org.graalvm.compiler.lir.gen

Interface LIRGeneratorTool

All Superinterfaces:

DiagnosticLIRGeneratorTool

All Known Subinterfaces:

HotSpotLIRGenerator

All Known Implementing Classes:

AArch64HotSpotLIRGenerator, AArch64LIRGenerator, AMD64HotSpotLIRGenerator, AMD64LIRGenerator, LIRGenerator

public interface LIRGeneratorTool
extends DiagnosticLIRGeneratorTool

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LIRGeneratorTool.BlockScope
static class	LIRGeneratorTool.CharsetName

Nested classes/interfaces inherited from interface org.graalvm.compiler.lir.gen.DiagnosticLIRGeneratorTool

DiagnosticLIRGeneratorTool.ZapRegistersAfterInstruction, DiagnosticLIRGeneratorTool.ZapStackArgumentSpaceBeforeInstruction

Method Summary

Modifier and Type	Method and Description
default AllocatableValue	addressAsAllocatableInteger(Value value) Returns an AllocatableValue of the address value with an integer representation.
default VirtualStackSlot	allocateStackMemory(int sizeInBytes, int alignmentInBytes)
<I extends LIRInstruction> I	append(I op)
AllocatableValue	asAllocatable(Value value) Returns an AllocatableValue holding the value by moving it if necessary.
boolean	canInlineConstant(Constant constant)
Variable	emitAddress(AllocatableValue stackslot)
default Variable	emitArrayCompareTo(JavaKind kind1, JavaKind kind2, int array1BaseOffset, int array2BaseOffset, Value array1, Value array2, Value length1, Value length2)
default void	emitArrayCopyWithConversion(JavaKind strideSrc, JavaKind strideDst, Value arraySrc, Value offsetSrc, Value arrayDst, Value offsetDst, Value length)
default void	emitArrayCopyWithConversion(Value arraySrc, Value offsetSrc, Value arrayDst, Value offsetDst, Value length, Value stride)
default Variable	emitArrayEquals(int array1BaseOffset, int array2BaseOffset, int maskBaseOffset, Value array1, Value offset1, Value array2, Value offset2, Value mask, Value length, Value stride)
default Variable	emitArrayEquals(int array1BaseOffset, int array2BaseOffset, Value array1, Value offset1, Value array2, Value offset2, Value length, Value stride)
default Variable	emitArrayEquals(JavaKind kind, int array1BaseOffset, int array2BaseOffset, Value array1, Value array2, Value length)
default Variable	emitArrayEquals(JavaKind kind, int array1BaseOffset, int array2BaseOffset, Value array1, Value offset1, Value array2, Value offset2, Value length)
default Variable	emitArrayEquals(JavaKind kind1, JavaKind kind2, int array1BaseOffset, int array2BaseOffset, Value array1, Value offset1, Value array2, Value offset2, Value length)
default Variable	emitArrayEquals(JavaKind kind1, JavaKind kind2, JavaKind kindMask, int array1BaseOffset, int array2BaseOffset, int maskBaseOffset, Value array1, Value offset1, Value array2, Value offset2, Value mask, Value length)
default Variable	emitArrayIndexOf(int arrayBaseOffset, JavaKind valueKind, boolean findTwoConsecutive, boolean withMask, Value array, Value offset, Value length, Value fromIndex, Value... searchValues)
default Variable	emitArrayRegionCompareTo(JavaKind strideA, JavaKind strideB, Value arrayA, Value offsetA, Value arrayB, Value offsetB, Value length)
default Variable	emitArrayRegionCompareTo(Value arrayA, Value offsetA, Value arrayB, Value offsetB, Value length, Value stride)
default Value	emitAtomicReadAndAdd(Value address, <any> valueKind, Value delta) Emit an atomic read-and-add instruction.
default Value	emitAtomicReadAndWrite(Value address, <any> valueKind, Value newValue) Emit an atomic read-and-write instruction.
void	emitBlackhole(Value operand)
Variable	emitByteSwap(Value operand)
void	emitCacheWriteback(Value address) Emits instruction(s) to flush an individual cache line that starts at address.
void	emitCacheWritebackSync(boolean isPreSync) Emits instruction(s) to serialize cache writeback operations relative to preceding (if isPreSync == true) or following (if isPreSync == false) memory writes.
default Variable	emitCalcStringAttributes(Object op, Value array, Value offset, Value length, boolean isValid)
Value	emitCompress(Value pointer, CompressEncoding encoding, boolean nonNull)
Variable	emitConditionalMove(PlatformKind cmpKind, Value leftVal, Value right, Condition cond, boolean unorderedIsTrue, Value trueValue, Value falseValue)
Value	emitConstant(LIRKind kind, Constant constant)
default void	emitConvertNullToZero(AllocatableValue result, AllocatableValue input)
default void	emitConvertNullToZero(AllocatableValue result, Value input)
default void	emitConvertZeroToNull(AllocatableValue result, Value input)
void	emitDeoptimize(Value actionAndReason, Value failedSpeculation, LIRFrameState state)
default Variable	emitEncodeArray(Value src, Value dst, Value length, LIRGeneratorTool.CharsetName charset)
Variable	emitForeignCall(ForeignCallLinkage linkage, LIRFrameState state, Value... args)
default Variable	emitHasNegatives(Value array, Value length)
Variable	emitIntegerTestMove(Value leftVal, Value right, Value trueValue, Value falseValue)
Value	emitJavaConstant(JavaConstant constant)
void	emitJump(LabelRef label)
AllocatableValue	emitLoadConstant(<any> kind, Constant constant)
Variable	emitLogicCompareAndSwap(LIRKind accessKind, Value address, Value expectedValue, Value newValue, Value trueValue, Value falseValue, MemoryOrderMode memoryOrder)
void	emitMembar(int barriers)
void	emitMove(AllocatableValue dst, Value src)
Variable	emitMove(Value input)
void	emitMoveConstant(AllocatableValue dst, Constant src)
void	emitNullCheck(Value address, LIRFrameState state)
void	emitPause()
void	emitPrefetchAllocate(Value address)
default Value	emitReadCallerStackPointer(Stamp wordStamp)
Variable	emitReadRegister(Register register, <any> kind)
default Value	emitReadReturnAddress(Stamp wordStamp, int returnAddressSize)
void	emitReturn(JavaKind javaKind, Value input) Emits a return instruction.
void	emitSpeculationFence() Emits an instruction that prevents speculative execution from proceeding: no instruction after this fence will execute until all previous instructions have retired.
default void	emitStringLatin1Inflate(Value src, Value dst, Value len)
default Variable	emitStringUTF16Compress(Value src, Value dst, Value len)
default Value	emitTimeStampWithProcid()
Value	emitUncompress(Value pointer, CompressEncoding encoding, boolean nonNull)
void	emitUnwind(Value operand)
Value	emitValueCompareAndSwap(LIRKind accessKind, Value address, Value expectedValue, Value newValue, MemoryOrderMode memoryOrder)
void	emitWriteRegister(Register dst, Value src, <any> wordStamp)
default void	emitZeroMemory(Value address, Value length, boolean isAligned)
ArithmeticLIRGeneratorTool	getArithmetic()
CodeCacheProvider	getCodeCache()
AbstractBlockBase<?>	getCurrentBlock()
ForeignCallsProvider	getForeignCalls()
LIRKind	getLIRKind(Stamp stamp)
default VectorSize	getMaxVectorSize() Returns the maximum size of vector registers.
MetaAccessProvider	getMetaAccess()
MoveFactory	getMoveFactory()
CodeGenProviders	getProviders()
RegisterConfig	getRegisterConfig()
LIRGenerationResult	getResult()
MoveFactory	getSpillMoveFactory() Get a special MoveFactory for spill moves.
boolean	mayEmbedConstantLoad(Constant constant)
Variable	newVariable(<any> kind) Create a new Variable.
TargetDescription	target()
<K extends <any>> K	toRegisterKind(K kind) Some backends need to convert sub-word kinds to a larger kind in ArithmeticLIRGeneratorTool.emitLoad(org.graalvm.compiler.core.common.LIRKind, Value, org.graalvm.compiler.lir.LIRFrameState) and LIRGeneratorTool.emitLoadConstant(<any>, Constant) because sub-word registers can't be accessed.

