GetField documentation

FRAMES NO FRAMES SUMMARY: NESTED CONSTR ENUM FIELD METHOD ELEMENT

DETAIL: FIELD CONSTR ENUM METHOD ELEMENT

org.jikesrvm.compilers.opt.ir

Class GetField

@SuppressWarnings (value = {"unused"})

public final class GetField
extends InstructionFormat

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

SinceNot specified.

VersionNot specified.

AuthorNot specified.

Wiki javadoc Use textile entry format.

Add your comments here.

Fields inherited from org.jikesrvm.compilers.opt.irInstructionFormat
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 IfCmp2_format IfCmp2_traits IfCmp_format IfCmp_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 MIR_BinaryAcc_format MIR_BinaryAcc_traits MIR_Branch_format MIR_Branch_traits MIR_CacheOp_format MIR_CacheOp_traits MIR_Call_format MIR_Call_traits MIR_CaseLabel_format MIR_CaseLabel_traits MIR_CompareExchange8B_format MIR_CompareExchange8B_traits MIR_CompareExchange_format MIR_CompareExchange_traits MIR_Compare_format MIR_Compare_traits MIR_CondBranch2_format MIR_CondBranch2_traits MIR_CondBranch_format MIR_CondBranch_traits MIR_CondMove_format MIR_CondMove_traits MIR_ConvertDW2QW_format MIR_ConvertDW2QW_traits MIR_Divide_format MIR_Divide_traits MIR_DoubleShift_format MIR_DoubleShift_traits MIR_Empty_format MIR_Empty_traits MIR_FSave_format MIR_FSave_traits MIR_Lea_format MIR_Lea_traits MIR_LowTableSwitch_format MIR_LowTableSwitch_traits MIR_Move_format MIR_Move_traits MIR_Multiply_format MIR_Multiply_traits MIR_Nullary_format MIR_Nullary_traits MIR_RDTSC_format MIR_RDTSC_traits MIR_Return_format MIR_Return_traits MIR_Set_format MIR_Set_traits MIR_Test_format MIR_Test_traits MIR_TrapIf_format MIR_TrapIf_traits MIR_Trap_format MIR_Trap_traits MIR_UnaryAcc_format MIR_UnaryAcc_traits MIR_UnaryNoRes_format MIR_UnaryNoRes_traits MIR_Unary_format MIR_Unary_traits MIR_XChng_format MIR_XChng_traits MonitorOp_format MonitorOp_traits Move_format Move_traits Multianewarray_format Multianewarray_traits NewArray_format NewArray_traits New_format New_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 StoreCheck_format StoreCheck_traits Store_format Store_traits TableSwitch_format TableSwitch_traits TrapIf_format TrapIf_traits Trap_format Trap_traits TypeCheck_format TypeCheck_traits Unary_format Unary_traits Unassigned_format ZeroCheck_format ZeroCheck_traits

Fields inherited from org.jikesrvm.compilers.opt.irInstructionFormat

Constructor Summary
GetField() No description provided.

Method Summary
static boolean	conforms( Instruction i ) InstructionFormat identification method for GetField.
static boolean	conforms( Operator o ) InstructionFormat identification method for GetField.
static Instruction	create( Operator o, RegisterOperand Result, Operand Ref, Operand Offset, LocationOperand Location, Operand Guard ) Create an instruction of the GetField instruction format.
static Operand	getClearGuard( Instruction i ) Get the operand called Guard from the argument instruction clearing its instruction pointer.
static LocationOperand	getClearLocation( Instruction i ) Get the operand called Location from the argument instruction clearing its instruction pointer.
static Operand	getClearOffset( Instruction i ) Get the operand called Offset 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	getClearResult( Instruction i ) Get the operand called Result from the argument instruction clearing its instruction pointer.
static Operand	getGuard( Instruction i ) Get the operand called Guard from the argument instruction.
static LocationOperand	getLocation( Instruction i ) Get the operand called Location from the argument instruction.
static Operand	getOffset( Instruction i ) Get the operand called Offset from the argument instruction.
static Operand	getRef( Instruction i ) Get the operand called Ref from the argument instruction.
static RegisterOperand	getResult( Instruction i ) Get the operand called Result from the argument instruction.
static boolean	hasGuard( Instruction i ) Does the argument instruction have a non-null operand named Guard?
static boolean	hasLocation( Instruction i ) Does the argument instruction have a non-null operand named Location?
static boolean	hasOffset( Instruction i ) Does the argument instruction have a non-null operand named Offset?
static boolean	hasRef( Instruction i ) Does the argument instruction have a non-null operand named Ref?
static boolean	hasResult( Instruction i ) Does the argument instruction have a non-null operand named Result?
static int	indexOfGuard( Instruction i ) Return the index of the operand called Guard in the argument instruction.
static int	indexOfLocation( Instruction i ) Return the index of the operand called Location in the argument instruction.
static int	indexOfOffset( Instruction i ) Return the index of the operand called Offset in the argument instruction.
static int	indexOfRef( Instruction i ) Return the index of the operand called Ref in the argument instruction.
static int	indexOfResult( Instruction i ) Return the index of the operand called Result in the argument instruction.
static Instruction	mutate( Instruction i, Operator o, RegisterOperand Result, Operand Ref, Operand Offset, LocationOperand Location, Operand Guard ) Mutate the argument instruction into an instruction of the GetField instruction format having the specified operator and operands.
static void	setGuard( Instruction i, Operand Guard ) Set the operand called Guard in the argument instruction to the argument operand.
static void	setLocation( Instruction i, LocationOperand Location ) Set the operand called Location in the argument instruction to the argument operand.
static void	setOffset( Instruction i, Operand Offset ) Set the operand called Offset 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.
static void	setResult( Instruction i, RegisterOperand Result ) Set the operand called Result in the argument instruction to the argument operand.

