org.graalvm.compiler.core.common.type

Class IntegerStamp

java.lang.Object

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

org.graalvm.compiler.core.common.type.ArithmeticStamp

org.graalvm.compiler.core.common.type.PrimitiveStamp

org.graalvm.compiler.core.common.type.IntegerStamp

All Implemented Interfaces:

SpeculationReasonGroup.SpeculationContextObject

public final class IntegerStamp
extends PrimitiveStamp

Describes the possible values of a node that produces an int or long result. The description consists of (inclusive) lower and upper bounds and up (may be set) and down (always set) bit-masks.

Nested Class Summary

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

SpeculationReasonGroup.SpeculationContextObject.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static ArithmeticOpTable	OPS

Method Summary

Modifier and Type	Method and Description
static boolean	addCanOverflow(IntegerStamp a, IntegerStamp b)
static boolean	addOverflowsNegatively(long x, long y, int bits)
static boolean	addOverflowsPositively(long x, long y, int bits)
JavaConstant	asConstant() If this stamp represents a single value, the methods returns this single value.
boolean	canBeNegative()
boolean	canBePositive()
static long	carryBits(long x, long y)
Stamp	constant(Constant c, MetaAccessProvider meta) If it is possible to represent single value stamps of this kind, this method returns the stamp representing the single value c.
boolean	contains(long value)
static IntegerStamp	create(int bits, long lowerBoundInput, long upperBoundInput)
static IntegerStamp	create(int bits, long lowerBoundInput, long upperBoundInput, long downMask, long upMask)
static IntegerStamp	create(int bits, long lowerBoundInput, long upperBoundInput, long downMask, long upMask, boolean canBeZero)
SerializableConstant	deserialize(ByteBuffer buffer)
long	downMask() This bit-mask describes the bits that are always set in the value described by this stamp.
IntegerStamp	empty() Returns a stamp of the same kind, but with no allowed values.
boolean	equals(Object obj)
LIRKind	getLIRKind(LIRKindTool tool) Gets a platform dependent LIRKind that can be used to store a value of this stamp.
JavaKind	getStackKind() Gets a Java JavaKind that can be used to store a value of this stamp on the Java bytecode stack.
int	hashCode()
boolean	hasValues() Test whether this stamp has legal values.
boolean	isCompatible(Constant constant) Check that the constant other is compatible with this stamp.
boolean	isCompatible(Stamp stamp) Check that the constant other is compatible with this stamp.
boolean	isNegative()
boolean	isPositive()
boolean	isStrictlyNegative()
boolean	isStrictlyPositive()
boolean	isUnrestricted() Tests whether this stamp represents all values of this kind.
ResolvedJavaType	javaType(MetaAccessProvider metaAccess) Returns the type of the stamp, guaranteed to be non-null.
IntegerStamp	join(Stamp otherStamp) Returns the intersection of this stamp and the given stamp.
long	lowerBound() The signed inclusive lower bound on the value described by this stamp.
Stamp	meet(Stamp otherStamp) Returns the union of this stamp and the given stamp.
static boolean	multiplicationCanOverflow(IntegerStamp a, IntegerStamp b)
static boolean	multiplicationOverflows(long a, long b, int bits)
static boolean	negateCanOverflow(IntegerStamp stamp) Returns if stamp can overflow when applying negation.
Constant	readConstant(MemoryAccessProvider provider, Constant base, long displacement, Stamp accessStamp) Read a value of this stamp from memory where the underlying storage might be of a different size.
static boolean	sameSign(IntegerStamp s1, IntegerStamp s2) Checks if the 2 stamps represent values of the same sign.
static IntegerStamp	stampForMask(int bits, long downMask, long upMask)
static boolean	subtractionCanOverflow(IntegerStamp x, IntegerStamp y)
static boolean	subtractionOverflows(long x, long y, int bits)
String	toString()
IntegerStamp	unrestricted() Returns a stamp of the same kind, but allowing the full value range of the kind.
long	unsignedLowerBound()
long	unsignedUpperBound()
long	upMask() This bit-mask describes the bits that can be set in the value described by this stamp.
long	upperBound() The signed inclusive upper bound on the value described by this stamp.

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

accept, getBits, getBits, readConstant, readJavaConstant

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

getOps, improveWith

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

alwaysDistinct, isEmpty, isPointerStamp, makeSymbolic, neverDistinct, tryImproveWith

Methods inherited from class java.lang.Object

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

Field Detail

OPS

public static final ArithmeticOpTable OPS

Method Detail

create

public static IntegerStamp create(int bits,
                                  long lowerBoundInput,
                                  long upperBoundInput)

create

public static IntegerStamp create(int bits,
                                  long lowerBoundInput,
                                  long upperBoundInput,
                                  long downMask,
                                  long upMask)

create

public static IntegerStamp create(int bits,
                                  long lowerBoundInput,
                                  long upperBoundInput,
                                  long downMask,
                                  long upMask,
                                  boolean canBeZero)

stampForMask

public static IntegerStamp stampForMask(int bits,
                                        long downMask,
                                        long upMask)

unrestricted

public IntegerStamp 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

empty

public IntegerStamp empty()

Description copied from class: Stamp

Returns a stamp of the same kind, but with no allowed values. Stamp.empty() is the neutral element of the Stamp.meet(Stamp) operation.

