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