Add support for Metrics simulator (DSim) to Vunit

vunit/sim_if/factory.py

@@ -14,6 +14,7 @@
 from .incisive import IncisiveInterface
 from .modelsim import ModelSimInterface
 from .rivierapro import RivieraProInterface
+from .metrics import MetricsInterface
 from . import BooleanOption, ListOfStringOption, VHDLAssertLevelOption
 
 
@@ -33,6 +34,7 @@ def supported_simulators():
             ActiveHDLInterface,
             GHDLInterface,
             IncisiveInterface,
+            MetricsInterface,
         ]
 
     def _extract_compile_options(self):

vunit/sim_if/metrics.py

@@ -0,0 +1,184 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (c) 2014-2020, Lars Asplund lars.anders.asplund@gmail.com
+
+"""
+Interface for the Metrics DSim simulator
+"""
+
+from pathlib import Path
+from os.path import relpath
+from os import environ
+import os
+import subprocess
+import logging
+from ..exceptions import CompileError
+from ..ostools import write_file, file_exists
+from ..vhdl_standard import VHDL
+from . import SimulatorInterface, run_command, ListOfStringOption
+
+LOGGER = logging.getLogger(__name__)
+
+
+class MetricsInterface(  # pylint: disable=too-many-instance-attributes
+    SimulatorInterface
+):
+    """
+    Interface for the Metrics simulator
+    """
+
+    name = "metrics"
+    executable = environ.get("DSIM_HOME", "bin")
+    supports_gui_flag = False
+
+    compile_options = [
+        ListOfStringOption("metrics.dsim_vhdl_flags"),
+        ListOfStringOption("metrics.dsim_verilog_flags"),
+    ]
+
+    sim_options = [ListOfStringOption("metrics.dsim_sim_flags")]
+
+    @staticmethod
+    def add_arguments(parser):
+        """
+        Add command line arguments
+        """
+        group = parser.add_argument_group(
+            "Metrics dsim", description="Metrics dsim-specific flags"
+        )
+        group.add_argument(
+            "-waves",
+            choices=["waves.vcd", "waves.fst"],
+            default=None,
+            help="Save .vcd or .fst",
+        )
+
+    @classmethod
+    def from_args(cls, args, output_path, **kwargs):
+        """
+        Create new instance from command line arguments object
+        """
+        return cls(
+            prefix=cls.find_prefix(),
+            output_path=output_path,
+            log_level=args.log_level,
+            gui=args.gui,
+        )
+
+    @classmethod
+    def find_prefix_from_path(cls):
+        """
+        Find Metrics simulator from PATH environment variable
+        """
+        return cls.find_toolchain(["dsim"])
+
+    @staticmethod
+    def supports_vhdl_contexts():
+        """
+        Returns True when this simulator supports VHDL 2008 contexts
+        """
+        return False
+
+    def __init__(  # pylint: disable=too-many-arguments
+        self, prefix, output_path, gui=False, log_level=None
+    ):
+        SimulatorInterface.__init__(self, output_path, gui)
+        self._prefix = prefix
+        self._libraries = []
+        self._log_level = log_level
+
+    def setup_library_mapping(self, project):
+        """
+        Setup library mapping
+        """
+        for library in project.get_libraries():
+            self._libraries.append(library)
+
+
+    def compile_source_file_command(self, source_file):
+        """
+        Returns the command to compile a single source file
+        """
+        if source_file.is_vhdl:
+            return self.compile_vhdl_file_command(source_file)
+
+        if source_file.is_any_verilog:
+            return self.compile_verilog_file_command(source_file)
+
+        raise CompileError
+
+
+    #def compile_vhdl_file_command(self, source_file):
+        """
+        Returns command to compile a VHDL file
+        """
+    # VHDL not currently supported by Metrics
+
+
+    def compile_verilog_file_command(self, source_file):
+        """
+        Returns commands to compile a Verilog file
+        """
+        cmd = str(Path(self._prefix) / "dvlcom")
+        args = []
+        args += ["-work", source_file.library.directory.rstrip(source_file.library.name)]
+        args += ["-lib", source_file.library.name]
+        args += source_file.compile_options.get("metrics.dsim_verilog_flags", [])
+        args += [
+            '-l %s'
+            % str(
+                Path(self._output_path)
+                / ("metrics_compile_verilog_file_%s.log" % source_file.library.name)
+            )
+        ]
+
+        for include_dir in source_file.include_dirs:
+            args += ['+incdir+%s' % include_dir]
+
+
+        args += ['%s' % source_file.name]
+        argsfile = str(
+            Path(self._output_path)
+            / ("metrics_compile_verilog_file_%s.args" % source_file.library.name)
+        )
+        write_file(argsfile, "\n".join(args))
+        return [cmd, "-f", argsfile]
+
+    def simulate(  # pylint: disable=too-many-locals
+            self, output_path, test_suite_name, config, elaborate_only=False):
+        """
+        Elaborates and Simulates
+        """
+
+        script_path = str(Path(output_path) / self.name)
+
+        cmd = str(Path(self._prefix) / "dsim")
+        args = []
+        args += ["-exit-on-error 1"]
+        args += config.sim_options.get("metrics.dsim_sim_flags", [])
+        args += ['-l %s' % str(Path(script_path) / ("dsim_simulate.log"))]
+
+        runner_cfg = config.generics["runner_cfg"]
+
+        for name, value in config.generics.items():
+            args += ['-defparam %s=\"%s\"' % (name, value)]
+
+        for library in self._libraries:
+            args += ['-L %s' % library.name]
+
+        args += ['-work %s' % library.directory.rstrip(library.name)]
+        args += ["+acc+b"]
+        args += ["-top %s.%s" % (config.library_name, config.entity_name)]
+
+        argsfile = "%s/dsim_simulate.args" % (script_path)
+        write_file(argsfile, "\n".join(args))
+        if not run_command(
+            [cmd, "-f", relpath(argsfile, script_path)],
+            cwd=script_path,
+            env=self.get_env(),
+        ):
+            return False
+        return True
+