com.oracle.truffle.api.frame.FrameSlot 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, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.oracle.truffle.api.frame;
import java.util.Map;
import java.util.WeakHashMap;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
/**
* A slot in a {@link Frame} and {@link FrameDescriptor} that can store a value of a given type.
*
* @since 0.8 or earlier
*/
public final class FrameSlot implements Cloneable {
final FrameDescriptor descriptor;
private final Object identifier;
private final Object info;
private final int index;
/*
* The sharedWith has to be precisely tracked per FrameSlot. If it was tracked in
* FrameDescriptor then it could cause large number of invalidations. When a single
* FrameDescriptor is used as a template and large number of FrameDescriptors is created based
* of it with shallowCopy, then any kind change in one of them would invalidate all of them.
*/
Map sharedWith;
/*
* The FrameSlot cannot be made immutable by moving the kind field to FrameDescriptor, because
* it would force getFrameSlotKind and setFrameSlotKind to check frameSlot removal which would
* require locking the FrameDescriptor, instead of current simple read from the volatile kind
* field.
*/
@CompilationFinal volatile FrameSlotKind kind;
FrameSlot(FrameDescriptor descriptor, Object identifier, Object info, FrameSlotKind kind, int index) {
this.descriptor = descriptor;
this.identifier = identifier;
this.info = info;
this.index = index;
this.kind = kind;
this.sharedWith = null;
}
/**
* Identifier of the slot.
*
* @return value as specified in {@link FrameDescriptor#addFrameSlot(java.lang.Object)}
* parameter
* @since 0.8 or earlier
*/
public Object getIdentifier() {
return identifier;
}
/**
* Information about the slot.
*
* @return value as specified as second parameter of
* {@link FrameDescriptor#addFrameSlot(java.lang.Object, java.lang.Object, com.oracle.truffle.api.frame.FrameSlotKind)}
* @since 0.8 or earlier
*/
public Object getInfo() {
return info;
}
/**
* Index of the slot in the {@link FrameDescriptor}.
*
* @return position of the slot computed after
* {@link FrameDescriptor#addFrameSlot(java.lang.Object, java.lang.Object, com.oracle.truffle.api.frame.FrameSlotKind)
* adding} it.
* @since 0.8 or earlier
*/
public int getIndex() {
return index;
}
/**
* Kind of the slot. Specified either at
* {@link FrameDescriptor#addFrameSlot(java.lang.Object, com.oracle.truffle.api.frame.FrameSlotKind)
* creation time} or updated via
* {@link FrameDescriptor#setFrameSlotKind(FrameSlot, FrameSlotKind)} method.
*
* @return current kind of this slot
* @since 0.8 or earlier
* @deprecated in 1.0 use {@link FrameDescriptor#getFrameSlotKind(FrameSlot)} instead.
*/
@Deprecated
public FrameSlotKind getKind() {
return descriptor.getFrameSlotKind(this);
}
/**
* Changes the kind of this slot. Change of the slot kind is done on slow path and
* invalidates assumptions about version of the {@link FrameDescriptor descriptor} it belongs
* to.
*
* @param kind new kind of the slot
* @since 0.8 or earlier
* @deprecated in 1.0 use {@link FrameDescriptor#setFrameSlotKind(FrameSlot, FrameSlotKind)}
* instead.
*/
@Deprecated
public void setKind(final FrameSlotKind kind) {
descriptor.setFrameSlotKind(this, kind);
}
/** @since 0.8 or earlier */
@Override
public String toString() {
CompilerAsserts.neverPartOfCompilation("do not call FrameSlot.toString from compiled code");
return "[" + index + "," + identifier + "," + kind + "]";
}
/**
* Frame descriptor this slot is associated with. When the slot was shared using
* {@link FrameDescriptor#shallowCopy()} it returns the original {@link FrameDescriptor}.
*
* @return instance of descriptor that {@link FrameDescriptor#addFrameSlot(java.lang.Object)
* created} the slot
* @since 0.8 or earlier
* @deprecated in 1.0 without direct replacement. When {@link FrameDescriptor#shallowCopy()} is
* removed the frame slot will always belong only to the descriptor which created
* it.
*/
@Deprecated
public FrameDescriptor getFrameDescriptor() {
return this.descriptor;
}
void shareWith(FrameDescriptor frameDescriptor) {
if (sharedWith == null) {
sharedWith = new WeakHashMap<>();
}
sharedWith.put(frameDescriptor, null);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy