com.xilinx.rapidwright.rwroute

Class RouterHelper

Object

com.xilinx.rapidwright.rwroute.RouterHelper

public class RouterHelper
extends Object

A collection of supportive methods for the router.

Constructor Summary

Constructors

Constructor and Description
RouterHelper()

Method Summary

Modifier and Type	Method and Description
static void	addNodeTypeLengthToMap(Node node, long wlNode, Map<IntentCode,Long> typeUsage, Map<IntentCode,Long> typeLength) Adds the IntentCode and wirelength of an used node to the map.
static short	computeNodeDelay(DelayEstimatorBase estimator, Node node) Computes the delay of a node.
static LightweightRouteNode	createRoutingNode(Node node, Map<Node,LightweightRouteNode> createdRoutingNodes) Creates a LightweightRouteNode Object based on a Node Object, avoiding duplicates.
static List<Node>	findPathBetweenNodes(Node source, Node sink) Find a path from a source node to a sink node.
static PIP	findPIPbetweenNodes(Node driver, Node load) Finds the PIP instance that connects two Node instances.
static List<PIP>	getConnectionPIPs(Connection connection) Gets a list of PIP instances for routing a connection.
static Collection<Node>	getNodesOfNet(Net net) Gets a (non-unique) collection of Node instances used by a Net instance.
static PIP	getPIP(Node driver, Node load) Gets the PIP instance from a driver Node instance to a load Node instance.
static PIP	getPIP(Tile loadTile, Wire[] driverWires, int loadWire) Gets the PIP instance based on the Tile instance of a node, its driver node wires and its base Wire instance.
static List<PIP>	getPIPsFromNodes(List<Node> connectionNodes) Gets a list of PIP instances from a list of Node instances.
static List<PIP>	getPIPsFromNodes(List<Node> connectionNodes, boolean srcToSinkOrder) Gets a list of PIP instances from a list of Node instances.
static void	getSamplePathDelay(String filePath, TimingManager timingManager, Map<TimingEdge,Connection> timingEdgeConnectionMap, RouteNodeGraph routingGraph) Gets the delay of a given path, using output pin only.
static Map<Pair<SitePinInst,Node>,Short>	getSourceToSinkINTNodeDelays(Net net, DelayEstimatorBase estimator) Gets a map containing net delay for each sink pin paired with an INT tile node of a routed net.
static Tile	getUpstreamINTTileOfClkIn(SitePinInst clkIn)
static Set<SitePinInst>	invertPossibleGndPinsToVccPins(Design design, List<SitePinInst> pins) Inverts all possible GND sink pins to VCC pins.
static boolean	isDriverLessNet(Net net) Checks if a Net instance is driver-less.
static boolean	isDriverLessOrLoadLessNet(Net net) Checks if a Net instance is driver-less or load-less.
static boolean	isExternalConnectionToCout(SitePinInst source, SitePinInst sink) Checks if the source-sink connection is an external connection driven by COUT.
static boolean	isInternallyRoutedNet(Net net) Checks if a Net instance is internally routed net.
static boolean	isLoadLessNet(Net net) Checks if a Net instance is load-less.
static boolean	isRoutableNetWithSourceSinks(Net net) Checks if a Net instance has source and sink SitePinInst instances to be routable.
static List<String>	parseVivadoPathToStringList(File file) Parses the data path from an input file indicating data path of a Vivado timing report.
static List<Node>	projectInputPinToINTNode(SitePinInst input) Gets a list of Node instances that connect an input SitePinInst instance to an INT Tile instance.
static Node	projectOutputPinToINTNode(SitePinInst output) Gets a Node instance that connects to an INT Tile instance from an output SitePinInst instance.
static boolean	routeDirectConnection(Connection directConnection) Routes and assigns nodes to a direct connection, e.g.

Methods inherited from class Object

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

Constructor Detail

RouterHelper

public RouterHelper()

Method Detail

isRoutableNetWithSourceSinks

public static boolean isRoutableNetWithSourceSinks(Net net)

Checks if a Net instance has source and sink SitePinInst instances to be routable.

Parameters:

net - The net to be checked.

Returns:

true, if the net has source and sink pins.

isDriverLessOrLoadLessNet

public static boolean isDriverLessOrLoadLessNet(Net net)

Checks if a Net instance is driver-less or load-less.

Parameters:

net - The net to be checked.

Returns:

true, if the nets is driver-less or load-less.

isDriverLessNet

public static boolean isDriverLessNet(Net net)

Checks if a Net instance is driver-less.

Parameters:

net - The net to be checked.

Returns:

true, if the net does not have a source pin.

isLoadLessNet

public static boolean isLoadLessNet(Net net)

Checks if a Net instance is load-less.

Parameters:

net - The net to be checked.

Returns:

true, if the net does not have sink pins.

isInternallyRoutedNet

public static boolean isInternallyRoutedNet(Net net)

Checks if a Net instance is internally routed net.

Parameters:

net - The net to be checked.

Returns:

true, if the net does not have pins.

isExternalConnectionToCout

public static boolean isExternalConnectionToCout(SitePinInst source,
                                                 SitePinInst sink)

Checks if the source-sink connection is an external connection driven by COUT. If true, the source pin swapped to the alternative pin of the Net instance. Because COUT only connects to CIN.

Parameters:

source - The source SitePinInst of this connection.

sink - The sink SitePinInst of this connection.

Returns:

true, if the source is a COUT while the sink is not CIN.

projectOutputPinToINTNode

public static Node projectOutputPinToINTNode(SitePinInst output)

Gets a Node instance that connects to an INT Tile instance from an output SitePinInst instance.

Parameters:

output - The output pin.

Returns:

A node that connects to an INT tile from an output pin.

