org.graalvm.compiler.replacements

Class SnippetCounterNode

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.SnippetCounterNode

All Implemented Interfaces:

Cloneable, Formattable, FixedNodeInterface, FixedWithNextNodeInterface, Lowerable, ValueNodeInterface

public class SnippetCounterNode
extends FixedWithNextNode
implements Lowerable

This node can be used to add a counter to the code that will estimate the dynamic number of calls by adding an increment to the compiled code. This should of course only be used for debugging/testing purposes. A unique counter will be created for each unique name passed to the constructor. Depending on the value of withContext, the name of the root method is added to the counter's name.

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 SnippetCounter	counter
protected ValueNode	increment
static org.graalvm.word.LocationIdentity	SNIPPET_COUNTER_LOCATION We do not want to use the LocationIdentity of the SnippetCounter.value() field, so that the usage in snippets is always possible.
static NodeClass<SnippetCounterNode>	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

Constructor and Description
SnippetCounterNode(SnippetCounter counter, ValueNode increment)

Method Summary

Modifier and Type	Method and Description
static void	add(SnippetCounter counter, int increment)
static org.graalvm.word.LocationIdentity[]	addSnippetCounters(org.graalvm.word.LocationIdentity[] privateLocations) Add SnippetCounterNode.SNIPPET_COUNTER_LOCATION to privateLocations if it isn't already there.
SnippetCounter	getCounter()
ValueNode	getIncrement()
static void	increment(SnippetCounter counter)
void	lower(LoweringTool tool) Expand this node into lower level nodes expressing the same semantics.

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<SnippetCounterNode> TYPE

increment

protected ValueNode increment

counter

protected final SnippetCounter counter

SNIPPET_COUNTER_LOCATION

public static final org.graalvm.word.LocationIdentity SNIPPET_COUNTER_LOCATION

We do not want to use the LocationIdentity of the SnippetCounter.value() field, so that the usage in snippets is always possible. If a method accesses the counter via the field and the snippet, the result might not be correct though.

Constructor Detail

SnippetCounterNode

public SnippetCounterNode(SnippetCounter counter,
                          ValueNode increment)

Method Detail

getCounter

public SnippetCounter getCounter()

getIncrement

public ValueNode getIncrement()

add

public static void add(SnippetCounter counter,
                       int increment)

increment

public static void increment(SnippetCounter counter)

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

addSnippetCounters

public static org.graalvm.word.LocationIdentity[] addSnippetCounters(org.graalvm.word.LocationIdentity[] privateLocations)

Add SnippetCounterNode.SNIPPET_COUNTER_LOCATION to privateLocations if it isn't already there.

Parameters:

privateLocations -

Returns:

a copy of privateLocations with any needed locations added