org.jikesrvm.compilers.opt.ir

Class LowTableSwitch

java.lang.Object

org.jikesrvm.compilers.opt.ir.InstructionFormat

org.jikesrvm.compilers.opt.ir.LowTableSwitch

public final class LowTableSwitch
extends InstructionFormat

The LowTableSwitch 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
LowTableSwitch()

Method Summary

Modifier and Type	Method and Description
static boolean	conforms(Instruction i) InstructionFormat identification method for LowTableSwitch.
static boolean	conforms(Operator o) InstructionFormat identification method for LowTableSwitch.
static Instruction	create(Operator o, RegisterOperand Index, int numVarOps) Create an instruction of the LowTableSwitch instruction format.
static BranchProfileOperand	getBranchProfile(Instruction i, int k) Get the k'th operand called BranchProfile from the argument instruction.
static BranchProfileOperand	getClearBranchProfile(Instruction i, int k) Get the k'th operand called BranchProfile from the argument instruction clearing its instruction pointer.
static RegisterOperand	getClearIndex(Instruction i) Get the operand called Index from the argument instruction clearing its instruction pointer.
static BranchOperand	getClearTarget(Instruction i, int k) Get the k'th operand called Target from the argument instruction clearing its instruction pointer.
static RegisterOperand	getIndex(Instruction i) Get the operand called Index from the argument instruction.
static int	getNumberOfBranchProfiles(Instruction i) How many variable-length operands called BranchProfiles does the argument instruction have?
static int	getNumberOfTargets(Instruction i) How many variable-length operands called Targets does the argument instruction have?
static BranchOperand	getTarget(Instruction i, int k) Get the k'th operand called Target from the argument instruction.
static boolean	hasBranchProfile(Instruction i, int k) Does the argument instruction have a non-null k'th operand named BranchProfile?
static boolean	hasBranchProfiles(Instruction i) Does the argument instruction have any operands named BranchProfile?
static boolean	hasIndex(Instruction i) Does the argument instruction have a non-null operand named Index?
static boolean	hasTarget(Instruction i, int k) Does the argument instruction have a non-null k'th operand named Target?
static boolean	hasTargets(Instruction i) Does the argument instruction have any operands named Target?
static int	indexOfBranchProfile(Instruction i, int k) Return the index of the k'th operand called BranchProfile in the argument instruction.
static int	indexOfBranchProfiles(Instruction i) Return the index of the first operand called BranchProfile in the argument instruction.
static int	indexOfIndex(Instruction i) Return the index of the operand called Index in the argument instruction.
static int	indexOfTarget(Instruction i, int k) Return the index of the k'th operand called Target in the argument instruction.
static int	indexOfTargets(Instruction i) Return the index of the first operand called Target in the argument instruction.
static Instruction	mutate(Instruction i, Operator o, RegisterOperand Index, int numVarOps) Mutate the argument instruction into an instruction of the LowTableSwitch instruction format having the specified operator and operands.
static void	resizeNumberOfBranchProfiles(Instruction i, int numVarOps) Change the number of BranchProfiles that may be stored in the argument instruction to numVarOps.
static void	resizeNumberOfTargets(Instruction i, int numVarOps) Change the number of Targets that may be stored in the argument instruction to numVarOps.
static void	setBranchProfile(Instruction i, int k, BranchProfileOperand o) Set the k'th operand called BranchProfile in the argument instruction to the argument operand.
static void	setIndex(Instruction i, RegisterOperand Index) Set the operand called Index in the argument instruction to the argument operand.
static void	setTarget(Instruction i, int k, BranchOperand o) Set the k'th operand called Target 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

LowTableSwitch

public LowTableSwitch()

Method Detail

conforms

public static boolean conforms(Instruction i)

InstructionFormat identification method for LowTableSwitch.

Parameters:

i - an instruction

Returns:

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

conforms

public static boolean conforms(Operator o)

InstructionFormat identification method for LowTableSwitch.

Parameters:

o - an instruction

Returns:

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

getIndex

public static RegisterOperand getIndex(Instruction i)

Get the operand called Index 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 Index

getClearIndex

public static RegisterOperand getClearIndex(Instruction i)

Get the operand called Index 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 Index

setIndex

public static void setIndex(Instruction i,
                            RegisterOperand Index)

Set the operand called Index 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

Index - the operand to store

indexOfIndex

public static int indexOfIndex(Instruction i)

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

Parameters:

i - the instruction to access.

Returns:

the index of the operand called Index in the argument instruction

hasIndex

public static boolean hasIndex(Instruction i)

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

Parameters:

i - the instruction to access.

