Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DesignTools.deletePblock()]: utility to delete a pblock #1020

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/com/xilinx/rapidwright/design/DesignTools.java
Original file line number Diff line number Diff line change
Expand Up @@ -4197,4 +4197,56 @@ public static void updatePinsIsRouted(Design design) {
updatePinsIsRouted(net);
}
}

/**
* (Untested) Remove the speicifed pblock from the XDC constraints of the design.
*
* This utility will iterate through the lines of the XDC constraints and
* remove any lines that contain the specified pblock name and any pblock-related
* commands. The commands that are considered pblock-related are:
* - add_cells_to_pblock
* - create_pblock
* - get_pblocks
* - resize_pblock
*
* This utility is only tested on Vivado-maintained XDC constraints.
*
* @param design The design to remove the pblock from.
* @param pblockName The name of the pblock to remove.
*/
public static void deletePblock(Design design, String pblockName) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest calling it something more clear:

Suggested change
public static void deletePblock(Design design, String pblockName) {
public static void removeConstraintsReferencingPBlock(Design design, String pblockName) {

List<String> pblockCommands = Arrays.asList(
"add_cells_to_pblock",
"create_pblock",
"get_pblocks",
"resize_pblock"
);

boolean foundPblock = false; // Flag to track if any matching pblock is found

for (ConstraintGroup cg : ConstraintGroup.values()) {
// Get the current constraints for the constraint group
List<String> updatedConstraints = new ArrayList<>();

// Check if the line contains any pblock-related command and the pblockName
for (String line : design.getXDCConstraints(cg)) {
boolean containsPblockCommand = pblockCommands.stream().anyMatch(line::contains);
boolean containsPblockName = line.contains(pblockName);
Comment on lines +4233 to +4234
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using contains seems quite brittle. Given pblockName is foo, the following would match:

  • create_pblock foobar
  • ... [get_pblocks notfoo]
  • add_cells_to_pblock ... [get_cells foo]

Now the robustness of this is certainly limited by RapidWright not having a XDC parser, but I would still prefer to see some stricter matching, perhaps using regex.


if (containsPblockCommand && containsPblockName) {
foundPblock = true;
continue;
}

updatedConstraints.add(line);
}

// Update the constraints for the constraint group
design.setXDCConstraints(updatedConstraints, cg);
}

if (!foundPblock) {
System.out.println("WARNING: No such pblock '" + pblockName + "' found in the design.");
}
}
}
Loading