Class AbstractWritableArray

java.lang.Object

com.oracle.truffle.js.runtime.array.ScriptArray

com.oracle.truffle.js.runtime.array.DynamicArray

com.oracle.truffle.js.runtime.array.dyn.AbstractWritableArray

Direct Known Subclasses:

AbstractDoubleArray, AbstractIntArray, AbstractJSObjectArray, AbstractObjectArray

public abstract class AbstractWritableArray
extends DynamicArray

Base class of a javascript dynamic writable array. The array implementation uses three write access modes:

• InBoundsFast: Accessed index is in bounds of the physical and logical array. So no housekeeping should usually be necessary in this access mode.
• InBounds: Accessed index is in bounds of the physical backing array. Little housekeeping.
• Supported: If a write to this index is supported by the array. Full housekeeping.
• Not Supported: If a write to this index is not supported by the array. The array will transition to another implementation that supports the written index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractWritableArray.SetSupportedProfileAccess

Nested classes/interfaces inherited from class com.oracle.truffle.js.runtime.array.DynamicArray

DynamicArray.DynamicArrayCache

Nested classes/interfaces inherited from class com.oracle.truffle.js.runtime.array.ScriptArray

ScriptArray.CreateWritableProfileAccess, ScriptArray.DefaultIterator, ScriptArray.SetLengthProfileAccess

Field Summary

Fields inherited from class com.oracle.truffle.js.runtime.array.DynamicArray

cache, INTEGRITY_LEVEL_FROZEN, INTEGRITY_LEVEL_FROZEN_LENGTH_READONLY, INTEGRITY_LEVEL_MASK, INTEGRITY_LEVEL_NONE, INTEGRITY_LEVEL_NONE_LENGTH_READONLY, INTEGRITY_LEVEL_NOT_EXTENSIBLE, INTEGRITY_LEVEL_NOT_EXTENSIBLE_LENGTH_READONLY, INTEGRITY_LEVEL_SEALED, INTEGRITY_LEVEL_SEALED_LENGTH_READONLY, INTEGRITY_LEVELS, integrityLevel, LENGTH_NOT_WRITABLE, LENGTH_WRITABLE_MASK

Fields inherited from class com.oracle.truffle.js.runtime.array.ScriptArray

EMPTY_OBJECT_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWritableArray(int integrityLevel, DynamicArray.DynamicArrayCache cache)

Method Summary

