OptimizedCallTarget

java.lang.Object
- org.graalvm.compiler.truffle.runtime.OptimizedCallTarget

All Implemented Interfaces:: com.oracle.truffle.api.CallTarget, com.oracle.truffle.api.ReplaceObserver, com.oracle.truffle.api.RootCallTarget, CompilableTruffleAST

Direct Known Subclasses:: HotSpotOptimizedCallTarget

public abstract class OptimizedCallTarget
extends Object
implements CompilableTruffleAST, com.oracle.truffle.api.RootCallTarget, com.oracle.truffle.api.ReplaceObserver

Call target that is optimized by Graal upon surpassing a specific invocation threshold. That is, this is a Truffle AST that can be optimized via partial evaluation and compiled to machine code. Note: PartialEvaluator looks up this class and a number of its methods by name. The end-goal of executing a OptimizedCallTarget is executing its root node. The following call-graph shows all the paths that can be taken from calling a call target (through all the public call* methods) to the execution of the root node depending on the type of call.

              GraalRuntimeSupport#callProfiled                    GraalRuntimeSupport#callInlined
                                |                                               |
                                |                                               V
  PUBLIC   call -> callIndirect | callOSR   callDirect <================> callInlined
                           |  +-+    |           |             ^                |
                           |  |  +---+           |     substituted by the       |
                           V  V  V               |     compiler if inlined      |
  PROTECTED               doInvoke <-------------+                              |
                             |                                                  |
                             | <= Jump to installed code                        |
                             V                                                  |
  PROTECTED              callBoundary                                           |
                             |                                                  |
                             | <= Tail jump to installed code in Int.           |
                             V                                                  |
  PROTECTED           profiledPERoot                                            |
                             |                                                  |
  PRIVATE                    +----------> executeRootNode <---------------------+
                                                 |
                                                 V
                                         rootNode.execute()

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OptimizedCallTarget.ArgumentsProfile

static class OptimizedCallTarget.ReturnProfile

Nested Classes
Modifier and Type	Class and Description
`static class`	`OptimizedCallTarget.ArgumentsProfile`
`static class`	`OptimizedCallTarget.ReturnProfile`

Field Summary

Fields
Modifier and Type	Field and Description
`EngineData`	`engine` The engine data associated with this call target.
`int`	`id`
`protected boolean`	`initialized` Whether this call target was cloned, compiled or called.
`protected SpeculationLog`	`speculationLog` The speculation log to keep track of assumptions taken and failed for previous compilations.

Constructor Summary

Constructors
Modifier Constructor and Description

protected OptimizedCallTarget(OptimizedCallTarget sourceCallTarget, com.oracle.truffle.api.nodes.RootNode rootNode)

