X-Git-Url: https://git.hcoop.net/bpt/guile.git/blobdiff_plain/a06e3a75b298d2335d134cfec97ee893b29aea33..673ba2da04c2495f905b9e47c2ee820a605aef64:/libguile/threads.h

diff --git a/libguile/threads.h b/libguile/threads.h
dissimilarity index 90%
index 408ce1734..ad38653ed 100644
--- a/libguile/threads.h
+++ b/libguile/threads.h
@@ -1,113 +1,233 @@
-/* classes: h_files */
-
-#ifndef THREADSH
-#define THREADSH
-
-/* Copyright (C) 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
-
-
-
-#include "libguile/__scm.h"
-#include "libguile/procs.h"
-#include "libguile/throw.h"
-
-
-
-/* smob tags for the thread datatypes */
-extern scm_t_bits scm_tc16_thread;
-extern scm_t_bits scm_tc16_mutex;
-extern scm_t_bits scm_tc16_condvar;
-
-#define SCM_THREADP(x)      SCM_TYP16_PREDICATE (scm_tc16_thread, x)
-#define SCM_THREAD_DATA(x)  ((void *) SCM_CELL_WORD_1 (x))
-
-#define SCM_MUTEXP(x)       SCM_TYP16_PREDICATE (scm_tc16_mutex, x)
-#define SCM_MUTEX_DATA(x)   ((void *) SCM_CELL_WORD_1 (x))
-
-#define SCM_CONDVARP(x)     SCM_TYP16_PREDICATE (scm_tc16_condvar, x)
-#define SCM_CONDVAR_DATA(x) ((void *) SCM_CELL_WORD_1 (x))
-
-/* Initialize implementation specific details of the threads support */
-void scm_threads_init (SCM_STACKITEM *);
-void scm_threads_mark_stacks (void);
-void scm_init_threads (SCM_STACKITEM *);
-
-/* */
-SCM scm_threads_make_mutex (void);
-SCM scm_threads_lock_mutex (SCM);
-SCM scm_threads_unlock_mutex (SCM);
-SCM scm_threads_monitor (void);
-
-SCM scm_spawn_thread (scm_t_catch_body body, void *body_data,
-		      scm_t_catch_handler handler, void *handler_data);
-
-/* These are versions of the ordinary sleep and usleep functions,
-   that play nicely with the thread system.  */
-unsigned long scm_thread_sleep (unsigned long);
-unsigned long scm_thread_usleep (unsigned long);
-
-
-/* The C versions of the Scheme-visible thread functions.  */
-#ifdef USE_COOP_THREADS
-extern SCM scm_single_thread_p (void);
-#endif
-extern SCM scm_yield (void);
-extern SCM scm_call_with_new_thread (SCM argl);
-extern SCM scm_join_thread (SCM t);
-extern SCM scm_make_mutex (void);
-extern SCM scm_lock_mutex (SCM m);
-extern SCM scm_unlock_mutex (SCM m);
-extern SCM scm_make_condition_variable (void);
-extern SCM scm_wait_condition_variable (SCM cond, SCM mutex);
-extern SCM scm_signal_condition_variable (SCM cond);
-
-#ifdef USE_COOP_THREADS
-#include "libguile/coop-defs.h"
-#endif
-
-#endif  /* THREADSH */
-
-/*
-  Local Variables:
-  c-file-style: "gnu"
-  End:
-*/
+/* classes: h_files */
+
+#ifndef SCM_THREADS_H
+#define SCM_THREADS_H
+
+/* Copyright (C) 1996,1997,1998,2000,2001, 2002, 2003, 2004 Free Software Foundation, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+
+
+#include "libguile/__scm.h"
+#include "libguile/procs.h"
+#include "libguile/throw.h"
+#include "libguile/root.h"
+#include "libguile/iselect.h"
+#include "libguile/dynwind.h"
+
+#if SCM_USE_PTHREAD_THREADS
+#include "libguile/pthread-threads.h"
+#endif
+
+#if SCM_USE_NULL_THREADS
+#include "libguile/null-threads.h"
+#endif
+
+
+
+/* smob tags for the thread datatypes */
+SCM_API scm_t_bits scm_tc16_thread;
+SCM_API scm_t_bits scm_tc16_mutex;
+SCM_API scm_t_bits scm_tc16_condvar;
+
+typedef struct scm_i_thread {
+  struct scm_i_thread *next_thread;
+
+  SCM handle;
+  scm_i_pthread_t pthread;
+  
+  SCM join_queue;
+  SCM result;
+  int exited;
+
+  SCM sleep_object;
+  scm_i_pthread_mutex_t *sleep_mutex;
+  scm_i_pthread_cond_t sleep_cond;
+  int sleep_fd, sleep_pipe[2];
+
+  /* This mutex represents this threads right to access the heap.
+     That right can temporarily be taken away by the GC.  
+  */
+  scm_i_pthread_mutex_t heap_mutex;
+
+  /* The freelists of this thread.  Each thread has its own lists so
+     that they can all allocate concurrently.
+  */
+  SCM freelist, freelist2;
+  int clear_freelists_p; /* set if GC was done while thread was asleep */
+
+  /* Other thread local things.
+   */
+  SCM dynamic_state;
+  scm_t_debug_frame *last_debug_frame;
+  SCM dynwinds;
+
+  /* For system asyncs.
+   */
+  SCM active_asyncs;            /* The thunks to be run at the next
+                                   safe point */
+  SCM signal_asyncs;            /* The pre-queued cells for signal handlers.
+                                 */
+  unsigned int block_asyncs;    /* Non-zero means that asyncs should 
+                                   not be run. */
+  unsigned int pending_asyncs;  /* Non-zero means that asyncs might be pending.
+				 */
+
+  /* The current continuation root and the stack base for it.
+
+     The continuation root is an arbitrary but unique object that
+     identifies a dynamic extent.  Continuations created during that
+     extent can also only be invoked during it.
+
+     We use pairs where the car is the thread handle and the cdr links
+     to the previous pair.  This might be used for better error
+     messages but is not essential for identifying continuation roots.
+
+     The continuation base is the far end of the stack upto which it
+     needs to be copied.
+  */
+  SCM continuation_root;
+  SCM_STACKITEM *continuation_base;
+
+  /* For keeping track of the stack and registers. */
+  SCM_STACKITEM *base;
+  SCM_STACKITEM *top;
+  jmp_buf regs;
+
+} scm_i_thread;
+
+#define SCM_I_IS_THREAD(x)    SCM_SMOB_PREDICATE (scm_tc16_thread, x)
+#define SCM_I_THREAD_DATA(x)  ((scm_i_thread *) SCM_SMOB_DATA (x))
+
+#define SCM_VALIDATE_THREAD(pos, a) \
+  scm_assert_smob_type (scm_tc16_thread, (a))
+#define SCM_VALIDATE_MUTEX(pos, a) \
+  scm_assert_smob_type (scm_tc16_mutex, (a))
+#define SCM_VALIDATE_CONDVAR(pos, a) \
+  scm_assert_smob_type (scm_tc16_condvar, (a))
+
+SCM_API SCM scm_spawn_thread (scm_t_catch_body body, void *body_data,
+			      scm_t_catch_handler handler, void *handler_data);
+
+typedef void *scm_t_guile_ticket;
+SCM_API void scm_enter_guile (scm_t_guile_ticket ticket);
+SCM_API scm_t_guile_ticket scm_leave_guile (void);
+SCM_API void *scm_without_guile (void *(*func)(void *), void *data);
+
+SCM_API void *scm_with_guile (void *(*func)(void *), void *data);
+SCM_API void *scm_i_with_guile_and_parent (void *(*func)(void *), void *data,
+					   SCM parent);
+
+/* Critical sections */
+
+/* XXX - every critical section needs to be examined and protected
+   with scm_frame_critical_section, say.
+*/
+
+extern scm_i_pthread_mutex_t scm_i_critical_section_mutex;
+
+#define SCM_CRITICAL_SECTION_START \
+  scm_i_pthread_mutex_lock (&scm_i_critical_section_mutex)
+#define SCM_CRITICAL_SECTION_END \
+  scm_i_pthread_mutex_unlock (&scm_i_critical_section_mutex)
+
+extern int scm_i_thread_go_to_sleep;
+
+void scm_i_thread_put_to_sleep (void);
+void scm_i_thread_wake_up (void);
+void scm_i_thread_invalidate_freelists (void);
+void scm_i_thread_sleep_for_gc (void);
+SCM_API void scm_i_frame_single_threaded (void);
+
+void scm_threads_prehistory (SCM_STACKITEM *);
+void scm_threads_init_first_thread (void);
+SCM_API void scm_threads_mark_stacks (void);
+SCM_API void scm_init_threads (void);
+SCM_API void scm_init_thread_procs (void);
+SCM_API void scm_init_threads_default_dynamic_state (void);
+
+
+#define SCM_THREAD_SWITCHING_CODE \
+do { \
+  if (scm_i_thread_go_to_sleep) \
+    scm_i_thread_sleep_for_gc (); \
+} while (0)
+
+SCM_API SCM scm_call_with_new_thread (SCM thunk, SCM handler);
+SCM_API SCM scm_yield (void);
+SCM_API SCM scm_join_thread (SCM t);
+
+SCM_API SCM scm_make_mutex (void);
+SCM_API SCM scm_make_recursive_mutex (void);
+SCM_API SCM scm_lock_mutex (SCM m);
+SCM_API SCM scm_try_mutex (SCM m);
+SCM_API SCM scm_unlock_mutex (SCM m);
+
+SCM_API SCM scm_make_condition_variable (void);
+SCM_API SCM scm_wait_condition_variable (SCM cond, SCM mutex);
+SCM_API SCM scm_timed_wait_condition_variable (SCM cond, SCM mutex,
+					       SCM abstime);
+SCM_API SCM scm_signal_condition_variable (SCM cond);
+SCM_API SCM scm_broadcast_condition_variable (SCM cond);
+
+SCM_API SCM scm_current_thread (void);
+SCM_API SCM scm_all_threads (void);
+
+SCM_API int scm_c_thread_exited_p (SCM thread);
+SCM_API SCM scm_thread_exited_p (SCM thread);
+
+SCM_API void scm_frame_critical_section (void);
+
+#define SCM_I_CURRENT_THREAD \
+  ((scm_i_thread *) scm_i_pthread_getspecific (scm_i_thread_key))
+SCM_API scm_i_pthread_key_t scm_i_thread_key;
+
+#define scm_i_dynwinds()         (SCM_I_CURRENT_THREAD->dynwinds)
+#define scm_i_set_dynwinds(w)    (SCM_I_CURRENT_THREAD->dynwinds = (w))
+#define scm_i_last_debug_frame() (SCM_I_CURRENT_THREAD->last_debug_frame)
+#define scm_i_set_last_debug_frame(f) \
+                                 (SCM_I_CURRENT_THREAD->last_debug_frame = (f))
+
+SCM_API scm_i_pthread_mutex_t scm_i_misc_mutex;
+
+/* Convenience functions for working with the pthread API in guile
+   mode.
+*/
+
+#if SCM_USE_PTHREAD_THREADS
+SCM_API int scm_pthread_mutex_lock (pthread_mutex_t *mutex);
+SCM_API void scm_frame_pthread_mutex_lock (pthread_mutex_t *mutex);
+SCM_API int scm_pthread_cond_wait (pthread_cond_t *cond,
+				   pthread_mutex_t *mutex);
+SCM_API int scm_pthread_cond_timedwait (pthread_cond_t *cond,
+					pthread_mutex_t *mutex,
+					const struct timespec *abstime);
+#endif
+
+/* More convenience functions.
+ */
+
+SCM_API unsigned int scm_std_sleep (unsigned int);
+SCM_API unsigned long scm_std_usleep (unsigned long);
+
+#endif  /* SCM_THREADS_H */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/