librelane 2.4.0.dev0__py3-none-any.whl

librelane/scripts/odbpy/remove_buffers.py

@@ -0,0 +1,173 @@
+# Copyright 2021-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.
+import odb
+
+import re
+from typing import List
+
+from reader import click_odb, click
+
+
+def get_pin_name(pin: odb.dbITerm):
+    cell = pin.getInst()
+    cell_name = cell.getName()
+    master_pin = pin.getMTerm()
+    master_pin_name = master_pin.getConstName()
+    return f"{cell_name}/{master_pin_name}"
+
+
+def get_sinks_terms(net: odb.dbNet) -> List[odb.dbITerm]:
+    sinks = []
+    for it in net.getITerms():
+        cell = it.getInst()
+        cell_pin = it.getMTerm()
+
+        master_instance = cell.getMaster()
+        master_name = master_instance.getConstName()
+
+        if cell_pin.getIoType() == "INPUT":
+            print(
+                f"  * Net {net.getConstName()} sinks into {get_pin_name(it)} ({master_name})..."
+            )
+            sinks.append(it)
+
+    return sinks
+
+
+def get_drivers(net: odb.dbNet) -> List[odb.dbInst]:
+    drivers = []
+    for it in net.getITerms():
+        cell = it.getInst()
+        cell_pin = it.getMTerm()
+
+        master_instance = cell.getMaster()
+        master_name = master_instance.getConstName()
+
+        if cell_pin.getIoType() == "OUTPUT":
+            print(
+                f"  * Net {net.getConstName()} is driven by {get_pin_name(it)} ({master_name})..."
+            )
+            drivers.append(cell)
+
+    return drivers
+
+
+def get_io(cell: odb.dbInst):
+    inputs = []
+    outputs = []
+    for iterm in cell.getITerms():
+        if iterm.isSpecial():  # Skip special nets
+            continue
+
+        if iterm.isInputSignal():
+            input_pin_net = iterm.getNet()
+            inputs.append((iterm, input_pin_net))
+
+        if iterm.isOutputSignal():
+            output_pin_net = iterm.getNet()
+            outputs.append((iterm, output_pin_net))
+
+    return inputs, outputs
+
+
+@click.command()
+@click.option(
+    "-m",
+    "--match",
+    "rx_str",
+    required=True,
+    help="A regular expression matching all nets to remove.",
+)
+@click_odb
+def remove_buffers(reader, rx_str):
+    if rx_str != "^$":
+        # Save some compute time :)
+
+        rx = re.compile(rx_str)
+
+        design_nets = reader.block.getNets()
+        dont_buffer_nets = [
+            net for net in design_nets if rx.match(net.getConstName()) is not None
+        ]
+
+        for net in dont_buffer_nets:
+            net_name = net.getConstName()
+            print(f"* Attempting to unbuffer {net_name}...")
+            # get the cells driving the dont buffer net
+            drivers = get_drivers(net)
+
+            if len(drivers) > 1:
+                print(f"Net {net_name} is driven by multiple cells.")
+                exit(1)
+            elif len(drivers) == 0:
+                print(f"Net {net_name} is not driven by any cell..")
+                exit(1)
+
+            buffer = drivers[0]
+            buffer_name = drivers[0].getName()
+            master = buffer.getMaster()
+            master_name = master.getConstName()
+
+            if "buf" not in master_name:
+                print(
+                    f"*  {net_name} isn't driven by a buffer cell. It is driven by {buffer_name} ({master_name}). Skipping..."
+                )
+                continue
+
+            # get the net connected to the input pin of this buffer
+            inputs, outputs = get_io(buffer)
+
+            if len(inputs) != 1:
+                print(
+                    f"*  {master_name} has more than one output port. Doesn't appear to actually be a buffer. Skipping..."
+                )
+                continue
+            if len(outputs) != 1:
+                print(
+                    f"{master_name} has more than one output port. Doesn't appear to actually be a buffer. Skipping..."
+                )
+                continue
+
+            _, input_net = inputs[0]
+            _, output_net = outputs[0]
+
+            print("  * Reconnecting IO...")
+            # We connect the driver's output to the output_net: there may not be a
+            # sink with ITerms in case of things like output ports for example.
+            buffer_input_driver = get_drivers(input_net)[0]
+            _, bid_outputs = get_io(buffer_input_driver)
+            (bid_iterm, _) = bid_outputs[0]
+            bid_iterm.connect(output_net)
+            print(
+                f"  * Connected buffer output({output_net.getConstName()}) to {get_pin_name(bid_iterm)}."
+            )
+
+            print(f"  * Removing buffer {buffer_name} ({master_name})...")
+            odb.dbInst.destroy(buffer)
+
+            input_net_sinks = get_sinks_terms(input_net)
+            for iterm in input_net_sinks:
+                iterm.connect(output_net)
+                print(
+                    f"  * Connected buffer output({output_net.getConstName()}) to {get_pin_name(iterm)}."
+                )
+
+            print(f"  * Removing net {input_net.getName()}...")
+            odb.dbNet.destroy(input_net)
+
+        print("  * Done.")
+
+
+if __name__ == "__main__":
+    remove_buffers()

librelane/scripts/odbpy/snap_to_grid.py

@@ -0,0 +1,57 @@
+# 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.
+import math
+from decimal import Decimal
+
+from reader import OdbReader, click
+
+
+def snap_value(value: Decimal, manufacturing_grid: Decimal) -> Decimal:
+    adjusted = math.floor(value / manufacturing_grid) * manufacturing_grid
+    if adjusted == Decimal(0):
+        adjusted = math.ceil(value / manufacturing_grid) * manufacturing_grid
+    return adjusted
+
+
+@click.command()
+@click.option(
+    "-o",
+    "--output",
+    required=True,
+    help="A text file to which final values are output.",
+)
+@click.option(
+    "-l",
+    "--input-lef",
+    required=True,
+    help="Input LEF file (for the manufacturing grid)",
+)
+@click.argument("input_values", type=Decimal, nargs=-1)
+def cli(output, input_lef, input_values):
+    reader = OdbReader(input_lef, None)
+    manufacturing_grid = Decimal(reader.db.getTech().getManufacturingGrid()) / Decimal(
+        reader.db.getTech().getDbUnitsPerMicron()
+    )
+    with open(output, "w") as f:
+        print(
+            " ".join(
+                [str(snap_value(value, manufacturing_grid)) for value in input_values]
+            ),
+            end="",
+            file=f,
+        )
+
+
+if __name__ == "__main__":
+    cli()

librelane/scripts/odbpy/wire_lengths.py

@@ -0,0 +1,93 @@
+# 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.
+from decimal import Decimal
+
+import utl
+
+from reader import click, click_odb, OdbReader
+
+
+def to_si(microns: Decimal) -> str:
+    units = ["µm", "mm", "m"]
+    unit = 0
+    value = microns
+    while value >= 1000 and unit < len(units):
+        value /= 1000
+        unit += 1
+    return f"{value}{units[unit]}"
+
+
+@click.command()
+@click.option(
+    "-h",
+    "--human-readable",
+    default=False,
+    is_flag=True,
+    help="Print with SI units instead of database units.",
+)
+@click.option(
+    "-t",
+    "--threshold",
+    default=Decimal("Infinity"),
+    type=Decimal,
+    help="Threshold above which to print the wire (Default: ∞)",
+)
+@click.option(
+    "-R",
+    "--report-out",
+    default=None,
+    help="Output to print CSV file to. (Default: input + .wire_lengths.csv)",
+)
+@click_odb
+def main(
+    report_out,
+    threshold,
+    human_readable,
+    input_db,
+    reader: OdbReader,
+):
+    db = reader.db
+    if report_out is None:
+        report_out = f"{input_db}.wire_length.csv"
+
+    block = db.getChip().getBlock()
+    dbunits = block.getDefUnits()
+    nets = list(filter(lambda net: net.getWire() is not None, block.getNets()))
+    nets.sort(key=lambda net: net.getWire().getLength(), reverse=True)
+
+    max_wire_length = 0
+    above_threshold = []
+    with open(report_out, "w") as f:
+        print("net,length_um", file=f)
+        for net in nets:
+            length = net.getWire().getLength()
+            length_microns = Decimal(length) / Decimal(dbunits)
+            max_wire_length = max(length_microns, max_wire_length)
+            if length_microns >= threshold:
+                above_threshold.append((net, length_microns))
+            length_printable: str = str(length_microns)
+            if human_readable:
+                length_printable = str(to_si(length_microns))
+            print(f"{net.getName()},{length_printable}", file=f)
+
+    for net, length_microns in above_threshold:
+        print(
+            f"Net {net.getName()} is above the length threshold ({length_microns}/{threshold} µm)."
+        )
+
+    utl.metric_float("route__wirelength__max", float(max_wire_length))
+
+
+if __name__ == "__main__":
+    main()

