org.graalvm.compiler.graph

Class NodeClass<T>

java.lang.Object

org.graalvm.compiler.core.common.FieldIntrospection<T>

org.graalvm.compiler.graph.NodeClass<T>

public final class NodeClass<T>
extends FieldIntrospection<T>

Metadata for every Node type. The metadata includes:

• The offsets of fields annotated with Node.Input and Node.Successor as well as methods for iterating over such fields.
• The identifier for an IterableNodeType class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NodeClass.EdgeInfo Describes a field representing an input or successor edge in a node.
protected static class	NodeClass.InputInfo Describes a field representing an input edge in a node.
protected static class	NodeClass.NodeFieldsScanner

Field Summary

Fields

Modifier and Type	Field and Description
static long	LIST_MASK
static long	MAX_EDGES
static long	MAX_LIST_EDGES
static long	NEXT_EDGE
static long	OFFSET_MASK

Fields inherited from class org.graalvm.compiler.core.common.FieldIntrospection

data

Constructor Summary

Constructors

Constructor and Description
NodeClass(Class<T> clazz, NodeClass<? super T> superNodeClass)
NodeClass(Class<T> clazz, NodeClass<? super T> superNodeClass, FieldsScanner.CalcOffset calcOffset, int[] presetIterableIds, int presetIterableId)

Method Summary

Modifier and Type	Method and Description
Node	allocateInstance() Returns a newly allocated node for which no subclass-specific constructor has been called.
void	applyInputs(Node node, Node.EdgeVisitor consumer)
void	applySuccessors(Node node, Node.EdgeVisitor consumer)
static long	computeIterationMask(Edges.Type type, int directCount, long[] offsets)
static <T> NodeClass<T>	create(Class<T> c) Gets the NodeClass associated with a given Class.
NodeCycles	cycles()
boolean	dataEquals(Node a, Node b)
boolean	equalInputs(Node node, Node other)
boolean	equalSuccessors(Node node, Node other)
static <T> NodeClass<T>	get(Class<T> clazz)
Fields[]	getAllFields()
EnumSet<InputType>	getAllowedUsageTypes()
Edges	getEdges(Edges.Type type) Gets the input or successor edges defined by this node class.
Edges	getInputEdges()
NodeIterable<Node>	getInputIterable(Node node)
Class<T>	getJavaClass()
int	getLeafId()
String	getNameTemplate() The template used to build the Verbosity.Name version.
Edges	getSuccessorEdges()
NodeIterable<Node>	getSuccessorIterable(Node node)
NodeClass<? super T>	getSuperNodeClass()
long	inputsIteration()
boolean	isCanonicalizable() Determines if this node type is canonicalizable.
boolean	isCommutative() Determines if this node type is commutative.
boolean	isLeafNode()
boolean	isSimplifiable() Determines if this node type is simplifiable.
boolean	isValid(Position pos, NodeClass<?> from, Edges fromEdges)
int	iterableId()
void	pushInputs(Node node, NodeStack stack)
void	registerAtSuccessorsAsPredecessor(Node node)
boolean	replaceFirstInput(Node node, Node key, Node replacement) Finds the first Node.Input or Node.OptionalInput in node whose value == key and replaces it with replacement.
boolean	replaceFirstSuccessor(Node node, Node key, Node replacement) Finds the first Node.Successor in node whose value is key and replaces it with replacement.
String	shortName()
NodeSize	size()
String	toString()
void	unregisterAtInputsAsUsage(Node node)
void	unregisterAtSuccessorsAsPredecessor(Node node)
int	valueNumber(Node n)
boolean	valueNumberable()

Methods inherited from class org.graalvm.compiler.core.common.FieldIntrospection

getClazz, getData

Methods inherited from class java.lang.Object

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

Field Detail

MAX_EDGES

public static final long MAX_EDGES

See Also:

Constant Field Values

MAX_LIST_EDGES

public static final long MAX_LIST_EDGES

See Also:

Constant Field Values

OFFSET_MASK

public static final long OFFSET_MASK

See Also:

Constant Field Values

LIST_MASK

public static final long LIST_MASK

See Also:

