com.xilinx.rapidwright.edif

Class EDIFLibrary

Object

com.xilinx.rapidwright.edif.EDIFName

com.xilinx.rapidwright.edif.EDIFLibrary

All Implemented Interfaces:

Comparable<EDIFName>

Direct Known Subclasses:

EDIFLibraryBuiltin

public class EDIFLibrary
extends EDIFName

Keeps track of a set of EDIFCell objects that are part of a netlist. Created on: May 11, 2017

Field Summary

Fields inherited from class com.xilinx.rapidwright.edif.EDIFName

EXPORT_CONST_RENAME_START

Constructor Summary

Constructors

Constructor and Description
EDIFLibrary(EDIFLibrary copy) Shallow copy constructor - Creates a new EDIFLibrary object containing shallow copies of its contained EDIFCell-s.
EDIFLibrary(String name)

Method Summary

Modifier and Type	Method and Description
EDIFCell	addCell(EDIFCell cell) Adds the provided cell to the library.
EDIFCell	addCellRenameDuplicates(EDIFCell cell, String preferredSuffix) Adds the provided cell to the library.
boolean	containsCell(EDIFCell cell) Checks the library based on the legal EDIF name (rename) if the cell is stored within.
boolean	containsCell(String name) Checks if the library contains a cell with the name provided.
List<Future<ParallelDCPInput>>	exportEDIF(EDIFWriteLegalNameCache<?> cache)
void	exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache)
void	exportEDIF(OutputStream os, EDIFWriteLegalNameCache<?> cache, boolean stable)
EDIFCell	getCell(String name) Gets the name of the cell using the EDIF name (rename construct).
Map<String,EDIFCell>	getCellMap() Gets and returns the current map of cells in the library.
Collection<EDIFCell>	getCells()
List<EDIFCell>	getExternallyReferencedCells() Creates a list of all cells that have references outside of this library.
Collection<EDIFLibrary>	getExternallyReferencedLibraries() Creates a collections of libraries that are referenced by cell instances within this library.
EDIFNetlist	getNetlist()
List<EDIFCell>	getValidCellExportOrder(boolean stable) Creates an ordered list of cells such that each cell that appears in the list only references cells that have already been seen in the list.
boolean	isHDIPrimitivesLibrary() Checks if this library is the HDI primitives library or that the name matches EDIFTools.EDIF_LIBRARY_HDI_PRIMITIVES_NAME.
boolean	isWorkLibrary() Checks if this library is the work library or that the name matches EDIFTools.EDIF_LIBRARY_WORK_NAME.
EDIFCell	removeCell(EDIFCell cell) Removes the cell from the library.
EDIFCell	removeCell(String name) Removes the cell by name
void	setNetlist(EDIFNetlist netlist)
void	uniqueifyCellsWithPrefix(String prefix) This method prepares all the cells in the library for a merger with another library by adding a unique prefix to all cell names.

Methods inherited from class com.xilinx.rapidwright.edif.EDIFName

compareTo, equals, exportEDIFName, exportSomeEDIFName, getName, getNewMap, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EDIFLibrary

public EDIFLibrary(String name)

EDIFLibrary

public EDIFLibrary(EDIFLibrary copy)

Shallow copy constructor - Creates a new EDIFLibrary object containing shallow copies of its contained EDIFCell-s.

Parameters:

copy - The original library

Method Detail

addCell

public EDIFCell addCell(EDIFCell cell)

Adds the provided cell to the library. All cells must be unique by their name. If provided cell is already attached to a library, make a shallow copy.

Parameters:

cell - The cell to add to the library.

Returns:

The cell that has been added.

addCellRenameDuplicates

public EDIFCell addCellRenameDuplicates(EDIFCell cell,
                                        String preferredSuffix)

Adds the provided cell to the library. If a cell by this name already exists, append a suffix to uniqueify the name.

Parameters:

cell - The cell to add to the library.

