dvsim 1.7.1__py3-none-any.whl → 1.7.3__py3-none-any.whl

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/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/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/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/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/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/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/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/report/data.py

@@ -4,17 +4,11 @@
 
 """Report data models."""
 
-from collections.abc import Mapping
-from datetime import datetime
-from pathlib import Path
-
 from pydantic import BaseModel, ConfigDict
 
-from dvsim.sim_results import BucketedFailures
-
 __all__ = (
     "IPMeta",
-    "ResultsSummary",
+    "ToolMeta",
 )
 
 
@@ -45,197 +39,3 @@ class ToolMeta(BaseModel):
     """Name of the tool."""
     version: str
     """Version of the tool."""
-
-
-class TestResult(BaseModel):
-    """Test result."""
-
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    max_time: float
-    """Run time."""
-    sim_time: float
-    """Simulation time."""
-
-    passed: int
-    """Number of tests passed."""
-    total: int
-    """Total number of tests run."""
-    percent: float
-    """Percentage test pass rate."""
-
-
-class Testpoint(BaseModel):
-    """Testpoint."""
-
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    tests: Mapping[str, TestResult]
-    """Test results."""
-
-    passed: int
-    """Number of tests passed."""
-    total: int
-    """Total number of tests run."""
-    percent: float
-    """Percentage test pass rate."""
-
-
-class TestStage(BaseModel):
-    """Test stages."""
-
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    testpoints: Mapping[str, Testpoint]
-    """Results by test point."""
-
-    passed: int
-    """Number of tests passed."""
-    total: int
-    """Total number of tests run."""
-    percent: float
-    """Percentage test pass rate."""
-
-
-class CodeCoverageMetrics(BaseModel):
-    """CodeCoverage metrics."""
-
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    block: float | None
-    """Block Coverage (%) - did this part of the code execute?"""
-    line_statement: float | None
-    """Line/Statement Coverage (%) - did this part of the code execute?"""
-    branch: float | None
-    """Branch Coverage (%) - did this if/case take all paths?"""
-    condition_expression: float | None
-    """Condition/Expression Coverage (%) - did the logic evaluate to 0 & 1?"""
-    toggle: float | None
-    """Toggle Coverage (%) - did the signal wiggle?"""
-    fsm: float | None
-    """FSM Coverage (%) - did the state machine transition?"""
-
-    @property
-    def average(self) -> float | None:
-        """Average code coverage (%)."""
-        all_cov = [
-            c
-            for c in [
-                self.line_statement,
-                self.branch,
-                self.condition_expression,
-                self.toggle,
-                self.fsm,
-            ]
-            if c is not None
-        ]
-
-        if len(all_cov) == 0:
-            return None
-
-        return sum(all_cov) / len(all_cov)
-
-
-class CoverageMetrics(BaseModel):
-    """Coverage metrics."""
-
-    code: CodeCoverageMetrics | None
-    """Code Coverage."""
-    assertion: float | None
-    """Assertion Coverage."""
-    functional: float | None
-    """Functional coverage."""
-
-    @property
-    def average(self) -> float | None:
-        """Average code coverage (%) or None if there is no coverage."""
-        code = self.code.average if self.code is not None else None
-        all_cov = [
-            c
-            for c in [
-                code,
-                self.assertion,
-                self.functional,
-            ]
-            if c is not None
-        ]
-
-        if len(all_cov) == 0:
-            return None
-
-        return sum(all_cov) / len(all_cov)
-
-
-class FlowResults(BaseModel):
-    """Flow results data."""
-
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    block: IPMeta
-    """IP block metadata."""
-    tool: ToolMeta
-    """Tool used in the simulation run."""
-    timestamp: datetime
-    """Timestamp for when the test ran."""
-
-    stages: Mapping[str, TestStage]
-    """Results per test stage."""
-    coverage: CoverageMetrics | None
-    """Coverage metrics."""
-
-    failed_jobs: BucketedFailures
-    """Bucketed failed job overview."""
-
-    passed: int
-    """Number of tests passed."""
-    total: int
-    """Total number of tests run."""
-    percent: float
-    """Percentage test pass rate."""
-
-    @staticmethod
-    def load(path: Path) -> "FlowResults":
-        """Load results from JSON file.
-
-        Transform the fields of the loaded JSON into a more useful schema for
-        report generation.
-
-        Args:
-            path: to the json file to load.
-
-        """
-        return FlowResults.model_validate_json(path.read_text())
-
-
-class ResultsSummary(BaseModel):
-    """Summary of results."""
-
-    model_config = ConfigDict(frozen=True, extra="forbid")
-
-    top: IPMeta
-    """Meta data for the top level config."""
-
-    timestamp: datetime
-    """Run time stamp."""
-
-    flow_results: Mapping[str, FlowResults]
-    """Flow results."""
-
-    report_path: Path
-    """Path to the report JSON file."""
-
-    @staticmethod
-    def load(path: Path) -> "ResultsSummary":
-        """Load results from JSON file.
-
-        Transform the fields of the loaded JSON into a more useful schema for
-        report generation.
-
-        Args:
-            path: to the json file to load.
-
-        Returns:
-            The loaded ResultsSummary from JSON.
-
-        """
-        return ResultsSummary.model_validate_json(path.read_text())

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."""

dvsim/sim/data.py

@@ -0,0 +1,259 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Simulation data models."""
+
+from collections.abc import Mapping
+from datetime import datetime
+from pathlib import Path
+
+from pydantic import BaseModel, ConfigDict
+
+from dvsim.report.data import IPMeta, ToolMeta
+from dvsim.sim_results import BucketedFailures
+
+__all__ = (
+    "CodeCoverageMetrics",
+    "CoverageMetrics",
+    "SimFlowResults",
+    "SimResultsSummary",
+    "TestResult",
+    "TestStage",
+    "Testpoint",
+)
+
+
+class TestResult(BaseModel):
+    """Test result."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    max_time: float
+    """Run time."""
+    sim_time: float
+    """Simulation time."""
+
+    passed: int
+    """Number of tests passed."""
+    total: int
+    """Total number of tests run."""
+    percent: float
+    """Percentage test pass rate."""
+
+
+class Testpoint(BaseModel):
+    """Testpoint."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    tests: Mapping[str, TestResult]
+    """Test results."""
+
+    passed: int
+    """Number of tests passed."""
+    total: int
+    """Total number of tests run."""
+    percent: float
+    """Percentage test pass rate."""
+
+
+class TestStage(BaseModel):
+    """Test stages."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    testpoints: Mapping[str, Testpoint]
+    """Results by test point."""
+
+    passed: int
+    """Number of tests passed."""
+    total: int
+    """Total number of tests run."""
+    percent: float
+    """Percentage test pass rate."""
+
+
+class CodeCoverageMetrics(BaseModel):
+    """CodeCoverage metrics."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    block: float | None
+    """Block Coverage (%) - did this part of the code execute?"""
+    line_statement: float | None
+    """Line/Statement Coverage (%) - did this part of the code execute?"""
+    branch: float | None
+    """Branch Coverage (%) - did this if/case take all paths?"""
+    condition_expression: float | None
+    """Condition/Expression Coverage (%) - did the logic evaluate to 0 & 1?"""
+    toggle: float | None
+    """Toggle Coverage (%) - did the signal wiggle?"""
+    fsm: float | None
+    """FSM Coverage (%) - did the state machine transition?"""
+
+    @property
+    def average(self) -> float | None:
+        """Average code coverage (%)."""
+        all_cov = [
+            c
+            for c in [
+                self.line_statement,
+                self.branch,
+                self.condition_expression,
+                self.toggle,
+                self.fsm,
+            ]
+            if c is not None
+        ]
+
+        if len(all_cov) == 0:
+            return None
+
+        return sum(all_cov) / len(all_cov)
+
+
+class CoverageMetrics(BaseModel):
+    """Coverage metrics."""
+
+    code: CodeCoverageMetrics | None
+    """Code Coverage."""
+    assertion: float | None
+    """Assertion Coverage."""
+    functional: float | None
+    """Functional coverage."""
+
+    @property
+    def average(self) -> float | None:
+        """Average code coverage (%) or None if there is no coverage."""
+        code = self.code.average if self.code is not None else None
+        all_cov = [
+            c
+            for c in [
+                code,
+                self.assertion,
+                self.functional,
+            ]
+            if c is not None
+        ]
+
+        if len(all_cov) == 0:
+            return None
+
+        return sum(all_cov) / len(all_cov)
+
+
+class FlowResults(BaseModel):
+    """Flow results data."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    block: IPMeta
+    """IP block metadata."""
+    tool: ToolMeta
+    """Tool used in the simulation run."""
+    timestamp: datetime
+    """Timestamp for when the test ran."""
+
+    stages: Mapping[str, TestStage]
+    """Results per test stage."""
+    coverage: CoverageMetrics | None
+    """Coverage metrics."""
+
+    failed_jobs: BucketedFailures
+    """Bucketed failed job overview."""
+
+    passed: int
+    """Number of tests passed."""
+    total: int
+    """Total number of tests run."""
+    percent: float
+    """Percentage test pass rate."""
+
+    @staticmethod
+    def load(path: Path) -> "FlowResults":
+        """Load results from JSON file.
+
+        Transform the fields of the loaded JSON into a more useful schema for
+        report generation.
+
+        Args:
+            path: to the json file to load.
+
+        """
+        return FlowResults.model_validate_json(path.read_text())
+
+
+class SimFlowResults(BaseModel):
+    """Flow results data."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    block: IPMeta
+    """IP block metadata."""
+    tool: ToolMeta
+    """Tool used in the simulation run."""
+    timestamp: datetime
+    """Timestamp for when the test ran."""
+
+    stages: Mapping[str, TestStage]
+    """Results per test stage."""
+    coverage: CoverageMetrics | None
+    """Coverage metrics."""
+
+    failed_jobs: BucketedFailures
+    """Bucketed failed job overview."""
+
+    passed: int
+    """Number of tests passed."""
+    total: int
+    """Total number of tests run."""
+    percent: float
+    """Percentage test pass rate."""
+
+    @staticmethod
+    def load(path: Path) -> "FlowResults":
+        """Load results from JSON file.
+
+        Transform the fields of the loaded JSON into a more useful schema for
+        report generation.
+
+        Args:
+            path: to the json file to load.
+
+        """
+        return FlowResults.model_validate_json(path.read_text())
+
+
+class SimResultsSummary(BaseModel):
+    """Summary of results."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    top: IPMeta
+    """Meta data for the top level config."""
+
+    timestamp: datetime
+    """Run time stamp."""
+
+    flow_results: Mapping[str, SimFlowResults]
+    """Flow results."""
+
+    report_path: Path
+    """Path to the report JSON file."""
+
+    @staticmethod
+    def load(path: Path) -> "SimResultsSummary":
+        """Load results from JSON file.
+
+        Transform the fields of the loaded JSON into a more useful schema for
+        report generation.
+
+        Args:
+            path: to the json file to load.
+
+        Returns:
+            The loaded ResultsSummary from JSON.
+
+        """
+        return SimResultsSummary.model_validate_json(path.read_text())

dvsim/{flow/sim.py → sim/flow.py}

@@ -7,7 +7,7 @@
 import fnmatch
 import sys
 from collections import OrderedDict, defaultdict
-from collections.abc import Sequence
+from collections.abc import Mapping, Sequence
 from datetime import datetime, timezone
 from pathlib import Path
 from typing import ClassVar
@@ -25,12 +25,24 @@ from dvsim.job.deploy import (
 from dvsim.logging import log
 from dvsim.modes import BuildMode, Mode, RunMode, find_mode
 from dvsim.regression import Regression
-from dvsim.report.data import FlowResults, IPMeta, Testpoint, TestResult, TestStage, ToolMeta
+from dvsim.sim.data import (
+    IPMeta,
+    SimFlowResults,
+    SimResultsSummary,
+    Testpoint,
+    TestResult,
+    TestStage,
+    ToolMeta,
+)
+from dvsim.sim.report import gen_block_report, gen_reports
 from dvsim.sim_results import BucketedFailures, SimResults
 from dvsim.test import Test
 from dvsim.testplan import Testplan
 from dvsim.tool.utils import get_sim_tool_plugin
 from dvsim.utils import TS_FORMAT, rm_path
+from dvsim.utils.git import git_commit_hash
+
+__all__ = ("SimCfg",)
 
 # This affects the bucketizer failure report.
 _MAX_UNIQUE_TESTS = 5
@@ -574,13 +586,83 @@ class SimCfg(FlowCfg):
         for item in self.cfgs:
             item._cov_unr()
 
+    def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
+        """Generate flow results.
+
+        Args:
+            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, SimFlowResults] = {}
+
+        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: SimFlowResults = 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 = SimResultsSummary(
+                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 _gen_json_results(
         self,
         run_results: Sequence[CompletedJobStatus],
         commit: str,
         url: str,
-    ) -> FlowResults:
-        """Generate structured FlowResults from simulation run data.
+    ) -> SimFlowResults:
+        """Generate structured SimFlowResults from simulation run data.
 
         Args:
             run_results: completed job status.
@@ -700,7 +782,7 @@ class SimCfg(FlowCfg):
         failures = BucketedFailures.from_job_status(results=run_results)
 
         # --- Final result ---
-        return FlowResults(
+        return SimFlowResults(
             block=block,
             tool=tool,
             timestamp=timestamp,

dvsim/{report/generate.py → sim/report.py}

@@ -7,7 +7,7 @@
 from pathlib import Path
 
 from dvsim.logging import log
-from dvsim.report.data import FlowResults, ResultsSummary
+from dvsim.sim.data import SimFlowResults, SimResultsSummary
 from dvsim.templates.render import render_static, render_template
 
 __all__ = (
@@ -17,7 +17,7 @@ __all__ = (
 )
 
 
-def gen_block_report(results: FlowResults, path: Path) -> None:
+def gen_block_report(results: SimFlowResults, path: Path) -> None:
     """Generate a block report.
 
     Args:
@@ -47,7 +47,7 @@ def gen_block_report(results: FlowResults, path: Path) -> None:
     )
 
 
-def gen_summary_report(summary: ResultsSummary, path: Path) -> None:
+def gen_summary_report(summary: SimResultsSummary, path: Path) -> None:
     """Generate a summary report.
 
     Args:
@@ -88,7 +88,7 @@ def gen_summary_report(summary: ResultsSummary, path: Path) -> None:
     )
 
 
-def gen_reports(summary: ResultsSummary, path: Path) -> None:
+def gen_reports(summary: SimResultsSummary, path: Path) -> None:
     """Generate a full set of reports for the given regression run.
 
     Args:

dvsim/sim/tool/__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 Tools."""

dvsim/{tool/sim.py → sim/tool/base.py}

@@ -8,7 +8,7 @@ from collections.abc import Mapping, Sequence
 from pathlib import Path
 from typing import Protocol, runtime_checkable
 
-from dvsim.report.data import CoverageMetrics
+from dvsim.sim.data import CoverageMetrics
 
 __all__ = ("SimTool",)
 

dvsim/{tool → sim/tool}/vcs.py

@@ -8,7 +8,7 @@ import re
 from collections.abc import Mapping, Sequence
 from pathlib import Path
 
-from dvsim.report.data import CodeCoverageMetrics, CoverageMetrics
+from dvsim.sim.data import CodeCoverageMetrics, CoverageMetrics
 
 __all__ = ("VCS",)
 

dvsim/{tool → sim/tool}/xcelium.py

@@ -9,7 +9,7 @@ from collections import OrderedDict
 from collections.abc import Mapping, Sequence
 from pathlib import Path
 
-from dvsim.report.data import CodeCoverageMetrics, CoverageMetrics
+from dvsim.sim.data import CodeCoverageMetrics, CoverageMetrics
 
 __all__ = ("Xcelium",)
 

dvsim/tool/utils.py

@@ -5,9 +5,9 @@
 """EDA Tool base."""
 
 from dvsim.logging import log
-from dvsim.tool.sim import SimTool
-from dvsim.tool.vcs import VCS
-from dvsim.tool.xcelium import Xcelium
+from dvsim.sim.tool.base import SimTool
+from dvsim.sim.tool.vcs import VCS
+from dvsim.sim.tool.xcelium import Xcelium
 
 __all__ = ("get_sim_tool_plugin",)
 

{dvsim-1.7.1.dist-info → dvsim-1.7.3.dist-info}/METADATA

@@ -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.dist-info → dvsim-1.7.3.dist-info}/RECORD

@@ -10,29 +10,28 @@ dvsim/test.py,sha256=lMTieXHFIGEYQRJGJFsh_cP4bZ1_EadUolRWzIVmBvs,5610
 dvsim/testplan.py,sha256=Qhne2FqlU8R9UGB5o3QOufMVh1xdbKFMhtLvjvyGyts,28389
 dvsim/testplanner.py,sha256=kvgb6iAbmfaKmOLem1crKm49eygvOQX1q79Jv5UAHe0,1326
 dvsim/cli/__init__.py,sha256=vggha7pCXj7dUK4VZChIR37MhKONBcJqt3j8l9xKM_U,238
-dvsim/cli/admin.py,sha256=vDCMYrcSD6MQTdbB1wxsjX8_96qIsOu43yddaRjXjwA,1181
+dvsim/cli/admin.py,sha256=bBnz0ZX1gd8RBTLd4CB3ZFvm08ayIjUUszI-rauxIK4,1182
 dvsim/cli/run.py,sha256=_S6ejDxGRyxMYKgNreCH6CC7vLFoJFRPmnCTPqQ6PBc,27968
 dvsim/examples/testplanner/common_testplan.hjson,sha256=IDkf3AYleDdbuEarj8FItBhg5lMgoVrfgnAMzTU9_IM,806
 dvsim/examples/testplanner/foo_dv_doc.md,sha256=AZkreUFyAehr2-6xh6Z7eRo4Eok9HFUH4TrDnByDor0,331
 dvsim/examples/testplanner/foo_sim_results.hjson,sha256=WAx9FIwS11oybfw1BU7AmY_14tRDXWtoLBxAL0ZDh8I,1642
 dvsim/examples/testplanner/foo_testplan.hjson,sha256=QQs4Egu77svReT9N3pIBSDP-xWCqoicQCo4Y_2-ZybA,2307
 dvsim/flow/__init__.py,sha256=K6yruWpqvtuLCORlnTspPxwBjsIpQhMaCfQSqqtyvTQ,185
-dvsim/flow/base.py,sha256=jUZkH0dzTnBAX8U1Hg6OaanGe6Xj9j_6bB1sSrrtytM,18946
+dvsim/flow/base.py,sha256=2Ac15oc3rDpnAFlaKabLOMSOGwyi9ReVTd9zdeoLcgs,16602
 dvsim/flow/cdc.py,sha256=87aDKAsHNDnFs4dRkclQSJ5-Pm_djY8BlSR-nzcPAMY,558
-dvsim/flow/factory.py,sha256=J4Z3b2wTLn0pd944bca0wHSCCrN3ybCFkqcEMKHOuYo,3862
-dvsim/flow/formal.py,sha256=DVu-MkKJP-bJrfskXBIfqnL_sQTbqbDRuNiLv9_QQ2E,9935
+dvsim/flow/factory.py,sha256=Wtp3o87vqbGzZwku4I2zxAizEMzNyZRgDwgj7aWjw4U,3862
+dvsim/flow/formal.py,sha256=_sJIVSPNQv9-ezDcNr35r-xJKi1HKAWlCvwI4iqb3l0,10131
 dvsim/flow/hjson.py,sha256=iKR8gAHZl1XsYNkTPaePwKSkAcPgqO8BlKNBs4ER3XY,6483
-dvsim/flow/lint.py,sha256=2HxItKwCZK9JC6irG0vfmK5XTDw3MxdmgsSRZWEbibQ,6960
-dvsim/flow/one_shot.py,sha256=5YaEQZmvO-655bl1Nhp79_gCaj_h1YYVjoah1lqRcsc,5155
+dvsim/flow/lint.py,sha256=mOfNHmbFMLl9sbulbygMK1ekfxdMWZwb8RQTKXUBadM,7144
+dvsim/flow/one_shot.py,sha256=tRW8uXMz2OEYh1IIjpGuKh3Te5DId8Kp084CLSd9NEs,6819
 dvsim/flow/rdc.py,sha256=pu7GKw-eNd3RXdhq6oFKidBOflMtr1joAokS3SosTi4,562
-dvsim/flow/sim.py,sha256=iHGrJvz321WBPetGZWq_tXACRW0R8wHaVHt_Ea1E8kg,28009
 dvsim/flow/syn.py,sha256=LnwDM6dUhxNXRoTcUCbESZ2VCpBYEFdfuur3jsojejQ,15996
 dvsim/job/__init__.py,sha256=EtF6aoKkGy3sxCsfQMm2MAHgjYknmI1No90xvyjXRpY,186
 dvsim/job/data.py,sha256=dsc4bnAvTMW74m8QItCGMKJTyXa50fjTWngPtkw2lUc,4460
-dvsim/job/deploy.py,sha256=0J7suzihsKiFabJ5nlsa0d2hJGqO6salX11ATPfZz-A,31388
+dvsim/job/deploy.py,sha256=Ec5pmsGOtxGnwcAq4qh7b2B6URjlejyf6jLNwZo_aVg,31477
 dvsim/job/time.py,sha256=RLQn16cIEGRKmRf5bQC1h1P8SaSBAIjvynyDyYrKUrY,5369
 dvsim/launcher/__init__.py,sha256=P-A-eAsx-3Nz4b3mnautm9fGV02qVelwBrNX_PGfOUw,188
-dvsim/launcher/base.py,sha256=adjA2_XBurCiMUWrB0vmAQIejhpwntmHNs50Ybzv6g0,15099
+dvsim/launcher/base.py,sha256=TitiE4BTTkg0hcT-cKL9neYD6oudZXC0FpOGN_WpTfM,15027
 dvsim/launcher/factory.py,sha256=zs4bJ4n2TeWbbVk1IRXAazC5viNg4mPUITofP0fqHEc,2620
 dvsim/launcher/fake.py,sha256=ODtwNOzgaGYklPQPy3J69uWOlWbMGUw67sAmWQoENHQ,2426
 dvsim/launcher/local.py,sha256=eoCYkmkm-uS-zezVn4oRp7OuTwCnWr20ewtUFnxFmg8,6816
@@ -46,8 +45,15 @@ dvsim/launcher/sge/qsubopts.py,sha256=RxjgULUI_JDrdsn1VxQnBSxW0Z-4nfzP8w6l9x3tm6
 dvsim/linting/__init__.py,sha256=SOXGwiOyg_dBPIHSFwctNLKk2M84jXpDpZjjGyPmcPA,183
 dvsim/linting/parser.py,sha256=19o4F5YTh43u1s9Hx7nPeGujYgo61v44JHpPiy-e-Hw,3722
 dvsim/report/__init__.py,sha256=m58UrZ_U3jKI0QlB3r6cGdRb-QfgzN7t0udJpYa2DMs,196
-dvsim/report/data.py,sha256=MC9Apc3H7Cd3k0ykaJ9b3EsdZc-nfTnUaIsSPoHkesM,5829
-dvsim/report/generate.py,sha256=2zDJkMmpb71tlMxhopMq2vV_XDhOw2r5krSI0nZ4btQ,2634
+dvsim/report/data.py,sha256=Li_FSIPT7yEdF5buLLEbx7DnTX3eHf1UZ5aBHk6C5Es,935
+dvsim/sim/__init__.py,sha256=XU7GhNkaQxhHqsO_P5XDXnWURcT27iScKg630EQLJ40,195
+dvsim/sim/data.py,sha256=J1PkWk2ivFZm0FLUmLexGb3KAAhgnT51KDE6oZ1FqNM,6369
+dvsim/sim/flow.py,sha256=h1-zgd3_yGhODwD0EcKoknGU8xeVeWMb3uc1apQ1YI8,30552
+dvsim/sim/report.py,sha256=ljpmFu_ln3plZyhNs2X2_xkRFqERk5Txhn_zXvFl4fU,2646
+dvsim/sim/tool/__init__.py,sha256=VCe2PQYQUkthjXjbSVSxNALwO1t0Y6mVW6eszl_JtW4,192
+dvsim/sim/tool/base.py,sha256=HQJDapJQEf6GsPGJPDsNpNA4omk7i0CqzzxT27-ytjk,2573
+dvsim/sim/tool/vcs.py,sha256=qRxvr8KVaNJrcshPqpbwhCuyKq8o7dbb3X4cHh8wYSo,4813
+dvsim/sim/tool/xcelium.py,sha256=z_fbSODH7IGI-5ivZQ1WPlideY9Qo2OcMra0HlJNpOM,6155
 dvsim/templates/__init__.py,sha256=vZhkgLLCkdOPjOK_wGaa2AqDLs2fZLuc3_TJK62ttA8,195
 dvsim/templates/render.py,sha256=uAc798QYvZJBugTl53XFz1nft8ZK_YFsyIK0oQWWErQ,1582
 dvsim/templates/reports/__init__.py,sha256=eu0aBRe908Or6yAc4K61fuxUx-48lhjqBpsslUtn5Z8,192
@@ -62,11 +68,8 @@ dvsim/templates/static/js/htmx.min.js,sha256=Iig-9oy3VFkU8KiKG97cclanA9HVgMHSVSF
 dvsim/tool/__init__.py,sha256=Y8HxxxI8UTJGDg07FFytr1pVujdBsbtHulthnEOZHcI,197
 dvsim/tool/ascentlint.py,sha256=reBueV8vqEgwwmcbBNncVM4Z4fAFqxqRzLv5rVgcCh8,4047
 dvsim/tool/meridianrdc.py,sha256=RKAhQ5Rk6SfSc3DurZTQJP36qSpSAIej42plGq5ApL0,9675
-dvsim/tool/sim.py,sha256=mttJ57FS16vXN6_r8NAFBieCjDDlNcXw-4oYaNXfQA0,2576
-dvsim/tool/utils.py,sha256=bBK-y1PjTzuOBoEUsCjW7XcAkHKd5fcXFWGv9060ktI,834
-dvsim/tool/vcs.py,sha256=G1J8N_8xQ0VHDGle16RtVhcTCanOYPtTol4rlOAs34E,4816
+dvsim/tool/utils.py,sha256=lxLO1f0DdeATzW1XMQuJfzKOLVrmpyTD9lmgAmZM5U4,847
 dvsim/tool/verilator.py,sha256=MQykIh1Ua7PcCHmwxLaieuDx43B48bNWrJ_oviVHtQs,3655
-dvsim/tool/xcelium.py,sha256=T0X3H6_DP34jmi6IKha6S3LLbtnP9rt0qybljmcu_dk,6158
 dvsim/utils/__init__.py,sha256=UYFviDvztoGOBA6btN9xBCwRhaaagK45X4M0Kc1xQwU,1102
 dvsim/utils/check.py,sha256=b8bu_0zJHk4ieD5erlGfaG2F1GiDwadAvqB6kW4mOsU,994
 dvsim/utils/fs.py,sha256=NqPmnRlP8l2l1Cy3nAkLsPvEn_o2yQavP5dsUanQ_ZU,3859
@@ -77,8 +80,8 @@ dvsim/utils/status_printer.py,sha256=azwNWS83rI-h7OfOYPIj-Sy46aIz35L3y_Yiwkx60ZE
 dvsim/utils/subprocess.py,sha256=8jje9hmwZ_JH0zQ8JNwhsNldntgI3_SF6L5SUHQ9luo,1829
 dvsim/utils/timer.py,sha256=jD4R3wB_rBxaefiMr-k34aH325xdcoqtHHRCtSczSC8,1604
 dvsim/utils/wildcards.py,sha256=5WkByZLHyPlo5lD4rIXPuDjjrhrWqNpcTYxmQ5k294o,11701
-dvsim-1.7.1.dist-info/METADATA,sha256=d_FTuXXFCRV0937tGYDBw-TryFith5clFPfeYroX-9k,5882
-dvsim-1.7.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-dvsim-1.7.1.dist-info/entry_points.txt,sha256=6A-YOJ6XYbedSfSJ5dP56lRkoHYrLanJt0AYNH9w3r0,75
-dvsim-1.7.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dvsim-1.7.1.dist-info/RECORD,,
+dvsim-1.7.3.dist-info/METADATA,sha256=9iJYwxkuL0MfHfxrNtL1hBLXgzKpGrmDJJCCtFternM,5882
+dvsim-1.7.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+dvsim-1.7.3.dist-info/entry_points.txt,sha256=6A-YOJ6XYbedSfSJ5dP56lRkoHYrLanJt0AYNH9w3r0,75
+dvsim-1.7.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dvsim-1.7.3.dist-info/RECORD,,