org.graalvm.compiler.core.common.type

Class AbstractPointerStamp

java.lang.Object

org.graalvm.compiler.core.common.type.Stamp

org.graalvm.compiler.core.common.type.AbstractPointerStamp

All Implemented Interfaces:

SpeculationReasonGroup.SpeculationContextObject

Direct Known Subclasses:

AbstractObjectStamp, MetaspacePointerStamp, RawPointerStamp

public abstract class AbstractPointerStamp
extends Stamp

Abstract base class of all pointer types.

Nested Class Summary

Nested classes/interfaces inherited from interface org.graalvm.compiler.serviceprovider.SpeculationReasonGroup.SpeculationContextObject

SpeculationReasonGroup.SpeculationContextObject.Visitor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPointerStamp(boolean nonNull, boolean alwaysNull)

Method Summary

Modifier and Type	Method and Description
void	accept(SpeculationReasonGroup.SpeculationContextObject.Visitor v)
boolean	alwaysNull()
Stamp	asAlwaysNull()
Constant	asConstant() If this stamp represents a single value, the methods returns this single value.
AbstractPointerStamp	asMaybeNull()
AbstractPointerStamp	asNonNull()
protected abstract AbstractPointerStamp	copyWith(boolean newNonNull, boolean newAlwaysNull)
protected Stamp	defaultPointerJoin(Stamp stamp)
boolean	equals(Object obj)
JavaKind	getStackKind() Gets a Java JavaKind that can be used to store a value of this stamp on the Java bytecode stack.
int	hashCode()
Stamp	improveWith(Stamp other) Tries to improve this stamp with the stamp given as parameter.
boolean	isCompressed()
Stamp	meet(Stamp stamp) Returns the union of this stamp and the given stamp.
boolean	nonNull()
JavaConstant	nullConstant()
static Stamp	pointerAlwaysNull(Stamp stamp)
static Stamp	pointerMaybeNull(Stamp stamp)
static Stamp	pointerNonNull(Stamp stamp)
Stamp	unrestricted() Returns a stamp of the same kind, but allowing the full value range of the kind.

Methods inherited from class org.graalvm.compiler.core.common.type.Stamp

alwaysDistinct, constant, empty, getLIRKind, hasValues, isCompatible, isCompatible, isEmpty, isPointerStamp, isUnrestricted, javaType, join, makeSymbolic, neverDistinct, readConstant, readConstant, toString, tryImproveWith

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractPointerStamp

protected AbstractPointerStamp(boolean nonNull,
                               boolean alwaysNull)

Method Detail

accept

public void accept(SpeculationReasonGroup.SpeculationContextObject.Visitor v)

nonNull

public boolean nonNull()

alwaysNull

public boolean alwaysNull()

copyWith

protected abstract AbstractPointerStamp copyWith(boolean newNonNull,
                                                 boolean newAlwaysNull)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

defaultPointerJoin

protected Stamp defaultPointerJoin(Stamp stamp)

improveWith

public Stamp improveWith(Stamp other)

Description copied from class: Stamp

Tries to improve this stamp with the stamp given as parameter. If successful, returns the new improved stamp. Otherwise, returns a stamp equal to this.

Specified by:

improveWith in class Stamp

Parameters:

other - the stamp that should be used to improve this stamp

Returns:

the newly improved stamp or a stamp equal to this if an improvement was not possible

meet

public Stamp meet(Stamp stamp)

Description copied from class: Stamp

Returns the union of this stamp and the given stamp. Typically used to create stamps for phi nodes.

Specified by:

meet in class Stamp

Parameters:

stamp - The stamp that will enlarge this stamp.

Returns:

The union of this stamp and the given stamp.

unrestricted

public Stamp unrestricted()

Description copied from class: Stamp

Returns a stamp of the same kind, but allowing the full value range of the kind. Stamp.unrestricted() is the neutral element of the Stamp.join(Stamp) operation.

Specified by:

unrestricted in class Stamp

pointerNonNull

public static Stamp pointerNonNull(Stamp stamp)

pointerMaybeNull

public static Stamp pointerMaybeNull(Stamp stamp)

pointerAlwaysNull

public static Stamp pointerAlwaysNull(Stamp stamp)

asNonNull

public AbstractPointerStamp asNonNull()

asMaybeNull

public AbstractPointerStamp asMaybeNull()

asAlwaysNull

public Stamp asAlwaysNull()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

asConstant

public Constant asConstant()

Description copied from class: Stamp

If this stamp represents a single value, the methods returns this single value. It returns null otherwise.

Overrides:

asConstant in class Stamp

Returns:

the constant corresponding to the single value of this stamp and null if this stamp can represent less or more than one value.

nullConstant

public JavaConstant nullConstant()

getStackKind

public JavaKind getStackKind()

Description copied from class: Stamp

Gets a Java JavaKind that can be used to store a value of this stamp on the Java bytecode stack. Returns JavaKind.Illegal if a value of this stamp can not be stored on the bytecode stack.

Specified by:

getStackKind in class Stamp

isCompressed

public boolean isCompressed()