com.xilinx.rapidwright.design

Class NetTools

Object

com.xilinx.rapidwright.design.NetTools

public class NetTools
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetTools.NodeTree

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTINUE_ELBOW
static String	LAST_ELBOW
static String	VERTICAL_BAR
static String	WHITE_SPACE

Constructor Summary

Constructors

Constructor and Description
NetTools()

Method Summary

Modifier and Type	Method and Description
static Node	findClockRootVRoute(Net net) Finds the clock root VROUTE node.
static String	getClockTreeSpine(Net net) Generates the clock tree up to the horizontal distribution nodes of the provided clock net up to the NODE_PINFEED nodes.
static List<Net>	getNetsWithOverlappingNodes(Design design) Returns a list of nets with overlapping nodes without unrouting them.
static String	getNetTreeString(Net net) Returns a string representation of the net's routing tree using tree characters (├─, └─).
static String	getNetTreeString(Net net, Function<Node,Boolean> filter) Returns a string representation of the net's routing tree using tree characters (├─, └─).
static String	getNetTreeString(Net net, Function<Node,Boolean> filter, Function<Node,String> customToString) Returns a string representation of the net's routing tree using tree characters (├─, └─).
static List<Node>	getNodesToSink(SitePinInst spi) Recovers the Node instances that route the net of the given sink pin as far as that pin, by walking backwards from it through the drivers given by NetTools.getNodeToDriver(Net).
static Map<Node,Node>	getNodeToDriver(Net net) Builds a map from each Node driven by a PIP of the given net onto the node driving it, so that the routing reaching any one node can be recovered by walking backwards from it (see NetTools.getNodesToSink(SitePinInst)).
static List<NetTools.NodeTree>	getNodeTrees(Net net) Compute the node routing tree of the given Net by examining its PIPs.
static List<NetTools.NodeTree>	getNodeTrees(Net net, Function<Node,Boolean> filter) Compute the node routing tree of the given Net by examining its PIPs.
static String	getVerticalClockTreeSpine(Net net) Gets a string representation of the vertical clock routing spine for the given net.
static boolean	hasClockSinks(Net net) Checks if the provided net drives a clock site pin input.
static boolean	isGlobalClock(Net net)
static List<Net>	unrouteNetsWithOverlappingNodes(Design design) Unroutes routed nets that have one or more overlapping or conflicting nodes with another route in the design.
static List<Net>	unrouteTopLevelNetsThatLeavePBlock(Design d, PBlock pBlock) Unroute top-level port nets that have PIPs outside the specified PBlock.

Methods inherited from class Object

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

Field Detail

CONTINUE_ELBOW

public static final String CONTINUE_ELBOW

See Also:

Constant Field Values

LAST_ELBOW

public static final String LAST_ELBOW

See Also:

Constant Field Values

VERTICAL_BAR

public static final String VERTICAL_BAR

See Also:

Constant Field Values

WHITE_SPACE

public static final String WHITE_SPACE

See Also:

Constant Field Values

Constructor Detail

NetTools

public NetTools()

Method Detail

isGlobalClock

public static boolean isGlobalClock(Net net)

getNodeTrees

public static List<NetTools.NodeTree> getNodeTrees(Net net)

Compute the node routing tree of the given Net by examining its PIPs. Note that this method only discovers subtrees that start at an output SitePinInst or a node tied to VCC/GND (i.e. gaps and islands will be ignored). Nodes that are multiply-driven (indicative of routing loops) will have their NodeTree.multiplyDriven flag set.

Parameters:

net - Net to analyze.

Returns:

A list of NodeTree objects, corresponding to the root of each subtree.

getNodeTrees

public static List<NetTools.NodeTree> getNodeTrees(Net net,
                                                   Function<Node,Boolean> filter)

Compute the node routing tree of the given Net by examining its PIPs. Note that this method only discovers subtrees that start at an output SitePinInst or a node tied to VCC/GND (i.e. gaps and islands will be ignored). Nodes that are multiply-driven (indicative of routing loops) will have their NodeTree.multiplyDriven flag set.

Parameters:

net - Net to analyze.

filter - A function that when is applied to a node, if it returns true will be excluded from the tree.

Returns:

A list of NodeTree objects, corresponding to the root of each subtree.

hasClockSinks

public static boolean hasClockSinks(Net net)

Checks if the provided net drives a clock site pin input.

Parameters:

net - The net to examine.

Returns:

True if the net has a site pin clock input, false otherwise.

unrouteNetsWithOverlappingNodes

public static List<Net> unrouteNetsWithOverlappingNodes(Design design)

Unroutes routed nets that have one or more overlapping or conflicting nodes with another route in the design. The choice between which of two or more nets gets unrouted is arbitrary and nets are unrouted until the set of routed nets do not overlap.

