dvsim 1.7.2__py3-none-any.whl → 1.7.4__py3-none-any.whl

dvsim/cli/admin.py

@@ -4,12 +4,14 @@
 
 """DVSim CLI main entry point."""
 
+from importlib.metadata import version
 from pathlib import Path
 
 import click
 
 
 @click.group()
+@click.version_option(version("dvsim"))
 def cli() -> None:
     """DVSim Administration tool.
 

dvsim/cli/run.py

@@ -28,6 +28,7 @@ import shlex
 import subprocess
 import sys
 import textwrap
+from importlib.metadata import version
 from pathlib import Path
 
 from dvsim.flow.factory import make_cfg
@@ -43,9 +44,6 @@ from dvsim.launcher.slurm import SlurmLauncher
 from dvsim.logging import configure_logging, log
 from dvsim.utils import TS_FORMAT, TS_FORMAT_LONG, Timer, rm_path, run_cmd_with_timeout
 
-# TODO: add dvsim_cfg.hjson to retrieve this info
-version = 0.1
-
 # The different categories that can be passed to the --list argument.
 _LIST_CATEGORIES = ["build_modes", "run_modes", "tests", "regressions"]
 
@@ -298,7 +296,7 @@ def parse_args():
 
     parser.add_argument("cfg", metavar=cfg_metavar, help="""Configuration hjson file.""")
 
-    parser.add_argument("--version", action="store_true", help="Print version and exit")
+    parser.add_argument("--version", action="version", version=version("dvsim"))
 
     parser.add_argument(
         "--tool",
@@ -794,9 +792,6 @@ def parse_args():
 
     args = parser.parse_args()
 
-    if args.version:
-        sys.exit()
-
     # Check conflicts
     # interactive and remote, r
     if args.interactive and args.remote:

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
@@ -99,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

@@ -154,7 +154,7 @@ class OneShotCfg(FlowCfg):
         self._create_dirs()
 
     @abstractmethod
-    def _gen_results(self):
+    def _gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
         """Generate results for this config."""
 
     @abstractmethod

{dvsim-1.7.2.dist-info → dvsim-1.7.4.dist-info}/METADATA

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

{dvsim-1.7.2.dist-info → dvsim-1.7.4.dist-info}/RECORD

@@ -10,8 +10,8 @@ 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=bBnz0ZX1gd8RBTLd4CB3ZFvm08ayIjUUszI-rauxIK4,1182
-dvsim/cli/run.py,sha256=_S6ejDxGRyxMYKgNreCH6CC7vLFoJFRPmnCTPqQ6PBc,27968
+dvsim/cli/admin.py,sha256=wyN1WAmsJUTAZwCL-aGC_1ILrCyRdYZGeXCWmxy0An0,1261
+dvsim/cli/run.py,sha256=sgf0Qa8UJLU7kPUAUbOi6-t3sHTGAmPmWBmf607rjnI,27893
 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
@@ -20,10 +20,10 @@ dvsim/flow/__init__.py,sha256=K6yruWpqvtuLCORlnTspPxwBjsIpQhMaCfQSqqtyvTQ,185
 dvsim/flow/base.py,sha256=2Ac15oc3rDpnAFlaKabLOMSOGwyi9ReVTd9zdeoLcgs,16602
 dvsim/flow/cdc.py,sha256=87aDKAsHNDnFs4dRkclQSJ5-Pm_djY8BlSR-nzcPAMY,558
 dvsim/flow/factory.py,sha256=Wtp3o87vqbGzZwku4I2zxAizEMzNyZRgDwgj7aWjw4U,3862
-dvsim/flow/formal.py,sha256=DVu-MkKJP-bJrfskXBIfqnL_sQTbqbDRuNiLv9_QQ2E,9935
+dvsim/flow/formal.py,sha256=_sJIVSPNQv9-ezDcNr35r-xJKi1HKAWlCvwI4iqb3l0,10131
 dvsim/flow/hjson.py,sha256=iKR8gAHZl1XsYNkTPaePwKSkAcPgqO8BlKNBs4ER3XY,6483
-dvsim/flow/lint.py,sha256=YeLR8eegChWWkJj-jMtzqZp6VWN8grbuxz4kclaN9us,7063
-dvsim/flow/one_shot.py,sha256=qtbqQvql_VMoO33lfEz9qM7aGpr_CKSG4nXA1gbooBQ,6772
+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/syn.py,sha256=LnwDM6dUhxNXRoTcUCbESZ2VCpBYEFdfuur3jsojejQ,15996
 dvsim/job/__init__.py,sha256=EtF6aoKkGy3sxCsfQMm2MAHgjYknmI1No90xvyjXRpY,186
@@ -80,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.2.dist-info/METADATA,sha256=Mpw4nSelVLJwKDLZjhN6NW26vtic8yVcbH1mNyxARFM,5882
-dvsim-1.7.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-dvsim-1.7.2.dist-info/entry_points.txt,sha256=6A-YOJ6XYbedSfSJ5dP56lRkoHYrLanJt0AYNH9w3r0,75
-dvsim-1.7.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dvsim-1.7.2.dist-info/RECORD,,
+dvsim-1.7.4.dist-info/METADATA,sha256=54RR4UKrC5rDrQjZdddXYgCnT10beId7HvPt8_uYhzM,5882
+dvsim-1.7.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+dvsim-1.7.4.dist-info/entry_points.txt,sha256=6A-YOJ6XYbedSfSJ5dP56lRkoHYrLanJt0AYNH9w3r0,75
+dvsim-1.7.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dvsim-1.7.4.dist-info/RECORD,,