Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: openroad hierarchical macro placer #537

Draft
wants to merge 15 commits into
base: dev
Choose a base branch
from
Draft

feat: openroad hierarchical macro placer #537

wants to merge 15 commits into from

Conversation

donn
Copy link
Member

@donn donn commented Aug 26, 2024

  • OpenROAD.*

    • Added log_cmd from OpenROAD-flow-scripts -- neat idea for consistency
    • Internal: Steps now sensitive to _OPENROAD_GUI environment variable -- coupled with --only, it runs a step in OpenROAD then doesn't quit so you may inspect the result.
      • This is not part of the OpenLane stable API and may be broken at any moment.
  • OpenROAD.CutRows

    • Rows that generate less than a specified number of sites are now removed to help with PDN generation (default: 25)
  • Created OpenROAD.HierarchicalMacroPlacer

    • Based on OpenROAD mpl2-- a macro placer that uses hierarchy information from the RTL to generate a macro placement automatically
    • Used for macros for which a manual placement has not been provided
  • Created OpenROAD.UnplaceAll

    • Removes placement status of all instances.
  • Yosys.Synthesis

    • SYNTH_NO_FLAT replaced with SYNTH_HIERARCHY_MODE with three options: flatten (previously false), deferred_flatten (previously true) and keep (new value). When set to keep, the netlist generated is hierarchical.

Flows

  • Classic
    • Added OpenROAD.HierarchicalMacroPlacer after Odb.ManualMacroPlacement
    • Moved pin placement flow before macro placement as mpl2 requires pin placement information
    • Added OpenROAD.UnplaceAll after pin placement so rows can be cut for macros without worries about already-placed instances

