mpl: halos for specific macros #9315

openroad-ci · 2026-01-22T12:24:58Z

This PR adds a new command to MPL: set_macro_halo, which sets a halo for a specified macro. Currently, this halo works only for placement, the blockages generated later still use the values in MACRO_PLACE_HALO (or MACRO_BLOCKAGE_HALO).

Blockage generation will be updated in an upcoming PR.

gemini-code-assist

Code Review

This pull request introduces a new command, set_macro_halo, which allows setting specific halos for individual macros. The implementation correctly integrates this feature into the macro placement flow, with logic to use these specific halos or fall back to global defaults. The changes are well-structured, including updates to the TCL interface, core placement logic, and GUI visualization. My review identified a couple of minor issues: the documentation for the new command in README.md is incorrect due to a copy-paste error, and there's a small redundancy in the new TCL command's implementation. Addressing these will improve the clarity and correctness of the new feature.

gemini-code-assist · 2026-01-22T12:26:40Z

src/mpl/README.md

+set_macro_guidance_region
+    -macro_name macro_name
+    -region region
+```
+
+#### Options
+
+| Switch Name | Description |
+| ----- | ----- |
+| `-macro_name` | The name of a macro of the design. |
+| `-region` | The lower left corner and upper right corner {lx ly ux uy} of the region in microns. |


The documentation for the new set_macro_halo command appears to be a copy-paste from set_macro_guidance_region and is incorrect. The command name, arguments, and descriptions should be updated to reflect the new functionality.

Specifically:

The command in the example should be set_macro_halo.

The argument should be -halo instead of -region.

The description for -halo should state that it's a list of two values: {width height} in microns.

Suggested change

set_macro_guidance_region

-macro_name macro_name

-region region

```

#### Options

| Switch Name | Description |

| ----- | ----- |

| `-macro_name` | The name of a macro of the design. |

| `-region` | The lower left corner and upper right corner {lx ly ux uy} of the region in microns. |

set_macro_halo

-macro_name macro_name

-halo {width height}

Options

Switch Name Description

-macro_name The name of a macro of the design.

-halo The horizontal and vertical halo {width height} around the macro in microns.

gemini-code-assist · 2026-01-22T12:26:40Z

src/mpl/src/mpl.tcl

+  set width $width
+  set height $height


The lassign command on the previous line already assigns the values from the halo list to the width and height variables. These set commands are redundant and can be removed.

github-actions

clang-tidy made some suggestions

github-actions · 2026-01-22T12:32:11Z

src/mpl/include/mpl/rtl_mp.h


  void setMacroPlacementFile(const std::string& file_name);
  void addGuidanceRegion(odb::dbInst* macro, odb::Rect region);
+  void addMacroHalo(odb::dbInst* macro, std::pair<int, int> halo);


warning: no header providing "std::pair" is directly included [misc-include-cleaner]

src/mpl/include/mpl/rtl_mp.h:8:

- #include <vector> + #include <utility> + #include <vector>

github-actions · 2026-01-22T12:32:11Z

src/mpl/src/hier_rtlmp.h

  void setHaloHeight(int halo_height);
  void setGuidanceRegions(
      const std::map<odb::dbInst*, odb::Rect>& guidance_regions);
+  void setMacroHalos(const std::map<odb::dbInst*, std::pair<int, int>>& halos);


warning: no header providing "std::pair" is directly included [misc-include-cleaner]

src/mpl/src/hier_rtlmp.h:9:

- #include <vector> + #include <utility> + #include <vector>

github-actions · 2026-01-22T12:32:11Z

src/mpl/src/rtl_mp.cpp

  guidance_regions_[macro] = region;
 }

+void MacroPlacer::addMacroHalo(odb::dbInst* macro, std::pair<int, int> halo)


warning: no header providing "std::pair" is directly included [misc-include-cleaner]

src/mpl/src/rtl_mp.cpp:7:

- #include <vector> + #include <utility> + #include <vector>

Signed-off-by: João Mai <jmai@precisioninno.com>

