1 /* Copyright (C) 2001,2008,2009 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 /* This file is included in vm_engine.c */
26 VM_DEFINE_INSTRUCTION (0, nop
, "nop", 0, 0, 0)
31 VM_DEFINE_INSTRUCTION (1, halt
, "halt", 0, 0, 0)
33 vp
->time
+= scm_c_get_internal_run_time () - start_time
;
35 nvalues
= SCM_I_INUM (*sp
--);
44 finish_args
= scm_values (finish_args
);
48 ASSERT (sp
== stack_base
);
49 ASSERT (stack_base
== SCM_FRAME_UPPER_ADDRESS (fp
) - 1);
51 /* Restore registers */
52 sp
= SCM_FRAME_LOWER_ADDRESS (fp
) - 1;
54 fp
= SCM_FRAME_DYNAMIC_LINK (fp
);
55 NULLSTACK (stack_base
- sp
);
61 VM_DEFINE_INSTRUCTION (2, break, "break", 0, 0, 0)
67 VM_DEFINE_INSTRUCTION (3, drop
, "drop", 0, 1, 0)
73 VM_DEFINE_INSTRUCTION (4, mark
, "mark", 0, 0, 1)
79 VM_DEFINE_INSTRUCTION (5, dup
, "dup", 0, 0, 1)
91 VM_DEFINE_INSTRUCTION (6, void, "void", 0, 0, 1)
93 PUSH (SCM_UNSPECIFIED
);
97 VM_DEFINE_INSTRUCTION (7, make_true
, "make-true", 0, 0, 1)
103 VM_DEFINE_INSTRUCTION (8, make_false
, "make-false", 0, 0, 1)
109 VM_DEFINE_INSTRUCTION (9, make_eol
, "make-eol", 0, 0, 1)
115 VM_DEFINE_INSTRUCTION (10, make_int8
, "make-int8", 1, 0, 1)
117 PUSH (SCM_I_MAKINUM ((signed char) FETCH ()));
121 VM_DEFINE_INSTRUCTION (11, make_int8_0
, "make-int8:0", 0, 0, 1)
127 VM_DEFINE_INSTRUCTION (12, make_int8_1
, "make-int8:1", 0, 0, 1)
129 PUSH (SCM_I_MAKINUM (1));
133 VM_DEFINE_INSTRUCTION (13, make_int16
, "make-int16", 2, 0, 1)
137 PUSH (SCM_I_MAKINUM ((signed short) (h
<< 8) + l
));
141 VM_DEFINE_INSTRUCTION (14, make_char8
, "make-char8", 1, 0, 1)
143 PUSH (SCM_MAKE_CHAR (FETCH ()));
147 VM_DEFINE_INSTRUCTION (15, list
, "list", 2, -1, 1)
149 unsigned h
= FETCH ();
150 unsigned l
= FETCH ();
151 unsigned len
= ((h
<< 8) + l
);
156 VM_DEFINE_INSTRUCTION (16, vector
, "vector", 2, -1, 1)
158 unsigned h
= FETCH ();
159 unsigned l
= FETCH ();
160 unsigned len
= ((h
<< 8) + l
);
166 vect
= scm_make_vector (scm_from_uint (len
), SCM_BOOL_F
);
167 memcpy (SCM_I_VECTOR_WELTS(vect
), sp
, sizeof(SCM
) * len
);
174 VM_DEFINE_INSTRUCTION (17, list_mark
, "list-mark", 0, 0, 0)
180 VM_DEFINE_INSTRUCTION (18, cons_mark
, "cons-mark", 0, 0, 0)
186 VM_DEFINE_INSTRUCTION (19, vector_mark
, "vector-mark", 0, 0, 0)
190 *sp
= scm_vector (*sp
);
194 VM_DEFINE_INSTRUCTION (20, list_break
, "list-break", 0, 0, 0)
198 PUSH_LIST (l
, SCM_NULLP
);
207 #define OBJECT_REF(i) objects[i]
208 #define OBJECT_SET(i,o) objects[i] = o
210 #define LOCAL_REF(i) SCM_FRAME_VARIABLE (fp, i)
211 #define LOCAL_SET(i,o) SCM_FRAME_VARIABLE (fp, i) = o
213 /* For the variable operations, we _must_ obviously avoid function calls to
214 `scm_variable_ref ()', `scm_variable_bound_p ()' and friends which do
215 nothing more than the corresponding macros. */
216 #define VARIABLE_REF(v) SCM_VARIABLE_REF (v)
217 #define VARIABLE_SET(v,o) SCM_VARIABLE_SET (v, o)
218 #define VARIABLE_BOUNDP(v) (VARIABLE_REF (v) != SCM_UNDEFINED)
222 VM_DEFINE_INSTRUCTION (21, object_ref
, "object-ref", 1, 0, 1)
224 register unsigned objnum
= FETCH ();
225 CHECK_OBJECT (objnum
);
226 PUSH (OBJECT_REF (objnum
));
230 VM_DEFINE_INSTRUCTION (22, local_ref
, "local-ref", 1, 0, 1)
232 PUSH (LOCAL_REF (FETCH ()));
237 VM_DEFINE_INSTRUCTION (23, external_ref
, "external-ref", 1, 0, 1)
241 for (i
= FETCH (); i
; i
--)
252 VM_DEFINE_INSTRUCTION (24, variable_ref
, "variable-ref", 0, 0, 1)
256 if (!VARIABLE_BOUNDP (x
))
258 finish_args
= scm_list_1 (x
);
259 /* Was: finish_args = SCM_LIST1 (SCM_CAR (x)); */
260 goto vm_error_unbound
;
264 SCM o
= VARIABLE_REF (x
);
271 VM_DEFINE_INSTRUCTION (25, toplevel_ref
, "toplevel-ref", 1, 0, 1)
273 unsigned objnum
= FETCH ();
275 CHECK_OBJECT (objnum
);
276 what
= OBJECT_REF (objnum
);
278 if (!SCM_VARIABLEP (what
))
281 if (SCM_LIKELY (SCM_SYMBOLP (what
)))
284 if (SCM_LIKELY (scm_module_system_booted_p
285 && scm_is_true ((mod
= scm_program_module (program
)))))
287 what
= scm_module_lookup (mod
, what
);
290 SCM v
= scm_sym2var (what
, SCM_BOOL_F
, SCM_BOOL_F
);
291 if (scm_is_false (v
))
292 SCM_MISC_ERROR ("unbound variable: ~S", scm_list_1 (what
));
300 /* compilation of @ or @@
301 `what' is a three-element list: (MODNAME SYM INTERFACE?)
302 INTERFACE? is #t if we compiled @ or #f if we compiled @@
304 mod
= scm_resolve_module (SCM_CAR (what
));
305 if (scm_is_true (SCM_CADDR (what
)))
306 mod
= scm_module_public_interface (mod
);
307 if (SCM_FALSEP (mod
))
309 finish_args
= scm_list_1 (mod
);
310 goto vm_error_no_such_module
;
313 what
= scm_module_lookup (mod
, SCM_CADR (what
));
316 if (!VARIABLE_BOUNDP (what
))
318 finish_args
= scm_list_1 (what
);
319 goto vm_error_unbound
;
322 OBJECT_SET (objnum
, what
);
325 PUSH (VARIABLE_REF (what
));
331 VM_DEFINE_INSTRUCTION (26, local_set
, "local-set", 1, 1, 0)
333 LOCAL_SET (FETCH (), *sp
);
338 VM_DEFINE_INSTRUCTION (27, external_set
, "external-set", 1, 1, 0)
342 for (i
= FETCH (); i
; i
--)
353 VM_DEFINE_INSTRUCTION (28, variable_set
, "variable-set", 0, 1, 0)
355 VARIABLE_SET (sp
[0], sp
[-1]);
360 VM_DEFINE_INSTRUCTION (29, toplevel_set
, "toplevel-set", 1, 1, 0)
362 unsigned objnum
= FETCH ();
364 CHECK_OBJECT (objnum
);
365 what
= OBJECT_REF (objnum
);
367 if (!SCM_VARIABLEP (what
))
370 if (SCM_LIKELY (SCM_SYMBOLP (what
)))
373 if (SCM_LIKELY (scm_module_system_booted_p
374 && scm_is_true ((mod
= scm_program_module (program
)))))
376 what
= scm_module_lookup (mod
, what
);
379 SCM v
= scm_sym2var (what
, SCM_BOOL_F
, SCM_BOOL_F
);
380 if (scm_is_false (v
))
381 SCM_MISC_ERROR ("unbound variable: ~S", scm_list_1 (what
));
389 /* compilation of @ or @@
390 `what' is a three-element list: (MODNAME SYM INTERFACE?)
391 INTERFACE? is #t if we compiled @ or #f if we compiled @@
393 mod
= scm_resolve_module (SCM_CAR (what
));
394 if (scm_is_true (SCM_CADDR (what
)))
395 mod
= scm_module_public_interface (mod
);
396 if (SCM_FALSEP (mod
))
398 finish_args
= scm_list_1 (what
);
399 goto vm_error_no_such_module
;
402 what
= scm_module_lookup (mod
, SCM_CADR (what
));
405 OBJECT_SET (objnum
, what
);
408 VARIABLE_SET (what
, *sp
);
418 /* offset must be a signed short!!! */
419 #define FETCH_OFFSET(offset) \
423 offset = (h << 8) + l; \
428 signed short offset; \
429 FETCH_OFFSET (offset); \
437 VM_DEFINE_INSTRUCTION (31, br
, "br", 2, 0, 0)
441 ip
+= (signed short) (h
<< 8) + l
;
445 VM_DEFINE_INSTRUCTION (32, br_if
, "br-if", 2, 0, 0)
447 BR (!SCM_FALSEP (*sp
));
450 VM_DEFINE_INSTRUCTION (33, br_if_not
, "br-if-not", 2, 0, 0)
452 BR (SCM_FALSEP (*sp
));
455 VM_DEFINE_INSTRUCTION (34, br_if_eq
, "br-if-eq", 2, 0, 0)
457 sp
--; /* underflow? */
458 BR (SCM_EQ_P (sp
[0], sp
[1]));
461 VM_DEFINE_INSTRUCTION (35, br_if_not_eq
, "br-if-not-eq", 2, 0, 0)
463 sp
--; /* underflow? */
464 BR (!SCM_EQ_P (sp
[0], sp
[1]));
467 VM_DEFINE_INSTRUCTION (36, br_if_null
, "br-if-null", 2, 0, 0)
469 BR (SCM_NULLP (*sp
));
472 VM_DEFINE_INSTRUCTION (37, br_if_not_null
, "br-if-not-null", 2, 0, 0)
474 BR (!SCM_NULLP (*sp
));
482 VM_DEFINE_INSTRUCTION (38, make_closure
, "make-closure", 0, 1, 1)
485 SCM_NEWSMOB3 (*sp
, scm_tc16_program
, SCM_PROGRAM_OBJCODE (*sp
),
486 SCM_PROGRAM_OBJTABLE (*sp
), external
);
490 VM_DEFINE_INSTRUCTION (39, call
, "call", 1, -1, 1)
499 SCM_TICK
; /* allow interrupt here */
504 if (SCM_PROGRAM_P (x
))
514 #ifdef ENABLE_TRAMPOLINE
515 /* Seems to slow down the fibo test, dunno why */
523 scm_t_trampoline_0 call
= scm_trampoline_0 (x
);
534 scm_t_trampoline_1 call
= scm_trampoline_1 (x
);
540 *sp
= call (x
, arg1
);
547 scm_t_trampoline_2 call
= scm_trampoline_2 (x
);
554 *sp
= call (x
, arg1
, arg2
);
562 * Other interpreted or compiled call
564 if (!SCM_FALSEP (scm_procedure_p (x
)))
566 /* At this point, the stack contains the procedure and each one of its
570 /* keep args on stack so they are marked */
571 sp
[-1] = scm_apply (x
, sp
[0], SCM_EOL
);
572 NULLSTACK_FOR_NONLOCAL_EXIT ();
574 if (SCM_UNLIKELY (SCM_VALUESP (*sp
)))
576 /* truncate values */
579 values
= scm_struct_ref (values
, SCM_INUM0
);
580 if (scm_is_null (values
))
581 goto vm_error_not_enough_values
;
582 PUSH (SCM_CAR (values
));
589 if (SCM_VM_CONT_P (x
))
592 vm_call_continuation
:
593 /* Check the number of arguments */
594 /* FIXME multiple args */
596 scm_wrong_num_args (program
);
598 /* Reinstate the continuation */
600 reinstate_vm_cont (vp
, program
);
602 program
= SCM_FRAME_PROGRAM (fp
);
608 goto vm_error_wrong_type_apply
;
611 VM_DEFINE_INSTRUCTION (40, goto_args
, "goto/args", 1, -1, 1)
619 SCM_TICK
; /* allow interrupt here */
622 * Tail recursive call
624 if (SCM_EQ_P (x
, program
))
631 for (i
= 0; i
< bp
->nargs
; i
++)
632 LOCAL_SET (i
, sp
[i
]);
634 /* Drop the first argument and the program itself. */
636 NULLSTACK (bp
->nargs
+ 1);
638 /* Freshen the externals */
639 external
= SCM_PROGRAM_EXTERNALS (x
);
640 for (i
= 0; i
< bp
->nexts
; i
++)
641 CONS (external
, SCM_UNDEFINED
, external
);
642 SCM_FRAME_DATA_ADDRESS (fp
)[0] = external
;
644 /* Init locals to valid SCM values */
645 for (i
= 0; i
< bp
->nlocs
; i
++)
646 LOCAL_SET (i
+ bp
->nargs
, SCM_UNDEFINED
);
655 * Tail call, but not to self -- reuse the frame, keeping the ra and dl
657 if (SCM_PROGRAM_P (x
))
659 SCM
*data
, *tail_args
, *dl
;
661 scm_byte_t
*ra
, *mvra
;
662 #ifdef VM_ENABLE_STACK_NULLING
669 tail_args
= stack_base
+ 2;
670 ra
= SCM_FRAME_RETURN_ADDRESS (fp
);
671 mvra
= SCM_FRAME_MV_RETURN_ADDRESS (fp
);
672 dl
= SCM_FRAME_DYNAMIC_LINK (fp
);
674 /* switch programs */
678 /* delay updating the frame so that if INIT_ARGS has to cons up a rest
679 arg, going into GC, the stack still makes sense */
683 #ifdef VM_ENABLE_STACK_NULLING
688 /* new registers -- logically this would be better later, but let's make
689 sure we have space for the locals now */
690 data
= SCM_FRAME_DATA_ADDRESS (fp
);
692 stack_base
= data
+ 3;
696 /* copy args, bottom-up */
697 for (i
= 0; i
< nargs
; i
++)
698 fp
[i
] = tail_args
[i
];
700 NULLSTACK (old_sp
- sp
);
703 for (i
= bp
->nlocs
; i
; i
--)
704 data
[-i
] = SCM_UNDEFINED
;
711 /* Postpone initializing external vars, because if the CONS causes a GC,
712 we want the stack marker to see the data array formatted as expected. */
713 data
[0] = SCM_UNDEFINED
;
714 external
= SCM_PROGRAM_EXTERNALS (fp
[-1]);
715 for (i
= 0; i
< bp
->nexts
; i
++)
716 CONS (external
, SCM_UNDEFINED
, external
);
723 #ifdef ENABLE_TRAMPOLINE
724 /* This seems to actually slow down the fibo test -- dunno why */
732 scm_t_trampoline_0 call
= scm_trampoline_0 (x
);
743 scm_t_trampoline_1 call
= scm_trampoline_1 (x
);
749 *sp
= call (x
, arg1
);
756 scm_t_trampoline_2 call
= scm_trampoline_2 (x
);
763 *sp
= call (x
, arg1
, arg2
);
772 * Other interpreted or compiled call
774 if (!SCM_FALSEP (scm_procedure_p (x
)))
778 sp
[-1] = scm_apply (x
, sp
[0], SCM_EOL
);
779 NULLSTACK_FOR_NONLOCAL_EXIT ();
781 if (SCM_UNLIKELY (SCM_VALUESP (*sp
)))
783 /* multiple values returned to continuation */
786 values
= scm_struct_ref (values
, SCM_INUM0
);
787 nvalues
= scm_ilength (values
);
788 PUSH_LIST (values
, SCM_NULLP
);
789 goto vm_return_values
;
799 if (SCM_VM_CONT_P (program
))
800 goto vm_call_continuation
;
802 goto vm_error_wrong_type_apply
;
805 VM_DEFINE_INSTRUCTION (41, goto_nargs
, "goto/nargs", 0, 0, 1)
809 nargs
= scm_to_int (x
);
810 /* FIXME: should truncate values? */
814 VM_DEFINE_INSTRUCTION (42, call_nargs
, "call/nargs", 0, 0, 1)
818 nargs
= scm_to_int (x
);
819 /* FIXME: should truncate values? */
823 VM_DEFINE_INSTRUCTION (43, mv_call
, "mv-call", 3, -1, 1)
829 FETCH_OFFSET (offset
);
836 if (SCM_PROGRAM_P (x
))
842 SCM_FRAME_DATA_ADDRESS (fp
)[2] = (SCM
)(SCM_FRAME_RETURN_ADDRESS (fp
) + offset
);
848 * Other interpreted or compiled call
850 if (!SCM_FALSEP (scm_procedure_p (x
)))
852 /* At this point, the stack contains the procedure and each one of its
856 sp
[-1] = scm_apply (x
, sp
[0], SCM_EOL
);
857 NULLSTACK_FOR_NONLOCAL_EXIT ();
859 if (SCM_VALUESP (*sp
))
863 values
= scm_struct_ref (values
, SCM_INUM0
);
864 len
= scm_length (values
);
865 PUSH_LIST (values
, SCM_NULLP
);
874 if (SCM_VM_CONT_P (x
))
877 goto vm_call_continuation
;
881 goto vm_error_wrong_type_apply
;
884 VM_DEFINE_INSTRUCTION (44, apply
, "apply", 1, -1, 1)
893 len
= scm_ilength (ls
);
895 goto vm_error_wrong_type_arg
;
897 PUSH_LIST (ls
, SCM_NULL_OR_NIL_P
);
903 VM_DEFINE_INSTRUCTION (45, goto_apply
, "goto/apply", 1, -1, 1)
912 len
= scm_ilength (ls
);
914 goto vm_error_wrong_type_arg
;
916 PUSH_LIST (ls
, SCM_NULL_OR_NIL_P
);
922 VM_DEFINE_INSTRUCTION (46, call_cc
, "call/cc", 0, 1, 1)
928 cont
= scm_make_continuation (&first
);
936 ASSERT (sp
== vp
->sp
);
937 ASSERT (fp
== vp
->fp
);
938 else if (SCM_VALUESP (cont
))
940 /* multiple values returned to continuation */
942 values
= scm_struct_ref (cont
, SCM_INUM0
);
943 if (SCM_NULLP (values
))
944 goto vm_error_no_values
;
945 /* non-tail context does not accept multiple values? */
946 PUSH (SCM_CAR (values
));
956 VM_DEFINE_INSTRUCTION (47, goto_cc
, "goto/cc", 0, 1, 1)
962 cont
= scm_make_continuation (&first
);
963 ASSERT (sp
== vp
->sp
);
964 ASSERT (fp
== vp
->fp
);
972 else if (SCM_VALUESP (cont
))
974 /* multiple values returned to continuation */
976 values
= scm_struct_ref (cont
, SCM_INUM0
);
977 nvalues
= scm_ilength (values
);
978 PUSH_LIST (values
, SCM_NULLP
);
979 goto vm_return_values
;
988 VM_DEFINE_INSTRUCTION (48, return, "return", 0, 1, 1)
994 SCM_TICK
; /* allow interrupt here */
997 data
= SCM_FRAME_DATA_ADDRESS (fp
);
1000 ASSERT (sp
== stack_base
);
1001 ASSERT (stack_base
== data
+ 3);
1003 /* Restore registers */
1004 sp
= SCM_FRAME_LOWER_ADDRESS (fp
);
1005 ip
= SCM_FRAME_BYTE_CAST (data
[3]);
1006 fp
= SCM_FRAME_STACK_CAST (data
[1]);
1008 #ifdef VM_ENABLE_STACK_NULLING
1009 int nullcount
= stack_base
- sp
;
1011 stack_base
= SCM_FRAME_UPPER_ADDRESS (fp
) - 1;
1012 NULLSTACK (nullcount
);
1015 /* Set return value (sp is already pushed) */
1019 /* Restore the last program */
1020 program
= SCM_FRAME_PROGRAM (fp
);
1027 VM_DEFINE_INSTRUCTION (49, return_values
, "return/values", 1, -1, -1)
1029 /* nvalues declared at top level, because for some reason gcc seems to think
1030 that perhaps it might be used without declaration. Fooey to that, I say. */
1038 data
= SCM_FRAME_DATA_ADDRESS (fp
);
1039 ASSERT (stack_base
== data
+ 3);
1041 /* data[2] is the mv return address */
1042 if (nvalues
!= 1 && data
[2])
1045 /* Restore registers */
1046 sp
= SCM_FRAME_LOWER_ADDRESS (fp
) - 1;
1047 ip
= SCM_FRAME_BYTE_CAST (data
[2]); /* multiple value ra */
1048 fp
= SCM_FRAME_STACK_CAST (data
[1]);
1050 /* Push return values, and the number of values */
1051 for (i
= 0; i
< nvalues
; i
++)
1052 *++sp
= stack_base
[1+i
];
1053 *++sp
= SCM_I_MAKINUM (nvalues
);
1055 /* Finally set new stack_base */
1056 NULLSTACK (stack_base
- sp
+ nvalues
+ 1);
1057 stack_base
= SCM_FRAME_UPPER_ADDRESS (fp
) - 1;
1059 else if (nvalues
>= 1)
1061 /* Multiple values for a single-valued continuation -- here's where I
1062 break with guile tradition and try and do something sensible. (Also,
1063 this block handles the single-valued return to an mv
1065 /* Restore registers */
1066 sp
= SCM_FRAME_LOWER_ADDRESS (fp
) - 1;
1067 ip
= SCM_FRAME_BYTE_CAST (data
[3]); /* single value ra */
1068 fp
= SCM_FRAME_STACK_CAST (data
[1]);
1070 /* Push first value */
1071 *++sp
= stack_base
[1];
1073 /* Finally set new stack_base */
1074 NULLSTACK (stack_base
- sp
+ nvalues
+ 1);
1075 stack_base
= SCM_FRAME_UPPER_ADDRESS (fp
) - 1;
1078 goto vm_error_no_values
;
1080 /* Restore the last program */
1081 program
= SCM_FRAME_PROGRAM (fp
);
1088 VM_DEFINE_INSTRUCTION (50, return_values_star
, "return/values*", 1, -1, -1)
1093 ASSERT (nvalues
>= 1);
1097 while (SCM_CONSP (l
))
1103 if (SCM_UNLIKELY (!SCM_NULL_OR_NIL_P (l
))) {
1104 finish_args
= scm_list_1 (l
);
1105 goto vm_error_improper_list
;
1108 goto vm_return_values
;
1111 VM_DEFINE_INSTRUCTION (51, truncate_values
, "truncate-values", 2, -1, -1)
1116 nvalues
= scm_to_int (x
);
1123 if (nvalues
< nbinds
)
1124 goto vm_error_not_enough_values
;
1127 POP_LIST (nvalues
- nbinds
);
1129 DROPN (nvalues
- nbinds
);
1135 (defun renumber-ops ()
1136 "start from top of buffer and renumber 'VM_DEFINE_FOO (\n' sequences"
1139 (let ((counter -1)) (goto-char (point-min))
1140 (while (re-search-forward "^VM_DEFINE_[^ ]+ (\\([^,]+\\)," (point-max) t)
1142 (number-to-string (setq counter (1+ counter)))