org.jikesrvm.compilers.opt.ir

Class IfCmp

java.lang.Object

org.jikesrvm.compilers.opt.ir.InstructionFormat

org.jikesrvm.compilers.opt.ir.IfCmp

public final class IfCmp
extends InstructionFormat

The IfCmp InstructionFormat class. The header comment for Instruction contains an explanation of the role of InstructionFormats in the opt compiler's IR.

Field Summary

Fields inherited from class org.jikesrvm.compilers.opt.ir.InstructionFormat

ALoad_format, ALoad_traits, ARCH_INDEPENDENT_INSTR_FORMAT_END_format, AStore_format, AStore_traits, Athrow_format, Athrow_traits, Attempt_format, Attempt_traits, BBend_format, BBend_traits, Binary_format, Binary_traits, BooleanCmp_format, BooleanCmp_traits, BoundsCheck_format, BoundsCheck_traits, CacheOp_format, CacheOp_traits, Call_format, Call_traits, CondMove_format, CondMove_traits, Empty_format, Empty_traits, GetField_format, GetField_traits, GetStatic_format, GetStatic_traits, Goto_format, Goto_traits, GuardedBinary_format, GuardedBinary_traits, GuardedSet_format, GuardedSet_traits, GuardedUnary_format, GuardedUnary_traits, IfCmp_format, IfCmp_traits, IfCmp2_format, IfCmp2_traits, InlineGuard_format, InlineGuard_traits, InstanceOf_format, InstanceOf_traits, InstrumentedCounter_format, InstrumentedCounter_traits, Label_format, Label_traits, Load_format, Load_traits, LookupSwitch_format, LookupSwitch_traits, LowTableSwitch_format, LowTableSwitch_traits, MIN_OPERAND_ARRAY_LENGTH, MonitorOp_format, MonitorOp_traits, Move_format, Move_traits, Multianewarray_format, Multianewarray_traits, New_format, New_traits, NewArray_format, NewArray_traits, Nullary_format, Nullary_traits, NullCheck_format, NullCheck_traits, OsrBarrier_format, OsrBarrier_traits, OsrPoint_format, OsrPoint_traits, Phi_format, Phi_traits, Prepare_format, Prepare_traits, Prologue_format, Prologue_traits, PutField_format, PutField_traits, PutStatic_format, PutStatic_traits, Return_format, Return_traits, Store_format, Store_traits, StoreCheck_format, StoreCheck_traits, TableSwitch_format, TableSwitch_traits, Trap_format, Trap_traits, TrapIf_format, TrapIf_traits, TypeCheck_format, TypeCheck_traits, Unary_format, Unary_traits, Unassigned_format, ZeroCheck_format, ZeroCheck_traits

Constructor Summary

Constructors

Constructor and Description
IfCmp()

Method Summary

Modifier and Type	Method and Description
static boolean	conforms(Instruction i) InstructionFormat identification method for IfCmp.
static boolean	conforms(Operator o) InstructionFormat identification method for IfCmp.
static Instruction	create(Operator o, RegisterOperand GuardResult, Operand Val1, Operand Val2, ConditionOperand Cond, BranchOperand Target, BranchProfileOperand BranchProfile) Create an instruction of the IfCmp instruction format.
static BranchProfileOperand	getBranchProfile(Instruction i) Get the operand called BranchProfile from the argument instruction.
static BranchProfileOperand	getClearBranchProfile(Instruction i) Get the operand called BranchProfile from the argument instruction clearing its instruction pointer.
static ConditionOperand	getClearCond(Instruction i) Get the operand called Cond from the argument instruction clearing its instruction pointer.
static RegisterOperand	getClearGuardResult(Instruction i) Get the operand called GuardResult from the argument instruction clearing its instruction pointer.
static BranchOperand	getClearTarget(Instruction i) Get the operand called Target from the argument instruction clearing its instruction pointer.
static Operand	getClearVal1(Instruction i) Get the operand called Val1 from the argument instruction clearing its instruction pointer.
static Operand	getClearVal2(Instruction i) Get the operand called Val2 from the argument instruction clearing its instruction pointer.
static ConditionOperand	getCond(Instruction i) Get the operand called Cond from the argument instruction.
static RegisterOperand	getGuardResult(Instruction i) Get the operand called GuardResult from the argument instruction.
static BranchOperand	getTarget(Instruction i) Get the operand called Target from the argument instruction.
static Operand	getVal1(Instruction i) Get the operand called Val1 from the argument instruction.
static Operand	getVal2(Instruction i) Get the operand called Val2 from the argument instruction.
static boolean	hasBranchProfile(Instruction i) Does the argument instruction have a non-null operand named BranchProfile?
static boolean	hasCond(Instruction i) Does the argument instruction have a non-null operand named Cond?
static boolean	hasGuardResult(Instruction i) Does the argument instruction have a non-null operand named GuardResult?
static boolean	hasTarget(Instruction i) Does the argument instruction have a non-null operand named Target?
static boolean	hasVal1(Instruction i) Does the argument instruction have a non-null operand named Val1?
static boolean	hasVal2(Instruction i) Does the argument instruction have a non-null operand named Val2?
static int	indexOfBranchProfile(Instruction i) Return the index of the operand called BranchProfile in the argument instruction.
static int	indexOfCond(Instruction i) Return the index of the operand called Cond in the argument instruction.
static int	indexOfGuardResult(Instruction i) Return the index of the operand called GuardResult in the argument instruction.
static int	indexOfTarget(Instruction i) Return the index of the operand called Target in the argument instruction.
static int	indexOfVal1(Instruction i) Return the index of the operand called Val1 in the argument instruction.
static int	indexOfVal2(Instruction i) Return the index of the operand called Val2 in the argument instruction.
static Instruction	mutate(Instruction i, Operator o, RegisterOperand GuardResult, Operand Val1, Operand Val2, ConditionOperand Cond, BranchOperand Target, BranchProfileOperand BranchProfile) Mutate the argument instruction into an instruction of the IfCmp instruction format having the specified operator and operands.
static void	setBranchProfile(Instruction i, BranchProfileOperand BranchProfile) Set the operand called BranchProfile in the argument instruction to the argument operand.
static void	setCond(Instruction i, ConditionOperand Cond) Set the operand called Cond in the argument instruction to the argument operand.
static void	setGuardResult(Instruction i, RegisterOperand GuardResult) Set the operand called GuardResult in the argument instruction to the argument operand.
static void	setTarget(Instruction i, BranchOperand Target) Set the operand called Target in the argument instruction to the argument operand.
static void	setVal1(Instruction i, Operand Val1) Set the operand called Val1 in the argument instruction to the argument operand.
static void	setVal2(Instruction i, Operand Val2) Set the operand called Val2 in the argument instruction to the argument operand.

