com.oracle.graal.pointsto.typestate

Class TypeState

java.lang.Object

com.oracle.graal.pointsto.typestate.TypeState

Direct Known Subclasses:

MultiTypeState, SingleTypeState

public abstract class TypeState
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeState.TypesObjectsIterator This is a special iterator for the type state.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	properties A bit array of properties for this type state.

Constructor Summary

Constructors

Constructor and Description
TypeState(int properties)

Method Summary

Modifier and Type	Method and Description
abstract boolean	canBeNull()
boolean	closeToAllInstantiated(BigBang bb) The MultiTypeState overrides this method and provides the proper test.
boolean	containsObject(AnalysisObject object) Returns true if this type state contains the object, otherwise it returns false.
abstract boolean	containsType(AnalysisType exactType) Returns true if this type state contains the type, otherwise it returns false.
abstract boolean	equals(Object o)
abstract AnalysisType	exactType() If this type state has a single, exact type it returns that type, otherwise it returns null.
abstract TypeState	exactTypeState(BigBang bb, AnalysisType exactType) This method is needed for accessing the SingleTypeState associated with an specific type of a MutiTypeState, e.g.
static TypeState	forAllocation(BigBang bb, org.graalvm.compiler.nodes.ValueNode allocation, BytecodeLocation allocationLabel, AnalysisType exactType) Wraps the analysis object corresponding to an allocation site into a non-null type state.
static TypeState	forAllocation(BigBang bb, org.graalvm.compiler.nodes.ValueNode allocation, BytecodeLocation allocationSite, AnalysisType objectType, AnalysisContext allocationContext) Wraps the analysis object corresponding to an allocation site for a given context into a non-null type state.
protected abstract TypeState	forCanBeNull(BigBang bb, boolean stateCanBeNull)
static TypeState	forClone(BigBang bb, org.graalvm.compiler.nodes.ValueNode cloneSource, BytecodeLocation cloneSite, AnalysisType type, AnalysisContext allocationContext) Wraps the analysis object corresponding to a clone site for a given context into a non-null type state.
static TypeState	forConstant(BigBang bb, jdk.vm.ci.meta.JavaConstant constant, AnalysisType exactType) Wraps the analysis object corresponding to a JavaConstant into a non-null type state.
static TypeState	forContextInsensitiveTypeState(BigBang bb, TypeState state) Simplifies a type state by replacing all context sensitive objects with context insensitive objects.
static TypeState	forEmpty()
static TypeState	forExactType(BigBang bb, AnalysisObject object, boolean canBeNull)
static TypeState	forExactType(BigBang bb, AnalysisType exactType, boolean canBeNull)
static TypeState	forExactTypes(BigBang bb, BitSet exactTypes, boolean canBeNull)
static TypeState	forIntersection(BigBang bb, TypeState s1, TypeState s2)
TypeState	forNonNull(BigBang bb)
static TypeState	forNonNullObject(BigBang bb, AnalysisObject object) Wraps an analysis object into a non-null type state.
static TypeState	forNull()
static TypeState	forSubtraction(BigBang bb, TypeState s1, TypeState s2)
static TypeState	forUnion(BigBang bb, TypeState s1, TypeState s2)
static TypeState	forUnknown()
int	getId(BigBang bb)
int	getProperties()
TypeState.TypesObjectsIterator	getTypesObjectsIterator() Provides a special iterator for the type state.
abstract boolean	hasExactTypes(BitSet typesBitSet) Returns true if the type state contains exact the same types as the bit set.
int	hashCode()
boolean	isAllocation()
boolean	isConstant()
boolean	isEmpty()
boolean	isMultiTypeState()
boolean	isNull()
boolean	isSingleTypeState()
boolean	isUnknown()
void	noteMerge(BigBang bb) Note that the objects of this type state have been merged.
abstract AnalysisObject[]	objects() Returns the objects as an array.
Iterable<AnalysisObject>	objects(AnalysisType type) Provides an iterable for the objects corresponding to the type.
abstract AnalysisObject[]	objectsArray(AnalysisType type) Returns the objects corresponding to the type.
abstract int	objectsCount() Get the number of objects.
protected abstract Iterator<AnalysisObject>	objectsIterator(AnalysisType type) Provides an iterator for the objects corresponding to the type.
Stream<AnalysisObject>	objectsStream() Provides a stream for the objects.
void	setId(BigBang bb, int id)
Iterable<AnalysisType>	types() Provides an iterable for the types for easy "for-each loop" iteration.
abstract int	typesCount() Get the number of types.
protected abstract Iterator<AnalysisType>	typesIterator() Provides an iterator over the types.
Stream<AnalysisType>	typesStream() Provides a stream for the types.
boolean	verifyDeclaredType(AnalysisType declaredType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

properties

protected final int properties

A bit array of properties for this type state.

Constructor Detail

TypeState

public TypeState(int properties)

Method Detail

getProperties

public int getProperties()

hasExactTypes

public abstract boolean hasExactTypes(BitSet typesBitSet)

Returns true if the type state contains exact the same types as the bit set.

typesCount

public abstract int typesCount()

Get the number of types.

exactType

public abstract AnalysisType exactType()

If this type state has a single, exact type it returns that type, otherwise it returns null.

typesIterator

protected abstract Iterator<AnalysisType> typesIterator()

Provides an iterator over the types.

types

public Iterable<AnalysisType> types()

Provides an iterable for the types for easy "for-each loop" iteration.

typesStream

public Stream<AnalysisType> typesStream()

Provides a stream for the types.

containsType

public abstract boolean containsType(AnalysisType exactType)

Returns true if this type state contains the type, otherwise it returns false.

objectsCount

public abstract int objectsCount()

Get the number of objects.

objects

public abstract AnalysisObject[] objects()

Returns the objects as an array.

objectsArray

public abstract AnalysisObject[] objectsArray(AnalysisType type)

Returns the objects corresponding to the type. It copies those objects to a new array.

objectsIterator

protected abstract Iterator<AnalysisObject> objectsIterator(AnalysisType type)

Provides an iterator for the objects corresponding to the type. The objects are returned from the internal objects array and are not materialized to a different data structure.

objects

public Iterable<AnalysisObject> objects(AnalysisType type)

Provides an iterable for the objects corresponding to the type. The objects are returned from the internal objects array and are not materialized to a different data structure.

objectsStream

public Stream<AnalysisObject> objectsStream()

Provides a stream for the objects.

containsObject

public boolean containsObject(AnalysisObject object)

Returns true if this type state contains the object, otherwise it returns false.

getTypesObjectsIterator

public TypeState.TypesObjectsIterator getTypesObjectsIterator()

Provides a special iterator for the type state. It iterates over analysis types and objects in tandem doing a single pass over the objects array. See TypeState.TypesObjectsIterator for a complete explanation.

isAllocation

public boolean isAllocation()

isConstant

public boolean isConstant()

isEmpty

public boolean isEmpty()

isUnknown

public boolean isUnknown()

isSingleTypeState

public boolean isSingleTypeState()

isMultiTypeState

public boolean isMultiTypeState()

isNull

public boolean isNull()

canBeNull

public abstract boolean canBeNull()

noteMerge

public void noteMerge(BigBang bb)

Note that the objects of this type state have been merged.

exactTypeState

public abstract TypeState exactTypeState(BigBang bb,
                                         AnalysisType exactType)

This method is needed for accessing the SingleTypeState associated with an specific type of a MutiTypeState, e.g. for transferring the state from a virtual invoke type flow to the formal receiver flow of a specific callee resolved on the specified type.

verifyDeclaredType

public boolean verifyDeclaredType(AnalysisType declaredType)

closeToAllInstantiated

public boolean closeToAllInstantiated(BigBang bb)

The MultiTypeState overrides this method and provides the proper test. All the other type states have only 0 or 1 types.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

getId

public int getId(BigBang bb)

setId

public void setId(BigBang bb,
                  int id)

forEmpty

public static TypeState forEmpty()

forNull

public static TypeState forNull()

forUnknown

public static TypeState forUnknown()

forNonNullObject

public static TypeState forNonNullObject(BigBang bb,
                                         AnalysisObject object)

Wraps an analysis object into a non-null type state.

forConstant

public static TypeState forConstant(BigBang bb,
                                    jdk.vm.ci.meta.JavaConstant constant,
                                    AnalysisType exactType)

Wraps the analysis object corresponding to a JavaConstant into a non-null type state.

forAllocation

public static TypeState forAllocation(BigBang bb,
                                      org.graalvm.compiler.nodes.ValueNode allocation,
                                      BytecodeLocation allocationLabel,
                                      AnalysisType exactType)

Wraps the analysis object corresponding to an allocation site into a non-null type state.

forAllocation

public static TypeState forAllocation(BigBang bb,
                                      org.graalvm.compiler.nodes.ValueNode allocation,
                                      BytecodeLocation allocationSite,
                                      AnalysisType objectType,
                                      AnalysisContext allocationContext)

Wraps the analysis object corresponding to an allocation site for a given context into a non-null type state.

forClone

public static TypeState forClone(BigBang bb,
                                 org.graalvm.compiler.nodes.ValueNode cloneSource,
                                 BytecodeLocation cloneSite,
                                 AnalysisType type,
                                 AnalysisContext allocationContext)

Wraps the analysis object corresponding to a clone site for a given context into a non-null type state.

forExactType

public static TypeState forExactType(BigBang bb,
                                     AnalysisType exactType,
                                     boolean canBeNull)

forExactType

public static TypeState forExactType(BigBang bb,
                                     AnalysisObject object,
                                     boolean canBeNull)

forExactTypes

public static TypeState forExactTypes(BigBang bb,
                                      BitSet exactTypes,
                                      boolean canBeNull)

forContextInsensitiveTypeState

public static TypeState forContextInsensitiveTypeState(BigBang bb,
                                                       TypeState state)

Simplifies a type state by replacing all context sensitive objects with context insensitive objects.

forNonNull

public final TypeState forNonNull(BigBang bb)

forCanBeNull

protected abstract TypeState forCanBeNull(BigBang bb,
                                          boolean stateCanBeNull)

forUnion

public static TypeState forUnion(BigBang bb,
                                 TypeState s1,
                                 TypeState s2)

forIntersection

public static TypeState forIntersection(BigBang bb,
                                        TypeState s1,
                                        TypeState s2)

forSubtraction

public static TypeState forSubtraction(BigBang bb,
                                       TypeState s1,
                                       TypeState s2)