Specified by:

empty in class Stamp

constant

public Stamp constant(Constant c,
                      MetaAccessProvider meta)

Description copied from class: Stamp

If it is possible to represent single value stamps of this kind, this method returns the stamp representing the single value c. stamp.constant(c).asConstant() should be equal to c.

If it is not possible to represent single value stamps, this method returns a stamp that includes c, and is otherwise as narrow as possible.

Specified by:

constant in class Stamp

deserialize

public SerializableConstant deserialize(ByteBuffer buffer)

Specified by:

deserialize in class ArithmeticStamp

hasValues

public boolean hasValues()

Description copied from class: Stamp

Test whether this stamp has legal values.

Specified by:

hasValues in class Stamp

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

getLIRKind

public LIRKind getLIRKind(LIRKindTool tool)

Description copied from class: Stamp

Gets a platform dependent LIRKind that can be used to store a value of this stamp.

Specified by:

getLIRKind in class Stamp

javaType

public ResolvedJavaType javaType(MetaAccessProvider metaAccess)

Description copied from class: Stamp

Returns the type of the stamp, guaranteed to be non-null. In some cases, this requires the lookup of class meta data, therefore the MetaAccessProvider is mandatory.

Specified by:

javaType in class Stamp

readConstant

public Constant readConstant(MemoryAccessProvider provider,
                             Constant base,
                             long displacement,
                             Stamp accessStamp)

Description copied from class: Stamp

Read a value of this stamp from memory where the underlying storage might be of a different size. accessStamp is used to specify the size of access if it differs from the size of the result.

Overrides:

readConstant in class Stamp

Returns:

the value read or null if the value can't be read for some reason

lowerBound

public long lowerBound()

The signed inclusive lower bound on the value described by this stamp.

upperBound

public long upperBound()

The signed inclusive upper bound on the value described by this stamp.

downMask

public long downMask()

This bit-mask describes the bits that are always set in the value described by this stamp.

upMask

public long upMask()

This bit-mask describes the bits that can be set in the value described by this stamp.

isUnrestricted

public boolean isUnrestricted()

Description copied from class: Stamp

Tests whether this stamp represents all values of this kind.

Overrides:

isUnrestricted in class Stamp

contains

public boolean contains(long value)

isPositive

public boolean isPositive()

isNegative

public boolean isNegative()

isStrictlyPositive

public boolean isStrictlyPositive()

isStrictlyNegative

public boolean isStrictlyNegative()

canBePositive

public boolean canBePositive()

canBeNegative

public boolean canBeNegative()

toString

public String toString()

Specified by:

toString in class Stamp

meet

public Stamp meet(Stamp otherStamp)

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:

otherStamp - The stamp that will enlarge this stamp.

Returns:

The union of this stamp and the given stamp.

join

public IntegerStamp join(Stamp otherStamp)

Description copied from class: Stamp

Returns the intersection of this stamp and the given stamp.

Specified by:

join in class Stamp

Parameters:

otherStamp - The stamp that will tighten this stamp.

Returns:

The intersection of this stamp and the given stamp.

isCompatible

public boolean isCompatible(Stamp stamp)

Description copied from class: Stamp

Check that the constant other is compatible with this stamp.

Specified by:

isCompatible in class Stamp

isCompatible

public boolean isCompatible(Constant constant)

Description copied from class: Stamp

Check that the constant other is compatible with this stamp.

Specified by:

isCompatible in class Stamp

unsignedUpperBound

public long unsignedUpperBound()

unsignedLowerBound

public long unsignedLowerBound()

hashCode

public int hashCode()

Overrides:

hashCode in class PrimitiveStamp

equals

public boolean equals(Object obj)

Overrides:

equals in class PrimitiveStamp

sameSign

public static boolean sameSign(IntegerStamp s1,
                               IntegerStamp s2)

Checks if the 2 stamps represent values of the same sign. Returns true if the two stamps are both positive of null or if they are both strictly negative

Returns:

true if the two stamps are both positive of null or if they are both strictly negative

asConstant

public JavaConstant 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.

addCanOverflow

public static boolean addCanOverflow(IntegerStamp a,
                                     IntegerStamp b)

addOverflowsPositively

public static boolean addOverflowsPositively(long x,
                                             long y,
                                             int bits)

addOverflowsNegatively

public static boolean addOverflowsNegatively(long x,
                                             long y,
                                             int bits)

carryBits

public static long carryBits(long x,
                             long y)

multiplicationOverflows

public static boolean multiplicationOverflows(long a,
                                              long b,
                                              int bits)

multiplicationCanOverflow

public static boolean multiplicationCanOverflow(IntegerStamp a,
                                                IntegerStamp b)

subtractionCanOverflow

public static boolean subtractionCanOverflow(IntegerStamp x,
                                             IntegerStamp y)

subtractionOverflows

public static boolean subtractionOverflows(long x,
                                           long y,
                                           int bits)

negateCanOverflow

public static boolean negateCanOverflow(IntegerStamp stamp)

Returns if stamp can overflow when applying negation. It effectively tests if stamp's value range contains the minimal value of an N-bits integer, where N is the width in bits of the values described by stamp.

See Also:

Math.negateExact(int)