Methods inherited from interface org.graalvm.compiler.lir.gen.DiagnosticLIRGeneratorTool

createBenchmarkCounter, createMultiBenchmarkCounter, createZapArgumentSpace, createZapRegisters, createZapRegisters, createZapRegisters, zapArgumentSpace

Method Detail

getArithmetic

ArithmeticLIRGeneratorTool getArithmetic()

getProviders

CodeGenProviders getProviders()

target

TargetDescription target()

getMetaAccess

MetaAccessProvider getMetaAccess()

getCodeCache

CodeCacheProvider getCodeCache()

getForeignCalls

ForeignCallsProvider getForeignCalls()

getCurrentBlock

AbstractBlockBase<?> getCurrentBlock()

getResult

LIRGenerationResult getResult()

getRegisterConfig

RegisterConfig getRegisterConfig()

getMoveFactory

MoveFactory getMoveFactory()

getSpillMoveFactory

MoveFactory getSpillMoveFactory()

Get a special MoveFactory for spill moves. The instructions returned by this factory must only depend on the input values. References to values that require interaction with register allocation are strictly forbidden.

canInlineConstant

boolean canInlineConstant(Constant constant)

mayEmbedConstantLoad

boolean mayEmbedConstantLoad(Constant constant)

emitConstant

Value emitConstant(LIRKind kind,
                   Constant constant)

