org.graalvm.compiler.lir

Class LIRInstruction

java.lang.Object

org.graalvm.compiler.lir.LIRInstruction

Direct Known Subclasses:

AArch64BlockEndOp, AArch64LIRInstruction, AMD64BlockEndOp, AMD64LIRInstruction, FullInfopointOp, HotSpotCounterOp, HotSpotInstructionProfiling.InstructionCounterOp, HotSpotLockStack, StandardOp.BindToRegisterOp, StandardOp.BlackholeOp, StandardOp.JumpOp, StandardOp.LabelOp, StandardOp.NoOp, StandardOp.SaveRegistersOp, StandardOp.SpillRegistersOp, StandardOp.StackMove

public abstract class LIRInstruction
extends Object

The base class for an LIRInstruction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LIRInstruction.Alive
static interface	LIRInstruction.Def
static class	LIRInstruction.OperandFlag Flags for an operand.
static class	LIRInstruction.OperandMode Constants denoting how a LIR instruction uses an operand.
static interface	LIRInstruction.State
static interface	LIRInstruction.Temp
static interface	LIRInstruction.Use

Field Summary

Fields

Modifier and Type	Field and Description
protected static EnumSet<LIRInstruction.OperandFlag>	ADDRESS_FLAGS The flags of the base and index value of an address.
protected static EnumMap<LIRInstruction.OperandMode,EnumSet<LIRInstruction.OperandFlag>>	ALLOWED_FLAGS For validity checking of the operand flags defined by instruction subclasses.

Constructor Summary

Constructors

Constructor and Description
LIRInstruction(LIRInstructionClass<? extends LIRInstruction> c) Constructs a new LIR instruction.

Method Summary

Modifier and Type	Method and Description
protected static Value[]	addStackSlotsToTemporaries(Value[] parameters, Value[] temporaries) Utility method to add stack arguments to a list of temporaries.
boolean	destroysCallerSavedRegisters()
abstract void	emitCode(CompilationResultBuilder crb)
void	forEachAlive(InstructionValueProcedure proc)
void	forEachAlive(ValueProcedure proc)
void	forEachInput(InstructionValueProcedure proc)
void	forEachInput(ValueProcedure proc)
void	forEachOutput(InstructionValueProcedure proc)
void	forEachOutput(ValueProcedure proc)
Value	forEachRegisterHint(Value value, LIRInstruction.OperandMode mode, InstructionValueProcedure proc)
Value	forEachRegisterHint(Value value, LIRInstruction.OperandMode mode, ValueProcedure proc)
void	forEachState(InstructionStateProcedure proc)
void	forEachState(InstructionValueProcedure proc)
void	forEachState(StateProcedure proc)
void	forEachState(ValueProcedure proc)
void	forEachTemp(InstructionValueProcedure proc)
void	forEachTemp(ValueProcedure proc)
String	getComment(LIRGenerationResult res) Gets the comment attached to this instruction.
LIRInstructionClass<?>	getLIRInstructionClass()
NodeSourcePosition	getPosition()
int	hashCode()
boolean	hasOperands()
boolean	hasState()
int	id()
boolean	isLoadConstantOp() Returns true if the instruction is a StandardOp.LoadConstantOp.
boolean	isMoveOp() Returns true if the instruction is a StandardOp.MoveOp.
boolean	isValueMoveOp() Returns true if the instruction is a StandardOp.ValueMoveOp.
String	name()
boolean	needsClearUpperVectorRegisters()
void	setComment(LIRGenerationResult res, String comment) Adds a comment to this instruction.
void	setId(int id)
void	setPosition(NodeSourcePosition position)
String	toString()
String	toString(LIRGenerationResult res)
String	toStringWithIdPrefix()
void	verify()
void	visitEachAlive(InstructionValueConsumer proc)
void	visitEachAlive(ValueConsumer proc)
void	visitEachInput(InstructionValueConsumer proc)
void	visitEachInput(ValueConsumer proc)
void	visitEachOutput(InstructionValueConsumer proc)
void	visitEachOutput(ValueConsumer proc)
void	visitEachState(InstructionValueConsumer proc)
void	visitEachState(ValueConsumer proc)
void	visitEachTemp(InstructionValueConsumer proc)
void	visitEachTemp(ValueConsumer proc)

Methods inherited from class java.lang.Object

clone, equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALLOWED_FLAGS

