org.graalvm.compiler.lir.util

Class IndexedValueMap

java.lang.Object

org.graalvm.compiler.lir.util.IndexedValueMap

public final class IndexedValueMap
extends Object

A map-like data structure for directly mapping int indexes to Value objects using an array. If the size of the array grows beyond IndexedValueMap.MAP_FALLBACK_THRESHOLD then this data structure does a switch to EconomicMap backing. When the data structure is populated via the copy constructor, or the IndexedValueMap.putAll(IndexedValueMap) method while being empty, the backing array or map are not copied, instead the backing array or map from the source are used. They are copied only on the next modification. Therefore, IndexedValueMap instances must not be passed to other threads.

Constructor Summary

Constructors

Constructor and Description
IndexedValueMap() Construct a new empty map.
IndexedValueMap(IndexedValueMap other) Constructs a new map containing the same mappings as the other map.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Determine whether the specified object is an IndexedValueMap and all the mappings with non-null values are equal in this map and the specified map.
void	forEach(LIRInstruction inst, LIRInstruction.OperandMode mode, EnumSet<LIRInstruction.OperandFlag> flags, InstructionValueProcedure proc) Iterate over all non-null values and, optionally, modify them.
Value	get(int index) Returns the value to which the specified index is mapped, or null if the map contains no mapping for the index.
int	hashCode()
void	put(int index, Value value) Associates the specified value with the specified index in this map.
void	putAll(IndexedValueMap stack) Copies all of the mappings with non-null value from the specified map to this map.
String	toString() Get a string representation for all mappings in this map with a non-null value.
void	visitEach(LIRInstruction inst, LIRInstruction.OperandMode mode, EnumSet<LIRInstruction.OperandFlag> flags, InstructionValueConsumer consumer) Iterate over all non-null values without modifying them.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedValueMap

public IndexedValueMap()

Construct a new empty map.

IndexedValueMap

public IndexedValueMap(IndexedValueMap other)

Constructs a new map containing the same mappings as the other map. Note that the mappings are not copied, instead the new map uses the same backing as the source map, copying it only on the next modification. As a result, the backing of the source map has to be copied on the next modification as well.

Parameters:

other - the source map whose mappings are to be placed in this map

Method Detail

get

public Value get(int index)

Returns the value to which the specified index is mapped, or null if the map contains no mapping for the index.

Parameters:

index - the index whose associated value is to be returned

Returns:

the value to which the specified index is mapped, or null if the map contains no mapping for the index

put

public void put(int index,
                Value value)

Associates the specified value with the specified index in this map. If the map previously contained a mapping for the index, the old value is replaced. If this operation requires a modification of the backing array or map and IndexedValueMap.copyOnWrite is true, the backing array or map are copied. If this map is backed by the array and this operation requires it to grow above IndexedValueMap.MAP_FALLBACK_THRESHOLD, the array is copied to the fallback map which becomes the new backing for this map.

Parameters:

index - the index with which the specified value is to be associated

value - value to be associated with the specified index

putAll

public void putAll(IndexedValueMap stack)

Copies all of the mappings with non-null value from the specified map to this map. These mappings replace any mappings that this map had for any of the indexes currently in the specified map. If this operation requires a modification of the backing array or map and IndexedValueMap.copyOnWrite is true, the backing array or map are copied. If this map is backed by the array and this operation requires it to grow above IndexedValueMap.MAP_FALLBACK_THRESHOLD, the array is copied to the fallback map which becomes the new backing for this map. If this map is empty, the mappings from the specified map are not copied, instead the new map uses the same backing as the source map, copying it only on the next modification. As a result, the backing of the source map has to be copied on the next modification as well.

Parameters:

stack - mappings to be stored in this map

equals

public boolean equals(Object other)

Determine whether the specified object is an IndexedValueMap and all the mappings with non-null values are equal in this map and the specified map.

Overrides:

equals in class Object

Parameters:

other - the object to compare this map with

Returns:

true if and only if the specified object is an IndexedValueMap and all the mappings with non-null values are equal in this map and the specified map.

forEach

public void forEach(LIRInstruction inst,
                    LIRInstruction.OperandMode mode,
                    EnumSet<LIRInstruction.OperandFlag> flags,
                    InstructionValueProcedure proc)

Iterate over all non-null values and, optionally, modify them. For each mapping in this map with a non-null value, apply the specified procedure to the value and replace the value in the mapping by the value returned by the procedure.

Parameters:

inst - current instruction

mode - the operand mode for each value

flags - a set of flags for each value

proc - procedure to apply to each value

visitEach

public void visitEach(LIRInstruction inst,
                      LIRInstruction.OperandMode mode,
                      EnumSet<LIRInstruction.OperandFlag> flags,
                      InstructionValueConsumer consumer)

Iterate over all non-null values without modifying them. For each mapping in this map with a non-null value, pass the value to the specified consumer function.

Parameters:

inst - current instruction

mode - the operand mode for each value

flags - a set of flags for each value

consumer - consumer function to be called for each value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Get a string representation for all mappings in this map with a non-null value.

Overrides:

toString in class Object

Returns:

a string representation for all mappings in this map with a non-null value