emitJavaConstant

Value emitJavaConstant(JavaConstant constant)

toRegisterKind

<K extends <any>> K toRegisterKind(K kind)

Some backends need to convert sub-word kinds to a larger kind in ArithmeticLIRGeneratorTool.emitLoad(org.graalvm.compiler.core.common.LIRKind, Value, org.graalvm.compiler.lir.LIRFrameState) and LIRGeneratorTool.emitLoadConstant(<any>, Constant) because sub-word registers can't be accessed. This method converts the LIRKind of a memory location or constant to the LIRKind that will be used when it is loaded into a register.

emitLoadConstant

AllocatableValue emitLoadConstant(<any> kind,
                                  Constant constant)

emitNullCheck

void emitNullCheck(Value address,
                   LIRFrameState state)

emitLogicCompareAndSwap

Variable emitLogicCompareAndSwap(LIRKind accessKind,
                                 Value address,
                                 Value expectedValue,
                                 Value newValue,
                                 Value trueValue,
                                 Value falseValue,
                                 MemoryOrderMode memoryOrder)

emitValueCompareAndSwap

Value emitValueCompareAndSwap(LIRKind accessKind,
                              Value address,
                              Value expectedValue,
                              Value newValue,
                              MemoryOrderMode memoryOrder)

emitAtomicReadAndAdd

default Value emitAtomicReadAndAdd(Value address,
                                   <any> valueKind,
                                   Value delta)

Emit an atomic read-and-add instruction.

Parameters:

address - address of the value to be read and written

valueKind - the access kind for the value to be written

delta - the value to be added

emitAtomicReadAndWrite

default Value emitAtomicReadAndWrite(Value address,
                                     <any> valueKind,
                                     Value newValue)

Emit an atomic read-and-write instruction.

Parameters:

address - address of the value to be read and written

valueKind - the access kind for the value to be written

newValue - the new value to be written

emitDeoptimize

void emitDeoptimize(Value actionAndReason,
                    Value failedSpeculation,
                    LIRFrameState state)

emitForeignCall

Variable emitForeignCall(ForeignCallLinkage linkage,
                         LIRFrameState state,
                         Value... args)

