com.oracle.truffle.object.LayoutStrategy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages
that achieves high performance when combined with Graal.
/*
* Copyright (c) 2014, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.truffle.object;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.object.DynamicObject;
import com.oracle.truffle.api.object.Location;
import com.oracle.truffle.api.object.Property;
import com.oracle.truffle.object.ShapeImpl.BaseAllocator;
import com.oracle.truffle.object.Transition.AddPropertyTransition;
import com.oracle.truffle.object.Transition.DirectReplacePropertyTransition;
import com.oracle.truffle.object.Transition.ObjectFlagsTransition;
import com.oracle.truffle.object.Transition.ObjectTypeTransition;
import com.oracle.truffle.object.Transition.RemovePropertyTransition;
/** @since 0.17 or earlier */
@SuppressWarnings("deprecation")
public abstract class LayoutStrategy {
/**
* @since 0.17 or earlier
*/
protected LayoutStrategy() {
}
protected abstract int getLocationOrdinal(Location location);
/** @since 0.17 or earlier */
protected abstract boolean updateShape(DynamicObject object);
/** @since 0.17 or earlier */
protected abstract ShapeImpl ensureValid(ShapeImpl newShape);
/** @since 0.17 or earlier */
protected abstract ShapeImpl ensureSpace(ShapeImpl shape, Location location);
/** @since 0.17 or earlier */
public abstract BaseAllocator createAllocator(LayoutImpl shape);
/** @since 0.17 or earlier */
public abstract BaseAllocator createAllocator(ShapeImpl shape);
/** @since 0.17 or earlier */
protected ShapeImpl defineProperty(ShapeImpl shape, Object key, Object value, int flags, com.oracle.truffle.api.object.LocationFactory locationFactory) {
return defineProperty(shape, key, value, flags, locationFactory, Flags.DEFAULT);
}
protected ShapeImpl defineProperty(ShapeImpl shape, Object key, Object value, int flags, com.oracle.truffle.api.object.LocationFactory locationFactory, long putFlags) {
ShapeImpl oldShape = shape;
if (!oldShape.isValid()) {
oldShape = ensureValid(oldShape);
}
Property existing = oldShape.getProperty(key);
return defineProperty(oldShape, key, value, flags, locationFactory, existing, putFlags);
}
protected ShapeImpl defineProperty(ShapeImpl oldShape, Object key, Object value, int propertyFlags, com.oracle.truffle.api.object.LocationFactory locationFactory, Property existing,
long putFlags) {
if (existing == null) {
if (Flags.isSeparateShape(putFlags)) {
return definePropertySeparateShape(oldShape, key, value, propertyFlags, putFlags, locationFactory);
} else {
return defineNewProperty(oldShape, key, value, propertyFlags, putFlags, locationFactory);
}
} else {
if (existing.getFlags() == propertyFlags) {
if (existing.getLocation().canStore(value)) {
return oldShape;
} else {
return definePropertyGeneralize(oldShape, existing, value, locationFactory, putFlags);
}
} else {
return definePropertyChangeFlags(oldShape, existing, value, propertyFlags, putFlags);
}
}
}
private ShapeImpl defineNewProperty(ShapeImpl oldShape, Object key, Object value, int propertyFlags, long putFlags, com.oracle.truffle.api.object.LocationFactory locationFactory) {
if (!Flags.isConstant(putFlags) && !Flags.isDeclaration(putFlags) && locationFactory == null) {
Class locationType = detectLocationType(value);
if (locationType != null) {
AddPropertyTransition addTransition = new AddPropertyTransition(key, propertyFlags, locationType);
ShapeImpl cachedShape = oldShape.queryTransition(addTransition);
if (cachedShape != null) {
return ensureValid(cachedShape);
}
}
}
Location location = createLocationForValue(oldShape, value, putFlags, locationFactory);
Property property = Property.create(key, location, propertyFlags);
return addProperty(oldShape, property);
}
protected Class detectLocationType(Object value) {
if (value instanceof Integer) {
return int.class;
} else if (value instanceof Double) {
return double.class;
} else if (value instanceof Long) {
return long.class;
} else if (value instanceof Boolean) {
return boolean.class;
} else {
return Object.class;
}
}
private Location createLocationForValue(ShapeImpl oldShape, Object value, long putFlags, com.oracle.truffle.api.object.LocationFactory locationFactory) {
if (locationFactory != null) {
return locationFactory.createLocation(oldShape, value);
} else {
return createLocationForValue(oldShape, value, putFlags);
}
}
protected abstract Location createLocationForValue(ShapeImpl shape, Object value, long putFlags);
protected ShapeImpl definePropertyChangeFlags(ShapeImpl oldShape, Property existing, Object value, int propertyFlags, long putFlags) {
assert existing.getFlags() != propertyFlags;
oldShape.onPropertyTransition(existing);
if (existing.getLocation().canStore(value)) {
Property newProperty = Property.create(existing.getKey(), existing.getLocation(), propertyFlags);
return replaceProperty(oldShape, existing, newProperty);
} else {
return generalizePropertyWithFlags(oldShape, existing, value, propertyFlags, putFlags);
}
}
protected ShapeImpl definePropertyGeneralize(ShapeImpl oldShape, Property oldProperty, Object value, com.oracle.truffle.api.object.LocationFactory locationFactory, long putFlags) {
oldShape.onPropertyTransition(oldProperty);
if (Flags.isSeparateShape(putFlags)) {
Location newLocation = createLocationForValue(oldShape, value, putFlags, locationFactory);
Property newProperty = ((PropertyImpl) oldProperty).relocate(newLocation);
return separateReplaceProperty(oldShape, oldProperty, newProperty);
} else if (oldProperty.getLocation().isValue()) {
Location newLocation = createLocationForValue(oldShape, value, putFlags, locationFactory);
Property newProperty = ((PropertyImpl) oldProperty).relocate(newLocation);
// Always use direct replace for value locations to avoid shape explosion
return directReplaceProperty(oldShape, oldProperty, newProperty);
} else {
return generalizeProperty(oldProperty, value, oldShape, oldShape, putFlags);
}
}
protected ShapeImpl generalizeProperty(Property oldProperty, Object value, ShapeImpl currentShape, ShapeImpl nextShape, long putFlags) {
Location oldLocation = oldProperty.getLocation();
Location newLocation = currentShape.allocator().locationForValueUpcast(value, oldLocation, putFlags);
Property newProperty = ((PropertyImpl) oldProperty).relocate(newLocation);
nextShape.onPropertyTransition(oldProperty);
return replaceProperty(nextShape, oldProperty, newProperty);
}
protected ShapeImpl generalizePropertyWithFlags(ShapeImpl currentShape, Property oldProperty, Object value, int propertyFlags, long putFlags) {
assert !oldProperty.getLocation().canStore(value);
Location newLocation = currentShape.allocator().locationForValueUpcast(value, oldProperty.getLocation(), putFlags);
Property newProperty = Property.create(oldProperty.getKey(), newLocation, propertyFlags);
return replaceProperty(currentShape, oldProperty, newProperty);
}
/** @since 0.17 or earlier */
protected void propertySetFallback(Property property, DynamicObject store, Object value, ShapeImpl currentShape) {
ShapeImpl oldShape = currentShape;
ShapeImpl newShape = defineProperty(oldShape, property.getKey(), value, property.getFlags(), null, Flags.DEFAULT);
Property newProperty = newShape.getProperty(property.getKey());
assert store.getShape() == oldShape;
try {
((LocationImpl) newProperty.getLocation()).set(store, value, oldShape, newShape);
} catch (com.oracle.truffle.api.object.IncompatibleLocationException ex) {
throw CompilerDirectives.shouldNotReachHere(ex);
}
}
private ShapeImpl definePropertySeparateShape(ShapeImpl oldShape, Object key, Object value, int propertyFlags, long putFlags, com.oracle.truffle.api.object.LocationFactory locationFactory) {
Location location = createLocationForValue(oldShape, value, putFlags, locationFactory);
Property property = Property.create(key, location, propertyFlags);
return createSeparateShape(oldShape).addProperty(property);
}
/** @since 0.17 or earlier */
protected ShapeImpl replaceProperty(ShapeImpl shape, Property oldProperty, Property newProperty) {
return directReplaceProperty(shape, oldProperty, newProperty);
}
/** @since 0.17 or earlier */
protected ShapeImpl removeProperty(ShapeImpl shape, Property property) {
shape.onPropertyTransition(property);
boolean direct = shape.isShared();
RemovePropertyTransition transition = newRemovePropertyTransition(property, direct);
ShapeImpl cachedShape = shape.queryTransition(transition);
if (cachedShape != null) {
return ensureValid(cachedShape);
}
if (direct) {
return directRemoveProperty(shape, property, transition);
}
return indirectRemoveProperty(shape, property, transition);
}
protected RemovePropertyTransition newRemovePropertyTransition(Property property, boolean direct) {
return new RemovePropertyTransition(property, toLocationOrType(property.getLocation()), direct);
}
/**
* Removes a property by rewinding and replaying property transitions; moves any subsequent
* property locations to fill in the gap.
*/
private ShapeImpl indirectRemoveProperty(ShapeImpl shape, Property property, RemovePropertyTransition transition) {
ShapeImpl owningShape = getShapeFromProperty(shape, property.getKey());
if (owningShape == null) {
return null;
}
List transitionList = new ArrayList<>();
for (ShapeImpl current = shape; current != owningShape; current = current.parent) {
Transition transitionFromParent = current.getTransitionFromParent();
if (transitionFromParent instanceof Transition.DirectReplacePropertyTransition &&
((Transition.DirectReplacePropertyTransition) transitionFromParent).getPropertyBefore().getKey().equals(property.getKey())) {
continue;
} else {
transitionList.add(transitionFromParent);
}
}
ShapeImpl newShape = owningShape.parent;
for (ListIterator iterator = transitionList.listIterator(transitionList.size()); iterator.hasPrevious();) {
Transition previous = iterator.previous();
newShape = applyTransition(newShape, previous, true);
}
return shape.addIndirectTransition(transition, newShape);
}
/**
* Removes a property without moving property locations, leaving a gap that is lost forever.
*/
private static ShapeImpl directRemoveProperty(ShapeImpl shape, Property property, RemovePropertyTransition transition) {
PropertyMap newPropertyMap = shape.getPropertyMap().removeCopy(property);
ShapeImpl newShape = shape.createShape(shape.getLayout(), shape.sharedData, shape, shape.objectType, newPropertyMap, transition, shape.allocator(), shape.flags);
return shape.addDirectTransition(transition, newShape);
}
protected ShapeImpl directReplaceProperty(ShapeImpl shape, Property oldProperty, Property newProperty) {
return directReplaceProperty(shape, oldProperty, newProperty, true);
}
protected ShapeImpl directReplaceProperty(ShapeImpl shape, Property oldProperty, Property newProperty, boolean ensureValid) {
ShapeImpl newShape = directReplacePropertyInner(shape, oldProperty, newProperty);
Property actualProperty = newShape.getProperty(newProperty.getKey());
// Ensure the actual property location is of the same type or more general.
ensureSameTypeOrMoreGeneral(actualProperty, newProperty);
return ensureValid ? ensureValid(newShape) : newShape;
}
private static ShapeImpl directReplacePropertyInner(ShapeImpl shape, Property oldProperty, Property newProperty) {
assert oldProperty.getKey().equals(newProperty.getKey());
if (oldProperty.equals(newProperty)) {
return shape;
}
shape.onPropertyTransition(oldProperty);
Transition replacePropertyTransition = new Transition.DirectReplacePropertyTransition(oldProperty, newProperty);
ShapeImpl cachedShape = shape.queryTransition(replacePropertyTransition);
if (cachedShape != null) {
return cachedShape;
}
PropertyMap newPropertyMap = shape.getPropertyMap().replaceCopy(oldProperty, newProperty);
BaseAllocator allocator = shape.allocator().addLocation(newProperty.getLocation());
ShapeImpl newShape = shape.createShape(shape.getLayout(), shape.sharedData, shape, shape.objectType, newPropertyMap, replacePropertyTransition, allocator, shape.flags);
newShape = shape.addDirectTransition(replacePropertyTransition, newShape);
if (!shape.isValid()) {
newShape.invalidateValidAssumption();
}
return newShape;
}
protected ShapeImpl separateReplaceProperty(ShapeImpl shape, Property oldProperty, Property newProperty) {
ShapeImpl newRoot = shape.createShape(shape.getLayout(), shape.sharedData, null, shape.objectType, PropertyMap.empty(), null, shape.getLayout().createAllocator(), shape.flags);
ShapeImpl newShape = newRoot;
boolean found = false;
for (Iterator iterator = shape.getPropertyMap().orderedValueIterator(); iterator.hasNext();) {
Property p = iterator.next();
if (!found && p.equals(oldProperty)) {
p = newProperty;
found = true;
}
newShape = newShape.addProperty(newProperty);
}
assert found;
assert newShape.isValid();
return newShape;
}
protected ShapeImpl createSeparateShape(ShapeImpl shape) {
ShapeImpl newRoot = shape.createShape(shape.getLayout(), shape.sharedData, null, shape.objectType, PropertyMap.empty(), null, shape.getLayout().createAllocator(), shape.flags);
ShapeImpl newShape = newRoot;
for (Iterator iterator = shape.getPropertyMap().orderedValueIterator(); iterator.hasNext();) {
Property p = iterator.next();
newShape = newShape.addProperty(p);
}
assert newShape.isValid();
return newShape;
}
/** @since 0.17 or earlier */
protected ShapeImpl addProperty(ShapeImpl shape, Property property) {
return addProperty(shape, property, true);
}
/** @since 0.17 or earlier */
protected ShapeImpl addProperty(ShapeImpl shape, Property property, boolean ensureValid) {
ShapeImpl newShape = addPropertyInner(shape, property);
Property actualProperty = newShape.getLastProperty();
// Ensure the actual property location is of the same type or more general.
ensureSameTypeOrMoreGeneral(actualProperty, property);
return ensureValid ? ensureValid(newShape) : newShape;
}
private ShapeImpl addPropertyInner(ShapeImpl shape, Property property) {
assert !(shape.hasProperty(property.getKey())) : "duplicate property " + property.getKey();
shape.onPropertyTransition(property);
AddPropertyTransition addTransition = newAddPropertyTransition(property);
ShapeImpl cachedShape = shape.queryTransition(addTransition);
if (cachedShape != null) {
return cachedShape;
}
ShapeImpl oldShape = ensureSpace(shape, property.getLocation());
ShapeImpl newShape = ShapeImpl.makeShapeWithAddedProperty(oldShape, addTransition);
newShape = oldShape.addDirectTransition(addTransition, newShape);
if (!oldShape.isValid()) {
newShape.invalidateValidAssumption();
}
return newShape;
}
protected AddPropertyTransition newAddPropertyTransition(Property property) {
return new AddPropertyTransition(property, toLocationOrType(property.getLocation()));
}
protected Object toLocationOrType(Location location) {
if (location instanceof LocationImpl) {
Class type = ((LocationImpl) location).getType();
if (type != null) {
return type;
}
}
return location;
}
/** @since 0.17 or earlier */
protected ShapeImpl applyTransition(ShapeImpl shape, Transition transition, boolean append) {
if (transition instanceof AddPropertyTransition) {
Property property = ((AddPropertyTransition) transition).getProperty();
ShapeImpl newShape;
if (append) {
Property newProperty = ((PropertyImpl) property).relocate(shape.allocator().moveLocation(property.getLocation()));
newShape = addProperty(shape, newProperty, true);
} else {
newShape = addProperty(shape, property, false);
}
return newShape;
} else if (transition instanceof ObjectTypeTransition) {
return shape.setDynamicType(((ObjectTypeTransition) transition).getObjectType());
} else if (transition instanceof ObjectFlagsTransition) {
return shape.setFlags(((ObjectFlagsTransition) transition).getObjectFlags());
} else if (transition instanceof DirectReplacePropertyTransition) {
Property oldProperty = ((DirectReplacePropertyTransition) transition).getPropertyBefore();
Property newProperty = ((DirectReplacePropertyTransition) transition).getPropertyAfter();
if (append) {
boolean sameLocation = oldProperty.getLocation().equals(newProperty.getLocation());
oldProperty = shape.getProperty(oldProperty.getKey());
Location newLocation;
if (sameLocation) {
newLocation = oldProperty.getLocation();
} else {
newLocation = shape.allocator().moveLocation(newProperty.getLocation());
}
newProperty = ((PropertyImpl) newProperty).relocate(newLocation);
}
return directReplaceProperty(shape, oldProperty, newProperty, append);
} else {
throw new UnsupportedOperationException(transition.getClass().getName());
}
}
/**
* Get the (parent) shape that holds the given property.
*
* @since 0.17 or earlier
*/
protected static ShapeImpl getShapeFromProperty(ShapeImpl shape, Object propertyName) {
ShapeImpl current = shape;
ShapeImpl root = shape.getRoot();
while (current != root) {
if (current.getTransitionFromParent() instanceof AddPropertyTransition && ((AddPropertyTransition) current.getTransitionFromParent()).getPropertyKey().equals(propertyName)) {
return current;
}
current = current.getParent();
}
return null;
}
protected void ensureSameTypeOrMoreGeneral(Property generalProperty, Property specificProperty) {
assert ((PropertyImpl) generalProperty).isSame(specificProperty) : generalProperty;
if (generalProperty.getLocation() != specificProperty.getLocation()) {
assert ((LocationImpl) generalProperty.getLocation()).getType() == ((LocationImpl) specificProperty.getLocation()).getType() : generalProperty;
}
}
}