org.graalvm.compiler.nodes.util

Class GraphUtil

java.lang.Object

org.graalvm.compiler.nodes.util.GraphUtil

public class GraphUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphUtil.Options

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FRAMESTATE_SEARCH_DEPTH

Constructor Summary

Constructors

Constructor and Description
GraphUtil()

Method Summary

Modifier and Type	Method and Description
static RuntimeException	approxSourceException(Node node, Throwable cause) Gets an approximate source code location for a node, encoded as an exception, if possible.
static String	approxSourceLocation(Node node) Gets an approximate source code location for a node if possible.
static StackTraceElement[]	approxSourceStackTraceElement(BytecodePosition bytecodePosition) Gets approximate stack trace elements for a bytecode position.
static StackTraceElement[]	approxSourceStackTraceElement(FrameState frameState) Gets an approximate source code location for frame state.
static StackTraceElement[]	approxSourceStackTraceElement(Node node) Gets an approximate source code location for a node if possible.
static ValueNode	arrayLength(ValueNode value, ArrayLengthProvider.FindLengthMode mode, ConstantReflectionProvider constantReflection) Returns the length of the array described by the value parameter, or null if it is not available.
static boolean	checkFrameState(FixedNode start, int maxDepth) Snippet lowerings may produce patterns without a frame state on the merge.
static void	checkRedundantPhi(PhiNode phiNode)
static void	checkRedundantProxy(ProxyNode vpn)
static BailoutException	createBailoutException(String message, Throwable cause, StackTraceElement[] elements) Creates a bailout exception with the given stack trace elements and message.
static FrameState	findLastFrameState(FixedNode start) Find the last, i.e.
static Constant	foldIfConstantAndRemove(ValueNode node, ValueNode constant)
static SimplifierTool	getDefaultSimplifier(CoreProviders providers, boolean canonicalizeReads, Assumptions assumptions, OptionValues options)
static boolean	isFloatingNode(Node n)
static void	killCFG(FixedNode node)
static void	killWithUnusedFloatingInputs(Node node)
static void	killWithUnusedFloatingInputs(Node node, boolean mayKillGuard)
static boolean	mayRemoveSplit(IfNode ifNode)
static void	normalizeLoops(StructuredGraph graph) Remove loop header without loop ends.
static ValueNode	originalValue(ValueNode value, boolean abortOnLoopPhi) Tries to find an original value of the given node by traversing through proxies and unambiguous phis.
static NodeIterable<FixedNode>	predecessorIterable(FixedNode start) Returns an iterator that will return the given node followed by all its predecessors, up until the point where Node.predecessor() returns null.
static void	removeFixedWithUnusedInputs(FixedWithNextNode fixed)
static void	removeNewNodes(Graph graph, Graph.Mark mark) Removes all nodes created after the mark, assuming no "old" nodes point to "new" nodes.
static ValueNode	skipPi(ValueNode node)
static ValueNode	skipPiWhileNonNullArray(ValueNode node)
static String	toString(Iterable<?> objects) Returns a string representation of the given collection of objects.
static boolean	tryKillUnused(Node node)
static LoopEndNode	tryToTransformToEmptyLoopDiamond(IfNode ifNode, LoopBeginNode loopBegin) An if node with an empty body at the end of a loop is represented with a LoopEndNode at the end of each path.
static void	unlinkAndKillExceptionEdge(WithExceptionNode withException)
static void	unlinkFixedNode(FixedWithNextNode fixed)
static ValueNode	unproxify(ValueNode value) Gets the original value by iterating through all ValueProxies.
static ValueNode	unproxify(ValueProxy value) Gets the original value by iterating through all ValueProxies.
static void	virtualizeArrayCopy(VirtualizerTool tool, ValueNode source, ValueNode sourceLength, ValueNode newLength, ValueNode from, ResolvedJavaType newComponentType, JavaKind elementKind, StructuredGraph graph, BiFunction<ResolvedJavaType,Integer,VirtualArrayNode> virtualArrayProvider) Virtualize an array copy.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FRAMESTATE_SEARCH_DEPTH

public static final int MAX_FRAMESTATE_SEARCH_DEPTH

See Also:

Constant Field Values

Constructor Detail

GraphUtil

public GraphUtil()

Method Detail

killCFG

public static void killCFG(FixedNode node)

isFloatingNode

public static boolean isFloatingNode(Node n)

killWithUnusedFloatingInputs

public static void killWithUnusedFloatingInputs(Node node)

killWithUnusedFloatingInputs

public static void killWithUnusedFloatingInputs(Node node,
                                                boolean mayKillGuard)

removeNewNodes

public static void removeNewNodes(Graph graph,
                                  Graph.Mark mark)

Removes all nodes created after the mark, assuming no "old" nodes point to "new" nodes.

removeFixedWithUnusedInputs

public static void removeFixedWithUnusedInputs(FixedWithNextNode fixed)

unlinkFixedNode

public static void unlinkFixedNode(FixedWithNextNode fixed)

unlinkAndKillExceptionEdge

public static void unlinkAndKillExceptionEdge(WithExceptionNode withException)

checkRedundantPhi

public static void checkRedundantPhi(PhiNode phiNode)

checkRedundantProxy

public static void checkRedundantProxy(ProxyNode vpn)

normalizeLoops

public static void normalizeLoops(StructuredGraph graph)

Remove loop header without loop ends. This can happen with degenerated loops like this one:

 for (;;) {
     try {
         break;
     } catch (UnresolvedException iioe) {
     }
 }
 

approxSourceStackTraceElement

public static StackTraceElement[] approxSourceStackTraceElement(Node node)

Gets an approximate source code location for a node if possible.

Returns:

the StackTraceElements if an approximate source location is found, null otherwise

