org.graalvm.compiler.core.common.type

Class RawPointerStamp

java.lang.Object

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

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

org.graalvm.compiler.core.common.type.RawPointerStamp

All Implemented Interfaces:

SpeculationReasonGroup.SpeculationContextObject

public class RawPointerStamp
extends AbstractPointerStamp

Type describing pointers to raw memory. This stamp is used for example for direct pointers to fields or array elements.

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	RawPointerStamp()

Method Summary

Modifier and Type	Method and Description
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.
protected AbstractPointerStamp	copyWith(boolean newNonNull, boolean newAlwaysNull)
Stamp	empty() Returns a stamp of the same kind, but with no allowed values.
LIRKind	getLIRKind(LIRKindTool tool) Gets a platform dependent LIRKind that can be used to store a value of this stamp.
boolean	hasValues() Test whether this stamp has legal values.
Stamp	improveWith(Stamp other) Tries to improve this stamp with the stamp given as parameter.
boolean	isCompatible(Constant constant) Check that the constant other is compatible with this stamp.
boolean	isCompatible(Stamp other) Check that the constant other is compatible with this stamp.
ResolvedJavaType	javaType(MetaAccessProvider metaAccess) Returns the type of the stamp, guaranteed to be non-null.
Stamp	join(Stamp other) Returns the intersection of this stamp and the given stamp.
Stamp	meet(Stamp other) Returns the union of this stamp and the given stamp.
Constant	readConstant(MemoryAccessProvider provider, Constant base, long displacement) Read a value of this stamp from memory.
String	toString()
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.AbstractPointerStamp

accept, alwaysNull, asAlwaysNull, asConstant, asMaybeNull, asNonNull, defaultPointerJoin, equals, getStackKind, hashCode, isCompressed, nonNull, nullConstant, pointerAlwaysNull, pointerMaybeNull, pointerNonNull

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

alwaysDistinct, isEmpty, isPointerStamp, isUnrestricted, makeSymbolic, neverDistinct, readConstant, tryImproveWith

Methods inherited from class java.lang.Object

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

Constructor Detail

RawPointerStamp

protected RawPointerStamp()

Method Detail

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

copyWith

protected AbstractPointerStamp copyWith(boolean newNonNull,
                                        boolean newAlwaysNull)

Specified by:

copyWith in class AbstractPointerStamp

meet

public Stamp meet(Stamp other)

Description copied from class: Stamp

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

Overrides:

meet in class AbstractPointerStamp

Parameters:

other - The stamp that will enlarge this stamp.

Returns:

The union of this stamp and the given 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.

Overrides:

improveWith in class AbstractPointerStamp

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

join

public Stamp join(Stamp other)

Description copied from class: Stamp

Returns the intersection of this stamp and the given stamp.

Specified by:

join in class Stamp

Parameters:

other - The stamp that will tighten this stamp.

Returns:

The intersection 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.

Overrides:

unrestricted in class AbstractPointerStamp

empty

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

hasValues

public boolean hasValues()

Description copied from class: Stamp

Test whether this stamp has legal values.

Specified by:

hasValues 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

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

isCompatible

public boolean isCompatible(Stamp other)

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

readConstant

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

Description copied from class: Stamp

Read a value of this stamp from memory.

Specified by:

readConstant in class Stamp

Returns:

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

toString

public String toString()

Specified by:

toString in class Stamp