Gui external heatmaps by openroad-ci · Pull Request #10005 · The-OpenROAD-Project/OpenROAD

openroad-ci · 2026-03-31T10:46:20Z

Summary

Introduce ExternalHeatMapDataSource as a generic class to support loading heatmap data externally
Introduce utl::CsvParser
Introduce load_external_heatmap command

Type of Change

New feature

Impact

None of the current designs should be affected by this change.

Verification

I have verified that the local build succeeds (./etc/Build.sh).
I have run the relevant tests and they pass.
My code follows the repository's formatting guidelines.
I have signed my commits (DCO).

Related Issues

NA

Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

…rnal-heatmaps

…nal-heatmaps Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

Signed-off-by: Osama <osama21@aucegypt.edu>

…rnal-heatmaps

Signed-off-by: Osama <osama21@aucegypt.edu>

gemini-code-assist

Code Review

This pull request adds support for loading external heatmaps from CSV files. It introduces the ExternalHeatMapDataSource class to handle coordinate-based data and a CsvParser utility for reading the input files. Review feedback highlights a potential crash when processing root chips in hierarchical designs, suggests pre-allocating memory for data entries to improve performance, and notes that the current CSV parsing logic lacks support for quoted fields or escaped characters.

gemini-code-assist · 2026-03-31T10:49:51Z

src/gui/src/gui.cpp

+    auto* unfolded_chip
+        = db_->getUnfoldedModel()->findUnfoldedChip(chiplet_name);
+    if (unfolded_chip != nullptr) {
+      chip = unfolded_chip->chip_inst_path.back()->getMasterChip();


Accessing unfolded_chip->chip_inst_path.back() without checking if the path is empty can lead to a crash if chiplet_name refers to the top-level chip in an unfolded model. Hierarchical designs typically have an empty path for the root chip.

if (unfolded_chip->chip_inst_path.empty()) { chip = db_->getChip(); } else { chip = unfolded_chip->chip_inst_path.back()->getMasterChip(); }

gemini-code-assist · 2026-03-31T10:49:51Z

src/gui/src/gui.cpp

+  }
+  chiplet_name = csv_rows[0][0];
+  heatmap_name = csv_rows[0][1];
+  std::vector<ExternalHeatMapDataSource::Entry> data;


Reserving space in the data vector can improve performance by avoiding multiple reallocations, especially for large CSV files.

std::vector<ExternalHeatMapDataSource::Entry> data; data.reserve(csv_rows.size() - 1);

gemini-code-assist · 2026-03-31T10:49:51Z

src/utl/src/CsvParser.cpp

+    while (std::getline(ss, cell, delimiter)) {
+      cells.push_back(trim(cell));
+    }


The current CSV parsing logic using std::getline with a delimiter is very basic and does not handle standard CSV features like quoted fields (which may contain the delimiter or newlines) or escaped characters. While sufficient for simple numeric data, consider using a more robust parser if this utility is intended for general use within the utl namespace.

github-actions

clang-tidy made some suggestions

github-actions · 2026-03-31T10:53:02Z

src/gui/src/gui.cpp

