org.graalvm.compiler.nodes.extended

Class ForeignCallNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.FixedNode

org.graalvm.compiler.nodes.FixedWithNextNode

org.graalvm.compiler.nodes.AbstractStateSplit

org.graalvm.compiler.nodes.memory.AbstractMemoryCheckpoint

org.graalvm.compiler.nodes.extended.ForeignCallNode

All Implemented Interfaces:

Cloneable, Formattable, MemoryKillMarker, DeoptBciSupplier, DeoptimizingNode, DeoptimizingNode.DeoptDuring, ForeignCall, FixedNodeInterface, FixedWithNextNodeInterface, MemoryKill, MultiMemoryKill, LIRLowerable, NodeWithState, StateSplit, ValueNodeInterface

public class ForeignCallNode
extends AbstractMemoryCheckpoint
implements ForeignCall

Node for a foreign call.

Nested Class Summary

Nested classes/interfaces inherited from class org.graalvm.compiler.graph.Node

Node.ConstantNodeParameter, Node.EdgeVisitor, Node.IndirectCanonicalization, Node.InjectedNodeParameter, Node.Input, Node.NodeInsertionStackTrace, Node.NodeIntrinsic, Node.NodeIntrinsicFactory, Node.OptionalInput, Node.Successor, Node.ValueNumberable

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.DeoptimizingNode

DeoptimizingNode.DeoptAfter, DeoptimizingNode.DeoptBefore, DeoptimizingNode.DeoptDuring

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

MemoryKill.NoLocation

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeInputList<ValueNode>	arguments
protected int	bci
protected ForeignCallDescriptor	descriptor
protected FrameState	stateDuring
static NodeClass<ForeignCallNode>	TYPE

Fields inherited from class org.graalvm.compiler.nodes.AbstractStateSplit

stateAfter

Fields inherited from class org.graalvm.compiler.nodes.FixedWithNextNode

next

Fields inherited from class org.graalvm.compiler.nodes.ValueNode

EMPTY_ARRAY, stamp

Fields inherited from class org.graalvm.compiler.graph.Node

NODE_LIST, NOT_ITERABLE, TRACK_CREATION_POSITION, WithAllEdges, WithNoEdges, WithOnlyInputEdges, WithOnlySucessorEdges

Fields inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

MULTI_KILL_NO_LOCATION, NO_LOCATION

Constructor Summary

Constructors

Modifier	Constructor and Description
	ForeignCallNode(ForeignCallDescriptor descriptor, Stamp stamp)
	ForeignCallNode(ForeignCallDescriptor descriptor, Stamp stamp, List<ValueNode> arguments)
	ForeignCallNode(ForeignCallDescriptor descriptor, ValueNode... arguments)
	ForeignCallNode(ForeignCallsProvider foreignCalls, ForeignCallSignature signature, ValueNode... arguments)
protected	ForeignCallNode(NodeClass<? extends ForeignCallNode> c, ForeignCallDescriptor descriptor, ValueNode... arguments)

Method Summary

Modifier and Type	Method and Description
int	bci()
static boolean	finishIntrinsification(GraphBuilderContext b, Stamp returnStamp, ForeignCall node)
NodeInputList<ValueNode>	getArguments()
Map<Object,Object>	getDebugProperties(Map<Object,Object> map) Fills a Map with properties of this for use in debugging (e.g., to view in the ideal graph visualizer).
ForeignCallDescriptor	getDescriptor()
boolean	hasSideEffect() Determines if this node has a side-effect.
static boolean	intrinsify(GraphBuilderContext b, Stamp returnStamp, ForeignCallDescriptor descriptor, ValueNode... arguments)
static boolean	intrinsify(GraphBuilderContext b, Stamp returnStamp, ForeignCallsProvider foreignCalls, ForeignCallSignature signature, ValueNode... arguments)
void	setBci(int bci) Remember the byte code index (BCI) for code generation or lowering purposes.
void	setStateAfter(FrameState x) Sets the FrameState corresponding to the state of the JVM after execution of this node.
void	setStateDuring(FrameState stateDuring) Sets the FrameState describing the program state during the execution of this node.
FrameState	stateDuring()
String	toString(Verbosity verbosity) Creates a String representation for this with a given Verbosity.

Methods inherited from class org.graalvm.compiler.nodes.AbstractStateSplit

stateAfter, verify

Methods inherited from class org.graalvm.compiler.nodes.FixedWithNextNode

asFixedWithNextNode, next, setNext

Methods inherited from class org.graalvm.compiler.nodes.FixedNode

asFixedNode

Methods inherited from class org.graalvm.compiler.nodes.ValueNode

asConstant, asJavaConstant, asNode, asSerializableConstant, checkReplaceAtUsagesInvariants, getStackKind, graph, hasUsagesOtherThan, inferStamp, isAllowedUsageType, isConstant, isConstantPredicate, isDefaultConstant, isIllegalConstant, isJavaConstant, isNullConstant, isSerializableConstant, recursivelyDataFlowEqualsUpTo, setStamp, stamp, updateStamp, updateUsagesInterface

Methods inherited from class org.graalvm.compiler.graph.Node

