org.graalvm.compiler.replacements.nodes

Class AssertionNode

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.replacements.nodes.AssertionNode

All Implemented Interfaces:

Cloneable, Formattable, CanonicalizableMarker, FixedNodeInterface, FixedWithNextNodeInterface, Canonicalizable, LIRLowerable, Lowerable, ValueNodeInterface

public final class AssertionNode
extends FixedWithNextNode
implements Lowerable, Canonicalizable, LIRLowerable

Assertion nodes will go away as soon as the value evaluates to true. Compile-time assertions will fail if this has not happened by the time the node is lowered to LIR, while runtime assertions may need to insert a check.

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.spi.Canonicalizable

Canonicalizable.Binary<T extends Node>, Canonicalizable.BinaryCommutative<T extends Node>, Canonicalizable.Ternary<T extends Node>, Canonicalizable.Unary<T extends Node>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	compileTimeAssertion
protected String	message
static NodeClass<AssertionNode>	TYPE

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssertionNode(boolean compileTimeAssertion, ValueNode condition, String message, Object msgArg1, Object msgArg2, ValueNode l1, ValueNode l2)

Method Summary

Modifier and Type	Method and Description
static void	assertion(boolean compileTimeAssertion, boolean condition, String message, Object msgArg1, Object msgArg2, long arg1, long arg2)
Node	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
ValueNode	condition()
static void	dynamicAssert(boolean condition, String message)
static void	dynamicAssert(boolean condition, String message, long arg1, long arg2)
void	generate(NodeLIRBuilderTool generator)
ValueNode	getL1()
ValueNode	getL2()
boolean	isCompileTimeAssertion()
void	lower(LoweringTool tool) Expand this node into lower level nodes expressing the same semantics.
String	message()
static void	staticAssert(boolean condition, String message)
static void	staticAssert(boolean condition, String message, Object msgArg1, Object msgArg2)

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

asFixedWithNextNode, next, setNext

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

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

asFixedNode

Field Detail

TYPE

public static final NodeClass<AssertionNode> TYPE

compileTimeAssertion

protected final boolean compileTimeAssertion

message

protected final String message

Constructor Detail

AssertionNode

protected AssertionNode(boolean compileTimeAssertion,
                        ValueNode condition,
                        String message,
                        Object msgArg1,
                        Object msgArg2,
                        ValueNode l1,
                        ValueNode l2)

Method Detail

getL1

public ValueNode getL1()

getL2

public ValueNode getL2()

condition

public ValueNode condition()

message

public String message()

isCompileTimeAssertion

public boolean isCompileTimeAssertion()

canonical

public Node canonical(CanonicalizerTool tool)

Description copied from interface: Canonicalizable

Implementations of this method can provide local optimizations like constant folding and strength reduction. Implementations should look at the properties and inputs of the current node and determine if there is a more optimal and always semantically correct replacement.
The return value determines the effect that the canonicalization will have:

• Returning an pre-existing node will replace the current node with the given one.
• Returning a newly created node (that was not yet added to the graph) will replace the current node with the given one, after adding it to the graph. If both the replacement and the replacee are anchored in control flow (fixed nodes), the replacement will be added to the control flow. It is invalid to replace a non-fixed node with a newly created fixed node (because its placement in the control flow cannot be determined without scheduling).
• Returning null will delete the current node and replace it with null at all usages. Note that it is not necessary to delete floating nodes that have no more usages this way - they will be deleted automatically.

Specified by:

canonical in interface Canonicalizable

Parameters:

tool - provides access to runtime interfaces like MetaAccessProvider

lower

public void lower(LoweringTool tool)

Description copied from interface: Lowerable

Expand this node into lower level nodes expressing the same semantics. If the introduced nodes are themselves lowerable, they should be recursively lowered as part of this call.

Specified by:

lower in interface Lowerable

generate

public void generate(NodeLIRBuilderTool generator)

Specified by:

generate in interface LIRLowerable

assertion

public static void assertion(boolean compileTimeAssertion,
                             boolean condition,
                             String message,
                             Object msgArg1,
                             Object msgArg2,
                             long arg1,
                             long arg2)

staticAssert

public static void staticAssert(boolean condition,
                                String message)

staticAssert

public static void staticAssert(boolean condition,
                                String message,
                                Object msgArg1,
                                Object msgArg2)

dynamicAssert

public static void dynamicAssert(boolean condition,
                                 String message)

dynamicAssert

public static void dynamicAssert(boolean condition,
                                 String message,
                                 long arg1,
                                 long arg2)