org.graalvm.compiler.nodes

Class WithExceptionNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.FixedNode

org.graalvm.compiler.nodes.ControlSplitNode

org.graalvm.compiler.nodes.WithExceptionNode

All Implemented Interfaces:

Cloneable, Formattable, FixedNodeInterface, ValueNodeInterface

Direct Known Subclasses:

BasicArrayCopyNode, FallbackInvokeWithExceptionNode, InvokeWithExceptionNode, MacroWithExceptionNode, PluginReplacementWithExceptionNode, ValidateNewInstanceClassNode

public abstract class WithExceptionNode
extends ControlSplitNode

Base class for fixed nodes that have exactly two successors: A "next" successor for normal execution, and an "exception edge" successor for exceptional control flow.

See Also:

ExceptionObjectNode

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractBeginNode	exceptionEdge
protected AbstractBeginNode	next
static NodeClass<WithExceptionNode>	TYPE

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WithExceptionNode(NodeClass<? extends WithExceptionNode> c, Stamp stamp)

Method Summary

Modifier and Type	Method and Description
AbstractBeginNode	exceptionEdge()
AbstractBeginNode	getPrimarySuccessor() Primary successor of the control split.
ProfileData.BranchProbabilityData	getProfileData() Returns the source of this node's knowledge about its successor probabilities.
int	getSuccessorCount() Returns the number of successors.
void	killExceptionEdge()
AbstractBeginNode	next()
double	probability(AbstractBeginNode successor)
FixedNode	replaceWithNonThrowing() Converts this node into a variant with the same semantics but without an exception edge.
void	setExceptionEdge(AbstractBeginNode x)
void	setNext(AbstractBeginNode x)
boolean	setProbability(AbstractBeginNode successor, ProfileData.BranchProbabilityData profileData) Attempts to set the probability for the given successor to the passed value (which has to be in the range of 0.0 and 1.0).

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

successorProbabilities

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

asFixedNode, verify

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, 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, 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.ValueNodeInterface

asNode

Field Detail

TYPE

public static final NodeClass<WithExceptionNode> TYPE

next

protected AbstractBeginNode next

exceptionEdge

protected AbstractBeginNode exceptionEdge

Constructor Detail

WithExceptionNode

protected WithExceptionNode(NodeClass<? extends WithExceptionNode> c,
                            Stamp stamp)

Method Detail

next

public AbstractBeginNode next()

setNext

public void setNext(AbstractBeginNode x)

getPrimarySuccessor

public AbstractBeginNode getPrimarySuccessor()

Description copied from class: ControlSplitNode

Primary successor of the control split. Data dependencies on the node have to be scheduled in the primary successor. Returns null if data dependencies are not expected.

Specified by:

getPrimarySuccessor in class ControlSplitNode

Returns:

the primary successor

exceptionEdge

public AbstractBeginNode exceptionEdge()

setExceptionEdge

public void setExceptionEdge(AbstractBeginNode x)

killExceptionEdge

public void killExceptionEdge()

probability

public double probability(AbstractBeginNode successor)

Specified by:

probability in class ControlSplitNode

setProbability

public boolean setProbability(AbstractBeginNode successor,
                              ProfileData.BranchProbabilityData profileData)

Description copied from class: ControlSplitNode

Attempts to set the probability for the given successor to the passed value (which has to be in the range of 0.0 and 1.0). Returns whether setting the probability was successful. When successful, sets the source of the knowledge about probabilities according to the profileData's profile source.

Specified by:

setProbability in class ControlSplitNode

getProfileData

public ProfileData.BranchProbabilityData getProfileData()

Description copied from class: ControlSplitNode

Returns the source of this node's knowledge about its successor probabilities.

Specified by:

getProfileData in class ControlSplitNode

getSuccessorCount

public int getSuccessorCount()

Description copied from class: ControlSplitNode

Returns the number of successors.

Specified by:

getSuccessorCount in class ControlSplitNode

replaceWithNonThrowing

public FixedNode replaceWithNonThrowing()

Converts this node into a variant with the same semantics but without an exception edge. The default implementation does not change the node class, but instead only marks the exception path as unused. A later lowering of the node needs to take care of the actual removal of the exception path, e.g., by lowering into a ForeignCallNode.