org.graalvm.compiler.lir.asm

Class CompilationResultBuilder

java.lang.Object

org.graalvm.compiler.lir.asm.CompilationResultBuilder

Direct Known Subclasses:

TruffleCallBoundaryInstrumentation

public class CompilationResultBuilder
extends Object

Fills in a CompilationResult as its code is being assembled.

See Also:

CompilationResultBuilderFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompilationResultBuilder.Options
static class	CompilationResultBuilder.PendingImplicitException

Field Summary

Fields

Modifier and Type	Field and Description
Assembler	asm
CodeCacheProvider	codeCache
CompilationResult	compilationResult
protected int	currentBlockIndex The index of the block currently being emitted.
DataBuilder	dataBuilder
ForeignCallsProvider	foreignCalls
FrameContext	frameContext The object that emits code for managing a method's frame.
FrameMap	frameMap
protected LIR	lir The LIR for which code is being generated.
CodeGenProviders	providers
TargetDescription	target
Register	uncompressedNullRegister

Constructor Summary

Constructors

Constructor and Description
CompilationResultBuilder(CodeGenProviders providers, FrameMap frameMap, Assembler asm, DataBuilder dataBuilder, FrameContext frameContext, OptionValues options, DebugContext debug, CompilationResult compilationResult, Register uncompressedNullRegister)
CompilationResultBuilder(CodeGenProviders providers, FrameMap frameMap, Assembler asm, DataBuilder dataBuilder, FrameContext frameContext, OptionValues options, DebugContext debug, CompilationResult compilationResult, Register uncompressedNullRegister, org.graalvm.collections.EconomicMap<Constant,DataSection.Data> dataCache)

Method Summary

Modifier and Type	Method and Description
AbstractAddress	asAddress(Value value)
AbstractAddress	asByteAddr(Value value)
AbstractAddress	asDoubleAddr(Value value)
double	asDoubleConst(Value value) Returns the double value of any constant that can be represented by a 64-bit float value.
AbstractAddress	asDoubleConstRef(JavaConstant value) Returns the address of a double constant that is embedded as a data reference into the code.
AbstractAddress	asDoubleConstRef(JavaConstant value, int alignment)
AbstractAddress	asFloatAddr(Value value)
float	asFloatConst(Value value) Returns the float value of any constant that can be represented by a 32-bit float value.
AbstractAddress	asFloatConstRef(JavaConstant value) Returns the address of a float constant that is embedded as a data reference into the code.
AbstractAddress	asFloatConstRef(JavaConstant value, int alignment)
AbstractAddress	asIntAddr(Value value)
int	asIntConst(Value value) Returns the integer value of any constant that can be represented by a 32-bit integer value, including long constants that fit into the 32-bit range.
AbstractAddress	asLongAddr(Value value)
long	asLongConst(Value value) Returns the long value of any constant that can be represented by a 64-bit long value.
AbstractAddress	asLongConstRef(JavaConstant value) Returns the address of a long constant that is embedded as a data reference into the code.
AbstractAddress	asObjectConstRef(JavaConstant value) Returns the address of an object constant that is embedded as a data reference into the code.
AbstractAddress	asShortAddr(Value value)
void	blockComment(String s)
void	buildLabelOffsets(LIR generatedLIR) Builds up a map for label and LIR instruction positions where labels are or labels pointing to.
protected void	closeCompilationResult() Calls CompilationResult.close(OptionValues) on CompilationResultBuilder.compilationResult.
DataSection.Data	createDataItem(Constant constant)
void	emit(LIR lir) Emits code for lir in its code emitting order.
void	finish() Sets the code and exception handler fields of the compilation result and then closes it.
int	getLastImplicitExceptionOffset()
LIR	getLIR()
OptionValues	getOptions()
List<CompilationResultBuilder.PendingImplicitException>	getPendingImplicitExceptionList()
boolean	hasImplicitException(int pcOffset)
boolean	isSuccessorEdge(LabelRef edge) Determines if a given edge from the block currently being emitted goes to its lexical successor.
boolean	labelWithinLIRRange(LIRInstruction instruction, Label label, int maxLIRDistance) Determines whether the distance from the LIR instruction to the label is within maxLIRDistance LIR instructions.
boolean	mustReplaceWithUncompressedNullRegister(JavaConstant nullConstant)
boolean	needsClearUpperVectorRegisters()
boolean	needsMHDeoptHandler()
AbstractAddress	recordDataReferenceInCode(Constant constant, int alignment)
AbstractAddress	recordDataReferenceInCode(DataPointerConstant constant)
AbstractAddress	recordDataSectionReference(DataSection.Data data)
Call	recordDirectCall(int posBefore, int posAfter, InvokeTarget callTarget, LIRFrameState info)
void	recordExceptionHandlers(int pcOffset, LIRFrameState info)
void	recordImplicitException(int pcOffset, int dispatchOffset, LIRFrameState info)
void	recordImplicitException(int pcOffset, LIRFrameState info)
void	recordIndirectCall(int posBefore, int posAfter, InvokeTarget callTarget, LIRFrameState info)
void	recordInfopoint(int pos, DebugInfo debugInfo, InfopointReason reason)
void	recordInfopoint(int pos, LIRFrameState info, InfopointReason reason)
void	recordInlineDataInCode(Constant data)
void	recordInlineDataInCodeWithNote(Constant data, Object note)
CompilationResult.CodeMark	recordMark(CompilationResult.MarkId markId) Associates markId with the current assembler position in the compilation result.
CompilationResult.CodeMark	recordMark(int codePos, CompilationResult.MarkId markId) Associates markId with position codePos in the compilation result.
void	recordSourceMapping(int pcOffset, int endPcOffset, NodeSourcePosition sourcePosition)
void	resetForEmittingCode()
void	setConservativeLabelRanges() Sets this CompilationResultBuilder into conservative mode.
void	setMaxInterpreterFrameSize(int maxInterpreterFrameSize)
void	setNeedsMHDeoptHandler()
void	setTotalFrameSize(int frameSize)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