newVariable

Variable newVariable(<any> kind)

Create a new Variable.

Parameters:

kind - The type of the value that will be stored in this Variable. See LIRKind for documentation on what to pass here. Note that in most cases, simply passing Value.getValueKind() is wrong.

Returns:

A new Variable.

emitMove

Variable emitMove(Value input)

emitMove

void emitMove(AllocatableValue dst,
              Value src)

emitReadRegister

Variable emitReadRegister(Register register,
                          <any> kind)

emitWriteRegister

void emitWriteRegister(Register dst,
                       Value src,
                       <any> wordStamp)

emitMoveConstant

void emitMoveConstant(AllocatableValue dst,
                      Constant src)

emitAddress

Variable emitAddress(AllocatableValue stackslot)

emitMembar

void emitMembar(int barriers)

emitUnwind

void emitUnwind(Value operand)

emitReturn

void emitReturn(JavaKind javaKind,
                Value input)

Emits a return instruction. Implementations need to insert a move if the input is not in the correct location.

asAllocatable

AllocatableValue asAllocatable(Value value)

Returns an AllocatableValue holding the value by moving it if necessary. If value is already an AllocatableValue, returns it unchanged.

addressAsAllocatableInteger

default AllocatableValue addressAsAllocatableInteger(Value value)

Returns an AllocatableValue of the address value with an integer representation.

append

<I extends LIRInstruction> I append(I op)

emitJump

void emitJump(LabelRef label)

emitConditionalMove

Variable emitConditionalMove(PlatformKind cmpKind,
                             Value leftVal,
                             Value right,
                             Condition cond,
                             boolean unorderedIsTrue,
                             Value trueValue,
                             Value falseValue)

emitIntegerTestMove

Variable emitIntegerTestMove(Value leftVal,
                             Value right,
                             Value trueValue,
                             Value falseValue)

emitByteSwap

Variable emitByteSwap(Value operand)

emitArrayCompareTo

default Variable emitArrayCompareTo(JavaKind kind1,
                                    JavaKind kind2,
                                    int array1BaseOffset,
                                    int array2BaseOffset,
                                    Value array1,
                                    Value array2,
                                    Value length1,
                                    Value length2)

emitArrayRegionCompareTo

default Variable emitArrayRegionCompareTo(Value arrayA,
                                          Value offsetA,
                                          Value arrayB,
                                          Value offsetB,
                                          Value length,
                                          Value stride)

emitArrayRegionCompareTo

default Variable emitArrayRegionCompareTo(JavaKind strideA,
                                          JavaKind strideB,
                                          Value arrayA,
                                          Value offsetA,
                                          Value arrayB,
                                          Value offsetB,
                                          Value length)

emitArrayEquals

default Variable emitArrayEquals(JavaKind kind,
                                 int array1BaseOffset,
                                 int array2BaseOffset,
                                 Value array1,
                                 Value array2,
                                 Value length)

emitArrayEquals

default Variable emitArrayEquals(int array1BaseOffset,
                                 int array2BaseOffset,
                                 Value array1,
                                 Value offset1,
                                 Value array2,
                                 Value offset2,
                                 Value length,
                                 Value stride)

emitArrayEquals

default Variable emitArrayEquals(JavaKind kind,
                                 int array1BaseOffset,
                                 int array2BaseOffset,
                                 Value array1,
                                 Value offset1,
                                 Value array2,
                                 Value offset2,
                                 Value length)

emitArrayEquals

default Variable emitArrayEquals(JavaKind kind1,
                                 JavaKind kind2,
                                 int array1BaseOffset,
                                 int array2BaseOffset,
                                 Value array1,
                                 Value offset1,
                                 Value array2,
                                 Value offset2,
                                 Value length)

emitArrayEquals

default Variable emitArrayEquals(int array1BaseOffset,
                                 int array2BaseOffset,
                                 int maskBaseOffset,
                                 Value array1,
                                 Value offset1,
                                 Value array2,
                                 Value offset2,
                                 Value mask,
                                 Value length,
                                 Value stride)

