siliconcompiler 0.30.0__py3-none-any.whl → 0.31.1__py3-none-any.whl

siliconcompiler/tools/yosys/syn_asic.py

@@ -217,6 +217,33 @@ def setup_asic(chip):
     chip.set('tool', tool, 'task', task, 'file', 'synth_extra_map',
              'Files used in synthesis to perform additional techmapping', field='help')
 
+    chip.set('tool', tool, 'task', task, 'var', 'lock_design', False,
+             step=step, index=index,
+             clobber=False)
+    chip.set('tool', tool, 'task', task, 'var', 'lock_design',
+             'true/false, if true will attempt to lock the design with moosic',
+             field='help')
+    chip.add('tool', tool, 'task', task, 'require',
+             ",".join(['tool', tool, 'task', task, 'var', 'lock_design']),
+             step=step, index=index)
+    chip.set('tool', tool, 'task', task, 'var', 'lock_design_key',
+             'lock locking key',
+             field='help')
+    chip.set('tool', tool, 'task', task, 'var', 'lock_design_port', 'moosic_key',
+             step=step, index=index,
+             clobber=False)
+    chip.set('tool', tool, 'task', task, 'var', 'lock_design_port',
+             'lock locking port name',
+             field='help')
+    if chip.get('tool', tool, 'task', task, 'var', 'lock_design', step=step, index=index)[0] == \
+            'true':
+        chip.add('tool', tool, 'task', task, 'require',
+                 ",".join(['tool', tool, 'task', task, 'var', 'lock_design_key']),
+                 step=step, index=index)
+        chip.add('tool', tool, 'task', task, 'require',
+                 ",".join(['tool', tool, 'task', task, 'var', 'lock_design_port']),
+                 step=step, index=index)
+
 
 ################################
 # mark cells dont use and format liberty files for yosys and abc

siliconcompiler/tools/yosys/syn_asic.tcl

