Merge pull request #8341 from eder-matheus/grt_report_wirelength

grt: report wire length per layer

Author: eder-matheus

src/grt/README.md

@@ -264,6 +264,7 @@ report_wire_length
     [-global_route]
     [-detailed_route]
     [-verbose]
+    [-summary]
 ```
 
 #### Options
@@ -275,6 +276,7 @@ report_wire_length
 | `-global_route` | Report the wire length of the global routing. |
 | `-detailed_route` | Report the wire length of the detailed routing. |
 | `-verbose` | This flag enables the full reporting of the layer-wise wirelength information. |
+| `-summary` | This flag reports the wire length for each layer of the design. |
 
 ### Global Route Debug Mode
 

src/grt/include/grt/GlobalRouter.h

@@ -262,7 +262,7 @@ class GlobalRouter
 
   // Report the wire length on each layer.
   void reportNetLayerWirelengths(odb::dbNet* db_net, std::ofstream& out);
-  void reportLayerWireLengths();
+  void reportLayerWireLengths(bool global_route, bool detailed_route);
   odb::Rect globalRoutingToBox(const GSegment& route);
   void boxToGlobalRouting(const odb::Rect& route_bds,
                           int layer,

src/grt/src/GlobalRouter.cpp

@@ -4781,32 +4781,89 @@ void GlobalRouter::reportNetLayerWirelengths(odb::dbNet* db_net,
   }
 }
 
-void GlobalRouter::reportLayerWireLengths()
+void GlobalRouter::reportLayerWireLengths(bool global_route,
+                                          bool detailed_route)
 {
-  std::vector<int64_t> lengths(db_->getTech()->getRoutingLayerCount() + 1);
-  int64_t total_length = 0;
-  for (auto& net_route : routes_) {
-    GRoute& route = net_route.second;
-    for (GSegment& seg : route) {
-      int layer1 = seg.init_layer;
-      int layer2 = seg.final_layer;
-      if (layer1 == layer2) {
-        int seg_length = seg.length();
-        lengths[layer1] += seg_length;
-        total_length += seg_length;
+  if (block_ == nullptr) {
+    block_ = db_->getChip()->getBlock();
+  }
+
+  if (global_route) {
+    logger_->info(GRT, 278, "Global route wire length by layer:");
+    std::vector<int64_t> lengths(db_->getTech()->getRoutingLayerCount() + 1);
+    int64_t total_length = 0;
+    for (auto& net_route : routes_) {
+      GRoute& route = net_route.second;
+      for (GSegment& seg : route) {
+        int layer1 = seg.init_layer;
+        int layer2 = seg.final_layer;
+        if (layer1 == layer2) {
+          int seg_length = seg.length();
+          lengths[layer1] += seg_length;
+          total_length += seg_length;
+        }
+      }
+    }
+    if (total_length > 0) {
+      logger_->report("Layer    Wire length  Percentage");
+      logger_->report("--------------------------------");
+      for (size_t i = 0; i < lengths.size(); i++) {
+        int64_t length = lengths[i];
+        if (length > 0) {
+          odb::dbTechLayer* layer = routing_layers_[i];
+          logger_->report("{:7s} {:8.2f}um {:5}%",
+                          layer->getName(),
+                          block_->dbuToMicrons(length),
+                          static_cast<int>((100.0 * length) / total_length));
+        }
       }
+      logger_->report("--------------------------------");
     }
   }
-  if (total_length > 0) {
-    for (size_t i = 0; i < lengths.size(); i++) {
-      int64_t length = lengths[i];
-      if (length > 0) {
-        odb::dbTechLayer* layer = routing_layers_[i];
-        logger_->report("{:5s} {:8d}um {:3d}%",
-                        layer->getName(),
-                        block_->dbuToMicrons(length),
-                        static_cast<int>((100.0 * length) / total_length));
+
+  if (detailed_route) {
+    logger_->info(GRT, 279, "Detailed route wire length by layer:");
+    std::vector<int64_t> lengths(db_->getTech()->getRoutingLayerCount() + 1);
+    int64_t total_length = 0;
+    odb::dbSet<odb::dbNet> nets = block_->getNets();
+    for (odb::dbNet* db_net : nets) {
+      odb::dbWire* wire = db_net->getWire();
+      if (wire == nullptr || db_net->getSigType().isSupply()
+          || db_net->isSpecial() || !db_net->getSWires().empty()
+          || db_net->isConnectedByAbutment()) {
+        continue;
+      }
+
+      odb::dbWirePath path;
+      odb::dbWirePathShape pshape;
+      odb::dbWirePathItr pitr;
+      for (pitr.begin(wire); pitr.getNextPath(path);) {
+        while (pitr.getNextShape(pshape)) {
+          const odb::dbShape& shape = pshape.shape;
+          if (!shape.isVia()) {
+            int layer = shape.getTechLayer()->getRoutingLevel();
+            int seg_length = shape.getLength();
+            lengths[layer] += seg_length;
+            total_length += seg_length;
+          }
+        }
+      }
+    }
+
+    if (total_length > 0) {
+      logger_->report("Layer    Wire length  Percentage");
+      logger_->report("--------------------------------");
+      for (size_t i = 0; i < lengths.size(); i++) {
+        int64_t length = lengths[i];
+        if (length > 0) {
+          odb::dbTechLayer* layer = db_->getTech()->findRoutingLayer(i);
+          logger_->report("{:7s} {:8.2f}um {:5}%",
+                          layer->getName(),
+                          block_->dbuToMicrons(length),
+                          static_cast<int>((100.0 * length) / total_length));
+        }
       }
+      logger_->report("--------------------------------");
     }
   }
 }

src/grt/src/GlobalRouter.i

@@ -237,9 +237,9 @@ clear_route_guides()
 }
 
 void
-report_layer_wire_lengths()
+report_layer_wire_lengths(bool global_route, bool detailed_route)
 {
-  getGlobalRouter()->reportLayerWireLengths();
+  getGlobalRouter()->reportLayerWireLengths(global_route, detailed_route);
 }
 
 void write_segments(const char* file_name)

src/grt/src/GlobalRouter.tcl

@@ -403,13 +403,14 @@ sta::define_cmd_args "report_wire_length" { [-net net_list] \
                                             [-file file] \
                                             [-global_route] \
                                             [-detailed_route] \
-                                            [-verbose]
+                                            [-verbose] \
+                                            [-summary]
 }
 
 proc report_wire_length { args } {
   sta::parse_key_args "report_wire_length" args \
     keys {-net -file} \
-    flags {-global_route -detailed_route -verbose}
+    flags {-global_route -detailed_route -verbose -summary}
 
   set block [ord::get_db_block]
   if { $block == "NULL" } {
@@ -431,7 +432,9 @@ proc report_wire_length { args } {
     grt::create_wl_report_file $file $verbose
   }
 
-  if { [info exists keys(-net)] } {
+  if { [info exists flags(-summary)] } {
+    grt::report_layer_wire_lengths $global_route_wl $detailed_route_wl
+  } elseif { [info exists keys(-net)] } {
     foreach net [get_nets $keys(-net)] {
       set db_net [sta::sta_to_db_net $net]
       if {

src/grt/test/BUILD

@@ -66,6 +66,8 @@ TESTS = [
     "report_wire_length4",
     "report_wire_length5",
     "report_wire_length6",
+    "report_wire_length7",
+    "report_wire_length8",
     "set_nets_to_route1",
     "silence",
     "single_row",

src/grt/test/CMakeLists.txt

@@ -66,6 +66,8 @@ or_integration_tests(
     report_wire_length4
     report_wire_length5
     report_wire_length6
+    report_wire_length7
+    report_wire_length8
     set_nets_to_route1
     silence
     single_row