reconfigure steps and flow as a librelane plugin

(+ i attempted to fold resizing the floorplan into PlaceRAM and failed)

Author: donn

Makefile

@@ -16,7 +16,7 @@ venv/manifest.txt: ./requirements_dev.txt
 	PYTHONPATH= ./venv/bin/python3 -m pip install --upgrade pip
 	PYTHONPATH= ./venv/bin/python3 -m pip install --upgrade wheel
 	PYTHONPATH= ./venv/bin/python3 -m pip install --upgrade\
-		-r ./requirements_dev.txt
+		-r ./requirements_dev.txt -r ./requirements.txt
 	PYTHONPATH= ./venv/bin/python3 -m pip freeze > $@
 	touch venv/manifest.txt
 
@@ -30,4 +30,4 @@ clean:
 	rm -rf build/
 	rm -rf logs/
 	rm -rf dist/
-	rm -rf *.egg-info
+	rm -rf *.egg-info

Readme.md

@@ -1,11 +1,8 @@
 <h1 align="center"> DFFRAM Compiler</h1>
-<p align="center">
-  <a href="https://colab.research.google.com/github/Cloud-V/DFFRAM/blob/main/dffram.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open in Google Colab"/></a>
-</p>
 <p align="center">
     <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0"/></a>
     <img src="https://github.com/AUCOHL/DFFRAM/actions/workflows/main.yml/badge.svg?branch=main" alt="CI Status" />
-    <a href="https://invite.skywater.tools"><img src="https://img.shields.io/badge/Community-Skywater%20PDK%20Slack-ff69b4?logo=slack" alt="Invite to the Skywater PDK Slack"/></a>
+    <a href="https://fossi-chat.org"><img src="https://img.shields.io/badge/Community-FOSSi%20Chat-1bb378?logo=element" alt="Invite to FOSSi Chat"/></a>
     <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black"/></a>
 </p>
 
@@ -21,11 +18,12 @@ but it is a bit out-of-date at this point.
 
 ## Platform Support Status
 
-| Configured Platform | Working | Silicon-proven\* |
+| Configured Platform | Signoff-clean | Silicon-proven\* |
 | - | - | - |
-| `sky130A` | Yes | Yes |
-| `sky130B` | Yes | No |
-| `gf180mcuD` | No\* (Hold violations in the Netlist) | No |
+| `sky130A` (Latches) | Yes | Yes |
+| `sky130A` (DFF) | Yes | No |
+| `sky130B` (Latches/DFF) | Yes | No |
+| `gf180mcuD` (Latches/DFF) | No\* (Hold violations in the Netlist) | No |
 
 > \* Silicon proven does not imply that you should use it without whole-system,
 > timing-annotated simulation to make sure that it works for your circuit.
@@ -76,7 +74,11 @@ blocks are as follows:
 
 Currently, the can compiler generate the layout of the following configurations:
 
-> 1RW1R variants are temporarily disabled due to a bug.
+> We currently do not recommend the use of 1RW1R. See this discussion for more
+> info:
+>
+> https://github.com/AUCOHL/DFFRAM/issues/198
+
 
 * RAM
   * 32 words with byte write enable (1RW and 1RW1R).
@@ -116,8 +118,8 @@ using different means.
     <th rowspan="2">Size<sup>1</sup></th> 
     <th colspan="2">OpenRAM<sup>2</sup></th> 
     <th colspan="2">DFFRAM Compiler</th> 
-    <th colspan="2">DFFRAM/OpenLane</th> 
-    <th colspan="2">RTL/OpenLane</th>
+    <th colspan="2">DFFRAM Netlist + OpenROAD Placer</th> 
+    <th colspan="2">Memory RTL with OpenLane</th>
   </tr>
   <tr style="border-top:4px solid darkblue;">
     <td> Dim WxH (μm) </td> <td> Bit Density (bits/mm<sup>2</sup>) </td>

dffram.py

@@ -47,6 +47,7 @@
     type=Decimal,
     help="Minimum height in µm",
 )
+@cloup.option("--latch/--dff", default=True, help="Whether to use latches or dffs")
 @cloup_flow_opts(accept_config_files=False)
 @cloup.argument("size", default="32x32", nargs=1)
 def main(
@@ -67,6 +68,7 @@ def main(
     min_height,
     flow_name,
     pdk_root,
+    latch,
     **kwargs,
 ):
     if variant == "DEFAULT":
@@ -123,7 +125,9 @@ def main(
         }
     )
 
-    build_dir = os.path.join("build", design)
+    build_dir = os.path.join(
+        "build", f"{pdk}-{scl}-{'latch' if latch else 'dff'}", design
+    )
     mkdirp(build_dir)
 
     tech_info_path = os.path.join(".", "platforms", pdk, scl, "tech.yml")
@@ -163,7 +167,7 @@ def main(
             ],
             "SYNTH_ELABORATE_ONLY": True,
             "SYNTH_ELABORATE_FLATTEN": True,
-            "SYNTH_PARAMETERS": [f"WSIZE={logical_width}"],
+            "SYNTH_PARAMETERS": [f"WSIZE={logical_width}", f"USE_LATCH={int(latch)}"],
             "GRT_REPAIR_ANTENNAS": False,
             "MINIMUM_HEIGHT": min_height,
             "VERTICAL_HALO": vertical_halo,

placeram/__init__.py …ffram/scripts/odbpy/placeram/__init__.pyplaceram/__init__.py renamed to librelane_plugin_dffram/scripts/odbpy/placeram/__init__.py placeram/__init__.py renamed to librelane_plugin_dffram/scripts/odbpy/placeram/__init__.py

@@ -107,8 +107,8 @@ def create_fill(name, sites=1):
             fill_cell = self.fill_cells_by_sites[sites]
             return odb.dbInst_create(self.block, fill_cell, name)
 
-        self.micron_in_units = self.block.getDefUnits()
-        tap_distance = self.micron_in_units * tap_distance
+        self.micron_in_dbus: int = self.block.getDefUnits()
+        tap_distance = self.micron_in_dbus * tap_distance
 
         self.rows = Row.from_odb(
             self.block.getRows(),
@@ -132,22 +132,49 @@ def represent(self, file):
 
     def place(self):
         eprint("Starting placement…")
-        print(f"Placing across {len(self.rows)} rows...")
+        print(f"Placing across {len(self.rows)} rows…")
         last_row = self.hierarchy.place(self.rows)
-        print(f"Placement concluded with {last_row} rows...")
+
+        print(f"Placement concluded with {last_row} rows…")
         Row.fill_rows(self.rows, 0, last_row)
 
         # We can't rely on the fact that a placeable will probably fill
         # before returning and pick the width of the nth row or whatever.
-        width_units = 0
+        width_dbus: int = 0
         for row in self.rows:
-            width_units = max(row.width, width_units)
+            width_dbus = max(row.width, width_dbus)
 
-        self.core_width = width_units / self.micron_in_units
+        height_dbus: int = self.rows[last_row - 1].ymax - self.rows[0].y
 
-        height_units = self.rows[last_row - 1].ymax - self.rows[0].y
+        self.core_width = width_dbus / self.micron_in_dbus
+        self.core_height = height_dbus / self.micron_in_dbus
 
-        self.core_height = height_units / self.micron_in_units
+        utl.metric_float("dffram__suggested__core_width", self.core_width)
+        utl.metric_float("dffram__suggested__core_height", self.core_height)
+
+        eprint(
+            "Placement concluded with core area of %fµm x %fµm."
+            % (self.core_width, self.core_height)
+        )
+
+        # resizing doesn't work - rows widths are immutable from python
+        # # resize
+        # width_margin: int = self.rows[0].x
+        # height_margin: int = self.rows[0].y
+        # die_height_dbus = height_dbus + height_margin * 2
+        # die_width_dbus = width_dbus + width_margin * 2
+
+        # die_rect = odb.Rect(0, 0, die_width_dbus, die_height_dbus)
+        # self.block.setDieArea(die_rect)
+        # for row in self.block.getRows():
+        #     _, row_y = row.getOrigin()
+        #     if row_y >= width_dbus + width_margin:
+        #         odb.dbRow.destroy(row)
+
+        # calculate density
+        die_width = self.block.getDieArea().dx() / self.micron_in_dbus
+        die_height = self.block.getDieArea().dy() / self.micron_in_dbus
+        die_area = die_width * die_height
 
         logical_area: float = 0
         for cell in self.block.getInsts():
@@ -160,24 +187,13 @@ def place(self):
                     break
             if type not in ["nonfiller"]:
                 continue
-            width = master.getWidth() / self.micron_in_units
-            height = master.getHeight() / self.micron_in_units
+            width = master.getWidth() / self.micron_in_dbus
+            height = master.getHeight() / self.micron_in_dbus
             logical_area += width * height
 
-        eprint(
-            "Placement concluded with core area of %fµm x %fµm."
-            % (self.core_width, self.core_height)
-        )
-
-        utl.metric_float("dffram__suggested__core_width", self.core_width)
-        utl.metric_float("dffram__suggested__core_height", self.core_height)
-
-        die_width = self.block.getDieArea().dx() / self.micron_in_units
-        die_height = self.block.getDieArea().dy() / self.micron_in_units
-        die_area = die_width * die_height
-
         self.density = logical_area / die_area
         utl.metric_float("dffram__logic__density", self.density)
+
         eprint("Density: %.2f%%" % (self.density * 100))
         eprint("Done.")
 

placeram/__main__.py …ffram/scripts/odbpy/placeram/__main__.pyplaceram/__main__.py renamed to librelane_plugin_dffram/scripts/odbpy/placeram/__main__.py placeram/__main__.py renamed to librelane_plugin_dffram/scripts/odbpy/placeram/__main__.py

@@ -18,15 +18,22 @@ def dbInst__repr__(self):
 
 Instance.__repr__ = dbInst__repr__
 
-RegExp = str
+
+def _load_regexes():
+    compiled = {}
+    with open(os.path.join(os.path.dirname(__file__), "rx.yml"), encoding="utf8") as f:
+        _loading: Dict[str, Dict[str, str]] = yaml.safe_load(f)
+        for cls, patterns in _loading.items():
+            compiled.setdefault(cls, {})
+            for variable, rx in patterns.items():
+                compiled[cls][variable] = re.compile(rx)
+    return compiled
 
 
 class Placeable(object):
-    RegexDictionary: Dict[str, Dict[str, RegExp]] = yaml.safe_load(
-        open(os.path.join(os.path.dirname(__file__), "rx.yml"))
-    )
+    RegexDictionary: Dict[str, Dict[str, re.Pattern]] = _load_regexes()
 
-    def regex_dict(self) -> Dict[str, RegExp]:
+    def regex_dict(self) -> Dict[str, re.Pattern]:
         return Placeable.RegexDictionary[self.__class__.__name__]
 
     class Sieve(object):
@@ -44,7 +51,6 @@ def __init__(
 
     def sieve(self, instances: List[Instance], sieves: List[Sieve]):
         regexes = self.regex_dict()
-        compiled_regexes = {k: re.compile(v) for k, v in regexes.items()}
         for sieve in sieves:
             depth = len(sieve.groups)
             if depth == 0:
@@ -56,7 +62,7 @@ def sieve(self, instances: List[Instance], sieves: List[Sieve]):
             n = instance.getName()
             found = False
             for sieve in sieves:
-                rx = compiled_regexes[sieve.variable]
+                rx = regexes[sieve.variable]
                 result = rx.search(n)
                 if result is None:
                     continue

placeram/cli.py …gin_dffram/scripts/odbpy/placeram/cli.pyplaceram/cli.py renamed to librelane_plugin_dffram/scripts/odbpy/placeram/cli.py placeram/cli.py renamed to librelane_plugin_dffram/scripts/odbpy/placeram/cli.py

@@ -7,11 +7,9 @@
 from .placeable import Placeable
 from .common_data import Decoder5x32
 
-from odb import dbInst
+from odb import dbInst as Instance
 from typing import Dict, List
 
-Instance = dbInst
-
 P = Placeable
 S = Placeable.Sieve