com.oracle.truffle.sl.nodes.local

Class SLWriteLocalVariableNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.sl.nodes.local.SLScopedNode

com.oracle.truffle.sl.nodes.SLStatementNode

com.oracle.truffle.sl.nodes.SLExpressionNode

com.oracle.truffle.sl.nodes.local.SLWriteLocalVariableNode

All Implemented Interfaces:

com.oracle.truffle.api.instrumentation.InstrumentableNode, com.oracle.truffle.api.nodes.NodeInterface, Cloneable

public abstract class SLWriteLocalVariableNode
extends SLExpressionNode

Node to write a local variable to a function's frame. The Truffle frame API allows to store primitive values of all Java primitive types, and Object values.

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.nodes.Node.Child, com.oracle.truffle.api.nodes.Node.Children

Nested classes/interfaces inherited from interface com.oracle.truffle.api.instrumentation.InstrumentableNode

com.oracle.truffle.api.instrumentation.InstrumentableNode.WrapperNode

Constructor Summary

Constructors

Constructor and Description
SLWriteLocalVariableNode()

Method Summary

Modifier and Type	Method and Description
abstract void	executeWrite(com.oracle.truffle.api.frame.VirtualFrame frame, Object value)
protected abstract SLExpressionNode	getNameNode() Returns the child node nameNode.
Object	getNodeObject()
protected abstract int	getSlot() Returns the descriptor of the accessed local variable.
com.oracle.truffle.api.strings.TruffleString	getSlotName()
boolean	hasTag(Class<? extends com.oracle.truffle.api.instrumentation.Tag> tag)
protected boolean	isBooleanOrIllegal(com.oracle.truffle.api.frame.VirtualFrame frame)
abstract boolean	isDeclaration()
protected boolean	isLongOrIllegal(com.oracle.truffle.api.frame.VirtualFrame frame) Guard function that the local variable has the type long.
protected Object	write(com.oracle.truffle.api.frame.VirtualFrame frame, Object value) Generic write method that works for all possible types.
protected boolean	writeBoolean(com.oracle.truffle.api.frame.VirtualFrame frame, boolean value)
protected long	writeLong(com.oracle.truffle.api.frame.VirtualFrame frame, long value) Specialized method to write a primitive long value.

Methods inherited from class com.oracle.truffle.sl.nodes.SLExpressionNode

addExpressionTag, createWrapper, executeBoolean, executeGeneric, executeLong, executeVoid

Methods inherited from class com.oracle.truffle.sl.nodes.SLStatementNode

addRootTag, addStatementTag, formatSourceSection, getSourceCharIndex, getSourceEndIndex, getSourceLength, getSourceSection, hasSource, isInstrumentable, setSourceSection, setUnavailableSourceSection, toString

Methods inherited from class com.oracle.truffle.sl.nodes.local.SLScopedNode

findBlock, getVisibleVariablesIndexOnEnter, hasScope, setVisibleVariablesIndexOnEnter, setVisibleVariablesIndexOnExit

Methods inherited from class com.oracle.truffle.api.nodes.Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, insert, insert, isAdoptable, isSafelyReplaceableBy, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.truffle.api.instrumentation.InstrumentableNode

findInstrumentableParent, findNearestNodeAt, materializeInstrumentableNodes

Constructor Detail

SLWriteLocalVariableNode

public SLWriteLocalVariableNode()

Method Detail

getSlot

protected abstract int getSlot()

Returns the descriptor of the accessed local variable. The implementation of this method is created by the Truffle DSL based on the NodeField annotation on the class.

getNameNode

protected abstract SLExpressionNode getNameNode()

Returns the child node nameNode. The implementation of this method is created by the Truffle DSL based on the NodeChild annotation on the class.

isDeclaration

public abstract boolean isDeclaration()

getSlotName

public final com.oracle.truffle.api.strings.TruffleString getSlotName()

writeLong

protected long writeLong(com.oracle.truffle.api.frame.VirtualFrame frame,
                         long value)

Specialized method to write a primitive long value. This is only possible if the local variable also has currently the type long or was never written before, therefore a Truffle DSL custom guard is specified.

writeBoolean

protected boolean writeBoolean(com.oracle.truffle.api.frame.VirtualFrame frame,
                               boolean value)

write

protected Object write(com.oracle.truffle.api.frame.VirtualFrame frame,
                       Object value)

Generic write method that works for all possible types.

Why is this method annotated with Specialization and not Fallback? For a Fallback method, the Truffle DSL generated code would try all other specializations first before calling this method. We know that all these specializations would fail their guards, so there is no point in calling them. Since this method takes a value of type Object, it is guaranteed to never fail, i.e., once we are in this specialization the node will never be re-specialized.

executeWrite

public abstract void executeWrite(com.oracle.truffle.api.frame.VirtualFrame frame,
                                  Object value)

isLongOrIllegal

protected boolean isLongOrIllegal(com.oracle.truffle.api.frame.VirtualFrame frame)

Guard function that the local variable has the type long.

Parameters:

frame - The parameter seems unnecessary, but it is required: Without the parameter, the Truffle DSL would not check the guard on every execution of the specialization. Guards without parameters are assumed to be pure, but our guard depends on the slot kind which can change.

isBooleanOrIllegal

protected boolean isBooleanOrIllegal(com.oracle.truffle.api.frame.VirtualFrame frame)

hasTag

public boolean hasTag(Class<? extends com.oracle.truffle.api.instrumentation.Tag> tag)

Specified by:

hasTag in interface com.oracle.truffle.api.instrumentation.InstrumentableNode

Overrides:

hasTag in class SLExpressionNode

getNodeObject

public Object getNodeObject()