emitArrayEquals

default Variable emitArrayEquals(JavaKind kind1,
                                 JavaKind kind2,
                                 JavaKind kindMask,
                                 int array1BaseOffset,
                                 int array2BaseOffset,
                                 int maskBaseOffset,
                                 Value array1,
                                 Value offset1,
                                 Value array2,
                                 Value offset2,
                                 Value mask,
                                 Value length)

emitArrayCopyWithConversion

default void emitArrayCopyWithConversion(JavaKind strideSrc,
                                         JavaKind strideDst,
                                         Value arraySrc,
                                         Value offsetSrc,
                                         Value arrayDst,
                                         Value offsetDst,
                                         Value length)

emitArrayCopyWithConversion

default void emitArrayCopyWithConversion(Value arraySrc,
                                         Value offsetSrc,
                                         Value arrayDst,
                                         Value offsetDst,
                                         Value length,
                                         Value stride)

emitCalcStringAttributes

default Variable emitCalcStringAttributes(Object op,
                                          Value array,
                                          Value offset,
                                          Value length,
                                          boolean isValid)

emitArrayIndexOf

default Variable emitArrayIndexOf(int arrayBaseOffset,
                                  JavaKind valueKind,
                                  boolean findTwoConsecutive,
                                  boolean withMask,
                                  Value array,
                                  Value offset,
                                  Value length,
                                  Value fromIndex,
                                  Value... searchValues)

emitStringLatin1Inflate

default void emitStringLatin1Inflate(Value src,
                                     Value dst,
                                     Value len)

emitStringUTF16Compress

default Variable emitStringUTF16Compress(Value src,
                                         Value dst,
                                         Value len)

emitEncodeArray

default Variable emitEncodeArray(Value src,
                                 Value dst,
                                 Value length,
                                 LIRGeneratorTool.CharsetName charset)

emitHasNegatives

default Variable emitHasNegatives(Value array,
                                  Value length)

emitBlackhole

void emitBlackhole(Value operand)

getLIRKind

LIRKind getLIRKind(Stamp stamp)

emitPause

void emitPause()

emitPrefetchAllocate

void emitPrefetchAllocate(Value address)

emitCompress

Value emitCompress(Value pointer,
                   CompressEncoding encoding,
                   boolean nonNull)

emitUncompress

Value emitUncompress(Value pointer,
                     CompressEncoding encoding,
                     boolean nonNull)

emitConvertNullToZero

default void emitConvertNullToZero(AllocatableValue result,
                                   Value input)

emitConvertNullToZero

default void emitConvertNullToZero(AllocatableValue result,
                                   AllocatableValue input)

emitConvertZeroToNull

default void emitConvertZeroToNull(AllocatableValue result,
                                   Value input)

emitSpeculationFence

void emitSpeculationFence()

Emits an instruction that prevents speculative execution from proceeding: no instruction after this fence will execute until all previous instructions have retired.

allocateStackMemory

default VirtualStackSlot allocateStackMemory(int sizeInBytes,
                                             int alignmentInBytes)

emitTimeStampWithProcid

default Value emitTimeStampWithProcid()

emitReadCallerStackPointer

default Value emitReadCallerStackPointer(Stamp wordStamp)

emitReadReturnAddress

default Value emitReadReturnAddress(Stamp wordStamp,
                                    int returnAddressSize)

emitZeroMemory

default void emitZeroMemory(Value address,
                            Value length,
                            boolean isAligned)

emitCacheWriteback

void emitCacheWriteback(Value address)

Emits instruction(s) to flush an individual cache line that starts at address.

emitCacheWritebackSync

void emitCacheWritebackSync(boolean isPreSync)

Emits instruction(s) to serialize cache writeback operations relative to preceding (if isPreSync == true) or following (if isPreSync == false) memory writes.

getMaxVectorSize

default VectorSize getMaxVectorSize()

Returns the maximum size of vector registers.