org.jikesrvm.compilers.opt.ir

Class NullCheck

java.lang.Object

org.jikesrvm.compilers.opt.ir.InstructionFormat

org.jikesrvm.compilers.opt.ir.NullCheck

public final class NullCheck
extends InstructionFormat

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

Method Summary

Modifier and Type	Method and Description
static boolean	conforms(Instruction i) InstructionFormat identification method for NullCheck.
static boolean	conforms(Operator o) InstructionFormat identification method for NullCheck.
static Instruction	create(Operator o, RegisterOperand GuardResult, Operand Ref) Create an instruction of the NullCheck instruction format.
static RegisterOperand	getClearGuardResult(Instruction i) Get the operand called GuardResult from the argument instruction clearing its instruction pointer.
static Operand	getClearRef(Instruction i) Get the operand called Ref from the argument instruction clearing its instruction pointer.
static RegisterOperand	getGuardResult(Instruction i) Get the operand called GuardResult from the argument instruction.
static Operand	getRef(Instruction i) Get the operand called Ref from the argument instruction.
static boolean	hasGuardResult(Instruction i) Does the argument instruction have a non-null operand named GuardResult?
static boolean	hasRef(Instruction i) Does the argument instruction have a non-null operand named Ref?
static int	indexOfGuardResult(Instruction i) Return the index of the operand called GuardResult in the argument instruction.
static int	indexOfRef(Instruction i) Return the index of the operand called Ref in the argument instruction.
static Instruction	mutate(Instruction i, Operator o, RegisterOperand GuardResult, Operand Ref) Mutate the argument instruction into an instruction of the NullCheck instruction format having the specified operator and operands.
static void	setGuardResult(Instruction i, RegisterOperand GuardResult) Set the operand called GuardResult in the argument instruction to the argument operand.
static void	setRef(Instruction i, Operand Ref) Set the operand called Ref 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

NullCheck

public NullCheck()

Method Detail

conforms

public static boolean conforms(Instruction i)

InstructionFormat identification method for NullCheck.

Parameters:

i - an instruction

Returns:

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

conforms

public static boolean conforms(Operator o)

InstructionFormat identification method for NullCheck.

Parameters:

o - an instruction

Returns:

true if the InstructionFormat of the argument operator is NullCheck 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.

getRef

public static Operand getRef(Instruction i)

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

getClearRef

public static Operand getClearRef(Instruction i)

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

setRef

public static void setRef(Instruction i,
                          Operand Ref)

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

Ref - the operand to store

indexOfRef

public static int indexOfRef(Instruction i)

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

Parameters:

i - the instruction to access.

Returns:

the index of the operand called Ref in the argument instruction

hasRef

public static boolean hasRef(Instruction i)

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

Parameters:

i - the instruction to access.

Returns:

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

create

public static Instruction create(Operator o,
                                 RegisterOperand GuardResult,
                                 Operand Ref)

Create an instruction of the NullCheck instruction format.

Parameters:

o - the instruction's operator

GuardResult - the instruction's GuardResult operand

Ref - the instruction's Ref operand

Returns:

the newly created NullCheck instruction

mutate

public static Instruction mutate(Instruction i,
                                 Operator o,
                                 RegisterOperand GuardResult,
                                 Operand Ref)

Mutate the argument instruction into an instruction of the NullCheck 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

Ref - the instruction's Ref operand

Returns:

the mutated instruction