siliconcompiler 0.28.1__tar.gz → 0.28.2__tar.gz

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/Changes

@@ -8,6 +8,19 @@ The changes in each SiliconCompiler release version are described below. Commit
 version shown in (). Where applicable, the contributors that suggested a given
 feature are shown in [].
 
+SiliconCompiler 0.28.2 (2024-10-02)
+=========================================
+
+**Major:**
+
+ * Added `sc-install` utility application to help install tools on supported platforms.
+
+
+**Minor:**
+
+ * Updated `.input/.output` to support receiving lists of files.
+
+
 SiliconCompiler 0.28.1 (2024-09-20)
 =========================================
 

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: siliconcompiler
-Version: 0.28.1
+Version: 0.28.2
 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
@@ -12,7 +12,7 @@ Project-URL: Discussion, https://github.com/siliconcompiler/siliconcompiler/disc
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp==3.10.5
+Requires-Dist: aiohttp==3.10.8
 Requires-Dist: requests==2.32.3
 Requires-Dist: PyYAML==6.0.2
 Requires-Dist: pandas>=1.1.5
@@ -45,7 +45,7 @@ Requires-Dist: pytest-cov==5.0.0; extra == "test"
 Requires-Dist: responses==0.25.3; extra == "test"
 Requires-Dist: PyVirtualDisplay==3.0; extra == "test"
 Requires-Dist: flake8==7.1.1; extra == "test"
-Requires-Dist: tclint==0.4.0; extra == "test"
+Requires-Dist: tclint==0.4.1; extra == "test"
 Requires-Dist: codespell==2.3.0; extra == "test"
 Provides-Extra: docs
 Requires-Dist: Sphinx==8.0.2; extra == "docs"

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/SECURITY.md

@@ -1,6 +1,6 @@
 # Security Policy
 
-If you believe you have identified a security issue with a SilionCompiler project, do not open a public issue. To responsibly report a security issue, please email security@zeroasic.com. A security team member will contact you acknowledging the report and how to continue.
+If you believe you have identified a security issue with a SiliconCompiler project, do not open a public issue. To responsibly report a security issue, please email security@zeroasic.com. A security team member will contact you acknowledging the report and how to continue.
 
 Be sure to include as much detail as necessary in your report. If you are able, you may also include a fix for the issue generated with git format-patch.
 

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/pyproject.toml