Tool Updates

  • openroad -> 49a497a
  • Enhanced overlay for or-tools to fix a bug where trying to build OpenROAD from a git repo (using nix develop .#openroad) would Cmake always fail after the first cmake ..

Depends on #534
Resolves #506

donn added 11 commits August 21, 2024 19:01
* `Yosys.JsonHeader`, `Yosys.*Synthesis`
  * **Internal**:
    * Steps are no longer `TclStep`s: rewritten in Python and now use `libyosys`. While there are no functional changes, this enhances the codebase's consistency and helps avoid tokenization-related security issues.

* `Yosys.*Synthesis`
  * ABC scripts used now created dynamically and dumped as a `.abc` file into the step directory.

* Updated `nix-eda`
  * `yosys` -> `0.44` (+ `-y` patch)
  * `klayout` -> `0.29.4`
  * OpenROAD now used with new `withPythonPackages` features to use Python packages specifically for the OpenROAD environment
* `OpenROAD.*`
  * Added `log_cmd` from OpenROAD-flow-scripts -- neat idea for consistency
  * **Internal**: Steps now sensitive to `_OPENROAD_GUI` environment variable -- coupled with `--only`, it runs a step in OpenROAD then doesn't quit so you may inspect the result.
    * This is not part of the OpenLane stable API and may be broken at any moment.

* `OpenROAD.CutRows`
  * Rows that generate less than a specified number of sites are now removed to help with PDN generation (default: 25)

* Created `OpenROAD.HierarchicalMacroPlacer`
  * Based on OpenROAD `mpl2`-- a macro placer that uses hierarchy information from the RTL to generate a macro placement automatically
  * Used for macros for which a manual placement has not been provided

* Created `OpenROAD.UnplaceAll`
  * Removes placement status of all instances.

* `Yosys.Synthesis`
  * `SYNTH_NO_FLAT` replaced with `SYNTH_HIERARCHY_MODE` with three options: `flatten` (previously `false`), `deferred_flatten` (previously `true`) and `keep` (new value). When set to `keep`, the netlist generated is hierarchical.

## Flows
* Classic
  * Added `OpenROAD.HierarchicalMacroPlacer` after `Odb.ManualMacroPlacement`
  * Moved pin placement flow before macro placement as `mpl2` requires pin placement information
  * Added `OpenROAD.UnplaceAll` after pin placement so rows can be cut for macros without worries about already-placed instances

## Tool Updates
* `openroad` -> `49a497a`
* Enhanced overlay for `or-tools` to fix a bug where trying to build OpenROAD from a git repo (using nix develop .#openroad) would Cmake always fail after the first `cmake ..`
@donn donn changed the title Yosys Step Rewrite, Update nix-eda Add support for Hierarchical RTL Macro Placer Aug 26, 2024
@donn
Copy link
Member Author

donn commented Aug 26, 2024

EF_UART don't fail every time I slightly alter the flow challenge (impossible)

@openlane-bot
Copy link
Collaborator

openlane-bot commented Aug 26, 2024

Metric comparisons are in beta. Please report bugs under the issues tab.

To create this report yourself, grab the metrics artifact from the CI run, extract them, and invoke python3 -m openlane.common.metrics compare-remote current --branch dev --table-verbosity ALL --table-out ./tables_all.md.

  • Changes to critical metrics were detected in the following designs:
    • gf180mcuD/gf180mcu_fd_sc_mcu7t5v0/blink
    • gf180mcuD/gf180mcu_fd_sc_mcu7t5v0/usb_cdc_core
    • gf180mcuD/gf180mcu_fd_sc_mcu7t5v0/wbqspiflash
    • gf180mcuD/gf180mcu_fd_sc_mcu7t5v0/zipdiv
    • sky130A/sky130_fd_sc_hd/EF_PSRAM_CTRL_V2
    • sky130A/sky130_fd_sc_hd/EF_TCC32
    • sky130A/sky130_fd_sc_hd/MS_DMAC_AHBL
    • sky130A/sky130_fd_sc_hd/MS_SPI_XIP_CACHE

Full tables ► https://gist.github.com/openlane-bot/a61cacd8dce8d43bfd498c5632c0f98d

@donn donn changed the title Add support for Hierarchical RTL Macro Placer feat: openroad hierarchical macro placer Oct 9, 2024
commit e7a0e71
Author: Kareem Farid <[email protected]>
Date:   Sun Nov 3 13:22:53 2024 +0200

    lint

    Signed-off-by: Kareem Farid <[email protected]>

commit 9e25b72
Author: Kareem Farid <[email protected]>
Date:   Sun Nov 3 13:11:51 2024 +0200

    update changelog, Verilator.Lint, Yosys.JsonHeader

    Signed-off-by: Kareem Farid <[email protected]>

commit 36bca9b
Author: Kareem Farid <[email protected]>
Date:   Sun Nov 3 12:52:59 2024 +0200

    bugfix: allow unsetting variables in configuration files

    Signed-off-by: Kareem Farid <[email protected]>

commit b0246e6
Author: Kareem Farid <[email protected]>
Date:   Tue Oct 29 15:29:20 2024 +0300

    hotfix: incorrect error message when substiuting with a nonexistent step

commit 19109e1
Author: Mohamed Gaber <[email protected]>
Date:   Sat Oct 26 20:12:12 2024 +0300

    bugfix: odb steps dropping PYTHONPATH (#592)

    * `Odb.*`
      * Fixed OpenROAD dropping user-set `PYTHONPATH` values.

    ## Tool Updates

    * Use `NIX_PYTHONPATH` instead of `PYTHONPATH` in Docker and devshells
      to avoid collisions with user-set `PYTHONPATH` variables.

commit 627a5ab
Author: Mohamed Gaber <[email protected]>
Date:   Thu Oct 24 11:03:55 2024 +0300

    nix: make flake.createOpenLane shell more ergonomic

    ## Tool Updates
    * `flake.createOpenLaneShell` now gets OpenLane from `python3.pkgs`.
    * Fixed issue with `flake.createOpenLaneShell` where plugins would not get
      included due to an operator precedence issue.

commit 8451508
Author: Mohamed Gaber <[email protected]>
Date:   Thu Oct 24 10:57:58 2024 +0300

    hotfix: regression in nix/create-shell.nix

commit 1bfa43d
Author: Mohamed Gaber <[email protected]>
Date:   Mon Oct 21 21:05:05 2024 +0300

    Temporarily revert Colab's OpenLane version until it's fixed

Signed-off-by: Kareem Farid <[email protected]>
@qwertxzy
Copy link

Any reason this hasn't been merged other than the effort it takes to resolve the merge conflicts?

@donn
Copy link
Member Author

donn commented Dec 2, 2024

Hi Leo, sorry just saw this

I had to stop working on this because I was needed on an internal tapeout project. It's back on the radar now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants