org.jruby.ir.instructions

Class Instr

java.lang.Object

org.jruby.ir.instructions.Instr

Direct Known Subclasses:

AliasInstr, BlockGivenInstr, BranchInstr, BreakInstr, BuildLambdaInstr, CallBase, CheckArgsArrayArityInstr, CheckArityInstr, CopyInstr, DefineClassInstr, DefineClassMethodInstr, DefinedInstr, DefineInstanceMethodInstr, DefineMetaClassInstr, DefineModuleInstr, EnsureRubyArrayInstr, EQQInstr, ExceptionRegionEndMarkerInstr, ExceptionRegionStartMarkerInstr, GetBackrefInstr, GetClassVarContainerModuleInstr, GetEncodingInstr, GetErrorInfoInstr, GetInstr, GVarAliasInstr, InheritanceSearchConstInstr, JumpIndirectInstr, JumpInstr, LabelInstr, LexicalSearchConstInstr, LineNumberInstr, LoadLocalVarInstr, Match2Instr, Match3Instr, MatchInstr, MethodLookupInstr, ModuleVersionGuardInstr, MultipleAsgnBase, NopInstr, NotInstr, PopBindingInstr, PopFrameInstr, ProcessModuleBodyInstr, PushBindingInstr, PushFrameInstr, PutInstr, RaiseArgumentErrorInstr, ReceiveArgBase, ReceiveClosureInstr, ReceiveExceptionInstr, ReceiveSelfInstr, RecordEndBlockInstr, RescueEQQInstr, RestoreErrorInfoInstr, ReturnBase, RuntimeHelperCall, SearchConstInstr, SetReturnAddressInstr, StoreLocalVarInstr, ThreadPollInstr, ThrowExceptionInstr, ToAryInstr, UndefMethodInstr, YieldInstr

public abstract class Instr
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Operand[]	EMPTY_OPERANDS
private boolean	hasUnusedResult
private boolean	isDead
private Operation	operation

Constructor Summary

Constructors

Constructor and Description
Instr(Operation operation)

Method Summary

Modifier and Type	Method and Description
boolean	canBeDeleted(IRScope s)
boolean	canRaiseException()
Instr	cloneForBlockCloning(InlinerInfo ii) Clone the instruction so it can be used in a cloned block which is present in a scope that itself or an ancestor scope (in the case of nested blocks) is being inlined.
Instr	cloneForInlinedClosure(InlinerInfo ii) Clone the instruction (present in a closure) so it can be inlined into another scope.
Instr	cloneForInlinedScope(InlinerInfo ii) Clone the instruction (present in a method/closure) so it can be inlined into another scope.
Instr	cloneForInlining(InlinerInfo inlinerInfo) Clone the instruction for use in an inlining context (either when a scope is inlined into another scope, or when a block has to be cloned because its associated call belongs to an inlined scope).
abstract Operand[]	getOperands()
Operation	getOperation()
java.util.List<Variable>	getUsedVariables()
boolean	hasSideEffects()
boolean	hasUnusedResult()
java.lang.Object	interpret(ThreadContext context, DynamicScope currDynScope, IRubyObject self, java.lang.Object[] temp, Block block)
int	interpretAndGetNewIPC(ThreadContext context, DynamicScope currDynScope, IRubyObject self, java.lang.Object[] temp, int ipc)
boolean	isDead()
void	markDead()
void	markUnusedResult()
void	renameVars(java.util.Map<Operand,Operand> renameMap)
Operand	simplifyAndGetResult(IRScope scope, java.util.Map<Operand,Operand> valueMap) This method takes as input a map of operands to their values, and outputs the result of this instruction.
void	simplifyOperands(java.util.Map<Operand,Operand> valueMap, boolean force) This method takes as input a map of operands to their values, and outputs If the value map provides a value for any of the instruction's operands this method is expected to replace the original operands with the simplified values.
java.lang.String	toString()
boolean	transfersControl()
void	visit(IRVisitor visitor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_OPERANDS

public static final Operand[] EMPTY_OPERANDS

operation

private final Operation operation

isDead

private boolean isDead

hasUnusedResult

private boolean hasUnusedResult

Constructor Detail

Instr

public Instr(Operation operation)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOperation

public Operation getOperation()

hasSideEffects

public boolean hasSideEffects()

canRaiseException

public boolean canRaiseException()

transfersControl

public boolean transfersControl()

canBeDeleted

public boolean canBeDeleted(IRScope s)

markDead

public void markDead()

isDead

public boolean isDead()

markUnusedResult

public void markUnusedResult()

hasUnusedResult

public boolean hasUnusedResult()

getOperands

public abstract Operand[] getOperands()

getUsedVariables

public java.util.List<Variable> getUsedVariables()

renameVars

public void renameVars(java.util.Map<Operand,Operand> renameMap)

cloneForInlining

public Instr cloneForInlining(InlinerInfo inlinerInfo)

Clone the instruction for use in an inlining context (either when a scope is inlined into another scope, or when a block has to be cloned because its associated call belongs to an inlined scope). This requires renaming variables and labels to eliminate naming conflicts.

Parameters:

inlinerInfo - This object manages renaming of variables and labels, handles args and return values.

Returns:

a new instruction that can be used in the target scope.

cloneForInlinedScope

public Instr cloneForInlinedScope(InlinerInfo ii)

Clone the instruction (present in a method/closure) so it can be inlined into another scope. This requires renaming variables and labels to eliminate naming conflicts.

Parameters:

inlinerInfo - This object manages renaming of variables and labels, handles args and return values.

Returns:

a new instruction that can be used in the target scope.

cloneForInlinedClosure

public Instr cloneForInlinedClosure(InlinerInfo ii)

Clone the instruction (present in a closure) so it can be inlined into another scope. This requires renaming variables and labels to eliminate naming conflicts.

Parameters:

inlinerInfo - This object manages renaming of variables and labels, handles args and return values.

Returns:

a new instruction that can be used in the target scope.

cloneForBlockCloning

public Instr cloneForBlockCloning(InlinerInfo ii)

Clone the instruction so it can be used in a cloned block which is present in a scope that itself or an ancestor scope (in the case of nested blocks) is being inlined. This requires renaming variables to eliminate naming conflicts. Labels need not be renamed.

Parameters:

inlinerInfo - This object manages renaming of variables and labels, handling scope args and return values.

Returns:

a new instruction that can be used in the target scope.

simplifyOperands

public void simplifyOperands(java.util.Map<Operand,Operand> valueMap,
                             boolean force)

This method takes as input a map of operands to their values, and outputs If the value map provides a value for any of the instruction's operands this method is expected to replace the original operands with the simplified values. It is not required that it do so -- code correctness is not compromised by failure to simplify

simplifyAndGetResult

public Operand simplifyAndGetResult(IRScope scope,
                                    java.util.Map<Operand,Operand> valueMap)

This method takes as input a map of operands to their values, and outputs the result of this instruction. If the value map provides a value for any of the instruction's operands the expectation is that the operand will be replaced with the simplified value. It is not required that it do so -- code correctness is not compromised by failure to simplify.

Parameters:

valueMap - Mapping from operands to their simplified values

interpret

public java.lang.Object interpret(ThreadContext context,
                                  DynamicScope currDynScope,
                                  IRubyObject self,
                                  java.lang.Object[] temp,
                                  Block block)

interpretAndGetNewIPC

public int interpretAndGetNewIPC(ThreadContext context,
                                 DynamicScope currDynScope,
                                 IRubyObject self,
                                 java.lang.Object[] temp,
                                 int ipc)

visit

public void visit(IRVisitor visitor)