projectInputPinToINTNode

public static List<Node> projectInputPinToINTNode(SitePinInst input)

Gets a list of Node instances that connect an input SitePinInst instance to an INT Tile instance.

Parameters:

input - The input pin.

Returns:

A list of nodes from the input SitePinInst to an INT tile.

getUpstreamINTTileOfClkIn

public static Tile getUpstreamINTTileOfClkIn(SitePinInst clkIn)

getConnectionPIPs

public static List<PIP> getConnectionPIPs(Connection connection)

Gets a list of PIP instances for routing a connection.

Parameters:

connection - The Connection instance that has been routed with a list of Node instances.

Returns:

A list of PIPs for the connection.

getPIPsFromNodes

public static List<PIP> getPIPsFromNodes(List<Node> connectionNodes)

Gets a list of PIP instances from a list of Node instances.

Parameters:

connectionNodes - The list of nodes of a routed Connection instance.

Returns:

A list of PIPs generated from the list of nodes.

getPIPsFromNodes

public static List<PIP> getPIPsFromNodes(List<Node> connectionNodes,
                                         boolean srcToSinkOrder)

Gets a list of PIP instances from a list of Node instances.

Parameters:

connectionNodes - The list of nodes of a routed Connection instance.

srcToSinkOrder - Specifies the order of the connection nodes. True indicates the first node is the source and the last is the sink. False indicates the opposite.

Returns:

A list of PIPs generated from the list of nodes.

findPIPbetweenNodes

public static PIP findPIPbetweenNodes(Node driver,
                                      Node load)

Finds the PIP instance that connects two Node instances.

Parameters:

driver - The driver node.

load - The load node.

Returns:

The PIP connecting the two nodes.

getPIP

public static PIP getPIP(Tile loadTile,
                         Wire[] driverWires,
                         int loadWire)

Gets the PIP instance based on the Tile instance of a node, its driver node wires and its base Wire instance.

Parameters:

loadTile - The base tile of the load node.

driverWires - All wires in the driver node.

loadWire - The wire of the load node.

Returns:

The PIP that connects one of the wires in the driver node and the wire of the load node.

getPIP

public static PIP getPIP(Node driver,
                         Node load)

Gets the PIP instance from a driver Node instance to a load Node instance.

Parameters:

driver - The driver node.

load - The load node.

Returns:

The PIP from the driver node to the load node.

getNodesOfNet

public static Collection<Node> getNodesOfNet(Net net)

Gets a (non-unique) collection of Node instances used by a Net instance. Nodes associated with unrouted sink pins on this net will be excluded.

Parameters:

net - The target net.

Returns:

A collection of nodes used by target net.

invertPossibleGndPinsToVccPins

public static Set<SitePinInst> invertPossibleGndPinsToVccPins(Design design,
                                                              List<SitePinInst> pins)

Inverts all possible GND sink pins to VCC pins.

Parameters:

design - The target design.

pins - The static net pins.

addNodeTypeLengthToMap

public static void addNodeTypeLengthToMap(Node node,
                                          long wlNode,
                                          Map<IntentCode,Long> typeUsage,
                                          Map<IntentCode,Long> typeLength)

Adds the IntentCode and wirelength of an used node to the map.

Parameters:

node - The target node.

wlNode - The wirelength of the node.

typeUsage - The map between each node type and the number of used nodes for the node type.

typeLength - The map between each node type and the total wirelength of used nodes for the node type.

getSourceToSinkINTNodeDelays

public static Map<Pair<SitePinInst,Node>,Short> getSourceToSinkINTNodeDelays(Net net,
                                                                             DelayEstimatorBase estimator)

Gets a map containing net delay for each sink pin paired with an INT tile node of a routed net.

Parameters:

net - The target routed net.

estimator - An instantiation of DelayEstimatorBase.

Returns:

The map containing net delay for each sink pin paired with an INT tile node of a routed net.

createRoutingNode

public static LightweightRouteNode createRoutingNode(Node node,
                                                     Map<Node,LightweightRouteNode> createdRoutingNodes)

Creates a LightweightRouteNode Object based on a Node Object, avoiding duplicates.

Parameters:

node - The Node instance that is used to create a RoutingNode object.

createdRoutingNodes - A map storing created LightweightRouteNode instances and corresponding Node instances.

Returns:

A created RoutingNode instance based on a node

computeNodeDelay

public static short computeNodeDelay(DelayEstimatorBase estimator,
                                     Node node)

Computes the delay of a node.

Parameters:

estimator - An instantiation of the DelayEstimatorBase.

node - The node in question.

Returns:

The delay of the node.

routeDirectConnection

public static boolean routeDirectConnection(Connection directConnection)

Routes and assigns nodes to a direct connection, e.g. carry chain connections and connections between cascaded BRAMs.

Parameters:

directConnection - The target direct connection.

Returns:

true, if the connection is successfully routed.

findPathBetweenNodes

public static List<Node> findPathBetweenNodes(Node source,
                                              Node sink)

Find a path from a source node to a sink node.

Parameters:

source - The source node.

sink - The sink node.

Returns:

A list of nodes making up the path.

getSamplePathDelay

public static void getSamplePathDelay(String filePath,
                                      TimingManager timingManager,
                                      Map<TimingEdge,Connection> timingEdgeConnectionMap,
                                      RouteNodeGraph routingGraph)

Gets the delay of a given path, using output pin only. The path format: superSource -> Q -> O -> --- -> D.

parseVivadoPathToStringList

public static List<String> parseVivadoPathToStringList(File file)
                                                throws IOException

Parses the data path from an input file indicating data path of a Vivado timing report.

Parameters:

file - The file contains a data path of a Vivado timing report.

Returns:

The data path.

Throws:

IOException