siliconcompiler 0.31.1__tar.gz → 0.32.0__tar.gz

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/.readthedocs.yaml

@@ -24,9 +24,8 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
         - test
         - lint
+        - docs
         - profile
-        - examples
         - optimizer

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/Changes

@@ -8,6 +8,24 @@ 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.32.0 (2025-03-11)
+=========================================
+
+**Major:**
+
+ * Changed default behavior of `.summary` to only print metrics summary, and added `.snapshot` to generate and display job summary image.
+ * Moved default verilog/system verilog frontend parser to Slang.
+
+
+**Minor:**
+
+ * Changed examples to use a `requirements.txt` file for external dependencies.
+
+ * Tools:
+
+  * openroad: added timing histogram reports.
+
+
 SiliconCompiler 0.31.1 (2025-03-06)
 =========================================
 

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: siliconcompiler
-Version: 0.31.1
+Version: 0.32.0
 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
@@ -45,10 +45,10 @@ Requires-Dist: fasteners==0.19
 Requires-Dist: fastjsonschema==2.21.1
 Requires-Dist: docker==7.1.0
 Requires-Dist: importlib_metadata; python_version < "3.10"
-Requires-Dist: sc-surelog==1.84.1
 Requires-Dist: orjson==3.10.15
+Requires-Dist: pyslang==8.0.0
 Requires-Dist: streamlit==1.40.1; python_version <= "3.8"
-Requires-Dist: streamlit==1.42.2; python_version >= "3.9" and python_full_version != "3.9.7"
+Requires-Dist: streamlit==1.43.1; 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"
@@ -74,9 +74,6 @@ Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "docs"
 Requires-Dist: sc-leflib>=0.2.0; extra == "docs"
 Provides-Extra: profile
 Requires-Dist: gprof2dot==2024.6.6; extra == "profile"
-Provides-Extra: examples
-Requires-Dist: migen==0.9.2; extra == "examples"
-Requires-Dist: lambdalib==0.3.3; extra == "examples"
 Provides-Extra: optimizer
 Requires-Dist: google-vizier[jax]==0.1.21; python_version >= "3.10" and extra == "optimizer"
 

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/pyproject.toml

