org.graalvm.compiler.nodes.debug

Class DynamicCounterNode

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.debug.DynamicCounterNode

All Implemented Interfaces:

Cloneable, Formattable, FixedNodeInterface, FixedWithNextNodeInterface, LIRLowerable, ValueNodeInterface

Direct Known Subclasses:

WeakCounterNode

public class DynamicCounterNode
extends FixedWithNextNode
implements LIRLowerable

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 String	group
static long	MAX_INCREMENT
static long	MIN_INCREMENT
protected String	name
static NodeClass<DynamicCounterNode>	TYPE
protected boolean	withContext

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	DynamicCounterNode(NodeClass<? extends DynamicCounterNode> c, String group, String name, ValueNode increment, boolean withContext)
	DynamicCounterNode(String group, String name, ValueNode increment, boolean withContext)

Method Summary

Modifier and Type	Method and Description
static void	addCounterBefore(String group, String name, long increment, boolean withContext, FixedNode position)
static void	addCounterBefore(String group, String name, ValueNode increment, boolean withContext, FixedNode position)
static long	clampIncrement(long value) Clamps value to a value between DynamicCounterNode.MIN_INCREMENT and DynamicCounterNode.MAX_INCREMENT.
static void	counter(String group, String name, long increment, boolean addContext)
void	generate(NodeLIRBuilderTool generator)
String	getGroup()
ValueNode	getIncrement()
String	getName()
boolean	isWithContext()

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

asFixedNode

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

asNode

Field Detail

TYPE

public static final NodeClass<DynamicCounterNode> TYPE

group

protected final String group

name

protected final String name

withContext

protected final boolean withContext

MIN_INCREMENT

public static final long MIN_INCREMENT

See Also:

Constant Field Values

MAX_INCREMENT

public static final long MAX_INCREMENT

See Also:

Constant Field Values

Constructor Detail

DynamicCounterNode

public DynamicCounterNode(String group,
                          String name,
                          ValueNode increment,
                          boolean withContext)

DynamicCounterNode

protected DynamicCounterNode(NodeClass<? extends DynamicCounterNode> c,
                             String group,
                             String name,
                             ValueNode increment,
                             boolean withContext)

Method Detail

clampIncrement

public static long clampIncrement(long value)

Clamps value to a value between DynamicCounterNode.MIN_INCREMENT and DynamicCounterNode.MAX_INCREMENT. This mitigates the possibility of overflowing benchmark counters.

getIncrement

public ValueNode getIncrement()

getName

public String getName()

getGroup

public String getGroup()

isWithContext

public boolean isWithContext()

addCounterBefore

public static void addCounterBefore(String group,
                                    String name,
                                    long increment,
                                    boolean withContext,
                                    FixedNode position)

addCounterBefore

public static void addCounterBefore(String group,
                                    String name,
                                    ValueNode increment,
                                    boolean withContext,
                                    FixedNode position)

counter

public static void counter(String group,
                           String name,
                           long increment,
                           boolean addContext)

generate

public void generate(NodeLIRBuilderTool generator)

Specified by:

generate in interface LIRLowerable