com.oracle.truffle.object.LayoutImpl 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) 2012, 2021, 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.EnumSet;
import java.util.Map;
import java.util.Objects;
import com.oracle.truffle.api.Assumption;
import com.oracle.truffle.api.TruffleOptions;
import com.oracle.truffle.api.memory.MemoryFence;
import com.oracle.truffle.api.object.DynamicObject;
import com.oracle.truffle.api.object.Location;
import com.oracle.truffle.api.object.ObjectType;
import com.oracle.truffle.api.object.Shape;
import com.oracle.truffle.api.object.Shape.Allocator;
/** @since 0.17 or earlier */
@SuppressWarnings("deprecation")
public abstract class LayoutImpl extends com.oracle.truffle.api.object.Layout {
private static final int INT_TO_DOUBLE_FLAG = 1;
private static final int INT_TO_LONG_FLAG = 2;
/** @since 0.17 or earlier */
protected final LayoutStrategy strategy;
/** @since 0.17 or earlier */
protected final Class clazz;
private final int allowedImplicitCasts;
/** @since 0.17 or earlier */
protected LayoutImpl(Class clazz, LayoutStrategy strategy, int implicitCastFlags) {
this.strategy = strategy;
this.clazz = Objects.requireNonNull(clazz);
this.allowedImplicitCasts = implicitCastFlags;
}
protected static int implicitCastFlags(EnumSet allowedImplicitCasts) {
return (allowedImplicitCasts.contains(ImplicitCast.IntToDouble) ? INT_TO_DOUBLE_FLAG : 0) | (allowedImplicitCasts.contains(ImplicitCast.IntToLong) ? INT_TO_LONG_FLAG : 0);
}
/** @since 0.17 or earlier */
@Override
public abstract DynamicObject newInstance(Shape shape);
protected abstract DynamicObject construct(Shape shape);
protected abstract boolean isLegacyLayout();
/** @since 0.17 or earlier */
@Override
public Class getType() {
return clazz;
}
/** @since 0.17 or earlier */
@Override
public final Shape createShape(ObjectType objectType, Object sharedData) {
return createShape(objectType, sharedData, 0);
}
/** @since 0.17 or earlier */
@Override
public final Shape createShape(ObjectType objectType) {
return createShape(objectType, null);
}
@Override
public final Shape createShape(ObjectType objectType, Object sharedData, int flags) {
return newShape(objectType, sharedData, ShapeImpl.checkObjectFlags(flags), null);
}
@Override
protected final Shape buildShape(Object dynamicType, Object sharedData, int flags, Assumption singleContextAssumption) {
return newShape(dynamicType, sharedData, flags, null);
}
protected abstract Shape newShape(Object objectType, Object sharedData, int flags, Assumption singleContextAssumption);
/** @since 0.17 or earlier */
public boolean isAllowedIntToDouble() {
return (allowedImplicitCasts & INT_TO_DOUBLE_FLAG) != 0;
}
/** @since 0.17 or earlier */
public boolean isAllowedIntToLong() {
return (allowedImplicitCasts & INT_TO_LONG_FLAG) != 0;
}
/** @since 0.17 or earlier */
protected abstract boolean hasObjectExtensionArray();
/** @since 0.17 or earlier */
protected abstract boolean hasPrimitiveExtensionArray();
/** @since 0.17 or earlier */
protected abstract int getObjectFieldCount();
/** @since 0.17 or earlier */
protected abstract int getPrimitiveFieldCount();
/** @since 0.17 or earlier */
protected abstract Location getObjectArrayLocation();
/** @since 0.17 or earlier */
protected abstract Location getPrimitiveArrayLocation();
/** @since 0.17 or earlier */
@Override
public abstract Allocator createAllocator();
/** @since 0.17 or earlier */
public LayoutStrategy getStrategy() {
return strategy;
}
@Override
public String toString() {
return "Layout[" + clazz.getName() + "]";
}
/**
* Resets the state for native image generation.
*
* NOTE: this method is called reflectively by downstream projects.
*/
static void resetNativeImageState() {
assert TruffleOptions.AOT : "Only supported during image generation";
((CoreLayoutFactory) getFactory()).resetNativeImageState();
}
@SuppressWarnings("static-method")
protected abstract static class Support extends Access {
protected Support() {
}
public final void setShapeWithStoreFence(DynamicObject object, Shape shape) {
if (shape.isShared()) {
MemoryFence.storeStore();
}
super.setShape(object, shape);
}
public final void grow(DynamicObject object, Shape thisShape, Shape otherShape) {
DynamicObjectSupport.grow(object, thisShape, otherShape);
}
public final void resize(DynamicObject object, Shape thisShape, Shape otherShape) {
DynamicObjectSupport.resize(object, thisShape, otherShape);
}
public final void invalidateAllPropertyAssumptions(Shape shape) {
DynamicObjectSupport.invalidateAllPropertyAssumptions(shape);
}
public final void trimToSize(DynamicObject object, Shape thisShape, Shape otherShape) {
DynamicObjectSupport.trimToSize(object, thisShape, otherShape);
}
public final Map archive(DynamicObject object) {
return DynamicObjectSupport.archive(object);
}
public final boolean verifyValues(DynamicObject object, Map archive) {
return DynamicObjectSupport.verifyValues(object, archive);
}
protected void arrayCopy(Object[] from, Object[] to, int length) {
System.arraycopy(from, 0, to, 0, length);
}
protected void arrayCopy(int[] from, int[] to, int length) {
System.arraycopy(from, 0, to, 0, length);
}
}
static final class CoreAccess extends Support {
private CoreAccess() {
}
}
static final CoreAccess ACCESS = new CoreAccess();
}