librelane 2.4.0__py3-none-any.whl

librelane/scripts/openroad/sta/corner.tcl

@@ -0,0 +1,393 @@
+# Copyright 2020-2023 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This file supports one defined corner per-process.
+# Any more defined corners will be ignored.
+# Aggregation is left to the LibreLane step.
+
+
+source $::env(SCRIPTS_DIR)/openroad/common/io.tcl
+
+set_cmd_units\
+    -time ns\
+    -capacitance pF\
+    -current mA\
+    -voltage V\
+    -resistance kOhm\
+    -distance um
+
+set sta_report_default_digits 6
+
+if { [namespace exists ::ord] } {
+    read_current_odb
+    source $::env(SCRIPTS_DIR)/openroad/common/set_rc.tcl
+
+    # Internal API- brittle
+    if { [grt::have_routes] } {
+        estimate_parasitics -global_routing
+    } elseif { [rsz::check_corner_wire_cap] } {
+        estimate_parasitics -placement
+    }
+} else {
+    read_timing_info
+}
+read_spefs
+
+set corner [lindex [sta::corners] 0]
+sta::set_cmd_corner $corner
+
+set clocks [sta::sort_by_name [sta::all_clocks]]
+
+puts "%OL_CREATE_REPORT min.rpt"
+puts "\n==========================================================================="
+puts "report_checks -path_delay min (Hold)"
+puts "============================================================================"
+puts "======================= [$corner name] Corner ===================================\n"
+report_checks -sort_by_slack -path_delay min -fields {slew cap input nets fanout} -format full_clock_expanded -group_count 1000 -corner [$corner name]
+puts ""
+puts "%OL_END_REPORT"
+
+
+puts "%OL_CREATE_REPORT max.rpt"
+puts "\n==========================================================================="
+puts "report_checks -path_delay max (Setup)"
+puts "============================================================================"
+puts "======================= [$corner name] Corner ===================================\n"
+report_checks -sort_by_slack -path_delay max -fields {slew cap input nets fanout} -format full_clock_expanded -group_count 1000 -corner [$corner name]
+puts ""
+puts "%OL_END_REPORT"
+
+
+puts "%OL_CREATE_REPORT checks.rpt"
+puts "\n==========================================================================="
+puts "report_checks -unconstrained"
+puts "==========================================================================="
+puts "======================= [$corner name] Corner ===================================\n"
+report_checks -unconstrained -fields {slew cap input nets fanout} -format full_clock_expanded -corner [$corner name]
+puts ""
+
+
+puts "\n==========================================================================="
+puts "report_checks --slack_max -0.01"
+puts "============================================================================"
+puts "======================= [$corner name] Corner ===================================\n"
+report_checks -slack_max -0.01 -fields {slew cap input nets fanout} -format full_clock_expanded -corner [$corner name]
+puts ""
+
+puts "\n==========================================================================="
+puts " report_check_types -max_slew -max_cap -max_fanout -violators"
+puts "============================================================================"
+puts "======================= [$corner name] Corner ===================================\n"
+report_check_types -max_slew -max_capacitance -max_fanout -violators -corner [$corner name]
+puts ""
+
+puts "\n==========================================================================="
+puts "report_parasitic_annotation -report_unannotated"
+puts "============================================================================"
+report_parasitic_annotation -report_unannotated
+
+puts "\n==========================================================================="
+puts "max slew violation count [sta::max_slew_violation_count]"
+write_metric_int "design__max_slew_violation__count__corner:[$corner name]" [sta::max_slew_violation_count]
+puts "max fanout violation count [sta::max_fanout_violation_count]"
+write_metric_int "design__max_fanout_violation__count__corner:[$corner name]" [sta::max_fanout_violation_count]
+puts "max cap violation count [sta::max_capacitance_violation_count]"
+write_metric_int "design__max_cap_violation__count__corner:[$corner name]" [sta::max_capacitance_violation_count]
+puts "============================================================================"
+
+puts "\n==========================================================================="
+puts "check_setup -verbose -unconstrained_endpoints -multiple_clock -no_clock -no_input_delay -loops -generated_clocks"
+puts "==========================================================================="
+check_setup -verbose -unconstrained_endpoints -multiple_clock -no_clock -no_input_delay -loops -generated_clocks
+puts "%OL_END_REPORT"
+
+
+
+puts "%OL_CREATE_REPORT power.rpt"
+puts "\n==========================================================================="
+puts " report_power"
+puts "============================================================================"
+puts "======================= [$corner name] Corner ===================================\n"
+report_power -corner [$corner name]
+
+set power_result [sta::design_power $corner]
+set totals       [lrange $power_result  0  3]
+lassign $totals design_internal design_switching design_leakage design_total
+
+write_metric_num "power__internal__total" $design_internal
+write_metric_num "power__switching__total" $design_switching
+write_metric_num "power__leakage__total" $design_leakage
+write_metric_num "power__total" $design_total
+
+puts ""
+puts "%OL_END_REPORT"
+
+
+puts "%OL_CREATE_REPORT skew.min.rpt"
+puts "\n==========================================================================="
+puts "Clock Skew (Hold)"
+puts "============================================================================"
+set skew_corner [worst_clock_skew -hold]
+write_metric_num "clock__skew__worst_hold__corner:[$corner name]" $skew_corner
+
+puts "======================= [$corner name] Corner ===================================\n"
+report_clock_skew -corner [$corner name] -hold
+
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT skew.max.rpt"
+puts "\n==========================================================================="
+puts "Clock Skew (Setup)"
+puts "============================================================================"
+set skew_corner [worst_clock_skew -setup]
+write_metric_num "clock__skew__worst_setup__corner:[$corner name]" $skew_corner
+
+puts "======================= [$corner name] Corner ===================================\n"
+report_clock_skew -corner [$corner name] -setup
+
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT ws.min.rpt"
+puts "\n==========================================================================="
+puts "Worst Slack (Hold)"
+puts "============================================================================"
+set ws [worst_slack -corner [$corner name] -min]
+write_metric_num "timing__hold__ws__corner:[$corner name]" $ws
+puts "[$corner name]: $ws"
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT ws.max.rpt"
+puts "\n==========================================================================="
+puts "Worst Slack (Setup)"
+puts "============================================================================"
+
+set ws [worst_slack -corner [$corner name] -max]
+write_metric_num "timing__setup__ws__corner:[$corner name]" $ws
+puts "[$corner name]: $ws"
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT tns.min.rpt"
+puts "\n==========================================================================="
+puts "Total Negative Slack (Hold)"
+puts "============================================================================"
+
+set tns [total_negative_slack -corner [$corner name] -min]
+write_metric_num "timing__hold__tns__corner:[$corner name]" $tns
+puts "[$corner name]: $tns"
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT tns.max.rpt"
+puts "\n==========================================================================="
+puts "Total Negative Slack (Setup)"
+puts "============================================================================"
+set tns [total_negative_slack -corner [$corner name] -max]
+write_metric_num "timing__setup__tns__corner:[$corner name]" $tns
+puts "[$corner name]: $tns"
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT wns.min.rpt"
+puts "\n==========================================================================="
+puts "Worst Negative Slack (Hold)"
+puts "============================================================================"
+
+set ws [worst_slack -corner [$corner name] -min]
+set wns 0
+if { $ws < 0 } {
+    set wns $ws
+}
+write_metric_num "timing__hold__wns__corner:[$corner name]" $wns
+puts "[$corner name]: $wns"
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT wns.max.rpt"
+puts "\n==========================================================================="
+puts "Worst Negative Slack (Setup)"
+puts "============================================================================"
+
+set ws [worst_slack -corner [$corner name] -max]
+set wns 0.0
+if { $ws < 0 } {
+    set wns $ws
+}
+write_metric_num "timing__setup__wns__corner:[$corner name]" $wns
+puts "[$corner name]: $wns"
+puts "%OL_END_REPORT"
+
+proc check_if_terminal {pin_object} {
+    set net [get_nets -of_object $pin_object]
+    if { "$net" == "NULL" } {
+        return 1
+    }
+    return 0
+}
+
+proc get_path_kind {start_pin end_pin} {
+    set from "reg"
+    set to "reg"
+
+    if { [check_if_terminal $start_pin] } {
+        set from "in"
+    }
+    if { [check_if_terminal $end_pin] } {
+        set to "out"
+    }
+    return "$from-$to"
+}
+
+puts "%OL_CREATE_REPORT violator_list.rpt"
+puts "\n==========================================================================="
+puts "Violator List"
+puts "============================================================================"
+
+set total_hold_vios 0
+set r2r_hold_vios 0
+set total_setup_vios 0
+set r2r_setup_vios 0
+
+set max_violator_count 999999999
+if { [info exists ::env(STA_MAX_VIOLATOR_COUNT)] } {
+    set max_violator_count $::env(STA_MAX_VIOLATOR_COUNT)
+}
+
+set hold_violating_paths [find_timing_paths -unique_paths_to_endpoint -path_delay min -sort_by_slack -group_count $max_violator_count -slack_max 0]
+foreach path $hold_violating_paths {
+    set start_pin [get_property $path startpoint]
+    set end_pin [get_property $path endpoint]
+    set kind "[get_path_kind $start_pin $end_pin]"
+    set slack [get_property $path slack]
+
+    if { $slack >= 0 } {
+        continue
+    }
+
+    incr total_hold_vios
+    if { "$kind" == "reg-reg" } {
+        incr r2r_hold_vios
+    }
+    puts "\[hold $kind] [get_property $start_pin full_name] -> [get_property $end_pin full_name] : [get_property $path slack]"
+}
+
+set worst_r2r_hold_slack 1e30
+set hold_paths [find_timing_paths -unique_paths_to_endpoint -path_delay min -sort_by_slack -group_count $max_violator_count -slack_max $worst_r2r_hold_slack]
+foreach path $hold_paths {
+    set start_pin [get_property $path startpoint]
+    set end_pin [get_property $path endpoint]
+    set kind "[get_path_kind $start_pin $end_pin]"
+    set slack [get_property $path slack]
+
+    if { "$kind" == "reg-reg" } {
+        set slack [get_property $path slack]
+
+        if { $slack < $worst_r2r_hold_slack } {
+            set worst_r2r_hold_slack $slack
+        }
+    }
+}
+
+set setup_violating_paths [find_timing_paths -unique_paths_to_endpoint -path_delay max -sort_by_slack -group_count $max_violator_count -slack_max 0]
+foreach path $setup_violating_paths {
+    set start_pin [get_property $path startpoint]
+    set end_pin [get_property $path endpoint]
+    set kind "[get_path_kind $start_pin $end_pin]"
+    set slack [get_property $path slack]
+
+    if { $slack >= 0 } {
+        continue
+    }
+
+    incr total_setup_vios
+    if { "$kind" == "reg-reg" } {
+        incr r2r_setup_vios
+    }
+    puts "\[setup $kind] [get_property $start_pin full_name] -> [get_property $end_pin full_name] : [get_property $path slack]"
+}
+
+set worst_r2r_setup_slack 1e30
+set setup_paths [find_timing_paths -unique_paths_to_endpoint -path_delay max -sort_by_slack -group_count $max_violator_count -slack_max $worst_r2r_setup_slack]
+foreach path $setup_paths {
+    set start_pin [get_property $path startpoint]
+    set end_pin [get_property $path endpoint]
+    set kind "[get_path_kind $start_pin $end_pin]"
+    set slack [get_property $path slack]
+
+    if { "$kind" == "reg-reg" } {
+        set slack [get_property $path slack]
+        if { $slack < $worst_r2r_setup_slack } {
+            set worst_r2r_setup_slack $slack
+        }
+    }
+}
+
+write_metric_int "timing__hold_vio__count__corner:[$corner name]" $total_hold_vios
+write_metric_num "timing__hold_r2r__ws__corner:[$corner name]" $worst_r2r_hold_slack
+write_metric_int "timing__hold_r2r_vio__count__corner:[$corner name]" $r2r_hold_vios
+write_metric_int "timing__setup_vio__count__corner:[$corner name]" $total_setup_vios
+write_metric_num "timing__setup_r2r__ws__corner:[$corner name]" $worst_r2r_setup_slack
+write_metric_int "timing__setup_r2r_vio__count__corner:[$corner name]" $r2r_setup_vios
+puts "%OL_END_REPORT"
+
+puts "%OL_CREATE_REPORT unpropagated.rpt"
+
+foreach clock [all_clocks] {
+    if { ![get_property $clock is_propagated] } {
+        puts "[get_property $clock full_name]"
+    }
+}
+
+puts "%OL_END_REPORT"
+
+
+puts "%OL_CREATE_REPORT clock.rpt"
+
+foreach clock [all_clocks] {
+    set source_names ""
+    set is_generated "no"
+    set is_virtual "no"
+    set is_propagated "no"
+    foreach source [get_property $clock sources] {
+        set source_names "[get_property $source full_name] $source_names"
+    }
+    if { [get_property $clock is_generated] } {
+        set is_generated "yes"
+    }
+    if { [get_property $clock is_virtual] } {
+        set is_virtual "yes"
+    }
+    if { [get_property $clock is_propagated] } {
+        set is_virtual "yes"
+    }
+    puts "Clock: [get_property $clock name]"
+    puts "Sources: $source_names"
+    puts "Generated: $is_generated"
+    puts "Virtual: $is_virtual"
+    puts "Propagated: $is_propagated"
+    puts "Period: [get_property $clock period]"
+    puts "\n==========================================================================="
+    puts "report_clock_properties"
+    puts "============================================================================"
+    report_clock_properties $clock
+    puts "\n==========================================================================="
+    puts "report_clock_latency"
+    puts "============================================================================"
+    report_clock_latency -clock $clock
+    puts "\n==========================================================================="
+    puts "report_clock_min_period"
+    puts "============================================================================"
+    report_clock_min_period -clocks [get_property $clock name]
+}
+
+puts "%OL_END_REPORT"
+
+write_sdfs
+write_libs

librelane/scripts/openroad/tapcell.tcl

@@ -0,0 +1,25 @@
+# Copyright 2020-2022 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+source $::env(SCRIPTS_DIR)/openroad/common/io.tcl
+read_current_odb
+
+tapcell\
+    -distance $::env(FP_TAPCELL_DIST)\
+    -tapcell_master "$::env(WELLTAP_CELL)"\
+    -endcap_master "$::env(ENDCAP_CELL)"\
+    -halo_width_x $::env(FP_MACRO_HORIZONTAL_HALO)\
+    -halo_width_y $::env(FP_MACRO_VERTICAL_HALO)
+
+
+write_views

librelane/scripts/openroad/write_views.tcl

@@ -0,0 +1,27 @@
+# Copyright 2022 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+source $::env(SCRIPTS_DIR)/openroad/common/io.tcl
+if { [info exists ::env(CURRENT_ODB)] } {
+    read_current_odb
+} elseif { [info exists ::env(CURRENT_DEF)] } {
+    read_pnr_libs
+    read_lefs
+    read_def $::env(CURRENT_DEF)
+} else {
+    read_pnr_libs
+    read_lefs
+    read_current_netlist
+}
+
+write_views

librelane/scripts/pyosys/construct_abc_script.py

@@ -0,0 +1,177 @@
+# Copyright 2020-2024 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+import re
+
+
+class ABCScriptCreator:
+    def __init__(self, config):
+        self.config = config
+
+        self.rs_K = "resub -K "
+        self.rs = "resub"
+        self.rsz = "resub -z"
+        self.rf = "drf -l"
+        self.rfz = "drf -l -z"
+        self.rw = "drw -l"
+        self.rwz = "drw -l -z"
+        self.rw_K = "drw -l -K"
+
+        if config["SYNTH_ABC_LEGACY_REFACTOR"]:
+            self.rf = "refactor"
+            self.rfz = "refactor -z"
+
+        if config["SYNTH_ABC_LEGACY_REWRITE"]:
+            self.rw = "rewrite"
+            self.rwz = "rewrite -z"
+            self.rw_K = "rewrite -K"
+
+        self.b = "balance"
+        self.resyn2 = f"{self.b}; {self.rw}; {self.rf}; {self.b}; {self.rw}; {self.rwz}; {self.b}; {self.rfz}; {self.rwz}; {self.b}"
+        self.share = f"strash; multi -m; {self.resyn2}"
+        self.resyn2a = f"{self.b};{self.rw};{self.b};{self.rw};{self.rwz};{self.b};{self.rwz};{self.b}"
+        self.resyn3 = f"{self.b}; resub; resub -K 6; {self.b};resub -z;resub -z -K 6; {self.b};resub -z -K 5; {self.b}"
+        self.resyn2rs = f"{self.b};{self.rs_K} 6;{self.rw};{self.rs_K} 6 -N 2;{self.rf};{self.rs_K} 8;{self.rw};{self.rs_K} 10;{self.rwz};{self.rs_K} 10 -N 2;{self.b} {self.rs_K} 12;{self.rfz};{self.rs_K} 12 -N 2;{self.rwz};{self.b}"
+
+        self.choice = f"fraig_store; {self.resyn2}; fraig_store; {self.resyn2}; fraig_store; fraig_restore"
+        self.choice2 = f"fraig_store; {self.b}; fraig_store; {self.resyn2}; fraig_store; {self.resyn2}; fraig_store; {self.resyn2}; fraig_store; fraig_restore"
+
+        self.area_mfs3 = ""
+        self.delay_mfs3 = ""
+        if config["SYNTH_ABC_USE_MFS3"]:
+            self.area_mfs3 = "mfs3 -aemvz -I 4 -O 2"
+            self.delay_mfs3 = "mfs3 -emvz -I 4 -O 2"
+
+        self.map_old_area = "map -p -a -B 0.2 -A 0.9 -M 0"
+        self.map_old_dly = "map -p -B 0.2 -A 0.9 -M 0"
+        self.retime_area = "retime {D} -M 5"
+        self.retime_dly = "retime {D} -M 6"
+        self.map_new_area = "amap -m -Q 0.1 -F 20 -A 20 -C 5000"
+
+        if config["SYNTH_ABC_AREA_USE_NF"]:
+            self.map_new_area = "&get -n; &nf -R 1000; &put"
+
+        self.max_fanout = config["MAX_FANOUT_CONSTRAINT"]
+        self.max_transition = (
+            config.get("MAX_TRANSITION_CONSTRAINT") or 0
+        ) * 1000  # ns -> ps
+        self.fine_tune = ""
+        if config["SYNTH_ABC_BUFFERING"]:
+            max_tr_arg = ""
+            if self.max_transition != 0:
+                max_tr_arg = f" -S {self.max_transition}"
+            self.fine_tune = (
+                f"buffer -N {self.max_fanout}{max_tr_arg};upsize {{D}};dnsize {{D}}"
+            )
+        elif config["SYNTH_SIZING"]:
+            self.fine_tune = "upsize {D};dnsize {D}"
+
+    def generate_abc_script(self, step_dir, strategy):
+        strategy_clean = re.sub(r"\s+", "_", strategy)
+        abc_script_path = os.path.join(step_dir, f"{strategy_clean}.abc")
+        f = open(abc_script_path, "w")
+
+        if strategy == "AREA 3":
+            # ORFS Area Script
+            print("strash", file=f)
+            print("dch", file=f)
+            print("map -B 0.9", file=f)
+            print("topo", file=f)
+            print("stime -c", file=f)
+            print(f"buffer -c -N {self.max_fanout}", file=f)
+            print("upsize -c", file=f)
+            print("dnsize -c", file=f)
+        elif strategy == "DELAY 4":
+            # ORFS Delay Script
+            def repeated_sequence(f):
+                print("&st", file=f)
+                print("&syn2", file=f)
+                print("&if -g -K 6", file=f)
+                print("&synch2", file=f)
+                print("&nf", file=f)
+
+            print("&get -n", file=f)
+            print("&st", file=f)
+            print("&dch", file=f)
+            print("&nf", file=f)
+
+            for _ in range(5):
+                repeated_sequence(f)
+
+            print("&put", file=f)
+            print(f"buffer -c -N {self.max_fanout}", file=f)
+            print("topo", file=f)
+            print("stime -c", file=f)
+            print("upsize -c", file=f)
+            print("dnsize -c", file=f)
+        else:
+            print("fx", file=f)
+            print("mfs", file=f)
+            print("strash", file=f)
+            print(self.rf, file=f)
+
+            # Resynth/Retime
+            if strategy == "AREA 2":
+                print(self.choice2, file=f)
+            else:
+                print(self.resyn2, file=f)
+            if strategy.startswith("AREA ") or strategy == "DELAY 3":
+                print(self.retime_area, file=f)
+            else:
+                print(self.retime_dly, file=f)
+            print("scleanup", file=f)
+
+            if strategy in ["AREA 4", "DELAY 2"]:
+                print(self.choice, file=f)
+            elif strategy != "DELAY 0":
+                print(self.choice2, file=f)
+            if strategy.startswith("AREA ") or strategy == "DELAY 3":
+                print(self.map_new_area, file=f)
+            else:
+                print(self.map_old_dly, file=f)
+
+            # Area Recovery
+            if strategy in ["AREA 1", "AREA 2"]:
+                print(self.choice2, file=f)
+                print(self.map_new_area, file=f)
+            elif strategy in ["DELAY 1"]:
+                print(self.choice2, file=f)
+                print("map", file=f)
+            elif strategy in ["DELAY 2"]:
+                print(self.choice, file=f)
+                print("map", file=f)
+            elif strategy in ["DELAY 3"]:
+                print(self.choice2, file=f)
+                print(self.map_old_dly, file=f)
+
+            if strategy.startswith("AREA "):
+                print(self.area_mfs3, file=f)
+            else:
+                print(self.delay_mfs3, file=f)
+
+            print("retime {D}", file=f)
+
+            # & space
+            print("&get -n", file=f)
+            print("&st", file=f)
+            print("&dch", file=f)
+            print("&nf", file=f)
+            print("&put", file=f)
+            print(self.fine_tune, file=f)
+
+        # Common Conclusion
+        print("stime -p", file=f)
+        print("print_stats -m", file=f)
+        f.close()
+        return abc_script_path