Marker interface for location identities. A different location identity of two memory accesses guarantees that the two accesses do not interfere.

Clients of LocationIdentity must use equals(Object), not ==, when comparing two LocationIdentity values for equality. Likewise, they must not use java.util.IdentityHashMaps with LocationIdentity values as keys.

Modifier and Type	Class and Description
private static class	LocationIdentity.AnyLocationIdentity
private static class	LocationIdentity.InitLocationIdentity

Field Summary

Modifier and Type	Field and Description
public static final LocationIdentity	ANY_LOCATION Indicates that the given location is the union of all possible mutable locations.
public static final LocationIdentity	INIT_LOCATION Location only allowed to be used for writes.

Access	Constructor and Description
protected	LocationIdentity() Creates a new location identity.

Method Summary

Modifier and Type	Method and Description
public static LocationIdentity	any() Indicates that the given location is the union of all possible mutable locations.
public static LocationIdentity	init() Location only allowed to be used for writes.
public final boolean	isAny() Returns true if this location identity is `any`.
public abstract boolean	isImmutable() Denotes a location is unchanging in all cases.
public final boolean	isInit() Returns true if this location identity is `init`.
public final boolean	isMutable() The inversion of `isImmutable`.
public final boolean	isSingle() Returns true if this location identity is not `any`.
public final boolean	overlaps(LocationIdentity other) Returns true if the memory slice denoted by this location identity may overlap with the provided other location identity.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ANY_LOCATION	back to summary
public static final LocationIdentity ANY_LOCATION Indicates that the given location is the union of all possible mutable locations. A write to such a location kill all reads from mutable locations and a read from this location is killed by any write (except for initialization writes). Since 19.0

ANY_LOCATION

back to summary

public static final LocationIdentity ANY_LOCATION

Indicates that the given location is the union of all possible mutable locations. A write to such a location kill all reads from mutable locations and a read from this location is killed by any write (except for initialization writes).

Since: 19.0

INIT_LOCATION	back to summary
public static final LocationIdentity INIT_LOCATION Location only allowed to be used for writes. Indicates that a completely new memory location is written. Kills no read. The previous value at the given location must be either uninitialized or null. Writes to this location do not need a GC pre-barrier. Since 19.0

INIT_LOCATION

back to summary

public static final LocationIdentity INIT_LOCATION

Location only allowed to be used for writes. Indicates that a completely new memory location is written. Kills no read. The previous value at the given location must be either uninitialized or null. Writes to this location do not need a GC pre-barrier.

Since: 19.0

Constructor Detail

LocationIdentity back to summary

LocationIdentity	back to summary
protected LocationIdentity() Creates a new location identity. Subclasses are responsible to provide proper implementations of `equals` and `hashCode`. Since 19.0

protected LocationIdentity()

Creates a new location identity. Subclasses are responsible to provide proper implementations of equals and hashCode.

Since: 19.0

Method Detail

any	back to summary
public static LocationIdentity any() Indicates that the given location is the union of all possible mutable locations. A write to such a location kill all reads from mutable locations and a read from this location is killed by any write (except for initialization writes). Since 19.0

any

back to summary

public static LocationIdentity any()

Since: 19.0

init	back to summary
public static LocationIdentity init() Location only allowed to be used for writes. Indicates that a completely new memory location is written. Kills no read. The previous value at the given location must be either uninitialized or null. Writes to this location do not need a GC pre-barrier. Since 19.0

init

back to summary

public static LocationIdentity init()

Since: 19.0

isAny back to summary

isAny	back to summary
public final boolean isAny() Returns true if this location identity is `any`. Since 19.0

public final boolean isAny()

Returns true if this location identity is any.

Since: 19.0

isImmutable	back to summary
public abstract boolean isImmutable() Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment. Since 19.0

isImmutable

back to summary

public abstract boolean isImmutable()

Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment.

Since: 19.0

isInit back to summary

isInit	back to summary
public final boolean isInit() Returns true if this location identity is `init`. Since 19.0

public final boolean isInit()

Returns true if this location identity is init.

Since: 19.0

isMutable back to summary

isMutable	back to summary
public final boolean isMutable() The inversion of `isImmutable`. Since 19.0

public final boolean isMutable()

The inversion of isImmutable.

Since: 19.0

isSingle back to summary

isSingle	back to summary
public final boolean isSingle() Returns true if this location identity is not `any`. Since 19.0

public final boolean isSingle()

Returns true if this location identity is not any.

Since: 19.0

overlaps	back to summary
public final boolean overlaps(LocationIdentity other) Returns true if the memory slice denoted by this location identity may overlap with the provided other location identity. Since 19.0

overlaps

back to summary

public final boolean overlaps(LocationIdentity other)

Returns true if the memory slice denoted by this location identity may overlap with the provided other location identity.

Since: 19.0

org.graalvm.word back to summary

private final Class LocationIdentity.AnyLocationIdentity

Class Inheritance

extends LocationIdentity

java.lang.Object
org.graalvm.word.LocationIdentity
org.graalvm.word.LocationIdentity.AnyLocationIdentity

Field Summary

Inherited from org.graalvm.word.LocationIdentity:: ANY_LOCATION INIT_LOCATION

Constructor Summary

Access	Constructor and Description
private	AnyLocationIdentity()

Method Summary

Modifier and Type	Method and Description
public boolean	isImmutable() Implements abstract org.graalvm.word.LocationIdentity.isImmutable. Denotes a location is unchanging in all cases.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.graalvm.word.LocationIdentity:: any init isAny isInit isMutable isSingle overlaps

Constructor Detail

AnyLocationIdentity	back to summary
private AnyLocationIdentity()

Method Detail

isImmutable	back to summary
public boolean isImmutable() Implements abstract org.graalvm.word.LocationIdentity.isImmutable. Doc from org.graalvm.word.LocationIdentity.isImmutable. Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment. Annotations @Override

isImmutable

back to summary

public boolean isImmutable()

Implements abstract org.graalvm.word.LocationIdentity.isImmutable.

Doc from org.graalvm.word.LocationIdentity.isImmutable.

Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.graalvm.word back to summary

private final Class LocationIdentity.InitLocationIdentity

Class Inheritance

extends LocationIdentity

java.lang.Object
org.graalvm.word.LocationIdentity
org.graalvm.word.LocationIdentity.InitLocationIdentity

Field Summary

Inherited from org.graalvm.word.LocationIdentity:: ANY_LOCATION INIT_LOCATION

Constructor Summary

Access	Constructor and Description
private	InitLocationIdentity()

Method Summary

Modifier and Type	Method and Description
public boolean	isImmutable() Implements abstract org.graalvm.word.LocationIdentity.isImmutable. Denotes a location is unchanging in all cases.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.graalvm.word.LocationIdentity:: any init isAny isInit isMutable isSingle overlaps

Constructor Detail

InitLocationIdentity	back to summary
private InitLocationIdentity()

Method Detail

isImmutable	back to summary
public boolean isImmutable() Implements abstract org.graalvm.word.LocationIdentity.isImmutable. Doc from org.graalvm.word.LocationIdentity.isImmutable. Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment. Annotations @Override

isImmutable

back to summary

public boolean isImmutable()

Implements abstract org.graalvm.word.LocationIdentity.isImmutable.

Doc from org.graalvm.word.LocationIdentity.isImmutable.

Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class LocationIdentity

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LocationIdentity.AnyLocationIdentity

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class LocationIdentity.InitLocationIdentity

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail