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 | |
2b829bbb | 6 | /* Copyright (C) 1996,1997,1998,1999,2000,2001, 2002, 2006 Free Software Foundation, Inc. |
0527e687 | 7 | * |
73be1d9e MV |
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. | |
0527e687 | 12 | * |
73be1d9e | 13 | * This library is distributed in the hope that it will be useful, |
7bfd3b9e | 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
0527e687 | 17 | * |
73be1d9e MV |
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 | |
92205699 | 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 21 | */ |
d3a6bc94 | 22 | |
7bfd3b9e JB |
23 | \f |
24 | ||
ec81cb0b | 25 | #include "libguile/__scm.h" |
a0599745 | 26 | #include "libguile/iselect.h" |
44e8413c | 27 | |
277ee0fa | 28 | #if SCM_HAVE_WINSOCK2_H |
ec81cb0b | 29 | # include <winsock2.h> |
8f99e3f3 SJ |
30 | #endif |
31 | ||
32e738bb | 32 | #ifdef GUILE_PTHREAD_COMPAT |
89f423d5 | 33 | # include <pthread.h> |
32e738bb MD |
34 | #endif |
35 | ||
e7bca227 LC |
36 | #include "libguile/boehm-gc.h" |
37 | ||
7bfd3b9e JB |
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 | |
40 | coop-threads.c. */ | |
41 | ||
42 | /* The coop_t struct must be declared here, since macros in this file | |
43 | refer to the data member. */ | |
44 | ||
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 | |
48 | (next). */ | |
49 | ||
50 | struct qt_t; | |
51 | ||
52 | typedef struct coop_t { | |
53 | struct qt_t *sp; /* QuickThreads handle. */ | |
54 | void *sto; /* `malloc'-allocated stack. */ | |
55 | ||
56 | struct coop_t *next; /* Next thread in the queue. */ | |
57 | ||
58 | struct coop_t *all_next; | |
59 | struct coop_t *all_prev; | |
60 | ||
61 | void *data; /* Thread local data */ | |
32e738bb MD |
62 | void **specific; /* Data associated with keys */ |
63 | int n_keys; /* Upper limit for keys on this thread */ | |
7bfd3b9e JB |
64 | |
65 | void *base; /* Base of stack */ | |
66 | void *top; /* Top of stack */ | |
67 | ||
68 | void *joining; /* A queue of threads waiting to join this | |
69 | thread */ | |
70 | ||
9997213b MV |
71 | SCM handle; /* SCM handle, protected via scm_all_threads. */ |
72 | ||
44e8413c MD |
73 | int nfds; |
74 | SELECT_TYPE *readfds; | |
75 | SELECT_TYPE *writefds; | |
76 | SELECT_TYPE *exceptfds; | |
77 | int timeoutp; | |
78 | struct timeval wakeup_time; /* Time to stop sleeping */ | |
c44bfbc9 | 79 | int _errno; |
44e8413c | 80 | int retval; |
7bfd3b9e | 81 | |
32e738bb MD |
82 | #ifdef GUILE_PTHREAD_COMPAT |
83 | pthread_t dummy_thread; | |
84 | pthread_mutex_t dummy_mutex; | |
32e738bb | 85 | #endif |
7bfd3b9e JB |
86 | } coop_t; |
87 | ||
c8bf4ecd MD |
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 */ | |
94 | ||
95 | typedef struct coop_q_t { | |
96 | coop_t t; | |
97 | coop_t *tail; | |
98 | } coop_q_t; | |
99 | ||
100 | /* A Mutex variable is made up of a owner thread, and a queue of threads | |
101 | waiting on the mutex */ | |
102 | ||
103 | typedef struct coop_m { | |
104 | coop_t *owner; /* Mutex owner */ | |
79cd5b8e | 105 | int level; /* for recursive locks. */ |
c8bf4ecd MD |
106 | coop_q_t waiting; /* Queue of waiting threads */ |
107 | } coop_m; | |
108 | ||
32e738bb MD |
109 | typedef int coop_mattr; |
110 | ||
33b001fd MV |
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*); | |
c8bf4ecd MD |
117 | |
118 | /* A Condition variable is made up of a list of threads waiting on the | |
119 | condition. */ | |
120 | ||
121 | typedef struct coop_c { | |
122 | coop_q_t waiting; /* Queue of waiting threads */ | |
123 | } coop_c; | |
124 | ||
32e738bb MD |
125 | typedef int coop_cattr; |
126 | ||
33b001fd MV |
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*, | |
131 | coop_m*, | |
ec81cb0b | 132 | const scm_t_timespec *abstime); |
33b001fd | 133 | SCM_API int coop_condition_variable_signal (coop_c*); |
79cd5b8e | 134 | SCM_API int coop_condition_variable_broadcast (coop_c*); |
33b001fd | 135 | SCM_API int coop_condition_variable_destroy (coop_c*); |
c8bf4ecd | 136 | |
32e738bb MD |
137 | typedef int coop_k; |
138 | ||
92c2555f | 139 | typedef coop_k scm_t_key; |
32e738bb | 140 | |
33b001fd MV |
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); | |
32e738bb MD |
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 | |
149 | ||
33b001fd | 150 | SCM_API coop_t *coop_global_curr; /* Currently-executing thread. */ |
7bfd3b9e | 151 | |
33b001fd MV |
152 | SCM_API void coop_join (coop_t *t); |
153 | SCM_API void coop_yield (void); | |
7bfd3b9e | 154 | |
33b001fd MV |
155 | SCM_API size_t scm_switch_counter; |
156 | SCM_API size_t scm_thread_count; | |
7bfd3b9e JB |
157 | |
158 | \f | |
6d71500e JB |
159 | /* Some iselect functions. */ |
160 | ||
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 | |
3d7f708f MV |
166 | rethink this at the moment. This code awaits a Hero. --JimB |
167 | */ | |
33b001fd | 168 | SCM_API void coop_timeout_qinsert (coop_q_t *, coop_t *); |
33b001fd MV |
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); | |
6d71500e JB |
172 | |
173 | ||
174 | \f | |
7bfd3b9e JB |
175 | |
176 | /* Cooperative threads don't need to have these defined */ | |
177 | ||
216eedfc DH |
178 | #define SCM_CRITICAL_SECTION_START |
179 | #define SCM_CRITICAL_SECTION_END | |
7bfd3b9e JB |
180 | |
181 | \f | |
182 | ||
183 | #define SCM_NO_CRITICAL_SECTION_OWNER 0 | |
184 | #define SCM_THREAD_SWITCH_COUNT 50 /* was 10 /mdj */ | |
185 | ||
186 | \f | |
187 | ||
7bfd3b9e JB |
188 | #if 0 |
189 | #define SCM_THREAD_SWITCHING_CODE \ | |
d3a6bc94 | 190 | do { \ |
7bfd3b9e JB |
191 | if (scm_thread_count > 1) \ |
192 | coop_yield(); \ | |
d3a6bc94 | 193 | } while (0) |
7bfd3b9e JB |
194 | |
195 | #else | |
196 | #define SCM_THREAD_SWITCHING_CODE \ | |
d3a6bc94 | 197 | do { \ |
7bfd3b9e JB |
198 | if (scm_thread_count > 1) \ |
199 | { \ | |
200 | scm_switch_counter--; \ | |
201 | if (scm_switch_counter == 0) \ | |
202 | { \ | |
203 | scm_switch_counter = SCM_THREAD_SWITCH_COUNT; \ | |
204 | coop_yield(); \ | |
205 | } \ | |
206 | } \ | |
d3a6bc94 | 207 | } while (0) |
7bfd3b9e JB |
208 | |
209 | #endif | |
210 | ||
32e738bb MD |
211 | /* For pthreads, this is a value associated with a specific key. |
212 | * For coop, we use a special field for increased efficiency. | |
213 | */ | |
7bfd3b9e JB |
214 | #define SCM_THREAD_LOCAL_DATA (coop_global_curr->data) |
215 | #define SCM_SET_THREAD_LOCAL_DATA(ptr) (coop_global_curr->data = (ptr)) | |
216 | ||
0527e687 | 217 | #endif /* SCM_COOP_DEFS_H */ |
89e00824 ML |
218 | |
219 | /* | |
220 | Local Variables: | |
221 | c-file-style: "gnu" | |
222 | End: | |
223 | */ |