github-actions

clang-tidy made some suggestions

github-actions · 2026-01-22T19:33:24Z

src/mpl/include/mpl/rtl_mp.h

  odb::dbDatabase* db_ = nullptr;

  std::map<odb::dbInst*, odb::Rect> guidance_regions_;
+  std::map<odb::dbInst*, std::pair<int, int>> macro_halos_;


warning: no header providing "std::pair" is directly included [misc-include-cleaner]

src/mpl/include/mpl/rtl_mp.h:8:

- #include <vector> + #include <utility> + #include <vector>

Signed-off-by: João Mai <jmai@precisioninno.com>

github-actions · 2026-01-22T20:07:38Z

clang-tidy review says "All clean, LGTM! 👍"

AcKoucher

Please, address the code assist comment in the .mpl file.
Also, take a look at why the tests with fixed macros are failing (I suspect it has something to do with the new method for creating HardMacros).

AcKoucher · 2026-01-23T14:55:31Z

src/mpl/src/rtl_mp.cpp

+void MacroPlacer::addMacroHalo(odb::dbInst* macro,
+                               int halo_width,
+                               int halo_height)
+{
+  hier_rtlmp_->addMacroHalo(macro, halo_width, halo_height);
+}
+


I think the name setMacroHalo makes more sense, as a macro won't have more than one Halo.

AcKoucher · 2026-01-23T14:56:00Z

src/mpl/src/mpl.i

 }

+void
+add_macro_halo(odb::dbInst* macro, 


set_macro_halo

AcKoucher · 2026-01-23T14:58:45Z

src/mpl/src/hier_rtlmp.h


  std::map<std::string, odb::Rect> fences_;   // macro_name, fence
  std::map<odb::dbInst*, odb::Rect> guides_;  // Macro -> Guidance Region
+  std::map<odb::dbInst*, HardMacro::Halo>


macro_to_halo_ and drop the comment.

AcKoucher · 2026-01-23T14:59:46Z

src/mpl/include/mpl/rtl_mp.h


  void setMacroPlacementFile(const std::string& file_name);
  void addGuidanceRegion(odb::dbInst* macro, odb::Rect region);
+  void addMacroHalo(odb::dbInst* macro, int halo_width, int halo_height);


setMacroHalo

AcKoucher · 2026-01-23T15:00:34Z

src/mpl/src/clusterEngine.cpp

-    const int width = master->getWidth() + (2 * tree_->halo_width);
-    const int height = master->getHeight() + (2 * tree_->halo_height);
-    macro_with_halo_area += (width * static_cast<int64_t>(height));
+    macro_with_halo_area += tree_->maps.inst_to_hard[unfixed_macro]->getArea();


Use std::map::at as the map is not being modified.

AcKoucher · 2026-01-23T15:10:01Z

src/mpl/src/hier_rtlmp.cpp

+  clustering_engine_ = std::make_unique<ClusteringEngine>(
+      block_, network_, logger_, tritonpart_, graphics_.get());
+
+  createHardMacros(block_->getTopModule());


I liked that you separated this in one function :-)

I've been trying to make the ClusteringEngine the object that populates/changes the tree_.
That said, I think this method should belong to the ClusteringEngine and not to HierRTLMP. (Ideally it should belong to a placement engine, but that is for one day in the future when the stars align).

AcKoucher · 2026-01-23T15:13:29Z

src/mpl/src/graphics.cpp

+    odb::Rect halo_bbox(macro.getX(),
+                        macro.getY(),
+                        macro.getX() + macro.getWidth(),
+                        macro.getY() + macro.getHeight());
+    odb::Rect macro_bbox(macro.getRealX(),
+                         macro.getRealY(),
+                         macro.getRealX() + width,
+                         macro.getRealY() + height);

