Merge pull request #7968 from AcKoucher/mpl-keep-clustering

mpl: add option to store clustering data as dbGroups

Author: maliberty

src/mpl/README.md

@@ -46,6 +46,7 @@ rtl_macro_placer
     [-min_ar min_ar]
     [-report_directory report_directory]
     [-write_macro_placement file_name]
+    [-keep_clustering_data]
 ```
 
 #### Options
@@ -66,6 +67,7 @@ rtl_macro_placer
 | `-min_ar` | Specifies the minimum aspect ratio $a$, or the ratio of its width to height of a `StandardCellCluster` from $[a, \frac{1}{a}]$. The allowed values are floats, and the default value is `0.33`. |
 | `-report_directory` | Save reports to this directory. |
 | `-write_macro_placement` | Generates a file with the design's macro placement in the format of calls for the `place_macro` command. |
+| `-keep_clustering_data` | Save the hierarchy generated by MPL's clustering engine in the form of dbGroups inside ODB. |
 
 #### Simulated Annealing Weight parameters
 

src/mpl/include/mpl/rtl_mp.h

@@ -69,7 +69,8 @@ class MacroPlacer
              float target_util,
              float target_dead_space,
              float min_ar,
-             const char* report_directory);
+             const char* report_directory,
+             bool keep_clustering_data);
 
   void placeMacro(odb::dbInst* inst,
                   const float& x_origin,

src/mpl/src/hier_rtlmp.cpp

@@ -181,6 +181,11 @@ void HierRTLMP::setReportDirectory(const char* report_directory)
   report_directory_ = report_directory;
 }
 
+void HierRTLMP::setKeepClusteringData(bool keep_clustering_data)
+{
+  keep_clustering_data_ = keep_clustering_data;
+}
+
 // Top Level Function
 // The flow of our MacroPlacer is divided into 6 stages.
 // 1) Multilevel Autoclustering:
@@ -207,6 +212,10 @@ void HierRTLMP::run()
     return;
   }
 
+  if (keep_clustering_data_) {
+    commitClusteringDataToDb();
+  }
+
   if (!tree_->has_std_cells) {
     resetSAParameters();
   }
@@ -2562,6 +2571,44 @@ void HierRTLMP::commitMacroPlacementToDb()
   }
 }
 
+void HierRTLMP::commitClusteringDataToDb() const
+{
+  createGroupForCluster(tree_->root.get(), nullptr);
+}
+
+void HierRTLMP::createGroupForCluster(Cluster* cluster,
+                                      odb::dbGroup* parent_group) const
+{
+  if (cluster->isIOCluster()) {
+    return;
+  }
+
+  odb::dbGroup* cluster_group
+      = parent_group != nullptr
+            ? odb::dbGroup::create(parent_group, cluster->getName().c_str())
+            : odb::dbGroup::create(block_, cluster->getName().c_str());
+
+  cluster_group->setType(odb::dbGroupType::VISUAL_DEBUG);
+
+  for (odb::dbInst* inst : cluster->getLeafStdCells()) {
+    cluster_group->addInst(inst);
+  }
+
+  for (odb::dbInst* macro : cluster->getLeafMacros()) {
+    cluster_group->addInst(macro);
+  }
+
+  for (odb::dbModule* module : cluster->getDbModules()) {
+    for (odb::dbInst* inst : module->getLeafInsts()) {
+      cluster_group->addInst(inst);
+    }
+  }
+
+  for (const auto& child : cluster->getChildren()) {
+    createGroupForCluster(child.get(), cluster_group);
+  }
+}
+
 void HierRTLMP::setMacroPlacementFile(const std::string& file_name)
 {
   macro_placement_file_ = file_name;

src/mpl/src/hier_rtlmp.h

@@ -105,6 +105,7 @@ class HierRTLMP
   void setTargetDeadSpace(float target_dead_space);
   void setMinAR(float min_ar);
   void setReportDirectory(const char* report_directory);
+  void setKeepClusteringData(bool keep_clustering_data);
   void setDebug(std::unique_ptr<MplObserver>& graphics);
   void setDebugShowBundledNets(bool show_bundled_nets);
   void setDebugShowClustersIds(bool show_clusters_ids);
@@ -134,6 +135,9 @@ class HierRTLMP
   void updateMacrosOnDb();
   void updateMacroOnDb(const HardMacro* hard_macro);
   void commitMacroPlacementToDb();
+  void commitClusteringDataToDb() const;
+  void createGroupForCluster(Cluster* cluster,
+                             odb::dbGroup* parent_group) const;
   void clear();
   void computeWireLength() const;
 
@@ -309,6 +313,7 @@ class HierRTLMP
   const float conversion_tolerance_ = 0.01;
 
   bool skip_macro_placement_ = false;
+  bool keep_clustering_data_{false};
 
   std::unique_ptr<MplObserver> graphics_;
   bool is_debug_only_final_result_{false};

src/mpl/src/mpl.i

@@ -52,7 +52,8 @@ bool rtl_macro_placer_cmd(const int max_num_macro,
                           const float target_util,
                           const float target_dead_space,
                           const float min_ar,
-                          const char* report_directory) {
+                          const char* report_directory,
+                          const bool keep_clustering_data) {
 
   auto macro_placer = getMacroPlacer();
   const int num_threads = ord::OpenRoad::openRoad()->getThreadCount();
@@ -83,7 +84,8 @@ bool rtl_macro_placer_cmd(const int max_num_macro,
                              target_util,
                              target_dead_space,
                              min_ar,
-                             report_directory);
+                             report_directory,
+                             keep_clustering_data);
 }
 
 void set_debug_cmd(odb::dbBlock* block,

src/mpl/src/mpl.tcl

@@ -29,6 +29,7 @@ sta::define_cmd_args "rtl_macro_placer" { -max_num_macro  max_num_macro \
                                           -min_ar  min_ar \
                                           -report_directory report_directory \
                                           -write_macro_placement file_name \
+                                          -keep_clustering_data \
                                         }
 proc rtl_macro_placer { args } {
   sta::parse_key_args "rtl_macro_placer" args \
@@ -42,7 +43,7 @@ proc rtl_macro_placer { args } {
          -target_dead_space -min_ar \
          -report_directory \
          -write_macro_placement } \
-    flags {}
+    flags {-keep_clustering_data}
 
   sta::check_argc_eq0 "rtl_macro_placer" $args
 
@@ -198,7 +199,8 @@ proc rtl_macro_placer { args } {
       $target_util \
       $target_dead_space \
       $min_ar \
-      $report_directory]
+      $report_directory \
+      [info exists flags(-keep_clustering_data)]]
   } {
     return false
   }

src/mpl/src/rtl_mp.cpp

@@ -59,7 +59,8 @@ bool MacroPlacer::place(const int num_threads,
                         const float target_util,
                         const float target_dead_space,
                         const float min_ar,
-                        const char* report_directory)
+                        const char* report_directory,
+                        const bool keep_clustering_data)
 {
   hier_rtlmp_->setClusterSize(
       max_num_macro, min_num_macro, max_num_inst, min_num_inst);
@@ -84,6 +85,7 @@ bool MacroPlacer::place(const int num_threads,
   hier_rtlmp_->setMinAR(min_ar);
   hier_rtlmp_->setReportDirectory(report_directory);
   hier_rtlmp_->setNumThreads(num_threads);
+  hier_rtlmp_->setKeepClusteringData(keep_clustering_data);
 
   hier_rtlmp_->setGuidanceRegions(guidance_regions_);
 

src/mpl/test/BUILD

@@ -33,6 +33,7 @@ COMPULSORY_TESTS = [
     "boundary_push3",
     "centralization1",
     "clocked_macro",
+    "keep_clustering_data",
     "fixed_macros",
 ]
 
@@ -119,6 +120,7 @@ filegroup(
                 "io_constraints6": ["testcases/io_constraints6.def"],
                 "io_constraints7": ["testcases/io_constraints6.def"],
                 "io_constraints8": ["testcases/io_constraints6.def"],
+                "keep_clustering_data": ["testcases/io_constraints6.def"],
             }.get(test_name, []),
         ),
     )

src/mpl/test/CMakeLists.txt

@@ -26,6 +26,7 @@ or_integration_tests(
     boundary_push3
     centralization1
     clocked_macro
+    keep_clustering_data
     fixed_macros
 )