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,
   7  *   2007, 2008, 2009, 2011, 2013 Free Software Foundation, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 3 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA
  23  */
  24
  25 \f
  26
  27 #include "libguile/__scm.h"
  28 #include "libguile/procs.h"
  29 #include "libguile/throw.h"
  30 #include "libguile/root.h"
  31 #include "libguile/iselect.h"
  32 #include "libguile/dynwind.h"
  33 #include "libguile/continuations.h"
  34
  35 #if SCM_USE_PTHREAD_THREADS
  36 #include "libguile/pthread-threads.h"
  37 #endif
  38
  39 #if SCM_USE_NULL_THREADS
  40 #include "libguile/null-threads.h"
  41 #endif
  42
  43 \f
  44
  45 /* smob tags for the thread datatypes */
  46 SCM_API scm_t_bits scm_tc16_thread;
  47 SCM_API scm_t_bits scm_tc16_mutex;
  48 SCM_API scm_t_bits scm_tc16_condvar;
  49
  50 typedef struct scm_i_thread {
  51   struct scm_i_thread *next_thread;
  52
  53   SCM handle;
  54   scm_i_pthread_t pthread;
  55
  56   SCM cleanup_handler;
  57   SCM join_queue;
  58
  59   scm_i_pthread_mutex_t admin_mutex;
  60   SCM mutexes;
  61   scm_i_pthread_mutex_t *held_mutex;
  62
  63   SCM result;
  64   int canceled;
  65   int exited;
  66
  67   /* Boolean indicating whether the thread is in guile mode.  */
  68   int guile_mode;
  69
  70   SCM sleep_object;
  71   scm_i_pthread_mutex_t *sleep_mutex;
  72   scm_i_pthread_cond_t sleep_cond;
  73   int sleep_fd, sleep_pipe[2];
  74
  75   /* XXX: These two fields used to hold information about the BDW-GC
  76      mark stack during the mark phase.  They are no longer used.  */
  77   void *current_mark_stack_ptr;
  78   void *current_mark_stack_limit;
  79
  80   /* Other thread local things.
  81    */
  82   SCM dynamic_state;
  83   SCM dynwinds;
  84
  85   /* For system asyncs.
  86    */
  87   SCM active_asyncs;            /* The thunks to be run at the next
  88                                    safe point */
  89   unsigned int block_asyncs;    /* Non-zero means that asyncs should
  90                                    not be run. */
  91   unsigned int pending_asyncs;  /* Non-zero means that asyncs might be pending.
  92                                  */
  93
  94   /* The current continuation root and the stack base for it.
  95
  96      The continuation root is an arbitrary but unique object that
  97      identifies a dynamic extent.  Continuations created during that
  98      extent can also only be invoked during it.
  99
 100      We use pairs where the car is the thread handle and the cdr links
 101      to the previous pair.  This might be used for better error
 102      messages but is not essential for identifying continuation roots.
 103
 104      The continuation base is the far end of the stack upto which it
 105      needs to be copied.
 106   */
 107   SCM continuation_root;
 108   SCM_STACKITEM *continuation_base;
 109
 110   /* For keeping track of the stack and registers. */
 111   SCM vm;
 112   SCM_STACKITEM *base;
 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_reset_fluid (size_t);
 141 SCM_INTERNAL void scm_threads_prehistory (void *);
 142 SCM_INTERNAL void scm_init_threads (void);
 143 SCM_INTERNAL void scm_init_thread_procs (void);
 144 SCM_INTERNAL void scm_init_threads_default_dynamic_state (void);
 145
 146 SCM_INTERNAL void scm_i_dynwind_pthread_mutex_lock_block_asyncs (scm_i_pthread_mutex_t *mutex);
 147
 148 #define SCM_THREAD_SWITCHING_CODE \
 149   do { } while (0)
 150
 151 SCM_API SCM scm_call_with_new_thread (SCM thunk, SCM handler);
 152 SCM_API SCM scm_yield (void);
 153 SCM_API SCM scm_cancel_thread (SCM t);
 154 SCM_API SCM scm_set_thread_cleanup_x (SCM thread, SCM proc);
 155 SCM_API SCM scm_thread_cleanup (SCM thread);
 156 SCM_API SCM scm_join_thread (SCM t);
 157 SCM_API SCM scm_join_thread_timed (SCM t, SCM timeout, SCM timeoutval);
 158 SCM_API SCM scm_thread_p (SCM t);
 159
 160 SCM_API SCM scm_make_mutex (void);
 161 SCM_API SCM scm_make_recursive_mutex (void);
 162 SCM_API SCM scm_make_mutex_with_flags (SCM flags);
 163 SCM_API SCM scm_lock_mutex (SCM m);
 164 SCM_API SCM scm_lock_mutex_timed (SCM m, SCM timeout, SCM owner);
 165 SCM_API void scm_dynwind_lock_mutex (SCM mutex);
 166 SCM_API SCM scm_try_mutex (SCM m);
 167 SCM_API SCM scm_unlock_mutex (SCM m);
 168 SCM_API SCM scm_unlock_mutex_timed (SCM m, SCM cond, SCM timeout);
 169 SCM_API SCM scm_mutex_p (SCM o);
 170 SCM_API SCM scm_mutex_locked_p (SCM m);
 171 SCM_API SCM scm_mutex_owner (SCM m);
 172 SCM_API SCM scm_mutex_level (SCM m);
 173
 174 SCM_API SCM scm_make_condition_variable (void);
 175 SCM_API SCM scm_wait_condition_variable (SCM cond, SCM mutex);
 176 SCM_API SCM scm_timed_wait_condition_variable (SCM cond, SCM mutex,
 177                                                SCM abstime);
 178 SCM_API SCM scm_signal_condition_variable (SCM cond);
 179 SCM_API SCM scm_broadcast_condition_variable (SCM cond);
 180 SCM_API SCM scm_condition_variable_p (SCM o);
 181
 182 SCM_API SCM scm_current_thread (void);
 183 SCM_API SCM scm_all_threads (void);
 184
 185 SCM_API int scm_c_thread_exited_p (SCM thread);
 186 SCM_API SCM scm_thread_exited_p (SCM thread);
 187
 188 SCM_API void scm_dynwind_critical_section (SCM mutex);
 189
 190 #ifdef BUILDING_LIBGUILE
 191
 192 /* Though we don't need the key for SCM_I_CURRENT_THREAD if we have TLS,
 193    we do use it for cleanup purposes.  */
 194 SCM_INTERNAL scm_i_pthread_key_t scm_i_thread_key;
 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 #  define SCM_I_CURRENT_THREAD                                          \
 204     ((scm_i_thread *) scm_i_pthread_getspecific (scm_i_thread_key))
 205
 206 # endif /* !SCM_HAVE_THREAD_STORAGE_CLASS */
 207
 208 # define scm_i_dynwinds()         (SCM_I_CURRENT_THREAD->dynwinds)
 209 # define scm_i_set_dynwinds(w)    (SCM_I_CURRENT_THREAD->dynwinds = (w))
 210
 211 #endif /* BUILDING_LIBGUILE */
 212
 213
 214 SCM_INTERNAL scm_i_pthread_mutex_t scm_i_misc_mutex;
 215
 216 /* Convenience functions for working with the pthread API in guile
 217    mode.
 218 */
 219
 220 #if SCM_USE_PTHREAD_THREADS
 221 SCM_API int scm_pthread_mutex_lock (pthread_mutex_t *mutex);
 222 SCM_API void scm_dynwind_pthread_mutex_lock (pthread_mutex_t *mutex);
 223 SCM_API int scm_pthread_cond_wait (pthread_cond_t *cond,
 224                                    pthread_mutex_t *mutex);
 225 SCM_API int scm_pthread_cond_timedwait (pthread_cond_t *cond,
 226                                         pthread_mutex_t *mutex,
 227                                         const scm_t_timespec *abstime);
 228 #endif
 229
 230 /* More convenience functions.
 231  */
 232
 233 SCM_API unsigned int scm_std_sleep (unsigned int);
 234 SCM_API unsigned long scm_std_usleep (unsigned long);
 235
 236 SCM_API SCM scm_total_processor_count (void);
 237 SCM_API SCM scm_current_processor_count (void);
 238
 239 #endif  /* SCM_THREADS_H */
 240
 241 /*
 242   Local Variables:
 243   c-file-style: "gnu"
 244   End:
 245 */