questa.py

Go to the documentation of this file.

#  Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
#  See https://llvm.org/LICENSE.txt for license information.
#  SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
import os
from pathlib import Path
from typing import List, Optional, Callable, Dict
 
from .simulator import CosimCollateralDir, Simulator, SourceFiles
 
 
class Questa(Simulator):
  """Run and compile funcs for Questasim."""
 
  DefaultDriver = CosimCollateralDir / "driver.sv"
 
  def __init__(
      self,
      sources: SourceFiles,
      run_dir: Path,
      debug: bool,
      save_waveform: bool = False,
      run_stdout_callback: Optional[Callable[[str], None]] = None,
      run_stderr_callback: Optional[Callable[[str], None]] = None,
      compile_stdout_callback: Optional[Callable[[str], None]] = None,
      compile_stderr_callback: Optional[Callable[[str], None]] = None,
      make_default_logs: bool = True,
      macro_definitions: Optional[Dict[str, Optional[str]]] = None,
      # An optional list of questa error codes to suppress
      suppressed_questa_errors: Optional[List[int]] = None):
    super().__init__(
        sources=sources,
        run_dir=run_dir,
        debug=debug,
        save_waveform=save_waveform,
        run_stdout_callback=run_stdout_callback,
        run_stderr_callback=run_stderr_callback,
        compile_stdout_callback=compile_stdout_callback,
        compile_stderr_callback=compile_stderr_callback,
        make_default_logs=make_default_logs,
        macro_definitions=macro_definitions,
    )
    self.suppressed_questa_errors = suppressed_questa_errors
 
  # Questa doesn't use stderr for error messages. Everything goes to stdout.
  UsesStderr = False
 
  def internal_compile_commands(self) -> List[str]:
    cmds = [
        "onerror { quit -f -code 1 }",
    ]
    sources = self.sources.rtl_sources
    sources.append(Questa.DefaultDriver)
 
    # Format macro definition command
    if self.macro_definitions:
      macro_definitions_cmd = " ".join([
          f"+define+{k}={v}" if v is not None else f"+define+{k}"
          for k, v in self.macro_definitions.items()
      ])
    else:
      macro_definitions_cmd = ""
 
    # Format error suppression command
    if self.suppressed_questa_errors:
      suppressed_questa_errors_cmd = " ".join(
          [f"-suppress {ec}" for ec in self.suppressed_questa_errors])
    else:
      suppressed_questa_errors_cmd = ""
 
    acc_flag = " +acc" if self.debug else ""
    for src in sources:
      cmds.append(
          f"vlog -incr{acc_flag} -sv {macro_definitions_cmd} {suppressed_questa_errors_cmd} +define+TOP_MODULE={self.sources.top}"
          f" +define+SIMULATION {src.as_posix()}")
    cmds.append(f"vopt -incr driver -o driver_opt{acc_flag}")
    return cmds
 
  def compile_commands(self) -> List[Simulator.CompileStep]:
    with open("compile.do", "w") as f:
      for cmd in self.internal_compile_commands():
        f.write(cmd)
        f.write("\n")
      f.write("quit\n")
    return [
        ["vsim", "-batch", "-do", "compile.do"],
    ]
 
  def run_command(self, gui: bool) -> List[str]:
    vsim = "vsim"
    # Note: vsim exit codes say nothing about the test run's pass/fail even
    # if $fatal is encountered in the simulation.
    if gui:
      cmd = [
          vsim,
          "driver_opt",
      ]
    else:
      cmd = [
          vsim,
          "driver_opt",
          "-batch",
      ]
 
      if self.debug:
        # Create waveform dump .do file
        wave_file = Path("wave.do")
        with wave_file.open("w") as f:
          f.write("log -r /*\n")
        cmd += [
            "-do",
            str(wave_file.resolve()),
        ]
        # Questa will by default log to a vsim.wlf file in the current
        # directory.
        print(
            f"Debug mode enabled - waveform will be in {wave_file.resolve().parent / 'vsim.wlf'}"
        )
 
      cmd += [
          "-do",
          "run -all",
      ]
 
    for lib in self.sources.dpi_so_paths():
      svLib = os.path.splitext(lib)[0]
      cmd.append("-sv_lib")
      cmd.append(svLib)
    return cmd
 
  def run(self,
          inner_command: str,
          gui: bool = False,
          server_only: bool = False) -> int:
    """Override the Simulator.run() to add a link in the run directory (to
    the work directory) before running vsim the usual way."""
 
    # Ensure the work library is accessible from run_dir. Compiles run in a
    # different directory (e.g. a cached class compile) so we need a link/copy
    # so vsim can find it.
    workDir = self.run_dir / "work"
    compiledWork = Path(os.getcwd()) / "work"
    if not workDir.exists() and compiledWork.exists():
      if os.name == "nt":
        # os.symlink requires elevated privileges on Windows; use a junction
        # (which doesn't need them) so compiled outputs remain shared.
        import subprocess as _sp
        _sp.run(
            ["cmd", "/c", "mklink", "/J",
             str(workDir),
             str(compiledWork)],
            check=True,
            capture_output=True,
            text=True,
        )
      else:
        os.symlink(compiledWork, workDir, target_is_directory=True)
 
    # Run the simulation.
    return super().run(inner_command, gui, server_only=server_only)