add flow variable to control MPL keep-clustering-data flag

Signed-off-by: Arthur Koucher <[email protected]>

Author: AcKoucher

docs/user/FlowVariables.md

@@ -168,6 +168,7 @@ configuration file.
 | <a name="MAX_ROUTING_LAYER"></a>MAX_ROUTING_LAYER| The highest metal layer name to be used in routing.| |
 | <a name="MIN_BUF_CELL_AND_PORTS"></a>MIN_BUF_CELL_AND_PORTS| Used to insert a buffer cell to pass through wires. Used in synthesis.| |
 | <a name="MIN_ROUTING_LAYER"></a>MIN_ROUTING_LAYER| The lowest metal layer name to be used in routing.| |
+| <a name="MPL_KEEP_CLUSTERING_DATA"></a>MPL_KEEP_CLUSTERING_DATA| Store the physical hierarchy generated during the macro placer in the form of dbGroups inside ODB.| 0|
 | <a name="OPENROAD_HIERARCHICAL"></a>OPENROAD_HIERARCHICAL| Feature toggle to enable to run OpenROAD in hierarchical mode, otherwise considered flat. Will eventually be the default and this option will be retired.| 0|
 | <a name="PDN_TCL"></a>PDN_TCL| File path which has a set of power grid policies used by pdn to be applied to the design, such as layers to use, stripe width and spacing to generate the actual metal straps.| |
 | <a name="PLACE_DENSITY"></a>PLACE_DENSITY| The desired average placement density of cells: 1.0 = dense, 0.0 = widely spread. The intended effort is also communicated by this parameter. Use a low value for faster builds and higher value for better quality of results. If a too low value is used, the placer will not be able to place all cells and a recommended minimum placement density can be found in the logs. A too high value can lead to excessive runtimes, even timeouts and subtle failures in the flow after placement, such as in CTS or global routing when timing repair fails. The default is platform specific.| |
@@ -313,6 +314,7 @@ configuration file.
 - [MATCH_CELL_FOOTPRINT](#MATCH_CELL_FOOTPRINT)
 - [MAX_ROUTING_LAYER](#MAX_ROUTING_LAYER)
 - [MIN_ROUTING_LAYER](#MIN_ROUTING_LAYER)
+- [MPL_KEEP_CLUSTERING_DATA](#MPL_KEEP_CLUSTERING_DATA)
 - [PDN_TCL](#PDN_TCL)
 - [PLACE_DENSITY](#PLACE_DENSITY)
 - [PLACE_DENSITY_LB_ADDON](#PLACE_DENSITY_LB_ADDON)

flow/scripts/macro_place_util.tcl

@@ -59,6 +59,7 @@ if { [find_macros] != "" } {
   append_env_var additional_rtlmp_args RTLMP_FENCE_LY -fence_ly 1
   append_env_var additional_rtlmp_args RTLMP_FENCE_UX -fence_ux 1
   append_env_var additional_rtlmp_args RTLMP_FENCE_UY -fence_uy 1
+  append_env_var additional_rtlmp_args MPL_KEEP_CLUSTERING_DATA -keep_clustering_data 0
 
   append additional_rtlmp_args " -target_util [place_density_with_lb_addon]"
 

flow/scripts/variables.yaml

@@ -1018,6 +1018,13 @@ RTLMP_ARGS:
     Overrides all other RTL macro placer arguments.
   stages:
     - floorplan
+MPL_KEEP_CLUSTERING_DATA:
+  description: >
+    Store the physical hierarchy generated during the macro placer in the form
+    of dbGroups inside ODB.
+  default: 0
+  stages:
+    - floorplan
 GDS_ALLOW_EMPTY:
   description: >
     Regular expression of module names of macros that have no .gds file