Constructors
Modifier	Constructor and Description
`protected`	`OptimizedCallTarget(OptimizedCallTarget sourceCallTarget, com.oracle.truffle.api.nodes.RootNode rootNode)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(com.oracle.truffle.api.nodes.NodeVisitor visitor)`
`JavaConstant`	`asJavaConstant()` Gets this AST as a compiler constant.
`static int`	`calculateNonTrivialNodes(com.oracle.truffle.api.nodes.Node node)`
`Object`	`call(Object... args)`
`protected Object`	`callBoundary(Object[] args)`
`Object`	`callDirect(com.oracle.truffle.api.nodes.Node location, Object... args)` In compiled code, this is only used if the callee is not inlined.
`Object`	`callIndirect(com.oracle.truffle.api.nodes.Node location, Object... args)`
`Object`	`callInlined(com.oracle.truffle.api.nodes.Node location, Object... arguments)`
`Object`	`callOSR(Object... args)`
`boolean`	`cancelCompilation(CharSequence reason)` Cancel the compilation of this truffle ast.
`boolean`	`compile(boolean lastTierCompilation)` Returns `true` if the call target was already compiled or was compiled synchronously.
`void`	`compiledTier(int tier)`
`boolean`	`computeBlockCompilations()` Computes block compilation using `BlockNode` APIs.
`static com.oracle.truffle.api.frame.VirtualFrame`	`createFrame(com.oracle.truffle.api.frame.FrameDescriptor descriptor, Object[] args)` Intrinsifiable compiler directive for creating a frame.
`void`	`dequeueInlined()` We intentionally do not synchronize here since as it's not worth the sync costs.
`protected Object`	`doInvoke(Object[] args)` Overridden by SVM.
`void`	`ensureInitialized()`
`boolean`	`equals(Object obj)`
`boolean`	`firstTierCall()`
`int`	`getCallAndLoopCount()`
`int`	`getCallCount()` Return the total number of calls to this target.
`TruffleCallNode[]`	`getCallNodes()` Returns the list of call nodes in this AST.
`OptimizedDirectCallNode`	`getCallSiteForSplit()`
`abstract long`	`getCodeAddress()` Gets the address of the machine code for this call target.
`Map<String,Object>`	`getDebugProperties()`
`protected OptimizedCallTarget.ArgumentsProfile`	`getInitializedArgumentsProfile()`
`protected OptimizedCallTarget.ReturnProfile`	`getInitializedReturnProfile()`
`long`	`getInitializedTimestamp()`
`int`	`getKnownCallSiteCount()`
`String`	`getName()` Gets a descriptive name for this call target.
`JavaConstant`	`getNodeRewritingAssumptionConstant()`
`int`	`getNonTrivialNodeCount()` Returns the estimate of the Truffle node count in this AST.
`<T> T`	`getOptionValue(org.graalvm.options.OptionKey<T> key)`
`org.graalvm.options.OptionValues`	`getOptionValues()`
`com.oracle.truffle.api.nodes.RootNode`	`getRootNode()`
`OptimizedDirectCallNode`	`getSingleCallNode()`
`OptimizedCallTarget`	`getSourceCallTarget()`
`SpeculationLog`	`getSpeculationLog()` Gets the speculation log used to collect all failed speculations in the compiled code for this call target.
`JavaConstant`	`getValidRootAssumptionConstant()`
`int`	`hashCode()`
`int`	`highestCompiledTier()`
`Object[]`	`injectArgumentsProfile(Object[] originalArguments)`
`boolean`	`invalidate(CharSequence reason)` Invalidates this call target by invalidating any machine code attached to it.
`boolean`	`isInitialized()`
`boolean`	`isSameOrSplit(CompilableTruffleAST ast)`
`boolean`	`isSingleCaller()`
`boolean`	`isSourceCallTarget()`
`boolean`	`isSplit()`
`boolean`	`isSubmittedForCompilation()`
`boolean`	`isTrivial()`
`abstract boolean`	`isValid()` Determines if this call target has valid machine code that can be entered attached to it.
`abstract boolean`	`isValidLastTier()` Determines if this call target has valid machine code attached to it, and that this code was compiled in the last tier.
`void`	`log(String message)`
`boolean`	`maybeWaitForTask(CompilationTask task)`
`boolean`	`needsCompile(boolean isLastTierCompilation)`
`boolean`	`nodeReplaced(com.oracle.truffle.api.nodes.Node oldNode, com.oracle.truffle.api.nodes.Node newNode, CharSequence reason)`
`void`	`onCompilationFailed(Supplier<String> serializedException, boolean silent, boolean bailout, boolean permanentBailout, boolean graphTooBig)` Notifies this object that a compilation of the AST it represents failed.
`boolean`	`onInvalidate(Object source, CharSequence reason, boolean wasActive)`
`boolean`	`prepareForAOT()`
`void`	`profileArguments(Object[] args)`
`protected Object`	`profiledPERoot(Object[] originalArguments)`
`void`	`resetCompilationProfile()`
`void`	`resetNeedsSplit()`
`protected static GraalTruffleRuntime`	`runtime()`
`boolean`	`shouldCompile()`
`String`	`toString()`
`void`	`waitForCompilation()`
`boolean`	`wasExecuted()`

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graalvm.compiler.truffle.common.CompilableTruffleAST
getCompilationSpeculationLog, serializeException

- Field Detail
  - initialized
```
protected volatile boolean initialized
```
    Whether this call target was cloned, compiled or called.
  - engine
```
public final EngineData engine
```
    The engine data associated with this call target. Used to cache option lookups and to gather engine specific statistics.
  - speculationLog
