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 ()));
236 VM_DEFINE_INSTRUCTION (23, external_ref
, "external-ref", 1, 0, 1)
240 for (i
= FETCH (); i
; i
--)
250 VM_DEFINE_INSTRUCTION (24, variable_ref
, "variable-ref", 0, 0, 1)
254 if (!VARIABLE_BOUNDP (x
))
256 finish_args
= scm_list_1 (x
);
257 /* Was: finish_args = SCM_LIST1 (SCM_CAR (x)); */
258 goto vm_error_unbound
;
262 SCM o
= VARIABLE_REF (x
);
269 VM_DEFINE_INSTRUCTION (25, toplevel_ref
, "toplevel-ref", 1, 0, 1)
271 unsigned objnum
= FETCH ();
273 CHECK_OBJECT (objnum
);
274 what
= OBJECT_REF (objnum
);
276 if (!SCM_VARIABLEP (what
))
279 if (SCM_LIKELY (SCM_SYMBOLP (what
)))
282 if (SCM_LIKELY (scm_module_system_booted_p
283 && scm_is_true ((mod
= scm_program_module (program
)))))
285 what
= scm_module_lookup (mod
, what
);
288 SCM v
= scm_sym2var (what
, SCM_BOOL_F
, SCM_BOOL_F
);
289 if (scm_is_false (v
))
290 SCM_MISC_ERROR ("unbound variable: ~S", scm_list_1 (what
));
298 /* compilation of @ or @@
299 `what' is a three-element list: (MODNAME SYM INTERFACE?)
300 INTERFACE? is #t if we compiled @ or #f if we compiled @@
302 mod
= scm_resolve_module (SCM_CAR (what
));
303 if (scm_is_true (SCM_CADDR (what
)))
304 mod
= scm_module_public_interface (mod
);
305 if (SCM_FALSEP (mod
))
307 finish_args
= scm_list_1 (mod
);
308 goto vm_error_no_such_module
;
311 what
= scm_module_lookup (mod
, SCM_CADR (what
));
314 if (!VARIABLE_BOUNDP (what
))
316 finish_args
= scm_list_1 (what
);
317 goto vm_error_unbound
;
320 OBJECT_SET (objnum
, what
);
323 PUSH (VARIABLE_REF (what
));
329 VM_DEFINE_INSTRUCTION (26, local_set
, "local-set", 1, 1, 0)
331 LOCAL_SET (FETCH (), *sp
);
336 VM_DEFINE_INSTRUCTION (27, external_set
, "external-set", 1, 1, 0)
340 for (i
= FETCH (); i
; i
--)
351 VM_DEFINE_INSTRUCTION (28, variable_set
, "variable-set", 0, 1, 0)
353 VARIABLE_SET (sp
[0], sp
[-1]);
358 VM_DEFINE_INSTRUCTION (29, toplevel_set
, "toplevel-set", 1, 1, 0)
360 unsigned objnum
= FETCH ();
362 CHECK_OBJECT (objnum
);
363 what
= OBJECT_REF (objnum
);
365 if (!SCM_VARIABLEP (what
))
368 if (SCM_LIKELY (SCM_SYMBOLP (what
)))
371 if (SCM_LIKELY (scm_module_system_booted_p
372 && scm_is_true ((mod
= scm_program_module (program
)))))
374 what
= scm_module_lookup (mod
, what
);
377 SCM v
= scm_sym2var (what
, SCM_BOOL_F
, SCM_BOOL_F
);
378 if (scm_is_false (v
))
379 SCM_MISC_ERROR ("unbound variable: ~S", scm_list_1 (what
));
387 /* compilation of @ or @@
388 `what' is a three-element list: (MODNAME SYM INTERFACE?)
389 INTERFACE? is #t if we compiled @ or #f if we compiled @@
391 mod
= scm_resolve_module (SCM_CAR (what
));
392 if (scm_is_true (SCM_CADDR (what
)))
393 mod
= scm_module_public_interface (mod
);
394 if (SCM_FALSEP (mod
))
396 finish_args
= scm_list_1 (what
);
397 goto vm_error_no_such_module
;
400 what
= scm_module_lookup (mod
, SCM_CADR (what
));
403 OBJECT_SET (objnum
, what
);
406 VARIABLE_SET (what
, *sp
);
411 VM_DEFINE_INSTRUCTION (30, externals
, "externals", 0, 0, 1)
422 /* offset must be a signed short!!! */
423 #define FETCH_OFFSET(offset) \
427 offset = (h << 8) + l; \
432 signed short offset; \
433 FETCH_OFFSET (offset); \
441 VM_DEFINE_INSTRUCTION (31, br
, "br", 2, 0, 0)
445 ip
+= (signed short) (h
<< 8) + l
;
449 VM_DEFINE_INSTRUCTION (32, br_if
, "br-if", 2, 0, 0)
451 BR (!SCM_FALSEP (*sp
));
454 VM_DEFINE_INSTRUCTION (33, br_if_not
, "br-if-not", 2, 0, 0)
456 BR (SCM_FALSEP (*sp
));
459 VM_DEFINE_INSTRUCTION (34, br_if_eq
, "br-if-eq", 2, 0, 0)
461 sp
--; /* underflow? */
462 BR (SCM_EQ_P (sp
[0], sp
[1]));
465 VM_DEFINE_INSTRUCTION (35, br_if_not_eq
, "br-if-not-eq", 2, 0, 0)
467 sp
--; /* underflow? */
468 BR (!SCM_EQ_P (sp
[0], sp
[1]));
471 VM_DEFINE_INSTRUCTION (36, br_if_null
, "br-if-null", 2, 0, 0)
473 BR (SCM_NULLP (*sp
));
476 VM_DEFINE_INSTRUCTION (37, br_if_not_null
, "br-if-not-null", 2, 0, 0)
478 BR (!SCM_NULLP (*sp
));
486 VM_DEFINE_INSTRUCTION (38, make_closure
, "make-closure", 0, 1, 1)
489 SCM_NEWSMOB3 (*sp
, scm_tc16_program
, SCM_PROGRAM_OBJCODE (*sp
),
490 SCM_PROGRAM_OBJTABLE (*sp
), external
);
494 VM_DEFINE_INSTRUCTION (39, call
, "call", 1, -1, 1)
503 SCM_TICK
; /* allow interrupt here */
508 if (SCM_PROGRAM_P (x
))
518 #ifdef ENABLE_TRAMPOLINE
519 /* Seems to slow down the fibo test, dunno why */
527 scm_t_trampoline_0 call
= scm_trampoline_0 (x
);
538 scm_t_trampoline_1 call
= scm_trampoline_1 (x
);
544 *sp
= call (x
, arg1
);
551 scm_t_trampoline_2 call
= scm_trampoline_2 (x
);
558 *sp
= call (x
, arg1
, arg2
);
566 * Other interpreted or compiled call
568 if (!SCM_FALSEP (scm_procedure_p (x
)))
570 /* At this point, the stack contains the procedure and each one of its
574 /* keep args on stack so they are marked */
575 sp
[-1] = scm_apply (x
, sp
[0], SCM_EOL
);
576 NULLSTACK_FOR_NONLOCAL_EXIT ();
578 if (SCM_UNLIKELY (SCM_VALUESP (*sp
)))
580 /* truncate values */
583 values
= scm_struct_ref (values
, SCM_INUM0
);
584 if (scm_is_null (values
))
585 goto vm_error_not_enough_values
;
586 PUSH (SCM_CAR (values
));
593 if (SCM_VM_CONT_P (x
))
596 vm_call_continuation
:
597 /* Check the number of arguments */
598 /* FIXME multiple args */
600 scm_wrong_num_args (program
);
602 /* Reinstate the continuation */
604 reinstate_vm_cont (vp
, program
);
606 program
= SCM_FRAME_PROGRAM (fp
);
612 goto vm_error_wrong_type_apply
;
615 VM_DEFINE_INSTRUCTION (40, goto_args
, "goto/args", 1, -1, 1)
623 SCM_TICK
; /* allow interrupt here */
626 * Tail recursive call
628 if (SCM_EQ_P (x
, program
))
635 for (i
= 0; i
< bp
->nargs
; i
++)
636 LOCAL_SET (i
, sp
[i
]);
638 /* Drop the first argument and the program itself. */
640 NULLSTACK (bp
->nargs
+ 1);
642 /* Freshen the externals */
643 external
= SCM_PROGRAM_EXTERNALS (x
);
644 for (i
= 0; i
< bp
->nexts
; i
++)
645 CONS (external
, SCM_UNDEFINED
, external
);
646 SCM_FRAME_DATA_ADDRESS (fp
)[0] = external
;
648 /* Init locals to valid SCM values */
649 for (i
= 0; i
< bp
->nlocs
; i
++)
650 LOCAL_SET (i
+ bp
->nargs
, SCM_UNDEFINED
);
659 * Tail call, but not to self -- reuse the frame, keeping the ra and dl
661 if (SCM_PROGRAM_P (x
))
663 SCM
*data
, *tail_args
, *dl
;
665 scm_byte_t
*ra
, *mvra
;
666 #ifdef VM_ENABLE_STACK_NULLING
673 tail_args
= stack_base
+ 2;
674 ra
= SCM_FRAME_RETURN_ADDRESS (fp
);
675 mvra
= SCM_FRAME_MV_RETURN_ADDRESS (fp
);
676 dl
= SCM_FRAME_DYNAMIC_LINK (fp
);
678 /* switch programs */
682 /* delay updating the frame so that if INIT_ARGS has to cons up a rest
683 arg, going into GC, the stack still makes sense */
687 #ifdef VM_ENABLE_STACK_NULLING
692 /* new registers -- logically this would be better later, but let's make
693 sure we have space for the locals now */
694 data
= SCM_FRAME_DATA_ADDRESS (fp
);
696 stack_base
= data
+ 3;
700 /* copy args, bottom-up */
701 for (i
= 0; i
< nargs
; i
++)
702 fp
[i
] = tail_args
[i
];
704 NULLSTACK (old_sp
- sp
);
707 for (i
= bp
->nlocs
; i
; i
--)
708 data
[-i
] = SCM_UNDEFINED
;
715 /* Postpone initializing external vars, because if the CONS causes a GC,
716 we want the stack marker to see the data array formatted as expected. */
717 data
[0] = SCM_UNDEFINED
;
718 external
= SCM_PROGRAM_EXTERNALS (fp
[-1]);
719 for (i
= 0; i
< bp
->nexts
; i
++)
720 CONS (external
, SCM_UNDEFINED
, external
);
727 #ifdef ENABLE_TRAMPOLINE
728 /* This seems to actually slow down the fibo test -- dunno why */
736 scm_t_trampoline_0 call
= scm_trampoline_0 (x
);
747 scm_t_trampoline_1 call
= scm_trampoline_1 (x
);
753 *sp
= call (x
, arg1
);
760 scm_t_trampoline_2 call
= scm_trampoline_2 (x
);
767 *sp
= call (x
, arg1
, arg2
);
776 * Other interpreted or compiled call
778 if (!SCM_FALSEP (scm_procedure_p (x
)))
782 sp
[-1] = scm_apply (x
, sp
[0], SCM_EOL
);
783 NULLSTACK_FOR_NONLOCAL_EXIT ();
785 if (SCM_UNLIKELY (SCM_VALUESP (*sp
)))
787 /* multiple values returned to continuation */
790 values
= scm_struct_ref (values
, SCM_INUM0
);
791 nvalues
= scm_ilength (values
);
792 PUSH_LIST (values
, SCM_NULLP
);
793 goto vm_return_values
;
803 if (SCM_VM_CONT_P (program
))
804 goto vm_call_continuation
;
806 goto vm_error_wrong_type_apply
;
809 VM_DEFINE_INSTRUCTION (41, goto_nargs
, "goto/nargs", 0, 0, 1)
813 nargs
= scm_to_int (x
);
814 /* FIXME: should truncate values? */
818 VM_DEFINE_INSTRUCTION (42, call_nargs
, "call/nargs", 0, 0, 1)
822 nargs
= scm_to_int (x
);
823 /* FIXME: should truncate values? */
827 VM_DEFINE_INSTRUCTION (43, mv_call
, "mv-call", 3, -1, 1)
833 FETCH_OFFSET (offset
);
840 if (SCM_PROGRAM_P (x
))
846 SCM_FRAME_DATA_ADDRESS (fp
)[2] = (SCM
)(SCM_FRAME_RETURN_ADDRESS (fp
) + offset
);
852 * Other interpreted or compiled call
854 if (!SCM_FALSEP (scm_procedure_p (x
)))
856 /* At this point, the stack contains the procedure and each one of its
860 sp
[-1] = scm_apply (x
, sp
[0], SCM_EOL
);
861 NULLSTACK_FOR_NONLOCAL_EXIT ();
863 if (SCM_VALUESP (*sp
))
867 values
= scm_struct_ref (values
, SCM_INUM0
);
868 len
= scm_length (values
);
869 PUSH_LIST (values
, SCM_NULLP
);
878 if (SCM_VM_CONT_P (x
))
881 goto vm_call_continuation
;
885 goto vm_error_wrong_type_apply
;
888 VM_DEFINE_INSTRUCTION (44, apply
, "apply", 1, -1, 1)
897 len
= scm_ilength (ls
);
899 goto vm_error_wrong_type_arg
;
901 PUSH_LIST (ls
, SCM_NULL_OR_NIL_P
);
907 VM_DEFINE_INSTRUCTION (45, goto_apply
, "goto/apply", 1, -1, 1)
916 len
= scm_ilength (ls
);
918 goto vm_error_wrong_type_arg
;
920 PUSH_LIST (ls
, SCM_NULL_OR_NIL_P
);
926 VM_DEFINE_INSTRUCTION (46, call_cc
, "call/cc", 0, 1, 1)
932 cont
= scm_make_continuation (&first
);
940 ASSERT (sp
== vp
->sp
);
941 ASSERT (fp
== vp
->fp
);
942 else if (SCM_VALUESP (cont
))
944 /* multiple values returned to continuation */
946 values
= scm_struct_ref (cont
, SCM_INUM0
);
947 if (SCM_NULLP (values
))
948 goto vm_error_no_values
;
949 /* non-tail context does not accept multiple values? */
950 PUSH (SCM_CAR (values
));
960 VM_DEFINE_INSTRUCTION (47, goto_cc
, "goto/cc", 0, 1, 1)
966 cont
= scm_make_continuation (&first
);
967 ASSERT (sp
== vp
->sp
);
968 ASSERT (fp
== vp
->fp
);
976 else if (SCM_VALUESP (cont
))
978 /* multiple values returned to continuation */
980 values
= scm_struct_ref (cont
, SCM_INUM0
);
981 nvalues
= scm_ilength (values
);
982 PUSH_LIST (values
, SCM_NULLP
);
983 goto vm_return_values
;
992 VM_DEFINE_INSTRUCTION (48, return, "return", 0, 1, 1)
998 SCM_TICK
; /* allow interrupt here */
1001 data
= SCM_FRAME_DATA_ADDRESS (fp
);
1004 ASSERT (sp
== stack_base
);
1005 ASSERT (stack_base
== data
+ 3);
1007 /* Restore registers */
1008 sp
= SCM_FRAME_LOWER_ADDRESS (fp
);
1009 ip
= SCM_FRAME_BYTE_CAST (data
[3]);
1010 fp
= SCM_FRAME_STACK_CAST (data
[1]);
1012 #ifdef VM_ENABLE_STACK_NULLING
1013 int nullcount
= stack_base
- sp
;
1015 stack_base
= SCM_FRAME_UPPER_ADDRESS (fp
) - 1;
1016 NULLSTACK (nullcount
);
1019 /* Set return value (sp is already pushed) */
1023 /* Restore the last program */
1024 program
= SCM_FRAME_PROGRAM (fp
);
1031 VM_DEFINE_INSTRUCTION (49, return_values
, "return/values", 1, -1, -1)
1033 /* nvalues declared at top level, because for some reason gcc seems to think
1034 that perhaps it might be used without declaration. Fooey to that, I say. */
1042 data
= SCM_FRAME_DATA_ADDRESS (fp
);
1043 ASSERT (stack_base
== data
+ 3);
1045 /* data[2] is the mv return address */
1046 if (nvalues
!= 1 && data
[2])
1049 /* Restore registers */
1050 sp
= SCM_FRAME_LOWER_ADDRESS (fp
) - 1;
1051 ip
= SCM_FRAME_BYTE_CAST (data
[2]); /* multiple value ra */
1052 fp
= SCM_FRAME_STACK_CAST (data
[1]);
1054 /* Push return values, and the number of values */
1055 for (i
= 0; i
< nvalues
; i
++)
1056 *++sp
= stack_base
[1+i
];
1057 *++sp
= SCM_I_MAKINUM (nvalues
);
1059 /* Finally set new stack_base */
1060 NULLSTACK (stack_base
- sp
+ nvalues
+ 1);
1061 stack_base
= SCM_FRAME_UPPER_ADDRESS (fp
) - 1;
1063 else if (nvalues
>= 1)
1065 /* Multiple values for a single-valued continuation -- here's where I
1066 break with guile tradition and try and do something sensible. (Also,
1067 this block handles the single-valued return to an mv
1069 /* Restore registers */
1070 sp
= SCM_FRAME_LOWER_ADDRESS (fp
) - 1;
1071 ip
= SCM_FRAME_BYTE_CAST (data
[3]); /* single value ra */
1072 fp
= SCM_FRAME_STACK_CAST (data
[1]);
1074 /* Push first value */
1075 *++sp
= stack_base
[1];
1077 /* Finally set new stack_base */
1078 NULLSTACK (stack_base
- sp
+ nvalues
+ 1);
1079 stack_base
= SCM_FRAME_UPPER_ADDRESS (fp
) - 1;
1082 goto vm_error_no_values
;
1084 /* Restore the last program */
1085 program
= SCM_FRAME_PROGRAM (fp
);
1092 VM_DEFINE_INSTRUCTION (50, return_values_star
, "return/values*", 1, -1, -1)
1097 ASSERT (nvalues
>= 1);
1101 while (SCM_CONSP (l
))
1107 if (SCM_UNLIKELY (!SCM_NULL_OR_NIL_P (l
))) {
1108 finish_args
= scm_list_1 (l
);
1109 goto vm_error_improper_list
;
1112 goto vm_return_values
;
1115 VM_DEFINE_INSTRUCTION (51, truncate_values
, "truncate-values", 2, -1, -1)
1120 nvalues
= scm_to_int (x
);
1127 if (nvalues
< nbinds
)
1128 goto vm_error_not_enough_values
;
1131 POP_LIST (nvalues
- nbinds
);
1133 DROPN (nvalues
- nbinds
);
1139 (defun renumber-ops ()
1140 "start from top of buffer and renumber 'VM_DEFINE_FOO (\n' sequences"
1143 (let ((counter -1)) (goto-char (point-min))
1144 (while (re-search-forward "^VM_DEFINE_[^ ]+ (\\([^,]+\\)," (point-max) t)
1146 (number-to-string (setq counter (1+ counter)))