librelane/scripts/openroad/antenna_check.tcl

@@ -0,0 +1,20 @@
+# 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
+
+# start checking antennas and generate a detailed report
+puts "%OL_CREATE_REPORT $::env(_ANTENNA_REPORT)"
+check_antennas -verbose
+puts "%OL_END_REPORT"

librelane/scripts/openroad/antenna_repair.tcl

@@ -0,0 +1,31 @@
+# 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
+source $::env(SCRIPTS_DIR)/openroad/common/dpl_cell_pad.tcl
+
+set_propagated_clock [all_clocks]
+
+source $::env(SCRIPTS_DIR)/openroad/common/grt.tcl
+
+set diode_split [split $::env(DIODE_CELL) "/"]
+repair_antennas "[lindex $diode_split 0]" -iterations $::env(GRT_ANTENNA_ITERS) -ratio_margin $::env(GRT_ANTENNA_MARGIN)
+
+source $::env(SCRIPTS_DIR)/openroad/common/dpl.tcl
+source $::env(SCRIPTS_DIR)/openroad/common/grt.tcl
+
+source $::env(SCRIPTS_DIR)/openroad/common/set_rc.tcl
+estimate_parasitics -global_routing
+
+write_views

librelane/scripts/openroad/basic_mp.tcl

@@ -0,0 +1,24 @@
+# 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
+
+macro_placement\
+    -channel $::env(PL_MACRO_CHANNEL)\
+    -halo $::env(PL_MACRO_HALO)
+
+write_views
+
+report_design_area_metrics
+

librelane/scripts/openroad/buffer_list.tcl

@@ -0,0 +1,10 @@
+foreach lib $::env(_PNR_LIBS) {
+    read_liberty $lib
+}
+
+set cells [get_lib_cells *]
+foreach cell $cells {
+    if { [$cell is_buffer] } {
+        puts [get_property $cell name]
+    }
+}

librelane/scripts/openroad/common/dpl.tcl

@@ -0,0 +1,24 @@
+# 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/dpl_cell_pad.tcl
+
+remove_fillers
+
+detailed_placement\
+    -max_displacement [subst { $::env(PL_MAX_DISPLACEMENT_X) $::env(PL_MAX_DISPLACEMENT_Y) }]
+
+if { [info exists ::env(PL_OPTIMIZE_MIRRORING)] && $::env(PL_OPTIMIZE_MIRRORING) } {
+    optimize_mirroring
+}
+check_placement -verbose

librelane/scripts/openroad/common/dpl_cell_pad.tcl

@@ -0,0 +1,26 @@
+# 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.
+set cell_pad_value $::env(DPL_CELL_PADDING)
+
+set cell_pad_side [expr $cell_pad_value / 2]
+
+set_placement_padding -global -right $cell_pad_side -left $cell_pad_side
+
+foreach wildcard $::env(CELL_PAD_EXCLUDE) {
+    set_placement_padding -masters $wildcard -right 0 -left 0
+}
+if { [info exists ::env(DIODE_PADDING)] && $::env(DIODE_PADDING) } {
+    set diode_split [split $::env(DIODE_CELL) "/"]
+    set_placement_padding -masters [lindex $diode_split 0] -left $::env(DIODE_PADDING)
+}

librelane/scripts/openroad/common/grt.tcl

@@ -0,0 +1,32 @@
+# Copyright 2022-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.
+if { ![info exists ::grt_preamble] } {
+    set ::grt_preamble 1
+
+    source $::env(SCRIPTS_DIR)/openroad/common/set_routing_layers.tcl
+    source $::env(SCRIPTS_DIR)/openroad/common/set_layer_adjustments.tcl
+
+    set_macro_extension $::env(GRT_MACRO_EXTENSION)
+}
+
+set arg_list [list]
+lappend arg_list -congestion_iterations $::env(GRT_OVERFLOW_ITERS)
+lappend arg_list -verbose
+if { $::env(GRT_ALLOW_CONGESTION) == 1 } {
+    lappend arg_list -allow_congestion
+}
+puts $arg_list
+global_route {*}$arg_list
+
+write_guide $::env(STEP_DIR)/after_grt.guide