```
protected volatile SpeculationLog speculationLog
```
    The speculation log to keep track of assumptions taken and failed for previous compilations.
  - id
```
public final int id
```
- Constructor Detail
  - OptimizedCallTarget
```
protected OptimizedCallTarget(OptimizedCallTarget sourceCallTarget,
                              com.oracle.truffle.api.nodes.RootNode rootNode)
```
- Method Detail
  - compiledTier
```
public void compiledTier(int tier)
```
  - highestCompiledTier
```
public int highestCompiledTier()
```
  - getNodeRewritingAssumptionConstant
```
public JavaConstant getNodeRewritingAssumptionConstant()
```
    Specified by:
    
    getNodeRewritingAssumptionConstant in interface CompilableTruffleAST
    
    Returns:
    
    A JavaConstant representing the assumption that the nodes of the AST were not rewritten.
  - getValidRootAssumptionConstant
```
public JavaConstant getValidRootAssumptionConstant()
```
    Specified by:
    
    getValidRootAssumptionConstant in interface CompilableTruffleAST
    
    Returns:
    
    A JavaConstant representing the assumption that the compiled code of the AST was not invalidated.
  - isTrivial
```
public boolean isTrivial()
```
    Specified by:
    
    isTrivial in interface CompilableTruffleAST
    
    Returns:
    
    true is the root nodes of this AST trivial, false otherwise.
  - dequeueInlined
```
public void dequeueInlined()
```
    We intentionally do not synchronize here since as it's not worth the sync costs.
    
    Specified by:
    
    dequeueInlined in interface CompilableTruffleAST
  - getRootNode
```
public final com.oracle.truffle.api.nodes.RootNode getRootNode()
```
    Specified by:
    
    getRootNode in interface com.oracle.truffle.api.RootCallTarget
  - resetCompilationProfile
```
public final void resetCompilationProfile()
```
  - call
```
public final Object call(Object... args)
```
    Specified by:
    
    call in interface com.oracle.truffle.api.CallTarget
  - callIndirect
```
public Object callIndirect(com.oracle.truffle.api.nodes.Node location,
                           Object... args)
```
  - callDirect
```
public final Object callDirect(com.oracle.truffle.api.nodes.Node location,
                               Object... args)
```
    In compiled code, this is only used if the callee is not inlined. If the callee is inlined, OptimizedCallTarget.callInlined(Node, Object...) is used instead, which does not profile arguments, as it is estimated redundant. See the docs of OptimizedCallTarget.
  - callInlined
```
public final Object callInlined(com.oracle.truffle.api.nodes.Node location,
                                Object... arguments)
```
  - callOSR
```
public final Object callOSR(Object... args)
```
  - doInvoke
```
protected Object doInvoke(Object[] args)
```
    Overridden by SVM.
  - callBoundary
```
protected final Object callBoundary(Object[] args)
```
  - shouldCompile
```
public final boolean shouldCompile()
```
  - wasExecuted
```
public final boolean wasExecuted()
```
  - profiledPERoot
```
protected final Object profiledPERoot(Object[] originalArguments)
```
  - firstTierCall
```
public final boolean firstTierCall()
```
  - runtime
```
protected static GraalTruffleRuntime runtime()
```
  - ensureInitialized
```
public final void ensureInitialized()
```
  - isInitialized
```
public final boolean isInitialized()
```
  - getOptionValues
```
public final org.graalvm.options.OptionValues getOptionValues()
```
  - getOptionValue
```
public final <T> T getOptionValue(org.graalvm.options.OptionKey<T> key)
```
  - compile
```
public final boolean compile(boolean lastTierCompilation)
```
    Returns true if the call target was already compiled or was compiled synchronously. Returns false if compilation was not scheduled or is happening in the background. Use OptimizedCallTarget.isSubmittedForCompilation() to find out whether it is submitted for compilation.
  - maybeWaitForTask
```
public final boolean maybeWaitForTask(CompilationTask task)
```
  - needsCompile
```
public final boolean needsCompile(boolean isLastTierCompilation)
```
  - isSubmittedForCompilation
```
public final boolean isSubmittedForCompilation()
```
  - waitForCompilation
```
public final void waitForCompilation()
```
  - getCodeAddress