@@ -52,12 +52,12 @@ dependencies = [
     "fastjsonschema == 2.21.1",
     "docker == 7.1.0",
     "importlib_metadata; python_version < '3.10'",
-    "sc-surelog == 1.84.1",
     "orjson == 3.10.15",
+    "pyslang == 8.0.0",
 
     # dashboard, streamlit does not support 3.9.7
     "streamlit == 1.40.1; python_version <= '3.8'",
-    "streamlit == 1.42.2; python_version >= '3.9' and python_full_version != '3.9.7'",
+    "streamlit == 1.43.1; python_version >= '3.9' and python_full_version != '3.9.7'",
     "streamlit_agraph == 0.0.45; python_full_version != '3.9.7'",
     "streamlit-antd-components == 0.3.2; python_full_version != '3.9.7'",
     "streamlit_javascript == 0.1.5; python_full_version != '3.9.7'",
@@ -130,10 +130,6 @@ docs = [
 profile = [
     "gprof2dot == 2024.6.6"
 ]
-examples = [
-    "migen == 0.9.2",
-    "lambdalib == 0.3.3"
-]
 optimizer = [
     "google-vizier[jax] == 0.1.21; python_version >= '3.10'"
 ]

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/_metadata.py

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

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/apps/sc.py

@@ -99,6 +99,7 @@ def main():
 
         # Print Job Summary
         chip.summary()
+        chip.snapshot()
     except SiliconCompilerError:
         return 1
     except Exception as e:

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/apps/utils/summarize.py

@@ -37,7 +37,7 @@ def main():
         return 1
 
     # Print Job Summary
-    chip.summary(generate_image=False, generate_html=False)
+    chip.summary()
 
     return 0
 

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/core.py

@@ -26,7 +26,6 @@ from siliconcompiler import _metadata
 from siliconcompiler import NodeStatus, SiliconCompilerError
 from siliconcompiler.report import _show_summary_table
 from siliconcompiler.report import _generate_summary_image, _open_summary_image
-from siliconcompiler.report import _generate_html_report, _open_html_report
 from siliconcompiler.report import Dashboard
 from siliconcompiler import package as sc_package
 import glob
@@ -211,6 +210,8 @@ class Chip:
 
         self.logger.addHandler(file_handler)
 
+        return file_handler
+
     ###########################################################################
     def _init_logger(self, step=None, index=None, in_run=False):
 
@@ -2889,7 +2890,7 @@ class Chip:
         return self._dash
 
     ###########################################################################
-    def summary(self, show_all_indices=False, generate_image=True, generate_html=False):
+    def summary(self, show_all_indices=False):
         '''
         Prints a summary of the compilation manifest.
 
@@ -2902,13 +2903,6 @@ class Chip:
             show_all_indices (bool): If True, displays metrics for all indices
                 of each step. If False, displays metrics only for winning
                 indices.
-            generate_image (bool): If True, generates a summary image featuring
-                a layout screenshot and a subset of metrics. Requires that the
-                current job has an ending node that generated a PNG file.
-            generate_html (bool): If True, generates an HTML report featuring a
-                metrics summary table and manifest tree view. The report will
-                include a layout screenshot if the current job has an ending node
-                that generated a PNG file.
 
         Examples:
             >>> chip.summary()
@@ -2921,36 +2915,36 @@ class Chip:
 
         _show_summary_table(self, flow, nodes_to_execute, show_all_indices=show_all_indices)
 
-        # Create a report for the Chip object which can be viewed in a web browser.
-        # Place report files in the build's root directory.
-        work_dir = self.getworkdir()
-        if os.path.isdir(work_dir):
-            # Mark file paths where the reports can be found if they were generated.
-            results_img = os.path.join(work_dir, f'{self.design}.png')
-            results_html = os.path.join(work_dir, 'report.html')
-
-            for path in (results_img, results_html):
-                if os.path.exists(path):
-                    os.remove(path)
-
-            if generate_image:
-                _generate_summary_image(self, results_img)
-
-            if generate_html:
-                _generate_html_report(self, flow, nodes_to_execute, results_html)
-
-            # dashboard does not generate any data
-            self.logger.info(f'Dashboard at "sc-dashboard -cfg {work_dir}/{self.design}.pkg.json"')
-
-            # Try to open the results and layout only if '-nodisplay' is not set.
-            # Priority: PNG > HTML > dashboard.
-            if not self.get('option', 'nodisplay'):
-                if os.path.isfile(results_img):
-                    _open_summary_image(results_img)
-                elif os.path.isfile(results_html):
-                    _open_html_report(self, results_html)
-                else:
-                    self.dashboard(wait=False)
+        # dashboard does not generate any data
+        self.logger.info('Dashboard at "sc-dashboard '
+                         f'-cfg {self.getworkdir()}/{self.design}.pkg.json"')
+
+    ###########################################################################
+    def snapshot(self, path=None, display=True):
+        '''
+        Creates a snapshot image of the job
+
+        Args:
+            path (str): Path to generate the image at, if not provided will default to
+                <job>/<design>.png
+            display (bool): If True, will open the image for viewing. If :keypath:`option,nodisplay`
+                is True, this argument will be ignored.
+
+        Examples:
+            >>> chip.snapshot()
+            Creates a snapshot image in the default location
+        '''
+
+        if not path:
+            path = os.path.join(self.getworkdir(), f'{self.design}.png')
+
+        if os.path.exists(path):
+            os.remove(path)
+
+        _generate_summary_image(self, path)
+
+        if os.path.isfile(path) and not self.get('option', 'nodisplay') and display:
+            _open_summary_image(path)
 
     ###########################################################################
     def clock(self, pin, period, jitter=0, mode='global'):

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/flows/_common.py

@@ -1,4 +1,5 @@
 from siliconcompiler.tools.surelog import parse as surelog_parse
+from siliconcompiler.tools.slang import elaborate as slang_preprocess
 from siliconcompiler.tools.chisel import convert as chisel_convert
 from siliconcompiler.tools.bambu import convert as bambu_convert
 from siliconcompiler.tools.bluespec import convert as bluespec_convert
@@ -7,6 +8,8 @@ from siliconcompiler.tools.sv2v import convert as sv2v_convert
 
 from siliconcompiler.tools.builtin import concatenate
 
+from siliconcompiler.tools.slang import has_pyslang
+
 
 def _make_docs(chip):
     from siliconcompiler.targets import freepdk45_demo
@@ -20,9 +23,12 @@ def _make_docs(chip):
     chip.use(freepdk45_demo)
 
 
-def __get_frontends(allow_system_verilog):
+def __get_frontends(allow_system_verilog, use_surelog=False):
+    parser = surelog_parse
+    if not use_surelog and has_pyslang():
+        parser = slang_preprocess
     systemverilog_frontend = [
-        ('import.verilog', surelog_parse)
+        ('import.verilog', parser)
     ]
     if not allow_system_verilog:
         systemverilog_frontend.append(('import.convert', sv2v_convert))
@@ -36,7 +42,7 @@ def __get_frontends(allow_system_verilog):
     }
 
 
-def setup_multiple_frontends(flow, allow_system_verilog=False):
+def setup_multiple_frontends(flow, allow_system_verilog=False, use_surelog=False):
     '''
     Sets of multiple frontends if different frontends are required.
 
@@ -45,7 +51,7 @@ def setup_multiple_frontends(flow, allow_system_verilog=False):
 
     concat_nodes = []
     flowname = flow.design
-    for _, pipe in __get_frontends(allow_system_verilog).items():
+    for _, pipe in __get_frontends(allow_system_verilog, use_surelog=use_surelog).items():
         prev_step = None
         for step, task in pipe:
             flow.node(flowname, step, task)

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/package/__init__.py

@@ -41,11 +41,11 @@ def get_download_cache_path(chip, package, ref):
         os.path.join(cache_path, f'{package}-{ref}.lock')
 
 
-def _file_path_resolver(chip, package, path, ref, url):
+def _file_path_resolver(chip, package, path, ref, url, fetch):
     return os.path.abspath(path.replace('file://', ''))
 
 
-def _python_path_resolver(chip, package, path, ref, url):
+def _python_path_resolver(chip, package, path, ref, url, fetch):
     return path_from_python(chip, url.netloc)
 
 
@@ -66,7 +66,7 @@ def _get_path_resolver(path):
     raise ValueError(f"{path} is not supported")
 
 
-def _path(chip, package):
+def _path(chip, package, fetch):
     # Initially try retrieving data source from schema
     data = {}
     data['path'] = chip.get('package', 'source', package, 'path')
@@ -84,22 +84,23 @@ def _path(chip, package):
 
     path_resolver, url = _get_path_resolver(data['path'])
 
-    return path_resolver(chip, package, data['path'], data['ref'], url)
+    return path_resolver(chip, package, data['path'], data['ref'], url, fetch)
 
 
-def path(chip, package):
+def path(chip, package, fetch=True):
     """
     Compute data source data path
     Additionally cache data source data if possible
     Parameters:
         package (str): Name of the data source
+        fetch (bool): Flag to indicate that the path should be fetched
     Returns:
         path: Location of data source on the local system
     """
 
     if package not in chip._packages:
         changed = False
-        data_path = _path(chip, package)
+        data_path = _path(chip, package, fetch)
 
         if isinstance(data_path, tuple) and len(data_path) == 2:
             data_path, changed = data_path

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/package/git.py

@@ -15,9 +15,12 @@ def get_resolver(url):
     return None
 
 
-def git_resolver(chip, package, path, ref, url):
+def git_resolver(chip, package, path, ref, url, fetch):
     data_path, data_path_lock = get_download_cache_path(chip, package, ref)
 
+    if not fetch:
+        return data_path, False
+
     # Acquire lock
     data_lock = InterProcessLock(data_path_lock)
     aquire_data_lock(data_path, data_lock)

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/package/https.py

@@ -21,16 +21,20 @@ def get_resolver(url):
     return None
 
 
-def http_resolver(chip, package, path, ref, url):
+def http_resolver(chip, package, path, ref, url, fetch):
     data_path, data_path_lock = get_download_cache_path(chip, package, ref)
 
-    if os.path.exists(data_path):
+    if not fetch:
         return data_path, False
 
     # Acquire lock
     data_lock = InterProcessLock(data_path_lock)
     aquire_data_lock(data_path, data_lock)
 
+    if os.path.exists(data_path):
+        release_data_lock(data_lock)
+        return data_path, False
+
     extract_from_url(chip, package, path, ref, url, data_path)
 
     release_data_lock(data_lock)

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/report/dashboard/components/__init__.py

@@ -433,7 +433,7 @@ def node_file_tree_viewer(chip, step, index):
     lookup = {}
     tree_items = []
 
-    file_metrics = report.get_metrics_source(chip, step, index)
+    metrics_source, file_metrics = report.get_metrics_source(chip, step, index)
     work_dir = chip.getworkdir(step=step, index=index)
 
     def make_item(file):
@@ -446,12 +446,22 @@ def node_file_tree_viewer(chip, step, index):
 
         check_file = os.path.relpath(file['value'], work_dir)
         if check_file in file_metrics:
-            for metric in file_metrics[check_file]:
-                if len(item.tag) < 5:
-                    item.tag.append(sac.Tag(metric, color='green'))
-                else:
-                    item.tag.append(sac.Tag('metrics...', color='geekblue'))
+            metrics = set(file_metrics[check_file])
+            primary_source = set()
+            if check_file in metrics_source:
+                primary_source = set(metrics_source[check_file])
+            metrics = metrics - primary_source
+
+            for color, metric_set in (('blue', primary_source), ('green', metrics)):
+                if len(item.tag) >= 5:
                     break
+
+                for metric in metric_set:
+                    if len(item.tag) < 5:
+                        item.tag.append(sac.Tag(metric, color=color))
+                    else:
+                        item.tag.append(sac.Tag('metrics...', color='geekblue'))
+                        break
             item.tooltip = "metrics: " + ", ".join(file_metrics[check_file])
 
         if 'children' in file:

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/report/report.py

@@ -302,20 +302,20 @@ def get_metrics_source(chip, step, index):
         index (string) : Index of node.
     '''
     file_to_metric = {}
+    metric_primary_source = {}
     tool, task = get_tool_task(chip, step, index)
     if not chip.valid('tool', tool, 'task', task, 'report'):
-        return file_to_metric
+        return metric_primary_source, file_to_metric
 
     metrics = chip.getkeys('tool', tool, 'task', task, 'report')
 
     for metric in metrics:
         sources = chip.get('tool', tool, 'task', task, 'report', metric, step=step, index=index)
+        if sources:
+            metric_primary_source.setdefault(sources[0], []).append(metric)
         for source in sources:
-            if source in file_to_metric:
-                file_to_metric[source].append(metric)
-            else:
-                file_to_metric[source] = [metric]
-    return file_to_metric
+            file_to_metric.setdefault(source, []).append(metric)
+    return metric_primary_source, file_to_metric
 
 
 def get_files(chip, step, index):

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/scheduler/run_node.py

@@ -45,6 +45,9 @@ def main():
                         metavar='<package>:<directory>',
                         nargs='+',
                         help='Map of caches to prepopulate runner with')
+    parser.add_argument('-fetch_cache',
+                        action='store_true',
+                        help='Allow for cache downloads')
     parser.add_argument('-step',
                         required=True,
                         metavar='<step>',
@@ -105,7 +108,7 @@ def main():
 
     # Populate cache
     for package in chip.getkeys('package', 'source'):
-        sc_path(chip, package)
+        sc_path(chip, package, fetch=args.fetch_cache)
 
     # Run the task.
     error = True

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/tools/openroad/_apr.py

@@ -84,12 +84,16 @@ def extract_metrics(chip):
     metric_reports = {
         "setuptns": [
             "timing/total_negative_slack.rpt",
-            "timing/setup.rpt"
+            "timing/setup.rpt",
+            "timing/setup.histogram.rpt",
+            "images/timing/setup.histogram.png"
         ],
         "setupslack": [
             "timing/worst_slack.setup.rpt",
             "timing/setup.rpt",
-            "timing/setup.topN.rpt"
+            "timing/setup.topN.rpt",
+            "timing/setup.histogram.rpt",
+            "images/timing/setup.histogram.png"
         ],
         "setupskew": [
             "timing/skew.setup.rpt",
@@ -99,12 +103,16 @@ def extract_metrics(chip):
         ],
         "setuppaths": [
             "timing/setup.rpt",
-            "timing/setup.topN.rpt"
+            "timing/setup.topN.rpt",
+            "timing/setup.histogram.rpt",
+            "images/timing/setup.histogram.png"
         ],
         "holdslack": [
             "timing/worst_slack.hold.rpt",
             "timing/hold.rpt",
-            "timing/hold.topN.rpt"
+            "timing/hold.topN.rpt",
+            "timing/hold.histogram.rpt",
+            "images/timing/hold.histogram.png"
         ],
         "holdskew": [
             "timing/skew.hold.rpt",
@@ -114,7 +122,9 @@ def extract_metrics(chip):
         ],
         "holdpaths": [
             "timing/hold.rpt",
-            "timing/hold.topN.rpt"
+            "timing/hold.topN.rpt",
+            "timing/hold.histogram.rpt",
+            "images/timing/hold.histogram.png"
         ],
         "unconstrained": [
             "timing/unconstrained.rpt",

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/tools/openroad/scripts/common/reports.tcl

@@ -27,6 +27,11 @@ if { [sc_cfg_tool_task_check_in_list setup var reports] } {
     tee -file reports/timing/total_negative_slack.rpt \
         "report_tns"
     report_tns_metric -setup
+
+    if { [sc_check_version 19519] } {
+        tee -quiet -file reports/timing/setup.histogram.rpt \
+            "report_timing_histogram -num_bins 20 -setup"
+    }
 }
 
 if { [sc_cfg_tool_task_check_in_list hold var reports] } {
@@ -42,6 +47,11 @@ if { [sc_cfg_tool_task_check_in_list hold var reports] } {
     report_worst_slack_metric -hold
 
     report_tns_metric -hold
+
+    if { [sc_check_version 19519] } {
+        tee -quiet -file reports/timing/hold.histogram.rpt \
+            "report_timing_histogram -num_bins 20 -hold"
+    }
 }
 
 if { [sc_cfg_tool_task_check_in_list unconstrained var reports] } {

{siliconcompiler-0.31.1 → siliconcompiler-0.32.0}/siliconcompiler/tools/openroad/scripts/common/write_images.tcl

@@ -304,6 +304,30 @@ proc sc_image_clocktree { } {
     gui::hide_widget "Clock Tree Viewer"
 }
 
+proc sc_image_timing_histograms { } {
+    if { ![sc_check_version 19526] } {
+        return
+    }
+    file mkdir reports/images/timing
+
+    if { [sc_cfg_tool_task_check_in_list setup var reports] } {
+        set path reports/images/timing/setup.histogram.png
+        utl::info FLW 1 "Saving setup timing histogram to $path"
+        save_histogram_image $path \
+            -mode setup \
+            -width 500 \
+            -height 500
+    }
+    if { [sc_cfg_tool_task_check_in_list hold var reports] } {
+        set path reports/images/timing/hold.histogram.png
+        utl::info FLW 1 "Saving hold timing histogram to $path"
+        save_histogram_image $path \
+            -mode hold \
+            -width 500 \
+            -height 500
+    }
+}
+
 proc sc_image_optimizer { } {
     global sc_design
     sc_image_setup_default
@@ -390,6 +414,9 @@ if { [sc_cfg_tool_task_check_in_list module_view var reports] } {
 # Markers
 sc_image_markers
 
+# Histograms
+sc_image_timing_histograms
+
 # Heatmaps
 if { [sc_cfg_tool_task_check_in_list placement_density var reports] } {
     sc_image_placement_density