asm

public final Assembler asm

dataBuilder

public final DataBuilder dataBuilder

compilationResult

public final CompilationResult compilationResult

uncompressedNullRegister

public final Register uncompressedNullRegister

target

public final TargetDescription target

providers

public final CodeGenProviders providers

codeCache

public final CodeCacheProvider codeCache

foreignCalls

public final ForeignCallsProvider foreignCalls

frameMap

public final FrameMap frameMap

lir

protected LIR lir

The LIR for which code is being generated.

currentBlockIndex

protected int currentBlockIndex

The index of the block currently being emitted.

frameContext

public final FrameContext frameContext

The object that emits code for managing a method's frame.

Constructor Detail

CompilationResultBuilder

public CompilationResultBuilder(CodeGenProviders providers,
                                FrameMap frameMap,
                                Assembler asm,
                                DataBuilder dataBuilder,
                                FrameContext frameContext,
                                OptionValues options,
                                DebugContext debug,
                                CompilationResult compilationResult,
                                Register uncompressedNullRegister)

CompilationResultBuilder

public CompilationResultBuilder(CodeGenProviders providers,
                                FrameMap frameMap,
                                Assembler asm,
                                DataBuilder dataBuilder,
                                FrameContext frameContext,
                                OptionValues options,
                                DebugContext debug,
                                CompilationResult compilationResult,
                                Register uncompressedNullRegister,
                                org.graalvm.collections.EconomicMap<Constant,DataSection.Data> dataCache)

Method Detail

mustReplaceWithUncompressedNullRegister

public final boolean mustReplaceWithUncompressedNullRegister(JavaConstant nullConstant)

setTotalFrameSize

public void setTotalFrameSize(int frameSize)

setMaxInterpreterFrameSize

public void setMaxInterpreterFrameSize(int maxInterpreterFrameSize)

recordMark

public CompilationResult.CodeMark recordMark(int codePos,
                                             CompilationResult.MarkId markId)

Associates markId with position codePos in the compilation result.

Returns:

the recorded entry for the mark

recordMark

public CompilationResult.CodeMark recordMark(CompilationResult.MarkId markId)

Associates markId with the current assembler position in the compilation result.

Returns:

the recorded entry for the mark

blockComment

public void blockComment(String s)

finish

public void finish()

Sets the code and exception handler fields of the compilation result and then closes it.

closeCompilationResult

protected void closeCompilationResult()

Calls CompilationResult.close(OptionValues) on CompilationResultBuilder.compilationResult.

recordExceptionHandlers

public void recordExceptionHandlers(int pcOffset,
                                    LIRFrameState info)

recordImplicitException

public void recordImplicitException(int pcOffset,
                                    LIRFrameState info)

recordImplicitException

public void recordImplicitException(int pcOffset,
                                    int dispatchOffset,
                                    LIRFrameState info)

getLastImplicitExceptionOffset

public int getLastImplicitExceptionOffset()

hasImplicitException

public boolean hasImplicitException(int pcOffset)

recordDirectCall