```
public abstract long getCodeAddress()
```
    Gets the address of the machine code for this call target. A non-zero return value denotes the contiguous memory block containing the machine code but does not necessarily represent an entry point for the machine code or even the address of executable instructions. This value is only for informational purposes (e.g., use in a log message).
  - isValid
```
public abstract boolean isValid()
```
    Determines if this call target has valid machine code that can be entered attached to it.
  - isValidLastTier
```
public abstract boolean isValidLastTier()
```
    Determines if this call target has valid machine code attached to it, and that this code was compiled in the last tier.
  - invalidate
```
public final boolean invalidate(CharSequence reason)
```
    Invalidates this call target by invalidating any machine code attached to it.
    
    Parameters:
    
    reason - a textual description of the reason why the machine code was invalidated. May be null.
    
    Returns:
    
    imprecise: whether code has possibly been invalidated or a compilation has been cancelled. Returns false only if both are guaranteed to not have happened, true otherwise.
  - getSpeculationLog
```
public SpeculationLog getSpeculationLog()
```
    Gets the speculation log used to collect all failed speculations in the compiled code for this call target. Note that this may differ from the speculation log used for compilation.
  - asJavaConstant
```
public final JavaConstant asJavaConstant()
```
    Description copied from interface: CompilableTruffleAST
    
    Gets this AST as a compiler constant.
    
    Specified by:
    
    asJavaConstant in interface CompilableTruffleAST
  - isSameOrSplit
```
public final boolean isSameOrSplit(CompilableTruffleAST ast)
```
    Specified by:
    
    isSameOrSplit in interface CompilableTruffleAST
    
    Parameters:
    
    ast - the ast to compare to
    
    Returns:
    
    true if this ast and the argument are the same, one is a split of the other or they are both splits of the same ast. False otherwise.
  - cancelCompilation
```
public boolean cancelCompilation(CharSequence reason)
```
    Description copied from interface: CompilableTruffleAST
    
    Cancel the compilation of this truffle ast.
    
    Specified by:
    
    cancelCompilation in interface CompilableTruffleAST
  - computeBlockCompilations
```
public final boolean computeBlockCompilations()
```
    Computes block compilation using BlockNode APIs. If no block node is used in the AST or block node compilation is disabled then this method always returns false.
  - onInvalidate
```
public final boolean onInvalidate(Object source,
                                  CharSequence reason,
                                  boolean wasActive)
```
  - onCompilationFailed
```
public final void onCompilationFailed(Supplier<String> serializedException,
                                      boolean silent,
                                      boolean bailout,
                                      boolean permanentBailout,
                                      boolean graphTooBig)
```
    Description copied from interface: CompilableTruffleAST
    
    Notifies this object that a compilation of the AST it represents failed.
    
    Specified by:
    
    onCompilationFailed in interface CompilableTruffleAST
    
    Parameters:
    
    serializedException - serializedException a serialized representation of the exception representing the reason for compilation failure. See CompilableTruffleAST.serializeException(Throwable).
    
    silent - specifies whether the failure was suppressed and should be silent. Use the TruffleCompilerRuntime.isSuppressedFailure(CompilableTruffleAST, Supplier) to determine if the failure should be suppressed.
    
    bailout - specifies whether the failure was a bailout or an error in the compiler. A bailout means the compiler aborted the compilation based on some of property of the AST (e.g., too big). A non-bailout means an unexpected error in the compiler itself.
    
    permanentBailout - specifies if a bailout is due to a condition that probably won't change if this AST is compiled again. This value is meaningless if bailout == false.
    
    graphTooBig - graph was too big
  - log
```
public final void log(String message)
```
  - getKnownCallSiteCount
```
public final int getKnownCallSiteCount()
```
    Specified by:
    
    getKnownCallSiteCount in interface CompilableTruffleAST
    
    Returns:
    
    How many direct callers is this ast known to have.
  - getSourceCallTarget
```
public final OptimizedCallTarget getSourceCallTarget()
```
  - getName
```
public final String getName()
```
    Description copied from interface: CompilableTruffleAST
    
    Gets a descriptive name for this call target.
    
    Specified by:
    
    getName in interface CompilableTruffleAST
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - createFrame
```
public static com.oracle.truffle.api.frame.VirtualFrame createFrame(com.oracle.truffle.api.frame.FrameDescriptor descriptor,
                                                                    Object[] args)
```
    Intrinsifiable compiler directive for creating a frame.
  - nodeReplaced
