Commit | Line | Data |
---|---|---|
aab9d46c | 1 | /* Copyright (C) 2001, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc. |
a98cef7e | 2 | * |
560b9c25 | 3 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
4 | * modify it under the terms of the GNU Lesser General Public License |
5 | * as published by the Free Software Foundation; either version 3 of | |
6 | * the License, or (at your option) any later version. | |
a98cef7e | 7 | * |
53befeb7 NJ |
8 | * This library is distributed in the hope that it will be useful, but |
9 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
560b9c25 AW |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
a98cef7e | 12 | * |
560b9c25 AW |
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 | |
53befeb7 NJ |
15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
16 | * 02110-1301 USA | |
560b9c25 | 17 | */ |
a98cef7e | 18 | |
13c47753 AW |
19 | #if HAVE_CONFIG_H |
20 | # include <config.h> | |
21 | #endif | |
22 | ||
da8b4747 | 23 | #include <stdlib.h> |
6d14383e | 24 | #include <alloca.h> |
daccfef4 | 25 | #include <alignof.h> |
17e90c5e | 26 | #include <string.h> |
e78d4bf9 | 27 | #include <stdint.h> |
e3eb628d | 28 | |
1c44468d | 29 | #include "libguile/bdw-gc.h" |
e3eb628d LC |
30 | #include <gc/gc_mark.h> |
31 | ||
560b9c25 | 32 | #include "_scm.h" |
adaf86ec | 33 | #include "control.h" |
ac99cb0c | 34 | #include "frames.h" |
17e90c5e | 35 | #include "instructions.h" |
8f5cfc81 | 36 | #include "objcodes.h" |
ac99cb0c | 37 | #include "programs.h" |
a98cef7e | 38 | #include "vm.h" |
486013d6 | 39 | #include "vm-builtins.h" |
a98cef7e | 40 | |
aab9d46c SIT |
41 | #include "private-gc.h" /* scm_getenv_int */ |
42 | ||
97b18a66 | 43 | static int vm_default_engine = SCM_VM_REGULAR_ENGINE; |
ea9f4f4b AW |
44 | |
45 | /* Unfortunately we can't snarf these: snarfed things are only loaded up from | |
46 | (system vm vm), which might not be loaded before an error happens. */ | |
47 | static SCM sym_vm_run; | |
48 | static SCM sym_vm_error; | |
49 | static SCM sym_keyword_argument_error; | |
50 | static SCM sym_regular; | |
51 | static SCM sym_debug; | |
a98cef7e | 52 | |
11ea1aba AW |
53 | /* The VM has a number of internal assertions that shouldn't normally be |
54 | necessary, but might be if you think you found a bug in the VM. */ | |
55 | #define VM_ENABLE_ASSERTIONS | |
56 | ||
57 | /* We can add a mode that ensures that all stack items above the stack pointer | |
58 | are NULL. This is useful for checking the internal consistency of the VM's | |
59 | assumptions and its operators, but isn't necessary for normal operation. It | |
616167fc | 60 | will ensure that assertions are enabled. Slows down the VM by about 30%. */ |
747a1635 | 61 | /* NB! If you enable this, search for NULLING in throw.c */ |
616167fc | 62 | /* #define VM_ENABLE_STACK_NULLING */ |
11ea1aba | 63 | |
53e28ed9 AW |
64 | /* #define VM_ENABLE_PARANOID_ASSERTIONS */ |
65 | ||
11ea1aba AW |
66 | #if defined (VM_ENABLE_STACK_NULLING) && !defined (VM_ENABLE_ASSERTIONS) |
67 | #define VM_ENABLE_ASSERTIONS | |
68 | #endif | |
69 | ||
e3eb628d LC |
70 | /* When defined, arrange so that the GC doesn't scan the VM stack beyond its |
71 | current SP. This should help avoid excess data retention. See | |
72 | http://thread.gmane.org/gmane.comp.programming.garbage-collection.boehmgc/3001 | |
73 | for a discussion. */ | |
74 | #define VM_ENABLE_PRECISE_STACK_GC_SCAN | |
75 | ||
f1046e6b LC |
76 | /* Size in SCM objects of the stack reserve. The reserve is used to run |
77 | exception handling code in case of a VM stack overflow. */ | |
78 | #define VM_STACK_RESERVE_SIZE 512 | |
79 | ||
e3eb628d | 80 | |
a98cef7e | 81 | \f |
a98cef7e KN |
82 | /* |
83 | * VM Continuation | |
84 | */ | |
85 | ||
6f3b0cc2 AW |
86 | void |
87 | scm_i_vm_cont_print (SCM x, SCM port, scm_print_state *pstate) | |
88 | { | |
0607ebbf | 89 | scm_puts_unlocked ("#<vm-continuation ", port); |
6f3b0cc2 | 90 | scm_uintprint (SCM_UNPACK (x), 16, port); |
0607ebbf | 91 | scm_puts_unlocked (">", port); |
6f3b0cc2 | 92 | } |
17e90c5e | 93 | |
d8873dfe AW |
94 | /* In theory, a number of vm instances can be active in the call trace, and we |
95 | only want to reify the continuations of those in the current continuation | |
96 | root. I don't see a nice way to do this -- ideally it would involve dynwinds, | |
97 | and previous values of the *the-vm* fluid within the current continuation | |
98 | root. But we don't have access to continuation roots in the dynwind stack. | |
99 | So, just punt for now, we just capture the continuation for the current VM. | |
100 | ||
101 | While I'm on the topic, ideally we could avoid copying the C stack if the | |
102 | continuation root is inside VM code, and call/cc was invoked within that same | |
103 | call to vm_run; but that's currently not implemented. | |
104 | */ | |
cee1d22c AW |
105 | SCM |
106 | scm_i_vm_capture_stack (SCM *stack_base, SCM *fp, SCM *sp, scm_t_uint8 *ra, | |
9ede013f AW |
107 | scm_t_uint8 *mvra, scm_t_dynstack *dynstack, |
108 | scm_t_uint32 flags) | |
a98cef7e | 109 | { |
d8873dfe AW |
110 | struct scm_vm_cont *p; |
111 | ||
112 | p = scm_gc_malloc (sizeof (*p), "capture_vm_cont"); | |
113 | p->stack_size = sp - stack_base + 1; | |
d8eeb67c LC |
114 | p->stack_base = scm_gc_malloc (p->stack_size * sizeof (SCM), |
115 | "capture_vm_cont"); | |
d8873dfe AW |
116 | #if defined(VM_ENABLE_STACK_NULLING) && 0 |
117 | /* Tail continuations leave their frame on the stack for subsequent | |
118 | application, but don't capture the frame -- so there are some elements on | |
119 | the stack then, and this check doesn't work, so disable it for now. */ | |
120 | if (sp >= vp->stack_base) | |
66db076a AW |
121 | if (!vp->sp[0] || vp->sp[1]) |
122 | abort (); | |
11ea1aba AW |
123 | memset (p->stack_base, 0, p->stack_size * sizeof (SCM)); |
124 | #endif | |
d8873dfe AW |
125 | p->ra = ra; |
126 | p->mvra = mvra; | |
127 | p->sp = sp; | |
128 | p->fp = fp; | |
129 | memcpy (p->stack_base, stack_base, (sp + 1 - stack_base) * sizeof (SCM)); | |
130 | p->reloc = p->stack_base - stack_base; | |
9ede013f | 131 | p->dynstack = dynstack; |
cee1d22c | 132 | p->flags = flags; |
6f3b0cc2 | 133 | return scm_cell (scm_tc7_vm_cont, (scm_t_bits)p); |
a98cef7e KN |
134 | } |
135 | ||
136 | static void | |
d8873dfe | 137 | vm_return_to_continuation (SCM vm, SCM cont, size_t n, SCM *argv) |
a98cef7e | 138 | { |
d8873dfe AW |
139 | struct scm_vm *vp; |
140 | struct scm_vm_cont *cp; | |
141 | SCM *argv_copy; | |
142 | ||
143 | argv_copy = alloca (n * sizeof(SCM)); | |
144 | memcpy (argv_copy, argv, n * sizeof(SCM)); | |
145 | ||
146 | vp = SCM_VM_DATA (vm); | |
147 | cp = SCM_VM_CONT_DATA (cont); | |
148 | ||
149 | if (n == 0 && !cp->mvra) | |
150 | scm_misc_error (NULL, "Too few values returned to continuation", | |
151 | SCM_EOL); | |
152 | ||
03f16599 | 153 | if (vp->stack_size < cp->stack_size + n + 4) |
29366989 AW |
154 | scm_misc_error ("vm-engine", "not enough space to reinstate continuation", |
155 | scm_list_2 (vm, cont)); | |
156 | ||
11ea1aba AW |
157 | #ifdef VM_ENABLE_STACK_NULLING |
158 | { | |
d8873dfe | 159 | scm_t_ptrdiff nzero = (vp->sp - cp->sp); |
11ea1aba | 160 | if (nzero > 0) |
d8873dfe | 161 | memset (vp->stack_base + cp->stack_size, 0, nzero * sizeof (SCM)); |
66db076a AW |
162 | /* actually nzero should always be negative, because vm_reset_stack will |
163 | unwind the stack to some point *below* this continuation */ | |
11ea1aba AW |
164 | } |
165 | #endif | |
d8873dfe AW |
166 | vp->sp = cp->sp; |
167 | vp->fp = cp->fp; | |
168 | memcpy (vp->stack_base, cp->stack_base, cp->stack_size * sizeof (SCM)); | |
bfffd258 | 169 | |
03f16599 AW |
170 | { |
171 | size_t i; | |
172 | ||
173 | /* Push on an empty frame, as the continuation expects. */ | |
174 | for (i = 0; i < 4; i++) | |
175 | { | |
176 | vp->sp++; | |
177 | *vp->sp = SCM_BOOL_F; | |
178 | } | |
179 | ||
180 | /* Push the return values. */ | |
181 | for (i = 0; i < n; i++) | |
182 | { | |
183 | vp->sp++; | |
184 | *vp->sp = argv_copy[i]; | |
185 | } | |
186 | vp->ip = cp->mvra; | |
187 | } | |
d8873dfe | 188 | } |
bfffd258 | 189 | |
bfffd258 | 190 | SCM |
9ede013f | 191 | scm_i_capture_current_stack (void) |
bfffd258 | 192 | { |
9ede013f AW |
193 | scm_i_thread *thread; |
194 | SCM vm; | |
195 | struct scm_vm *vp; | |
196 | ||
197 | thread = SCM_I_CURRENT_THREAD; | |
198 | vm = scm_the_vm (); | |
199 | vp = SCM_VM_DATA (vm); | |
200 | ||
201 | return scm_i_vm_capture_stack (vp->stack_base, vp->fp, vp->sp, vp->ip, NULL, | |
202 | scm_dynstack_capture_all (&thread->dynstack), | |
203 | 0); | |
a98cef7e KN |
204 | } |
205 | ||
c850a0ff AW |
206 | static void vm_dispatch_hook (SCM vm, int hook_num, |
207 | SCM *argv, int n) SCM_NOINLINE; | |
208 | ||
b1b942b7 | 209 | static void |
c850a0ff | 210 | vm_dispatch_hook (SCM vm, int hook_num, SCM *argv, int n) |
b1b942b7 | 211 | { |
7656f194 AW |
212 | struct scm_vm *vp; |
213 | SCM hook; | |
b3567435 | 214 | struct scm_frame c_frame; |
8e4c60ff | 215 | scm_t_cell *frame; |
893fb8d0 | 216 | int saved_trace_level; |
b1b942b7 | 217 | |
7656f194 AW |
218 | vp = SCM_VM_DATA (vm); |
219 | hook = vp->hooks[hook_num]; | |
b1b942b7 | 220 | |
7656f194 AW |
221 | if (SCM_LIKELY (scm_is_false (hook)) |
222 | || scm_is_null (SCM_HOOK_PROCEDURES (hook))) | |
223 | return; | |
b3567435 | 224 | |
893fb8d0 AW |
225 | saved_trace_level = vp->trace_level; |
226 | vp->trace_level = 0; | |
b3567435 LC |
227 | |
228 | /* Allocate a frame object on the stack. This is more efficient than calling | |
229 | `scm_c_make_frame ()' to allocate on the heap, but it forces hooks to not | |
230 | capture frame objects. | |
231 | ||
232 | At the same time, procedures such as `frame-procedure' make sense only | |
233 | while the stack frame represented by the frame object is visible, so it | |
234 | seems reasonable to limit the lifetime of frame objects. */ | |
235 | ||
236 | c_frame.stack_holder = vm; | |
237 | c_frame.fp = vp->fp; | |
238 | c_frame.sp = vp->sp; | |
239 | c_frame.ip = vp->ip; | |
240 | c_frame.offset = 0; | |
8e4c60ff LC |
241 | |
242 | /* Arrange for FRAME to be 8-byte aligned, like any other cell. */ | |
243 | frame = alloca (sizeof (*frame) + 8); | |
244 | frame = (scm_t_cell *) ROUND_UP ((scm_t_uintptr) frame, 8UL); | |
245 | ||
246 | frame->word_0 = SCM_PACK (scm_tc7_frame); | |
21041372 | 247 | frame->word_1 = SCM_PACK_POINTER (&c_frame); |
b3567435 | 248 | |
c850a0ff AW |
249 | if (n == 0) |
250 | { | |
251 | SCM args[1]; | |
252 | ||
253 | args[0] = SCM_PACK_POINTER (frame); | |
254 | scm_c_run_hookn (hook, args, 1); | |
255 | } | |
256 | else if (n == 1) | |
257 | { | |
258 | SCM args[2]; | |
259 | ||
260 | args[0] = SCM_PACK_POINTER (frame); | |
261 | args[1] = argv[0]; | |
262 | scm_c_run_hookn (hook, args, 2); | |
263 | } | |
264 | else | |
265 | { | |
266 | SCM args = SCM_EOL; | |
267 | ||
268 | while (n--) | |
269 | args = scm_cons (argv[n], args); | |
270 | scm_c_run_hook (hook, scm_cons (SCM_PACK_POINTER (frame), args)); | |
271 | } | |
b3567435 | 272 | |
893fb8d0 | 273 | vp->trace_level = saved_trace_level; |
b1b942b7 AW |
274 | } |
275 | ||
4f66bcde | 276 | static void |
99511cd0 AW |
277 | vm_abort (SCM vm, SCM tag, size_t nstack, SCM *stack_args, SCM tail, SCM *sp, |
278 | scm_i_jmp_buf *current_registers) SCM_NORETURN; | |
9d381ba4 AW |
279 | |
280 | static void | |
99511cd0 AW |
281 | vm_abort (SCM vm, SCM tag, size_t nstack, SCM *stack_args, SCM tail, SCM *sp, |
282 | scm_i_jmp_buf *current_registers) | |
4f66bcde | 283 | { |
eaefabee | 284 | size_t i; |
2d026f04 | 285 | ssize_t tail_len; |
99511cd0 | 286 | SCM *argv; |
eaefabee | 287 | |
2d026f04 AW |
288 | tail_len = scm_ilength (tail); |
289 | if (tail_len < 0) | |
29366989 AW |
290 | scm_misc_error ("vm-engine", "tail values to abort should be a list", |
291 | scm_list_1 (tail)); | |
292 | ||
99511cd0 AW |
293 | argv = alloca ((nstack + tail_len) * sizeof (SCM)); |
294 | for (i = 0; i < nstack; i++) | |
295 | argv[i] = stack_args[i]; | |
296 | for (; i < nstack + tail_len; i++, tail = scm_cdr (tail)) | |
2d026f04 | 297 | argv[i] = scm_car (tail); |
eaefabee | 298 | |
99511cd0 AW |
299 | /* FIXME: NULLSTACK (SCM_VM_DATA (vp)->sp - sp) */ |
300 | SCM_VM_DATA (vm)->sp = sp; | |
301 | ||
302 | scm_c_abort (vm, tag, nstack + tail_len, argv, current_registers); | |
cee1d22c AW |
303 | } |
304 | ||
9d381ba4 AW |
305 | static void |
306 | vm_reinstate_partial_continuation (SCM vm, SCM cont, size_t n, SCM *argv, | |
307 | scm_t_dynstack *dynstack, | |
308 | scm_i_jmp_buf *registers) | |
cee1d22c | 309 | { |
07801437 AW |
310 | struct scm_vm *vp; |
311 | struct scm_vm_cont *cp; | |
312 | SCM *argv_copy, *base; | |
9ede013f | 313 | scm_t_ptrdiff reloc; |
07801437 AW |
314 | size_t i; |
315 | ||
316 | argv_copy = alloca (n * sizeof(SCM)); | |
317 | memcpy (argv_copy, argv, n * sizeof(SCM)); | |
318 | ||
319 | vp = SCM_VM_DATA (vm); | |
320 | cp = SCM_VM_CONT_DATA (cont); | |
321 | base = SCM_FRAME_UPPER_ADDRESS (vp->fp) + 1; | |
9ede013f | 322 | reloc = cp->reloc + (base - cp->stack_base); |
07801437 | 323 | |
0fc9040f | 324 | #define RELOC(scm_p) \ |
9ede013f | 325 | (((SCM *) (scm_p)) + reloc) |
07801437 AW |
326 | |
327 | if ((base - vp->stack_base) + cp->stack_size + n + 1 > vp->stack_size) | |
29366989 AW |
328 | scm_misc_error ("vm-engine", |
329 | "not enough space to instate partial continuation", | |
330 | scm_list_2 (vm, cont)); | |
07801437 AW |
331 | |
332 | memcpy (base, cp->stack_base, cp->stack_size * sizeof (SCM)); | |
333 | ||
334 | /* now relocate frame pointers */ | |
335 | { | |
336 | SCM *fp; | |
337 | for (fp = RELOC (cp->fp); | |
338 | SCM_FRAME_LOWER_ADDRESS (fp) > base; | |
339 | fp = SCM_FRAME_DYNAMIC_LINK (fp)) | |
340 | SCM_FRAME_SET_DYNAMIC_LINK (fp, RELOC (SCM_FRAME_DYNAMIC_LINK (fp))); | |
341 | } | |
342 | ||
343 | vp->sp = base - 1 + cp->stack_size; | |
344 | vp->fp = RELOC (cp->fp); | |
345 | vp->ip = cp->mvra; | |
346 | ||
07801437 AW |
347 | /* now push args. ip is in a MV context. */ |
348 | for (i = 0; i < n; i++) | |
349 | { | |
350 | vp->sp++; | |
351 | *vp->sp = argv_copy[i]; | |
352 | } | |
186b56c4 AW |
353 | #if 0 |
354 | /* The number-of-values marker, only used by the stack VM. */ | |
07801437 AW |
355 | vp->sp++; |
356 | *vp->sp = scm_from_size_t (n); | |
186b56c4 | 357 | #endif |
9a1c6f1f | 358 | |
9d381ba4 AW |
359 | /* The prompt captured a slice of the dynamic stack. Here we wind |
360 | those entries onto the current thread's stack. We also have to | |
361 | relocate any prompts that we see along the way. */ | |
362 | { | |
363 | scm_t_bits *walk; | |
364 | ||
365 | for (walk = SCM_DYNSTACK_FIRST (cp->dynstack); | |
366 | SCM_DYNSTACK_TAG (walk); | |
367 | walk = SCM_DYNSTACK_NEXT (walk)) | |
368 | { | |
369 | scm_t_bits tag = SCM_DYNSTACK_TAG (walk); | |
370 | ||
371 | if (SCM_DYNSTACK_TAG_TYPE (tag) == SCM_DYNSTACK_TYPE_PROMPT) | |
372 | scm_dynstack_wind_prompt (dynstack, walk, reloc, registers); | |
373 | else | |
374 | scm_dynstack_wind_1 (dynstack, walk); | |
375 | } | |
376 | } | |
adbdfd6d | 377 | #undef RELOC |
4f66bcde AW |
378 | } |
379 | ||
380 | \f | |
17e90c5e KN |
381 | /* |
382 | * VM Internal functions | |
383 | */ | |
384 | ||
6f3b0cc2 AW |
385 | void |
386 | scm_i_vm_print (SCM x, SCM port, scm_print_state *pstate) | |
387 | { | |
0a935b2a LC |
388 | const struct scm_vm *vm; |
389 | ||
390 | vm = SCM_VM_DATA (x); | |
391 | ||
0607ebbf | 392 | scm_puts_unlocked ("#<vm ", port); |
0a935b2a LC |
393 | switch (vm->engine) |
394 | { | |
395 | case SCM_VM_REGULAR_ENGINE: | |
0607ebbf | 396 | scm_puts_unlocked ("regular-engine ", port); |
0a935b2a LC |
397 | break; |
398 | ||
399 | case SCM_VM_DEBUG_ENGINE: | |
0607ebbf | 400 | scm_puts_unlocked ("debug-engine ", port); |
0a935b2a LC |
401 | break; |
402 | ||
403 | default: | |
0607ebbf | 404 | scm_puts_unlocked ("unknown-engine ", port); |
0a935b2a | 405 | } |
6f3b0cc2 | 406 | scm_uintprint (SCM_UNPACK (x), 16, port); |
0607ebbf | 407 | scm_puts_unlocked (">", port); |
6f3b0cc2 AW |
408 | } |
409 | ||
53bdfcf0 AW |
410 | \f |
411 | /* | |
412 | * VM Error Handling | |
413 | */ | |
414 | ||
415 | static void vm_error (const char *msg, SCM arg) SCM_NORETURN; | |
4d497b62 AW |
416 | static void vm_error_bad_instruction (scm_t_uint32 inst) SCM_NORETURN SCM_NOINLINE; |
417 | static void vm_error_unbound (SCM proc, SCM sym) SCM_NORETURN SCM_NOINLINE; | |
418 | static void vm_error_unbound_fluid (SCM proc, SCM fluid) SCM_NORETURN SCM_NOINLINE; | |
419 | static void vm_error_not_a_variable (const char *func_name, SCM x) SCM_NORETURN SCM_NOINLINE; | |
420 | static void vm_error_apply_to_non_list (SCM x) SCM_NORETURN SCM_NOINLINE; | |
421 | static void vm_error_kwargs_length_not_even (SCM proc) SCM_NORETURN SCM_NOINLINE; | |
28d5d253 MW |
422 | static void vm_error_kwargs_invalid_keyword (SCM proc, SCM obj) SCM_NORETURN SCM_NOINLINE; |
423 | static void vm_error_kwargs_unrecognized_keyword (SCM proc, SCM kw) SCM_NORETURN SCM_NOINLINE; | |
4d497b62 AW |
424 | static void vm_error_too_many_args (int nargs) SCM_NORETURN SCM_NOINLINE; |
425 | static void vm_error_wrong_num_args (SCM proc) SCM_NORETURN SCM_NOINLINE; | |
426 | static void vm_error_wrong_type_apply (SCM proc) SCM_NORETURN SCM_NOINLINE; | |
427 | static void vm_error_stack_overflow (struct scm_vm *vp) SCM_NORETURN SCM_NOINLINE; | |
428 | static void vm_error_stack_underflow (void) SCM_NORETURN SCM_NOINLINE; | |
429 | static void vm_error_improper_list (SCM x) SCM_NORETURN SCM_NOINLINE; | |
430 | static void vm_error_not_a_pair (const char *subr, SCM x) SCM_NORETURN SCM_NOINLINE; | |
431 | static void vm_error_not_a_bytevector (const char *subr, SCM x) SCM_NORETURN SCM_NOINLINE; | |
432 | static void vm_error_not_a_struct (const char *subr, SCM x) SCM_NORETURN SCM_NOINLINE; | |
433 | static void vm_error_no_values (void) SCM_NORETURN SCM_NOINLINE; | |
434 | static void vm_error_not_enough_values (void) SCM_NORETURN SCM_NOINLINE; | |
82f4bac4 | 435 | static void vm_error_wrong_number_of_values (scm_t_uint32 expected) SCM_NORETURN SCM_NOINLINE; |
4d497b62 AW |
436 | static void vm_error_continuation_not_rewindable (SCM cont) SCM_NORETURN SCM_NOINLINE; |
437 | static void vm_error_bad_wide_string_length (size_t len) SCM_NORETURN SCM_NOINLINE; | |
53bdfcf0 AW |
438 | |
439 | static void | |
440 | vm_error (const char *msg, SCM arg) | |
441 | { | |
442 | scm_throw (sym_vm_error, | |
443 | scm_list_3 (sym_vm_run, scm_from_latin1_string (msg), | |
444 | SCM_UNBNDP (arg) ? SCM_EOL : scm_list_1 (arg))); | |
445 | abort(); /* not reached */ | |
446 | } | |
447 | ||
448 | static void | |
449 | vm_error_bad_instruction (scm_t_uint32 inst) | |
450 | { | |
451 | vm_error ("VM: Bad instruction: ~s", scm_from_uint32 (inst)); | |
452 | } | |
453 | ||
454 | static void | |
455 | vm_error_unbound (SCM proc, SCM sym) | |
456 | { | |
457 | scm_error_scm (scm_misc_error_key, proc, | |
458 | scm_from_latin1_string ("Unbound variable: ~s"), | |
459 | scm_list_1 (sym), SCM_BOOL_F); | |
460 | } | |
461 | ||
462 | static void | |
463 | vm_error_unbound_fluid (SCM proc, SCM fluid) | |
464 | { | |
465 | scm_error_scm (scm_misc_error_key, proc, | |
466 | scm_from_latin1_string ("Unbound fluid: ~s"), | |
467 | scm_list_1 (fluid), SCM_BOOL_F); | |
468 | } | |
469 | ||
470 | static void | |
471 | vm_error_not_a_variable (const char *func_name, SCM x) | |
472 | { | |
473 | scm_error (scm_arg_type_key, func_name, "Not a variable: ~S", | |
474 | scm_list_1 (x), scm_list_1 (x)); | |
475 | } | |
476 | ||
53bdfcf0 AW |
477 | static void |
478 | vm_error_apply_to_non_list (SCM x) | |
479 | { | |
480 | scm_error (scm_arg_type_key, "apply", "Apply to non-list: ~S", | |
481 | scm_list_1 (x), scm_list_1 (x)); | |
482 | } | |
483 | ||
484 | static void | |
485 | vm_error_kwargs_length_not_even (SCM proc) | |
486 | { | |
487 | scm_error_scm (sym_keyword_argument_error, proc, | |
488 | scm_from_latin1_string ("Odd length of keyword argument list"), | |
489 | SCM_EOL, SCM_BOOL_F); | |
490 | } | |
491 | ||
492 | static void | |
4af0d97e | 493 | vm_error_kwargs_invalid_keyword (SCM proc, SCM obj) |
53bdfcf0 AW |
494 | { |
495 | scm_error_scm (sym_keyword_argument_error, proc, | |
496 | scm_from_latin1_string ("Invalid keyword"), | |
4af0d97e | 497 | SCM_EOL, scm_list_1 (obj)); |
53bdfcf0 AW |
498 | } |
499 | ||
500 | static void | |
4af0d97e | 501 | vm_error_kwargs_unrecognized_keyword (SCM proc, SCM kw) |
53bdfcf0 AW |
502 | { |
503 | scm_error_scm (sym_keyword_argument_error, proc, | |
504 | scm_from_latin1_string ("Unrecognized keyword"), | |
4af0d97e | 505 | SCM_EOL, scm_list_1 (kw)); |
53bdfcf0 AW |
506 | } |
507 | ||
508 | static void | |
509 | vm_error_too_many_args (int nargs) | |
510 | { | |
511 | vm_error ("VM: Too many arguments", scm_from_int (nargs)); | |
512 | } | |
513 | ||
514 | static void | |
515 | vm_error_wrong_num_args (SCM proc) | |
516 | { | |
517 | scm_wrong_num_args (proc); | |
518 | } | |
519 | ||
520 | static void | |
521 | vm_error_wrong_type_apply (SCM proc) | |
522 | { | |
523 | scm_error (scm_arg_type_key, NULL, "Wrong type to apply: ~S", | |
524 | scm_list_1 (proc), scm_list_1 (proc)); | |
525 | } | |
526 | ||
527 | static void | |
528 | vm_error_stack_overflow (struct scm_vm *vp) | |
529 | { | |
530 | if (vp->stack_limit < vp->stack_base + vp->stack_size) | |
531 | /* There are VM_STACK_RESERVE_SIZE bytes left. Make them available so | |
532 | that `throw' below can run on this VM. */ | |
533 | vp->stack_limit = vp->stack_base + vp->stack_size; | |
534 | else | |
535 | /* There is no space left on the stack. FIXME: Do something more | |
536 | sensible here! */ | |
537 | abort (); | |
538 | vm_error ("VM: Stack overflow", SCM_UNDEFINED); | |
539 | } | |
540 | ||
541 | static void | |
542 | vm_error_stack_underflow (void) | |
543 | { | |
544 | vm_error ("VM: Stack underflow", SCM_UNDEFINED); | |
545 | } | |
546 | ||
547 | static void | |
548 | vm_error_improper_list (SCM x) | |
549 | { | |
550 | vm_error ("Expected a proper list, but got object with tail ~s", x); | |
551 | } | |
552 | ||
553 | static void | |
554 | vm_error_not_a_pair (const char *subr, SCM x) | |
555 | { | |
556 | scm_wrong_type_arg_msg (subr, 1, x, "pair"); | |
557 | } | |
558 | ||
559 | static void | |
560 | vm_error_not_a_bytevector (const char *subr, SCM x) | |
561 | { | |
562 | scm_wrong_type_arg_msg (subr, 1, x, "bytevector"); | |
563 | } | |
564 | ||
565 | static void | |
566 | vm_error_not_a_struct (const char *subr, SCM x) | |
567 | { | |
568 | scm_wrong_type_arg_msg (subr, 1, x, "struct"); | |
569 | } | |
570 | ||
571 | static void | |
572 | vm_error_no_values (void) | |
573 | { | |
574 | vm_error ("Zero values returned to single-valued continuation", | |
575 | SCM_UNDEFINED); | |
576 | } | |
577 | ||
578 | static void | |
579 | vm_error_not_enough_values (void) | |
580 | { | |
581 | vm_error ("Too few values returned to continuation", SCM_UNDEFINED); | |
582 | } | |
583 | ||
82f4bac4 AW |
584 | static void |
585 | vm_error_wrong_number_of_values (scm_t_uint32 expected) | |
586 | { | |
587 | vm_error ("Wrong number of values returned to continuation (expected ~a)", | |
588 | scm_from_uint32 (expected)); | |
589 | } | |
590 | ||
53bdfcf0 AW |
591 | static void |
592 | vm_error_continuation_not_rewindable (SCM cont) | |
593 | { | |
594 | vm_error ("Unrewindable partial continuation", cont); | |
595 | } | |
596 | ||
597 | static void | |
598 | vm_error_bad_wide_string_length (size_t len) | |
599 | { | |
600 | vm_error ("VM: Bad wide string length: ~S", scm_from_size_t (len)); | |
601 | } | |
602 | ||
53bdfcf0 AW |
603 | |
604 | \f | |
28b119ee | 605 | |
510ca126 | 606 | static SCM rtl_boot_continuation; |
486013d6 AW |
607 | static SCM vm_builtin_apply; |
608 | static SCM vm_builtin_values; | |
609 | static SCM vm_builtin_abort_to_prompt; | |
610 | static SCM vm_builtin_call_with_values; | |
611 | static SCM vm_builtin_call_with_current_continuation; | |
510ca126 AW |
612 | |
613 | static const scm_t_uint32 rtl_boot_continuation_code[] = { | |
7396d216 | 614 | SCM_PACK_RTL_24 (scm_rtl_op_halt, 0) |
510ca126 AW |
615 | }; |
616 | ||
486013d6 AW |
617 | static const scm_t_uint32 vm_builtin_apply_code[] = { |
618 | SCM_PACK_RTL_24 (scm_rtl_op_assert_nargs_ge, 3), | |
619 | SCM_PACK_RTL_24 (scm_rtl_op_tail_apply, 0), /* proc in r1, args from r2 */ | |
510ca126 AW |
620 | }; |
621 | ||
486013d6 | 622 | static const scm_t_uint32 vm_builtin_values_code[] = { |
af95414f | 623 | SCM_PACK_RTL_24 (scm_rtl_op_return_values, 0) /* vals from r1 */ |
510ca126 AW |
624 | }; |
625 | ||
486013d6 AW |
626 | static const scm_t_uint32 vm_builtin_abort_to_prompt_code[] = { |
627 | SCM_PACK_RTL_24 (scm_rtl_op_assert_nargs_ge, 2), | |
628 | SCM_PACK_RTL_24 (scm_rtl_op_abort, 0), /* tag in r1, vals from r2 */ | |
629 | /* FIXME: Partial continuation should capture caller regs. */ | |
630 | SCM_PACK_RTL_24 (scm_rtl_op_return_values, 0) /* vals from r1 */ | |
631 | }; | |
632 | ||
633 | static const scm_t_uint32 vm_builtin_call_with_values_code[] = { | |
634 | SCM_PACK_RTL_24 (scm_rtl_op_assert_nargs_ee, 3), | |
635 | SCM_PACK_RTL_24 (scm_rtl_op_alloc_frame, 7), | |
636 | SCM_PACK_RTL_12_12 (scm_rtl_op_mov, 6, 1), | |
637 | SCM_PACK_RTL_24 (scm_rtl_op_call, 6), SCM_PACK_RTL_24 (0, 1), | |
638 | SCM_PACK_RTL_12_12 (scm_rtl_op_mov, 0, 2), | |
639 | SCM_PACK_RTL_24 (scm_rtl_op_tail_call_shuffle, 7) | |
640 | }; | |
641 | ||
642 | static const scm_t_uint32 vm_builtin_call_with_current_continuation_code[] = { | |
643 | SCM_PACK_RTL_24 (scm_rtl_op_assert_nargs_ee, 2), | |
644 | SCM_PACK_RTL_24 (scm_rtl_op_call_cc, 0) | |
645 | }; | |
646 | ||
647 | ||
648 | static SCM | |
649 | scm_vm_builtin_ref (unsigned idx) | |
650 | { | |
651 | switch (idx) | |
652 | { | |
9f309e2c | 653 | #define INDEX_TO_NAME(builtin, BUILTIN, req, opt, rest) \ |
486013d6 AW |
654 | case SCM_VM_BUILTIN_##BUILTIN: return vm_builtin_##builtin; |
655 | FOR_EACH_VM_BUILTIN(INDEX_TO_NAME) | |
656 | #undef INDEX_TO_NAME | |
657 | default: abort(); | |
658 | } | |
659 | } | |
660 | ||
9f309e2c | 661 | SCM scm_sym_apply; |
486013d6 AW |
662 | static SCM scm_sym_values; |
663 | static SCM scm_sym_abort_to_prompt; | |
664 | static SCM scm_sym_call_with_values; | |
665 | static SCM scm_sym_call_with_current_continuation; | |
666 | ||
667 | SCM | |
668 | scm_vm_builtin_name_to_index (SCM name) | |
669 | #define FUNC_NAME "builtin-name->index" | |
670 | { | |
671 | SCM_VALIDATE_SYMBOL (1, name); | |
672 | ||
9f309e2c | 673 | #define NAME_TO_INDEX(builtin, BUILTIN, req, opt, rest) \ |
486013d6 AW |
674 | if (scm_is_eq (name, scm_sym_##builtin)) \ |
675 | return scm_from_uint (SCM_VM_BUILTIN_##BUILTIN); | |
676 | FOR_EACH_VM_BUILTIN(NAME_TO_INDEX) | |
677 | #undef NAME_TO_INDEX | |
678 | ||
679 | return SCM_BOOL_F; | |
680 | } | |
681 | #undef FUNC_NAME | |
682 | ||
683 | SCM | |
684 | scm_vm_builtin_index_to_name (SCM index) | |
685 | #define FUNC_NAME "builtin-index->name" | |
686 | { | |
687 | unsigned idx; | |
688 | ||
689 | SCM_VALIDATE_UINT_COPY (1, index, idx); | |
690 | ||
691 | switch (idx) | |
692 | { | |
9f309e2c | 693 | #define INDEX_TO_NAME(builtin, BUILTIN, req, opt, rest) \ |
486013d6 AW |
694 | case SCM_VM_BUILTIN_##BUILTIN: return scm_sym_##builtin; |
695 | FOR_EACH_VM_BUILTIN(INDEX_TO_NAME) | |
696 | #undef INDEX_TO_NAME | |
697 | default: return SCM_BOOL_F; | |
698 | } | |
699 | } | |
700 | #undef FUNC_NAME | |
701 | ||
702 | static void | |
703 | scm_init_vm_builtins (void) | |
704 | { | |
486013d6 AW |
705 | scm_c_define_gsubr ("builtin-name->index", 1, 0, 0, |
706 | scm_vm_builtin_name_to_index); | |
707 | scm_c_define_gsubr ("builtin-index->name", 1, 0, 0, | |
708 | scm_vm_builtin_index_to_name); | |
709 | } | |
710 | ||
711 | SCM | |
712 | scm_i_call_with_current_continuation (SCM proc) | |
713 | { | |
714 | return scm_call_1 (vm_builtin_call_with_current_continuation, proc); | |
715 | } | |
510ca126 | 716 | |
a98cef7e KN |
717 | \f |
718 | /* | |
719 | * VM | |
720 | */ | |
721 | ||
b7393ea1 | 722 | static SCM |
b782ed01 | 723 | resolve_variable (SCM what, SCM module) |
b7393ea1 | 724 | { |
9bd48cb1 | 725 | if (SCM_LIKELY (scm_is_symbol (what))) |
b7393ea1 | 726 | { |
b782ed01 AW |
727 | if (scm_is_true (module)) |
728 | return scm_module_lookup (module, what); | |
b7393ea1 | 729 | else |
62e15979 | 730 | return scm_module_lookup (scm_the_root_module (), what); |
b7393ea1 AW |
731 | } |
732 | else | |
733 | { | |
b782ed01 AW |
734 | SCM modname, sym, public; |
735 | ||
736 | modname = SCM_CAR (what); | |
737 | sym = SCM_CADR (what); | |
738 | public = SCM_CADDR (what); | |
739 | ||
d6fbf0c0 AW |
740 | if (!scm_module_system_booted_p) |
741 | { | |
742 | #ifdef VM_ENABLE_PARANOID_ASSERTIONS | |
743 | ASSERT (scm_is_false (public)); | |
744 | ASSERT (scm_is_true | |
745 | (scm_equal_p (modname, | |
746 | scm_list_1 (scm_from_utf8_symbol ("guile"))))); | |
747 | #endif | |
748 | return scm_lookup (sym); | |
749 | } | |
750 | else if (scm_is_true (public)) | |
b782ed01 AW |
751 | return scm_public_lookup (modname, sym); |
752 | else | |
753 | return scm_private_lookup (modname, sym); | |
b7393ea1 AW |
754 | } |
755 | } | |
756 | ||
aab9d46c | 757 | #define VM_MIN_STACK_SIZE (1024) |
486013d6 | 758 | #define VM_DEFAULT_STACK_SIZE (256 * 1024) |
aab9d46c SIT |
759 | static size_t vm_stack_size = VM_DEFAULT_STACK_SIZE; |
760 | ||
761 | static void | |
762 | initialize_default_stack_size (void) | |
763 | { | |
764 | int size = scm_getenv_int ("GUILE_STACK_SIZE", vm_stack_size); | |
765 | if (size >= VM_MIN_STACK_SIZE) | |
766 | vm_stack_size = size; | |
767 | } | |
17e90c5e | 768 | |
510ca126 | 769 | #define RTL_VM_NAME rtl_vm_regular_engine |
6d14383e AW |
770 | #define FUNC_NAME "vm-regular-engine" |
771 | #define VM_ENGINE SCM_VM_REGULAR_ENGINE | |
83495480 | 772 | #include "vm-engine.c" |
510ca126 | 773 | #undef RTL_VM_NAME |
6d14383e | 774 | #undef FUNC_NAME |
17e90c5e | 775 | #undef VM_ENGINE |
17e90c5e | 776 | |
510ca126 | 777 | #define RTL_VM_NAME rtl_vm_debug_engine |
6d14383e AW |
778 | #define FUNC_NAME "vm-debug-engine" |
779 | #define VM_ENGINE SCM_VM_DEBUG_ENGINE | |
83495480 | 780 | #include "vm-engine.c" |
510ca126 | 781 | #undef RTL_VM_NAME |
6d14383e | 782 | #undef FUNC_NAME |
17e90c5e KN |
783 | #undef VM_ENGINE |
784 | ||
73c3db66 AW |
785 | typedef SCM (*scm_t_rtl_vm_engine) (SCM vm, SCM program, SCM *argv, size_t nargs); |
786 | ||
787 | static const scm_t_rtl_vm_engine rtl_vm_engines[] = | |
788 | { rtl_vm_regular_engine, rtl_vm_debug_engine }; | |
789 | ||
e3eb628d LC |
790 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN |
791 | ||
792 | /* The GC "kind" for the VM stack. */ | |
793 | static int vm_stack_gc_kind; | |
794 | ||
795 | #endif | |
796 | ||
a98cef7e | 797 | static SCM |
17e90c5e KN |
798 | make_vm (void) |
799 | #define FUNC_NAME "make_vm" | |
a98cef7e | 800 | { |
17e90c5e | 801 | int i; |
7f991c7d | 802 | struct scm_vm *vp; |
747a1635 | 803 | |
7f991c7d | 804 | vp = scm_gc_malloc (sizeof (struct scm_vm), "vm"); |
d8eeb67c | 805 | |
aab9d46c | 806 | vp->stack_size= vm_stack_size; |
e3eb628d LC |
807 | |
808 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN | |
4168aa46 TTN |
809 | vp->stack_base = (SCM *) |
810 | GC_generic_malloc (vp->stack_size * sizeof (SCM), vm_stack_gc_kind); | |
e3eb628d LC |
811 | |
812 | /* Keep a pointer to VP so that `vm_stack_mark ()' can know what the stack | |
813 | top is. */ | |
21041372 | 814 | *vp->stack_base = SCM_PACK_POINTER (vp); |
e3eb628d LC |
815 | vp->stack_base++; |
816 | vp->stack_size--; | |
817 | #else | |
d8eeb67c LC |
818 | vp->stack_base = scm_gc_malloc (vp->stack_size * sizeof (SCM), |
819 | "stack-base"); | |
e3eb628d LC |
820 | #endif |
821 | ||
2bbe1533 AW |
822 | #ifdef VM_ENABLE_STACK_NULLING |
823 | memset (vp->stack_base, 0, vp->stack_size * sizeof (SCM)); | |
824 | #endif | |
f1046e6b | 825 | vp->stack_limit = vp->stack_base + vp->stack_size - VM_STACK_RESERVE_SIZE; |
3616e9e9 KN |
826 | vp->ip = NULL; |
827 | vp->sp = vp->stack_base - 1; | |
828 | vp->fp = NULL; | |
ea9f4f4b | 829 | vp->engine = vm_default_engine; |
7656f194 | 830 | vp->trace_level = 0; |
17e90c5e | 831 | for (i = 0; i < SCM_VM_NUM_HOOKS; i++) |
3d5ee0cd | 832 | vp->hooks[i] = SCM_BOOL_F; |
6f3b0cc2 | 833 | return scm_cell (scm_tc7_vm, (scm_t_bits)vp); |
a98cef7e | 834 | } |
17e90c5e | 835 | #undef FUNC_NAME |
a98cef7e | 836 | |
e3eb628d LC |
837 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN |
838 | ||
839 | /* Mark the VM stack region between its base and its current top. */ | |
840 | static struct GC_ms_entry * | |
841 | vm_stack_mark (GC_word *addr, struct GC_ms_entry *mark_stack_ptr, | |
842 | struct GC_ms_entry *mark_stack_limit, GC_word env) | |
843 | { | |
844 | GC_word *word; | |
845 | const struct scm_vm *vm; | |
846 | ||
847 | /* The first word of the VM stack should contain a pointer to the | |
848 | corresponding VM. */ | |
849 | vm = * ((struct scm_vm **) addr); | |
850 | ||
8071c490 | 851 | if (vm == NULL |
f1046e6b | 852 | || (SCM *) addr != vm->stack_base - 1) |
e3eb628d LC |
853 | /* ADDR must be a pointer to a free-list element, which we must ignore |
854 | (see warning in <gc/gc_mark.h>). */ | |
855 | return mark_stack_ptr; | |
856 | ||
e3eb628d LC |
857 | for (word = (GC_word *) vm->stack_base; word <= (GC_word *) vm->sp; word++) |
858 | mark_stack_ptr = GC_MARK_AND_PUSH ((* (GC_word **) word), | |
859 | mark_stack_ptr, mark_stack_limit, | |
860 | NULL); | |
861 | ||
862 | return mark_stack_ptr; | |
863 | } | |
864 | ||
865 | #endif /* VM_ENABLE_PRECISE_STACK_GC_SCAN */ | |
866 | ||
867 | ||
6d14383e | 868 | SCM |
4abef68f | 869 | scm_c_vm_run (SCM vm, SCM program, SCM *argv, int nargs) |
6d14383e | 870 | { |
4abef68f | 871 | struct scm_vm *vp = SCM_VM_DATA (vm); |
b95d76fc | 872 | SCM_CHECK_STACK; |
1c33be99 | 873 | return rtl_vm_engines[vp->engine](vm, program, argv, nargs); |
6d14383e AW |
874 | } |
875 | ||
a98cef7e KN |
876 | /* Scheme interface */ |
877 | ||
271c3d31 LC |
878 | SCM_DEFINE (scm_the_vm, "the-vm", 0, 0, 0, |
879 | (void), | |
880 | "Return the current thread's VM.") | |
881 | #define FUNC_NAME s_scm_the_vm | |
882 | { | |
ea9f4f4b AW |
883 | scm_i_thread *t = SCM_I_CURRENT_THREAD; |
884 | ||
885 | if (SCM_UNLIKELY (scm_is_false (t->vm))) | |
886 | t->vm = make_vm (); | |
887 | ||
888 | return t->vm; | |
271c3d31 | 889 | } |
499a4c07 KN |
890 | #undef FUNC_NAME |
891 | ||
892 | ||
a98cef7e KN |
893 | SCM_DEFINE (scm_vm_p, "vm?", 1, 0, 0, |
894 | (SCM obj), | |
17e90c5e | 895 | "") |
a98cef7e KN |
896 | #define FUNC_NAME s_scm_vm_p |
897 | { | |
9bd48cb1 | 898 | return scm_from_bool (SCM_VM_P (obj)); |
a98cef7e KN |
899 | } |
900 | #undef FUNC_NAME | |
901 | ||
902 | SCM_DEFINE (scm_make_vm, "make-vm", 0, 0, 0, | |
17e90c5e KN |
903 | (void), |
904 | "") | |
905 | #define FUNC_NAME s_scm_make_vm, | |
a98cef7e | 906 | { |
17e90c5e | 907 | return make_vm (); |
a98cef7e KN |
908 | } |
909 | #undef FUNC_NAME | |
910 | ||
17e90c5e | 911 | SCM_DEFINE (scm_vm_ip, "vm:ip", 1, 0, 0, |
a98cef7e | 912 | (SCM vm), |
17e90c5e KN |
913 | "") |
914 | #define FUNC_NAME s_scm_vm_ip | |
a98cef7e KN |
915 | { |
916 | SCM_VALIDATE_VM (1, vm); | |
3d27ef4b | 917 | return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_DATA (vm)->ip); |
a98cef7e KN |
918 | } |
919 | #undef FUNC_NAME | |
920 | ||
921 | SCM_DEFINE (scm_vm_sp, "vm:sp", 1, 0, 0, | |
922 | (SCM vm), | |
17e90c5e | 923 | "") |
a98cef7e KN |
924 | #define FUNC_NAME s_scm_vm_sp |
925 | { | |
926 | SCM_VALIDATE_VM (1, vm); | |
3d27ef4b | 927 | return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_DATA (vm)->sp); |
a98cef7e KN |
928 | } |
929 | #undef FUNC_NAME | |
930 | ||
931 | SCM_DEFINE (scm_vm_fp, "vm:fp", 1, 0, 0, | |
932 | (SCM vm), | |
17e90c5e | 933 | "") |
a98cef7e KN |
934 | #define FUNC_NAME s_scm_vm_fp |
935 | { | |
936 | SCM_VALIDATE_VM (1, vm); | |
3d27ef4b | 937 | return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_DATA (vm)->fp); |
a98cef7e KN |
938 | } |
939 | #undef FUNC_NAME | |
940 | ||
17e90c5e KN |
941 | #define VM_DEFINE_HOOK(n) \ |
942 | { \ | |
3d5ee0cd | 943 | struct scm_vm *vp; \ |
17e90c5e | 944 | SCM_VALIDATE_VM (1, vm); \ |
3d5ee0cd | 945 | vp = SCM_VM_DATA (vm); \ |
8b22ed7a | 946 | if (scm_is_false (vp->hooks[n])) \ |
238e7a11 | 947 | vp->hooks[n] = scm_make_hook (SCM_I_MAKINUM (1)); \ |
3d5ee0cd | 948 | return vp->hooks[n]; \ |
17e90c5e KN |
949 | } |
950 | ||
c45d4d77 | 951 | SCM_DEFINE (scm_vm_apply_hook, "vm-apply-hook", 1, 0, 0, |
17e90c5e KN |
952 | (SCM vm), |
953 | "") | |
c45d4d77 | 954 | #define FUNC_NAME s_scm_vm_apply_hook |
a98cef7e | 955 | { |
c45d4d77 | 956 | VM_DEFINE_HOOK (SCM_VM_APPLY_HOOK); |
a98cef7e KN |
957 | } |
958 | #undef FUNC_NAME | |
959 | ||
c45d4d77 | 960 | SCM_DEFINE (scm_vm_push_continuation_hook, "vm-push-continuation-hook", 1, 0, 0, |
17e90c5e KN |
961 | (SCM vm), |
962 | "") | |
c45d4d77 | 963 | #define FUNC_NAME s_scm_vm_push_continuation_hook |
a98cef7e | 964 | { |
c45d4d77 | 965 | VM_DEFINE_HOOK (SCM_VM_PUSH_CONTINUATION_HOOK); |
a98cef7e KN |
966 | } |
967 | #undef FUNC_NAME | |
968 | ||
c45d4d77 | 969 | SCM_DEFINE (scm_vm_pop_continuation_hook, "vm-pop-continuation-hook", 1, 0, 0, |
a98cef7e | 970 | (SCM vm), |
17e90c5e | 971 | "") |
c45d4d77 | 972 | #define FUNC_NAME s_scm_vm_pop_continuation_hook |
a98cef7e | 973 | { |
c45d4d77 | 974 | VM_DEFINE_HOOK (SCM_VM_POP_CONTINUATION_HOOK); |
a98cef7e KN |
975 | } |
976 | #undef FUNC_NAME | |
977 | ||
c45d4d77 | 978 | SCM_DEFINE (scm_vm_next_hook, "vm-next-hook", 1, 0, 0, |
a98cef7e | 979 | (SCM vm), |
17e90c5e | 980 | "") |
c45d4d77 | 981 | #define FUNC_NAME s_scm_vm_next_hook |
a98cef7e | 982 | { |
c45d4d77 | 983 | VM_DEFINE_HOOK (SCM_VM_NEXT_HOOK); |
a98cef7e KN |
984 | } |
985 | #undef FUNC_NAME | |
f3120251 AW |
986 | |
987 | SCM_DEFINE (scm_vm_abort_continuation_hook, "vm-abort-continuation-hook", 1, 0, 0, | |
988 | (SCM vm), | |
989 | "") | |
990 | #define FUNC_NAME s_scm_vm_abort_continuation_hook | |
991 | { | |
992 | VM_DEFINE_HOOK (SCM_VM_ABORT_CONTINUATION_HOOK); | |
993 | } | |
994 | #undef FUNC_NAME | |
995 | ||
996 | SCM_DEFINE (scm_vm_restore_continuation_hook, "vm-restore-continuation-hook", 1, 0, 0, | |
997 | (SCM vm), | |
998 | "") | |
999 | #define FUNC_NAME s_scm_vm_restore_continuation_hook | |
1000 | { | |
1001 | VM_DEFINE_HOOK (SCM_VM_RESTORE_CONTINUATION_HOOK); | |
1002 | } | |
1003 | #undef FUNC_NAME | |
a98cef7e | 1004 | |
7656f194 | 1005 | SCM_DEFINE (scm_vm_trace_level, "vm-trace-level", 1, 0, 0, |
17e90c5e KN |
1006 | (SCM vm), |
1007 | "") | |
7656f194 | 1008 | #define FUNC_NAME s_scm_vm_trace_level |
a98cef7e | 1009 | { |
a98cef7e | 1010 | SCM_VALIDATE_VM (1, vm); |
7656f194 AW |
1011 | return scm_from_int (SCM_VM_DATA (vm)->trace_level); |
1012 | } | |
1013 | #undef FUNC_NAME | |
1014 | ||
1015 | SCM_DEFINE (scm_set_vm_trace_level_x, "set-vm-trace-level!", 2, 0, 0, | |
1016 | (SCM vm, SCM level), | |
1017 | "") | |
1018 | #define FUNC_NAME s_scm_set_vm_trace_level_x | |
1019 | { | |
1020 | SCM_VALIDATE_VM (1, vm); | |
1021 | SCM_VM_DATA (vm)->trace_level = scm_to_int (level); | |
1022 | return SCM_UNSPECIFIED; | |
a98cef7e KN |
1023 | } |
1024 | #undef FUNC_NAME | |
1025 | ||
1026 | \f | |
ea9f4f4b AW |
1027 | /* |
1028 | * VM engines | |
1029 | */ | |
1030 | ||
1031 | static int | |
1032 | symbol_to_vm_engine (SCM engine, const char *FUNC_NAME) | |
1033 | { | |
1034 | if (scm_is_eq (engine, sym_regular)) | |
1035 | return SCM_VM_REGULAR_ENGINE; | |
1036 | else if (scm_is_eq (engine, sym_debug)) | |
1037 | return SCM_VM_DEBUG_ENGINE; | |
1038 | else | |
1039 | SCM_MISC_ERROR ("Unknown VM engine: ~a", scm_list_1 (engine)); | |
1040 | } | |
1041 | ||
1042 | static SCM | |
1043 | vm_engine_to_symbol (int engine, const char *FUNC_NAME) | |
1044 | { | |
1045 | switch (engine) | |
1046 | { | |
1047 | case SCM_VM_REGULAR_ENGINE: | |
1048 | return sym_regular; | |
1049 | case SCM_VM_DEBUG_ENGINE: | |
1050 | return sym_debug; | |
1051 | default: | |
1052 | /* ? */ | |
1053 | SCM_MISC_ERROR ("Unknown VM engine: ~a", | |
1054 | scm_list_1 (scm_from_int (engine))); | |
1055 | } | |
1056 | } | |
1057 | ||
ea9f4f4b AW |
1058 | SCM_DEFINE (scm_vm_engine, "vm-engine", 1, 0, 0, |
1059 | (SCM vm), | |
1060 | "") | |
1061 | #define FUNC_NAME s_scm_vm_engine | |
1062 | { | |
1063 | SCM_VALIDATE_VM (1, vm); | |
1064 | return vm_engine_to_symbol (SCM_VM_DATA (vm)->engine, FUNC_NAME); | |
1065 | } | |
1066 | #undef FUNC_NAME | |
1067 | ||
1068 | void | |
1069 | scm_c_set_vm_engine_x (SCM vm, int engine) | |
1070 | #define FUNC_NAME "set-vm-engine!" | |
1071 | { | |
1072 | SCM_VALIDATE_VM (1, vm); | |
1073 | ||
ea9f4f4b AW |
1074 | if (engine < 0 || engine >= SCM_VM_NUM_ENGINES) |
1075 | SCM_MISC_ERROR ("Unknown VM engine: ~a", | |
1076 | scm_list_1 (scm_from_int (engine))); | |
1077 | ||
1078 | SCM_VM_DATA (vm)->engine = engine; | |
1079 | } | |
1080 | #undef FUNC_NAME | |
1081 | ||
1082 | SCM_DEFINE (scm_set_vm_engine_x, "set-vm-engine!", 2, 0, 0, | |
1083 | (SCM vm, SCM engine), | |
1084 | "") | |
1085 | #define FUNC_NAME s_scm_set_vm_engine_x | |
1086 | { | |
1087 | scm_c_set_vm_engine_x (vm, symbol_to_vm_engine (engine, FUNC_NAME)); | |
1088 | return SCM_UNSPECIFIED; | |
1089 | } | |
1090 | #undef FUNC_NAME | |
1091 | ||
1092 | void | |
1093 | scm_c_set_default_vm_engine_x (int engine) | |
1094 | #define FUNC_NAME "set-default-vm-engine!" | |
1095 | { | |
1096 | if (engine < 0 || engine >= SCM_VM_NUM_ENGINES) | |
1097 | SCM_MISC_ERROR ("Unknown VM engine: ~a", | |
1098 | scm_list_1 (scm_from_int (engine))); | |
1099 | ||
1100 | vm_default_engine = engine; | |
1101 | } | |
1102 | #undef FUNC_NAME | |
1103 | ||
1104 | SCM_DEFINE (scm_set_default_vm_engine_x, "set-default-vm-engine!", 1, 0, 0, | |
1105 | (SCM engine), | |
1106 | "") | |
1107 | #define FUNC_NAME s_scm_set_default_vm_engine_x | |
1108 | { | |
1109 | scm_c_set_default_vm_engine_x (symbol_to_vm_engine (engine, FUNC_NAME)); | |
1110 | return SCM_UNSPECIFIED; | |
1111 | } | |
1112 | #undef FUNC_NAME | |
1113 | ||
1114 | static void reinstate_vm (SCM vm) | |
1115 | { | |
1116 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
1117 | t->vm = vm; | |
1118 | } | |
1119 | ||
1120 | SCM_DEFINE (scm_call_with_vm, "call-with-vm", 2, 0, 1, | |
1121 | (SCM vm, SCM proc, SCM args), | |
1122 | "Apply @var{proc} to @var{args} in a dynamic extent in which\n" | |
1123 | "@var{vm} is the current VM.\n\n" | |
1124 | "As an implementation restriction, if @var{vm} is not the same\n" | |
1125 | "as the current thread's VM, continuations captured within the\n" | |
1126 | "call to @var{proc} may not be reinstated once control leaves\n" | |
1127 | "@var{proc}.") | |
1128 | #define FUNC_NAME s_scm_call_with_vm | |
1129 | { | |
1130 | SCM prev_vm, ret; | |
1131 | SCM *argv; | |
1132 | int i, nargs; | |
1133 | scm_t_wind_flags flags; | |
1134 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
1135 | ||
1136 | SCM_VALIDATE_VM (1, vm); | |
1137 | SCM_VALIDATE_PROC (2, proc); | |
1138 | ||
1139 | nargs = scm_ilength (args); | |
1140 | if (SCM_UNLIKELY (nargs < 0)) | |
1141 | scm_wrong_type_arg_msg (FUNC_NAME, 3, args, "list"); | |
1142 | ||
1143 | argv = alloca (nargs * sizeof(SCM)); | |
1144 | for (i = 0; i < nargs; i++) | |
1145 | { | |
1146 | argv[i] = SCM_CAR (args); | |
1147 | args = SCM_CDR (args); | |
1148 | } | |
1149 | ||
1150 | prev_vm = t->vm; | |
1151 | ||
1152 | /* Reentry can happen via invokation of a saved continuation, but | |
1153 | continuations only save the state of the VM that they are in at | |
1154 | capture-time, which might be different from this one. So, in the | |
1155 | case that the VMs are different, set up a non-rewindable frame to | |
1156 | prevent reinstating an incomplete continuation. */ | |
1157 | flags = scm_is_eq (prev_vm, vm) ? 0 : SCM_F_WIND_EXPLICITLY; | |
1158 | if (flags) | |
1159 | { | |
1160 | scm_dynwind_begin (0); | |
1161 | scm_dynwind_unwind_handler_with_scm (reinstate_vm, prev_vm, flags); | |
1162 | t->vm = vm; | |
1163 | } | |
1164 | ||
1165 | ret = scm_c_vm_run (vm, proc, argv, nargs); | |
1166 | ||
1167 | if (flags) | |
1168 | scm_dynwind_end (); | |
1169 | ||
1170 | return ret; | |
1171 | } | |
1172 | #undef FUNC_NAME | |
1173 | ||
1174 | \f | |
a98cef7e | 1175 | /* |
17e90c5e | 1176 | * Initialize |
a98cef7e KN |
1177 | */ |
1178 | ||
07e56b27 AW |
1179 | SCM scm_load_compiled_with_vm (SCM file) |
1180 | { | |
b8bc86bc AW |
1181 | SCM program = scm_load_thunk_from_file (file); |
1182 | ||
4abef68f | 1183 | return scm_c_vm_run (scm_the_vm (), program, NULL, 0); |
07e56b27 AW |
1184 | } |
1185 | ||
67b699cc | 1186 | |
9f309e2c AW |
1187 | void |
1188 | scm_init_vm_builtin_properties (void) | |
1189 | { | |
1190 | /* FIXME: Seems hacky to do this here, but oh well :/ */ | |
1191 | scm_sym_apply = scm_from_utf8_symbol ("apply"); | |
1192 | scm_sym_values = scm_from_utf8_symbol ("values"); | |
1193 | scm_sym_abort_to_prompt = scm_from_utf8_symbol ("abort-to-prompt"); | |
1194 | scm_sym_call_with_values = scm_from_utf8_symbol ("call-with-values"); | |
1195 | scm_sym_call_with_current_continuation = | |
1196 | scm_from_utf8_symbol ("call-with-current-continuation"); | |
1197 | ||
1198 | #define INIT_BUILTIN(builtin, BUILTIN, req, opt, rest) \ | |
1199 | scm_set_procedure_property_x (vm_builtin_##builtin, scm_sym_name, \ | |
1200 | scm_sym_##builtin); \ | |
1201 | scm_set_procedure_minimum_arity_x (vm_builtin_##builtin, \ | |
1202 | SCM_I_MAKINUM (req), \ | |
1203 | SCM_I_MAKINUM (opt), \ | |
1204 | scm_from_bool (rest)); | |
1205 | FOR_EACH_VM_BUILTIN (INIT_BUILTIN); | |
1206 | #undef INIT_BUILTIN | |
1207 | } | |
1208 | ||
17e90c5e | 1209 | void |
07e56b27 | 1210 | scm_bootstrap_vm (void) |
17e90c5e | 1211 | { |
44602b08 AW |
1212 | scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION, |
1213 | "scm_init_vm", | |
60ae5ca2 | 1214 | (scm_t_extension_init_func)scm_init_vm, NULL); |
486013d6 AW |
1215 | scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION, |
1216 | "scm_init_vm_builtins", | |
1217 | (scm_t_extension_init_func)scm_init_vm_builtins, | |
1218 | NULL); | |
60ae5ca2 | 1219 | |
aab9d46c SIT |
1220 | initialize_default_stack_size (); |
1221 | ||
4a655e50 AW |
1222 | sym_vm_run = scm_from_latin1_symbol ("vm-run"); |
1223 | sym_vm_error = scm_from_latin1_symbol ("vm-error"); | |
1224 | sym_keyword_argument_error = scm_from_latin1_symbol ("keyword-argument-error"); | |
1225 | sym_regular = scm_from_latin1_symbol ("regular"); | |
1226 | sym_debug = scm_from_latin1_symbol ("debug"); | |
0404c97d | 1227 | |
73c3db66 AW |
1228 | rtl_boot_continuation = scm_i_make_rtl_program (rtl_boot_continuation_code); |
1229 | SCM_SET_CELL_WORD_0 (rtl_boot_continuation, | |
1230 | (SCM_CELL_WORD_0 (rtl_boot_continuation) | |
1231 | | SCM_F_PROGRAM_IS_BOOT)); | |
9f309e2c AW |
1232 | |
1233 | #define DEFINE_BUILTIN(builtin, BUILTIN, req, opt, rest) \ | |
1234 | vm_builtin_##builtin = scm_i_make_rtl_program (vm_builtin_##builtin##_code); | |
1235 | FOR_EACH_VM_BUILTIN (DEFINE_BUILTIN); | |
1236 | #undef DEFINE_BUILTIN | |
73c3db66 | 1237 | |
e3eb628d LC |
1238 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN |
1239 | vm_stack_gc_kind = | |
1240 | GC_new_kind (GC_new_free_list (), | |
1241 | GC_MAKE_PROC (GC_new_proc (vm_stack_mark), 0), | |
1242 | 0, 1); | |
1243 | ||
1244 | #endif | |
07e56b27 AW |
1245 | } |
1246 | ||
1247 | void | |
1248 | scm_init_vm (void) | |
1249 | { | |
17e90c5e | 1250 | #ifndef SCM_MAGIC_SNARFER |
aeeff258 | 1251 | #include "libguile/vm.x" |
17e90c5e | 1252 | #endif |
a98cef7e | 1253 | } |
17e90c5e KN |
1254 | |
1255 | /* | |
1256 | Local Variables: | |
1257 | c-file-style: "gnu" | |
1258 | End: | |
1259 | */ |