org.graalvm.compiler.nodes.cfg

Class ControlFlowGraph

java.lang.Object

org.graalvm.compiler.nodes.cfg.ControlFlowGraph

All Implemented Interfaces:

AbstractControlFlowGraph<Block>

public final class ControlFlowGraph
extends Object
implements AbstractControlFlowGraph<Block>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlFlowGraph.CFGOptions
static class	ControlFlowGraph.DeferredExit
static interface	ControlFlowGraph.RecursiveVisitor<V>

Field Summary

Fields

Modifier and Type	Field and Description
StructuredGraph	graph
static double	MAX_RELATIVE_FREQUENCY
static double	MIN_RELATIVE_FREQUENCY Don't allow relative frequency values to be become too small or too high as this makes frequency calculations over- or underflow the range of a double.

Fields inherited from interface org.graalvm.compiler.core.common.cfg.AbstractControlFlowGraph

BLOCK_ID_INITIAL, BLOCK_ID_VISITED

Method Summary

Modifier and Type	Method and Description
static void	addDeferredExit(ControlFlowGraph.DeferredExit[] deferredExits, Block b)
Block	blockFor(Node node)
Block	commonDominatorFor(NodeIterable<? extends Node> nodes)
static ControlFlowGraph	compute(StructuredGraph graph, boolean connectBlocks, boolean computeLoops, boolean computeDominators, boolean computePostdominators)
static ControlFlowGraph	computeForSchedule(StructuredGraph graph)
void	computePostdominators()
String	dominatorTreeString()
Block[]	getBlocks() Returns the list blocks contained in this control flow graph.
org.graalvm.collections.EconomicMap<LoopBeginNode,ProfileData.LoopFrequencyData>	getLocalLoopFrequencyData()
List<Loop<Block>>	getLoops()
int	getMaxDominatorDepth()
NodeMap<Block>	getNodeToBlock()
Block	getStartBlock()
static boolean	isDominatorTreeLoopExit(Block b)
static boolean	isDominatorTreeLoopExit(Block b, boolean considerRealExits)
double	localLoopFrequency(LoopBeginNode lb)
ProfileData.ProfileSource	localLoopFrequencySource(LoopBeginNode lb)
static double	multiplyRelativeFrequencies(double a, double b) Multiplies a and b and clamps the between ControlFlowGraph.MIN_RELATIVE_FREQUENCY and ControlFlowGraph.MAX_RELATIVE_FREQUENCY.
static double	multiplyRelativeFrequencies(double a, double b, double c)
Block[]	reversePostOrder()
void	setNodeToBlock(NodeMap<Block> nodeMap)
void	updateCachedLocalLoopFrequency(LoopBeginNode lb, Function<ProfileData.LoopFrequencyData,ProfileData.LoopFrequencyData> updater) Update the cached local loop frequency for the given loop.
<V> void	visitDominatorTree(ControlFlowGraph.RecursiveVisitor<V> visitor, boolean deferLoopExits)
<V> void	visitDominatorTreeDefault(ControlFlowGraph.RecursiveVisitor<V> visitor)
<V> void	visitDominatorTreeDeferLoopExits(ControlFlowGraph.RecursiveVisitor<V> visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graalvm.compiler.core.common.cfg.AbstractControlFlowGraph

commonDominator, commonDominatorHelper, commonDominatorTyped, dominates, strictlyDominates

Field Detail

MIN_RELATIVE_FREQUENCY

public static final double MIN_RELATIVE_FREQUENCY

Don't allow relative frequency values to be become too small or too high as this makes frequency calculations over- or underflow the range of a double. This commonly happens with infinite loops within infinite loops. The value is chosen a bit lower than half the maximum exponent supported by double. That way we can never overflow to infinity when multiplying two relative frequency values.

See Also:

Constant Field Values

MAX_RELATIVE_FREQUENCY

public static final double MAX_RELATIVE_FREQUENCY

See Also:

Constant Field Values

graph

public final StructuredGraph graph

Method Detail

computeForSchedule

public static ControlFlowGraph computeForSchedule(StructuredGraph graph)

compute

public static ControlFlowGraph compute(StructuredGraph graph,
                                       boolean connectBlocks,
                                       boolean computeLoops,
                                       boolean computeDominators,
                                       boolean computePostdominators)

localLoopFrequency

public double localLoopFrequency(LoopBeginNode lb)

localLoopFrequencySource

public ProfileData.ProfileSource localLoopFrequencySource(LoopBeginNode lb)

getLocalLoopFrequencyData

public org.graalvm.collections.EconomicMap<LoopBeginNode,ProfileData.LoopFrequencyData> getLocalLoopFrequencyData()

updateCachedLocalLoopFrequency

public void updateCachedLocalLoopFrequency(LoopBeginNode lb,
                                           Function<ProfileData.LoopFrequencyData,ProfileData.LoopFrequencyData> updater)

Update the cached local loop frequency for the given loop. Future queries of ControlFlowGraph.localLoopFrequency(LoopBeginNode) on this ControlFlowGraph instance will return the updated value. This is useful for phases to record temporary effects of transformations on loop frequencies, without having to recompute a CFG.

The updated frequency is a cached value local to this CFG. It is not persisted in the IR graph. Newly computed ControlFlowGraph instances will recompute a frequency from loop exit probabilities, they will not see this locally cached value. Persistent changes to loop frequencies must be modeled by changing loop exit probabilities in the graph.

dominatorTreeString

public String dominatorTreeString()

visitDominatorTreeDefault

public <V> void visitDominatorTreeDefault(ControlFlowGraph.RecursiveVisitor<V> visitor)

addDeferredExit

public static void addDeferredExit(ControlFlowGraph.DeferredExit[] deferredExits,
                                   Block b)

visitDominatorTreeDeferLoopExits

public <V> void visitDominatorTreeDeferLoopExits(ControlFlowGraph.RecursiveVisitor<V> visitor)

visitDominatorTree

public <V> void visitDominatorTree(ControlFlowGraph.RecursiveVisitor<V> visitor,
                                   boolean deferLoopExits)

isDominatorTreeLoopExit

public static boolean isDominatorTreeLoopExit(Block b)

isDominatorTreeLoopExit

public static boolean isDominatorTreeLoopExit(Block b,
                                              boolean considerRealExits)

getBlocks

public Block[] getBlocks()

Description copied from interface: AbstractControlFlowGraph

Returns the list blocks contained in this control flow graph. It is guaranteed that the blocks are numbered and ordered according to a reverse post order traversal of the control flow graph.

Specified by:

getBlocks in interface AbstractControlFlowGraph<Block>

See Also:

CFGVerifier

getStartBlock

public Block getStartBlock()

Specified by:

getStartBlock in interface AbstractControlFlowGraph<Block>

reversePostOrder

public Block[] reversePostOrder()

getNodeToBlock

public NodeMap<Block> getNodeToBlock()

blockFor

public Block blockFor(Node node)

commonDominatorFor

public Block commonDominatorFor(NodeIterable<? extends Node> nodes)

getLoops

public List<Loop<Block>> getLoops()

Specified by:

getLoops in interface AbstractControlFlowGraph<Block>

getMaxDominatorDepth

public int getMaxDominatorDepth()

computePostdominators

public void computePostdominators()

setNodeToBlock

public void setNodeToBlock(NodeMap<Block> nodeMap)

multiplyRelativeFrequencies

public static double multiplyRelativeFrequencies(double a,
                                                 double b,
                                                 double c)

multiplyRelativeFrequencies

public static double multiplyRelativeFrequencies(double a,
                                                 double b)

Multiplies a and b and clamps the between ControlFlowGraph.MIN_RELATIVE_FREQUENCY and ControlFlowGraph.MAX_RELATIVE_FREQUENCY.