@@ -217,6 +217,33 @@ if { !$flatten_design && [lindex [sc_cfg_tool_task_get var auto_flatten] 0] == "
 # Finish synthesis
 yosys synth {*}$synth_args -top $sc_design -run fine:check
 
+# Logic locking
+if { [lindex [sc_cfg_tool_task_get var lock_design] 0] == "true" } {
+    if { [sc_load_plugin moosic] } {
+        # moosic cannot handle hierarchy
+        foreach module [get_modules "*"] {
+            yosys select -module $module
+            yosys setattr -mod -unset keep_hierarchy
+            yosys select -clear
+        }
+        yosys flatten
+        yosys opt -fast
+
+        set ll_port [lindex [sc_cfg_tool_task_get var lock_design_port] 0]
+        set ll_key [lindex [sc_cfg_tool_task_get var lock_design_key] 0]
+        set ll_bits [expr { 4 * [string length $ll_key] }]
+        yosys select -module $sc_design
+        yosys logic_locking \
+            -nb-locked $ll_bits \
+            -key $ll_key \
+            -port-name $ll_port
+        yosys tee -o reports/logic_locking.rpt {ll_show}
+        yosys select -clear
+    } else {
+        puts "ERROR: unable to load moosic"
+    }
+}
+
 # https://github.com/hdl/bazel_rules_hdl/blob/4cca75f32a3869a57c0635bc7426a696a15ec143/synthesis/synth.tcl#L54C1-L58C26
 # Remove $print cells.  These cells represent Verilog $display() tasks.
 # Some place and route tools cannot handle these in the output Verilog,

siliconcompiler/toolscripts/_tools.json

@@ -1,7 +1,7 @@
 {
   "openroad": {
     "git-url": "https://github.com/The-OpenROAD-Project/OpenROAD.git",
-    "git-commit": "3258b30e2c47d695ff2bb6c14a23c6779ed130bb",
+    "git-commit": "1d7f91584c040b73089e415ec12fd806da1c1161",
     "docker-cmds": [
       "# Remove OR-Tools files",
       "RUN rm -f $SC_PREFIX/Makefile $SC_PREFIX/README.md",
@@ -45,7 +45,7 @@
   },
   "sv2v": {
     "git-url": "https://github.com/zachjs/sv2v.git",
-    "git-commit": "4ec99fcffd2c533c4a2c74ad6f56278f2672f05d",
+    "git-commit": "5d5723f65dd4501d17004736d7d048bea7ef2339",
     "auto-update": true
   },
   "verilator": {
@@ -66,7 +66,7 @@
   },
   "vpr": {
     "git-url": "https://github.com/verilog-to-routing/vtr-verilog-to-routing.git",
-    "git-commit": "de31f094aa4f894a5e6e0dc32c66365f4b341190",
+    "git-commit": "v9.0.0",
     "auto-update": false
   },
   "icepack": {
@@ -136,5 +136,17 @@
     "git-commit": "v3.3.116",
     "git-url": "https://github.com/gtkwave/gtkwave.git",
     "auto-update": false
+  },
+  "yosys-slang": {
+    "git-url": "https://github.com/povik/yosys-slang.git",
+    "git-commit": "8f2239b2b12dac43f8f47f56deef1095d5262fa2",
+    "docker-depends": "yosys",
+    "auto-update": true
+  },
+  "yosys-moosic": {
+    "git-url": "https://github.com/gadfort/moosic-yosys-plugin.git",
+    "git-commit": "5dd1d8a60d0cc7228be856350bb90faad24dae9e",
+    "docker-depends": "yosys",
+    "auto-update": true
   }
 }

siliconcompiler/toolscripts/rhel8/install-yosys-moosic.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-url) yosys-moosic
+cd yosys-moosic
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-commit)
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/rhel8/install-yosys-slang.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+python3 -m venv .yosys-slang --clear
+. .yosys-slang/bin/activate
+python3 -m pip install cmake
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-url) yosys-slang
+cd yosys-slang
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-commit)
+git submodule update --init --recursive
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/rhel9/install-yosys-moosic.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-url) yosys-moosic
+cd yosys-moosic
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-commit)
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/rhel9/install-yosys-slang.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+python3 -m venv .yosys-slang --clear
+. .yosys-slang/bin/activate
+python3 -m pip install cmake
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-url) yosys-slang
+cd yosys-slang
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-commit)
+git submodule update --init --recursive
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/ubuntu20/install-yosys-moosic.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-url) yosys-moosic
+cd yosys-moosic
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-commit)
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/ubuntu20/install-yosys-slang.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+python3 -m venv .yosys-slang --clear
+. .yosys-slang/bin/activate
+python3 -m pip install cmake
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-url) yosys-slang
+cd yosys-slang
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-commit)
+git submodule update --init --recursive
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/ubuntu22/install-yosys-moosic.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-url) yosys-moosic
+cd yosys-moosic
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-commit)
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/ubuntu22/install-yosys-slang.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+python3 -m venv .yosys-slang --clear
+. .yosys-slang/bin/activate
+python3 -m pip install cmake
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-url) yosys-slang
+cd yosys-slang
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-commit)
+git submodule update --init --recursive
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/ubuntu24/install-yosys-moosic.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-url) yosys-moosic
+cd yosys-moosic
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-moosic --field git-commit)
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/toolscripts/ubuntu24/install-yosys-slang.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+# Get directory of script
+src_path=$(cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P)/..
+
+mkdir -p deps
+cd deps
+
+python3 -m venv .yosys-slang --clear
+. .yosys-slang/bin/activate
+python3 -m pip install cmake
+
+git clone $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-url) yosys-slang
+cd yosys-slang
+git checkout $(python3 ${src_path}/_tools.py --tool yosys-slang --field git-commit)
+git submodule update --init --recursive
+
+make -j$(nproc)
+sudo PATH="$PATH" make install
+cd -

siliconcompiler/utils/__init__.py

@@ -332,17 +332,20 @@ def grep(chip, args, line):
 
 
 #######################################
-def _resolve_env_vars(chip, filepath):
+def _resolve_env_vars(chip, filepath, step, index):
     if not filepath:
         return None
 
     env_save = os.environ.copy()
-    for env in chip.getkeys('option', 'env'):
-        os.environ[env] = chip.get('option', 'env', env)
+
+    os.environ.update(get_env_vars(chip, step, index))
     resolved_path = os.path.expandvars(filepath)
+
     os.environ.clear()
     os.environ.update(env_save)
 
+    resolved_path = os.path.expanduser(resolved_path)
+
     # variables that don't exist in environment get ignored by `expandvars`,
     # but we can do our own error checking to ensure this doesn't result in
     # silent bugs
@@ -353,8 +356,31 @@ def _resolve_env_vars(chip, filepath):
     return resolved_path
 
 