approxSourceStackTraceElement

public static StackTraceElement[] approxSourceStackTraceElement(FrameState frameState)

Gets an approximate source code location for frame state.

Returns:

the StackTraceElements if an approximate source location is found, null otherwise

approxSourceStackTraceElement

public static StackTraceElement[] approxSourceStackTraceElement(BytecodePosition bytecodePosition)

Gets approximate stack trace elements for a bytecode position.

approxSourceException

public static RuntimeException approxSourceException(Node node,
                                                     Throwable cause)

Gets an approximate source code location for a node, encoded as an exception, if possible.

Returns:

the exception with the location

createBailoutException

public static BailoutException createBailoutException(String message,
                                                      Throwable cause,
                                                      StackTraceElement[] elements)

Creates a bailout exception with the given stack trace elements and message.

Parameters:

message - the message of the exception

elements - the stack trace elements

Returns:

the exception

approxSourceLocation

public static String approxSourceLocation(Node node)

Gets an approximate source code location for a node if possible.

Returns:

a file name and source line number in stack trace format (e.g. "String.java:32") if an approximate source location is found, null otherwise

toString

public static String toString(Iterable<?> objects)

Returns a string representation of the given collection of objects.

Parameters:

objects - The Iterable that will be used to iterate over the objects.

Returns:

A string of the format "[a, b, ...]".

unproxify

public static ValueNode unproxify(ValueNode value)

Gets the original value by iterating through all ValueProxies.

Parameters:

value - the start value.

Returns:

the first non-proxy value encountered

unproxify

public static ValueNode unproxify(ValueProxy value)

Gets the original value by iterating through all ValueProxies.

Parameters:

value - the start value proxy.

Returns:

the first non-proxy value encountered

skipPi

public static ValueNode skipPi(ValueNode node)

skipPiWhileNonNullArray

public static ValueNode skipPiWhileNonNullArray(ValueNode node)

arrayLength

public static ValueNode arrayLength(ValueNode value,
                                    ArrayLengthProvider.FindLengthMode mode,
                                    ConstantReflectionProvider constantReflection)

Returns the length of the array described by the value parameter, or null if it is not available. Details of the different modes are documented in ArrayLengthProvider.FindLengthMode.

Parameters:

value - The start value.

mode - The mode as documented in ArrayLengthProvider.FindLengthMode.

Returns:

The array length if one was found, or null otherwise.

originalValue

public static ValueNode originalValue(ValueNode value,
                                      boolean abortOnLoopPhi)

Tries to find an original value of the given node by traversing through proxies and unambiguous phis. Note that this method will perform an exhaustive search through phis.

Parameters:

value - the node whose original value should be determined

abortOnLoopPhi - specifies if the traversal through phis should stop and return value if it hits a loop phi. This argument must be true if used during graph building as loop phi nodes may not yet have all their inputs computed.

Returns:

the original value (which might be value itself)

tryKillUnused

public static boolean tryKillUnused(Node node)

predecessorIterable

public static NodeIterable<FixedNode> predecessorIterable(FixedNode start)

Returns an iterator that will return the given node followed by all its predecessors, up until the point where Node.predecessor() returns null.

Parameters:

start - the node at which to start iterating

getDefaultSimplifier

public static SimplifierTool getDefaultSimplifier(CoreProviders providers,
                                                  boolean canonicalizeReads,
                                                  Assumptions assumptions,
                                                  OptionValues options)

foldIfConstantAndRemove

public static Constant foldIfConstantAndRemove(ValueNode node,
                                               ValueNode constant)

virtualizeArrayCopy

public static void virtualizeArrayCopy(VirtualizerTool tool,
                                       ValueNode source,
                                       ValueNode sourceLength,
                                       ValueNode newLength,
                                       ValueNode from,
                                       ResolvedJavaType newComponentType,
                                       JavaKind elementKind,
                                       StructuredGraph graph,
                                       BiFunction<ResolvedJavaType,Integer,VirtualArrayNode> virtualArrayProvider)

Virtualize an array copy.

Parameters:

tool - the virtualization tool

source - the source array

sourceLength - the length of the source array

newLength - the length of the new array

from - the start index in the source array

newComponentType - the component type of the new array

elementKind - the kind of the new array elements

graph - the node graph

virtualArrayProvider - a functional provider that returns a new virtual array given the component type and length

checkFrameState

public static boolean checkFrameState(FixedNode start,
                                      int maxDepth)

Snippet lowerings may produce patterns without a frame state on the merge. We need to take extra care when optimizing these patterns.

mayRemoveSplit

public static boolean mayRemoveSplit(IfNode ifNode)

tryToTransformToEmptyLoopDiamond

public static LoopEndNode tryToTransformToEmptyLoopDiamond(IfNode ifNode,
                                                           LoopBeginNode loopBegin)

An if node with an empty body at the end of a loop is represented with a LoopEndNode at the end of each path. For some optimizations it is more useful to have a representation of the if statement as a proper diamond with a merge after the two bodies, followed by a LoopEndNode. This method tries to transform the given ifNode into such a form, introducing new phi nodes for the diamond and patching up the loop's phis accordingly. On success, the newly introduced loop end node is returned. If the given ifNode is not an if statement with empty bodies at the end of the loop, the graph is not modified, and null is returned. Note that the diamond representation is not canonical and will be undone by the next application of AbstractMergeNode.simplify(SimplifierTool) to the merge.

findLastFrameState

public static FrameState findLastFrameState(FixedNode start)

Find the last, i.e. dominating, StateSplit node that returns true for StateSplit.hasSideEffect() and return its StateSplit.stateAfter(). That is the FrameState node describing the current frame since no side effect happened in between. This method will check Graal's invariant relations regarding side-effects and framestates.