Methods inherited from class org.jikesrvm.compilers.opt.ir.InstructionFormat

fail, fail

Methods inherited from class java.lang.Object

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

Constructor Detail

IfCmp

public IfCmp()

Method Detail

conforms

public static boolean conforms(Instruction i)

InstructionFormat identification method for IfCmp.

Parameters:

i - an instruction

Returns:

true if the InstructionFormat of the argument instruction is IfCmp or false if it is not.

conforms

public static boolean conforms(Operator o)

InstructionFormat identification method for IfCmp.

Parameters:

o - an instruction

Returns:

true if the InstructionFormat of the argument operator is IfCmp or false if it is not.

getGuardResult

public static RegisterOperand getGuardResult(Instruction i)

Get the operand called GuardResult from the argument instruction. Note that the returned operand will still point to its containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called GuardResult

getClearGuardResult

public static RegisterOperand getClearGuardResult(Instruction i)

Get the operand called GuardResult from the argument instruction clearing its instruction pointer. The returned operand will not point to any containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called GuardResult

setGuardResult

public static void setGuardResult(Instruction i,
                                  RegisterOperand GuardResult)

Set the operand called GuardResult in the argument instruction to the argument operand. The operand will now point to the argument instruction as its containing instruction.

Parameters:

i - the instruction in which to store the operand

GuardResult - the operand to store

indexOfGuardResult

public static int indexOfGuardResult(Instruction i)

Return the index of the operand called GuardResult in the argument instruction.

Parameters:

i - the instruction to access.

Returns:

the index of the operand called GuardResult in the argument instruction

hasGuardResult

public static boolean hasGuardResult(Instruction i)

Does the argument instruction have a non-null operand named GuardResult?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has an non-null operand named GuardResult or false if it does not.

getVal1

public static Operand getVal1(Instruction i)

Get the operand called Val1 from the argument instruction. Note that the returned operand will still point to its containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Val1

getClearVal1

public static Operand getClearVal1(Instruction i)

Get the operand called Val1 from the argument instruction clearing its instruction pointer. The returned operand will not point to any containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Val1

setVal1

public static void setVal1(Instruction i,
                           Operand Val1)

Set the operand called Val1 in the argument instruction to the argument operand. The operand will now point to the argument instruction as its containing instruction.

Parameters:

i - the instruction in which to store the operand

Val1 - the operand to store

indexOfVal1

public static int indexOfVal1(Instruction i)

Return the index of the operand called Val1 in the argument instruction.

Parameters:

i - the instruction to access.

Returns:

the index of the operand called Val1 in the argument instruction

hasVal1

public static boolean hasVal1(Instruction i)

Does the argument instruction have a non-null operand named Val1?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has an non-null operand named Val1 or false if it does not.

getVal2

public static Operand getVal2(Instruction i)

Get the operand called Val2 from the argument instruction. Note that the returned operand will still point to its containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Val2

getClearVal2

public static Operand getClearVal2(Instruction i)

Get the operand called Val2 from the argument instruction clearing its instruction pointer. The returned operand will not point to any containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Val2

setVal2

public static void setVal2(Instruction i,
                           Operand Val2)

Set the operand called Val2 in the argument instruction to the argument operand. The operand will now point to the argument instruction as its containing instruction.

