org.graalvm.compiler.truffle.runtime

Class OptimizedOSRLoopNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.nodes.LoopNode

org.graalvm.compiler.truffle.runtime.OptimizedOSRLoopNode

All Implemented Interfaces:

com.oracle.truffle.api.nodes.NodeInterface, com.oracle.truffle.api.ReplaceObserver, Cloneable

public abstract class OptimizedOSRLoopNode
extends com.oracle.truffle.api.nodes.LoopNode
implements com.oracle.truffle.api.ReplaceObserver

Loop node implementation that supports on-stack-replacement with compiled code.

See Also:

OptimizedOSRLoopNode.create(RepeatingNode), OptimizedOSRLoopNode.createOSRLoop(RepeatingNode, int, FrameSlot[], FrameSlot[])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptimizedOSRLoopNode.OSRRootNode

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

Method Summary

Modifier and Type	Method and Description
com.oracle.truffle.api.nodes.Node	copy()
static com.oracle.truffle.api.nodes.LoopNode	create(com.oracle.truffle.api.nodes.RepeatingNode repeat) Creates the default loop node implementation with the default configuration.
static OptimizedOSRLoopNode	createOSRLoop(com.oracle.truffle.api.nodes.RepeatingNode repeating, int osrThreshold, com.oracle.truffle.api.frame.FrameSlot[] readFrameSlots, com.oracle.truffle.api.frame.FrameSlot[] writtenFrameSlots) Creates a configurable instance of the OSR loop node.
protected OptimizedOSRLoopNode.OSRRootNode	createRootNode(com.oracle.truffle.api.frame.FrameDescriptor rootFrameDescriptor, Class<? extends com.oracle.truffle.api.frame.VirtualFrame> clazz)
Object	execute(com.oracle.truffle.api.frame.VirtualFrame frame)
void	executeLoop(com.oracle.truffle.api.frame.VirtualFrame frame)
void	forceOSR() Forces OSR compilation for this loop.
OptimizedCallTarget	getCompiledOSRLoop()
com.oracle.truffle.api.nodes.RepeatingNode	getRepeatingNode()
boolean	nodeReplaced(com.oracle.truffle.api.nodes.Node oldNode, com.oracle.truffle.api.nodes.Node newNode, CharSequence reason)

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

reportLoopCount

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

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

Methods inherited from class java.lang.Object

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

Method Detail

createRootNode

protected OptimizedOSRLoopNode.OSRRootNode createRootNode(com.oracle.truffle.api.frame.FrameDescriptor rootFrameDescriptor,
                                                          Class<? extends com.oracle.truffle.api.frame.VirtualFrame> clazz)

Parameters:

rootFrameDescriptor - may be null.

copy

public final com.oracle.truffle.api.nodes.Node copy()

Overrides:

copy in class com.oracle.truffle.api.nodes.Node

getRepeatingNode

public final com.oracle.truffle.api.nodes.RepeatingNode getRepeatingNode()

Specified by:

getRepeatingNode in class com.oracle.truffle.api.nodes.LoopNode

executeLoop

public void executeLoop(com.oracle.truffle.api.frame.VirtualFrame frame)

Specified by:

executeLoop in class com.oracle.truffle.api.nodes.LoopNode

execute

public Object execute(com.oracle.truffle.api.frame.VirtualFrame frame)

Overrides:

execute in class com.oracle.truffle.api.nodes.LoopNode

forceOSR

public final void forceOSR()

Forces OSR compilation for this loop.

getCompiledOSRLoop

public final OptimizedCallTarget getCompiledOSRLoop()

nodeReplaced

public final boolean nodeReplaced(com.oracle.truffle.api.nodes.Node oldNode,
                                  com.oracle.truffle.api.nodes.Node newNode,
                                  CharSequence reason)

Specified by:

nodeReplaced in interface com.oracle.truffle.api.ReplaceObserver

create

public static com.oracle.truffle.api.nodes.LoopNode create(com.oracle.truffle.api.nodes.RepeatingNode repeat)

Creates the default loop node implementation with the default configuration. If OSR is disabled OptimizedLoopNode will be used instead.

createOSRLoop

public static OptimizedOSRLoopNode createOSRLoop(com.oracle.truffle.api.nodes.RepeatingNode repeating,
                                                 int osrThreshold,
                                                 com.oracle.truffle.api.frame.FrameSlot[] readFrameSlots,
                                                 com.oracle.truffle.api.frame.FrameSlot[] writtenFrameSlots)

Creates a configurable instance of the OSR loop node. If readFrameSlots and writtenFrameSlots are set then the involved frame must never escape, ie Frame.materialize() is never invoked.

Important note: All readFrameSlots that are given must be initialized before entering the loop. Also all writtenFrameSlots must be initialized inside of the loop if they were not initialized outside the loop.

Parameters:

repeating - the repeating node to use for this loop.

osrThreshold - the threshold after how many loop iterations an OSR compilation is triggered. If the repeating node uses child loops or LoopNode.reportLoopCount(Node, int) then these iterations also contribute to this loop's iterations.

readFrameSlots - a set of all frame slots which are read inside the loop. null for unknown. All given frame slots must not have the illegal frame slot kind set. If readFrameSlot is kept null writtenFrameSlots must be null as well.

writtenFrameSlots - a set of all frame slots which are written inside the loop. null for unknown. All given frame slots must not have the illegal frame slot kind set. If readFrameSlot is kept null writtenFRameSlots must be null as well.

See Also:

LoopNode on how to use loop nodes.