Fixed weak alist vectors by having them use weak hash tables instead.
[bpt/guile.git] / libguile / futures.c
CommitLineData
2b829bbb 1/* Copyright (C) 1995,1996,1997,1998,2000,2001, 2002, 2003, 2006 Free Software Foundation, Inc.
6b468ba4 2 *
73be1d9e
MV
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
6b468ba4 7 *
73be1d9e
MV
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
6b468ba4 12 *
73be1d9e
MV
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
92205699 15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
73be1d9e 16 */
6b468ba4
MD
17
18
19\f
20
2f263a6a
MV
21#if 0
22
23/* This whole file is not being compiled. See futures.h for the
24 reason.
25*/
26
6b468ba4
MD
27#include "libguile/_scm.h"
28#include "libguile/eval.h"
29#include "libguile/ports.h"
30#include "libguile/validate.h"
31#include "libguile/stime.h"
32#include "libguile/threads.h"
33
34#include "libguile/futures.h"
35
36#define LINK(list, obj) \
37do { \
38 SCM_SET_FUTURE_NEXT (obj, list); \
39 list = obj; \
40} while (0)
41
42#define UNLINK(list, obj) \
43do { \
44 obj = list; \
45 list = SCM_FUTURE_NEXT (list); \
46} while (0)
47
9de87eea 48scm_i_pthread_mutex_t future_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
6b468ba4
MD
49
50static SCM futures = SCM_EOL;
51static SCM young = SCM_EOL;
52static SCM old = SCM_EOL;
53static SCM undead = SCM_EOL;
54
55static long last_switch;
56
57#ifdef SCM_FUTURES_DEBUG
58static int n_dead = 0;
59
60static SCM
61count (SCM ls)
62{
63 int n = 0;
d2e53ed6 64 while (!scm_is_null (ls))
6b468ba4
MD
65 {
66 ++n;
67 ls = SCM_FUTURE_NEXT (ls);
68 }
e11e83f3 69 return scm_from_int (n);
6b468ba4
MD
70}
71
72extern SCM scm_future_cache_status (void);
73
74SCM_DEFINE (scm_future_cache_status, "future-cache-status", 0, 0, 0,
75 (),
76 "Return a list containing number of futures, youngs, olds, undeads and deads.")
77#define FUNC_NAME s_scm_future_cache_status
78{
79 int nd = n_dead;
80 n_dead = 0;
81 return scm_list_5 (count (futures),
82 count (young),
83 count (old),
84 count (undead),
e11e83f3 85 scm_from_int (nd));
6b468ba4
MD
86}
87#undef FUNC_NAME
88
89#endif
90
91SCM *scm_loc_sys_thread_handler;
92
93SCM_DEFINE (scm_make_future, "make-future", 1, 0, 0,
94 (SCM thunk),
95 "Make a future evaluating THUNK.")
96#define FUNC_NAME s_scm_make_future
97{
98 SCM_VALIDATE_THUNK (1, thunk);
99 return scm_i_make_future (thunk);
100}
101#undef FUNC_NAME
102
103static char *s_future = "future";
104
105static void
106cleanup (scm_t_future *future)
107{
9de87eea
MV
108 scm_i_pthread_mutex_destroy (&future->mutex);
109 scm_i_pthread_cond_destroy (&future->cond);
6b468ba4
MD
110 scm_gc_free (future, sizeof (*future), s_future);
111#ifdef SCM_FUTURES_DEBUG
112 ++n_dead;
113#endif
114}
115
116static SCM
117future_loop (scm_t_future *future)
118{
9de87eea 119 scm_i_scm_pthread_mutex_lock (&future->mutex);
6b468ba4
MD
120 do {
121 if (future->status == SCM_FUTURE_SIGNAL_ME)
9de87eea 122 scm_i_pthread_cond_broadcast (&future->cond);
6b468ba4
MD
123 future->status = SCM_FUTURE_COMPUTING;
124 future->data = (SCM_CLOSUREP (future->data)
125 ? scm_i_call_closure_0 (future->data)
126 : scm_call_0 (future->data));
9de87eea 127 scm_i_scm_pthread_cond_wait (&future->cond, &future->mutex);
6b468ba4
MD
128 } while (!future->die_p);
129 future->status = SCM_FUTURE_DEAD;
9de87eea 130 scm_i_pthread_mutex_unlock (&future->mutex);
6b468ba4
MD
131 return SCM_UNSPECIFIED;
132}
133
134static SCM
135future_handler (scm_t_future *future, SCM key, SCM args)
136{
137 future->status = SCM_FUTURE_DEAD;
9de87eea 138 scm_i_pthread_mutex_unlock (&future->mutex);
6b468ba4
MD
139 return scm_apply_1 (*scm_loc_sys_thread_handler, key, args);
140}
141
142static SCM
143alloc_future (SCM thunk)
144{
145 scm_t_future *f = scm_gc_malloc (sizeof (*f), s_future);
146 SCM future;
147 f->data = SCM_BOOL_F;
9de87eea
MV
148 scm_i_pthread_mutex_init (&f->mutex, NULL);
149 scm_i_pthread_cond_init (&f->cond, NULL);
6b468ba4
MD
150 f->die_p = 0;
151 f->status = SCM_FUTURE_TASK_ASSIGNED;
9de87eea 152 scm_i_scm_pthread_mutex_lock (&future_admin_mutex);
6b468ba4
MD
153 SCM_NEWSMOB2 (future, scm_tc16_future, futures, f);
154 SCM_SET_FUTURE_DATA (future, thunk);
155 futures = future;
9de87eea 156 scm_i_pthread_mutex_unlock (&future_admin_mutex);
6b468ba4
MD
157 scm_spawn_thread ((scm_t_catch_body) future_loop,
158 SCM_FUTURE (future),
159 (scm_t_catch_handler) future_handler,
160 SCM_FUTURE (future));
161 return future;
162}
163
164static void
165kill_future (SCM future)
166{
167 SCM_FUTURE (future)->die_p = 1;
168 LINK (undead, future);
169}
170
171SCM
172scm_i_make_future (SCM thunk)
173{
174 SCM future;
9de87eea 175 scm_i_scm_pthread_mutex_lock (&future_admin_mutex);
6b468ba4
MD
176 while (1)
177 {
d2e53ed6 178 if (!scm_is_null (old))
6b468ba4 179 UNLINK (old, future);
d2e53ed6 180 else if (!scm_is_null (young))
6b468ba4
MD
181 UNLINK (young, future);
182 else
183 {
9de87eea 184 scm_i_pthread_mutex_unlock (&future_admin_mutex);
6b468ba4
MD
185 return alloc_future (thunk);
186 }
9de87eea 187 if (scm_i_pthread_mutex_trylock (SCM_FUTURE_MUTEX (future)))
6b468ba4
MD
188 kill_future (future);
189 else if (!SCM_FUTURE_ALIVE_P (future))
190 {
9de87eea 191 scm_i_pthread_mutex_unlock (SCM_FUTURE_MUTEX (future));
6b468ba4
MD
192 cleanup (SCM_FUTURE (future));
193 }
194 else
195 break;
196 }
197 LINK (futures, future);
9de87eea 198 scm_i_pthread_mutex_unlock (&future_admin_mutex);
6b468ba4
MD
199 SCM_SET_FUTURE_DATA (future, thunk);
200 SCM_SET_FUTURE_STATUS (future, SCM_FUTURE_TASK_ASSIGNED);
9de87eea
MV
201 scm_i_pthread_cond_signal (SCM_FUTURE_COND (future));
202 scm_i_pthread_mutex_unlock (SCM_FUTURE_MUTEX (future));
6b468ba4
MD
203 return future;
204}
205
206static SCM
207future_mark (SCM ptr) {
208 return SCM_FUTURE_DATA (ptr);
209}
210
211static int
212future_print (SCM exp, SCM port, scm_print_state *pstate)
213{
214 int writingp = SCM_WRITINGP (pstate);
215 scm_puts ("#<future ", port);
216 SCM_SET_WRITINGP (pstate, 1);
217 scm_iprin1 (SCM_FUTURE_DATA (exp), port, pstate);
218 SCM_SET_WRITINGP (pstate, writingp);
219 scm_putc ('>', port);
220 return !0;
221}
222
223SCM_DEFINE (scm_future_ref, "future-ref", 1, 0, 0,
224 (SCM future),
225 "If the future @var{x} has not been computed yet, compute and\n"
226 "return @var{x}, otherwise just return the previously computed\n"
227 "value.")
228#define FUNC_NAME s_scm_future_ref
229{
230 SCM res;
231 SCM_VALIDATE_FUTURE (1, future);
9de87eea 232 scm_i_scm_pthread_mutex_lock (SCM_FUTURE_MUTEX (future));
6b468ba4
MD
233 if (SCM_FUTURE_STATUS (future) != SCM_FUTURE_COMPUTING)
234 {
235 SCM_SET_FUTURE_STATUS (future, SCM_FUTURE_SIGNAL_ME);
9de87eea
MV
236 scm_i_scm_pthread_cond_wait (SCM_FUTURE_COND (future),
237 SCM_FUTURE_MUTEX (future));
6b468ba4
MD
238 }
239 if (!SCM_FUTURE_ALIVE_P (future))
240 {
9de87eea 241 scm_i_pthread_mutex_unlock (SCM_FUTURE_MUTEX (future));
6b468ba4
MD
242 SCM_MISC_ERROR ("requesting result from failed future ~A",
243 scm_list_1 (future));
244 }
245 res = SCM_FUTURE_DATA (future);
9de87eea 246 scm_i_pthread_mutex_unlock (SCM_FUTURE_MUTEX (future));
6b468ba4
MD
247 return res;
248}
249#undef FUNC_NAME
250
251static void
252kill_futures (SCM victims)
253{
d2e53ed6 254 while (!scm_is_null (victims))
6b468ba4
MD
255 {
256 SCM future;
257 UNLINK (victims, future);
258 kill_future (future);
9de87eea 259 scm_i_pthread_cond_signal (SCM_FUTURE_COND (future));
6b468ba4
MD
260 }
261}
262
263static void
264cleanup_undead ()
265{
266 SCM next = undead, *nextloc = &undead;
d2e53ed6 267 while (!scm_is_null (next))
6b468ba4 268 {
9de87eea 269 if (scm_i_pthread_mutex_trylock (SCM_FUTURE_MUTEX (next)))
6b468ba4
MD
270 goto next;
271 else if (SCM_FUTURE_ALIVE_P (next))
272 {
9de87eea
MV
273 scm_i_pthread_cond_signal (SCM_FUTURE_COND (next));
274 scm_i_pthread_mutex_unlock (SCM_FUTURE_MUTEX (next));
6b468ba4 275 next:
361d631f 276 SCM_SET_GC_MARK (next);
6b468ba4
MD
277 nextloc = SCM_FUTURE_NEXTLOC (next);
278 next = *nextloc;
279 }
280 else
281 {
282 SCM future;
283 UNLINK (next, future);
9de87eea 284 scm_i_pthread_mutex_unlock (SCM_FUTURE_MUTEX (future));
6b468ba4
MD
285 cleanup (SCM_FUTURE (future));
286 *nextloc = next;
287 }
288 }
289}
290
291static void
292mark_futures (SCM futures)
293{
d2e53ed6 294 while (!scm_is_null (futures))
6b468ba4 295 {
6b468ba4
MD
296 SCM_SET_GC_MARK (futures);
297 futures = SCM_FUTURE_NEXT (futures);
298 }
299}
300
301static void *
302scan_futures (void *dummy1, void *dummy2, void *dummy3)
303{
304 SCM next, *nextloc;
305
306 long now = scm_c_get_internal_run_time ();
307 if (now - last_switch > SCM_TIME_UNITS_PER_SECOND)
308 {
309 /* switch out old (> 1 sec), unused futures */
310 kill_futures (old);
311 old = young;
312 young = SCM_EOL;
313 last_switch = now;
314 }
361d631f
MD
315 else
316 mark_futures (young);
6b468ba4
MD
317
318 next = futures;
319 nextloc = &futures;
d2e53ed6 320 while (!scm_is_null (next))
6b468ba4
MD
321 {
322 if (!SCM_GC_MARK_P (next))
323 goto free;
324 keep:
325 nextloc = SCM_FUTURE_NEXTLOC (next);
326 next = *nextloc;
327 }
328 goto exit;
d2e53ed6 329 while (!scm_is_null (next))
6b468ba4
MD
330 {
331 if (SCM_GC_MARK_P (next))
332 {
333 *nextloc = next;
334 goto keep;
335 }
336 free:
337 {
338 SCM future;
339 UNLINK (next, future);
361d631f 340 SCM_SET_GC_MARK (future);
6b468ba4
MD
341 LINK (young, future);
342 }
343 }
344 *nextloc = SCM_EOL;
345 exit:
346 cleanup_undead ();
6b468ba4 347 mark_futures (old);
6b468ba4
MD
348 return 0;
349}
350
9de87eea
MV
351scm_t_bits scm_tc16_future;
352
6b468ba4
MD
353void
354scm_init_futures ()
355{
356 last_switch = scm_c_get_internal_run_time ();
357
358 scm_loc_sys_thread_handler
359 = SCM_VARIABLE_LOC (scm_c_define ("%thread-handler", SCM_BOOL_F));
360
361 scm_tc16_future = scm_make_smob_type ("future", 0);
362 scm_set_smob_mark (scm_tc16_future, future_mark);
363 scm_set_smob_print (scm_tc16_future, future_print);
364
365 scm_c_hook_add (&scm_before_sweep_c_hook, scan_futures, 0, 0);
366#include "libguile/futures.x"
367}
368
2f263a6a
MV
369#endif
370
6b468ba4
MD
371/*
372 Local Variables:
373 c-file-style: "gnu"
374 End:
375*/