com.oracle.svm.truffle.api

Class SubstrateOptimizedCallTarget

java.lang.Object

org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

com.oracle.svm.truffle.api.SubstrateOptimizedCallTarget

All Implemented Interfaces:

SubstrateInstalledCode.Factory, SubstrateCompilableTruffleAST, com.oracle.truffle.api.CallTarget, com.oracle.truffle.api.ReplaceObserver, com.oracle.truffle.api.RootCallTarget, org.graalvm.compiler.truffle.common.CompilableTruffleAST

public class SubstrateOptimizedCallTarget
extends org.graalvm.compiler.truffle.runtime.OptimizedCallTarget
implements SubstrateCompilableTruffleAST

Truffle call target which can be partially evaluated and compiled to machine code, which is then represented by SubstrateOptimizedCallTargetInstalledCode. At most one piece of code is valid as an entry point for new invocations at any given time, but arbitrarily many pieces of code for this call target can be alive at the same time (for example, from previous lower-tier compilations).

Assume that methods such as SubstrateOptimizedCallTarget.isValid() or SubstrateOptimizedCallTarget.getCodeAddress() return stale values because internal state can change at any safepoint. Consistent reads of such values require ensuring the absence of safepoint checks and preventing floating reads and read elimination.

Nested Class Summary

Nested classes/interfaces inherited from class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

org.graalvm.compiler.truffle.runtime.OptimizedCallTarget.ArgumentsProfile, org.graalvm.compiler.truffle.runtime.OptimizedCallTarget.ReturnProfile

Field Summary

Fields

Modifier and Type	Field and Description
protected SubstrateOptimizedCallTargetInstalledCode	installedCode Stores the most recently installed code, which is the only entry point for this call target at one point in time (or not an entry point, if invalid).

Fields inherited from class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

engine, id, initialized

Constructor Summary

Constructors

Constructor and Description
SubstrateOptimizedCallTarget(org.graalvm.compiler.truffle.runtime.OptimizedCallTarget sourceCallTarget, com.oracle.truffle.api.nodes.RootNode rootNode)

Method Summary

Modifier and Type	Method and Description
boolean	cancelCompilation(CharSequence reason)
protected SubstrateOptimizedCallTargetInstalledCode	createInitializationInstalledCode() Creates the instance for initializing SubstrateOptimizedCallTarget.installedCode so it is never null.
jdk.vm.ci.code.InstalledCode	createPreliminaryInstalledCode() Create a provisional InstalledCode object for code installation, as required by infrastructure, but this object does not need to be the same SubstrateInstalledCode object that is eventually installed in the code cache.
SubstrateOptimizedCallTargetInstalledCode	createSubstrateInstalledCode()
Object	doInvoke(Object[] args)
long	getCodeAddress()
jdk.vm.ci.meta.SpeculationLog	getCompilationSpeculationLog()
SubstrateSpeculationLog	getSpeculationLog()
Object	invokeCallBoundary(Object[] args)
boolean	isValid()
boolean	isValidLastTier()
protected void	onCodeCleared(SubstrateOptimizedCallTargetInstalledCode code) Called from SubstrateOptimizedCallTargetInstalledCode.clearAddress() for code representing this call target.
protected void	onCodeInstalled(SubstrateOptimizedCallTargetInstalledCode code) Called from SubstrateOptimizedCallTargetInstalledCode.setAddress(long, jdk.vm.ci.meta.ResolvedJavaMethod) for code representing this call target.
static void	safepointBarrier() Prevents reads from floating across a safepoint when the caller is inlined in another method.

Methods inherited from class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

accept, asJavaConstant, calculateNonTrivialNodes, call, callBoundary, callDirect, callIndirect, callInlined, callOSR, compile, compiledTier, computeBlockCompilations, createFrame, dequeueInlined, ensureInitialized, equals, firstTierCall, getCallAndLoopCount, getCallCount, getCallNodes, getCallSiteForSplit, getCompilerOptions, getDebugProperties, getInitializedArgumentsProfile, getInitializedReturnProfile, getInitializedTimestamp, getKnownCallSiteCount, getName, getNodeRewritingAssumptionConstant, getNonTrivialNodeCount, getOptionValue, getOptionValues, getRootNode, getSingleCallNode, getSourceCallTarget, getValidRootAssumptionConstant, hashCode, highestCompiledTier, injectArgumentsProfile, invalidate, isInitialized, isSameOrSplit, isSingleCaller, isSplit, isSubmittedForCompilation, isTrivial, log, maybeWaitForTask, needsCompile, nodeReplaced, onCompilationFailed, onInvalidate, prepareForAOT, profileArguments, profiledPERoot, resetCompilationProfile, resetNeedsSplit, runtime, shouldCompile, toString, waitForCompilation, wasExecuted

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graalvm.compiler.truffle.common.CompilableTruffleAST

