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, 2002, 2003, 2004, 2006, 2007 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library 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 GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 \f
  24
  25 #include "libguile/__scm.h"
  26 #include "libguile/procs.h"
  27 #include "libguile/throw.h"
  28 #include "libguile/root.h"
  29 #include "libguile/iselect.h"
  30 #include "libguile/dynwind.h"
  31
  32 #if SCM_USE_PTHREAD_THREADS
  33 #include "libguile/pthread-threads.h"
  34 #endif
  35
  36 #if SCM_USE_NULL_THREADS
  37 #include "libguile/null-threads.h"
  38 #endif
  39
  40 \f
  41
  42 /* smob tags for the thread datatypes */
  43 SCM_API scm_t_bits scm_tc16_thread;
  44 SCM_API scm_t_bits scm_tc16_mutex;
  45 SCM_API scm_t_bits scm_tc16_condvar;
  46
  47 typedef struct scm_i_thread {
  48   struct scm_i_thread *next_thread;
  49
  50   SCM handle;
  51   scm_i_pthread_t pthread;
  52
  53   SCM cleanup_handler;
  54   SCM join_queue;
  55   SCM result;
  56   int canceled;
  57   int exited;
  58
  59   SCM sleep_object;
  60   scm_i_pthread_mutex_t *sleep_mutex;
  61   scm_i_pthread_cond_t sleep_cond;
  62   int sleep_fd, sleep_pipe[2];
  63
  64   /* This mutex represents this threads right to access the heap.
  65      That right can temporarily be taken away by the GC.
  66   */
  67   scm_i_pthread_mutex_t heap_mutex;
  68
  69   /* The freelists of this thread.  Each thread has its own lists so
  70      that they can all allocate concurrently.
  71   */
  72   SCM freelist, freelist2;
  73   int clear_freelists_p; /* set if GC was done while thread was asleep */
  74   int gc_running_p;      /* non-zero while this thread does GC or a
  75                             sweep. */
  76
  77   /* Other thread local things.
  78    */
  79   SCM dynamic_state;
  80   scm_t_debug_frame *last_debug_frame;
  81   SCM dynwinds;
  82
  83   /* For system asyncs.
  84    */
  85   SCM active_asyncs;            /* The thunks to be run at the next
  86                                    safe point */
  87   unsigned int block_asyncs;    /* Non-zero means that asyncs should
  88                                    not be run. */
  89   unsigned int pending_asyncs;  /* Non-zero means that asyncs might be pending.
  90                                  */
  91
  92   /* The current continuation root and the stack base for it.
  93
  94      The continuation root is an arbitrary but unique object that
  95      identifies a dynamic extent.  Continuations created during that
  96      extent can also only be invoked during it.
  97
  98      We use pairs where the car is the thread handle and the cdr links
  99      to the previous pair.  This might be used for better error
 100      messages but is not essential for identifying continuation roots.
 101
 102      The continuation base is the far end of the stack upto which it
 103      needs to be copied.
 104   */
 105   SCM continuation_root;
 106   SCM_STACKITEM *continuation_base;
 107
 108   /* For keeping track of the stack and registers. */
 109   SCM_STACKITEM *base;
 110   SCM_STACKITEM *top;
 111   jmp_buf regs;
 112
 113 } scm_i_thread;
 114
 115 #define SCM_I_IS_THREAD(x)    SCM_SMOB_PREDICATE (scm_tc16_thread, x)
 116 #define SCM_I_THREAD_DATA(x)  ((scm_i_thread *) SCM_SMOB_DATA (x))
 117
 118 #define SCM_VALIDATE_THREAD(pos, a) \
 119   scm_assert_smob_type (scm_tc16_thread, (a))
 120 #define SCM_VALIDATE_MUTEX(pos, a) \
 121   scm_assert_smob_type (scm_tc16_mutex, (a))
 122 #define SCM_VALIDATE_CONDVAR(pos, a) \
 123   scm_assert_smob_type (scm_tc16_condvar, (a))
 124
 125 SCM_API SCM scm_spawn_thread (scm_t_catch_body body, void *body_data,
 126                               scm_t_catch_handler handler, void *handler_data);
 127
 128 SCM_API void *scm_without_guile (void *(*func)(void *), void *data);
 129 SCM_API void *scm_with_guile (void *(*func)(void *), void *data);
 130
 131 SCM_API void *scm_i_with_guile_and_parent (void *(*func)(void *), void *data,
 132                                            SCM parent);
 133
 134
 135 extern int scm_i_thread_go_to_sleep;
 136
 137 void scm_i_thread_put_to_sleep (void);
 138 void scm_i_thread_wake_up (void);
 139 void scm_i_thread_invalidate_freelists (void);
 140 void scm_i_thread_sleep_for_gc (void);
 141
 142 void scm_threads_prehistory (SCM_STACKITEM *);
 143 void scm_threads_init_first_thread (void);
 144 SCM_API void scm_threads_mark_stacks (void);
 145 SCM_API void scm_init_threads (void);
 146 SCM_API void scm_init_thread_procs (void);
 147 SCM_API void scm_init_threads_default_dynamic_state (void);
 148
 149
 150 #define SCM_THREAD_SWITCHING_CODE \
 151 do { \
 152   if (scm_i_thread_go_to_sleep) \
 153     scm_i_thread_sleep_for_gc (); \
 154 } while (0)
 155
 156 SCM_API SCM scm_call_with_new_thread (SCM thunk, SCM handler);
 157 SCM_API SCM scm_yield (void);
 158 SCM_API SCM scm_cancel_thread (SCM t);
 159 SCM_API SCM scm_set_thread_cleanup_x (SCM thread, SCM proc);
 160 SCM_API SCM scm_thread_cleanup (SCM thread);
 161 SCM_API SCM scm_join_thread (SCM t);
 162
 163 SCM_API SCM scm_make_mutex (void);
 164 SCM_API SCM scm_make_recursive_mutex (void);
 165 SCM_API SCM scm_lock_mutex (SCM m);
 166 SCM_API void scm_dynwind_lock_mutex (SCM mutex);
 167 SCM_API SCM scm_try_mutex (SCM m);
 168 SCM_API SCM scm_unlock_mutex (SCM m);
 169
 170 SCM_API SCM scm_make_condition_variable (void);
 171 SCM_API SCM scm_wait_condition_variable (SCM cond, SCM mutex);
 172 SCM_API SCM scm_timed_wait_condition_variable (SCM cond, SCM mutex,
 173                                                SCM abstime);
 174 SCM_API SCM scm_signal_condition_variable (SCM cond);
 175 SCM_API SCM scm_broadcast_condition_variable (SCM cond);
 176
 177 SCM_API SCM scm_current_thread (void);
 178 SCM_API SCM scm_all_threads (void);
 179
 180 SCM_API int scm_c_thread_exited_p (SCM thread);
 181 SCM_API SCM scm_thread_exited_p (SCM thread);
 182
 183 SCM_API void scm_dynwind_critical_section (SCM mutex);
 184
 185 #define SCM_I_CURRENT_THREAD \
 186   ((scm_i_thread *) scm_i_pthread_getspecific (scm_i_thread_key))
 187 SCM_API scm_i_pthread_key_t scm_i_thread_key;
 188
 189 #define scm_i_dynwinds()         (SCM_I_CURRENT_THREAD->dynwinds)
 190 #define scm_i_set_dynwinds(w)    (SCM_I_CURRENT_THREAD->dynwinds = (w))
 191 #define scm_i_last_debug_frame() (SCM_I_CURRENT_THREAD->last_debug_frame)
 192 #define scm_i_set_last_debug_frame(f) \
 193                                  (SCM_I_CURRENT_THREAD->last_debug_frame = (f))
 194
 195 SCM_API scm_i_pthread_mutex_t scm_i_misc_mutex;
 196
 197 /* Convenience functions for working with the pthread API in guile
 198    mode.
 199 */
 200
 201 #if SCM_USE_PTHREAD_THREADS
 202 SCM_API int scm_pthread_mutex_lock (pthread_mutex_t *mutex);
 203 SCM_API void scm_dynwind_pthread_mutex_lock (pthread_mutex_t *mutex);
 204 SCM_API int scm_pthread_cond_wait (pthread_cond_t *cond,
 205                                    pthread_mutex_t *mutex);
 206 SCM_API int scm_pthread_cond_timedwait (pthread_cond_t *cond,
 207                                         pthread_mutex_t *mutex,
 208                                         const struct timespec *abstime);
 209 #endif
 210
 211 /* More convenience functions.
 212  */
 213
 214 SCM_API unsigned int scm_std_sleep (unsigned int);
 215 SCM_API unsigned long scm_std_usleep (unsigned long);
 216
 217 #endif  /* SCM_THREADS_H */
 218
 219 /*
 220   Local Variables:
 221   c-file-style: "gnu"
 222   End:
 223 */