Modifier and Type	Method	Description
abstract Object	allocateArray(int length)
protected final boolean	assertHoleCount(JSDynamicObject object)
protected final boolean	checkFillHoles(JSDynamicObject object, int internalIndex, int grown)
protected void	clearUnusedArea(JSDynamicObject object, int startIdx, int endIdx, int arrayOffset, com.oracle.truffle.api.nodes.Node node, ScriptArray.SetLengthProfileAccess profile)	After shortening the array, the now unused area has to be cleared.
boolean	containsHoles(JSDynamicObject object, long index)
protected final int	countHoles(JSDynamicObject object)
protected final ScriptArray	deleteElementHoles(JSDynamicObject object, long index)
protected void	fillHoles(JSDynamicObject object, int internalIndex, int grown, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected abstract int	getArrayCapacity(JSDynamicObject object)
protected int	getArrayOffset(JSDynamicObject object)	The arrayOffset (int) is the first element in internal array.
final Object	getElement(JSDynamicObject object, long index)
final Object	getElementInBounds(JSDynamicObject object, long index)
abstract Object	getInBoundsFast(JSDynamicObject object, int index)
double	getInBoundsFastDouble(JSDynamicObject object, int index)
int	getInBoundsFastInt(JSDynamicObject object, int index)
protected long	getIndexOffset(JSDynamicObject object)	The indexOffset (int) is the first element is in array[indexOffset + arrayOffset].
protected static int	getUsedLength(JSDynamicObject object)
boolean	hasElement(JSDynamicObject object, long index)
boolean	hasHoles(JSDynamicObject object)	Returns true when this array actually has holes between ScriptArray.firstElementIndex(com.oracle.truffle.js.runtime.objects.JSDynamicObject) and ScriptArray.lastElementIndex(com.oracle.truffle.js.runtime.objects.JSDynamicObject).
boolean	hasHolesOrUnused(JSDynamicObject object)	Returns true when this array has any hole or unused elements between 0 and ScriptArray.length(com.oracle.truffle.js.runtime.objects.JSDynamicObject).
protected final void	incrementHolesCount(JSDynamicObject object, int offset)
protected abstract boolean	isHolePrepared(JSDynamicObject object, int index)	Returns true when the array contains a hole at that index.
final boolean	isInBounds(JSDynamicObject object, int index)
final boolean	isInBoundsFast(JSDynamicObject object, long index)	Returns true if the index can be written using inBoundsFast access mode.
final boolean	isSparse(JSDynamicObject object, long index)
abstract boolean	isSupported(JSDynamicObject object, long index)
final boolean	isSupportedContiguous(JSDynamicObject object, long index)
final boolean	isSupportedHoles(JSDynamicObject object, long index)
static boolean	isSupportedZeroBased(JSDynamicObject object, int index)
final long	length(JSDynamicObject object)
final int	lengthInt(JSDynamicObject object)
protected abstract void	moveRangePrepared(JSDynamicObject object, int src, int dst, int len)	Move len elements from src to dst.
long	nextElementIndex(JSDynamicObject object, long index)	Returns the next index.
protected final long	nextElementIndexHoles(JSDynamicObject object, long index0)
protected final long	nextElementIndexZeroBased(JSDynamicObject object, long index)
protected abstract int	prepareInBounds(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected final int	prepareInBoundsContiguous(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected abstract int	prepareInBoundsFast(JSDynamicObject object, long index)
protected final int	prepareInBoundsHoles(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected static void	prepareInBoundsZeroBased(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected abstract int	prepareSupported(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected final int	prepareSupportedContiguous(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected final int	prepareSupportedHoles(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
protected final void	prepareSupportedZeroBased(JSDynamicObject object, int index, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
long	previousElementIndex(JSDynamicObject object, long index)	Returns the previous index.
protected final long	previousElementIndexHoles(JSDynamicObject object, long index0)
protected final ScriptArray	removeRangeContiguous(JSDynamicObject object, long start, long end)
protected final ScriptArray	removeRangeHoles(JSDynamicObject object, long start, long end)
protected abstract void	resizeArray(JSDynamicObject object, int newCapacity, int oldCapacity, int offset)
protected void	setArrayOffset(JSDynamicObject object, int value)
protected static final void	setArrayProperties(JSDynamicObject object, long length, int usedLength, long indexOffset, int arrayOffset)
protected static final void	setArrayProperties(JSDynamicObject object, Object array, long length, int usedLength, long indexOffset, int arrayOffset)
protected abstract void	setHoleValue(JSDynamicObject object, int index)
protected void	setIndexOffset(JSDynamicObject object, long value)
final ScriptArray	setLengthImpl(JSDynamicObject object, long length, com.oracle.truffle.api.nodes.Node node, ScriptArray.SetLengthProfileAccess profile)
protected abstract void	setLengthLess(JSDynamicObject object, long length, com.oracle.truffle.api.nodes.Node node, ScriptArray.SetLengthProfileAccess profile)
protected final void	setLengthLessContiguous(JSDynamicObject object, long length, com.oracle.truffle.api.nodes.Node node, ScriptArray.SetLengthProfileAccess profile)
protected void	setLengthLessZeroBased(JSDynamicObject object, long length, com.oracle.truffle.api.nodes.Node node, ScriptArray.SetLengthProfileAccess profile)
ScriptArray	shiftRangeImpl(JSDynamicObject object, long from)	This function shifts all elements in the range from [0..limit[.
AbstractWritableArray	toContiguous(JSDynamicObject object, long index, Object value)
abstract AbstractWritableArray	toDouble(JSDynamicObject object, long index, double value)
abstract AbstractWritableArray	toHoles(JSDynamicObject object, long index, Object value)
ScriptArray	toNonContiguous(JSDynamicObject object, int index, Object value, com.oracle.truffle.api.nodes.Node node, AbstractWritableArray.SetSupportedProfileAccess profile)
AbstractWritableArray	toNonHoles(JSDynamicObject object, long index, Object value)
abstract AbstractWritableArray	toObject(JSDynamicObject object, long index, Object value)
final SparseArray	toSparse(JSDynamicObject object, long index, Object value)
protected final void	traceWriteValue(String access, int index, Object value)
protected static boolean	unusedElementsAreHoles(Object[] array, int usedStart, int usedLength)
protected abstract AbstractWritableArray	withIntegrityLevel(int newIntegrityLevel)

Methods inherited from class com.oracle.truffle.js.runtime.array.DynamicArray

cloneArray, createCache, freeze, isExtensible, isFrozen, isLengthNotWritable, isSealed, maybePreinitializeCache, preventExtensions, seal, setIntegrityLevel, setLengthNotWritable, toString

Methods inherited from class com.oracle.truffle.js.runtime.array.ScriptArray

addRange, addRangeImpl, asIterable, canDeleteElement, cast, createConstantArray, createConstantEmptyArray, deleteElement, deleteElementImpl, firstElementIndex, isHolesType, isInstance, lastElementIndex, makeMultiRangeList, makeRangeList, nextPower, ownPropertyKeys, ownPropertyKeysContiguous, ownPropertyKeysHoles, removeRange, removeRange, removeRangeImpl, setElement, setElementImpl, setLength, setLength, shiftRange, toArray, traceArrayTransition, traceWrite, valueIsByte

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractWritableArray

protected AbstractWritableArray(int integrityLevel,
 DynamicArray.DynamicArrayCache cache)

Method Details

setArrayProperties

protected static final void setArrayProperties(JSDynamicObject object,
 Object array,
 long length,
 int usedLength,
 long indexOffset,
 int arrayOffset)

setArrayProperties

protected static final void setArrayProperties(JSDynamicObject object,
 long length,
 int usedLength,
 long indexOffset,
 int arrayOffset)

isInBoundsFast

public final boolean isInBoundsFast(JSDynamicObject object,
 long index)

Returns true if the index can be written using inBoundsFast access mode.

Overrides:

isInBoundsFast in class ScriptArray

prepareInBoundsFast

protected abstract int prepareInBoundsFast(JSDynamicObject object,
 long index)

isInBounds

public final boolean isInBounds(JSDynamicObject object,
 int index)

prepareInBounds

protected abstract int prepareInBounds(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

prepareInBoundsZeroBased

protected static void prepareInBoundsZeroBased(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

getUsedLength

protected static int getUsedLength(JSDynamicObject object)

prepareInBoundsContiguous

protected final int prepareInBoundsContiguous(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

prepareInBoundsHoles

protected final int prepareInBoundsHoles(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

containsHoles

public boolean containsHoles(JSDynamicObject object,
 long index)

isSupported

public abstract boolean isSupported(JSDynamicObject object,
 long index)

isSupportedZeroBased

public static boolean isSupportedZeroBased(JSDynamicObject object,
 int index)

isSupportedContiguous

public final boolean isSupportedContiguous(JSDynamicObject object,
 long index)

isSupportedHoles

public final boolean isSupportedHoles(JSDynamicObject object,
 long index)

prepareSupported

protected abstract int prepareSupported(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

prepareSupportedZeroBased

protected final void prepareSupportedZeroBased(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

prepareSupportedContiguous

protected final int prepareSupportedContiguous(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

prepareSupportedHoles

protected final int prepareSupportedHoles(JSDynamicObject object,
 int index,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

incrementHolesCount

protected final void incrementHolesCount(JSDynamicObject object,
 int offset)

setHoleValue

protected abstract void setHoleValue(JSDynamicObject object,
 int index)

getArrayCapacity

protected abstract int getArrayCapacity(JSDynamicObject object)

getArrayOffset

protected int getArrayOffset(JSDynamicObject object)

The arrayOffset (int) is the first element in internal array.

setArrayOffset

protected void setArrayOffset(JSDynamicObject object,
 int value)

getIndexOffset

protected long getIndexOffset(JSDynamicObject object)

The indexOffset (int) is the first element is in array[indexOffset + arrayOffset].

setIndexOffset

protected void setIndexOffset(JSDynamicObject object,
 long value)

fillHoles

protected void fillHoles(JSDynamicObject object,
 int internalIndex,
 int grown,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

checkFillHoles

protected final boolean checkFillHoles(JSDynamicObject object,
 int internalIndex,
 int grown)

toDouble

public abstract AbstractWritableArray toDouble(JSDynamicObject object,
 long index,
 double value)

toObject

public abstract AbstractWritableArray toObject(JSDynamicObject object,
 long index,
 Object value)

toContiguous

public AbstractWritableArray toContiguous(JSDynamicObject object,
 long index,
 Object value)

toHoles

public abstract AbstractWritableArray toHoles(JSDynamicObject object,
 long index,
 Object value)

toNonHoles

public AbstractWritableArray toNonHoles(JSDynamicObject object,
 long index,
 Object value)

toSparse

public final SparseArray toSparse(JSDynamicObject object,
 long index,
 Object value)

resizeArray

protected abstract void resizeArray(JSDynamicObject object,
 int newCapacity,
 int oldCapacity,
 int offset)

isSparse

public final boolean isSparse(JSDynamicObject object,
 long index)

hasElement

public boolean hasElement(JSDynamicObject object,
 long index)

Specified by:

hasElement in class ScriptArray

Returns:

true if array has an element (not a hole) at this index.

nextElementIndex

public long nextElementIndex(JSDynamicObject object,
 long index)

Description copied from class: ScriptArray

Returns the next index. The index is guaranteed either to exist, or be MAX_SAFE_INTEGER. Reason for MAX_SAFE_INTEGER is: this array could be the prototype of another one; returning the length() of this array would be wrong, if the inheriting array is longer, but has a hole at length().

Specified by:

nextElementIndex in class ScriptArray

isHolePrepared

protected abstract boolean isHolePrepared(JSDynamicObject object,
 int index)

Returns true when the array contains a hole at that index. The index is a prepared (internal) index.

nextElementIndexHoles

protected final long nextElementIndexHoles(JSDynamicObject object,
 long index0)

nextElementIndexZeroBased

protected final long nextElementIndexZeroBased(JSDynamicObject object,
 long index)

previousElementIndex

public long previousElementIndex(JSDynamicObject object,
 long index)

Description copied from class: ScriptArray

Returns the previous index. The index is guaranteed either to exist, or be smaller than firstElementIndex().

Specified by:

previousElementIndex in class ScriptArray

previousElementIndexHoles

protected final long previousElementIndexHoles(JSDynamicObject object,
 long index0)

length

public final long length(JSDynamicObject object)

Specified by:

length in class ScriptArray

lengthInt

public final int lengthInt(JSDynamicObject object)

Specified by:

lengthInt in class ScriptArray

setLengthImpl

public final ScriptArray setLengthImpl(JSDynamicObject object,
 long length,
 com.oracle.truffle.api.nodes.Node node,
 ScriptArray.SetLengthProfileAccess profile)

Specified by:

setLengthImpl in class ScriptArray

setLengthLess

protected abstract void setLengthLess(JSDynamicObject object,
 long length,
 com.oracle.truffle.api.nodes.Node node,
 ScriptArray.SetLengthProfileAccess profile)

setLengthLessZeroBased

protected void setLengthLessZeroBased(JSDynamicObject object,
 long length,
 com.oracle.truffle.api.nodes.Node node,
 ScriptArray.SetLengthProfileAccess profile)

setLengthLessContiguous

protected final void setLengthLessContiguous(JSDynamicObject object,
 long length,
 com.oracle.truffle.api.nodes.Node node,
 ScriptArray.SetLengthProfileAccess profile)

clearUnusedArea

protected void clearUnusedArea(JSDynamicObject object,
 int startIdx,
 int endIdx,
 int arrayOffset,
 com.oracle.truffle.api.nodes.Node node,
 ScriptArray.SetLengthProfileAccess profile)

After shortening the array, the now unused area has to be cleared.

getElement

public final Object getElement(JSDynamicObject object,
 long index)

Specified by:

getElement in class ScriptArray

getElementInBounds

public final Object getElementInBounds(JSDynamicObject object,
 long index)

Specified by:

getElementInBounds in class ScriptArray

getInBoundsFast

public abstract Object getInBoundsFast(JSDynamicObject object,
 int index)

getInBoundsFastInt

public int getInBoundsFastInt(JSDynamicObject object,
 int index)
                       throws com.oracle.truffle.api.nodes.UnexpectedResultException

Throws:

com.oracle.truffle.api.nodes.UnexpectedResultException

getInBoundsFastDouble

public double getInBoundsFastDouble(JSDynamicObject object,
 int index)
                             throws com.oracle.truffle.api.nodes.UnexpectedResultException

Throws:

com.oracle.truffle.api.nodes.UnexpectedResultException

deleteElementHoles

protected final ScriptArray deleteElementHoles(JSDynamicObject object,
 long index)

traceWriteValue

protected final void traceWriteValue(String access,
 int index,
 Object value)

toNonContiguous

public ScriptArray toNonContiguous(JSDynamicObject object,
 int index,
 Object value,
 com.oracle.truffle.api.nodes.Node node,
 AbstractWritableArray.SetSupportedProfileAccess profile)

withIntegrityLevel

protected abstract AbstractWritableArray withIntegrityLevel(int newIntegrityLevel)

Specified by:

withIntegrityLevel in class DynamicArray

allocateArray

public abstract Object allocateArray(int length)

removeRangeContiguous

protected final ScriptArray removeRangeContiguous(JSDynamicObject object,
 long start,
 long end)

removeRangeHoles

protected final ScriptArray removeRangeHoles(JSDynamicObject object,
 long start,
 long end)

hasHoles

public boolean hasHoles(JSDynamicObject object)

Description copied from class: ScriptArray

Returns true when this array actually has holes between ScriptArray.firstElementIndex(com.oracle.truffle.js.runtime.objects.JSDynamicObject) and ScriptArray.lastElementIndex(com.oracle.truffle.js.runtime.objects.JSDynamicObject). Implies ScriptArray.isHolesType().

Specified by:

hasHoles in class ScriptArray

See Also:

• ScriptArray.hasHolesOrUnused(com.oracle.truffle.js.runtime.objects.JSDynamicObject)

hasHolesOrUnused

public boolean hasHolesOrUnused(JSDynamicObject object)

Description copied from class: ScriptArray

Returns true when this array has any hole or unused elements between 0 and ScriptArray.length(com.oracle.truffle.js.runtime.objects.JSDynamicObject).

Overrides:

hasHolesOrUnused in class ScriptArray

See Also:

• ScriptArray.hasHoles(com.oracle.truffle.js.runtime.objects.JSDynamicObject)

countHoles

protected final int countHoles(JSDynamicObject object)

assertHoleCount

protected final boolean assertHoleCount(JSDynamicObject object)

moveRangePrepared

protected abstract void moveRangePrepared(JSDynamicObject object,
 int src,
 int dst,
 int len)

Move len elements from src to dst.

shiftRangeImpl

public ScriptArray shiftRangeImpl(JSDynamicObject object,
 long from)

Description copied from class: ScriptArray

This function shifts all elements in the range from [0..limit[. Depending on the underlying implementation, the shift operation might be zero-copy. Can be used by e.g. Array.prototype.shift;

Overrides:

shiftRangeImpl in class ScriptArray

unusedElementsAreHoles

protected static boolean unusedElementsAreHoles(Object[] array,
 int usedStart,
 int usedLength)