3 #ifndef SCM_COOP_DEFS_H
4 #define SCM_COOP_DEFS_H
6 /* Copyright (C) 1996,1997,1998,1999,2000,2001, 2002, 2006 Free Software Foundation, Inc.
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.
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.
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
25 #include "libguile/__scm.h"
26 #include "libguile/iselect.h"
28 #if SCM_HAVE_WINSOCK2_H
29 # include <winsock2.h>
32 #ifdef GUILE_PTHREAD_COMPAT
36 #include "libguile/boehm-gc.h"
38 /* This file is included by threads.h, which, in turn, is included by
39 libguile.h while coop-threads.h only is included by
42 /* The coop_t struct must be declared here, since macros in this file
43 refer to the data member. */
45 /* The notion of a thread is merged with the notion of a queue.
46 Thread stuff: thread status (sp) and stuff to use during
47 (re)initialization. Queue stuff: next thread in the queue
52 typedef struct coop_t
{
53 struct qt_t
*sp
; /* QuickThreads handle. */
54 void *sto
; /* `malloc'-allocated stack. */
56 struct coop_t
*next
; /* Next thread in the queue. */
58 struct coop_t
*all_next
;
59 struct coop_t
*all_prev
;
61 void *data
; /* Thread local data */
62 void **specific
; /* Data associated with keys */
63 int n_keys
; /* Upper limit for keys on this thread */
65 void *base
; /* Base of stack */
66 void *top
; /* Top of stack */
68 void *joining
; /* A queue of threads waiting to join this
71 SCM handle
; /* SCM handle, protected via scm_all_threads. */
75 SELECT_TYPE
*writefds
;
76 SELECT_TYPE
*exceptfds
;
78 struct timeval wakeup_time
; /* Time to stop sleeping */
82 #ifdef GUILE_PTHREAD_COMPAT
83 pthread_t dummy_thread
;
84 pthread_mutex_t dummy_mutex
;
88 /* A queue is a circular list of threads. The queue head is a
89 designated list element. If this is a uniprocessor-only
90 implementation we can store the `main' thread in this, but in a
91 multiprocessor there are several `heavy' threads but only one run
92 queue. A fancier implementation might have private run queues,
93 which would lead to a simpler (trivial) implementation */
95 typedef struct coop_q_t
{
100 /* A Mutex variable is made up of a owner thread, and a queue of threads
101 waiting on the mutex */
103 typedef struct coop_m
{
104 coop_t
*owner
; /* Mutex owner */
105 int level
; /* for recursive locks. */
106 coop_q_t waiting
; /* Queue of waiting threads */
109 typedef int coop_mattr
;
111 SCM_API
int coop_mutex_init (coop_m
*);
112 SCM_API
int coop_new_mutex_init (coop_m
*, coop_mattr
*);
113 SCM_API
int coop_mutex_lock (coop_m
*);
114 SCM_API
int coop_mutex_trylock (coop_m
*);
115 SCM_API
int coop_mutex_unlock (coop_m
*);
116 SCM_API
int coop_mutex_destroy (coop_m
*);
118 /* A Condition variable is made up of a list of threads waiting on the
121 typedef struct coop_c
{
122 coop_q_t waiting
; /* Queue of waiting threads */
125 typedef int coop_cattr
;
127 SCM_API
int coop_condition_variable_init (coop_c
*);
128 SCM_API
int coop_new_condition_variable_init (coop_c
*, coop_cattr
*);
129 SCM_API
int coop_condition_variable_wait_mutex (coop_c
*, coop_m
*);
130 SCM_API
int coop_condition_variable_timed_wait_mutex (coop_c
*,
132 const scm_t_timespec
*abstime
);
133 SCM_API
int coop_condition_variable_signal (coop_c
*);
134 SCM_API
int coop_condition_variable_broadcast (coop_c
*);
135 SCM_API
int coop_condition_variable_destroy (coop_c
*);
139 typedef coop_k scm_t_key
;
141 SCM_API
int coop_key_create (coop_k
*keyp
, void (*destruktor
) (void *value
));
142 SCM_API
int coop_setspecific (coop_k key
, const void *value
);
143 SCM_API
void *coop_getspecific (coop_k key
);
144 SCM_API
int coop_key_delete (coop_k
);
145 #define scm_key_create coop_key_create
146 #define scm_setspecific coop_setspecific
147 #define scm_getspecific coop_getspecific
148 #define scm_key_delete coop_key_delete
150 SCM_API coop_t
*coop_global_curr
; /* Currently-executing thread. */
152 SCM_API
void coop_join (coop_t
*t
);
153 SCM_API
void coop_yield (void);
155 SCM_API
size_t scm_switch_counter
;
156 SCM_API
size_t scm_thread_count
;
159 /* Some iselect functions. */
161 /* I'm not sure whether these three declarations should be here.
162 They're really defined in iselect.c, so you'd think they'd go in
163 iselect.h, but they use coop_t, defined above, which uses things
164 defined in iselect.h. Basically, we're making at best a flailing
165 (and failing) attempt at modularity here, and I don't have time to
166 rethink this at the moment. This code awaits a Hero. --JimB
168 SCM_API
void coop_timeout_qinsert (coop_q_t
*, coop_t
*);
169 SCM_API coop_t
*coop_next_runnable_thread (void);
170 SCM_API coop_t
*coop_wait_for_runnable_thread_now (struct timeval
*);
171 SCM_API coop_t
*coop_wait_for_runnable_thread (void);
176 /* Cooperative threads don't need to have these defined */
178 #define SCM_CRITICAL_SECTION_START
179 #define SCM_CRITICAL_SECTION_END
183 #define SCM_NO_CRITICAL_SECTION_OWNER 0
184 #define SCM_THREAD_SWITCH_COUNT 50 /* was 10 /mdj */
189 #define SCM_THREAD_SWITCHING_CODE \
191 if (scm_thread_count > 1) \
196 #define SCM_THREAD_SWITCHING_CODE \
198 if (scm_thread_count > 1) \
200 scm_switch_counter--; \
201 if (scm_switch_counter == 0) \
203 scm_switch_counter = SCM_THREAD_SWITCH_COUNT; \
211 /* For pthreads, this is a value associated with a specific key.
212 * For coop, we use a special field for increased efficiency.
214 #define SCM_THREAD_LOCAL_DATA (coop_global_curr->data)
215 #define SCM_SET_THREAD_LOCAL_DATA(ptr) (coop_global_curr->data = (ptr))
217 #endif /* SCM_COOP_DEFS_H */