Returns:

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

getTarget

public static BranchOperand getTarget(Instruction i,
                                      int k)

Get the k'th 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

k - the index of the operand

Returns:

the k'th operand called Target

getClearTarget

public static BranchOperand getClearTarget(Instruction i,
                                           int k)

Get the k'th 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

k - the index of the operand

Returns:

the k'th operand called Target

setTarget

public static void setTarget(Instruction i,
                             int k,
                             BranchOperand o)

Set the k'th 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

k - the index of the operand

o - the operand to store

indexOfTarget

public static int indexOfTarget(Instruction i,
                                int k)

Return the index of the k'th operand called Target in the argument instruction.

Parameters:

i - the instruction to access.

k - the index of the operand.

Returns:

the index of the k'th operand called Target in the argument instruction

hasTarget

public static boolean hasTarget(Instruction i,
                                int k)

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

Parameters:

i - the instruction to access.

k - the index of the operand.

Returns:

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

indexOfTargets

public static int indexOfTargets(Instruction i)

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

Parameters:

i - the instruction to access.

Returns:

the index of the first operand called Target in the argument instruction

hasTargets

public static boolean hasTargets(Instruction i)

Does the argument instruction have any operands named Target?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has operands named Target or false if it does not.

getNumberOfTargets

public static int getNumberOfTargets(Instruction i)

How many variable-length operands called Targets does the argument instruction have?

Parameters:

i - the instruction to access

Returns:

the number of operands called Targets the instruction has

resizeNumberOfTargets

public static void resizeNumberOfTargets(Instruction i,
                                         int numVarOps)

Change the number of Targets that may be stored in the argument instruction to numVarOps.

Parameters:

i - the instruction to access

numVarOps - the new number of variable operands called Targets that may be stored in the instruction

getBranchProfile

public static BranchProfileOperand getBranchProfile(Instruction i,
                                                    int k)

Get the k'th 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

k - the index of the operand

Returns:

the k'th operand called BranchProfile

getClearBranchProfile

public static BranchProfileOperand getClearBranchProfile(Instruction i,
                                                         int k)

Get the k'th 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

k - the index of the operand

Returns:

the k'th operand called BranchProfile

setBranchProfile

public static void setBranchProfile(Instruction i,
                                    int k,
                                    BranchProfileOperand o)

Set the k'th 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

k - the index of the operand

o - the operand to store

indexOfBranchProfile

public static int indexOfBranchProfile(Instruction i,
                                       int k)

Return the index of the k'th operand called BranchProfile in the argument instruction.

Parameters:

i - the instruction to access.

k - the index of the operand.

Returns:

the index of the k'th operand called BranchProfile in the argument instruction

hasBranchProfile

public static boolean hasBranchProfile(Instruction i,
                                       int k)

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

Parameters:

i - the instruction to access.

k - the index of the operand.

Returns:

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

indexOfBranchProfiles

public static int indexOfBranchProfiles(Instruction i)

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

Parameters:

i - the instruction to access.

Returns:

the index of the first operand called BranchProfile in the argument instruction

hasBranchProfiles

public static boolean hasBranchProfiles(Instruction i)

Does the argument instruction have any operands named BranchProfile?

Parameters:

i - the instruction to access.

Returns:

true if the instruction has operands named BranchProfile or false if it does not.

getNumberOfBranchProfiles

public static int getNumberOfBranchProfiles(Instruction i)

How many variable-length operands called BranchProfiles does the argument instruction have?

Parameters:

i - the instruction to access

Returns:

the number of operands called BranchProfiles the instruction has

resizeNumberOfBranchProfiles

public static void resizeNumberOfBranchProfiles(Instruction i,
                                                int numVarOps)

Change the number of BranchProfiles that may be stored in the argument instruction to numVarOps.

Parameters:

i - the instruction to access

numVarOps - the new number of variable operands called BranchProfiles that may be stored in the instruction

create

public static Instruction create(Operator o,
                                 RegisterOperand Index,
                                 int numVarOps)

Create an instruction of the LowTableSwitch instruction format.

Parameters:

o - the instruction's operator

Index - the instruction's Index operand

numVarOps - the number of variable length operands that will be stored in the insruction.

Returns:

the newly created LowTableSwitch instruction

mutate

public static Instruction mutate(Instruction i,
                                 Operator o,
                                 RegisterOperand Index,
                                 int numVarOps)

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

Parameters:

i - the instruction to mutate

o - the instruction's operator

Index - the instruction's Index operand

numVarOps - the number of variable length operands that will be stored in the instruction.

Returns:

the mutated instruction