107 lines
3.9 KiB
Factor
107 lines
3.9 KiB
Factor
USING: compiler.cfg help.markup help.syntax kernel layouts slots.private ;
|
|
IN: compiler.cfg.instructions
|
|
|
|
HELP: insn
|
|
{ $class-description
|
|
"Base class for all virtual cpu instructions, used by the CFG IR."
|
|
} ;
|
|
|
|
HELP: vreg-insn
|
|
{ $class-description
|
|
"Base class for instructions that uses vregs."
|
|
} ;
|
|
|
|
HELP: flushable-insn
|
|
{ $class-description
|
|
"Instructions which do not have side effects; used for dead code elimination." } ;
|
|
|
|
HELP: foldable-insn
|
|
{ $class-description
|
|
"Instructions which are referentially transparent; used for value numbering." } ;
|
|
|
|
HELP: ##inc-d
|
|
{ $class-description
|
|
"An instruction that increases or decreases the data stacks size by n. For example, " { $link 2drop } " decreases it by two and pushing an item increases it by one."
|
|
} ;
|
|
|
|
HELP: ##prologue
|
|
{ $class-description
|
|
"An instruction for generating the prologue for a cfg." } ;
|
|
|
|
HELP: ##alien-invoke
|
|
{ $class-description
|
|
"An instruction for calling a function in a dynamically linked library. It has the following slots:"
|
|
{ $table
|
|
{ { $slot "reg-inputs" } { "Registers to use for the arguments to the function call." } }
|
|
{ { $slot "stack-inputs" } { "Stack slots used for the arguments to the function call. Only used if all register arguments are already filled." } }
|
|
{ { $slot "reg-outputs" } { "Register that wil contain the return value of the function call if any." } }
|
|
{ { $slot "symbols" } { "Name of the function to call." } }
|
|
{ { $slot "dll" } { "A dll handle." } }
|
|
}
|
|
} ;
|
|
|
|
HELP: ##set-slot
|
|
{ $class-description
|
|
"An instruction for the non-primitive, non-immediate variant of " { $link set-slot } ". It has the following slots:"
|
|
{ $table
|
|
{ { $slot "src" } { "Object to put in the slot." } }
|
|
{ { $slot "obj" } { "Object to set the slot on." } }
|
|
{ { $slot "slot" } { "Slot index." } }
|
|
{ { $slot "tag" } { "Type tag for obj." } }
|
|
}
|
|
}
|
|
{ $see-also ##set-slot-imm } ;
|
|
|
|
HELP: ##replace-imm
|
|
{ $class-description
|
|
"An instruction that replaces an item on the data or register stack with an " { $link immediate } " value." } ;
|
|
|
|
HELP: ##replace
|
|
{ $class-description
|
|
"Copies a value from a machine register to a stack location." }
|
|
{ $see-also ##peek ##replace-imm } ;
|
|
|
|
|
|
HELP: ##jump
|
|
{ $class-description
|
|
"An uncondiation jump instruction. It has the following slots:"
|
|
{ $table
|
|
{ { $slot "word" } { "Word whose address the instruction is jumping to." } }
|
|
}
|
|
"Note that the optimizer is sometimes able to optimize away a " { $link ##call } " and " { $link ##return } " pair into one ##jump instruction."
|
|
} ;
|
|
|
|
HELP: ##peek
|
|
{ $class-description
|
|
"Copies a value from a stack location to a machine register."
|
|
}
|
|
{ $see-also ##replace } ;
|
|
|
|
HELP: ##safepoint
|
|
{ $class-description "Instruction that inserts a safe point in the generated code." } ;
|
|
|
|
HELP: ##check-nursery-branch
|
|
{ $class-description
|
|
"Instruction that inserts a conditional branch to a " { $link basic-block } " that garbage collects the nursery. The " { $vocab-link "compiler.cfg.gc-checks" } " vocab goes through each block in the " { $link cfg } " and checks if it allocates memory. If it does, then this instruction is inserted in the cfg before that block and checks if there is enough available space in the nursery. If it isn't, then a basic block containing code for garbage collecting the nursery is executed."
|
|
$nl
|
|
"It has the following slots:"
|
|
{ $table
|
|
{ { $slot "size" } { "Number of bytes the next block in the cfg will allocate." } }
|
|
{ { $slot "cc" } { "A comparison symbol." } }
|
|
{ { $slot "temp1" } { "Register symbol." } }
|
|
{ { $slot "temp2" } { "Register symbol." } }
|
|
}
|
|
} ;
|
|
|
|
HELP: ##return
|
|
{ $class-description "Instruction that returns from a procedure call." } ;
|
|
|
|
HELP: ##no-tco
|
|
{ $class-description "A dummy instruction that simply inhibits TCO." } ;
|
|
|
|
HELP: ##copy
|
|
{ $class-description "Instruction that copies a value from one register to another." } ;
|
|
|
|
HELP: ##compare-integer
|
|
{ $class-description "This instruction is emitted for integer comparisons." } ;
|