Merge pull request #3818 from AcKoucher/secure-mpl-optional-data-flow

add flow variable for data flow driven macro placement and update OR

Author: eder-matheus

docs/user/FlowVariables.md

@@ -202,6 +202,7 @@ configuration file.
 | <a name="RTLMP_AREA_WT"></a>RTLMP_AREA_WT| Weight for the area of the current floorplan.| 0.1|
 | <a name="RTLMP_ARGS"></a>RTLMP_ARGS| Overrides all other RTL macro placer arguments.| |
 | <a name="RTLMP_BOUNDARY_WT"></a>RTLMP_BOUNDARY_WT| Weight for the boundary or how far the hard macro clusters are from boundaries.| 50.0|
+| <a name="RTLMP_DATA_FLOW_DRIVEN"></a>RTLMP_DATA_FLOW_DRIVEN| Specifies whether the macro placer should use data-flow driven macro placement. Data-flow driven works by adding a wire length component that takes into account the data paths of the design. This optional can increase run time significantly for large designs.| 1|
 | <a name="RTLMP_FENCE_LX"></a>RTLMP_FENCE_LX| Defines the lower left X coordinate for the global fence bounding box in microns.| 0.0|
 | <a name="RTLMP_FENCE_LY"></a>RTLMP_FENCE_LY| Defines the lower left Y coordinate for the global fence bounding box in microns.| 0.0|
 | <a name="RTLMP_FENCE_UX"></a>RTLMP_FENCE_UX| Defines the upper right X coordinate for the global fence bounding box in microns.| 0.0|
@@ -348,6 +349,7 @@ configuration file.
 - [RTLMP_AREA_WT](#RTLMP_AREA_WT)
 - [RTLMP_ARGS](#RTLMP_ARGS)
 - [RTLMP_BOUNDARY_WT](#RTLMP_BOUNDARY_WT)
+- [RTLMP_DATA_FLOW_DRIVEN](#RTLMP_DATA_FLOW_DRIVEN)
 - [RTLMP_FENCE_LX](#RTLMP_FENCE_LX)
 - [RTLMP_FENCE_LY](#RTLMP_FENCE_LY)
 - [RTLMP_FENCE_UX](#RTLMP_FENCE_UX)

flow/scripts/macro_place_util.tcl

@@ -60,6 +60,10 @@ if { [find_macros] != "" } {
 
   append additional_rtlmp_args " -target_util [place_density_with_lb_addon]"
 
+  if { $::env(RTLMP_DATA_FLOW_DRIVEN) } {
+    append additional_rtlmp_args " -data_flow_driven"
+  }
+
   set all_args $additional_rtlmp_args
 
   if { [env_var_exists_and_non_empty RTLMP_ARGS] } {

flow/scripts/variables.yaml

@@ -1155,6 +1155,15 @@ RTLMP_FENCE_UY:
   default: 0.0
   stages:
     - floorplan
+RTLMP_DATA_FLOW_DRIVEN:
+  description: >
+    Specifies whether the macro placer should use data-flow driven macro placement.
+    Data-flow driven works by adding a wire length component that takes into account
+    the data paths of the design. This optional can increase run time significantly
+    for large designs.
+  default: 1
+  stages:
+    - floorplan
 RTLMP_ARGS:
   description: >
     Overrides all other RTL macro placer arguments.