com.xilinx.rapidwright.design.tools

Class RelocationTools

Object

com.xilinx.rapidwright.design.tools.RelocationTools

public class RelocationTools
extends Object

A collection of tools to help relocate designs.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<SiteTypeEnum>	defaultSiteTypes

Constructor Summary

Constructors

Constructor and Description
RelocationTools()

Method Summary

Modifier and Type	Method and Description
static Pair<Site,Map<Integer,Site>>	getValidRelocationOptions(Design design) Based on the provided design, calculates all of the valid locations that the implemented component could be relocated to on the currently targeted device.
static void	main(String[] args) Offers a command line accessible way to relocate a design implementation.
static void	printValidRelocationOptions(Pair<Site,Map<Integer,Site>> options, int limit, PrintStream ps) Prints out valid relocation options produced by RelocationTools.getValidRelocationOptions(Design).
static boolean	relocate(Design design, Collection<SiteInst> siteInsts, int tileColOffset, int tileRowOffset) Relocate all given SiteInsts and PIPs in-place by tileColOffset/tileRowOffset tiles.
static boolean	relocate(Design design, PBlock pblock, int tileColOffset, int tileRowOffset) Relocate all SiteInsts (and PIPs) within the Pblock in-place by tileColOffset/tileRowOffset tiles.
static boolean	relocate(Design design, String instanceName, int tileColOffset, int tileRowOffset)
static boolean	relocate(Design design, String instanceName, int tileColOffset, int tileRowOffset, Set<SiteTypeEnum> siteTypes) Relocate all SiteInsts (and all associated PIPs) belonging to the logical Cell at instanceName in-place by tileColOffset/tileRowOffset tiles.

Methods inherited from class Object

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

Field Detail

defaultSiteTypes

public static final Set<SiteTypeEnum> defaultSiteTypes

Constructor Detail

RelocationTools

public RelocationTools()

Method Detail

relocate

public static boolean relocate(Design design,
                               String instanceName,
                               int tileColOffset,
                               int tileRowOffset)

relocate

public static boolean relocate(Design design,
                               String instanceName,
                               int tileColOffset,
                               int tileRowOffset,
                               Set<SiteTypeEnum> siteTypes)

Relocate all SiteInsts (and all associated PIPs) belonging to the logical Cell at instanceName in-place by tileColOffset/tileRowOffset tiles. Should a SiteInst contain a mix of physical Cells belonging to and outside of instanceName then this function will fail.

Parameters:

design - Parent design

instanceName - Full hierarchical instance name to logical cell (empty for top cell)

tileColOffset - Relocate this number of tile columns (X axis)

tileRowOffset - Relocate this number of tile rows (Y axis)

siteTypes - Set of SiteTypeEnum-s to relocate (overload exists where this is emitted thus defaulting to RelocationTools.defaultSiteTypes)

Returns:

True if successful, false otherwise.

relocate

public static boolean relocate(Design design,
                               PBlock pblock,
                               int tileColOffset,
                               int tileRowOffset)

Relocate all SiteInsts (and PIPs) within the Pblock in-place by tileColOffset/tileRowOffset tiles.

Parameters:

design - Parent design

pblock - PBlock

tileColOffset - Relocate this number of tile columns (X axis)

tileRowOffset - Relocate this number of tile rows (Y axis)

Returns:

True if successful, false otherwise.

relocate

public static boolean relocate(Design design,
                               Collection<SiteInst> siteInsts,
                               int tileColOffset,
                               int tileRowOffset)

Relocate all given SiteInsts and PIPs in-place by tileColOffset/tileRowOffset tiles. Should any SiteInst or PIP not be relocatable to a tile at the specified offset (e.g. if a compatible tile does not exist) function will return false and design will be unmodified. Any net sourced from a SiteInst not in the given set will be fully unrouted; those destined for a SiteInst not in the given set will have their specific branch unrouted.

Parameters:

design - Parent design

siteInsts - List of SiteInsts to be relocated

tileColOffset - Relocate this number of tile columns (X axis)

tileRowOffset - Relocate this number of tile rows (Y axis)

Returns:

True if successful, false otherwise.

getValidRelocationOptions

public static Pair<Site,Map<Integer,Site>> getValidRelocationOptions(Design design)

Based on the provided design, calculates all of the valid locations that the implemented component could be relocated to on the currently targeted device.

Parameters:

design - The design to evaluate for relocation options.

Returns:

A pair, where the first element is the anchor site selected in the design and the second element is a sorted map of placement options where the keys are ordered by increasing Manhattan distance (in tile (X,Y) coordinate values) from the original anchor site and the value is the potential relocated anchor site.

printValidRelocationOptions

public static void printValidRelocationOptions(Pair<Site,Map<Integer,Site>> options,
                                               int limit,
                                               PrintStream ps)

Prints out valid relocation options produced by RelocationTools.getValidRelocationOptions(Design).

Parameters:

options - The relocation options.

limit - Limit the number of printed options to this value.

main

public static void main(String[] args)

Offers a command line accessible way to relocate a design implementation. It can provide a list of valid relocation options for which full relocation is possible by providing just a single DCP as an option. Or, it will perform a best effort relocation (relocating as much as possible and unplacing/unrouting incompatible cells/routes) when provided a DCP, output location and set of offsets.

Parameters:

args - Two modes, for listing relocation options args[0]==; for relocation (full or best effort partial) args[0]==, args[1]==, args[2]==, args[3]==.