preferredSuffix - If a suffix needs to be appended for uniquification, use this one

Returns:

The cell that has been added.

getCell

public EDIFCell getCell(String name)

Gets the name of the cell using the EDIF name (rename construct). This is to avoid collisions that Vivado generates with parameterized cells (end with _HDI_###). Note that

Parameters:

name - The name of the cell as would be returned by getLegalEDIFName(). When the original name was already legal, it is the same.

Returns:

The cell in the library by the given legal EDIF name, or null if none exists.

getCells

public Collection<EDIFCell> getCells()

Returns:

the cells

getNetlist

public EDIFNetlist getNetlist()

Returns:

the netlist

setNetlist

public void setNetlist(EDIFNetlist netlist)

Parameters:

netlist - the netlist to set

removeCell

public EDIFCell removeCell(EDIFCell cell)

Removes the cell from the library. Uses the legal EDIF name as the key.

Parameters:

cell - The cell to remove.

Returns:

The removed cell.

removeCell

public EDIFCell removeCell(String name)

Removes the cell by name

Parameters:

name - The name of the cell to remove

Returns:

The removed cell, or null if it did not exist in the library.

containsCell

public boolean containsCell(EDIFCell cell)

Checks the library based on the legal EDIF name (rename) if the cell is stored within.

Parameters:

cell - The cell in question.

Returns:

True if the cell exists in the library, False otherwise.

containsCell

public boolean containsCell(String name)

Checks if the library contains a cell with the name provided.

Parameters:

name - The name of the cell to query in the library.

Returns:

True if a cell by such name was found in the library, False otherwise.

getCellMap

public Map<String,EDIFCell> getCellMap()

Gets and returns the current map of cells in the library. The cells are keyed by the legal EDIF name of the cell.

Returns:

The map containing the cells for this library.

getExternallyReferencedCells

public List<EDIFCell> getExternallyReferencedCells()

Creates a list of all cells that have references outside of this library.

Returns:

A newly created list of all cells that contains any instances of cells not located within this library.

getExternallyReferencedLibraries

public Collection<EDIFLibrary> getExternallyReferencedLibraries()

Creates a collections of libraries that are referenced by cell instances within this library.

Returns:

A collection of libraries that are referenced by cell instances found within cells of this library.

uniqueifyCellsWithPrefix

public void uniqueifyCellsWithPrefix(String prefix)

This method prepares all the cells in the library for a merger with another library by adding a unique prefix to all cell names. This method aims to address EDIF naming convention.

Parameters:

prefix - The prefix to add to all cells

getValidCellExportOrder

public List<EDIFCell> getValidCellExportOrder(boolean stable)

Creates an ordered list of cells such that each cell that appears in the list only references cells that have already been seen in the list. This is a requirement when exporting the EDIF to a file.

Parameters:

stable - makes sure that the list is always the same for the same input

Returns:

The ordered list.

isWorkLibrary

public boolean isWorkLibrary()

Checks if this library is the work library or that the name matches EDIFTools.EDIF_LIBRARY_WORK_NAME.

Returns:

True if this is the work library, false otherwise.

isHDIPrimitivesLibrary

public boolean isHDIPrimitivesLibrary()

Checks if this library is the HDI primitives library or that the name matches EDIFTools.EDIF_LIBRARY_HDI_PRIMITIVES_NAME.

Returns:

True if this is the HDI primitives library, false otherwise.

exportEDIF

public void exportEDIF(OutputStream os,
                       EDIFWriteLegalNameCache<?> cache,
                       boolean stable)
                throws IOException

Throws:

IOException

exportEDIF

public void exportEDIF(OutputStream os,
                       EDIFWriteLegalNameCache<?> cache)
                throws IOException

Throws:

IOException

exportEDIF

public List<Future<ParallelDCPInput>> exportEDIF(EDIFWriteLegalNameCache<?> cache)
                                          throws IOException

Throws:

IOException