Commit | Line | Data |
---|---|---|
4a655e50 | 1 | /* Copyright (C) 2001, 2009, 2010, 2011 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 KN |
38 | #include "vm.h" |
39 | ||
97b18a66 | 40 | static int vm_default_engine = SCM_VM_REGULAR_ENGINE; |
ea9f4f4b AW |
41 | |
42 | /* Unfortunately we can't snarf these: snarfed things are only loaded up from | |
43 | (system vm vm), which might not be loaded before an error happens. */ | |
44 | static SCM sym_vm_run; | |
45 | static SCM sym_vm_error; | |
46 | static SCM sym_keyword_argument_error; | |
47 | static SCM sym_regular; | |
48 | static SCM sym_debug; | |
a98cef7e | 49 | |
11ea1aba AW |
50 | /* The VM has a number of internal assertions that shouldn't normally be |
51 | necessary, but might be if you think you found a bug in the VM. */ | |
52 | #define VM_ENABLE_ASSERTIONS | |
53 | ||
54 | /* We can add a mode that ensures that all stack items above the stack pointer | |
55 | are NULL. This is useful for checking the internal consistency of the VM's | |
56 | assumptions and its operators, but isn't necessary for normal operation. It | |
616167fc | 57 | will ensure that assertions are enabled. Slows down the VM by about 30%. */ |
747a1635 | 58 | /* NB! If you enable this, search for NULLING in throw.c */ |
616167fc | 59 | /* #define VM_ENABLE_STACK_NULLING */ |
11ea1aba | 60 | |
53e28ed9 AW |
61 | /* #define VM_ENABLE_PARANOID_ASSERTIONS */ |
62 | ||
11ea1aba AW |
63 | #if defined (VM_ENABLE_STACK_NULLING) && !defined (VM_ENABLE_ASSERTIONS) |
64 | #define VM_ENABLE_ASSERTIONS | |
65 | #endif | |
66 | ||
e3eb628d LC |
67 | /* When defined, arrange so that the GC doesn't scan the VM stack beyond its |
68 | current SP. This should help avoid excess data retention. See | |
69 | http://thread.gmane.org/gmane.comp.programming.garbage-collection.boehmgc/3001 | |
70 | for a discussion. */ | |
71 | #define VM_ENABLE_PRECISE_STACK_GC_SCAN | |
72 | ||
f1046e6b LC |
73 | /* Size in SCM objects of the stack reserve. The reserve is used to run |
74 | exception handling code in case of a VM stack overflow. */ | |
75 | #define VM_STACK_RESERVE_SIZE 512 | |
76 | ||
e3eb628d | 77 | |
a98cef7e | 78 | \f |
a98cef7e KN |
79 | /* |
80 | * VM Continuation | |
81 | */ | |
82 | ||
6f3b0cc2 AW |
83 | void |
84 | scm_i_vm_cont_print (SCM x, SCM port, scm_print_state *pstate) | |
85 | { | |
86 | scm_puts ("#<vm-continuation ", port); | |
87 | scm_uintprint (SCM_UNPACK (x), 16, port); | |
88 | scm_puts (">", port); | |
89 | } | |
17e90c5e | 90 | |
d8873dfe AW |
91 | /* In theory, a number of vm instances can be active in the call trace, and we |
92 | only want to reify the continuations of those in the current continuation | |
93 | root. I don't see a nice way to do this -- ideally it would involve dynwinds, | |
94 | and previous values of the *the-vm* fluid within the current continuation | |
95 | root. But we don't have access to continuation roots in the dynwind stack. | |
96 | So, just punt for now, we just capture the continuation for the current VM. | |
97 | ||
98 | While I'm on the topic, ideally we could avoid copying the C stack if the | |
99 | continuation root is inside VM code, and call/cc was invoked within that same | |
100 | call to vm_run; but that's currently not implemented. | |
101 | */ | |
cee1d22c AW |
102 | SCM |
103 | scm_i_vm_capture_stack (SCM *stack_base, SCM *fp, SCM *sp, scm_t_uint8 *ra, | |
104 | scm_t_uint8 *mvra, scm_t_uint32 flags) | |
a98cef7e | 105 | { |
d8873dfe AW |
106 | struct scm_vm_cont *p; |
107 | ||
108 | p = scm_gc_malloc (sizeof (*p), "capture_vm_cont"); | |
109 | p->stack_size = sp - stack_base + 1; | |
d8eeb67c LC |
110 | p->stack_base = scm_gc_malloc (p->stack_size * sizeof (SCM), |
111 | "capture_vm_cont"); | |
d8873dfe AW |
112 | #if defined(VM_ENABLE_STACK_NULLING) && 0 |
113 | /* Tail continuations leave their frame on the stack for subsequent | |
114 | application, but don't capture the frame -- so there are some elements on | |
115 | the stack then, and this check doesn't work, so disable it for now. */ | |
116 | if (sp >= vp->stack_base) | |
66db076a AW |
117 | if (!vp->sp[0] || vp->sp[1]) |
118 | abort (); | |
11ea1aba AW |
119 | memset (p->stack_base, 0, p->stack_size * sizeof (SCM)); |
120 | #endif | |
d8873dfe AW |
121 | p->ra = ra; |
122 | p->mvra = mvra; | |
123 | p->sp = sp; | |
124 | p->fp = fp; | |
125 | memcpy (p->stack_base, stack_base, (sp + 1 - stack_base) * sizeof (SCM)); | |
126 | p->reloc = p->stack_base - stack_base; | |
cee1d22c | 127 | p->flags = flags; |
6f3b0cc2 | 128 | return scm_cell (scm_tc7_vm_cont, (scm_t_bits)p); |
a98cef7e KN |
129 | } |
130 | ||
131 | static void | |
d8873dfe | 132 | vm_return_to_continuation (SCM vm, SCM cont, size_t n, SCM *argv) |
a98cef7e | 133 | { |
d8873dfe AW |
134 | struct scm_vm *vp; |
135 | struct scm_vm_cont *cp; | |
136 | SCM *argv_copy; | |
137 | ||
138 | argv_copy = alloca (n * sizeof(SCM)); | |
139 | memcpy (argv_copy, argv, n * sizeof(SCM)); | |
140 | ||
141 | vp = SCM_VM_DATA (vm); | |
142 | cp = SCM_VM_CONT_DATA (cont); | |
143 | ||
144 | if (n == 0 && !cp->mvra) | |
145 | scm_misc_error (NULL, "Too few values returned to continuation", | |
146 | SCM_EOL); | |
147 | ||
148 | if (vp->stack_size < cp->stack_size + n + 1) | |
29366989 AW |
149 | scm_misc_error ("vm-engine", "not enough space to reinstate continuation", |
150 | scm_list_2 (vm, cont)); | |
151 | ||
11ea1aba AW |
152 | #ifdef VM_ENABLE_STACK_NULLING |
153 | { | |
d8873dfe | 154 | scm_t_ptrdiff nzero = (vp->sp - cp->sp); |
11ea1aba | 155 | if (nzero > 0) |
d8873dfe | 156 | memset (vp->stack_base + cp->stack_size, 0, nzero * sizeof (SCM)); |
66db076a AW |
157 | /* actually nzero should always be negative, because vm_reset_stack will |
158 | unwind the stack to some point *below* this continuation */ | |
11ea1aba AW |
159 | } |
160 | #endif | |
d8873dfe AW |
161 | vp->sp = cp->sp; |
162 | vp->fp = cp->fp; | |
163 | memcpy (vp->stack_base, cp->stack_base, cp->stack_size * sizeof (SCM)); | |
bfffd258 | 164 | |
d8873dfe AW |
165 | if (n == 1 || !cp->mvra) |
166 | { | |
167 | vp->ip = cp->ra; | |
168 | vp->sp++; | |
169 | *vp->sp = argv_copy[0]; | |
170 | } | |
171 | else | |
172 | { | |
173 | size_t i; | |
174 | for (i = 0; i < n; i++) | |
175 | { | |
176 | vp->sp++; | |
177 | *vp->sp = argv_copy[i]; | |
178 | } | |
179 | vp->sp++; | |
180 | *vp->sp = scm_from_size_t (n); | |
181 | vp->ip = cp->mvra; | |
182 | } | |
183 | } | |
bfffd258 | 184 | |
bfffd258 | 185 | SCM |
269479e3 | 186 | scm_i_vm_capture_continuation (SCM vm) |
bfffd258 | 187 | { |
d8873dfe | 188 | struct scm_vm *vp = SCM_VM_DATA (vm); |
cee1d22c | 189 | return scm_i_vm_capture_stack (vp->stack_base, vp->fp, vp->sp, vp->ip, NULL, 0); |
a98cef7e KN |
190 | } |
191 | ||
b1b942b7 | 192 | static void |
7656f194 | 193 | vm_dispatch_hook (SCM vm, int hook_num) |
b1b942b7 | 194 | { |
7656f194 AW |
195 | struct scm_vm *vp; |
196 | SCM hook; | |
b3567435 | 197 | struct scm_frame c_frame; |
8e4c60ff | 198 | scm_t_cell *frame; |
b3567435 | 199 | SCM args[1]; |
893fb8d0 | 200 | int saved_trace_level; |
b1b942b7 | 201 | |
7656f194 AW |
202 | vp = SCM_VM_DATA (vm); |
203 | hook = vp->hooks[hook_num]; | |
b1b942b7 | 204 | |
7656f194 AW |
205 | if (SCM_LIKELY (scm_is_false (hook)) |
206 | || scm_is_null (SCM_HOOK_PROCEDURES (hook))) | |
207 | return; | |
b3567435 | 208 | |
893fb8d0 AW |
209 | saved_trace_level = vp->trace_level; |
210 | vp->trace_level = 0; | |
b3567435 LC |
211 | |
212 | /* Allocate a frame object on the stack. This is more efficient than calling | |
213 | `scm_c_make_frame ()' to allocate on the heap, but it forces hooks to not | |
214 | capture frame objects. | |
215 | ||
216 | At the same time, procedures such as `frame-procedure' make sense only | |
217 | while the stack frame represented by the frame object is visible, so it | |
218 | seems reasonable to limit the lifetime of frame objects. */ | |
219 | ||
220 | c_frame.stack_holder = vm; | |
221 | c_frame.fp = vp->fp; | |
222 | c_frame.sp = vp->sp; | |
223 | c_frame.ip = vp->ip; | |
224 | c_frame.offset = 0; | |
8e4c60ff LC |
225 | |
226 | /* Arrange for FRAME to be 8-byte aligned, like any other cell. */ | |
227 | frame = alloca (sizeof (*frame) + 8); | |
228 | frame = (scm_t_cell *) ROUND_UP ((scm_t_uintptr) frame, 8UL); | |
229 | ||
230 | frame->word_0 = SCM_PACK (scm_tc7_frame); | |
21041372 AW |
231 | frame->word_1 = SCM_PACK_POINTER (&c_frame); |
232 | args[0] = SCM_PACK_POINTER (frame); | |
b3567435 LC |
233 | |
234 | scm_c_run_hookn (hook, args, 1); | |
235 | ||
893fb8d0 | 236 | vp->trace_level = saved_trace_level; |
b1b942b7 AW |
237 | } |
238 | ||
cee1d22c | 239 | static void vm_abort (SCM vm, size_t n, scm_t_int64 cookie) SCM_NORETURN; |
4f66bcde | 240 | static void |
cee1d22c | 241 | vm_abort (SCM vm, size_t n, scm_t_int64 vm_cookie) |
4f66bcde | 242 | { |
eaefabee | 243 | size_t i; |
2d026f04 AW |
244 | ssize_t tail_len; |
245 | SCM tag, tail, *argv; | |
eaefabee | 246 | |
2d026f04 AW |
247 | /* FIXME: VM_ENABLE_STACK_NULLING */ |
248 | tail = *(SCM_VM_DATA (vm)->sp--); | |
249 | /* NULLSTACK (1) */ | |
250 | tail_len = scm_ilength (tail); | |
251 | if (tail_len < 0) | |
29366989 AW |
252 | scm_misc_error ("vm-engine", "tail values to abort should be a list", |
253 | scm_list_1 (tail)); | |
254 | ||
eaefabee | 255 | tag = SCM_VM_DATA (vm)->sp[-n]; |
2d026f04 | 256 | argv = alloca ((n + tail_len) * sizeof (SCM)); |
eaefabee AW |
257 | for (i = 0; i < n; i++) |
258 | argv[i] = SCM_VM_DATA (vm)->sp[-(n-1-i)]; | |
2d026f04 AW |
259 | for (; i < n + tail_len; i++, tail = scm_cdr (tail)) |
260 | argv[i] = scm_car (tail); | |
261 | /* NULLSTACK (n + 1) */ | |
eaefabee AW |
262 | SCM_VM_DATA (vm)->sp -= n + 1; |
263 | ||
cee1d22c AW |
264 | scm_c_abort (vm, tag, n + tail_len, argv, vm_cookie); |
265 | } | |
266 | ||
267 | static void | |
07801437 | 268 | vm_reinstate_partial_continuation (SCM vm, SCM cont, SCM intwinds, |
adbdfd6d | 269 | size_t n, SCM *argv, scm_t_int64 vm_cookie) |
cee1d22c | 270 | { |
07801437 AW |
271 | struct scm_vm *vp; |
272 | struct scm_vm_cont *cp; | |
273 | SCM *argv_copy, *base; | |
274 | size_t i; | |
275 | ||
276 | argv_copy = alloca (n * sizeof(SCM)); | |
277 | memcpy (argv_copy, argv, n * sizeof(SCM)); | |
278 | ||
279 | vp = SCM_VM_DATA (vm); | |
280 | cp = SCM_VM_CONT_DATA (cont); | |
281 | base = SCM_FRAME_UPPER_ADDRESS (vp->fp) + 1; | |
282 | ||
283 | #define RELOC(scm_p) (scm_p + cp->reloc + (base - cp->stack_base)) | |
284 | ||
285 | if ((base - vp->stack_base) + cp->stack_size + n + 1 > vp->stack_size) | |
29366989 AW |
286 | scm_misc_error ("vm-engine", |
287 | "not enough space to instate partial continuation", | |
288 | scm_list_2 (vm, cont)); | |
07801437 AW |
289 | |
290 | memcpy (base, cp->stack_base, cp->stack_size * sizeof (SCM)); | |
291 | ||
292 | /* now relocate frame pointers */ | |
293 | { | |
294 | SCM *fp; | |
295 | for (fp = RELOC (cp->fp); | |
296 | SCM_FRAME_LOWER_ADDRESS (fp) > base; | |
297 | fp = SCM_FRAME_DYNAMIC_LINK (fp)) | |
298 | SCM_FRAME_SET_DYNAMIC_LINK (fp, RELOC (SCM_FRAME_DYNAMIC_LINK (fp))); | |
299 | } | |
300 | ||
301 | vp->sp = base - 1 + cp->stack_size; | |
302 | vp->fp = RELOC (cp->fp); | |
303 | vp->ip = cp->mvra; | |
304 | ||
07801437 AW |
305 | /* now push args. ip is in a MV context. */ |
306 | for (i = 0; i < n; i++) | |
307 | { | |
308 | vp->sp++; | |
309 | *vp->sp = argv_copy[i]; | |
310 | } | |
311 | vp->sp++; | |
312 | *vp->sp = scm_from_size_t (n); | |
9a1c6f1f | 313 | |
adbdfd6d AW |
314 | /* Finally, rewind the dynamic state. |
315 | ||
316 | We have to treat prompts specially, because we could be rewinding the | |
317 | dynamic state from a different thread, or just a different position on the | |
318 | C and/or VM stack -- so we need to reset the jump buffers so that an abort | |
319 | comes back here, with appropriately adjusted sp and fp registers. */ | |
9a1c6f1f AW |
320 | { |
321 | long delta = 0; | |
322 | SCM newwinds = scm_i_dynwinds (); | |
323 | for (; scm_is_pair (intwinds); intwinds = scm_cdr (intwinds), delta--) | |
adbdfd6d AW |
324 | { |
325 | SCM x = scm_car (intwinds); | |
326 | if (SCM_PROMPT_P (x)) | |
327 | /* the jmpbuf will be reset by our caller */ | |
328 | x = scm_c_make_prompt (SCM_PROMPT_TAG (x), | |
329 | RELOC (SCM_PROMPT_REGISTERS (x)->fp), | |
330 | RELOC (SCM_PROMPT_REGISTERS (x)->sp), | |
331 | SCM_PROMPT_REGISTERS (x)->ip, | |
332 | SCM_PROMPT_ESCAPE_P (x), | |
333 | vm_cookie, | |
334 | newwinds); | |
335 | newwinds = scm_cons (x, newwinds); | |
336 | } | |
9a1c6f1f AW |
337 | scm_dowinds (newwinds, delta); |
338 | } | |
adbdfd6d | 339 | #undef RELOC |
4f66bcde AW |
340 | } |
341 | ||
342 | \f | |
17e90c5e KN |
343 | /* |
344 | * VM Internal functions | |
345 | */ | |
346 | ||
6f3b0cc2 AW |
347 | void |
348 | scm_i_vm_print (SCM x, SCM port, scm_print_state *pstate) | |
349 | { | |
0a935b2a LC |
350 | const struct scm_vm *vm; |
351 | ||
352 | vm = SCM_VM_DATA (x); | |
353 | ||
6f3b0cc2 | 354 | scm_puts ("#<vm ", port); |
0a935b2a LC |
355 | switch (vm->engine) |
356 | { | |
357 | case SCM_VM_REGULAR_ENGINE: | |
358 | scm_puts ("regular-engine ", port); | |
359 | break; | |
360 | ||
361 | case SCM_VM_DEBUG_ENGINE: | |
362 | scm_puts ("debug-engine ", port); | |
363 | break; | |
364 | ||
365 | default: | |
366 | scm_puts ("unknown-engine ", port); | |
367 | } | |
6f3b0cc2 AW |
368 | scm_uintprint (SCM_UNPACK (x), 16, port); |
369 | scm_puts (">", port); | |
370 | } | |
371 | ||
2fda0242 | 372 | static SCM |
d2d7acd5 | 373 | really_make_boot_program (long nargs) |
2fda0242 | 374 | { |
5bd047ce | 375 | SCM u8vec; |
97fcf583 AW |
376 | scm_t_uint8 text[] = { scm_op_mv_call, 0, 0, 0, 1, |
377 | scm_op_make_int8_1, scm_op_halt }; | |
28b119ee | 378 | struct scm_objcode *bp; |
3b9e095b | 379 | SCM ret; |
5bd047ce | 380 | |
53e28ed9 | 381 | if (SCM_UNLIKELY (nargs > 255 || nargs < 0)) |
29366989 AW |
382 | scm_misc_error ("vm-engine", "too many args when making boot procedure", |
383 | scm_list_1 (scm_from_long (nargs))); | |
384 | ||
28b119ee AW |
385 | text[1] = (scm_t_uint8)nargs; |
386 | ||
fb031aba AW |
387 | bp = scm_gc_malloc_pointerless (sizeof (struct scm_objcode) + sizeof (text), |
388 | "boot-program"); | |
3dbbe28d | 389 | memcpy (SCM_C_OBJCODE_BASE (bp), text, sizeof (text)); |
28b119ee AW |
390 | bp->len = sizeof(text); |
391 | bp->metalen = 0; | |
28b119ee | 392 | |
fb031aba | 393 | u8vec = scm_c_take_gc_bytevector ((scm_t_int8*)bp, |
8b66aa8f AW |
394 | sizeof (struct scm_objcode) + sizeof (text), |
395 | SCM_BOOL_F); | |
5bd047ce | 396 | ret = scm_make_program (scm_bytecode_to_objcode (u8vec), |
20d47c39 | 397 | SCM_BOOL_F, SCM_BOOL_F); |
ba20f78a | 398 | SCM_SET_CELL_WORD_0 (ret, SCM_CELL_WORD_0 (ret) | SCM_F_PROGRAM_IS_BOOT); |
5bd047ce | 399 | |
3b9e095b | 400 | return ret; |
2fda0242 | 401 | } |
d2d7acd5 AW |
402 | #define NUM_BOOT_PROGS 8 |
403 | static SCM | |
404 | vm_make_boot_program (long nargs) | |
405 | { | |
0b0ac740 | 406 | static SCM programs[NUM_BOOT_PROGS] = { SCM_BOOL_F, }; |
d2d7acd5 | 407 | |
0b0ac740 | 408 | if (SCM_UNLIKELY (scm_is_false (programs[0]))) |
d2d7acd5 AW |
409 | { |
410 | int i; | |
411 | for (i = 0; i < NUM_BOOT_PROGS; i++) | |
f39448c5 | 412 | programs[i] = really_make_boot_program (i); |
d2d7acd5 AW |
413 | } |
414 | ||
415 | if (SCM_LIKELY (nargs < NUM_BOOT_PROGS)) | |
416 | return programs[nargs]; | |
417 | else | |
418 | return really_make_boot_program (nargs); | |
419 | } | |
2fda0242 | 420 | |
a98cef7e KN |
421 | \f |
422 | /* | |
423 | * VM | |
424 | */ | |
425 | ||
b7393ea1 AW |
426 | static SCM |
427 | resolve_variable (SCM what, SCM program_module) | |
428 | { | |
9bd48cb1 | 429 | if (SCM_LIKELY (scm_is_symbol (what))) |
b7393ea1 AW |
430 | { |
431 | if (SCM_LIKELY (scm_module_system_booted_p | |
432 | && scm_is_true (program_module))) | |
433 | /* might longjmp */ | |
434 | return scm_module_lookup (program_module, what); | |
435 | else | |
436 | { | |
437 | SCM v = scm_sym2var (what, SCM_BOOL_F, SCM_BOOL_F); | |
438 | if (scm_is_false (v)) | |
439 | scm_misc_error (NULL, "unbound variable: ~S", scm_list_1 (what)); | |
440 | else | |
441 | return v; | |
442 | } | |
443 | } | |
444 | else | |
445 | { | |
446 | SCM mod; | |
447 | /* compilation of @ or @@ | |
448 | `what' is a three-element list: (MODNAME SYM INTERFACE?) | |
449 | INTERFACE? is #t if we compiled @ or #f if we compiled @@ | |
450 | */ | |
451 | mod = scm_resolve_module (SCM_CAR (what)); | |
452 | if (scm_is_true (SCM_CADDR (what))) | |
453 | mod = scm_module_public_interface (mod); | |
5c8cefe5 | 454 | if (scm_is_false (mod)) |
b7393ea1 AW |
455 | scm_misc_error (NULL, "no such module: ~S", |
456 | scm_list_1 (SCM_CAR (what))); | |
457 | /* might longjmp */ | |
458 | return scm_module_lookup (mod, SCM_CADR (what)); | |
459 | } | |
460 | } | |
461 | ||
51e9ba2f | 462 | #define VM_DEFAULT_STACK_SIZE (64 * 1024) |
17e90c5e | 463 | |
17e90c5e | 464 | #define VM_NAME vm_regular_engine |
6d14383e AW |
465 | #define FUNC_NAME "vm-regular-engine" |
466 | #define VM_ENGINE SCM_VM_REGULAR_ENGINE | |
83495480 | 467 | #include "vm-engine.c" |
17e90c5e | 468 | #undef VM_NAME |
6d14383e | 469 | #undef FUNC_NAME |
17e90c5e | 470 | #undef VM_ENGINE |
17e90c5e KN |
471 | |
472 | #define VM_NAME vm_debug_engine | |
6d14383e AW |
473 | #define FUNC_NAME "vm-debug-engine" |
474 | #define VM_ENGINE SCM_VM_DEBUG_ENGINE | |
83495480 | 475 | #include "vm-engine.c" |
17e90c5e | 476 | #undef VM_NAME |
6d14383e | 477 | #undef FUNC_NAME |
17e90c5e KN |
478 | #undef VM_ENGINE |
479 | ||
6d14383e AW |
480 | static const scm_t_vm_engine vm_engines[] = |
481 | { vm_regular_engine, vm_debug_engine }; | |
482 | ||
e3eb628d LC |
483 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN |
484 | ||
485 | /* The GC "kind" for the VM stack. */ | |
486 | static int vm_stack_gc_kind; | |
487 | ||
488 | #endif | |
489 | ||
a98cef7e | 490 | static SCM |
17e90c5e KN |
491 | make_vm (void) |
492 | #define FUNC_NAME "make_vm" | |
a98cef7e | 493 | { |
17e90c5e | 494 | int i; |
7f991c7d | 495 | struct scm_vm *vp; |
747a1635 | 496 | |
7f991c7d | 497 | vp = scm_gc_malloc (sizeof (struct scm_vm), "vm"); |
d8eeb67c | 498 | |
3d5ee0cd | 499 | vp->stack_size = VM_DEFAULT_STACK_SIZE; |
e3eb628d LC |
500 | |
501 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN | |
4168aa46 TTN |
502 | vp->stack_base = (SCM *) |
503 | GC_generic_malloc (vp->stack_size * sizeof (SCM), vm_stack_gc_kind); | |
e3eb628d LC |
504 | |
505 | /* Keep a pointer to VP so that `vm_stack_mark ()' can know what the stack | |
506 | top is. */ | |
21041372 | 507 | *vp->stack_base = SCM_PACK_POINTER (vp); |
e3eb628d LC |
508 | vp->stack_base++; |
509 | vp->stack_size--; | |
510 | #else | |
d8eeb67c LC |
511 | vp->stack_base = scm_gc_malloc (vp->stack_size * sizeof (SCM), |
512 | "stack-base"); | |
e3eb628d LC |
513 | #endif |
514 | ||
2bbe1533 AW |
515 | #ifdef VM_ENABLE_STACK_NULLING |
516 | memset (vp->stack_base, 0, vp->stack_size * sizeof (SCM)); | |
517 | #endif | |
f1046e6b | 518 | vp->stack_limit = vp->stack_base + vp->stack_size - VM_STACK_RESERVE_SIZE; |
3616e9e9 KN |
519 | vp->ip = NULL; |
520 | vp->sp = vp->stack_base - 1; | |
521 | vp->fp = NULL; | |
ea9f4f4b | 522 | vp->engine = vm_default_engine; |
7656f194 | 523 | vp->trace_level = 0; |
17e90c5e | 524 | for (i = 0; i < SCM_VM_NUM_HOOKS; i++) |
3d5ee0cd | 525 | vp->hooks[i] = SCM_BOOL_F; |
2d026f04 | 526 | vp->cookie = 0; |
6f3b0cc2 | 527 | return scm_cell (scm_tc7_vm, (scm_t_bits)vp); |
a98cef7e | 528 | } |
17e90c5e | 529 | #undef FUNC_NAME |
a98cef7e | 530 | |
e3eb628d LC |
531 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN |
532 | ||
533 | /* Mark the VM stack region between its base and its current top. */ | |
534 | static struct GC_ms_entry * | |
535 | vm_stack_mark (GC_word *addr, struct GC_ms_entry *mark_stack_ptr, | |
536 | struct GC_ms_entry *mark_stack_limit, GC_word env) | |
537 | { | |
538 | GC_word *word; | |
539 | const struct scm_vm *vm; | |
540 | ||
541 | /* The first word of the VM stack should contain a pointer to the | |
542 | corresponding VM. */ | |
543 | vm = * ((struct scm_vm **) addr); | |
544 | ||
8071c490 | 545 | if (vm == NULL |
f1046e6b | 546 | || (SCM *) addr != vm->stack_base - 1) |
e3eb628d LC |
547 | /* ADDR must be a pointer to a free-list element, which we must ignore |
548 | (see warning in <gc/gc_mark.h>). */ | |
549 | return mark_stack_ptr; | |
550 | ||
e3eb628d LC |
551 | for (word = (GC_word *) vm->stack_base; word <= (GC_word *) vm->sp; word++) |
552 | mark_stack_ptr = GC_MARK_AND_PUSH ((* (GC_word **) word), | |
553 | mark_stack_ptr, mark_stack_limit, | |
554 | NULL); | |
555 | ||
556 | return mark_stack_ptr; | |
557 | } | |
558 | ||
559 | #endif /* VM_ENABLE_PRECISE_STACK_GC_SCAN */ | |
560 | ||
561 | ||
6d14383e | 562 | SCM |
4abef68f | 563 | scm_c_vm_run (SCM vm, SCM program, SCM *argv, int nargs) |
6d14383e | 564 | { |
4abef68f | 565 | struct scm_vm *vp = SCM_VM_DATA (vm); |
b95d76fc | 566 | SCM_CHECK_STACK; |
7656f194 | 567 | return vm_engines[vp->engine](vm, program, argv, nargs); |
6d14383e AW |
568 | } |
569 | ||
a98cef7e KN |
570 | /* Scheme interface */ |
571 | ||
271c3d31 LC |
572 | SCM_DEFINE (scm_the_vm, "the-vm", 0, 0, 0, |
573 | (void), | |
574 | "Return the current thread's VM.") | |
575 | #define FUNC_NAME s_scm_the_vm | |
576 | { | |
ea9f4f4b AW |
577 | scm_i_thread *t = SCM_I_CURRENT_THREAD; |
578 | ||
579 | if (SCM_UNLIKELY (scm_is_false (t->vm))) | |
580 | t->vm = make_vm (); | |
581 | ||
582 | return t->vm; | |
271c3d31 | 583 | } |
499a4c07 KN |
584 | #undef FUNC_NAME |
585 | ||
586 | ||
a98cef7e KN |
587 | SCM_DEFINE (scm_vm_p, "vm?", 1, 0, 0, |
588 | (SCM obj), | |
17e90c5e | 589 | "") |
a98cef7e KN |
590 | #define FUNC_NAME s_scm_vm_p |
591 | { | |
9bd48cb1 | 592 | return scm_from_bool (SCM_VM_P (obj)); |
a98cef7e KN |
593 | } |
594 | #undef FUNC_NAME | |
595 | ||
596 | SCM_DEFINE (scm_make_vm, "make-vm", 0, 0, 0, | |
17e90c5e KN |
597 | (void), |
598 | "") | |
599 | #define FUNC_NAME s_scm_make_vm, | |
a98cef7e | 600 | { |
17e90c5e | 601 | return make_vm (); |
a98cef7e KN |
602 | } |
603 | #undef FUNC_NAME | |
604 | ||
17e90c5e | 605 | SCM_DEFINE (scm_vm_ip, "vm:ip", 1, 0, 0, |
a98cef7e | 606 | (SCM vm), |
17e90c5e KN |
607 | "") |
608 | #define FUNC_NAME s_scm_vm_ip | |
a98cef7e KN |
609 | { |
610 | SCM_VALIDATE_VM (1, vm); | |
3d27ef4b | 611 | return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_DATA (vm)->ip); |
a98cef7e KN |
612 | } |
613 | #undef FUNC_NAME | |
614 | ||
615 | SCM_DEFINE (scm_vm_sp, "vm:sp", 1, 0, 0, | |
616 | (SCM vm), | |
17e90c5e | 617 | "") |
a98cef7e KN |
618 | #define FUNC_NAME s_scm_vm_sp |
619 | { | |
620 | SCM_VALIDATE_VM (1, vm); | |
3d27ef4b | 621 | return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_DATA (vm)->sp); |
a98cef7e KN |
622 | } |
623 | #undef FUNC_NAME | |
624 | ||
625 | SCM_DEFINE (scm_vm_fp, "vm:fp", 1, 0, 0, | |
626 | (SCM vm), | |
17e90c5e | 627 | "") |
a98cef7e KN |
628 | #define FUNC_NAME s_scm_vm_fp |
629 | { | |
630 | SCM_VALIDATE_VM (1, vm); | |
3d27ef4b | 631 | return scm_from_unsigned_integer ((scm_t_bits) SCM_VM_DATA (vm)->fp); |
a98cef7e KN |
632 | } |
633 | #undef FUNC_NAME | |
634 | ||
17e90c5e KN |
635 | #define VM_DEFINE_HOOK(n) \ |
636 | { \ | |
3d5ee0cd | 637 | struct scm_vm *vp; \ |
17e90c5e | 638 | SCM_VALIDATE_VM (1, vm); \ |
3d5ee0cd | 639 | vp = SCM_VM_DATA (vm); \ |
8b22ed7a | 640 | if (scm_is_false (vp->hooks[n])) \ |
238e7a11 | 641 | vp->hooks[n] = scm_make_hook (SCM_I_MAKINUM (1)); \ |
3d5ee0cd | 642 | return vp->hooks[n]; \ |
17e90c5e KN |
643 | } |
644 | ||
c45d4d77 | 645 | SCM_DEFINE (scm_vm_apply_hook, "vm-apply-hook", 1, 0, 0, |
17e90c5e KN |
646 | (SCM vm), |
647 | "") | |
c45d4d77 | 648 | #define FUNC_NAME s_scm_vm_apply_hook |
a98cef7e | 649 | { |
c45d4d77 | 650 | VM_DEFINE_HOOK (SCM_VM_APPLY_HOOK); |
a98cef7e KN |
651 | } |
652 | #undef FUNC_NAME | |
653 | ||
c45d4d77 | 654 | SCM_DEFINE (scm_vm_push_continuation_hook, "vm-push-continuation-hook", 1, 0, 0, |
17e90c5e KN |
655 | (SCM vm), |
656 | "") | |
c45d4d77 | 657 | #define FUNC_NAME s_scm_vm_push_continuation_hook |
a98cef7e | 658 | { |
c45d4d77 | 659 | VM_DEFINE_HOOK (SCM_VM_PUSH_CONTINUATION_HOOK); |
a98cef7e KN |
660 | } |
661 | #undef FUNC_NAME | |
662 | ||
c45d4d77 | 663 | SCM_DEFINE (scm_vm_pop_continuation_hook, "vm-pop-continuation-hook", 1, 0, 0, |
a98cef7e | 664 | (SCM vm), |
17e90c5e | 665 | "") |
c45d4d77 | 666 | #define FUNC_NAME s_scm_vm_pop_continuation_hook |
a98cef7e | 667 | { |
c45d4d77 | 668 | VM_DEFINE_HOOK (SCM_VM_POP_CONTINUATION_HOOK); |
a98cef7e KN |
669 | } |
670 | #undef FUNC_NAME | |
671 | ||
c45d4d77 | 672 | SCM_DEFINE (scm_vm_next_hook, "vm-next-hook", 1, 0, 0, |
a98cef7e | 673 | (SCM vm), |
17e90c5e | 674 | "") |
c45d4d77 | 675 | #define FUNC_NAME s_scm_vm_next_hook |
a98cef7e | 676 | { |
c45d4d77 | 677 | VM_DEFINE_HOOK (SCM_VM_NEXT_HOOK); |
a98cef7e KN |
678 | } |
679 | #undef FUNC_NAME | |
f3120251 AW |
680 | |
681 | SCM_DEFINE (scm_vm_abort_continuation_hook, "vm-abort-continuation-hook", 1, 0, 0, | |
682 | (SCM vm), | |
683 | "") | |
684 | #define FUNC_NAME s_scm_vm_abort_continuation_hook | |
685 | { | |
686 | VM_DEFINE_HOOK (SCM_VM_ABORT_CONTINUATION_HOOK); | |
687 | } | |
688 | #undef FUNC_NAME | |
689 | ||
690 | SCM_DEFINE (scm_vm_restore_continuation_hook, "vm-restore-continuation-hook", 1, 0, 0, | |
691 | (SCM vm), | |
692 | "") | |
693 | #define FUNC_NAME s_scm_vm_restore_continuation_hook | |
694 | { | |
695 | VM_DEFINE_HOOK (SCM_VM_RESTORE_CONTINUATION_HOOK); | |
696 | } | |
697 | #undef FUNC_NAME | |
a98cef7e | 698 | |
7656f194 | 699 | SCM_DEFINE (scm_vm_trace_level, "vm-trace-level", 1, 0, 0, |
17e90c5e KN |
700 | (SCM vm), |
701 | "") | |
7656f194 | 702 | #define FUNC_NAME s_scm_vm_trace_level |
a98cef7e | 703 | { |
a98cef7e | 704 | SCM_VALIDATE_VM (1, vm); |
7656f194 AW |
705 | return scm_from_int (SCM_VM_DATA (vm)->trace_level); |
706 | } | |
707 | #undef FUNC_NAME | |
708 | ||
709 | SCM_DEFINE (scm_set_vm_trace_level_x, "set-vm-trace-level!", 2, 0, 0, | |
710 | (SCM vm, SCM level), | |
711 | "") | |
712 | #define FUNC_NAME s_scm_set_vm_trace_level_x | |
713 | { | |
714 | SCM_VALIDATE_VM (1, vm); | |
715 | SCM_VM_DATA (vm)->trace_level = scm_to_int (level); | |
716 | return SCM_UNSPECIFIED; | |
a98cef7e KN |
717 | } |
718 | #undef FUNC_NAME | |
719 | ||
720 | \f | |
ea9f4f4b AW |
721 | /* |
722 | * VM engines | |
723 | */ | |
724 | ||
725 | static int | |
726 | symbol_to_vm_engine (SCM engine, const char *FUNC_NAME) | |
727 | { | |
728 | if (scm_is_eq (engine, sym_regular)) | |
729 | return SCM_VM_REGULAR_ENGINE; | |
730 | else if (scm_is_eq (engine, sym_debug)) | |
731 | return SCM_VM_DEBUG_ENGINE; | |
732 | else | |
733 | SCM_MISC_ERROR ("Unknown VM engine: ~a", scm_list_1 (engine)); | |
734 | } | |
735 | ||
736 | static SCM | |
737 | vm_engine_to_symbol (int engine, const char *FUNC_NAME) | |
738 | { | |
739 | switch (engine) | |
740 | { | |
741 | case SCM_VM_REGULAR_ENGINE: | |
742 | return sym_regular; | |
743 | case SCM_VM_DEBUG_ENGINE: | |
744 | return sym_debug; | |
745 | default: | |
746 | /* ? */ | |
747 | SCM_MISC_ERROR ("Unknown VM engine: ~a", | |
748 | scm_list_1 (scm_from_int (engine))); | |
749 | } | |
750 | } | |
751 | ||
ea9f4f4b AW |
752 | SCM_DEFINE (scm_vm_engine, "vm-engine", 1, 0, 0, |
753 | (SCM vm), | |
754 | "") | |
755 | #define FUNC_NAME s_scm_vm_engine | |
756 | { | |
757 | SCM_VALIDATE_VM (1, vm); | |
758 | return vm_engine_to_symbol (SCM_VM_DATA (vm)->engine, FUNC_NAME); | |
759 | } | |
760 | #undef FUNC_NAME | |
761 | ||
762 | void | |
763 | scm_c_set_vm_engine_x (SCM vm, int engine) | |
764 | #define FUNC_NAME "set-vm-engine!" | |
765 | { | |
766 | SCM_VALIDATE_VM (1, vm); | |
767 | ||
ea9f4f4b AW |
768 | if (engine < 0 || engine >= SCM_VM_NUM_ENGINES) |
769 | SCM_MISC_ERROR ("Unknown VM engine: ~a", | |
770 | scm_list_1 (scm_from_int (engine))); | |
771 | ||
772 | SCM_VM_DATA (vm)->engine = engine; | |
773 | } | |
774 | #undef FUNC_NAME | |
775 | ||
776 | SCM_DEFINE (scm_set_vm_engine_x, "set-vm-engine!", 2, 0, 0, | |
777 | (SCM vm, SCM engine), | |
778 | "") | |
779 | #define FUNC_NAME s_scm_set_vm_engine_x | |
780 | { | |
781 | scm_c_set_vm_engine_x (vm, symbol_to_vm_engine (engine, FUNC_NAME)); | |
782 | return SCM_UNSPECIFIED; | |
783 | } | |
784 | #undef FUNC_NAME | |
785 | ||
786 | void | |
787 | scm_c_set_default_vm_engine_x (int engine) | |
788 | #define FUNC_NAME "set-default-vm-engine!" | |
789 | { | |
790 | if (engine < 0 || engine >= SCM_VM_NUM_ENGINES) | |
791 | SCM_MISC_ERROR ("Unknown VM engine: ~a", | |
792 | scm_list_1 (scm_from_int (engine))); | |
793 | ||
794 | vm_default_engine = engine; | |
795 | } | |
796 | #undef FUNC_NAME | |
797 | ||
798 | SCM_DEFINE (scm_set_default_vm_engine_x, "set-default-vm-engine!", 1, 0, 0, | |
799 | (SCM engine), | |
800 | "") | |
801 | #define FUNC_NAME s_scm_set_default_vm_engine_x | |
802 | { | |
803 | scm_c_set_default_vm_engine_x (symbol_to_vm_engine (engine, FUNC_NAME)); | |
804 | return SCM_UNSPECIFIED; | |
805 | } | |
806 | #undef FUNC_NAME | |
807 | ||
808 | static void reinstate_vm (SCM vm) | |
809 | { | |
810 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
811 | t->vm = vm; | |
812 | } | |
813 | ||
814 | SCM_DEFINE (scm_call_with_vm, "call-with-vm", 2, 0, 1, | |
815 | (SCM vm, SCM proc, SCM args), | |
816 | "Apply @var{proc} to @var{args} in a dynamic extent in which\n" | |
817 | "@var{vm} is the current VM.\n\n" | |
818 | "As an implementation restriction, if @var{vm} is not the same\n" | |
819 | "as the current thread's VM, continuations captured within the\n" | |
820 | "call to @var{proc} may not be reinstated once control leaves\n" | |
821 | "@var{proc}.") | |
822 | #define FUNC_NAME s_scm_call_with_vm | |
823 | { | |
824 | SCM prev_vm, ret; | |
825 | SCM *argv; | |
826 | int i, nargs; | |
827 | scm_t_wind_flags flags; | |
828 | scm_i_thread *t = SCM_I_CURRENT_THREAD; | |
829 | ||
830 | SCM_VALIDATE_VM (1, vm); | |
831 | SCM_VALIDATE_PROC (2, proc); | |
832 | ||
833 | nargs = scm_ilength (args); | |
834 | if (SCM_UNLIKELY (nargs < 0)) | |
835 | scm_wrong_type_arg_msg (FUNC_NAME, 3, args, "list"); | |
836 | ||
837 | argv = alloca (nargs * sizeof(SCM)); | |
838 | for (i = 0; i < nargs; i++) | |
839 | { | |
840 | argv[i] = SCM_CAR (args); | |
841 | args = SCM_CDR (args); | |
842 | } | |
843 | ||
844 | prev_vm = t->vm; | |
845 | ||
846 | /* Reentry can happen via invokation of a saved continuation, but | |
847 | continuations only save the state of the VM that they are in at | |
848 | capture-time, which might be different from this one. So, in the | |
849 | case that the VMs are different, set up a non-rewindable frame to | |
850 | prevent reinstating an incomplete continuation. */ | |
851 | flags = scm_is_eq (prev_vm, vm) ? 0 : SCM_F_WIND_EXPLICITLY; | |
852 | if (flags) | |
853 | { | |
854 | scm_dynwind_begin (0); | |
855 | scm_dynwind_unwind_handler_with_scm (reinstate_vm, prev_vm, flags); | |
856 | t->vm = vm; | |
857 | } | |
858 | ||
859 | ret = scm_c_vm_run (vm, proc, argv, nargs); | |
860 | ||
861 | if (flags) | |
862 | scm_dynwind_end (); | |
863 | ||
864 | return ret; | |
865 | } | |
866 | #undef FUNC_NAME | |
867 | ||
868 | \f | |
a98cef7e | 869 | /* |
17e90c5e | 870 | * Initialize |
a98cef7e KN |
871 | */ |
872 | ||
07e56b27 AW |
873 | SCM scm_load_compiled_with_vm (SCM file) |
874 | { | |
53e28ed9 | 875 | SCM program = scm_make_program (scm_load_objcode (file), |
20d47c39 | 876 | SCM_BOOL_F, SCM_BOOL_F); |
07e56b27 | 877 | |
4abef68f | 878 | return scm_c_vm_run (scm_the_vm (), program, NULL, 0); |
07e56b27 AW |
879 | } |
880 | ||
17e90c5e | 881 | void |
07e56b27 | 882 | scm_bootstrap_vm (void) |
17e90c5e | 883 | { |
44602b08 AW |
884 | scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION, |
885 | "scm_init_vm", | |
60ae5ca2 AW |
886 | (scm_t_extension_init_func)scm_init_vm, NULL); |
887 | ||
4a655e50 AW |
888 | sym_vm_run = scm_from_latin1_symbol ("vm-run"); |
889 | sym_vm_error = scm_from_latin1_symbol ("vm-error"); | |
890 | sym_keyword_argument_error = scm_from_latin1_symbol ("keyword-argument-error"); | |
891 | sym_regular = scm_from_latin1_symbol ("regular"); | |
892 | sym_debug = scm_from_latin1_symbol ("debug"); | |
0404c97d | 893 | |
e3eb628d LC |
894 | #ifdef VM_ENABLE_PRECISE_STACK_GC_SCAN |
895 | vm_stack_gc_kind = | |
896 | GC_new_kind (GC_new_free_list (), | |
897 | GC_MAKE_PROC (GC_new_proc (vm_stack_mark), 0), | |
898 | 0, 1); | |
899 | ||
900 | #endif | |
07e56b27 AW |
901 | } |
902 | ||
903 | void | |
904 | scm_init_vm (void) | |
905 | { | |
17e90c5e | 906 | #ifndef SCM_MAGIC_SNARFER |
aeeff258 | 907 | #include "libguile/vm.x" |
17e90c5e | 908 | #endif |
a98cef7e | 909 | } |
17e90c5e KN |
910 | |
911 | /* | |
912 | Local Variables: | |
913 | c-file-style: "gnu" | |
914 | End: | |
915 | */ |