Commit | Line | Data |
---|---|---|
5afcf08b | 1 | /* Copyright (C) 1995,1996,1998,2000,2001,2004 Free Software Foundation, Inc. |
0f2d19dd | 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. | |
0f2d19dd | 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. | |
0f2d19dd | 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 | |
15 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
16 | */ | |
1bbd0b84 | 17 | |
1bbd0b84 | 18 | |
0f2d19dd JB |
19 | \f |
20 | ||
bbd43f03 RB |
21 | #include "libguile/_scm.h" |
22 | ||
13070bd3 DH |
23 | #include <string.h> |
24 | ||
d0f6ceb8 | 25 | #include "libguile/debug.h" |
a0599745 MD |
26 | #include "libguile/root.h" |
27 | #include "libguile/stackchk.h" | |
5f144b10 GH |
28 | #include "libguile/smob.h" |
29 | #include "libguile/ports.h" | |
30 | #include "libguile/dynwind.h" | |
ce212434 | 31 | #include "libguile/values.h" |
5f144b10 | 32 | |
db4b4ca6 | 33 | #include "libguile/validate.h" |
a0599745 | 34 | #include "libguile/continuations.h" |
01c8a3dd | 35 | |
0f2d19dd JB |
36 | \f |
37 | ||
38 | /* {Continuations} | |
39 | */ | |
40 | ||
92c2555f | 41 | scm_t_bits scm_tc16_continuation; |
0f2d19dd | 42 | |
e841c3e0 KN |
43 | static SCM |
44 | continuation_mark (SCM obj) | |
5f144b10 | 45 | { |
92c2555f | 46 | scm_t_contregs *continuation = SCM_CONTREGS (obj); |
01c8a3dd | 47 | |
5f144b10 GH |
48 | scm_gc_mark (continuation->throw_value); |
49 | scm_mark_locations (continuation->stack, continuation->num_stack_items); | |
193297d8 RB |
50 | #ifdef __ia64__ |
51 | if (continuation->backing_store) | |
52 | scm_mark_locations (continuation->backing_store, | |
53 | continuation->backing_store_size / | |
54 | sizeof (SCM_STACKITEM)); | |
55 | #endif /* __ia64__ */ | |
5f144b10 GH |
56 | return continuation->dynenv; |
57 | } | |
01c8a3dd | 58 | |
1be6b49c | 59 | static size_t |
e841c3e0 | 60 | continuation_free (SCM obj) |
5f144b10 | 61 | { |
92c2555f | 62 | scm_t_contregs *continuation = SCM_CONTREGS (obj); |
5f144b10 | 63 | /* stack array size is 1 if num_stack_items is 0 (rootcont). */ |
1be6b49c | 64 | size_t extra_items = (continuation->num_stack_items > 0) |
5f144b10 GH |
65 | ? (continuation->num_stack_items - 1) |
66 | : 0; | |
92c2555f | 67 | size_t bytes_free = sizeof (scm_t_contregs) |
5f144b10 | 68 | + extra_items * sizeof (SCM_STACKITEM); |
193297d8 RB |
69 | |
70 | #ifdef __ia64__ | |
4c9419ac MV |
71 | scm_gc_free (continuation->backing_store, continuation->backing_store_size, |
72 | "continuation backing store"); | |
193297d8 | 73 | #endif /* __ia64__ */ |
4c9419ac MV |
74 | scm_gc_free (continuation, bytes_free, "continuation"); |
75 | return 0; | |
5f144b10 | 76 | } |
01c8a3dd | 77 | |
e841c3e0 | 78 | static int |
e81d98ec | 79 | continuation_print (SCM obj, SCM port, scm_print_state *state SCM_UNUSED) |
5f144b10 | 80 | { |
92c2555f | 81 | scm_t_contregs *continuation = SCM_CONTREGS (obj); |
5f144b10 GH |
82 | |
83 | scm_puts ("#<continuation ", port); | |
84 | scm_intprint (continuation->num_stack_items, 10, port); | |
85 | scm_puts (" @ ", port); | |
0345e278 | 86 | scm_uintprint (SCM_CELL_WORD_1 (obj), 16, port); |
5f144b10 GH |
87 | scm_putc ('>', port); |
88 | return 1; | |
89 | } | |
1cc91f1b | 90 | |
193297d8 | 91 | #ifdef __ia64__ |
87855fa2 MV |
92 | /* Extern declaration of getcontext()/setcontext() in order to redefine |
93 | getcontext() since on ia64-linux the second return value indicates whether | |
94 | it returned from getcontext() itself or by running setcontext(). */ | |
193297d8 RB |
95 | struct rv |
96 | { | |
97 | long retval; | |
98 | long first_return; | |
99 | }; | |
78b6566e | 100 | extern struct rv ia64_getcontext (ucontext_t *) __asm__ ("getcontext"); |
193297d8 RB |
101 | #endif /* __ia64__ */ |
102 | ||
5f144b10 GH |
103 | /* this may return more than once: the first time with the escape |
104 | procedure, then subsequently with the value to be passed to the | |
105 | continuation. */ | |
106 | #define FUNC_NAME "scm_make_continuation" | |
0f2d19dd | 107 | SCM |
5f144b10 | 108 | scm_make_continuation (int *first) |
0f2d19dd | 109 | { |
fcba9b58 | 110 | volatile SCM cont; |
92c2555f MV |
111 | scm_t_contregs *continuation; |
112 | scm_t_contregs *rootcont = SCM_CONTREGS (scm_rootcont); | |
c014a02e | 113 | long stack_size; |
01c8a3dd | 114 | SCM_STACKITEM * src; |
193297d8 RB |
115 | #ifdef __ia64__ |
116 | struct rv rv; | |
87855fa2 | 117 | #endif /* __ia64__ */ |
0f2d19dd | 118 | |
f83e2737 | 119 | SCM_ENTER_A_SECTION; |
0f2d19dd | 120 | SCM_FLUSH_REGISTER_WINDOWS; |
5f144b10 | 121 | stack_size = scm_stack_size (rootcont->base); |
4c9419ac MV |
122 | continuation = scm_gc_malloc (sizeof (scm_t_contregs) |
123 | + (stack_size - 1) * sizeof (SCM_STACKITEM), | |
124 | "continuation"); | |
5f144b10 GH |
125 | continuation->num_stack_items = stack_size; |
126 | continuation->dynenv = scm_dynwinds; | |
127 | continuation->throw_value = SCM_EOL; | |
128 | continuation->base = src = rootcont->base; | |
129 | continuation->seq = rootcont->seq; | |
5f144b10 | 130 | continuation->dframe = scm_last_debug_frame; |
5f144b10 GH |
131 | SCM_NEWSMOB (cont, scm_tc16_continuation, continuation); |
132 | SCM_EXIT_A_SECTION; | |
01c8a3dd | 133 | |
4ccb2cd2 | 134 | #if ! SCM_STACK_GROWS_UP |
5f144b10 GH |
135 | src -= stack_size; |
136 | #endif | |
5c5c27dc | 137 | continuation->offset = continuation->stack - src; |
5f144b10 GH |
138 | memcpy (continuation->stack, src, sizeof (SCM_STACKITEM) * stack_size); |
139 | ||
193297d8 | 140 | #ifdef __ia64__ |
78b6566e | 141 | rv = ia64_getcontext (&continuation->ctx); |
193297d8 RB |
142 | if (rv.first_return) |
143 | { | |
144 | continuation->backing_store_size = | |
145 | continuation->ctx.uc_mcontext.sc_ar_bsp - | |
87855fa2 | 146 | (unsigned long) __libc_ia64_register_backing_store_base; |
193297d8 RB |
147 | continuation->backing_store = NULL; |
148 | continuation->backing_store = | |
4c9419ac MV |
149 | scm_gc_malloc (continuation->backing_store_size, |
150 | "continuation backing store"); | |
193297d8 RB |
151 | memcpy (continuation->backing_store, |
152 | (void *) __libc_ia64_register_backing_store_base, | |
153 | continuation->backing_store_size); | |
154 | *first = 1; | |
155 | return cont; | |
156 | } | |
157 | else | |
158 | { | |
3c468478 | 159 | SCM ret = continuation->throw_value; |
193297d8 | 160 | *first = 0; |
3c468478 MV |
161 | continuation->throw_value = SCM_BOOL_F; |
162 | return ret; | |
193297d8 RB |
163 | } |
164 | #else /* !__ia64__ */ | |
5f144b10 GH |
165 | if (setjmp (continuation->jmpbuf)) |
166 | { | |
3c468478 | 167 | SCM ret = continuation->throw_value; |
5f144b10 | 168 | *first = 0; |
3c468478 MV |
169 | continuation->throw_value = SCM_BOOL_F; |
170 | return ret; | |
5f144b10 GH |
171 | } |
172 | else | |
173 | { | |
174 | *first = 1; | |
175 | return cont; | |
176 | } | |
193297d8 | 177 | #endif /* !__ia64__ */ |
0f2d19dd | 178 | } |
5f144b10 | 179 | #undef FUNC_NAME |
0f2d19dd | 180 | |
d3c6aef9 MV |
181 | |
182 | /* Invoking a continuation proceeds as follows: | |
183 | * | |
184 | * - the stack is made large enough for the called continuation | |
185 | * - the old windchain is unwound down to the branching point | |
186 | * - the continuation stack is copied into place | |
187 | * - the windchain is rewound up to the continuation's context | |
188 | * - the continuation is invoked via longjmp (or setcontext) | |
189 | * | |
190 | * This order is important so that unwind and rewind handlers are run | |
191 | * with their correct stack. | |
192 | */ | |
193 | ||
5f144b10 | 194 | static void scm_dynthrow (SCM, SCM); |
01c8a3dd DH |
195 | |
196 | /* Grow the stack by a fixed amount to provide space to copy in the | |
197 | * continuation. Possibly this function has to be called several times | |
198 | * recursively before enough space is available. Make sure the compiler does | |
199 | * not optimize the growth array away by storing it's address into a global | |
200 | * variable. | |
201 | */ | |
202 | ||
92c2555f | 203 | scm_t_bits scm_i_dummy; |
1cc91f1b | 204 | |
0f2d19dd | 205 | static void |
01c8a3dd DH |
206 | grow_stack (SCM cont, SCM val) |
207 | { | |
92c2555f | 208 | scm_t_bits growth[100]; |
01c8a3dd | 209 | |
92c2555f | 210 | scm_i_dummy = (scm_t_bits) growth; |
01c8a3dd | 211 | scm_dynthrow (cont, val); |
0f2d19dd | 212 | } |
0f2d19dd | 213 | |
1cc91f1b | 214 | |
01c8a3dd DH |
215 | /* Copy the continuation stack into the current stack. Calling functions from |
216 | * within this function is safe, since only stack frames below this function's | |
217 | * own frame are overwritten. Thus, memcpy can be used for best performance. | |
218 | */ | |
d3c6aef9 MV |
219 | |
220 | typedef struct { | |
221 | scm_t_contregs *continuation; | |
222 | SCM_STACKITEM *dst; | |
223 | } copy_stack_data; | |
224 | ||
01c8a3dd | 225 | static void |
d3c6aef9 MV |
226 | copy_stack (void *data) |
227 | { | |
228 | copy_stack_data *d = (copy_stack_data *)data; | |
229 | memcpy (d->dst, d->continuation->stack, | |
230 | sizeof (SCM_STACKITEM) * d->continuation->num_stack_items); | |
231 | } | |
232 | ||
233 | static void | |
234 | copy_stack_and_call (scm_t_contregs *continuation, SCM val, | |
5f144b10 | 235 | SCM_STACKITEM * dst) |
0f2d19dd | 236 | { |
d3c6aef9 MV |
237 | long delta; |
238 | copy_stack_data data; | |
239 | ||
240 | delta = scm_ilength (scm_dynwinds) - scm_ilength (continuation->dynenv); | |
241 | data.continuation = continuation; | |
242 | data.dst = dst; | |
14578fa4 | 243 | scm_i_dowinds (continuation->dynenv, delta, copy_stack, &data); |
01c8a3dd | 244 | |
5f144b10 | 245 | scm_last_debug_frame = continuation->dframe; |
01c8a3dd | 246 | |
5f144b10 | 247 | continuation->throw_value = val; |
193297d8 RB |
248 | #ifdef __ia64__ |
249 | memcpy ((void *) __libc_ia64_register_backing_store_base, | |
250 | continuation->backing_store, | |
251 | continuation->backing_store_size); | |
252 | setcontext (&continuation->ctx); | |
253 | #else | |
5f144b10 | 254 | longjmp (continuation->jmpbuf, 1); |
193297d8 | 255 | #endif |
01c8a3dd DH |
256 | } |
257 | ||
01c8a3dd DH |
258 | /* Call grow_stack until the stack space is large enough, then, as the current |
259 | * stack frame might get overwritten, let copy_stack_and_call perform the | |
260 | * actual copying and continuation calling. | |
261 | */ | |
262 | static void | |
263 | scm_dynthrow (SCM cont, SCM val) | |
264 | { | |
92c2555f | 265 | scm_t_contregs *continuation = SCM_CONTREGS (cont); |
01c8a3dd DH |
266 | SCM_STACKITEM * dst = SCM_BASE (scm_rootcont); |
267 | SCM_STACKITEM stack_top_element; | |
268 | ||
4ccb2cd2 | 269 | #if SCM_STACK_GROWS_UP |
5afcf08b | 270 | if (dst + continuation->num_stack_items >= &stack_top_element) |
01c8a3dd | 271 | grow_stack (cont, val); |
0f2d19dd | 272 | #else |
5f144b10 | 273 | dst -= continuation->num_stack_items; |
c8a1bdc4 | 274 | if (dst <= &stack_top_element) |
01c8a3dd | 275 | grow_stack (cont, val); |
0f2d19dd | 276 | #endif /* def SCM_STACK_GROWS_UP */ |
01c8a3dd | 277 | |
5f144b10 GH |
278 | SCM_FLUSH_REGISTER_WINDOWS; |
279 | copy_stack_and_call (continuation, val, dst); | |
0f2d19dd JB |
280 | } |
281 | ||
db4b4ca6 DH |
282 | |
283 | static SCM | |
284 | continuation_apply (SCM cont, SCM args) | |
5f144b10 | 285 | #define FUNC_NAME "continuation_apply" |
0f2d19dd | 286 | { |
92c2555f MV |
287 | scm_t_contregs *continuation = SCM_CONTREGS (cont); |
288 | scm_t_contregs *rootcont = SCM_CONTREGS (scm_rootcont); | |
5f144b10 | 289 | |
5f144b10 GH |
290 | if (continuation->seq != rootcont->seq |
291 | /* this base comparison isn't needed */ | |
292 | || continuation->base != rootcont->base) | |
293 | { | |
db4b4ca6 | 294 | SCM_MISC_ERROR ("continuation from wrong top level: ~S", |
1afff620 | 295 | scm_list_1 (cont)); |
5f144b10 | 296 | } |
0f2d19dd | 297 | |
ce212434 | 298 | scm_dynthrow (cont, scm_values (args)); |
0f2d19dd JB |
299 | return SCM_UNSPECIFIED; /* not reached */ |
300 | } | |
5f144b10 | 301 | #undef FUNC_NAME |
0f2d19dd | 302 | |
db4b4ca6 | 303 | |
0f2d19dd JB |
304 | void |
305 | scm_init_continuations () | |
0f2d19dd | 306 | { |
5f144b10 GH |
307 | scm_tc16_continuation = scm_make_smob_type ("continuation", 0); |
308 | scm_set_smob_mark (scm_tc16_continuation, continuation_mark); | |
309 | scm_set_smob_free (scm_tc16_continuation, continuation_free); | |
310 | scm_set_smob_print (scm_tc16_continuation, continuation_print); | |
311 | scm_set_smob_apply (scm_tc16_continuation, continuation_apply, 0, 0, 1); | |
a0599745 | 312 | #include "libguile/continuations.x" |
0f2d19dd JB |
313 | } |
314 | ||
89e00824 ML |
315 | /* |
316 | Local Variables: | |
317 | c-file-style: "gnu" | |
318 | End: | |
319 | */ |