protected static final EnumMap<LIRInstruction.OperandMode,EnumSet<LIRInstruction.OperandFlag>> ALLOWED_FLAGS

For validity checking of the operand flags defined by instruction subclasses.

ADDRESS_FLAGS

protected static final EnumSet<LIRInstruction.OperandFlag> ADDRESS_FLAGS

The flags of the base and index value of an address.

Constructor Detail

LIRInstruction

public LIRInstruction(LIRInstructionClass<? extends LIRInstruction> c)

Constructs a new LIR instruction.

Method Detail

emitCode

public abstract void emitCode(CompilationResultBuilder crb)

id

public final int id()

setId

public final void setId(int id)

getPosition

public final NodeSourcePosition getPosition()

setPosition

public final void setPosition(NodeSourcePosition position)

name

public final String name()

hasOperands

public final boolean hasOperands()

hasState

public final boolean hasState()

destroysCallerSavedRegisters

public boolean destroysCallerSavedRegisters()

forEachInput

public final void forEachInput(InstructionValueProcedure proc)

forEachAlive

public final void forEachAlive(InstructionValueProcedure proc)

forEachTemp

public final void forEachTemp(InstructionValueProcedure proc)

forEachOutput

public final void forEachOutput(InstructionValueProcedure proc)

forEachState

public final void forEachState(InstructionValueProcedure proc)

forEachInput

public final void forEachInput(ValueProcedure proc)

forEachAlive

public final void forEachAlive(ValueProcedure proc)

forEachTemp

public final void forEachTemp(ValueProcedure proc)

forEachOutput

public final void forEachOutput(ValueProcedure proc)

forEachState

public final void forEachState(ValueProcedure proc)

forEachState

public final void forEachState(InstructionStateProcedure proc)

forEachState

public final void forEachState(StateProcedure proc)

visitEachInput

public final void visitEachInput(InstructionValueConsumer proc)

visitEachAlive

public final void visitEachAlive(InstructionValueConsumer proc)

visitEachTemp

public final void visitEachTemp(InstructionValueConsumer proc)

visitEachOutput

public final void visitEachOutput(InstructionValueConsumer proc)

visitEachState

public final void visitEachState(InstructionValueConsumer proc)

visitEachInput

public final void visitEachInput(ValueConsumer proc)

visitEachAlive

public final void visitEachAlive(ValueConsumer proc)

visitEachTemp

public final void visitEachTemp(ValueConsumer proc)

visitEachOutput

public final void visitEachOutput(ValueConsumer proc)

visitEachState

public final void visitEachState(ValueConsumer proc)

forEachRegisterHint

public final Value forEachRegisterHint(Value value,
                                       LIRInstruction.OperandMode mode,
                                       InstructionValueProcedure proc)

forEachRegisterHint

public final Value forEachRegisterHint(Value value,
                                       LIRInstruction.OperandMode mode,
                                       ValueProcedure proc)

isMoveOp

public final boolean isMoveOp()

Returns true if the instruction is a StandardOp.MoveOp. This function is preferred to instanceof MoveOp since the type check is more expensive than reading a field from LIRInstructionClass.

isValueMoveOp

public final boolean isValueMoveOp()

Returns true if the instruction is a StandardOp.ValueMoveOp. This function is preferred to instanceof ValueMoveOp since the type check is more expensive than reading a field from LIRInstructionClass.

isLoadConstantOp

public final boolean isLoadConstantOp()

Returns true if the instruction is a StandardOp.LoadConstantOp. This function is preferred to instanceof LoadConstantOp since the type check is more expensive than reading a field from LIRInstructionClass.

addStackSlotsToTemporaries

protected static Value[] addStackSlotsToTemporaries(Value[] parameters,
                                                    Value[] temporaries)

Utility method to add stack arguments to a list of temporaries. Useful for modeling calling conventions that kill outgoing argument space.

Returns:

additional temporaries

verify

public void verify()

setComment

public final void setComment(LIRGenerationResult res,
                             String comment)

Adds a comment to this instruction.

getComment

public final String getComment(LIRGenerationResult res)

Gets the comment attached to this instruction.

toStringWithIdPrefix

public final String toStringWithIdPrefix()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(LIRGenerationResult res)

getLIRInstructionClass

public LIRInstructionClass<?> getLIRInstructionClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

needsClearUpperVectorRegisters

public boolean needsClearUpperVectorRegisters()