afterClone, applyInputs, applySuccessors, assertFalse, assertTrue, cfgPredecessors, cfgSuccessors, clearInputs, clearNodeSourcePosition, clearSuccessors, copyWithInputs, copyWithInputs, dataFlowEquals, dynamicNodeSizeEstimate, estimatedNodeCycles, estimatedNodeSize, fail, formatTo, getCreationPosition, getDebug, getDebugProperties, getInsertionPosition, getNodeClass, getNodeSourcePosition, getOptions, getUsageCount, hasExactlyOneUsage, hashCode, hasMoreThanOneUsage, hasNoUsages, hasOnlyUsagesOfType, hasUsages, hasUsagesOfType, inputPositions, inputs, isAlive, isDeleted, isUnregistered, markDeleted, maybeNotifyZeroUsages, modCount, predecessor, pushInputs, removeUsage, replaceAllInputs, replaceAndDelete, replaceAtAllUsages, replaceAtMatchingUsages, replaceAtPredecessor, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsagesAndDelete, replaceAtUsagesAndDelete, replaceFirstInput, replaceFirstSuccessor, safeDelete, setCreationPosition, setInsertionPosition, setNodeSourcePosition, singleUsage, successorPositions, successors, toString, updateNodeSourcePosition, updatePredecessor, updateUsages, usages, valueEquals, verifyEdges, verifyInputs, verifySourcePosition, withNodeSourcePosition

Methods inherited from class java.lang.Object

clone, equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graalvm.compiler.nodes.extended.ForeignCall

canDeoptimize, computeStateDuring, generate, getKilledLocationIdentities, isGuaranteedSafepoint, operands

Methods inherited from interface org.graalvm.compiler.nodes.StateSplit

stateAfter

Methods inherited from interface org.graalvm.compiler.nodes.spi.NodeWithState

states

Methods inherited from interface org.graalvm.compiler.nodes.FixedNodeInterface

asFixedNode

Methods inherited from interface org.graalvm.compiler.nodes.ValueNodeInterface

asNode

Methods inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

asMultiMemoryKill, asSingleMemoryKill, isMemoryKill, isMultiMemoryKill, isSingleMemoryKill

Field Detail

TYPE

public static final NodeClass<ForeignCallNode> TYPE

arguments

protected NodeInputList<ValueNode> arguments

stateDuring

protected FrameState stateDuring

descriptor

protected final ForeignCallDescriptor descriptor

bci

protected int bci

Constructor Detail

ForeignCallNode

public ForeignCallNode(ForeignCallsProvider foreignCalls,
                       ForeignCallSignature signature,
                       ValueNode... arguments)

ForeignCallNode

public ForeignCallNode(ForeignCallDescriptor descriptor,
                       ValueNode... arguments)

ForeignCallNode

public ForeignCallNode(ForeignCallDescriptor descriptor,
                       Stamp stamp,
                       List<ValueNode> arguments)

ForeignCallNode

public ForeignCallNode(ForeignCallDescriptor descriptor,
                       Stamp stamp)

ForeignCallNode

protected ForeignCallNode(NodeClass<? extends ForeignCallNode> c,
                          ForeignCallDescriptor descriptor,
                          ValueNode... arguments)

Method Detail

intrinsify

public static boolean intrinsify(GraphBuilderContext b,
                                 Stamp returnStamp,
                                 ForeignCallsProvider foreignCalls,
                                 ForeignCallSignature signature,
                                 ValueNode... arguments)

intrinsify

public static boolean intrinsify(GraphBuilderContext b,
                                 Stamp returnStamp,
                                 ForeignCallDescriptor descriptor,
                                 ValueNode... arguments)

finishIntrinsification

public static boolean finishIntrinsification(GraphBuilderContext b,
                                             Stamp returnStamp,
                                             ForeignCall node)

hasSideEffect

public boolean hasSideEffect()

Description copied from interface: StateSplit

Determines if this node has a side-effect. Such nodes cannot be safely re-executed because they modify state which is visible to other threads or modify state beyond what is captured in FrameState nodes.

Specified by:

hasSideEffect in interface StateSplit

Overrides:

hasSideEffect in class AbstractStateSplit

getDescriptor

public ForeignCallDescriptor getDescriptor()

Specified by:

getDescriptor in interface ForeignCall

setStateAfter

public void setStateAfter(FrameState x)

Description copied from interface: StateSplit

Sets the FrameState corresponding to the state of the JVM after execution of this node.

Specified by:

setStateAfter in interface StateSplit

Overrides:

setStateAfter in class AbstractStateSplit

stateDuring

public FrameState stateDuring()

Specified by:

stateDuring in interface DeoptimizingNode.DeoptDuring

setStateDuring

public void setStateDuring(FrameState stateDuring)

Description copied from interface: DeoptimizingNode.DeoptDuring

Sets the FrameState describing the program state during the execution of this node.

Specified by:

setStateDuring in interface DeoptimizingNode.DeoptDuring

bci

public int bci()

Specified by:

bci in interface DeoptBciSupplier

Returns:

the byte code index (BCI) associated with the node implementing this interface

setBci

public void setBci(int bci)

Description copied from interface: DeoptBciSupplier

Remember the byte code index (BCI) for code generation or lowering purposes. For example, nodes lowering to foreign calls that can safepoint require a valid BCI for computations of the during-state of such a foreign call.

Specified by:

setBci in interface DeoptBciSupplier

Specified by:

setBci in interface ForeignCall

getArguments

public NodeInputList<ValueNode> getArguments()

Specified by:

getArguments in interface ForeignCall

toString

public String toString(Verbosity verbosity)

Description copied from class: Node

Creates a String representation for this with a given Verbosity.

Overrides:

toString in class Node

getDebugProperties

public Map<Object,Object> getDebugProperties(Map<Object,Object> map)

Description copied from class: Node

Fills a Map with properties of this for use in debugging (e.g., to view in the ideal graph visualizer). Subclasses overriding this method should also fill the map using their superclass.

Overrides:

getDebugProperties in class Node