Got the VM up and running! Augmented the documentation.
[bpt/guile.git] / src / vm_engine.h
CommitLineData
8f5cfc81 1/* Copyright (C) 2001 Free Software Foundation, Inc.
a98cef7e
KN
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
6 * any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
17 *
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
20 *
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
26 *
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
29 *
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
37 *
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
41
42/* This file is included in vm_engine.c */
43
44/*
3d5ee0cd 45 * Options
a98cef7e
KN
46 */
47
ac02b386
KN
48#define VM_USE_HOOKS 1 /* Various hooks */
49#define VM_USE_CLOCK 1 /* Bogoclock */
50#define VM_CHECK_EXTERNAL 1 /* Check external link */
a98cef7e
KN
51
52\f
53/*
17e90c5e 54 * Registers
a98cef7e
KN
55 */
56
17e90c5e 57/* Register optimization. [ stolen from librep/src/lispmach.h,v 1.3 ]
9df03fd0 58
17e90c5e
KN
59 Some compilers underestimate the use of the local variables representing
60 the abstract machine registers, and don't put them in hardware registers,
61 which slows down the interpreter considerably.
62 For GCC, I have hand-assigned hardware registers for several architectures.
63*/
9df03fd0 64
17e90c5e
KN
65#ifdef __GNUC__
66#ifdef __mips__
67#define IP_REG asm("$16")
68#define SP_REG asm("$17")
69#define FP_REG asm("$18")
70#endif
71#ifdef __sparc__
72#define IP_REG asm("%l0")
73#define SP_REG asm("%l1")
74#define FP_REG asm("%l2")
75#endif
76#ifdef __alpha__
77#ifdef __CRAY__
78#define IP_REG asm("r9")
79#define SP_REG asm("r10")
80#define FP_REG asm("r11")
9df03fd0 81#else
17e90c5e
KN
82#define IP_REG asm("$9")
83#define SP_REG asm("$10")
84#define FP_REG asm("$11")
85#endif
86#endif
87#ifdef __i386__
88#define IP_REG asm("%esi")
89#define SP_REG asm("%edi")
90#define FP_REG
91#endif
92#if defined(PPC) || defined(_POWER) || defined(_IBMR2)
93#define IP_REG asm("26")
94#define SP_REG asm("27")
95#define FP_REG asm("28")
96#endif
97#ifdef __hppa__
98#define IP_REG asm("%r18")
99#define SP_REG asm("%r17")
100#define FP_REG asm("%r16")
101#endif
102#ifdef __mc68000__
103#define IP_REG asm("a5")
104#define SP_REG asm("a4")
105#define FP_REG
106#endif
107#ifdef __arm__
108#define IP_REG asm("r9")
109#define SP_REG asm("r8")
110#define FP_REG asm("r7")
111#endif
9df03fd0
KN
112#endif
113
114\f
a98cef7e 115/*
3d5ee0cd 116 * Cache/Sync
a98cef7e
KN
117 */
118
3d5ee0cd 119#define CACHE_REGISTER() \
17e90c5e 120{ \
3d5ee0cd
KN
121 ip = vp->ip; \
122 sp = vp->sp; \
123 fp = vp->fp; \
17e90c5e 124}
a98cef7e 125
3d5ee0cd 126#define SYNC_REGISTER() \
a98cef7e 127{ \
3d5ee0cd
KN
128 vp->ip = ip; \
129 vp->sp = sp; \
130 vp->fp = fp; \
a98cef7e
KN
131}
132
238e7a11
LC
133/* Get a local copy of the program's "object table" (i.e. the vector of
134 external bindings that are referenced by the program), initialized by
135 `load-program'. */
136#define CACHE_PROGRAM() \
137{ \
138 size_t _vsize; \
139 ssize_t _vincr; \
140 scm_t_array_handle _vhandle; \
141 \
142 bp = SCM_PROGRAM_DATA (program); \
143 /* Was: objects = SCM_VELTS (bp->objs); */ \
144 objects = scm_vector_elements (bp->objs, &_vhandle, \
145 &_vsize, &_vincr); \
146 scm_array_handle_release (&_vhandle); \
41f248a8
KN
147}
148
3d5ee0cd
KN
149#define SYNC_BEFORE_GC() \
150{ \
151 SYNC_REGISTER (); \
17e90c5e 152}
a98cef7e 153
17e90c5e 154#define SYNC_ALL() \
a98cef7e 155{ \
3d5ee0cd 156 SYNC_REGISTER (); \
a98cef7e
KN
157}
158
a98cef7e 159\f
ac02b386
KN
160/*
161 * Error check
162 */
163
164#undef CHECK_EXTERNAL
165#if VM_CHECK_EXTERNAL
166#define CHECK_EXTERNAL(e) \
167 do { if (!SCM_CONSP (e)) goto vm_error_external; } while (0)
168#else
169#define CHECK_EXTERNAL(e)
170#endif
171
172\f
3d5ee0cd
KN
173/*
174 * Hooks
175 */
176
177#undef RUN_HOOK
178#if VM_USE_HOOKS
179#define RUN_HOOK(h) \
180{ \
ac02b386 181 if (!SCM_FALSEP (vp->hooks[h])) \
3d5ee0cd 182 { \
af988bbf
KN
183 SYNC_REGISTER (); \
184 vm_heapify_frames (vm); \
ac02b386 185 scm_c_run_hook (vp->hooks[h], hook_args); \
af988bbf 186 CACHE_REGISTER (); \
3d5ee0cd
KN
187 } \
188}
189#else
190#define RUN_HOOK(h)
191#endif
192
ac02b386
KN
193#define BOOT_HOOK() RUN_HOOK (SCM_VM_BOOT_HOOK)
194#define HALT_HOOK() RUN_HOOK (SCM_VM_HALT_HOOK)
195#define NEXT_HOOK() RUN_HOOK (SCM_VM_NEXT_HOOK)
7a0d0cee 196#define BREAK_HOOK() RUN_HOOK (SCM_VM_BREAK_HOOK)
ac02b386
KN
197#define ENTER_HOOK() RUN_HOOK (SCM_VM_ENTER_HOOK)
198#define APPLY_HOOK() RUN_HOOK (SCM_VM_APPLY_HOOK)
199#define EXIT_HOOK() RUN_HOOK (SCM_VM_EXIT_HOOK)
200#define RETURN_HOOK() RUN_HOOK (SCM_VM_RETURN_HOOK)
3d5ee0cd
KN
201
202\f
a98cef7e
KN
203/*
204 * Stack operation
205 */
206
17e90c5e 207#define CHECK_OVERFLOW() \
3616e9e9 208 if (sp > stack_limit) \
17e90c5e
KN
209 goto vm_error_stack_overflow
210
211#define CHECK_UNDERFLOW() \
3616e9e9 212 if (sp < stack_base) \
17e90c5e 213 goto vm_error_stack_underflow
a98cef7e 214
3616e9e9
KN
215#define PUSH(x) do { sp++; CHECK_OVERFLOW (); *sp = x; } while (0)
216#define DROP() do { CHECK_UNDERFLOW (); sp--; } while (0)
17e90c5e
KN
217#define POP(x) do { x = *sp; DROP (); } while (0)
218
219#define CONS(x,y,z) \
a98cef7e 220{ \
3d5ee0cd 221 SYNC_BEFORE_GC (); \
238e7a11 222 x = scm_cons (y, z); \
a98cef7e
KN
223}
224
17e90c5e
KN
225#define POP_LIST(n) \
226do { \
227 int i; \
228 SCM l = SCM_EOL; \
3616e9e9
KN
229 sp -= n; \
230 for (i = n; i; i--) \
17e90c5e 231 CONS (l, sp[i], l); \
3616e9e9 232 PUSH (l); \
17e90c5e
KN
233} while (0)
234
cb4cca12
KN
235#define POP_LIST_MARK() \
236do { \
237 SCM o; \
238 SCM l = SCM_EOL; \
239 POP (o); \
240 while (!SCM_UNBNDP (o)) \
241 { \
242 CONS (l, o, l); \
243 POP (o); \
244 } \
245 PUSH (l); \
246} while (0)
247
a98cef7e
KN
248\f
249/*
17e90c5e 250 * Instruction operation
a98cef7e
KN
251 */
252
17e90c5e 253#define FETCH() (*ip++)
17e90c5e
KN
254#define FETCH_LENGTH(len) do { ip = vm_fetch_length (ip, &len); } while (0)
255
256#undef CLOCK
257#if VM_USE_CLOCK
3d5ee0cd 258#define CLOCK(n) vp->clock += n
a98cef7e 259#else
17e90c5e 260#define CLOCK(n)
a98cef7e
KN
261#endif
262
17e90c5e
KN
263#undef NEXT_JUMP
264#ifdef HAVE_LABELS_AS_VALUES
265#define NEXT_JUMP() goto *jump_table[FETCH ()]
266#else
267#define NEXT_JUMP() goto vm_start
268#endif
269
270#define NEXT \
271{ \
272 CLOCK (1); \
17e90c5e
KN
273 NEXT_HOOK (); \
274 NEXT_JUMP (); \
a98cef7e
KN
275}
276
277\f
278/*
ac02b386 279 * Stack frame
17e90c5e
KN
280 */
281
17e90c5e
KN
282#define INIT_ARGS() \
283{ \
284 if (bp->nrest) \
285 { \
5315b862 286 int n = nargs - (bp->nargs - 1); \
17e90c5e
KN
287 if (n < 0) \
288 goto vm_error_wrong_num_args; \
289 POP_LIST (n); \
290 } \
291 else \
292 { \
293 if (nargs != bp->nargs) \
294 goto vm_error_wrong_num_args; \
295 } \
296}
297
ac99cb0c 298/* See frames.h for the layout of stack frames */
3616e9e9
KN
299
300#define NEW_FRAME() \
301{ \
24aa2715 302 int i; \
af988bbf
KN
303 SCM ra = SCM_PACK (ip); \
304 SCM dl = SCM_PACK (fp); \
24aa2715
KN
305 SCM *p = sp + 1; \
306 SCM *q = p + bp->nlocs; \
307 \
308 /* New pointers */ \
3616e9e9 309 ip = bp->base; \
24aa2715 310 fp = p - bp->nargs; \
af988bbf 311 sp = q + 3; \
3616e9e9 312 CHECK_OVERFLOW (); \
24aa2715
KN
313 \
314 /* Init local variables */ \
315 for (; p < q; p++) \
316 *p = SCM_UNDEFINED; \
317 \
318 /* Create external variables */ \
319 external = bp->external; \
320 for (i = 0; i < bp->nexts; i++) \
321 CONS (external, SCM_UNDEFINED, external); \
ac02b386
KN
322 \
323 /* Set frame data */ \
af988bbf
KN
324 p[3] = ra; \
325 p[2] = dl; \
326 p[1] = SCM_BOOL_F; \
24aa2715 327 p[0] = external; \
3616e9e9
KN
328}
329
330#define FREE_FRAME() \
331{ \
46f215f8
KN
332 SCM *last_sp = sp; \
333 SCM *last_fp = fp; \
f21dfea6 334 SCM *p = fp + bp->nargs + bp->nlocs; \
46f215f8
KN
335 \
336 /* Restore pointers */ \
337 ip = SCM_FRAME_BYTE_CAST (p[3]); \
338 fp = SCM_FRAME_STACK_CAST (p[2]); \
339 \
af988bbf 340 if (!SCM_FALSEP (p[1])) \
46f215f8
KN
341 { \
342 /* Unlink the heap stack */ \
343 vp->this_frame = p[1]; \
344 } \
af988bbf 345 else \
46f215f8
KN
346 { \
347 /* Move stack items */ \
348 p += 4; \
349 sp = SCM_FRAME_LOWER_ADDRESS (last_fp); \
350 while (p <= last_sp) \
351 *sp++ = *p++; \
352 sp--; \
353 } \
3616e9e9
KN
354}
355
af988bbf
KN
356#define CACHE_EXTERNAL() external = fp[bp->nargs + bp->nlocs]
357
ac02b386
KN
358\f
359/*
360 * Function support
361 */
362
363#define ARGS1(a1) SCM a1 = sp[0];
364#define ARGS2(a1,a2) SCM a1 = sp[-1], a2 = sp[0]; sp--;
365#define ARGS3(a1,a2,a3) SCM a1 = sp[-2], a2 = sp[-1], a3 = sp[0]; sp -= 2;
366
367#define RETURN(x) do { *sp = x; NEXT; } while (0)
368
17e90c5e
KN
369/*
370 Local Variables:
371 c-file-style: "gnu"
372 End:
373*/