@@ -17,7 +17,7 @@ description = "A compiler framework that automates translation from source code
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">= 3.8"
 dependencies = [
-    "aiohttp == 3.10.5",
+    "aiohttp == 3.10.8",
     "requests == 2.32.3",
     "PyYAML == 6.0.2",
     "pandas >= 1.1.5",
@@ -59,6 +59,7 @@ sc-issue = "siliconcompiler.apps.sc_issue:main"
 sc-remote = "siliconcompiler.apps.sc_remote:main"
 sc-server = "siliconcompiler.apps.sc_server:main"
 sc-show = "siliconcompiler.apps.sc_show:main"
+sc-install = "siliconcompiler.apps.sc_install:main"
 siliconcompiler = "siliconcompiler.apps.sc:main"
 smake = "siliconcompiler.apps.smake:main"
 
@@ -75,7 +76,7 @@ test = [
     "responses == 0.25.3",
     "PyVirtualDisplay == 3.0",
     "flake8 == 7.1.1",
-    "tclint == 0.4.0",
+    "tclint == 0.4.1",
     "codespell == 2.3.0"
 ]
 docs = [
@@ -141,3 +142,8 @@ skip = './build/*,*.json,*.xml,./siliconcompiler/templates/report/bootstrap.min.
 count = true
 quiet-level = 3
 ignore-words-list = 'synopsys,inout,subtile,FRAM,dffer,dffers'
+
+[tool.check-wheel-contents]
+ignore = [
+    "W002"
+]

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/_metadata.py

@@ -1,5 +1,5 @@
 # Version number following semver standard.
-version = '0.28.1'
+version = '0.28.2'
 
 # Default server address for remote runs, if unspecified.
 default_server = 'https://server.siliconcompiler.com'

siliconcompiler-0.28.2/siliconcompiler/apps/sc_install.py

@@ -0,0 +1,192 @@
+# Copyright 2024 Silicon Compiler Authors. All Rights Reserved.
+
+import argparse
+import glob
+import subprocess
+import sys
+import shutil
+import re
+import os.path
+from collections.abc import Container
+from pathlib import Path
+import siliconcompiler
+from siliconcompiler.scheduler import _get_machine_info
+
+
+class ChoiceOptional(Container):
+    def __init__(self, choices):
+        super().__init__()
+
+        self.__choices = set(choices)
+
+    def __contains__(self, item):
+        if not item:
+            # allow empty value
+            return True
+        return item in self.__choices
+
+    def __iter__(self):
+        return self.__choices.__iter__()
+
+    def get_items(self, choices):
+        items = set(choices)
+        return sorted(list(items))
+
+
+def install_tool(tool, script, build_dir, prefix):
+    # Ensure build dir is available
+    build_dir = Path(build_dir) / tool
+    shutil.rmtree(str(build_dir), ignore_errors=True)
+    build_dir.mkdir(parents=True, exist_ok=True)
+
+    # setup environment
+    env = os.environ.copy()
+    env["PREFIX"] = prefix
+
+    # run
+    ret = subprocess.call(script, env=env, cwd=build_dir)
+    if ret != 0:
+        print(f"Error occurred while building/installing {tool}")
+        return False
+    return True
+
+
+def show_tool(tool, script):
+    def print_header(head):
+        border_len = max(80, len(script) + 2)
+        border = border_len*"#"
+        print(border)
+        print(f"# {tool} script / {head}")
+        if head == "start":
+            print(f"# {script}")
+        print(border)
+
+    print_header("start")
+
+    with open(script) as f:
+        for line in f:
+            print(line.rstrip())
+
+    print_header("end")
+
+
+def _get_tools_list():
+    tools_root = Path(siliconcompiler.__file__).parent / "toolscripts"
+
+    machine_info = _get_machine_info()
+    script_dir = None
+    if machine_info['system'].lower() == 'linux':
+        if machine_info['distro'].lower() == 'ubuntu':
+            version, _ = machine_info['osversion'].split('.')
+            script_dir = f"{machine_info['distro'].lower()}{version}"
+    if script_dir:
+        script_dir = tools_root / script_dir
+        if not script_dir.exists():
+            script_dir = None
+
+    tools = {}
+    if script_dir:
+        for script in glob.glob(str(script_dir / "install-*.sh")):
+            tool = re.match(r"install-(.*)\.sh", os.path.basename(script).lower())
+            tools[tool.group(1)] = script
+
+    return tools
+
+
+def _recommended_tool_groups():
+    return {
+        "asic": {"surelog", "sv2v", "yosys", "openroad", "klayout"},
+        "fpga": {"surelog", "sv2v", "yosys", "vpr"},
+        "digital-simulation": {"verilator", "icarus"},
+        "analog-simulation": {"xyce"}
+    }
+
+
+def main():
+    progname = "sc-install"
+    description = """
+-----------------------------------------------------------
+SC app install supported tools.
+
+To install a single tool:
+    sc-install openroad
+
+To install multiple tools:
+    sc-install openroad yosys klayout
+
+To install a group of tools:
+    sc-install -group asic
+
+To install tools in a different location:
+    sc-install -prefix /usr/local yosys
+
+To build tools in a different location:
+    sc-install -build_dir /tmp yosys
+
+To show the install script:
+    sc-install -show openroad
+-----------------------------------------------------------
+"""
+    parser = argparse.ArgumentParser(
+        prog=progname,
+        description=description,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    tools = _get_tools_list()
+
+    tool_choices = ChoiceOptional(tools.keys())
+    parser.add_argument(
+        "tool",
+        nargs="*",
+        choices=tool_choices,
+        help="tool to install")
+
+    parser.add_argument(
+        "-group",
+        nargs="+",
+        choices=_recommended_tool_groups().keys(),
+        help="tool group to install")
+
+    parser.add_argument(
+        "-prefix",
+        default=Path.home() / ".local",
+        help="Prefix to use when installing tool",
+        metavar="<path>")
+
+    parser.add_argument(
+        "-build_dir",
+        default=Path.home() / ".sc" / "tool_build",
+        help="Directory to build the tool in",
+        metavar="<path>")
+
+    parser.add_argument(
+        "-show",
+        action="store_true",
+        help="Show the install script and exit")
+
+    args = parser.parse_args()
+
+    if not args.tool:
+        args.tool = []
+
+    args.tool = list(args.tool)
+    if args.group:
+        for group in args.group:
+            args.tool.extend(_recommended_tool_groups()[group])
+
+    tools_handled = set()
+    for tool in args.tool:
+        if tool in tools_handled:
+            continue
+        tools_handled.add(tool)
+        if args.show:
+            show_tool(tool, tools[tool])
+        else:
+            if not install_tool(tool, tools[tool], args.build_dir, args.prefix):
+                return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/core.py

@@ -1108,6 +1108,21 @@ class Chip:
         Performs a lookup in the io map for the fileset and filetype
         and will use those if they are not provided in the arguments
         '''
+        # Handle list inputs
+        if isinstance(filename, (list, tuple)):
+            for file in filename:
+                self._add_input_output(
+                    category,
+                    file,
+                    fileset=fileset,
+                    filetype=filetype,
+                    iomap=iomap,
+                    step=step,
+                    index=index,
+                    package=package,
+                    quiet=quiet)
+            return
+
         # Normalize value to string in case we receive a pathlib.Path
         filename = str(filename)
 

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/_common/tcl/sc_pin_constraints.tcl

@@ -1,8 +1,9 @@
-proc sc_collect_pin_constraints { \
-    placement_pins_arg \
-    ordered_pins_arg \
-    sc_side_layer_func \
-    { print_func puts } } {
+proc sc_collect_pin_constraints {
+    placement_pins_arg
+    ordered_pins_arg
+    sc_side_layer_func
+    { print_func puts }
+} {
     upvar 1 $placement_pins_arg placement_pins
     upvar 1 $ordered_pins_arg ordered_pins
 

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/openroad/scripts/sc_metrics.tcl

@@ -2,7 +2,7 @@
 # Report Metrics
 ###############################
 
-proc sc_display_report {report} {
+proc sc_display_report { report } {
   if { ![file exists $report] } {
     return
   }

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/openroad/scripts/sc_procs.tcl

@@ -2,7 +2,7 @@
 # Global Placement
 #######################
 
-proc sc_global_placement_density {} {
+proc sc_global_placement_density { } {
   global openroad_gpl_padding
   global openroad_gpl_place_density
   global openroad_gpl_uniform_placement_adjustment
@@ -82,7 +82,7 @@ proc sc_global_placement { args } {
 # Detailed Placement
 ###########################
 
-proc sc_detailed_placement {} {
+proc sc_detailed_placement { } {
   global openroad_dpl_padding
   global openroad_dpl_padding
   global openroad_dpl_disallow_one_site
@@ -149,7 +149,7 @@ proc sc_pin_placement { args } {
 # Check if OR has a GUI
 ###########################
 
-proc sc_has_gui {} {
+proc sc_has_gui { } {
   return [gui::supported]
 }
 
@@ -157,7 +157,7 @@ proc sc_has_gui {} {
 # Check if design has placed instances
 ###########################
 
-proc sc_has_placed_instances {} {
+proc sc_has_placed_instances { } {
   foreach inst [[ord::get_db_block] getInsts] {
     if { [$inst isPlaced] } {
       return true
@@ -170,7 +170,7 @@ proc sc_has_placed_instances {} {
 # Check if design has unplaced instances
 ###########################
 
-proc sc_has_unplaced_instances {} {
+proc sc_has_unplaced_instances { } {
   foreach inst [[ord::get_db_block] getInsts] {
     if { ![$inst isPlaced] } {
       return true
@@ -183,7 +183,7 @@ proc sc_has_unplaced_instances {} {
 # Check if design has routing
 ###########################
 
-proc sc_has_routing {} {
+proc sc_has_routing { } {
   foreach net [[ord::get_db_block] getNets] {
     if { [$net getWire] != "NULL" } {
       return true
@@ -196,7 +196,7 @@ proc sc_has_routing {} {
 # Check if design has global routing
 ###########################
 
-proc sc_has_global_routing {} {
+proc sc_has_global_routing { } {
   foreach net [[ord::get_db_block] getNets] {
     if { [llength [$net getGuides]] != 0 } {
       return true
@@ -211,7 +211,7 @@ proc sc_has_global_routing {} {
 
 # Function adapted from OpenROAD:
 # https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/ca3004b85e0d4fbee3470115e63b83c498cfed85/flow/scripts/macro_place.tcl#L26
-proc sc_design_has_unplaced_macros {} {
+proc sc_design_has_unplaced_macros { } {
   foreach inst [[ord::get_db_block] getInsts] {
     if { [$inst isBlock] && ![$inst isFixed] } {
       return true
@@ -224,7 +224,7 @@ proc sc_design_has_unplaced_macros {} {
 # Design has unplaced pads
 ###########################
 
-proc sc_design_has_unplaced_pads {} {
+proc sc_design_has_unplaced_pads { } {
   foreach inst [[ord::get_db_block] getInsts] {
     if { [$inst isPad] && ![$inst isFixed] } {
       return true
@@ -237,7 +237,7 @@ proc sc_design_has_unplaced_pads {} {
 # Design has placable IOs
 ###########################
 
-proc sc_design_has_placeable_ios {} {
+proc sc_design_has_placeable_ios { } {
   foreach bterm [[ord::get_db_block] getBTerms] {
     if {
       [$bterm getFirstPinPlacementStatus] != "FIXED" &&
@@ -284,7 +284,7 @@ proc sc_find_net_regex { net_name } {
 # Get supply nets in design
 ###########################
 
-proc sc_supply_nets {} {
+proc sc_supply_nets { } {
   set nets []
 
   foreach net [[ord::get_db_block] getNets] {
@@ -301,7 +301,7 @@ proc sc_supply_nets {} {
 # Get nets for PSM to check
 ###########################
 
-proc sc_psm_check_nets {} {
+proc sc_psm_check_nets { } {
   global openroad_psm_enable
   global openroad_psm_skip_nets
 
@@ -343,7 +343,7 @@ proc sc_save_image { title path { pixels 1000 } } {
 # Get the image bounding box
 ###########################
 
-proc sc_image_area {} {
+proc sc_image_area { } {
   set box [[ord::get_db_block] getDieArea]
   set width [$box dx]
   set height [$box dy]
@@ -373,7 +373,7 @@ proc sc_image_resolution { pixels } {
 # Clear gui selections
 ###########################
 
-proc sc_image_clear_selection {} {
+proc sc_image_clear_selection { } {
   gui::clear_highlights -1
   gui::clear_selections
 }
@@ -382,7 +382,7 @@ proc sc_image_clear_selection {} {
 # Setup default GUI setting for images
 ###########################
 
-proc sc_image_setup_default {} {
+proc sc_image_setup_default { } {
   gui::restore_display_controls
 
   sc_image_clear_selection
@@ -406,7 +406,7 @@ proc sc_image_setup_default {} {
 # Count the logic depth of the critical path
 ###########################
 
-proc count_logic_depth {} {
+proc count_logic_depth { } {
   set count 0
   set paths [find_timing_paths -sort_by_slack]
   if { [llength $paths] == 0 } {

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/openroad/scripts/sc_route.tcl

@@ -6,7 +6,7 @@
 # Helper functions
 #######################
 
-proc insert_fillers {} {
+proc insert_fillers { } {
   upvar sc_filler sc_filler
   if { $sc_filler != "" } {
     filler_placement $sc_filler

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/openroad/scripts/sc_write_images.tcl

@@ -54,7 +54,7 @@ proc sc_image_heatmap { name ident image_name title { allow_bin_adjust 1 } } {
   gui::set_display_controls "Heat Maps/${name}" visible false
 }
 
-proc sc_image_placement {} {
+proc sc_image_placement { } {
   if { ![sc_has_placed_instances] } {
     return
   }
@@ -70,7 +70,7 @@ proc sc_image_placement {} {
   sc_save_image "placement" reports/images/${sc_design}.placement.png
 }
 
-proc sc_image_routing {} {
+proc sc_image_routing { } {
   if { ![sc_has_routing] } {
     return
   }
@@ -85,7 +85,7 @@ proc sc_image_routing {} {
   sc_save_image "routing" reports/images/${sc_design}.routing.png
 }
 
-proc sc_image_everything {} {
+proc sc_image_everything { } {
   global sc_design
 
   sc_image_setup_default
@@ -134,7 +134,7 @@ proc sc_image_irdrop { net corner } {
   }
 }
 
-proc sc_image_routing_congestion {} {
+proc sc_image_routing_congestion { } {
   if { ![sc_has_global_routing] } {
     return
   }
@@ -148,7 +148,7 @@ proc sc_image_routing_congestion {} {
     0
 }
 
-proc sc_image_estimated_routing_congestion {} {
+proc sc_image_estimated_routing_congestion { } {
   if { ![sc_has_placed_instances] } {
     return
   }
@@ -166,7 +166,7 @@ proc sc_image_estimated_routing_congestion {} {
   unsuppress_message GRT 10
 }
 
-proc sc_image_power_density {} {
+proc sc_image_power_density { } {
   if { ![sc_has_placed_instances] } {
     return
   }
@@ -188,7 +188,7 @@ proc sc_image_power_density {} {
   }
 }
 
-proc sc_image_placement_density {} {
+proc sc_image_placement_density { } {
   if { ![sc_has_placed_instances] } {
     return
   }
@@ -201,7 +201,7 @@ proc sc_image_placement_density {} {
     "placement density"
 }
 
-proc sc_image_clocks {} {
+proc sc_image_clocks { } {
   if { ![sc_has_placed_instances] } {
     return
   }
@@ -223,7 +223,7 @@ proc sc_image_clocks {} {
   sc_save_image "clocks" reports/images/${sc_design}.clocks.png
 }
 
-proc sc_image_clocktree {} {
+proc sc_image_clocktree { } {
   gui::show_widget "Clock Tree Viewer"
   global sc_scenarios
 
@@ -263,7 +263,7 @@ proc sc_image_clocktree {} {
   gui::hide_widget "Clock Tree Viewer"
 }
 
-proc sc_image_optimizer {} {
+proc sc_image_optimizer { } {
   global sc_design
   sc_image_setup_default
 

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/opensta/scripts/sc_procs.tcl

@@ -2,7 +2,7 @@
 # Count the logic depth of the critical path
 ###########################
 
-proc sc_count_logic_depth {} {
+proc sc_count_logic_depth { } {
     set count 0
     set paths [find_timing_paths -sort_by_slack]
     if { [llength $paths] == 0 } {
@@ -24,7 +24,7 @@ proc sc_count_logic_depth {} {
     return [expr { $count - 1 }]
 }
 
-proc sc_design_area {} {
+proc sc_design_area { } {
     set area 0
     foreach inst [get_cells -hierarchical *] {
         set lib_cell [$inst liberty_cell]
@@ -35,7 +35,7 @@ proc sc_design_area {} {
     return $area
 }
 
-proc sc_display_report {report} {
+proc sc_display_report { report } {
     if { ![file exists $report] } {
         return
     }

{siliconcompiler-0.28.1 → siliconcompiler-0.28.2}/siliconcompiler/tools/yosys/syn_asic.tcl

@@ -3,7 +3,7 @@
 ####################
 source "$sc_refdir/syn_asic_fpga_shared.tcl"
 
-proc preserve_modules {} {
+proc preserve_modules { } {
     global sc_cfg
     global sc_tool
     global sc_task