Methods inherited from org.jikesrvm.compilers.opt.irInstructionFormat
fail (Instruction, String) fail (Operator, String)

Methods inherited from java.langObject
clone () equals (Object) finalize () getClass () hashCode () notify () notifyAll () toString () wait (long) wait (long, int) wait ()

Constructor Detail

GetField

public GetField ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

Method Detail

conforms

public static boolean conforms ( Instruction i )

InstructionFormat identification method for GetField.

Parameters

Type	Name	Description
Instruction	i	an instruction

Wiki javadoc Use textile entry format.

Add your comments here.

conforms

public static boolean conforms ( Operator o )

InstructionFormat identification method for GetField.

Parameters

Type	Name	Description
Operator	o	an instruction

Wiki javadoc Use textile entry format.

Add your comments here.

create

public static Instruction create ( Operator o, RegisterOperand Result, Operand Ref, Operand Offset, LocationOperand Location, Operand Guard )

Create an instruction of the GetField instruction format.

Parameters

Type	Name	Description
Operator	o	the instruction's operator
RegisterOperand	Result	the instruction's Result operand
Operand	Ref	the instruction's Ref operand
Operand	Offset	the instruction's Offset operand
LocationOperand	Location	the instruction's Location operand
Operand	Guard	the instruction's Guard operand

Wiki javadoc Use textile entry format.

Add your comments here.

getClearGuard

public static Operand getClearGuard ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getClearLocation

public static LocationOperand getClearLocation ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getClearOffset

public static Operand getClearOffset ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

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

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getClearResult

public static RegisterOperand getClearResult ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getGuard

public static Operand getGuard ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getLocation

public static LocationOperand getLocation ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getOffset

public static Operand getOffset ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

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

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

getResult

public static RegisterOperand getResult ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to fetch the operand from

Wiki javadoc Use textile entry format.

Add your comments here.

hasGuard

public static boolean hasGuard ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

hasLocation

public static boolean hasLocation ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

hasOffset

public static boolean hasOffset ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

hasRef

public static boolean hasRef ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

hasResult

public static boolean hasResult ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

indexOfGuard

public static int indexOfGuard ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

indexOfLocation

public static int indexOfLocation ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

indexOfOffset

public static int indexOfOffset ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

indexOfRef

public static int indexOfRef ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

indexOfResult

public static int indexOfResult ( Instruction i )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to access.

Wiki javadoc Use textile entry format.

Add your comments here.

mutate

public static Instruction mutate ( Instruction i, Operator o, RegisterOperand Result, Operand Ref, Operand Offset, LocationOperand Location, Operand Guard )

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

Parameters

Type	Name	Description
Instruction	i	the instruction to mutate
Operator	o	the instruction's operator
RegisterOperand	Result	the instruction's Result operand
Operand	Ref	the instruction's Ref operand
Operand	Offset	the instruction's Offset operand
LocationOperand	Location	the instruction's Location operand
Operand	Guard	the instruction's Guard operand

Wiki javadoc Use textile entry format.

Add your comments here.

setGuard

public static void setGuard ( Instruction i, Operand Guard )

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

Parameters

Type	Name	Description
Instruction	i	the instruction in which to store the operand
Operand	Guard	the operand to store

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setLocation

public static void setLocation ( Instruction i, LocationOperand Location )

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

Parameters

Type	Name	Description
Instruction	i	the instruction in which to store the operand
LocationOperand	Location	the operand to store

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setOffset

public static void setOffset ( Instruction i, Operand Offset )

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

Parameters

Type	Name	Description
Instruction	i	the instruction in which to store the operand
Operand	Offset	the operand to store

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

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

Type	Name	Description
Instruction	i	the instruction in which to store the operand
Operand	Ref	the operand to store

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setResult

public static void setResult ( Instruction i, RegisterOperand Result )

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

Parameters

Type	Name	Description
Instruction	i	the instruction in which to store the operand
RegisterOperand	Result	the operand to store

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.