+#######################################
+def get_env_vars(chip, step, index):
+    '''
+    Returns a dictionary of environmental variables from the manifest
+    '''
+
+    schema_env = {}
+    for env in chip.getkeys('option', 'env'):
+        schema_env[env] = chip.get('option', 'env', env)
+
+    flow = chip.get('option', 'flow')
+    if step is not None and index is not None and flow:
+        tool = chip.get('flowgraph', flow, step, str(index), 'tool')
+        task = chip.get('flowgraph', flow, step, str(index), 'task')
+
+        if chip.valid('tool', tool, 'task', task, 'env'):
+            for env in chip.getkeys('tool', tool, 'task', task, 'env'):
+                schema_env[env] = chip.get('tool', tool, 'task', task, 'env', env,
+                                           step=step, index=index)
+
+    return schema_env
+
+
 ###########################################################################
-def find_sc_file(chip, filename, missing_ok=False, search_paths=None):
+def find_sc_file(chip, filename, missing_ok=False, search_paths=None, step=None, index=None):
     """
     Returns the absolute path for the filename provided.
 
@@ -370,6 +396,8 @@ def find_sc_file(chip, filename, missing_ok=False, search_paths=None):
             found, rather than returning None.
         search_paths (list): List of directories to search under instead of
             the defaults.
+        step (str): Step name
+        index (str): Index
 
     Returns:
         Returns absolute path of 'filename' if found, otherwise returns
@@ -385,7 +413,7 @@ def find_sc_file(chip, filename, missing_ok=False, search_paths=None):
         return None
 
     # Replacing environment variables
-    filename = _resolve_env_vars(chip, filename)
+    filename = _resolve_env_vars(chip, filename, step, index)
 
     # If we have an absolute path, pass-through here
     if os.path.isabs(filename) and os.path.exists(filename):

{siliconcompiler-0.30.0.dist-info → siliconcompiler-0.31.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: siliconcompiler
-Version: 0.30.0
+Version: 0.31.1
 Summary: A compiler framework that automates translation from source code to silicon.
 Author-email: Andreas Olofsson <andreas.d.olofsson@gmail.com>
 License: Apache License 2.0
@@ -26,7 +26,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp==3.10.11; python_version <= "3.8"
-Requires-Dist: aiohttp==3.11.12; python_version >= "3.9"
+Requires-Dist: aiohttp==3.11.13; python_version >= "3.9"
 Requires-Dist: requests==2.32.3
 Requires-Dist: PyYAML==6.0.2
 Requires-Dist: pandas>=1.1.5
@@ -39,7 +39,7 @@ Requires-Dist: Pillow==10.4.0; python_version <= "3.8"
 Requires-Dist: Pillow==11.1.0; python_version >= "3.9"
 Requires-Dist: GitPython==3.1.44
 Requires-Dist: lambdapdk>=0.1.47
-Requires-Dist: PyGithub==2.6.0
+Requires-Dist: PyGithub==2.6.1
 Requires-Dist: urllib3>=1.26.0
 Requires-Dist: fasteners==0.19
 Requires-Dist: fastjsonschema==2.21.1
@@ -48,13 +48,13 @@ Requires-Dist: importlib_metadata; python_version < "3.10"
 Requires-Dist: sc-surelog==1.84.1
 Requires-Dist: orjson==3.10.15
 Requires-Dist: streamlit==1.40.1; python_version <= "3.8"
-Requires-Dist: streamlit==1.42.0; python_version >= "3.9" and python_full_version != "3.9.7"
+Requires-Dist: streamlit==1.42.2; python_version >= "3.9" and python_full_version != "3.9.7"
 Requires-Dist: streamlit_agraph==0.0.45; python_full_version != "3.9.7"
 Requires-Dist: streamlit-antd-components==0.3.2; python_full_version != "3.9.7"
 Requires-Dist: streamlit_javascript==0.1.5; python_full_version != "3.9.7"
 Requires-Dist: streamlit-autorefresh==1.0.1; python_full_version != "3.9.7"
 Provides-Extra: test
-Requires-Dist: pytest==8.3.4; extra == "test"
+Requires-Dist: pytest==8.3.5; extra == "test"
 Requires-Dist: pytest-xdist==3.6.1; extra == "test"
 Requires-Dist: pytest-timeout==2.3.1; extra == "test"
 Requires-Dist: pytest-asyncio==0.24.0; python_version <= "3.8" and extra == "test"
@@ -65,10 +65,10 @@ Requires-Dist: responses==0.25.6; extra == "test"
 Requires-Dist: PyVirtualDisplay==3.0; extra == "test"
 Provides-Extra: lint
 Requires-Dist: flake8==7.1.2; extra == "lint"
-Requires-Dist: tclint==0.5.0; extra == "lint"
+Requires-Dist: tclint==0.5.3; extra == "lint"
 Requires-Dist: codespell==2.4.1; extra == "lint"
 Provides-Extra: docs
-Requires-Dist: Sphinx==8.1.3; extra == "docs"
+Requires-Dist: Sphinx==8.2.3; extra == "docs"
 Requires-Dist: pip-licenses==5.0.0; extra == "docs"
 Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "docs"
 Requires-Dist: sc-leflib>=0.2.0; extra == "docs"
@@ -99,19 +99,19 @@ SiliconCompiler is a modular hardware build system ("make for silicon"). The pro
 
 | Type | Supported|
 |------|----------|
-|**Design Languages**| C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec
+|**Design Languages**| C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec, [MLIR](https://en.wikipedia.org/wiki/MLIR_(software))
 |**Simulation Tools**| Verilator, Icarus, GHDL, Xyce
 |**Synthesis**| Yosys, Vivado, Synopsys, Cadence
-|**ASIC APR**| OpenRoad, Synopsys, Cadence
+|**ASIC APR**| OpenROAD, Synopsys, Cadence
 |**FPGA APR**| VPR, nextpnr, Vivado
-|**Layout Viewer**| Klayout, OpenRoad, Cadence, Synopsys
-|**DRC/LVS**| Magic, Synopsys, Siemens
-|**PDKs**| sky130, gf180, asap7, freepdk45, gf12lp, gf22fdx, intel16, ihp130
+|**Layout Viewer**| Klayout, OpenROAD, Cadence, Synopsys
+|**DRC/LVS**| Klayout, Magic, Synopsys, Siemens
+|**PDKs**| sky130, ihp130, gf180, asap7, freepdk45, gf12lp, gf22fdx, intel16
 
 # Getting Started
 
 SiliconCompiler is available as wheel packages on PyPI for macOS, Windows and
-Linux platforms. For working Python 3.8-3.12 environment, just use pip.
+Linux platforms. For working Python 3.8-3.13 environment, just use pip.
 
 ```sh
 python3 -m pip install --upgrade siliconcompiler
@@ -166,17 +166,15 @@ A. Olofsson, W. Ransohoff, N. Moroze, "[Invited: A Distributed Approach to Silic
 Bibtex:
 ```
 @inproceedings{10.1145/3489517.3530673,
-author = {Olofsson, Andreas and Ransohoff, William and Moroze, Noah},
-title = {A Distributed Approach to Silicon Compilation: Invited},
-year = {2022},
-booktitle = {Proceedings of the 59th ACM/IEEE Design Automation Conference},
-pages = {1343–1346},
-location = {San Francisco, California}
+  author = {Olofsson, Andreas and Ransohoff, William and Moroze, Noah},
+  title = {A Distributed Approach to Silicon Compilation: Invited},
+  year = {2022},
+  booktitle = {Proceedings of the 59th ACM/IEEE Design Automation Conference},
+  pages = {1343–1346},
+  location = {San Francisco, California}
 }
 ```
 
-
-
 # Installation
 
 Complete installation instructions are available in the [Installation Guide](https://docs.siliconcompiler.com/en/stable/user_guide/installation.html).
@@ -194,14 +192,14 @@ python3 -m pip install -e .[docs,test]  # Optional install step for generating d
 
 Installation instructions for all external tools can be found in the
 [External Tools](https://docs.siliconcompiler.com/en/stable/user_guide/installation.html#external-tools) section
-of the user guide. We have included shell setup scripts (Ubuntu) for most of the supported tools.
+of the user guide. We have included shell setup scripts (Ubuntu) for most of the supported tools, which can be accessed via [sc-install](https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html#apps-sc-install-ref).
 See the [./siliconcompiler/toolscripts](./siliconcompiler/toolscripts) directory for a complete set of scripts and [./siliconcompiler/toolscripts/_tools.json](./siliconcompiler/toolscripts/_tools.json) for the currently recommended tool versions.
 
 # Contributing
 
 SiliconCompiler is an open-source project and welcomes contributions. To find out
 how to contribute to the project, see our
-[Contributing Guidelines.](./CONTRIBUTING.md)
+[Contributing Guidelines](./CONTRIBUTING.md).
 
 # Issues / Bugs