Parameters:

i - the instruction in which to store the operand

Val2 - the operand to store

indexOfVal2

public static int indexOfVal2(Instruction i)

Return the index of the operand called Val2 in the argument instruction.

Parameters:

i - the instruction to access.

Returns:

the index of the operand called Val2 in the argument instruction

hasVal2

public static boolean hasVal2(Instruction i)

Does the argument instruction have a non-null operand named Val2?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has an non-null operand named Val2 or false if it does not.

getCond

public static ConditionOperand getCond(Instruction i)

Get the operand called Cond from the argument instruction. Note that the returned operand will still point to its containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Cond

getClearCond

public static ConditionOperand getClearCond(Instruction i)

Get the operand called Cond from the argument instruction clearing its instruction pointer. The returned operand will not point to any containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Cond

setCond

public static void setCond(Instruction i,
                           ConditionOperand Cond)

Set the operand called Cond in the argument instruction to the argument operand. The operand will now point to the argument instruction as its containing instruction.

Parameters:

i - the instruction in which to store the operand

Cond - the operand to store

indexOfCond

public static int indexOfCond(Instruction i)

Return the index of the operand called Cond in the argument instruction.

Parameters:

i - the instruction to access.

Returns:

the index of the operand called Cond in the argument instruction

hasCond

public static boolean hasCond(Instruction i)

Does the argument instruction have a non-null operand named Cond?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has an non-null operand named Cond or false if it does not.

getTarget

public static BranchOperand getTarget(Instruction i)

Get the operand called Target from the argument instruction. Note that the returned operand will still point to its containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Target

getClearTarget

public static BranchOperand getClearTarget(Instruction i)

Get the operand called Target from the argument instruction clearing its instruction pointer. The returned operand will not point to any containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called Target

setTarget

public static void setTarget(Instruction i,
                             BranchOperand Target)

Set the operand called Target in the argument instruction to the argument operand. The operand will now point to the argument instruction as its containing instruction.

Parameters:

i - the instruction in which to store the operand

Target - the operand to store

indexOfTarget

public static int indexOfTarget(Instruction i)

Return the index of the operand called Target in the argument instruction.

Parameters:

i - the instruction to access.

Returns:

the index of the operand called Target in the argument instruction

hasTarget

public static boolean hasTarget(Instruction i)

Does the argument instruction have a non-null operand named Target?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has an non-null operand named Target or false if it does not.

getBranchProfile

public static BranchProfileOperand getBranchProfile(Instruction i)

Get the operand called BranchProfile from the argument instruction. Note that the returned operand will still point to its containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called BranchProfile

getClearBranchProfile

public static BranchProfileOperand getClearBranchProfile(Instruction i)

Get the operand called BranchProfile from the argument instruction clearing its instruction pointer. The returned operand will not point to any containing instruction.

Parameters:

i - the instruction to fetch the operand from

Returns:

the operand called BranchProfile

setBranchProfile

public static void setBranchProfile(Instruction i,
                                    BranchProfileOperand BranchProfile)

Set the operand called BranchProfile in the argument instruction to the argument operand. The operand will now point to the argument instruction as its containing instruction.

Parameters:

i - the instruction in which to store the operand

BranchProfile - the operand to store

indexOfBranchProfile

public static int indexOfBranchProfile(Instruction i)

Return the index of the operand called BranchProfile in the argument instruction.

Parameters:

i - the instruction to access.

Returns:

the index of the operand called BranchProfile in the argument instruction

hasBranchProfile

public static boolean hasBranchProfile(Instruction i)

Does the argument instruction have a non-null operand named BranchProfile?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has an non-null operand named BranchProfile or false if it does not.

create

public static Instruction create(Operator o,
                                 RegisterOperand GuardResult,
                                 Operand Val1,
                                 Operand Val2,
                                 ConditionOperand Cond,
                                 BranchOperand Target,
                                 BranchProfileOperand BranchProfile)

Create an instruction of the IfCmp instruction format.

Parameters:

o - the instruction's operator

GuardResult - the instruction's GuardResult operand

Val1 - the instruction's Val1 operand

Val2 - the instruction's Val2 operand

Cond - the instruction's Cond operand

Target - the instruction's Target operand

BranchProfile - the instruction's BranchProfile operand

Returns:

the newly created IfCmp instruction

mutate

public static Instruction mutate(Instruction i,
                                 Operator o,
                                 RegisterOperand GuardResult,
                                 Operand Val1,
                                 Operand Val2,
                                 ConditionOperand Cond,
                                 BranchOperand Target,
                                 BranchProfileOperand BranchProfile)

Mutate the argument instruction into an instruction of the IfCmp instruction format having the specified operator and operands.

Parameters:

i - the instruction to mutate

o - the instruction's operator

GuardResult - the instruction's GuardResult operand

Val1 - the instruction's Val1 operand

Val2 - the instruction's Val2 operand

Cond - the instruction's Cond operand

Target - the instruction's Target operand

BranchProfile - the instruction's BranchProfile operand

Returns:

the mutated instruction