Commit | Line | Data |
---|---|---|
7bfd3b9e JB |
1 | /* classes: h_files */ |
2 | ||
0527e687 DH |
3 | #ifndef SCM_COOP_DEFS_H |
4 | #define SCM_COOP_DEFS_H | |
7bfd3b9e | 5 | |
216eedfc | 6 | /* Copyright (C) 1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc. |
0527e687 | 7 | * |
7bfd3b9e JB |
8 | * This program is free software; you can redistribute it and/or modify |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2, or (at your option) | |
11 | * any later version. | |
0527e687 | 12 | * |
7bfd3b9e JB |
13 | * This program 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 | |
16 | * GNU General Public License for more details. | |
0527e687 | 17 | * |
7bfd3b9e JB |
18 | * You should have received a copy of the GNU General Public License |
19 | * along with this software; see the file COPYING. If not, write to | |
82892bed JB |
20 | * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
21 | * Boston, MA 02111-1307 USA | |
7bfd3b9e JB |
22 | * |
23 | * As a special exception, the Free Software Foundation gives permission | |
24 | * for additional uses of the text contained in its release of GUILE. | |
25 | * | |
26 | * The exception is that, if you link the GUILE library with other files | |
27 | * to produce an executable, this does not by itself cause the | |
28 | * resulting executable to be covered by the GNU General Public License. | |
29 | * Your use of that executable is in no way restricted on account of | |
30 | * linking the GUILE library code into it. | |
31 | * | |
32 | * This exception does not however invalidate any other reasons why | |
33 | * the executable file might be covered by the GNU General Public License. | |
34 | * | |
35 | * This exception applies only to the code released by the | |
36 | * Free Software Foundation under the name GUILE. If you copy | |
37 | * code from other Free Software Foundation releases into a copy of | |
38 | * GUILE, as the General Public License permits, the exception does | |
39 | * not apply to the code that you add in this way. To avoid misleading | |
40 | * anyone as to the status of such modified files, you must delete | |
41 | * this exception notice from them. | |
42 | * | |
43 | * If you write modifications of your own for GUILE, it is your choice | |
44 | * whether to permit this exception to apply to your modifications. | |
82892bed | 45 | * If you do not wish that, delete this exception notice. */ |
d3a6bc94 | 46 | |
7bfd3b9e JB |
47 | \f |
48 | ||
49 | # ifdef TIME_WITH_SYS_TIME | |
50 | # include <sys/time.h> | |
51 | # include <time.h> | |
52 | # else | |
53 | # ifdef HAVE_SYS_TIME_H | |
54 | # include <sys/time.h> | |
55 | # else | |
56 | # ifdef HAVE_TIME_H | |
57 | # include <time.h> | |
58 | # endif | |
59 | # endif | |
60 | # endif | |
61 | ||
44e8413c | 62 | #ifdef GUILE_ISELECT |
a0599745 | 63 | #include "libguile/iselect.h" |
44e8413c MD |
64 | #endif |
65 | ||
8f99e3f3 SJ |
66 | #if HAVE_WINSOCK2_H |
67 | #include <winsock2.h> | |
68 | #endif | |
69 | ||
32e738bb MD |
70 | #ifdef GUILE_PTHREAD_COMPAT |
71 | #include <pthread.h> | |
72 | #endif | |
73 | ||
7bfd3b9e JB |
74 | /* This file is included by threads.h, which, in turn, is included by |
75 | libguile.h while coop-threads.h only is included by | |
76 | coop-threads.c. */ | |
77 | ||
78 | /* The coop_t struct must be declared here, since macros in this file | |
79 | refer to the data member. */ | |
80 | ||
81 | /* The notion of a thread is merged with the notion of a queue. | |
82 | Thread stuff: thread status (sp) and stuff to use during | |
83 | (re)initialization. Queue stuff: next thread in the queue | |
84 | (next). */ | |
85 | ||
86 | struct qt_t; | |
87 | ||
88 | typedef struct coop_t { | |
89 | struct qt_t *sp; /* QuickThreads handle. */ | |
90 | void *sto; /* `malloc'-allocated stack. */ | |
91 | ||
92 | struct coop_t *next; /* Next thread in the queue. */ | |
93 | ||
94 | struct coop_t *all_next; | |
95 | struct coop_t *all_prev; | |
96 | ||
97 | void *data; /* Thread local data */ | |
32e738bb MD |
98 | void **specific; /* Data associated with keys */ |
99 | int n_keys; /* Upper limit for keys on this thread */ | |
7bfd3b9e JB |
100 | |
101 | void *base; /* Base of stack */ | |
102 | void *top; /* Top of stack */ | |
103 | ||
104 | void *joining; /* A queue of threads waiting to join this | |
105 | thread */ | |
106 | ||
9997213b MV |
107 | SCM handle; /* SCM handle, protected via scm_all_threads. */ |
108 | ||
44e8413c MD |
109 | #ifdef GUILE_ISELECT |
110 | int nfds; | |
111 | SELECT_TYPE *readfds; | |
112 | SELECT_TYPE *writefds; | |
113 | SELECT_TYPE *exceptfds; | |
114 | int timeoutp; | |
115 | struct timeval wakeup_time; /* Time to stop sleeping */ | |
c44bfbc9 | 116 | int _errno; |
44e8413c MD |
117 | int retval; |
118 | #else | |
7bfd3b9e | 119 | time_t wakeup_time; /* Time to stop sleeping */ |
44e8413c | 120 | #endif |
7bfd3b9e | 121 | |
32e738bb MD |
122 | #ifdef GUILE_PTHREAD_COMPAT |
123 | pthread_t dummy_thread; | |
124 | pthread_mutex_t dummy_mutex; | |
32e738bb | 125 | #endif |
7bfd3b9e JB |
126 | } coop_t; |
127 | ||
c8bf4ecd MD |
128 | /* A queue is a circular list of threads. The queue head is a |
129 | designated list element. If this is a uniprocessor-only | |
130 | implementation we can store the `main' thread in this, but in a | |
131 | multiprocessor there are several `heavy' threads but only one run | |
132 | queue. A fancier implementation might have private run queues, | |
133 | which would lead to a simpler (trivial) implementation */ | |
134 | ||
135 | typedef struct coop_q_t { | |
136 | coop_t t; | |
137 | coop_t *tail; | |
138 | } coop_q_t; | |
139 | ||
140 | /* A Mutex variable is made up of a owner thread, and a queue of threads | |
141 | waiting on the mutex */ | |
142 | ||
143 | typedef struct coop_m { | |
144 | coop_t *owner; /* Mutex owner */ | |
145 | coop_q_t waiting; /* Queue of waiting threads */ | |
146 | } coop_m; | |
147 | ||
32e738bb MD |
148 | typedef int coop_mattr; |
149 | ||
92c2555f | 150 | typedef coop_m scm_t_mutex; |
c8bf4ecd | 151 | |
33b001fd MV |
152 | SCM_API int coop_mutex_init (coop_m*); |
153 | SCM_API int coop_new_mutex_init (coop_m*, coop_mattr*); | |
154 | SCM_API int coop_mutex_lock (coop_m*); | |
155 | SCM_API int coop_mutex_trylock (coop_m*); | |
156 | SCM_API int coop_mutex_unlock (coop_m*); | |
157 | SCM_API int coop_mutex_destroy (coop_m*); | |
b74b1a63 | 158 | #define scm_mutex_init coop_mutex_init |
c8bf4ecd | 159 | #define scm_mutex_lock coop_mutex_lock |
62af908b | 160 | #define scm_mutex_trylock coop_mutex_lock |
c8bf4ecd MD |
161 | #define scm_mutex_unlock coop_mutex_unlock |
162 | #define scm_mutex_destroy coop_mutex_destroy | |
163 | ||
164 | /* A Condition variable is made up of a list of threads waiting on the | |
165 | condition. */ | |
166 | ||
167 | typedef struct coop_c { | |
168 | coop_q_t waiting; /* Queue of waiting threads */ | |
169 | } coop_c; | |
170 | ||
32e738bb MD |
171 | typedef int coop_cattr; |
172 | ||
92c2555f | 173 | typedef coop_c scm_t_cond; |
c8bf4ecd | 174 | |
14d2005d MD |
175 | #ifndef HAVE_STRUCT_TIMESPEC |
176 | /* POSIX.4 structure for a time value. This is like a `struct timeval' but | |
177 | has nanoseconds instead of microseconds. */ | |
178 | struct timespec | |
179 | { | |
180 | long int tv_sec; /* Seconds. */ | |
181 | long int tv_nsec; /* Nanoseconds. */ | |
182 | }; | |
183 | #endif | |
184 | ||
33b001fd MV |
185 | SCM_API int coop_condition_variable_init (coop_c*); |
186 | SCM_API int coop_new_condition_variable_init (coop_c*, coop_cattr*); | |
187 | SCM_API int coop_condition_variable_wait_mutex (coop_c*, coop_m*); | |
188 | SCM_API int coop_condition_variable_timed_wait_mutex (coop_c*, | |
189 | coop_m*, | |
190 | const struct timespec *abstime); | |
191 | SCM_API int coop_condition_variable_signal (coop_c*); | |
192 | SCM_API int coop_condition_variable_destroy (coop_c*); | |
32e738bb | 193 | #define scm_cond_init coop_new_condition_variable_init |
c8bf4ecd | 194 | #define scm_cond_wait coop_condition_variable_wait_mutex |
62af908b | 195 | #define scm_cond_timedwait coop_condition_variable_timed_wait_mutex |
c8bf4ecd | 196 | #define scm_cond_signal coop_condition_variable_signal |
32e738bb | 197 | #define scm_cond_broadcast coop_condition_variable_signal /* yes */ |
c8bf4ecd MD |
198 | #define scm_cond_destroy coop_condition_variable_destroy |
199 | ||
32e738bb MD |
200 | typedef int coop_k; |
201 | ||
92c2555f | 202 | typedef coop_k scm_t_key; |
32e738bb | 203 | |
33b001fd MV |
204 | SCM_API int coop_key_create (coop_k *keyp, void (*destruktor) (void *value)); |
205 | SCM_API int coop_setspecific (coop_k key, const void *value); | |
206 | SCM_API void *coop_getspecific (coop_k key); | |
207 | SCM_API int coop_key_delete (coop_k); | |
32e738bb MD |
208 | #define scm_key_create coop_key_create |
209 | #define scm_setspecific coop_setspecific | |
210 | #define scm_getspecific coop_getspecific | |
211 | #define scm_key_delete coop_key_delete | |
212 | ||
33b001fd | 213 | SCM_API coop_t *coop_global_curr; /* Currently-executing thread. */ |
7bfd3b9e | 214 | |
33b001fd MV |
215 | SCM_API void coop_join (coop_t *t); |
216 | SCM_API void coop_yield (void); | |
7bfd3b9e | 217 | |
33b001fd MV |
218 | SCM_API size_t scm_switch_counter; |
219 | SCM_API size_t scm_thread_count; | |
7bfd3b9e JB |
220 | |
221 | \f | |
6d71500e JB |
222 | /* Some iselect functions. */ |
223 | ||
224 | /* I'm not sure whether these three declarations should be here. | |
225 | They're really defined in iselect.c, so you'd think they'd go in | |
226 | iselect.h, but they use coop_t, defined above, which uses things | |
227 | defined in iselect.h. Basically, we're making at best a flailing | |
228 | (and failing) attempt at modularity here, and I don't have time to | |
229 | rethink this at the moment. This code awaits a Hero. --JimB */ | |
32e738bb | 230 | #ifdef GUILE_ISELECT |
33b001fd | 231 | SCM_API void coop_timeout_qinsert (coop_q_t *, coop_t *); |
32e738bb | 232 | #endif |
33b001fd MV |
233 | SCM_API coop_t *coop_next_runnable_thread (void); |
234 | SCM_API coop_t *coop_wait_for_runnable_thread_now (struct timeval *); | |
235 | SCM_API coop_t *coop_wait_for_runnable_thread (void); | |
6d71500e JB |
236 | |
237 | ||
238 | \f | |
7bfd3b9e JB |
239 | |
240 | /* Cooperative threads don't need to have these defined */ | |
241 | ||
216eedfc DH |
242 | #define SCM_CRITICAL_SECTION_START |
243 | #define SCM_CRITICAL_SECTION_END | |
7bfd3b9e JB |
244 | |
245 | \f | |
246 | ||
247 | #define SCM_NO_CRITICAL_SECTION_OWNER 0 | |
248 | #define SCM_THREAD_SWITCH_COUNT 50 /* was 10 /mdj */ | |
249 | ||
250 | \f | |
251 | ||
7bfd3b9e JB |
252 | #if 0 |
253 | #define SCM_THREAD_SWITCHING_CODE \ | |
d3a6bc94 | 254 | do { \ |
7bfd3b9e JB |
255 | if (scm_thread_count > 1) \ |
256 | coop_yield(); \ | |
d3a6bc94 | 257 | } while (0) |
7bfd3b9e JB |
258 | |
259 | #else | |
260 | #define SCM_THREAD_SWITCHING_CODE \ | |
d3a6bc94 | 261 | do { \ |
7bfd3b9e JB |
262 | if (scm_thread_count > 1) \ |
263 | { \ | |
264 | scm_switch_counter--; \ | |
265 | if (scm_switch_counter == 0) \ | |
266 | { \ | |
267 | scm_switch_counter = SCM_THREAD_SWITCH_COUNT; \ | |
268 | coop_yield(); \ | |
269 | } \ | |
270 | } \ | |
d3a6bc94 | 271 | } while (0) |
7bfd3b9e JB |
272 | |
273 | #endif | |
274 | ||
32e738bb MD |
275 | /* For pthreads, this is a value associated with a specific key. |
276 | * For coop, we use a special field for increased efficiency. | |
277 | */ | |
7bfd3b9e JB |
278 | #define SCM_THREAD_LOCAL_DATA (coop_global_curr->data) |
279 | #define SCM_SET_THREAD_LOCAL_DATA(ptr) (coop_global_curr->data = (ptr)) | |
280 | ||
0527e687 | 281 | #endif /* SCM_COOP_DEFS_H */ |
89e00824 ML |
282 | |
283 | /* | |
284 | Local Variables: | |
285 | c-file-style: "gnu" | |
286 | End: | |
287 | */ |