version 1.27, 2005/01/24 22:18:34
|
version 1.34, 2008/11/01 22:19:30
|
Line 10 This manual is for Vmgen
|
Line 10 This manual is for Vmgen
|
(version @value{VERSION}, @value{UPDATED}), |
(version @value{VERSION}, @value{UPDATED}), |
the virtual machine interpreter generator |
the virtual machine interpreter generator |
|
|
Copyright @copyright{} 2002,2003,2005 Free Software Foundation, Inc. |
Copyright @copyright{} 2002,2003,2005,2007,2008 Free Software Foundation, Inc. |
|
|
@quotation |
@quotation |
Permission is granted to copy, distribute and/or modify this document |
Permission is granted to copy, distribute and/or modify this document |
under the terms of the GNU Free Documentation License, Version 1.1 or |
under the terms of the GNU Free Documentation License, Version 1.2 or |
any later version published by the Free Software Foundation; with no |
any later version published by the Free Software Foundation; with no |
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' |
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' |
and with the Back-Cover Texts as in (a) below. A copy of the |
and with the Back-Cover Texts as in (a) below. A copy of the |
Line 94 Input File Grammar
|
Line 94 Input File Grammar
|
|
|
Simple instructions |
Simple instructions |
|
|
|
* Explicit stack access:: If the C code accesses a stack pointer |
* C Code Macros:: Macros recognized by Vmgen |
* C Code Macros:: Macros recognized by Vmgen |
* C Code restrictions:: Vmgen makes assumptions about C code |
* C Code restrictions:: Vmgen makes assumptions about C code |
* Stack growth direction:: is configurable per stack |
* Stack growth direction:: is configurable per stack |
Line 330 instructions. Another option is to use
|
Line 331 instructions. Another option is to use
|
for the virtual machine; we believe that using a stack architecture is |
for the virtual machine; we believe that using a stack architecture is |
usually both simpler and faster. |
usually both simpler and faster. |
|
|
however, this option is slower or |
However, this option is slower or |
significantly more complex to implement than a stack machine architecture. |
significantly more complex to implement than a stack machine architecture. |
|
|
Vmgen has special support and optimizations for stack VMs, making their |
Vmgen has special support and optimizations for stack VMs, making their |
Line 829 name. Stack prefixes are defined like t
|
Line 830 name. Stack prefixes are defined like t
|
|
|
@example |
@example |
\E inst-stream stack-prefix # |
\E inst-stream stack-prefix # |
|
\E data-stack stack-prefix S: |
@end example |
@end example |
|
|
This definition defines that the stack prefix @code{#} specifies the |
This definition defines that the stack prefix @code{#} specifies the |
Line 845 If there are multiple instruction stream
|
Line 847 If there are multiple instruction stream
|
first one (just as the intuition suggests). |
first one (just as the intuition suggests). |
|
|
@menu |
@menu |
|
* Explicit stack access:: If the C code accesses a stack pointer |
* C Code Macros:: Macros recognized by Vmgen |
* C Code Macros:: Macros recognized by Vmgen |
* C Code restrictions:: Vmgen makes assumptions about C code |
* C Code restrictions:: Vmgen makes assumptions about C code |
* Stack growth direction:: is configurable per stack |
* Stack growth direction:: is configurable per stack |
@end menu |
@end menu |
|
|
@c -------------------------------------------------------------------- |
@c -------------------------------------------------------------------- |
@node C Code Macros, C Code restrictions, Simple instructions, Simple instructions |
@node Explicit stack access, C Code Macros, Simple instructions, Simple instructions |
|
@subsection Explicit stack access |
|
@cindex stack access, explicit |
|
@cindex Stack pointer access |
|
@cindex explicit stack access |
|
|
|
This feature is not needed and not supported in the 0.6.2 version of |
|
vmgen that is documented here (and that is invoked by default). |
|
|
|
Not all stack effects can be specified using the stack effect |
|
specifications above. For VM instructions that have other stack |
|
effects, you can specify them explicitly by accessing the stack |
|
pointer in the C code; however, you have to notify Vmgen of such |
|
explicit stack accesses, otherwise Vmgens optimizations could conflict |
|
with your explicit stack accesses. |
|
|
|
You notify Vmgen by putting @code{...} with the appropriate stack |
|
prefix into the stack comment. Then the VM instruction will first |
|
take the other stack items specified in the stack effect into C |
|
variables, then make sure that all other stack items for that stack |
|
are in memory, and that the stack pointer for the stack points to the |
|
top-of-stack (by default, unless you change the stack access |
|
transformation: @pxref{Stack growth direction}). |
|
|
|
The general rule is: If you mention a stack pointer in the C code of a |
|
VM instruction, you should put a @code{...} for that stack in the stack |
|
effect. |
|
|
|
Consider this example: |
|
|
|
@example |
|
return ( #iadjust S:... target afp i1 -- i2 ) |
|
SET_IP(target); |
|
sp = (Cell *)(((char *)sp)+iadjust); |
|
fp = afp; |
|
i2=i1; |
|
@end example |
|
|
|
First the variables @code{target afp i1} are popped off the stack, |
|
then the stack pointer @code{sp} is set correctly for the new stack |
|
depth, then the C code changes the stack depth and does other things, |
|
and finally @code{i2} is pushed on the stack with the new depth. |
|
|
|
The position of the @code{...} within the stack effect does not |
|
matter. You can use several @code{...}s, for different stacks, and |
|
also several for the same stack (that has no additional effect). If |
|
you use @code{...} without a stack prefix, this specifies all the |
|
stacks except the instruction stream. |
|
|
|
You cannot use @code{...} for the instruction stream, but that is not |
|
necessary: At the start of the C code, @code{IP} points to the start |
|
of the next VM instruction (i.e., right beyond the end of the current |
|
VM instruction), and you can change the instruction pointer with |
|
@code{SET_IP} (@pxref{VM engine}). |
|
|
|
|
|
@c -------------------------------------------------------------------- |
|
@node C Code Macros, C Code restrictions, Explicit stack access, Simple instructions |
@subsection C Code Macros |
@subsection C Code Macros |
@cindex macros recognized by Vmgen |
@cindex macros recognized by Vmgen |
@cindex basic block, VM level |
@cindex basic block, VM level |
Line 906 if (branch_condition) @{
|
Line 966 if (branch_condition) @{
|
SUPER_CONTINUE; |
SUPER_CONTINUE; |
@end example |
@end example |
|
|
@item VM_JUMP |
@c !! uncomment for post-0.6.2 docs |
@findex VM_JUMP |
@c @item VM_JUMP |
@code{VM_JUMP(target)} is equivalent to @code{goto *(target)}, but |
@c @findex VM_JUMP |
allows Vmgen to do dynamic superinstructions and replication. You |
@c @code{VM_JUMP(target)} is equivalent to @code{goto *(target)}, but |
still need to say @code{SUPER_END}. |
@c allows Vmgen to do dynamic superinstructions and replication. You |
|
@c still need to say @code{SUPER_END}. Also, the goto only happens at |
|
@c the end (wherever the VM_JUMP is). Essentially, this just suppresses |
|
@c much of the ordinary dispatch mechanism. |
|
|
@end table |
@end table |
|
|
Line 1082 optimizer for both variations, so leave
|
Line 1145 optimizer for both variations, so leave
|
@cindex stack stores, optimization |
@cindex stack stores, optimization |
@cindex eliminating stack stores |
@cindex eliminating stack stores |
|
|
This minor optimization (0.6\%--0.8\% reduction in executed instructions |
This minor optimization (0.6%--0.8% reduction in executed instructions |
for Gforth) puts additional requirements on the instruction descriptions |
for Gforth) puts additional requirements on the instruction descriptions |
and is therefore disabled by default. |
and is therefore disabled by default. |
|
|
Line 1937 You can find vmgen information at
|
Line 2000 You can find vmgen information at
|
* GNU Free Documentation License:: License for copying this manual. |
* GNU Free Documentation License:: License for copying this manual. |
@end menu |
@end menu |
|
|
|
@node GNU Free Documentation License, , Copying This Manual, Copying This Manual |
|
@appendixsec GNU Free Documentation License |
@include fdl.texi |
@include fdl.texi |
|
|
|
|