org.graalvm.compiler.nodeinfo

Enum NodeSize

java.lang.Object

java.lang.Enum<NodeSize>

org.graalvm.compiler.nodeinfo.NodeSize

All Implemented Interfaces:

Serializable, Comparable<NodeSize>

public enum NodeSize
extends Enum<NodeSize>

Constants representing the abstract number of CPU instructions needed to represent a node. This ignores byte sizes of instructions (i.e., 32/64/variable-length). Note that the sizes specified are only estimations and should only be used to enhance performance of generated code. They should not be used to change any semantics of nodes. If a specific node has vastly different sizes based on different CPUs or how it might be potentially lowered (e.g., 1 versus 100 instructions), it should override Node.estimatedNodeSize(). Otherwise, just use the average of the different values (e.g., if AMD64 size is 5 and AArch64 is 1, use 3). In general, the current sizes for nodes are based on domain knowledge and experience, including machine-learning based tweaking. When adding a new node, it's best to look at the cost model for similar nodes if unsure what values to specify. Benchmarking is also useful to tune model parameters.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SIZE_0 Nodes that do not require any code to be generated in order to be "executed", e.g.
SIZE_1
SIZE_1024
SIZE_128
SIZE_16
SIZE_2
SIZE_256
SIZE_32
SIZE_4
SIZE_512
SIZE_64
SIZE_8
SIZE_IGNORED Nodes for which code size information is irrelevant and can be ignored, e.g.
SIZE_UNKNOWN Nodes for which, due to arbitrary reasons, no estimation can be made either (1) statically without inspecting the properties of a node or (2) at all (like e.g.
SIZE_UNSET The default value of the NodeInfo.size() property.

Field Summary

Fields

Modifier and Type	Field and Description
static int	IGNORE_SIZE_CONTRACT_FACTOR
int	value

Method Summary

Modifier and Type	Method and Description
static NodeSize	compute(int rawValue)
static NodeSize	compute(NodeSize base, int opCount)
static NodeSize	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeSize[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIZE_UNSET

public static final NodeSize SIZE_UNSET

The default value of the NodeInfo.size() property.

For further information about the use of SIZE_UNSET see NodeInfo.size().

SIZE_UNKNOWN

public static final NodeSize SIZE_UNKNOWN

Nodes for which, due to arbitrary reasons, no estimation can be made either (1) statically without inspecting the properties of a node or (2) at all (like e.g. for an invocation).

Nodes annotated with SIZE_UNKNOWN should specify the NodeInfo.sizeRationale() property to clarify why an estimation cannot be done.

SIZE_IGNORED

public static final NodeSize SIZE_IGNORED

Nodes for which code size information is irrelevant and can be ignored, e.g. for test nodes.

SIZE_0

public static final NodeSize SIZE_0

Nodes that do not require any code to be generated in order to be "executed", e.g. a PiNode.

SIZE_1

public static final NodeSize SIZE_1

SIZE_2

public static final NodeSize SIZE_2

SIZE_4

public static final NodeSize SIZE_4

SIZE_8

public static final NodeSize SIZE_8

SIZE_16

public static final NodeSize SIZE_16

SIZE_32

public static final NodeSize SIZE_32

SIZE_64

public static final NodeSize SIZE_64

SIZE_128

public static final NodeSize SIZE_128

SIZE_256

public static final NodeSize SIZE_256

SIZE_512

public static final NodeSize SIZE_512

SIZE_1024

public static final NodeSize SIZE_1024

Field Detail

value

public final int value

IGNORE_SIZE_CONTRACT_FACTOR

public static final int IGNORE_SIZE_CONTRACT_FACTOR

See Also:

Constant Field Values

Method Detail

values

public static NodeSize[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NodeSize valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

compute

public static NodeSize compute(NodeSize base,
                               int opCount)

compute

public static NodeSize compute(int rawValue)