+  }
+  const std::string short_name
+      = "External_" + std::to_string(owned_heat_maps_.size() + 1);
+  auto source = std::make_shared<ExternalHeatMapDataSource>(


warning: no header providing "gui::ExternalHeatMapDataSource" is directly included [misc-include-cleaner]

auto source = std::make_shared<ExternalHeatMapDataSource>( ^

github-actions · 2026-03-31T10:53:02Z

src/gui/src/gui.cpp

+  source->setTransform(transform);
+  registerHeatMap(source.get());
+  owned_heat_maps_.push_back(std::move(source));
+  return short_name;


warning: constness of 'short_name' prevents automatic move [performance-no-automatic-move]

return short_name; ^

github-actions · 2026-03-31T10:53:02Z

src/gui/src/heatMap.cpp

 #include <map>
 #include <memory>
+#include <optional>
+#include <sstream>


warning: included header optional is not used directly [misc-include-cleaner]

Suggested change

#include <sstream>

#include <sstream>

github-actions · 2026-03-31T10:53:02Z

src/gui/src/heatMap.cpp

 #include <memory>
+#include <optional>
+#include <sstream>
 #include <string>


warning: included header sstream is not used directly [misc-include-cleaner]

Suggested change

#include <string>

#include <string>

github-actions · 2026-03-31T10:53:02Z

src/gui/src/heatMap.cpp

 #include "heatMapSetup.h"
+#include "odb/db.h"
+#include "utl/Logger.h"



warning: included header Logger.h is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2026-03-31T10:53:03Z

src/utl/src/CsvParser.cpp

+
+namespace {
+
+static std::string trim(const std::string& s)


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

src/utl/src/CsvParser.cpp:7:

+ #include <string>

github-actions · 2026-03-31T10:53:03Z

src/utl/src/CsvParser.cpp

+
+}  // namespace
+
+std::vector<std::vector<std::string>> readCsv(const std::string& file_path,


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

src/utl/src/CsvParser.cpp:7:

+ #include <vector>

github-actions · 2026-03-31T10:53:03Z

src/utl/src/CsvParser.cpp

+
+  std::vector<std::vector<std::string>> rows;
+  std::string line;
+  while (std::getline(in, line)) {


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

while (std::getline(in, line)) { ^

github-actions · 2026-03-31T10:53:03Z

src/utl/src/CsvParser.cpp

+    std::vector<std::string> cells;
+    std::stringstream ss(line);
+    std::string cell;
+    while (std::getline(ss, cell, delimiter)) {


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

while (std::getline(ss, cell, delimiter)) { ^

github-actions · 2026-03-31T10:53:03Z

src/utl/src/CsvParser.cpp

+    while (std::getline(ss, cell, delimiter)) {
+      cells.push_back(trim(cell));
+    }
+    rows.push_back(std::move(cells));


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

src/utl/src/CsvParser.cpp:7:

+ #include <utility>

Signed-off-by: Osama <osama21@aucegypt.edu>

gadfort · 2026-03-31T15:22:07Z

src/gui/src/gui.cpp

+                   file_path,
+                   csv_rows[0].size());
+  }
+  const std::string chiplet_name = csv_rows[0][0];


why is chiplet_name here? that seems somewhat specific

To support 3D designs. When you have multiple chiplets in a system, the chiplet name is needed to apply the correct transformation per chiplet.

gadfort · 2026-03-31T15:23:15Z

src/gui/src/gui.i

  gui->dumpHeatMap(name, file);
 }

+std::string load_external_heatmap(const std::string& file_path)


no tcl command, maybe call this load_heatmap (unless it's specific to the chiplet, in which case that should be clear from the name

maliberty · 2026-03-31T20:49:43Z

src/utl/src/CsvParser.cpp

+
+namespace {
+
+static std::string trim(const std::string& s)


Use boost::trim ?

osamahammad21 · 2026-04-05T10:03:52Z

@vvbandeira @sombraSoft macOS build is failing while the bazel build in the CI is passing. Is this normal?

maliberty · 2026-04-06T16:44:43Z

Mac is running with --//:platform=gui but the regular build is not (yet). The error is in gui so it only appears there but is probably not mac specific.

osamahammad21 added 10 commits March 16, 2026 01:30

gui: support external heatmaps

7601c60

Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

Merge branch 'gui-chips-control' into gui-external-heatmaps

3ec825d

gui: unfolded chip in external heatmap datasource

d7d4a36

Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

Merge remote-tracking branch 'osama/odb-unfolded-model' into gui-exte…

9f07eba

…rnal-heatmaps

Merge remote-tracking branch 'osama/gui-chips-control' into gui-exter…

03d38b9

…nal-heatmaps Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

gui: changes after merge

a25d69f

Signed-off-by: osamahammad21 <osama21@aucegypt.edu>

Merge remote-tracking branch 'origin/master' into gui-external-heatmaps

2e40931

gui: code cleanup

690ce23

Signed-off-by: Osama <osama21@aucegypt.edu>

Merge commit '690ce230af12688517644185f2904d6baaf0f38f' into gui-exte…

4d7e55d

…rnal-heatmaps

gui: remove unrelated changes

e868ef7

Signed-off-by: Osama <osama21@aucegypt.edu>

openroad-ci assigned osamahammad21 Mar 31, 2026

gemini-code-assist bot reviewed Mar 31, 2026

View reviewed changes

github-actions bot reviewed Mar 31, 2026

View reviewed changes

clang-tidy requested changes

afcfd53

Signed-off-by: Osama <osama21@aucegypt.edu>

osamahammad21 requested a review from maliberty March 31, 2026 12:32

gadfort reviewed Mar 31, 2026

View reviewed changes

maliberty reviewed Mar 31, 2026

View reviewed changes

src/utl/src/CsvParser.cpp

namespace {

static std::string trim(const std::string& s)

Copy link
Copy Markdown

Member

maliberty Mar 31, 2026

Choose a reason for hiding this comment

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

Use boost::trim ?


		} // namespace

		std::vector<std::vector<std::string>> readCsv(const std::string& file_path,

Conversation

openroad-ci commented Mar 31, 2026 • edited by osamahammad21 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Type of Change

Impact

Verification

Related Issues

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Mar 31, 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 Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

gadfort Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

osamahammad21 Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

gadfort Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

maliberty Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

osamahammad21 commented Apr 5, 2026

Uh oh!

maliberty commented Apr 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openroad-ci commented Mar 31, 2026 •

edited by osamahammad21

Loading