asJavaConstant, dequeueInlined, getCallCount, getCallNodes, getKnownCallSiteCount, getName, getNodeRewritingAssumptionConstant, getNonTrivialNodeCount, getValidRootAssumptionConstant, isSameOrSplit, isTrivial, onCompilationFailed, serializeException

Field Detail

installedCode

protected SubstrateOptimizedCallTargetInstalledCode installedCode

Stores the most recently installed code, which is the only entry point for this call target at one point in time (or not an entry point, if invalid). Must never be null.

Does not need to be volatile because it is modified only in safepoint operations. Reads of this field must be done carefully so they cannot float across safepoint checks.

Constructor Detail

SubstrateOptimizedCallTarget

public SubstrateOptimizedCallTarget(org.graalvm.compiler.truffle.runtime.OptimizedCallTarget sourceCallTarget,
                                    com.oracle.truffle.api.nodes.RootNode rootNode)

Method Detail

getSpeculationLog

public SubstrateSpeculationLog getSpeculationLog()

Overrides:

getSpeculationLog in class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

getCompilationSpeculationLog

public jdk.vm.ci.meta.SpeculationLog getCompilationSpeculationLog()

Specified by:

getCompilationSpeculationLog in interface org.graalvm.compiler.truffle.common.CompilableTruffleAST

isValid

public boolean isValid()

Specified by:

isValid in class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

isValidLastTier

public boolean isValidLastTier()

Specified by:

isValidLastTier in class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

getCodeAddress

public long getCodeAddress()

Specified by:

getCodeAddress in class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

safepointBarrier

public static void safepointBarrier()

Prevents reads from floating across a safepoint when the caller is inlined in another method. Intrinsified in SubstrateTruffleGraphBuilderPlugins.

doInvoke

public Object doInvoke(Object[] args)

Overrides:

doInvoke in class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

cancelCompilation

public boolean cancelCompilation(CharSequence reason)

Specified by:

cancelCompilation in interface org.graalvm.compiler.truffle.common.CompilableTruffleAST

Overrides:

cancelCompilation in class org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

createPreliminaryInstalledCode

public jdk.vm.ci.code.InstalledCode createPreliminaryInstalledCode()

Description copied from interface: SubstrateCompilableTruffleAST

Create a provisional InstalledCode object for code installation, as required by infrastructure, but this object does not need to be the same SubstrateInstalledCode object that is eventually installed in the code cache. Once the provisional object is passed to SubstrateCodeCacheProvider, it creates the final SubstrateInstalledCode object and invokes SubstrateInstalledCode.setAddress(long, jdk.vm.ci.meta.ResolvedJavaMethod) on it.

Specified by:

createPreliminaryInstalledCode in interface SubstrateCompilableTruffleAST

See Also:

SubstrateCodeCacheProvider

invokeCallBoundary

public Object invokeCallBoundary(Object[] args)

createSubstrateInstalledCode

public SubstrateOptimizedCallTargetInstalledCode createSubstrateInstalledCode()

Specified by:

createSubstrateInstalledCode in interface SubstrateInstalledCode.Factory

onCodeInstalled

protected void onCodeInstalled(SubstrateOptimizedCallTargetInstalledCode code)

Called from SubstrateOptimizedCallTargetInstalledCode.setAddress(long, jdk.vm.ci.meta.ResolvedJavaMethod) for code representing this call target.

onCodeCleared

protected void onCodeCleared(SubstrateOptimizedCallTargetInstalledCode code)

Called from SubstrateOptimizedCallTargetInstalledCode.clearAddress() for code representing this call target. The caller can, however, be older code and not the current entry point, so that code != installedCode.

createInitializationInstalledCode

protected SubstrateOptimizedCallTargetInstalledCode createInitializationInstalledCode()

Creates the instance for initializing SubstrateOptimizedCallTarget.installedCode so it is never null.