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, 2008, 2009 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 License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * 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
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27 #include "libguile/procs.h"
  28 #include "libguile/throw.h"
  29 #include "libguile/root.h"
  30 #include "libguile/iselect.h"
  31 #include "libguile/dynwind.h"
  32 #include "libguile/continuations.h"
  33
  34 #if SCM_USE_PTHREAD_THREADS
  35 #include "libguile/pthread-threads.h"
  36 #endif
  37
  38 #if SCM_USE_NULL_THREADS
  39 #include "libguile/null-threads.h"
  40 #endif
  41
  42 \f
  43
  44 /* smob tags for the thread datatypes */
  45 SCM_API scm_t_bits scm_tc16_thread;
  46 SCM_API scm_t_bits scm_tc16_mutex;
  47 SCM_API scm_t_bits scm_tc16_condvar;
  48
  49 typedef struct scm_i_thread {
  50   struct scm_i_thread *next_thread;
  51
  52   SCM handle;
  53   scm_i_pthread_t pthread;
  54
  55   SCM cleanup_handler;
  56   SCM join_queue;
  57
  58   scm_i_pthread_mutex_t admin_mutex;
  59   SCM mutexes;
  60   scm_i_pthread_mutex_t *held_mutex;
  61
  62   SCM result;
  63   int canceled;
  64   int exited;
  65
  66   /* Boolean indicating whether the thread is in guile mode.  */
  67   int guile_mode;
  68
  69   SCM sleep_object;
  70   scm_i_pthread_mutex_t *sleep_mutex;
  71   scm_i_pthread_cond_t sleep_cond;
  72   int sleep_fd, sleep_pipe[2];
  73
  74   /* Information about the Boehm-GC mark stack during the mark phase.  This
  75      is used by `scm_gc_mark ()'.  */
  76   void *current_mark_stack_ptr;
  77   void *current_mark_stack_limit;
  78
  79   /* Other thread local things.
  80    */
  81   SCM dynamic_state;
  82   SCM dynwinds;
  83
  84   /* For system asyncs.
  85    */
  86   SCM active_asyncs;            /* The thunks to be run at the next
  87                                    safe point */
  88   unsigned int block_asyncs;    /* Non-zero means that asyncs should
  89                                    not be run. */
  90   unsigned int pending_asyncs;  /* Non-zero means that asyncs might be pending.
  91                                  */
  92
  93   /* The current continuation root and the stack base for it.
  94
  95      The continuation root is an arbitrary but unique object that
  96      identifies a dynamic extent.  Continuations created during that
  97      extent can also only be invoked during it.
  98
  99      We use pairs where the car is the thread handle and the cdr links
 100      to the previous pair.  This might be used for better error
 101      messages but is not essential for identifying continuation roots.
 102
 103      The continuation base is the far end of the stack upto which it
 104      needs to be copied.
 105   */
 106   SCM continuation_root;
 107   SCM_STACKITEM *continuation_base;
 108
 109   /* For keeping track of the stack and registers. */
 110   SCM vm;
 111   SCM_STACKITEM *base;
 112   SCM_STACKITEM *top;
 113   scm_i_jmp_buf regs;
 114 #ifdef __ia64__
 115   void *register_backing_store_base;
 116   scm_t_contregs *pending_rbs_continuation;
 117 #endif
 118
 119   /* Whether this thread is in a critical section. */
 120   int critical_section_level;
 121
 122 } scm_i_thread;
 123
 124 #define SCM_I_IS_THREAD(x)    SCM_SMOB_PREDICATE (scm_tc16_thread, x)
 125 #define SCM_I_THREAD_DATA(x)  ((scm_i_thread *) SCM_SMOB_DATA (x))
 126
 127 #define SCM_VALIDATE_THREAD(pos, a) \
 128   scm_assert_smob_type (scm_tc16_thread, (a))
 129 #define SCM_VALIDATE_MUTEX(pos, a) \
 130   scm_assert_smob_type (scm_tc16_mutex, (a))
 131 #define SCM_VALIDATE_CONDVAR(pos, a) \
 132   scm_assert_smob_type (scm_tc16_condvar, (a))
 133
 134 SCM_API SCM scm_spawn_thread (scm_t_catch_body body, void *body_data,
 135                               scm_t_catch_handler handler, void *handler_data);
 136
 137 SCM_API void *scm_without_guile (void *(*func)(void *), void *data);
 138 SCM_API void *scm_with_guile (void *(*func)(void *), void *data);
 139
 140 SCM_INTERNAL void *scm_i_with_guile_and_parent (void *(*func)(void *),
 141                                                 void *data, SCM parent);
 142
 143
 144 void scm_threads_prehistory (SCM_STACKITEM *);
 145 void scm_threads_init_first_thread (void);
 146
 147 SCM_INTERNAL void scm_init_threads (void);
 148 SCM_INTERNAL void scm_init_thread_procs (void);
 149 SCM_INTERNAL void scm_init_threads_default_dynamic_state (void);
 150
 151
 152 #define SCM_THREAD_SWITCHING_CODE \
 153   do { } while (0)
 154
 155 SCM_API SCM scm_call_with_new_thread (SCM thunk, SCM handler);
 156 SCM_API SCM scm_yield (void);
 157 SCM_API SCM scm_cancel_thread (SCM t);
 158 SCM_API SCM scm_set_thread_cleanup_x (SCM thread, SCM proc);
 159 SCM_API SCM scm_thread_cleanup (SCM thread);
 160 SCM_API SCM scm_join_thread (SCM t);
 161 SCM_API SCM scm_join_thread_timed (SCM t, SCM timeout, SCM timeoutval);
 162 SCM_API SCM scm_thread_p (SCM t);
 163
 164 SCM_API SCM scm_make_mutex (void);
 165 SCM_API SCM scm_make_recursive_mutex (void);
 166 SCM_API SCM scm_make_mutex_with_flags (SCM flags);
 167 SCM_API SCM scm_lock_mutex (SCM m);
 168 SCM_API SCM scm_lock_mutex_timed (SCM m, SCM timeout, SCM owner);
 169 SCM_API void scm_dynwind_lock_mutex (SCM mutex);
 170 SCM_API SCM scm_try_mutex (SCM m);
 171 SCM_API SCM scm_unlock_mutex (SCM m);
 172 SCM_API SCM scm_unlock_mutex_timed (SCM m, SCM cond, SCM timeout);
 173 SCM_API SCM scm_mutex_p (SCM o);
 174 SCM_API SCM scm_mutex_locked_p (SCM m);
 175 SCM_API SCM scm_mutex_owner (SCM m);
 176 SCM_API SCM scm_mutex_level (SCM m);
 177
 178 SCM_API SCM scm_make_condition_variable (void);
 179 SCM_API SCM scm_wait_condition_variable (SCM cond, SCM mutex);
 180 SCM_API SCM scm_timed_wait_condition_variable (SCM cond, SCM mutex,
 181                                                SCM abstime);
 182 SCM_API SCM scm_signal_condition_variable (SCM cond);
 183 SCM_API SCM scm_broadcast_condition_variable (SCM cond);
 184 SCM_API SCM scm_condition_variable_p (SCM o);
 185
 186 SCM_API SCM scm_current_thread (void);
 187 SCM_API SCM scm_all_threads (void);
 188
 189 SCM_API int scm_c_thread_exited_p (SCM thread);
 190 SCM_API SCM scm_thread_exited_p (SCM thread);
 191
 192 SCM_API void scm_dynwind_critical_section (SCM mutex);
 193
 194 #ifdef BUILDING_LIBGUILE
 195
 196 # ifdef SCM_HAVE_THREAD_STORAGE_CLASS
 197
 198 SCM_INTERNAL SCM_THREAD_LOCAL scm_i_thread *scm_i_current_thread;
 199 #  define SCM_I_CURRENT_THREAD (scm_i_current_thread)
 200
 201 # else /* !SCM_HAVE_THREAD_STORAGE_CLASS */
 202
 203 SCM_INTERNAL scm_i_pthread_key_t scm_i_thread_key;
 204 #  define SCM_I_CURRENT_THREAD                                          \
 205     ((scm_i_thread *) scm_i_pthread_getspecific (scm_i_thread_key))
 206
 207 # endif /* !SCM_HAVE_THREAD_STORAGE_CLASS */
 208
 209 # define scm_i_dynwinds()         (SCM_I_CURRENT_THREAD->dynwinds)
 210 # define scm_i_set_dynwinds(w)    (SCM_I_CURRENT_THREAD->dynwinds = (w))
 211
 212 #endif /* BUILDING_LIBGUILE */
 213
 214
 215 SCM_INTERNAL scm_i_pthread_mutex_t scm_i_misc_mutex;
 216
 217 /* Convenience functions for working with the pthread API in guile
 218    mode.
 219 */
 220
 221 #if SCM_USE_PTHREAD_THREADS
 222 SCM_API int scm_pthread_mutex_lock (pthread_mutex_t *mutex);
 223 SCM_API void scm_dynwind_pthread_mutex_lock (pthread_mutex_t *mutex);
 224 SCM_API int scm_pthread_cond_wait (pthread_cond_t *cond,
 225                                    pthread_mutex_t *mutex);
 226 SCM_API int scm_pthread_cond_timedwait (pthread_cond_t *cond,
 227                                         pthread_mutex_t *mutex,
 228                                         const scm_t_timespec *abstime);
 229 #endif
 230
 231 /* More convenience functions.
 232  */
 233
 234 SCM_API unsigned int scm_std_sleep (unsigned int);
 235 SCM_API unsigned long scm_std_usleep (unsigned long);
 236
 237 #endif  /* SCM_THREADS_H */
 238
 239 /*
 240   Local Variables:
 241   c-file-style: "gnu"
 242   End:
 243 */