Parameters:

design - The design to evaluate for conflicting nodes.

Returns:

The list of nets that were unrouted.

getNetsWithOverlappingNodes

public static List<Net> getNetsWithOverlappingNodes(Design design)

Returns a list of nets with overlapping nodes without unrouting them.

Parameters:

design - The design to evaluate for conflicting nodes.

Returns:

The list of nets that overlap.

getNetTreeString

public static String getNetTreeString(Net net)

Returns a string representation of the net's routing tree using tree characters (├─, └─).

Parameters:

net - The net to generate the tree of nodes from.

Returns:

String representation of the net's routing tree with tree characters.

getNetTreeString

public static String getNetTreeString(Net net,
                                      Function<Node,Boolean> filter)

Returns a string representation of the net's routing tree using tree characters (├─, └─).

Parameters:

net - The net to generate the tree of nodes from.

filter - A function that when returns true for a node, the node should be excluded.

Returns:

String representation of the net's routing tree with tree characters.

getNetTreeString

public static String getNetTreeString(Net net,
                                      Function<Node,Boolean> filter,
                                      Function<Node,String> customToString)

Returns a string representation of the net's routing tree using tree characters (├─, └─).

Parameters:

net - The net to generate the tree of nodes from.

filter - A function that when returns true for a node, the node should be excluded.

customToString - A custom toString() function to be applied to the Node when printed.

Returns:

String representation of the net's routing tree with tree characters.

getClockTreeSpine

public static String getClockTreeSpine(Net net)

Generates the clock tree up to the horizontal distribution nodes of the provided clock net up to the NODE_PINFEED nodes.

Parameters:

net - The clock net

Returns:

A string tree representation from the source of the clock out to all horizontal distribution nodes.

getVerticalClockTreeSpine

public static String getVerticalClockTreeSpine(Net net)

Gets a string representation of the vertical clock routing spine for the given net. This method is similar to getClockTreeSpine but only includes vertical distribution nodes. Only the clock root VROUTE node is included; all other VROUTE nodes are filtered out.

Parameters:

net - The net to analyze

Returns:

A string tree representation showing only vertical clock routing nodes

findClockRootVRoute

public static Node findClockRootVRoute(Net net)

Finds the clock root VROUTE node. The clock root is the deepest (furthest from source) NODE_GLOBAL_VROUTE node in the tree.

Parameters:

net - The net to analyze

Returns:

The clock root VROUTE node, or null if none found

unrouteTopLevelNetsThatLeavePBlock

public static List<Net> unrouteTopLevelNetsThatLeavePBlock(Design d,
                                                           PBlock pBlock)

Unroute top-level port nets that have PIPs outside the specified PBlock. Vivado can potentially create designs where the top-level port nets leave the PBlock if the InlineFlopTools flop harness was used and the top-level port net also has a sink inside the PBlock. Physical net names must be consistent and macro unisims must be expanded before calling this method.

Parameters:

d - The design to unroute nets from.

pBlock - The bounding box for the placed and routed design.

getNodeToDriver

public static Map<Node,Node> getNodeToDriver(Net net)

Builds a map from each Node driven by a PIP of the given net onto the node driving it, so that the routing reaching any one node can be recovered by walking backwards from it (see NetTools.getNodesToSink(SitePinInst)). The direction of bidirectional PIPs is taken from PIP.isReversed(). Since a node has at most one entry, a multiply-driven node (which only an illegally routed net can have) retains just the driver of the last such PIP visited; use NetTools.getNodeTrees(Net) when all drivers matter. Nodes that the net's routing merely passes through without a PIP terminating on them (e.g. the source pin's node) are absent.

Parameters:

net - The net to examine; it need not be fully routed.

Returns:

A map from driven node onto driving node, empty if the net has no PIPs.

getNodesToSink

public static List<Node> getNodesToSink(SitePinInst spi)

Recovers the Node instances that route the net of the given sink pin as far as that pin, by walking backwards from it through the drivers given by NetTools.getNodeToDriver(Net). Since that map is rebuilt on every call, prefer building it once and walking it directly when more than one sink of the same net is of interest. The walk stops at the first node that no PIP drives, which is not included in the result: for a fully routed sink that is the source pin's node, but for a partially routed one it is wherever its routing gives out, which this method does not distinguish. The net's routing is assumed to be loop-free; this walk does not terminate on one that is not.

Parameters:

spi - The sink SitePinInst to walk back from; it must belong to a net.

Returns:

The nodes reaching that pin, ordered sink-first and excluding the node the walk stopped at, or an empty list if nothing drives the pin (e.g. an unrouted net).