org.graalvm.compiler.phases.common.inlining

Class InliningUtil

java.lang.Object

org.graalvm.compiler.phases.util.ValueMergeUtil

org.graalvm.compiler.phases.common.inlining.InliningUtil

public class InliningUtil
extends ValueMergeUtil

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InliningUtil.InlineeReturnAction Pre-processing hook for special handling of inlinee return nodes during inlining.

Field Summary

Fields

Modifier and Type	Field and Description
static InliningUtil.InlineeReturnAction	NoReturnAction

Constructor Summary

Constructors

Constructor and Description
InliningUtil()

Method Summary

Modifier and Type	Method and Description
static String	checkInvokeConditions(Invoke invoke)
static PiNode	createAnchoredReceiver(StructuredGraph graph, GuardingNode anchor, ResolvedJavaType commonType, ValueNode receiver, boolean exact)
static SpeculationLog.SpeculationReason	createSpeculation(Invoke invoke, JavaTypeProfile typeProfile)
static int	getNodeCount(StructuredGraph graph) This method exclude InstrumentationNode from inlining heuristics.
static FrameState	handleMissingAfterExceptionFrameState(FrameState nonReplaceableFrameState, Invoke invoke, org.graalvm.collections.EconomicMap<Node,Node> replacements, boolean alwaysDuplicateStateAfter)
static org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>	inline(Invoke invoke, StructuredGraph inlineGraph, boolean receiverNullCheck, ResolvedJavaMethod inlineeMethod) Performs an actual inlining, thereby replacing the given invoke with the given inlineGraph.
static org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>	inline(Invoke invoke, StructuredGraph inlineGraph, boolean receiverNullCheck, ResolvedJavaMethod inlineeMethod, String reason, String phase)
static org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>	inline(Invoke invoke, StructuredGraph inlineGraph, boolean receiverNullCheck, ResolvedJavaMethod inlineeMethod, String reason, String phase, InliningUtil.InlineeReturnAction returnAction) Performs an actual inlining, thereby replacing the given invoke with the given inlineGraph.
static org.graalvm.collections.EconomicSet<Node>	inlineForCanonicalization(Invoke invoke, StructuredGraph inlineGraph, boolean receiverNullCheck, ResolvedJavaMethod inlineeMethod, Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicatesConsumer, String reason, String phase)
static org.graalvm.collections.EconomicSet<Node>	inlineForCanonicalization(Invoke invoke, StructuredGraph inlineGraph, boolean receiverNullCheck, ResolvedJavaMethod inlineeMethod, Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicatesConsumer, String reason, String phase, InliningUtil.InlineeReturnAction action)
static org.graalvm.collections.EconomicSet<Node>	inlineForCanonicalization(Invoke invoke, StructuredGraph inlineGraph, boolean receiverNullCheck, ResolvedJavaMethod inlineeMethod, String reason, String phase) Inline inlineGraph into the current replacing the node Invoke and return the set of nodes which should be canonicalized.
static void	insertTypeGuard(CoreProviders providers, Invoke invoke, ResolvedJavaType type, Speculation speculation)
static void	logInliningDecision(DebugContext debug, String msg, Object... args) Output a generic inlining decision to the logging stream (e.g.
static void	logNotInlinedMethod(Invoke invoke, String msg) Output a decision about not inlining a method to the logging stream, for debugging purposes.
static ValueNode	nonNullReceiver(Invoke invoke) Gets the receiver for an invoke, adding a guard if necessary to ensure it is non-null, and ensuring that the resulting type is compatible with the method being invoked.
static FrameState	processFrameState(FrameState frameState, Invoke invoke, org.graalvm.collections.EconomicMap<Node,Node> replacements, ResolvedJavaMethod inlinedMethod, FrameState stateAtExceptionEdge, FrameState outerFrameState, boolean alwaysDuplicateStateAfter, ResolvedJavaMethod invokeTargetMethod, List<ValueNode> invokeArgsList)
protected static void	processFrameStates(Invoke invoke, StructuredGraph inlineGraph, org.graalvm.collections.EconomicMap<Node,Node> duplicates, FrameState stateAtExceptionEdge, boolean alwaysDuplicateStateAfter)
static void	processMonitorId(FrameState stateAfter, MonitorIdNode monitorIdNode)
static org.graalvm.collections.Pair<ValueNode,FixedNode>	replaceInvokeAtUsages(ValueNode invokeNode, ValueNode origReturn, FixedNode anchorCandidate) Replaces invoke's usages with the provided return value while also insuring the new value's stamp is not weaker than the original invoke's stamp.
static void	replaceInvokeCallTarget(Invoke invoke, StructuredGraph graph, CallTargetNode.InvokeKind invokeKind, ResolvedJavaMethod targetMethod)
static void	traceInlinedMethod(InlineInfo info, int inliningDepth, boolean allowLogging, String msg, Object... args) Trace a decision to inline a method.
static void	traceInlinedMethod(Invoke invoke, int inliningDepth, boolean allowLogging, ResolvedJavaMethod method, String msg, Object... args) Trace a decision to inline a method.
static void	traceNotInlinedMethod(InlineInfo info, int inliningDepth, String msg, Object... args) Trace a decision to not inline a method.
static void	traceNotInlinedMethod(Invoke invoke, int inliningDepth, ResolvedJavaMethod method, String msg, Object... args) Trace a decision about not inlining a method.
static void	updateSourcePosition(StructuredGraph invokeGraph, org.graalvm.collections.UnmodifiableEconomicMap<Node,Node> duplicates, Graph.Mark mark, NodeSourcePosition invokePos, boolean isSubstitution)

Methods inherited from class org.graalvm.compiler.phases.util.ValueMergeUtil

mergeReturns, mergeUnwindExceptions, mergeValueProducers

Methods inherited from class java.lang.Object

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

Field Detail

NoReturnAction

public static InliningUtil.InlineeReturnAction NoReturnAction

Constructor Detail

InliningUtil

public InliningUtil()

Method Detail

traceInlinedMethod

public static void traceInlinedMethod(InlineInfo info,
                                      int inliningDepth,
                                      boolean allowLogging,
                                      String msg,
                                      Object... args)

Trace a decision to inline a method. This prints a HotSpot-style inlining message to the console, and it also logs the decision to the logging stream. Phases that perform inlining should use this method to trace the inlining decisions, and use the InliningUtil.traceNotInlinedMethod(org.graalvm.compiler.phases.common.inlining.info.InlineInfo, int, java.lang.String, java.lang.Object...) methods only for debugging purposes.

traceInlinedMethod

public static void traceInlinedMethod(Invoke invoke,
                                      int inliningDepth,
                                      boolean allowLogging,
                                      ResolvedJavaMethod method,
                                      String msg,
                                      Object... args)

Trace a decision to inline a method. This prints a HotSpot-style inlining message to the console, and it also logs the decision to the logging stream. Phases that perform inlining should use this method to trace the inlining decisions, and use the InliningUtil.traceNotInlinedMethod(org.graalvm.compiler.phases.common.inlining.info.InlineInfo, int, java.lang.String, java.lang.Object...) methods only for debugging purposes.

traceNotInlinedMethod

public static void traceNotInlinedMethod(InlineInfo info,
                                         int inliningDepth,
                                         String msg,
                                         Object... args)

Trace a decision to not inline a method. This prints a HotSpot-style inlining message to the console, and it also logs the decision to the logging stream. Phases that perform inlining should use this method to trace the inlining decisions, and use the InliningUtil.traceNotInlinedMethod(org.graalvm.compiler.phases.common.inlining.info.InlineInfo, int, java.lang.String, java.lang.Object...) methods only for debugging purposes.

traceNotInlinedMethod

public static void traceNotInlinedMethod(Invoke invoke,
                                         int inliningDepth,
                                         ResolvedJavaMethod method,
                                         String msg,
                                         Object... args)

Trace a decision about not inlining a method. This prints a HotSpot-style inlining message to the console, and it also logs the decision to the logging stream. Phases that perform inlining should use this method to trace the inlining decisions, and use the InliningUtil.traceNotInlinedMethod(org.graalvm.compiler.phases.common.inlining.info.InlineInfo, int, java.lang.String, java.lang.Object...) methods only for debugging purposes.

logInliningDecision

public static void logInliningDecision(DebugContext debug,
                                       String msg,
                                       Object... args)

Output a generic inlining decision to the logging stream (e.g. inlining termination condition). Used for debugging purposes.

logNotInlinedMethod

public static void logNotInlinedMethod(Invoke invoke,
                                       String msg)

Output a decision about not inlining a method to the logging stream, for debugging purposes.

replaceInvokeCallTarget

public static void replaceInvokeCallTarget(Invoke invoke,
                                           StructuredGraph graph,
                                           CallTargetNode.InvokeKind invokeKind,
                                           ResolvedJavaMethod targetMethod)

createAnchoredReceiver

public static PiNode createAnchoredReceiver(StructuredGraph graph,
                                            GuardingNode anchor,
                                            ResolvedJavaType commonType,
                                            ValueNode receiver,
                                            boolean exact)

checkInvokeConditions

public static String checkInvokeConditions(Invoke invoke)

Returns:

null iff the check succeeds, otherwise a (non-null) descriptive message.

inline

public static org.graalvm.collections.UnmodifiableEconomicMap<Node,Node> inline(Invoke invoke,
                                                                                StructuredGraph inlineGraph,
                                                                                boolean receiverNullCheck,
                                                                                ResolvedJavaMethod inlineeMethod)

Performs an actual inlining, thereby replacing the given invoke with the given inlineGraph.

Parameters:

invoke - the invoke that will be replaced

inlineGraph - the graph that the invoke will be replaced with

receiverNullCheck - true if a null check needs to be generated for non-static inlinings, false if no such check is required

inlineeMethod - the actual method being inlined. Maybe be null for snippets.

inline

public static org.graalvm.collections.UnmodifiableEconomicMap<Node,Node> inline(Invoke invoke,
                                                                                StructuredGraph inlineGraph,
                                                                                boolean receiverNullCheck,
                                                                                ResolvedJavaMethod inlineeMethod,
                                                                                String reason,
                                                                                String phase)

inline

public static org.graalvm.collections.UnmodifiableEconomicMap<Node,Node> inline(Invoke invoke,
                                                                                StructuredGraph inlineGraph,
                                                                                boolean receiverNullCheck,
                                                                                ResolvedJavaMethod inlineeMethod,
                                                                                String reason,
                                                                                String phase,
                                                                                InliningUtil.InlineeReturnAction returnAction)

Performs an actual inlining, thereby replacing the given invoke with the given inlineGraph.

Parameters:

invoke - the invoke that will be replaced

inlineGraph - the graph that the invoke will be replaced with

receiverNullCheck - true if a null check needs to be generated for non-static inlinings, false if no such check is required

inlineeMethod - the actual method being inlined. Maybe be null for snippets.

reason - the reason for inlining, used in tracing

phase - the phase that invoked inlining

inlineForCanonicalization

public static org.graalvm.collections.EconomicSet<Node> inlineForCanonicalization(Invoke invoke,
                                                                                  StructuredGraph inlineGraph,
                                                                                  boolean receiverNullCheck,
                                                                                  ResolvedJavaMethod inlineeMethod,
                                                                                  String reason,
                                                                                  String phase)

Inline inlineGraph into the current replacing the node Invoke and return the set of nodes which should be canonicalized. The set should only contain nodes which modified by the inlining since the current graph and inlineGraph are expected to already be canonical.

Parameters:

invoke -

inlineGraph -

receiverNullCheck -

inlineeMethod -

Returns:

the set of nodes to canonicalize

inlineForCanonicalization

public static org.graalvm.collections.EconomicSet<Node> inlineForCanonicalization(Invoke invoke,
                                                                                  StructuredGraph inlineGraph,
                                                                                  boolean receiverNullCheck,
                                                                                  ResolvedJavaMethod inlineeMethod,
                                                                                  Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicatesConsumer,
                                                                                  String reason,
                                                                                  String phase)

inlineForCanonicalization

public static org.graalvm.collections.EconomicSet<Node> inlineForCanonicalization(Invoke invoke,
                                                                                  StructuredGraph inlineGraph,
                                                                                  boolean receiverNullCheck,
                                                                                  ResolvedJavaMethod inlineeMethod,
                                                                                  Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicatesConsumer,
                                                                                  String reason,
                                                                                  String phase,
                                                                                  InliningUtil.InlineeReturnAction action)

replaceInvokeAtUsages

public static org.graalvm.collections.Pair<ValueNode,FixedNode> replaceInvokeAtUsages(ValueNode invokeNode,
                                                                                      ValueNode origReturn,
                                                                                      FixedNode anchorCandidate)

Replaces invoke's usages with the provided return value while also insuring the new value's stamp is not weaker than the original invoke's stamp.

Returns:

new return and the anchoring values

updateSourcePosition

public static void updateSourcePosition(StructuredGraph invokeGraph,
                                        org.graalvm.collections.UnmodifiableEconomicMap<Node,Node> duplicates,
                                        Graph.Mark mark,
                                        NodeSourcePosition invokePos,
                                        boolean isSubstitution)

processMonitorId

public static void processMonitorId(FrameState stateAfter,
                                    MonitorIdNode monitorIdNode)

processFrameStates

protected static void processFrameStates(Invoke invoke,
                                         StructuredGraph inlineGraph,
                                         org.graalvm.collections.EconomicMap<Node,Node> duplicates,
                                         FrameState stateAtExceptionEdge,
                                         boolean alwaysDuplicateStateAfter)

processFrameState

public static FrameState processFrameState(FrameState frameState,
                                           Invoke invoke,
                                           org.graalvm.collections.EconomicMap<Node,Node> replacements,
                                           ResolvedJavaMethod inlinedMethod,
                                           FrameState stateAtExceptionEdge,
                                           FrameState outerFrameState,
                                           boolean alwaysDuplicateStateAfter,
                                           ResolvedJavaMethod invokeTargetMethod,
                                           List<ValueNode> invokeArgsList)

handleMissingAfterExceptionFrameState

public static FrameState handleMissingAfterExceptionFrameState(FrameState nonReplaceableFrameState,
                                                               Invoke invoke,
                                                               org.graalvm.collections.EconomicMap<Node,Node> replacements,
                                                               boolean alwaysDuplicateStateAfter)

nonNullReceiver

public static ValueNode nonNullReceiver(Invoke invoke)

Gets the receiver for an invoke, adding a guard if necessary to ensure it is non-null, and ensuring that the resulting type is compatible with the method being invoked.

insertTypeGuard

public static void insertTypeGuard(CoreProviders providers,
                                   Invoke invoke,
                                   ResolvedJavaType type,
                                   Speculation speculation)

createSpeculation

public static SpeculationLog.SpeculationReason createSpeculation(Invoke invoke,
                                                                 JavaTypeProfile typeProfile)

getNodeCount

public static int getNodeCount(StructuredGraph graph)

This method exclude InstrumentationNode from inlining heuristics.