dvsim 1.7.1__tar.gz → 1.7.3__tar.gz

{dvsim-1.7.1 → dvsim-1.7.3}/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 <!-- version list -->
 
+## v1.7.3 (2026-01-21)
+
+### Bug Fixes
+
+- Formal flow
+  ([`bd28563`](https://github.com/lowRISC/dvsim/commit/bd2856360b8ca5355e860f7fb9c3d3888d4663e8))
+
+
+## v1.7.2 (2026-01-21)
+
+### Bug Fixes
+
+- Hacky workaround for sim centric code
+  ([`596d92f`](https://github.com/lowRISC/dvsim/commit/596d92fa4b0e69bf69b3b23e086db0ba72e3d0aa))
+
+- Restore the lint flow old style report
+  ([`85d8550`](https://github.com/lowRISC/dvsim/commit/85d8550db2fb4f3404ac6c96dc8baf64e8fd44bb))
+
+### Refactoring
+
+- Move sim related modules to top level package
+  ([`9e31623`](https://github.com/lowRISC/dvsim/commit/9e31623a722e3ef4e500dc83072c49f5da803fd0))
+
+
 ## v1.7.1 (2026-01-08)
 
 ### Bug Fixes

{dvsim-1.7.1 → dvsim-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dvsim
-Version: 1.7.1
+Version: 1.7.3
 Summary: DV system
 Author: lowRISC contributors (OpenTitan project)
 License-File: LICENSE

{dvsim-1.7.1 → dvsim-1.7.3}/pyproject.toml

@@ -8,7 +8,7 @@
 
 [project]
 name = "dvsim"
-version = "1.7.1"
+version = "1.7.3"
 description = "DV system"
 authors = [{name = "lowRISC contributors (OpenTitan project)"}]
 readme = "README.md"

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/cli/admin.py

@@ -35,9 +35,9 @@ def report() -> None:
 )
 def gen(json_path: Path, output_dir: Path) -> None:
     """Generate a report from a existing results JSON."""
-    from dvsim.report.data import ResultsSummary
-    from dvsim.report.generate import gen_reports
+    from dvsim.sim.data import SimResultsSummary
+    from dvsim.sim.report import gen_reports
 
-    results: ResultsSummary = ResultsSummary.load(path=json_path)
+    results: SimResultsSummary = SimResultsSummary.load(path=json_path)
 
     gen_reports(summary=results, path=output_dir)

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/flow/base.py

@@ -10,7 +10,6 @@ import pprint
 import sys
 from abc import ABC, abstractmethod
 from collections.abc import Mapping, Sequence
-from datetime import datetime, timezone
 from pathlib import Path
 from typing import TYPE_CHECKING, ClassVar
 
@@ -20,15 +19,12 @@ from dvsim.flow.hjson import set_target_attribute
 from dvsim.job.data import CompletedJobStatus
 from dvsim.launcher.factory import get_launcher_cls
 from dvsim.logging import log
-from dvsim.report.data import FlowResults, IPMeta, ResultsSummary
-from dvsim.report.generate import gen_block_report, gen_reports
 from dvsim.scheduler import Scheduler
 from dvsim.utils import (
     find_and_substitute_wildcards,
     rm_path,
     subst_wildcards,
 )
-from dvsim.utils.git import git_commit_hash
 
 if TYPE_CHECKING:
     from dvsim.job.deploy import Deploy
@@ -447,6 +443,7 @@ class FlowCfg(ABC):
             interactive=self.interactive,
         ).run()
 
+    @abstractmethod
     def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
         """Generate flow results.
 
@@ -454,68 +451,6 @@ class FlowCfg(ABC):
             results: completed job status objects.
 
         """
-        reports_dir = Path(self.scratch_base_path) / "reports"
-        commit = git_commit_hash(path=Path(self.proj_root))
-        url = f"https://github.com/lowrisc/opentitan/tree/{commit}"
-
-        all_flow_results: Mapping[str, FlowResults] = {}
-
-        for item in self.cfgs:
-            item_results = [
-                res
-                for res in results
-                if res.block.name == item.name and res.block.variant == item.variant
-            ]
-
-            flow_results: FlowResults = item._gen_json_results(
-                run_results=item_results,
-                commit=commit,
-                url=url,
-            )
-
-            # Convert to lowercase to match filename
-            block_result_index = (
-                f"{item.name}_{item.variant}" if item.variant else item.name
-            ).lower()
-
-            all_flow_results[block_result_index] = flow_results
-
-            # Generate the block's JSON/HTML reports to the report area.
-            gen_block_report(
-                results=flow_results,
-                path=reports_dir,
-            )
-
-            self.errors_seen |= item.errors_seen
-
-        if self.is_primary_cfg:
-            # The timestamp for this run has been taken with `utcnow()` and is
-            # stored in a custom format.  Store it in standard ISO format with
-            # explicit timezone annotation.
-            timestamp = (
-                datetime.strptime(self.timestamp, "%Y%m%d_%H%M%S")
-                .replace(tzinfo=timezone.utc)
-                .isoformat()
-            )
-
-            results_summary = ResultsSummary(
-                top=IPMeta(
-                    name=self.name,
-                    variant=self.variant,
-                    commit=commit,
-                    branch=self.branch,
-                    url=url,
-                ),
-                timestamp=timestamp,
-                flow_results=all_flow_results,
-                report_path=reports_dir,
-            )
-
-            # Generate all the JSON/HTML reports to the report area.
-            gen_reports(
-                summary=results_summary,
-                path=reports_dir,
-            )
 
     def has_errors(self) -> bool:
         """Return error state."""

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/flow/factory.py

@@ -11,9 +11,9 @@ from dvsim.flow.formal import FormalCfg
 from dvsim.flow.hjson import load_hjson
 from dvsim.flow.lint import LintCfg
 from dvsim.flow.rdc import RdcCfg
-from dvsim.flow.sim import SimCfg
 from dvsim.flow.syn import SynCfg
 from dvsim.logging import log
+from dvsim.sim.flow import SimCfg
 
 FLOW_HANDLERS = {
     "cdc": CdcCfg,

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/flow/formal.py

@@ -2,12 +2,14 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 
+from collections.abc import Sequence
 from pathlib import Path
 
 import hjson
 from tabulate import tabulate
 
 from dvsim.flow.one_shot import OneShotCfg
+from dvsim.job.data import CompletedJobStatus
 from dvsim.logging import log
 from dvsim.utils import subst_wildcards
 
@@ -176,41 +178,47 @@ class FormalCfg(OneShotCfg):
 
         return self.results_summary_md
 
-    def _gen_results(self, results):
-        # This function is called after the regression and looks for
-        # results.hjson file with aggregated results from the formal logfile.
-        # The hjson file is required to follow this format:
-        # {
-        #   "messages": {
-        #      "errors"      : []
-        #      "warnings"    : []
-        #      "cex"         : ["property1", "property2"...],
-        #      "undetermined": [],
-        #      "unreachable" : [],
-        #   },
-        #
-        #   "summary": {
-        #      "errors"      : 0
-        #      "warnings"    : 2
-        #      "proven"      : 20,
-        #      "cex"         : 5,
-        #      "covered"     : 18,
-        #      "undetermined": 7,
-        #      "unreachable" : 2,
-        #      "pass_rate"   : "90 %",
-        #      "cover_rate"  : "90 %"
-        #   },
-        # }
-        # The categories for property results are: proven, cex, undetermined,
-        # covered, and unreachable.
-        #
-        # If coverage was enabled then results.hjson will also have an item that
-        # shows formal coverage. It will have the following format:
-        #   "coverage": {
-        #      formal:  "90 %",
-        #      stimuli: "90 %",
-        #      checker: "80 %"
-        #   }
+    def _gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
+        """Generate results.
+
+        This function is called after the regression and looks for
+        results.hjson file with aggregated results from the formal logfile.
+        The hjson file is required to follow this format:
+        {
+          "messages": {
+             "errors"      : []
+             "warnings"    : []
+             "cex"         : ["property1", "property2"...],
+             "undetermined": [],
+             "unreachable" : [],
+          },
+
+          "summary": {
+             "errors"      : 0
+             "warnings"    : 2
+             "proven"      : 20,
+             "cex"         : 5,
+             "covered"     : 18,
+             "undetermined": 7,
+             "unreachable" : 2,
+             "pass_rate"   : "90 %",
+             "cover_rate"  : "90 %"
+          },
+        }
+        The categories for property results are: proven, cex, undetermined,
+        covered, and unreachable.
+
+        If coverage was enabled then results.hjson will also have an item that
+        shows formal coverage. It will have the following format:
+          "coverage": {
+             formal:  "90 %",
+             stimuli: "90 %",
+             checker: "80 %"
+          }
+        """
+        # There should be just one job that has run for this config.
+        complete_job = results[0]
+
         results_str = "## " + self.results_title + "\n\n"
         results_str += "### " + self.timestamp_long + "\n"
         if self.revision:
@@ -222,7 +230,7 @@ class FormalCfg(OneShotCfg):
         assert len(self.deploy) == 1
         mode = self.deploy[0]
 
-        if results[mode] == "P":
+        if complete_job.status == "P":
             result_data = Path(
                 subst_wildcards(self.build_dir, {"build_mode": mode.name}),
                 "results.hjson",
@@ -254,8 +262,8 @@ class FormalCfg(OneShotCfg):
         else:
             summary += ["N/A", "N/A", "N/A"]
 
-        if results[mode] != "P":
-            results_str += "\n## List of Failures\n" + "".join(mode.launcher.fail_msg.message)
+        if complete_job.status != "P":
+            results_str += "\n## List of Failures\n" + "".join(complete_job.fail_msg.message)
 
         messages = self.result.get("messages")
         if messages is not None:

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/flow/lint.py

@@ -4,11 +4,13 @@
 
 """Class describing lint configuration object."""
 
+from collections.abc import Sequence
 from pathlib import Path
 
 from tabulate import tabulate
 
 from dvsim.flow.one_shot import OneShotCfg
+from dvsim.job.data import CompletedJobStatus
 from dvsim.logging import log
 from dvsim.msg_buckets import MsgBuckets
 from dvsim.utils import check_bool, subst_wildcards
@@ -76,7 +78,10 @@ class LintCfg(OneShotCfg):
 
         keys = self.totals.get_keys(self.report_severities)
         for cfg in self.cfgs:
-            name_with_link = cfg._get_results_page_link(self.results_dir)
+            link_text = self.name.upper()
+            relative_link = Path(self.results_dir) / self.results_page
+
+            name_with_link = f"[{link_text}]({relative_link})"
 
             row = [name_with_link]
             row += cfg.result_summary.get_counts_md(keys)
@@ -96,26 +101,26 @@ class LintCfg(OneShotCfg):
 
     # TODO(#9079): This way of parsing out messages into an intermediate
     # results.hjson file will be replaced by a native parser mechanism.
-    def _gen_results(self, results):
-        # '''
-        # The function is called after the regression has completed. It looks
-        # for a results.hjson file with aggregated results from the lint run.
-        # The hjson needs to have the following format:
-        #
-        # {
-        #     bucket_key: [str],
-        #     // other buckets according to message_buckets configuration
-        # }
-        #
-        # Each bucket key points to a list of signatures (strings).
-        # The bucket categories and severities are defined in the
-        # message_buckets class variable, and can be set via Hjson Dvsim
-        # config files.
-        #
-        # Note that if this is a primary config, the results will
-        # be generated using the _gen_results_summary function
-        # '''
-
+    def _gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
+        """Generate results.
+
+        The function is called after the regression has completed. It looks
+        for a results.hjson file with aggregated results from the lint run.
+        The hjson needs to have the following format:
+
+        {
+            bucket_key: [str],
+            // other buckets according to message_buckets configuration
+        }
+
+        Each bucket key points to a list of signatures (strings).
+        The bucket categories and severities are defined in the
+        message_buckets class variable, and can be set via Hjson Dvsim
+        config files.
+
+        Note that if this is a primary config, the results will
+        be generated using the _gen_results_summary function
+        """
         # Generate results table for runs.
         results_str = f"## {self.results_title}\n\n"
         results_str += f"### {self.timestamp_long}\n"

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/flow/one_shot.py

@@ -4,10 +4,13 @@
 
 """Class describing a one-shot build configuration object."""
 
-import pathlib
+from abc import abstractmethod
 from collections import OrderedDict
+from collections.abc import Sequence
+from pathlib import Path
 
 from dvsim.flow.base import FlowCfg
+from dvsim.job.data import CompletedJobStatus
 from dvsim.job.deploy import CompileOneShot
 from dvsim.logging import log
 from dvsim.modes import BuildMode, Mode
@@ -15,9 +18,7 @@ from dvsim.utils import rm_path
 
 
 class OneShotCfg(FlowCfg):
-    """Simple one-shot build flow for non-simulation targets like
-    linting, synthesis and FPV.
-    """
+    """Simple one-shot build flow for non-simulation targets like linting, synthesis and FPV."""
 
     ignored_wildcards = [*FlowCfg.ignored_wildcards, "build_mode", "index", "test"]
 
@@ -134,8 +135,10 @@ class OneShotCfg(FlowCfg):
     def _create_dirs(self) -> None:
         """Create initial set of directories."""
         for link in self.links:
-            rm_path(self.links[link])
-            pathlib.Path(self.links[link]).mkdir(parents=True)
+            link_path = Path(self.links[link])
+
+            rm_path(link_path)
+            link_path.mkdir(parents=True)
 
     def _create_deploy_objects(self) -> None:
         """Create deploy objects from build modes."""
@@ -149,3 +152,49 @@ class OneShotCfg(FlowCfg):
 
         # Create initial set of directories before kicking off the regression.
         self._create_dirs()
+
+    @abstractmethod
+    def _gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
+        """Generate results for this config."""
+
+    @abstractmethod
+    def gen_results_summary(self):
+        """Gathers the aggregated results from all sub configs."""
+
+    def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
+        """Generate flow results.
+
+        Args:
+            results: completed job status objects.
+
+        """
+        for item in self.cfgs:
+            project = item.name
+
+            item_results = [
+                res
+                for res in results
+                if res.block.name == item.name and res.block.variant == item.variant
+            ]
+
+            result = item._gen_results(item_results)
+
+            log.info("[results]: [%s]:\n%s\n", project, result)
+            log.info("[scratch_path]: [%s] [%s]", project, item.scratch_path)
+
+            # TODO: Implement HTML report using templates
+
+            results_dir = Path(self.results_dir)
+            results_dir.mkdir(exist_ok=True, parents=True)
+
+            # (results_dir / self.results_html_name).write_text(
+            #     md_results_to_html(self.results_title, self.css_file, item.results_md)
+            # )
+
+            log.verbose("[report]: [%s] [%s/report.html]", project, item.results_dir)
+
+            self.errors_seen |= item.errors_seen
+
+        if self.is_primary_cfg:
+            self.gen_results_summary()
+            # self.write_results(self.results_html_name, self.results_summary_md)

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/job/deploy.py

@@ -74,6 +74,10 @@ class Deploy:
         # Cross ref the whole cfg object for ease.
         self.sim_cfg = sim_cfg
         self.flow = sim_cfg.name
+
+        if not hasattr(self.sim_cfg, "variant"):
+            self.sim_cfg.variant = ""
+
         self._variant_suffix = f"_{self.sim_cfg.variant}" if self.sim_cfg.variant else ""
 
         # A list of jobs on which this job depends.

{dvsim-1.7.1 → dvsim-1.7.3}/src/dvsim/launcher/base.py

@@ -339,25 +339,28 @@ class Launcher(ABC):
         # since it is devoid of the delays incurred due to infrastructure and
         # setup overhead.
 
-        plugin = get_sim_tool_plugin(tool=self.job_spec.tool.name)
+        time = self.job_runtime_secs
+        unit = "s"
+
+        if self.job_spec.job_type in [
+            "CompileSim",
+            "RunTest",
+            "CovUnr",
+            "CovMerge",
+            "CovReport",
+            "CovAnalyze",
+        ]:
+            plugin = get_sim_tool_plugin(tool=self.job_spec.tool.name)
 
-        try:
-            time, unit = plugin.get_job_runtime(log_text=lines)
-            self.job_runtime.set(time, unit)
-
-        except RuntimeError as e:
-            log.warning(
-                f"{self.job_spec.full_name}: {e} Using dvsim-maintained job_runtime instead."
-            )
-            self.job_runtime.set(self.job_runtime_secs, "s")
-
-        if self.job_spec.job_type == "RunTest":
             try:
-                time, unit = plugin.get_simulated_time(log_text=lines)
-                self.simulated_time.set(time, unit)
+                time, unit = plugin.get_job_runtime(log_text=lines)
 
             except RuntimeError as e:
-                log.debug(f"{self.job_spec.full_name}: {e}")
+                log.warning(
+                    f"{self.job_spec.full_name}: {e} Using dvsim-maintained job_runtime instead."
+                )
+
+        self.job_runtime.set(time, unit)
 
         if chk_failed or chk_passed:
             for cnt, line in enumerate(lines):

dvsim-1.7.3/src/dvsim/report/data.py

@@ -0,0 +1,41 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Report data models."""
+
+from pydantic import BaseModel, ConfigDict
+
+__all__ = (
+    "IPMeta",
+    "ToolMeta",
+)
+
+
+class IPMeta(BaseModel):
+    """Meta data for an IP block."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    name: str
+    """Name of the IP."""
+    variant: str | None = None
+    """Variant of the IP if there is one."""
+
+    commit: str
+    """Git commit sha of the IP the tests are run against."""
+    branch: str
+    """Git branch"""
+    url: str
+    """URL to where the IP can be found in git (e.g. github)."""
+
+
+class ToolMeta(BaseModel):
+    """Meta data for an EDA tool."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    name: str
+    """Name of the tool."""
+    version: str
+    """Version of the tool."""

dvsim-1.7.3/src/dvsim/sim/__init__.py

@@ -0,0 +1,5 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Simulation workflow."""