Skip to content

grt: change 'overflow' to 'congestion'#10410

Merged
eder-matheus merged 4 commits into
The-OpenROAD-Project:masterfrom
eder-matheus:grt_cugr_reports_rename
May 14, 2026
Merged

grt: change 'overflow' to 'congestion'#10410
eder-matheus merged 4 commits into
The-OpenROAD-Project:masterfrom
eder-matheus:grt_cugr_reports_rename

Conversation

@eder-matheus
Copy link
Copy Markdown
Member

Summary

Renames every report overflow log/column/marker/comment to congestion across GRT so the vocabulary is consistent between FastRoute and CUGR. Internal C++ symbols (total_overflow_, getTotalOverflowPerLayer(), etc.) and the stable telemetry metric key (global_route__fastroute__overflow_iterations_s) are intentionally preserved.

What changes:

  • FastRoute (FastRoute.cpp, maze.cpp, utility.cpp) — Running extra iterations to remove overflow.... congestion; the iteration timer label, the GRT-0103 debug header, GRT-0107, the GRT-0230 warning, the RST Tree before overflow iterations / Tree 2D after overflow iterations debug prints, and all Max/Final/Total H/V overflow debug lines. The congestion_report_file CSV column header and the Total overflow: line in that file are renamed.
  • FastRoute marker commentscapacity:N usage:M overflow:Kcapacity:N usage:M congestion:K.
  • CUGR (CUGR.cpp) — Nets with overflow:Nets with congestion:, Total overflow:Total congestion:, and the per-3D-edge marker comment's overflow:K (...)congestion:K (...).
  • GlobalRouter (GlobalRouter.cpp) — GRT-0096 final-report column header Total OverflowTotal Congestion.
  • Docs / Tcl help (src/grt/README.md, GlobalRouter.tcl) — -congestion_iterations / -tree2D descriptions updated to match.
  • Test goldens — 53 .ok files and 3 .rptok files refreshed to reflect the renamed strings. The congestion_markers_cugr.tcl test's regex and comment also updated to expect congestion: in the marker comment.

Type of Change

  • Refactoring
  • Documentation update

Impact

  • All user-facing GRT logs now use a single consistent term ("congestion") for what was previously a mix of "overflow" and "congestion" depending on the call site. The numeric content is unchanged.
  • GRT-0096 report column reads Max H / Max V / Total Congestion.
  • dbMarker comments produced by both engines read capacity:N usage:M congestion:K (...). The DRC viewer / web inspector pass marker comments through verbatim, and no in-tree tool parses them, so this is a string-level change with no functional impact in the codebase. Downstream scripts (outside this repo) that parse the renamed strings would need to be updated.
  • congestion_report_file <file>.rpt output CSV column changed from overflow to congestion; the trailing total line changed from Total overflow: to Total congestion:.
  • Telemetry metric key global_route__fastroute__overflow_iterations_s is unchanged so ORFS / dashboard plumbing is not affected.

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 included tests to prevent regressions.
  • I have signed my commits (DCO).

Signed-off-by: Eder Monteiro <emrmonteiro@precisioninno.com>
Signed-off-by: Eder Monteiro <emrmonteiro@precisioninno.com>
Signed-off-by: Eder Monteiro <emrmonteiro@precisioninno.com>
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request implements a consistent terminology update by renaming "overflow" to "congestion" across the Global Router (grt) module. The changes span documentation, source code logging, report formatting, and test expectations. I have no feedback to provide as there were no review comments to assess.

@eder-matheus eder-matheus requested a review from maliberty May 12, 2026 22:03
@github-actions
Copy link
Copy Markdown
Contributor

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

@eder-matheus eder-matheus requested review from jfgava and removed request for maliberty May 13, 2026 21:32
…ROAD into grt_cugr_reports_rename

Signed-off-by: Eder Monteiro <emrmonteiro@precisioninno.com>
@eder-matheus eder-matheus requested a review from a team as a code owner May 14, 2026 13:58
@github-actions
Copy link
Copy Markdown
Contributor

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

@eder-matheus eder-matheus merged commit 5f0ba34 into The-OpenROAD-Project:master May 14, 2026
16 checks passed
@eder-matheus eder-matheus deleted the grt_cugr_reports_rename branch May 14, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants