GraphBuilderContext (Graal OpenJDK Project Documentation)

All Known Implementing Classes:

BytecodeParser, IntrinsicGraphBuilder, PEGraphDecoder.PEAppendGraphBuilderContext, PEGraphDecoder.PENonAppendGraphBuilderContext
```
public interface GraphBuilderContext
```
Used by a GraphBuilderPlugin to interface with an object that parses the bytecode of a single method as part of building a graph .

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <T extends ValueNode> T`	`add(T value)` Adds a node to the graph.
`default <T extends ValueNode> T`	`addPush(Kind kind, T value)` Adds a node with a non-void kind to the graph, pushes it to the stack.
`<T extends ValueNode> T`	`append(T value)` Raw operation for adding a node to the graph when neither `add(T)` nor `addPush(Kind, ValueNode)` can be used.
`BailoutException`	`bailout(String string)`
`int`	`bci()` Gets the index of the bytecode instruction currently being parsed.
`default Assumptions`	`getAssumptions()`
`ConstantReflectionProvider`	`getConstantReflection()`
`default int`	`getDepth()` Gets the inline depth of this context.
`StructuredGraph`	`getGraph()` Gets the graph being constructed.
`IntrinsicContext`	`getIntrinsic()` Gets the intrinsic of the current parsing context or `null` if not `parsing an intrinsic`.
`CallTargetNode.InvokeKind`	`getInvokeKind()` Gets the kind of invocation currently being parsed.
`default Stamp`	`getInvokeReturnStamp()`
`JavaType`	`getInvokeReturnType()` Gets the return type of the invocation currently being parsed.
`MetaAccessProvider`	`getMetaAccess()`
`ResolvedJavaMethod`	`getMethod()` Gets the method being parsed by this context.
`default GraphBuilderContext`	`getNonIntrinsicAncestor()` Gets the first ancestor parsing context that is not parsing a intrinsic.
`GraphBuilderContext`	`getParent()` Gets the parsing context for the method that inlines the method being parsed by this context.
`StampProvider`	`getStampProvider()`
`void`	`handleReplacedInvoke(CallTargetNode.InvokeKind invokeKind, ResolvedJavaMethod targetMethod, ValueNode[] args, boolean forceInlineEverything)` Handles an invocation that a plugin determines can replace the original invocation (i.e., the one for which the plugin was applied).
`void`	`intrinsify(ResolvedJavaMethod targetMethod, ResolvedJavaMethod substitute, ValueNode[] args)` Intrinsifies an invocation of a given method by inlining the bytecodes of a given substitution method.
`default ValueNode`	`nullCheckedValue(ValueNode value)` Gets a version of a given value that has a non-null stamp.
`default boolean`	`parsingIntrinsic()` Determines if this parsing context is within the bytecode of an intrinsic or a method inlined by an intrinsic.
`void`	`push(Kind kind, ValueNode value)` Pushes a given value to the frame state stack using an explicit kind.
`<T extends ValueNode> T`	`recursiveAppend(T value)` Adds the given node to the graph and also adds recursively all referenced inputs.
`void`	`setStateAfter(StateSplit sideEffect)` Creates a snap shot of the current frame state with the BCI of the instruction after the one currently being parsed and assigns it to a given side effect node.

- Method Detail
  - append
```
<T extends ValueNode> T append(T value)
```
    Raw operation for adding a node to the graph when neither add(T) nor addPush(Kind, ValueNode) can be used.
    
    Returns:
    
    either the node added or an equivalent node
  - recursiveAppend
```
<T extends ValueNode> T recursiveAppend(T value)
```
    Adds the given node to the graph and also adds recursively all referenced inputs.
    
    Parameters:
    
    value - the node to be added to the graph
    
    Returns:
    
    either the node added or an equivalent node
  - push
```
void push(Kind kind,
          ValueNode value)
```
    Pushes a given value to the frame state stack using an explicit kind. This should be used when value.getKind() is different from the kind that the bytecode instruction currently being parsed pushes to the stack.
    
    Parameters:
    
    kind - the kind to use when type checking this operation
    
    value - the value to push to the stack. The value must already have been appended.
  - add
```
default <T extends ValueNode> T add(T value)
```
    Adds a node to the graph. If the returned node is a StateSplit with a null frame state, the frame state is initialized.
    
    Parameters:
    
    value - the value to add to the graph and push to the stack. The value.getKind() kind is used when type checking this operation.
    
    Returns:
    
    a node equivalent to value in the graph
  - addPush
```
default <T extends ValueNode> T addPush(Kind kind,
                                        T value)