-    painter.drawRect(bbox);
-    painter.drawString(bbox.xCenter(),
-                       bbox.yCenter(),
+    halo_bbox.moveDelta(outline_.xMin(), outline_.yMin());
+    macro_bbox.moveDelta(outline_.xMin(), outline_.yMin());
+
+    painter.setBrush(gui::Painter::kDarkRed);
+    painter.drawRect(halo_bbox);
+
+    painter.setBrush(gui::Painter::kRed);
+    painter.drawRect(macro_bbox);


Signed-off-by: João Mai <jmai@precisioninno.com>

AcKoucher · 2026-01-28T18:08:46Z

The new code from #9362 will require changes in this PR.

Signed-off-by: João Mai <jmai@precisioninno.com>

github-actions · 2026-01-28T21:49:12Z

clang-tidy review says "All clean, LGTM! 👍"

AcKoucher

LGTM

AcKoucher · 2026-01-29T11:43:43Z

src/mpl/src/clusterEngine.cpp

+  auto macro_insts
+      = block_->getInsts() | std::ranges::views::filter(&odb::dbInst::isBlock);


openroad-ci assigned joaomai Jan 22, 2026

gemini-code-assist bot reviewed Jan 22, 2026

View reviewed changes

github-actions bot reviewed Jan 22, 2026

View reviewed changes

joaomai added 8 commits January 22, 2026 18:29

mpl: update graphics to visualize halos

3adc846

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: tcl command to add specific halo to specific macros

4f2a1d2

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: halos for specific macros

343d346

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: update README with new command

8ae61a8

Signed-off-by: João Mai <jmai@precisioninno.com>

formatting

9867436

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: update README

4d402df

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: use HardMacro::Halo to store halo data

d93930d

Signed-off-by: João Mai <jmai@precisioninno.com>

formatting

4ec524b

Signed-off-by: João Mai <jmai@precisioninno.com>

openroad-ci force-pushed the mpl-new-halos branch from 112fab5 to 4ec524b Compare January 22, 2026 19:26

github-actions bot reviewed Jan 22, 2026

View reviewed changes

joaomai added 2 commits January 22, 2026 19:33

mpl: update README

c5a5393

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: remove unused variable

88c4fd4

Signed-off-by: João Mai <jmai@precisioninno.com>

joaomai requested a review from AcKoucher January 22, 2026 20:03

AcKoucher suggested changes Jan 23, 2026

View reviewed changes

joaomai added 5 commits January 28, 2026 13:53

Merge branch 'master' into mpl-new-halos

130aa1a

mpl: rename halo related variables

ca7eeca

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: move createHardMacros to ClusteringEngine

4cd8e91

Signed-off-by: João Mai <jmai@precisioninno.com>

mpl: create macros after floorplan has been initialized

471d37b

Signed-off-by: João Mai <jmai@precisioninno.com>

Merge branch 'master' into mpl-new-halos

8549ad3

Merge branch 'master' into mpl-new-halos

a6ae9b3

Signed-off-by: João Mai <jmai@precisioninno.com>

joaomai requested a review from AcKoucher January 28, 2026 21:45

AcKoucher approved these changes Jan 29, 2026

View reviewed changes

joaomai requested a review from maliberty January 29, 2026 14:45

Switch Name	Description
`-macro_name`	The name of a macro of the design.
`-halo`	The horizontal and vertical halo {width height} around the macro in microns.

		auto macro_insts
		= block_->getInsts() \| std::ranges::views::filter(&odb::dbInst::isBlock);

mpl: halos for specific macros #9315

Are you sure you want to change the base?

mpl: halos for specific macros #9315

Conversation

openroad-ci commented Jan 22, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jan 22, 2026

Choose a reason for hiding this comment

Options

Uh oh!

gemini-code-assist bot Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 22, 2026

Uh oh!

AcKoucher left a comment

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

AcKoucher commented Jan 28, 2026

Uh oh!

github-actions bot commented Jan 28, 2026

Uh oh!

AcKoucher left a comment

Choose a reason for hiding this comment

Uh oh!

AcKoucher Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

AcKoucher Jan 23, 2026 •

edited

Loading

AcKoucher Jan 23, 2026 •

edited

Loading

AcKoucher Jan 23, 2026 •

edited

Loading