org.graalvm.compiler.nodes

Class CompressionNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.calc.FloatingNode

org.graalvm.compiler.nodes.calc.UnaryNode

org.graalvm.compiler.nodes.CompressionNode

All Implemented Interfaces:

Cloneable, Formattable, Node.ValueNumberable, CanonicalizableMarker, ConvertNode, Canonicalizable, Canonicalizable.Unary<ValueNode>, LIRLowerable, ValueNodeInterface

Direct Known Subclasses:

HotSpotCompressionNode

public abstract class CompressionNode
extends UnaryNode
implements ConvertNode, LIRLowerable

Compress or uncompress an oop or metaspace pointer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompressionNode.CompressionOp

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 CompressEncoding	encoding
protected CompressionNode.CompressionOp	op
static NodeClass<CompressionNode>	TYPE

Fields inherited from class org.graalvm.compiler.nodes.calc.UnaryNode

value

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
CompressionNode(NodeClass<? extends UnaryNode> c, CompressionNode.CompressionOp op, ValueNode input, Stamp stamp, CompressEncoding encoding)

Method Summary

Modifier and Type	Method and Description
ValueNode	canonical(CanonicalizerTool tool, ValueNode forValue) Similar to Canonicalizable.canonical(CanonicalizerTool), except that implementations should act as if the current input of the node was the given one, i.e., they should never look at the inputs via the this pointer.
protected abstract Constant	compress(Constant c)
Constant	convert(Constant c, ConstantReflectionProvider constantReflection)
Stamp	foldStamp(Stamp newStamp) Compute an improved for this node using the passed in stamp.
void	generate(NodeLIRBuilderTool gen)
CompressEncoding	getEncoding()
CompressionNode.CompressionOp	getOp()
boolean	isLossless() Check whether a conversion is lossless.
boolean	mayNullCheckSkipConversion() Checks whether a null check may skip the conversion.
protected abstract Stamp	mkStamp(Stamp input)
JavaConstant	nullConstant()
Constant	reverse(Constant c, ConstantReflectionProvider constantReflection)
abstract ValueNode	reverse(ValueNode input) Apply the inverse of this node's operation (with the same encoding) to the given input node.
protected abstract Constant	uncompress(Constant c)

Methods inherited from class org.graalvm.compiler.nodes.calc.UnaryNode

getValue, inferStamp, setValue

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

asConstant, asJavaConstant, asNode, asSerializableConstant, checkReplaceAtUsagesInvariants, getStackKind, graph, hasUsagesOtherThan, 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, hasExactlyOneUsageOfType, 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, verify, 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.calc.ConvertNode

getValue, preservesOrder, preservesOrder

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

asNode

Methods inherited from interface org.graalvm.compiler.nodes.spi.Canonicalizable.Unary

canonical

Field Detail

TYPE

public static final NodeClass<CompressionNode> TYPE

op

protected final CompressionNode.CompressionOp op

encoding

protected final CompressEncoding encoding

Constructor Detail

CompressionNode

public CompressionNode(NodeClass<? extends UnaryNode> c,
                       CompressionNode.CompressionOp op,
                       ValueNode input,
                       Stamp stamp,
                       CompressEncoding encoding)

Method Detail

foldStamp

public Stamp foldStamp(Stamp newStamp)

Description copied from class: UnaryNode

Compute an improved for this node using the passed in stamp. The stamp must be compatible with the current value of UnaryNode.value. This code is used to provide the default implementation of UnaryNode.inferStamp() and may be used by external optimizations.

Overrides:

foldStamp in class UnaryNode

compress

protected abstract Constant compress(Constant c)

uncompress

protected abstract Constant uncompress(Constant c)

nullConstant

public JavaConstant nullConstant()

convert

public Constant convert(Constant c,
                        ConstantReflectionProvider constantReflection)

Specified by:

convert in interface ConvertNode

reverse

public Constant reverse(Constant c,
                        ConstantReflectionProvider constantReflection)

Specified by:

reverse in interface ConvertNode

reverse

public abstract ValueNode reverse(ValueNode input)

Apply the inverse of this node's operation (with the same encoding) to the given input node. Implementers may return an existing node. If a new node is returned, it is not added to the graph.

isLossless

public boolean isLossless()

Description copied from interface: ConvertNode

Check whether a conversion is lossless.

Specified by:

isLossless in interface ConvertNode

Returns:

true iff reverse(convert(c)) == c for all c

mkStamp

protected abstract Stamp mkStamp(Stamp input)

getOp

public CompressionNode.CompressionOp getOp()

getEncoding

public CompressEncoding getEncoding()

canonical

public ValueNode canonical(CanonicalizerTool tool,
                           ValueNode forValue)

Description copied from interface: Canonicalizable.Unary

Similar to Canonicalizable.canonical(CanonicalizerTool), except that implementations should act as if the current input of the node was the given one, i.e., they should never look at the inputs via the this pointer.

Specified by:

canonical in interface Canonicalizable.Unary<ValueNode>

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

mayNullCheckSkipConversion

public boolean mayNullCheckSkipConversion()

Description copied from interface: ConvertNode

Checks whether a null check may skip the conversion. This is true if in the conversion NULL is converted to NULL and if it is the only value converted to NULL.

Specified by:

mayNullCheckSkipConversion in interface ConvertNode

Returns:

whether a null check may skip the conversion