```
    Adds a node with a non-void kind to the graph, pushes it to the stack. If the returned node is a StateSplit with a null frame state, the frame state is initialized.
    
    Parameters:
    
    kind - the kind to use when type checking this operation
    
    value - the value to add to the graph and push to the stack
    
    Returns:
    
    a node equivalent to value in the graph
  - handleReplacedInvoke
```
void handleReplacedInvoke(CallTargetNode.InvokeKind invokeKind,
                          ResolvedJavaMethod targetMethod,
                          ValueNode[] args,
                          boolean forceInlineEverything)
```
    Handles an invocation that a plugin determines can replace the original invocation (i.e., the one for which the plugin was applied). This applies all standard graph builder processing to the replaced invocation including applying any relevant plugins.
    
    Parameters:
    
    invokeKind - the kind of the replacement invocation
    
    targetMethod - the target of the replacement invocation
    
    args - the arguments to the replacement invocation
    
    forceInlineEverything - specifies if all invocations encountered in the scope of handling the replaced invoke are to be force inlined
  - intrinsify
```
void intrinsify(ResolvedJavaMethod targetMethod,
                ResolvedJavaMethod substitute,
                ValueNode[] args)
```
    Intrinsifies an invocation of a given method by inlining the bytecodes of a given substitution method.
    
    Parameters:
    
    targetMethod - the method being intrinsified
    
    substitute - the intrinsic implementation
    
    args - the arguments with which to inline the invocation
  - getStampProvider
```
StampProvider getStampProvider()
```
  - getMetaAccess
```
MetaAccessProvider getMetaAccess()
```
  - getAssumptions
```
default Assumptions getAssumptions()
```
  - getConstantReflection
```
ConstantReflectionProvider getConstantReflection()
```
  - getGraph
```
StructuredGraph getGraph()
```
    Gets the graph being constructed.
  - setStateAfter
```
void setStateAfter(StateSplit sideEffect)
```
    Creates a snap shot of the current frame state with the BCI of the instruction after the one currently being parsed and assigns it to a given side effect node.
    
    Parameters:
    
    sideEffect - a side effect node just appended to the graph
  - getParent
```
GraphBuilderContext getParent()
```
    Gets the parsing context for the method that inlines the method being parsed by this context.
  - getNonIntrinsicAncestor
```
default GraphBuilderContext getNonIntrinsicAncestor()
```
    Gets the first ancestor parsing context that is not parsing a intrinsic.
  - getMethod
```
ResolvedJavaMethod getMethod()
```
    Gets the method being parsed by this context.
  - bci
```
int bci()
```
    Gets the index of the bytecode instruction currently being parsed.
  - getInvokeKind
```
CallTargetNode.InvokeKind getInvokeKind()
```
    Gets the kind of invocation currently being parsed.
  - getInvokeReturnType
```
JavaType getInvokeReturnType()
```
    Gets the return type of the invocation currently being parsed.
  - getInvokeReturnStamp
```
default Stamp getInvokeReturnStamp()
```
  - getDepth
```
default int getDepth()
```
    Gets the inline depth of this context. A return value of 0 implies that this is the context for the parse root.
  - parsingIntrinsic
```
default boolean parsingIntrinsic()
```
    Determines if this parsing context is within the bytecode of an intrinsic or a method inlined by an intrinsic.
  - getIntrinsic
```
IntrinsicContext getIntrinsic()
```
    Gets the intrinsic of the current parsing context or null if not parsing an intrinsic.
  - bailout
```
BailoutException bailout(String string)
```
  - nullCheckedValue
```
default ValueNode nullCheckedValue(ValueNode value)
```
    Gets a version of a given value that has a non-null stamp.

Interface GraphBuilderContext

Method Summary

Method Detail

append

recursiveAppend

push

add

addPush

handleReplacedInvoke

intrinsify

getStampProvider

getMetaAccess

getAssumptions

getConstantReflection

getGraph

setStateAfter

getParent

getNonIntrinsicAncestor

getMethod

bci

getInvokeKind

getInvokeReturnType

getInvokeReturnStamp

getDepth

parsingIntrinsic

getIntrinsic

bailout

nullCheckedValue