public Call recordDirectCall(int posBefore,
                             int posAfter,
                             InvokeTarget callTarget,
                             LIRFrameState info)

recordIndirectCall

public void recordIndirectCall(int posBefore,
                               int posAfter,
                               InvokeTarget callTarget,
                               LIRFrameState info)

recordInfopoint

public void recordInfopoint(int pos,
                            LIRFrameState info,
                            InfopointReason reason)

recordInfopoint

public void recordInfopoint(int pos,
                            DebugInfo debugInfo,
                            InfopointReason reason)

recordSourceMapping

public void recordSourceMapping(int pcOffset,
                                int endPcOffset,
                                NodeSourcePosition sourcePosition)

recordInlineDataInCode

public void recordInlineDataInCode(Constant data)

recordInlineDataInCodeWithNote

public void recordInlineDataInCodeWithNote(Constant data,
                                           Object note)

recordDataSectionReference

public AbstractAddress recordDataSectionReference(DataSection.Data data)

recordDataReferenceInCode

public AbstractAddress recordDataReferenceInCode(DataPointerConstant constant)

recordDataReferenceInCode

public AbstractAddress recordDataReferenceInCode(Constant constant,
                                                 int alignment)

createDataItem

public DataSection.Data createDataItem(Constant constant)

asIntConst

public int asIntConst(Value value)

Returns the integer value of any constant that can be represented by a 32-bit integer value, including long constants that fit into the 32-bit range.

asFloatConst

public float asFloatConst(Value value)

Returns the float value of any constant that can be represented by a 32-bit float value.

asLongConst

public long asLongConst(Value value)

Returns the long value of any constant that can be represented by a 64-bit long value.

asDoubleConst

public double asDoubleConst(Value value)

Returns the double value of any constant that can be represented by a 64-bit float value.

asFloatConstRef

public AbstractAddress asFloatConstRef(JavaConstant value)

Returns the address of a float constant that is embedded as a data reference into the code.

asFloatConstRef

public AbstractAddress asFloatConstRef(JavaConstant value,
                                       int alignment)

asDoubleConstRef

public AbstractAddress asDoubleConstRef(JavaConstant value)

Returns the address of a double constant that is embedded as a data reference into the code.

asDoubleConstRef

public AbstractAddress asDoubleConstRef(JavaConstant value,
                                        int alignment)

asLongConstRef

public AbstractAddress asLongConstRef(JavaConstant value)

Returns the address of a long constant that is embedded as a data reference into the code.

asObjectConstRef

public AbstractAddress asObjectConstRef(JavaConstant value)

Returns the address of an object constant that is embedded as a data reference into the code.

asByteAddr

public AbstractAddress asByteAddr(Value value)

asShortAddr

public AbstractAddress asShortAddr(Value value)

asIntAddr

public AbstractAddress asIntAddr(Value value)

asLongAddr

public AbstractAddress asLongAddr(Value value)

asFloatAddr

public AbstractAddress asFloatAddr(Value value)

asDoubleAddr

public AbstractAddress asDoubleAddr(Value value)

asAddress

public AbstractAddress asAddress(Value value)

isSuccessorEdge

public boolean isSuccessorEdge(LabelRef edge)

Determines if a given edge from the block currently being emitted goes to its lexical successor.

emit

public void emit(LIR lir)

Emits code for lir in its code emitting order.

getLIR

public LIR getLIR()

resetForEmittingCode

public void resetForEmittingCode()

getOptions

public OptionValues getOptions()

buildLabelOffsets

public void buildLabelOffsets(LIR generatedLIR)

Builds up a map for label and LIR instruction positions where labels are or labels pointing to.

labelWithinLIRRange

public boolean labelWithinLIRRange(LIRInstruction instruction,
                                   Label label,
                                   int maxLIRDistance)

Determines whether the distance from the LIR instruction to the label is within maxLIRDistance LIR instructions.

Parameters:

maxLIRDistance - Maximum number of LIR instructions between label and instruction

setConservativeLabelRanges

public void setConservativeLabelRanges()

Sets this CompilationResultBuilder into conservative mode. If set, CompilationResultBuilder.labelWithinLIRRange(LIRInstruction, Label, int) always returns false.

needsClearUpperVectorRegisters

public final boolean needsClearUpperVectorRegisters()

setNeedsMHDeoptHandler

public void setNeedsMHDeoptHandler()

needsMHDeoptHandler

public boolean needsMHDeoptHandler()

getPendingImplicitExceptionList

public List<CompilationResultBuilder.PendingImplicitException> getPendingImplicitExceptionList()