```
public final boolean nodeReplaced(com.oracle.truffle.api.nodes.Node oldNode,
                                  com.oracle.truffle.api.nodes.Node newNode,
                                  CharSequence reason)
```
    Specified by:
    
    nodeReplaced in interface com.oracle.truffle.api.ReplaceObserver
  - accept
```
public final void accept(com.oracle.truffle.api.nodes.NodeVisitor visitor)
```
  - getNonTrivialNodeCount
```
public final int getNonTrivialNodeCount()
```
    Description copied from interface: CompilableTruffleAST
    
    Returns the estimate of the Truffle node count in this AST.
    
    Specified by:
    
    getNonTrivialNodeCount in interface CompilableTruffleAST
  - getCallCount
```
public final int getCallCount()
```
    Description copied from interface: CompilableTruffleAST
    
    Return the total number of calls to this target.
    
    Specified by:
    
    getCallCount in interface CompilableTruffleAST
  - getCallAndLoopCount
```
public final int getCallAndLoopCount()
```
  - getInitializedTimestamp
```
public final long getInitializedTimestamp()
```
  - calculateNonTrivialNodes
```
public static int calculateNonTrivialNodes(com.oracle.truffle.api.nodes.Node node)
```
  - getDebugProperties
```
public final Map<String,Object> getDebugProperties()
```
  - getCallNodes
```
public final TruffleCallNode[] getCallNodes()
```
    Description copied from interface: CompilableTruffleAST
    
    Returns the list of call nodes in this AST.
    
    Specified by:
    
    getCallNodes in interface CompilableTruffleAST
  - profileArguments
```
public final void profileArguments(Object[] args)
```
  - injectArgumentsProfile
```
public final Object[] injectArgumentsProfile(Object[] originalArguments)
```
  - getInitializedArgumentsProfile
```
protected final OptimizedCallTarget.ArgumentsProfile getInitializedArgumentsProfile()
```
  - getInitializedReturnProfile
```
protected final OptimizedCallTarget.ReturnProfile getInitializedReturnProfile()
```
  - isSourceCallTarget
```
public final boolean isSourceCallTarget()
```
  - isSplit
```
public final boolean isSplit()
```
  - getCallSiteForSplit
```
public final OptimizedDirectCallNode getCallSiteForSplit()
```
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isSingleCaller
```
public final boolean isSingleCaller()
```
  - getSingleCallNode
```
public final OptimizedDirectCallNode getSingleCallNode()
```
  - resetNeedsSplit
```
public final void resetNeedsSplit()
```
  - prepareForAOT
```
public final boolean prepareForAOT()
```

Class OptimizedCallTarget

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

initialized

engine

speculationLog

id

Constructor Detail

OptimizedCallTarget

Method Detail

compiledTier

highestCompiledTier

getNodeRewritingAssumptionConstant

getValidRootAssumptionConstant

isTrivial

dequeueInlined

getRootNode

resetCompilationProfile

call

callIndirect

callDirect

callInlined

callOSR

doInvoke

callBoundary

shouldCompile

wasExecuted

profiledPERoot

firstTierCall

runtime

ensureInitialized

isInitialized

getOptionValues

getOptionValue

compile

maybeWaitForTask

needsCompile

isSubmittedForCompilation

waitForCompilation

getCodeAddress

isValid

isValidLastTier

invalidate

getSpeculationLog

asJavaConstant

isSameOrSplit

cancelCompilation

computeBlockCompilations

onInvalidate

onCompilationFailed

log

getKnownCallSiteCount

getSourceCallTarget

getName

toString

createFrame

nodeReplaced

accept

getNonTrivialNodeCount

getCallCount

getCallAndLoopCount

getInitializedTimestamp

calculateNonTrivialNodes

getDebugProperties

getCallNodes

profileArguments

injectArgumentsProfile

getInitializedArgumentsProfile

getInitializedReturnProfile

isSourceCallTarget

isSplit

getCallSiteForSplit

equals

hashCode

isSingleCaller