Constant Field Values

NEXT_EDGE

public static final long NEXT_EDGE

See Also:

Constant Field Values

Constructor Detail

NodeClass

public NodeClass(Class<T> clazz,
                 NodeClass<? super T> superNodeClass)

NodeClass

public NodeClass(Class<T> clazz,
                 NodeClass<? super T> superNodeClass,
                 FieldsScanner.CalcOffset calcOffset,
                 int[] presetIterableIds,
                 int presetIterableId)

Method Detail

create

public static <T> NodeClass<T> create(Class<T> c)

Gets the NodeClass associated with a given Class.

get

public static <T> NodeClass<T> get(Class<T> clazz)

cycles

public NodeCycles cycles()

size

public NodeSize size()

computeIterationMask

public static long computeIterationMask(Edges.Type type,
                                        int directCount,
                                        long[] offsets)

shortName

public String shortName()

getAllFields

public Fields[] getAllFields()

Specified by:

getAllFields in class FieldIntrospection<T>

iterableId

public int iterableId()

valueNumberable

public boolean valueNumberable()

isCanonicalizable

public boolean isCanonicalizable()

Determines if this node type is canonicalizable.

isCommutative

public boolean isCommutative()

Determines if this node type is commutative.

isSimplifiable

public boolean isSimplifiable()

Determines if this node type is simplifiable.

getAllowedUsageTypes

public EnumSet<InputType> getAllowedUsageTypes()

toString

public String toString()

Overrides:

toString in class Object

valueNumber

public int valueNumber(Node n)

dataEquals

public boolean dataEquals(Node a,
                          Node b)

isValid

public boolean isValid(Position pos,
                       NodeClass<?> from,
                       Edges fromEdges)

getEdges

public Edges getEdges(Edges.Type type)

Gets the input or successor edges defined by this node class.

getInputEdges

public Edges getInputEdges()

getSuccessorEdges

public Edges getSuccessorEdges()

allocateInstance

public Node allocateInstance()

Returns a newly allocated node for which no subclass-specific constructor has been called.

getJavaClass

public Class<T> getJavaClass()

getNameTemplate

public String getNameTemplate()

The template used to build the Verbosity.Name version. Variable parts are specified using {i#inputName} or {p#propertyName}. If no template is specified, it uses NodeInfo.shortName(). If none of the two is specified, it returns an empty string.

isLeafNode

public boolean isLeafNode()

Returns:

true if the node has no inputs and no successors

getLeafId

public int getLeafId()

getSuperNodeClass

public NodeClass<? super T> getSuperNodeClass()

inputsIteration

public long inputsIteration()

getSuccessorIterable

public NodeIterable<Node> getSuccessorIterable(Node node)

getInputIterable

public NodeIterable<Node> getInputIterable(Node node)

equalSuccessors

public boolean equalSuccessors(Node node,
                               Node other)

equalInputs

public boolean equalInputs(Node node,
                           Node other)

pushInputs

public void pushInputs(Node node,
                       NodeStack stack)

applySuccessors

public void applySuccessors(Node node,
                            Node.EdgeVisitor consumer)

applyInputs

public void applyInputs(Node node,
                        Node.EdgeVisitor consumer)

unregisterAtSuccessorsAsPredecessor

public void unregisterAtSuccessorsAsPredecessor(Node node)

registerAtSuccessorsAsPredecessor

public void registerAtSuccessorsAsPredecessor(Node node)

replaceFirstInput

public boolean replaceFirstInput(Node node,
                                 Node key,
                                 Node replacement)

Finds the first Node.Input or Node.OptionalInput in node whose value == key and replaces it with replacement. Pre-requisite: node.getNodeClass() == this

Returns:

true if a replacement was made, false if key was not an input

replaceFirstSuccessor

public boolean replaceFirstSuccessor(Node node,
                                     Node key,
                                     Node replacement)

Finds the first Node.Successor in node whose value is key and replaces it with replacement. Pre-requisite: node.getNodeClass() == this

Returns:

true if a replacement was made, false if key was not an input

unregisterAtInputsAsUsage

public void unregisterAtInputsAsUsage(Node node)