esiaccel 0.1.5.dev147__cp311-cp311-win_amd64.whl → 0.1.5.dev164__cp311-cp311-win_amd64.whl

esiaccel/cosim/Cosim_Endpoint.sv

@@ -9,6 +9,8 @@
 // Package: Cosim_DpiPkg
 //
 // Main cosim <--> dpi bridge module.
+
+
 //
 //===----------------------------------------------------------------------===//
 
@@ -118,9 +120,8 @@ module Cosim_Endpoint_FromHost
       $error("Cosim endpoint (%s) register failed: %d", ENDPOINT_ID, rc);
   end
 
-  /// *******************
-  /// Data out management.
-  ///
+  /// ***********************
+  /// Useful constants.
 
   localparam int FROM_HOST_SIZE_BYTES = int'((FROM_HOST_SIZE_BITS+7)/8);
   // The number of bits over a byte.
@@ -129,13 +130,30 @@ module Cosim_Endpoint_FromHost
   localparam int FROM_HOST_SIZE_BYTES_FLOOR_IN_BITS
       = FROM_HOST_SIZE_BYTES_FLOOR * 8;
 
+  // Buffer to hold incoming data directly from the DPI calls.
   byte unsigned DataOutBuffer[FROM_HOST_SIZE_BYTES-1:0];
+
+  // Pipeline interface signals for buffering DataOut.
+  // DataOut_a_valid is asserted when a complete message is available in
+  // DataOut_a buffer and waiting to be accepted by the skid buffer.
+  logic DataOut_a_valid;
+  // Packed representation of the byte buffer to feed the skid input.
+  logic [FROM_HOST_SIZE_BITS-1:0] DataOut_a;
+  // Ready/valid wires between this module and the skid buffer.
+  wire DataOut_a_ready;
+  wire DataOut_x_valid;
+  wire [FROM_HOST_SIZE_BITS-1:0] DataOut_x;
+
   always @(posedge clk) begin
     if (~rst) begin
-      if (DataOutValid && DataOutReady) // A transfer occurred.
-        DataOutValid <= 1'b0;
-
-      if (!DataOutValid || DataOutReady) begin
+      // If the skid buffer accepted the input token this cycle, clear the
+      // internal valid that indicates we have buffered data.
+      if (DataOut_a_valid && DataOut_a_ready)
+        DataOut_a_valid <= 1'b0;
+
+      // Only attempt to fetch data from the host when the skid buffer can
+      // accept it (DataOut_a_ready).
+      if (!DataOut_a_valid && DataOut_a_ready) begin
         int data_limit;
         int rc;
 
@@ -149,7 +167,7 @@ module Cosim_Endpoint_FromHost
             ENDPOINT_ID, FROM_HOST_SIZE_BYTES, data_limit, rc);
         end else if (rc == 0) begin
           if (data_limit == FROM_HOST_SIZE_BYTES)
-            DataOutValid <= 1'b1;
+            DataOut_a_valid <= 1'b1;
           else if (data_limit == 0)
             begin end // No message.
           else
@@ -159,24 +177,53 @@ module Cosim_Endpoint_FromHost
         end
       end
     end else begin
-      DataOutValid <= 1'b0;
+      DataOut_a_valid <= 1'b0;
     end
   end
 
-  // Assign packed output bit array from unpacked byte array.
+  // Pack the byte array into a single vector that will be handed to the
+  // skid buffer as its input payload.
   genvar iOut;
   generate
     for (iOut=0; iOut<FROM_HOST_SIZE_BYTES_FLOOR; iOut++)
-      assign DataOut[((iOut+1)*8)-1:iOut*8] = DataOutBuffer[iOut];
+      assign DataOut_a[((iOut+1)*8)-1:iOut*8] = DataOutBuffer[iOut];
     if (FROM_HOST_SIZE_BITS_DIFF != 0)
-      // If the type is not a multiple of 8, we've got to copy the extra bits.
-      assign DataOut[(FROM_HOST_SIZE_BYTES_FLOOR_IN_BITS +
-                      FROM_HOST_SIZE_BITS_DIFF - 1) :
-                        FROM_HOST_SIZE_BYTES_FLOOR_IN_BITS]
+      // If the type is not a multiple of 8, copy the extra bits.
+      assign DataOut_a[(FROM_HOST_SIZE_BYTES_FLOOR_IN_BITS +
+                        FROM_HOST_SIZE_BITS_DIFF - 1) :
+                          FROM_HOST_SIZE_BYTES_FLOOR_IN_BITS]
              = DataOutBuffer[FROM_HOST_SIZE_BYTES - 1]
                             [FROM_HOST_SIZE_BITS_DIFF - 1 : 0];
   endgenerate
 
+  /// *******************
+  /// Data out management.
+  ///
+  /// It has been observed that some simulators (verilator) does not handle
+  /// combinational driving from DPI well (resulting in non-determinism wrt
+  /// some of the combinational outputs being dropped/replicated). Questa does
+  /// not show this behavior.
+  /// A mitigation is to add a skid buffer to decouple the DPI interface
+  /// from the output interface.
+
+  // Instantiate a single-stage pipeline to buffer tokens that arrive from
+  // the host and present them to the module's output with proper
+  // ready/valid handshaking.
+  ESI_PipelineStage #(.WIDTH(FROM_HOST_SIZE_BITS)) out_pipe (
+    .clk(clk),
+    .rst(rst),
+    .a_valid(DataOut_a_valid),
+    .a(DataOut_a),
+    .a_ready(DataOut_a_ready),
+    .x_valid(DataOut_x_valid),
+    .x(DataOut_x),
+    .x_ready(DataOutReady)
+  );
+
+  // Drive the module's outward-facing signals from the pipeline output.
+  assign DataOutValid = DataOut_x_valid;
+  assign DataOut = DataOut_x;
+
   initial begin
     $display("FROM_HOST_SIZE_BITS: %d", FROM_HOST_SIZE_BITS);
     $display("FROM_HOST_SIZE_BYTES: %d", FROM_HOST_SIZE_BYTES);

esiaccel/cosim/questa.py

@@ -0,0 +1,78 @@
+#  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
+
+from .simulator import CosimCollateralDir, Simulator
+
+
+class Questa(Simulator):
+  """Run and compile funcs for Questasim."""
+
+  DefaultDriver = CosimCollateralDir / "driver.sv"
+
+  # 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)
+    for src in sources:
+      cmds.append(f"vlog -incr +acc -sv +define+TOP_MODULE={self.sources.top}"
+                  f" +define+SIMULATION {str(src)}")
+    cmds.append(f"vopt -incr driver -o driver_opt +acc")
+    return cmds
+
+  def compile_commands(self) -> List[List[str]]:
+    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",
+          "-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 soft link in the run directory (to
+    the work directory) before running vsim the usual way."""
+
+    # Create a soft link to the work directory.
+    workDir = self.run_dir / "work"
+    if not workDir.exists():
+      os.symlink(Path(os.getcwd()) / "work", workDir)
+
+    # Run the simulation.
+    return super().run(inner_command, gui, server_only=server_only)

esiaccel/cosim/simulator.py

@@ -0,0 +1,228 @@
+#  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
+import re
+import signal
+import socket
+import subprocess
+import time
+from pathlib import Path
+from typing import Dict, List
+
+_thisdir = Path(__file__).parent
+CosimCollateralDir = _thisdir
+
+
+def is_port_open(port) -> bool:
+  """Check if a TCP port is open locally."""
+  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+  result = sock.connect_ex(('127.0.0.1', port))
+  sock.close()
+  return True if result == 0 else False
+
+
+class SourceFiles:
+
+  def __init__(self, top: str) -> None:
+    # User source files.
+    self.user: List[Path] = []
+    # DPI shared objects.
+    self.dpi_so: List[str] = ["EsiCosimDpiServer"]
+    # DPI SV files.
+    self.dpi_sv: List[Path] = [
+        CosimCollateralDir / "Cosim_DpiPkg.sv",
+        CosimCollateralDir / "Cosim_Endpoint.sv",
+        CosimCollateralDir / "Cosim_Manifest.sv",
+    ]
+    # Name of the top module.
+    self.top = top
+
+  def add_dir(self, dir: Path):
+    """Add all the RTL files in a directory to the source list."""
+    for file in sorted(dir.iterdir()):
+      if file.is_file() and (file.suffix == ".sv" or file.suffix == ".v"):
+        self.user.append(file)
+      elif file.is_dir():
+        self.add_dir(file)
+
+  def dpi_so_paths(self) -> List[Path]:
+    """Return a list of all the DPI shared object files."""
+
+    def find_so(name: str) -> Path:
+      for path in Simulator.get_env().get("LD_LIBRARY_PATH", "").split(":"):
+        if os.name == "nt":
+          so = Path(path) / f"{name}.dll"
+        else:
+          so = Path(path) / f"lib{name}.so"
+        if so.exists():
+          return so
+      raise FileNotFoundError(f"Could not find {name}.so in LD_LIBRARY_PATH")
+
+    return [find_so(name) for name in self.dpi_so]
+
+  @property
+  def rtl_sources(self) -> List[Path]:
+    """Return a list of all the RTL source files."""
+    return self.dpi_sv + self.user
+
+
+class SimProcess:
+
+  def __init__(self, proc: subprocess.Popen, port: int):
+    self.proc = proc
+    self.port = port
+
+  def force_stop(self):
+    """Make sure to stop the simulation no matter what."""
+    if self.proc:
+      os.killpg(os.getpgid(self.proc.pid), signal.SIGINT)
+      # Allow the simulation time to flush its outputs.
+      try:
+        self.proc.wait(timeout=1.0)
+      except subprocess.TimeoutExpired:
+        # If the simulation doesn't exit of its own free will, kill it.
+        self.proc.kill()
+
+
+class Simulator:
+
+  # Some RTL simulators don't use stderr for error messages. Everything goes to
+  # stdout. Boo! They should feel bad about this. Also, they can specify that
+  # broken behavior by overriding this.
+  UsesStderr = True
+
+  def __init__(self, sources: SourceFiles, run_dir: Path, debug: bool):
+    self.sources = sources
+    self.run_dir = run_dir
+    self.debug = debug
+
+  @staticmethod
+  def get_env() -> Dict[str, str]:
+    """Get the environment variables to locate shared objects."""
+
+    env = os.environ.copy()
+    env["LIBRARY_PATH"] = env.get("LIBRARY_PATH", "") + ":" + str(
+        _thisdir.parent / "lib")
+    env["LD_LIBRARY_PATH"] = env.get("LD_LIBRARY_PATH", "") + ":" + str(
+        _thisdir.parent / "lib")
+    return env
+
+  def compile_commands(self) -> List[List[str]]:
+    """Compile the sources. Returns the exit code of the simulation compiler."""
+    assert False, "Must be implemented by subclass"
+
+  def compile(self) -> int:
+    cmds = self.compile_commands()
+    self.run_dir.mkdir(parents=True, exist_ok=True)
+    with (self.run_dir / "compile_stdout.log").open("w") as stdout, (
+        self.run_dir / "compile_stderr.log").open("w") as stderr:
+      for cmd in cmds:
+        stderr.write(" ".join(cmd) + "\n")
+        cp = subprocess.run(cmd,
+                            env=Simulator.get_env(),
+                            capture_output=True,
+                            text=True)
+        stdout.write(cp.stdout)
+        stderr.write(cp.stderr)
+        if cp.returncode != 0:
+          print("====== Compilation failure:")
+          if self.UsesStderr:
+            print(cp.stderr)
+          else:
+            print(cp.stdout)
+          return cp.returncode
+    return 0
+
+  def run_command(self, gui: bool) -> List[str]:
+    """Return the command to run the simulation."""
+    assert False, "Must be implemented by subclass"
+
+  def run_proc(self, gui: bool = False) -> SimProcess:
+    """Run the simulation process. Returns the Popen object and the port which
+      the simulation is listening on."""
+    # Open log files
+    self.run_dir.mkdir(parents=True, exist_ok=True)
+    simStdout = open(self.run_dir / "sim_stdout.log", "w")
+    simStderr = open(self.run_dir / "sim_stderr.log", "w")
+
+    # Erase the config file if it exists. We don't want to read
+    # an old config.
+    portFileName = self.run_dir / "cosim.cfg"
+    if os.path.exists(portFileName):
+      os.remove(portFileName)
+
+    # Run the simulation.
+    simEnv = Simulator.get_env()
+    if self.debug:
+      simEnv["COSIM_DEBUG_FILE"] = "cosim_debug.log"
+      if "DEBUG_PERIOD" not in simEnv:
+        # Slow the simulation down to one tick per millisecond.
+        simEnv["DEBUG_PERIOD"] = "1"
+    rcmd = self.run_command(gui)
+    simProc = subprocess.Popen(self.run_command(gui),
+                               stdout=simStdout,
+                               stderr=simStderr,
+                               env=simEnv,
+                               cwd=self.run_dir,
+                               preexec_fn=os.setsid)
+    simStderr.close()
+    simStdout.close()
+
+    # Get the port which the simulation RPC selected.
+    checkCount = 0
+    while (not os.path.exists(portFileName)) and \
+            simProc.poll() is None:
+      time.sleep(0.1)
+      checkCount += 1
+      if checkCount > 500 and not gui:
+        raise Exception(f"Cosim never wrote cfg file: {portFileName}")
+    port = -1
+    while port < 0:
+      portFile = open(portFileName, "r")
+      for line in portFile.readlines():
+        m = re.match("port: (\\d+)", line)
+        if m is not None:
+          port = int(m.group(1))
+      portFile.close()
+
+    # Wait for the simulation to start accepting RPC connections.
+    checkCount = 0
+    while not is_port_open(port):
+      checkCount += 1
+      if checkCount > 200:
+        raise Exception(f"Cosim RPC port ({port}) never opened")
+      if simProc.poll() is not None:
+        raise Exception("Simulation exited early")
+      time.sleep(0.05)
+    return SimProcess(proc=simProc, port=port)
+
+  def run(self,
+          inner_command: str,
+          gui: bool = False,
+          server_only: bool = False) -> int:
+    """Start the simulation then run the command specified. Kill the simulation
+    when the command exits."""
+
+    # 'simProc' is accessed in the finally block. Declare it here to avoid
+    # syntax errors in that block.
+    simProc = None
+    try:
+      simProc = self.run_proc(gui=gui)
+      if server_only:
+        # wait for user input to kill the server
+        input(
+            f"Running in server-only mode on port {simProc.port} - Press anything to kill the server..."
+        )
+        return 0
+      else:
+        # Run the inner command, passing the connection info via environment vars.
+        testEnv = os.environ.copy()
+        testEnv["ESI_COSIM_PORT"] = str(simProc.port)
+        testEnv["ESI_COSIM_HOST"] = "localhost"
+        return subprocess.run(inner_command, cwd=os.getcwd(),
+                              env=testEnv).returncode
+    finally:
+      if simProc:
+        simProc.force_stop()

esiaccel/cosim/verilator.py

@@ -0,0 +1,61 @@
+#  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
+
+from .simulator import CosimCollateralDir, Simulator, SourceFiles
+
+
+class Verilator(Simulator):
+  """Run and compile funcs for Verilator."""
+
+  DefaultDriver = CosimCollateralDir / "driver.cpp"
+
+  def __init__(self, sources: SourceFiles, run_dir: Path, debug: bool):
+    super().__init__(sources, run_dir, debug)
+
+    self.verilator = "verilator"
+    if "VERILATOR_PATH" in os.environ:
+      self.verilator = os.environ["VERILATOR_PATH"]
+
+  def compile_commands(self) -> List[List[str]]:
+    cmd: List[str] = [
+        self.verilator,
+        "--cc",
+        "--top-module",
+        self.sources.top,
+        "-DSIMULATION",
+        "-Wno-TIMESCALEMOD",
+        "-Wno-fatal",
+        "-sv",
+        "--exe",
+        "--build",
+        "-j",
+        "0",
+        "--output-split",
+        "--assert",
+        str(Verilator.DefaultDriver),
+    ]
+    cflags = [
+        "-DTOP_MODULE=" + self.sources.top,
+    ]
+    if self.debug:
+      cmd += [
+          "--trace", "--trace-params", "--trace-structs", "--trace-underscore"
+      ]
+      cflags.append("-DTRACE")
+    if len(cflags) > 0:
+      cmd += ["-CFLAGS", " ".join(cflags)]
+    if len(self.sources.dpi_so) > 0:
+      cmd += ["-LDFLAGS", " ".join(["-l" + so for so in self.sources.dpi_so])]
+    cmd += [str(p) for p in self.sources.rtl_sources]
+    return [cmd]
+
+  def run_command(self, gui: bool):
+    if gui:
+      raise RuntimeError("Verilator does not support GUI mode.")
+    exe = Path.cwd() / "obj_dir" / ("V" + self.sources.top)
+    return [str(exe)]

esiaccel/esi-cosim.py

@@ -14,350 +14,14 @@
 # ===----------------------------------------------------------------------===//
 
 import argparse
-import os
 from pathlib import Path
-import re
-import signal
-import socket
-import subprocess
 import sys
 import textwrap
-import time
 from typing import Dict, List
 
-_thisdir = Path(__file__).parent
-CosimCollateralDir = _thisdir.parent / "cosim"
-
-
-def is_port_open(port) -> bool:
-  """Check if a TCP port is open locally."""
-  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-  result = sock.connect_ex(('127.0.0.1', port))
-  sock.close()
-  return True if result == 0 else False
-
-
-class SourceFiles:
-
-  def __init__(self, top: str) -> None:
-    # User source files.
-    self.user: List[Path] = []
-    # DPI shared objects.
-    self.dpi_so: List[str] = ["EsiCosimDpiServer"]
-    # DPI SV files.
-    self.dpi_sv: List[Path] = [
-        CosimCollateralDir / "Cosim_DpiPkg.sv",
-        CosimCollateralDir / "Cosim_Endpoint.sv",
-        CosimCollateralDir / "Cosim_Manifest.sv",
-    ]
-    # Name of the top module.
-    self.top = top
-
-  def add_dir(self, dir: Path):
-    """Add all the RTL files in a directory to the source list."""
-    for file in sorted(dir.iterdir()):
-      if file.is_file() and (file.suffix == ".sv" or file.suffix == ".v"):
-        self.user.append(file)
-      elif file.is_dir():
-        self.add_dir(file)
-
-  def dpi_so_paths(self) -> List[Path]:
-    """Return a list of all the DPI shared object files."""
-
-    def find_so(name: str) -> Path:
-      for path in Simulator.get_env().get("LD_LIBRARY_PATH", "").split(":"):
-        if os.name == "nt":
-          so = Path(path) / f"{name}.dll"
-        else:
-          so = Path(path) / f"lib{name}.so"
-        if so.exists():
-          return so
-      raise FileNotFoundError(f"Could not find {name}.so in LD_LIBRARY_PATH")
-
-    return [find_so(name) for name in self.dpi_so]
-
-  @property
-  def rtl_sources(self) -> List[Path]:
-    """Return a list of all the RTL source files."""
-    return self.dpi_sv + self.user
-
-
-class SimProcess:
-
-  def __init__(self, proc: subprocess.Popen, port: int):
-    self.proc = proc
-    self.port = port
-
-  def force_stop(self):
-    """Make sure to stop the simulation no matter what."""
-    if self.proc:
-      os.killpg(os.getpgid(self.proc.pid), signal.SIGINT)
-      # Allow the simulation time to flush its outputs.
-      try:
-        self.proc.wait(timeout=1.0)
-      except subprocess.TimeoutExpired:
-        # If the simulation doesn't exit of its own free will, kill it.
-        self.proc.kill()
-
-
-class Simulator:
-
-  # Some RTL simulators don't use stderr for error messages. Everything goes to
-  # stdout. Boo! They should feel bad about this. Also, they can specify that
-  # broken behavior by overriding this.
-  UsesStderr = True
-
-  def __init__(self, sources: SourceFiles, run_dir: Path, debug: bool):
-    self.sources = sources
-    self.run_dir = run_dir
-    self.debug = debug
-
-  @staticmethod
-  def get_env() -> Dict[str, str]:
-    """Get the environment variables to locate shared objects."""
-
-    env = os.environ.copy()
-    env["LIBRARY_PATH"] = env.get("LIBRARY_PATH", "") + ":" + str(
-        _thisdir.parent / "lib")
-    env["LD_LIBRARY_PATH"] = env.get("LD_LIBRARY_PATH", "") + ":" + str(
-        _thisdir.parent / "lib")
-    return env
-
-  def compile_commands(self) -> List[List[str]]:
-    """Compile the sources. Returns the exit code of the simulation compiler."""
-    assert False, "Must be implemented by subclass"
-
-  def compile(self) -> int:
-    cmds = self.compile_commands()
-    self.run_dir.mkdir(parents=True, exist_ok=True)
-    with (self.run_dir / "compile_stdout.log").open("w") as stdout, (
-        self.run_dir / "compile_stderr.log").open("w") as stderr:
-      for cmd in cmds:
-        stderr.write(" ".join(cmd) + "\n")
-        cp = subprocess.run(cmd,
-                            env=Simulator.get_env(),
-                            capture_output=True,
-                            text=True)
-        stdout.write(cp.stdout)
-        stderr.write(cp.stderr)
-        if cp.returncode != 0:
-          print("====== Compilation failure:")
-          if self.UsesStderr:
-            print(cp.stderr)
-          else:
-            print(cp.stdout)
-          return cp.returncode
-    return 0
-
-  def run_command(self, gui: bool) -> List[str]:
-    """Return the command to run the simulation."""
-    assert False, "Must be implemented by subclass"
-
-  def run_proc(self, gui: bool = False) -> SimProcess:
-    """Run the simulation process. Returns the Popen object and the port which
-      the simulation is listening on."""
-    # Open log files
-    self.run_dir.mkdir(parents=True, exist_ok=True)
-    simStdout = open(self.run_dir / "sim_stdout.log", "w")
-    simStderr = open(self.run_dir / "sim_stderr.log", "w")
-
-    # Erase the config file if it exists. We don't want to read
-    # an old config.
-    portFileName = self.run_dir / "cosim.cfg"
-    if os.path.exists(portFileName):
-      os.remove(portFileName)
-
-    # Run the simulation.
-    simEnv = Simulator.get_env()
-    if self.debug:
-      simEnv["COSIM_DEBUG_FILE"] = "cosim_debug.log"
-      if "DEBUG_PERIOD" not in simEnv:
-        # Slow the simulation down to one tick per millisecond.
-        simEnv["DEBUG_PERIOD"] = "1"
-    rcmd = self.run_command(gui)
-    simProc = subprocess.Popen(self.run_command(gui),
-                               stdout=simStdout,
-                               stderr=simStderr,
-                               env=simEnv,
-                               cwd=self.run_dir,
-                               preexec_fn=os.setsid)
-    simStderr.close()
-    simStdout.close()
-
-    # Get the port which the simulation RPC selected.
-    checkCount = 0
-    while (not os.path.exists(portFileName)) and \
-            simProc.poll() is None:
-      time.sleep(0.1)
-      checkCount += 1
-      if checkCount > 500 and not gui:
-        raise Exception(f"Cosim never wrote cfg file: {portFileName}")
-    port = -1
-    while port < 0:
-      portFile = open(portFileName, "r")
-      for line in portFile.readlines():
-        m = re.match("port: (\\d+)", line)
-        if m is not None:
-          port = int(m.group(1))
-      portFile.close()
-
-    # Wait for the simulation to start accepting RPC connections.
-    checkCount = 0
-    while not is_port_open(port):
-      checkCount += 1
-      if checkCount > 200:
-        raise Exception(f"Cosim RPC port ({port}) never opened")
-      if simProc.poll() is not None:
-        raise Exception("Simulation exited early")
-      time.sleep(0.05)
-    return SimProcess(proc=simProc, port=port)
-
-  def run(self,
-          inner_command: str,
-          gui: bool = False,
-          server_only: bool = False) -> int:
-    """Start the simulation then run the command specified. Kill the simulation
-    when the command exits."""
-
-    # 'simProc' is accessed in the finally block. Declare it here to avoid
-    # syntax errors in that block.
-    simProc = None
-    try:
-      simProc = self.run_proc(gui=gui)
-      if server_only:
-        # wait for user input to kill the server
-        input(
-            f"Running in server-only mode on port {simProc.port} - Press anything to kill the server..."
-        )
-        return 0
-      else:
-        # Run the inner command, passing the connection info via environment vars.
-        testEnv = os.environ.copy()
-        testEnv["ESI_COSIM_PORT"] = str(simProc.port)
-        testEnv["ESI_COSIM_HOST"] = "localhost"
-        return subprocess.run(inner_command, cwd=os.getcwd(),
-                              env=testEnv).returncode
-    finally:
-      if simProc:
-        simProc.force_stop()
-
-
-class Verilator(Simulator):
-  """Run and compile funcs for Verilator."""
-
-  DefaultDriver = CosimCollateralDir / "driver.cpp"
-
-  def __init__(self, sources: SourceFiles, run_dir: Path, debug: bool):
-    super().__init__(sources, run_dir, debug)
-
-    self.verilator = "verilator"
-    if "VERILATOR_PATH" in os.environ:
-      self.verilator = os.environ["VERILATOR_PATH"]
-
-  def compile_commands(self) -> List[List[str]]:
-    cmd: List[str] = [
-        self.verilator,
-        "--cc",
-        "--top-module",
-        self.sources.top,
-        "-DSIMULATION",
-        "-Wno-TIMESCALEMOD",
-        "-Wno-fatal",
-        "-sv",
-        "--build",
-        "--exe",
-        "--assert",
-        str(Verilator.DefaultDriver),
-    ]
-    cflags = [
-        "-DTOP_MODULE=" + self.sources.top,
-    ]
-    if self.debug:
-      cmd += [
-          "--trace", "--trace-params", "--trace-structs", "--trace-underscore"
-      ]
-      cflags.append("-DTRACE")
-    if len(cflags) > 0:
-      cmd += ["-CFLAGS", " ".join(cflags)]
-    if len(self.sources.dpi_so) > 0:
-      cmd += ["-LDFLAGS", " ".join(["-l" + so for so in self.sources.dpi_so])]
-    cmd += [str(p) for p in self.sources.rtl_sources]
-    return [cmd]
-
-  def run_command(self, gui: bool):
-    if gui:
-      raise RuntimeError("Verilator does not support GUI mode.")
-    exe = Path.cwd() / "obj_dir" / ("V" + self.sources.top)
-    return [str(exe)]
-
-
-class Questa(Simulator):
-  """Run and compile funcs for Questasim."""
-
-  DefaultDriver = CosimCollateralDir / "driver.sv"
-
-  # 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)
-    for src in sources:
-      cmds.append(f"vlog -incr +acc -sv +define+TOP_MODULE={self.sources.top}"
-                  f" +define+SIMULATION {str(src)}")
-    cmds.append(f"vopt -incr driver -o driver_opt +acc")
-    return cmds
-
-  def compile_commands(self) -> List[List[str]]:
-    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",
-          "-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 soft link in the run directory (to
-    the work directory) before running vsim the usual way."""
-
-    # Create a soft link to the work directory.
-    workDir = self.run_dir / "work"
-    if not workDir.exists():
-      os.symlink(Path(os.getcwd()) / "work", workDir)
-
-    # Run the simulation.
-    return super().run(inner_command, gui, server_only=server_only)
+from esiaccel.cosim.questa import Questa
+from esiaccel.cosim.verilator import Verilator
+from esiaccel.cosim.simulator import SourceFiles
 
 
 def __main__(args):

{esiaccel-0.1.5.dev147.dist-info → esiaccel-0.1.5.dev164.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esiaccel
-Version: 0.1.5.dev147
+Version: 0.1.5.dev164
 Summary: ESI accelerators runtime
 Author-email: John Demme <John.Demme@microsoft.com>
 License: ==============================================================================

{esiaccel-0.1.5.dev147.dist-info → esiaccel-0.1.5.dev164.dist-info}/RECORD

@@ -1,25 +1,28 @@
-esiaccel/CosimBackend.dll,sha256=IL1XoD-Z8zQ1ZjK7X8XBP42rHowpxIa2xRKYf-R7I8k,7152128
+esiaccel/CosimBackend.dll,sha256=pVZhWoNUMgZNnY8LCShcT1Sqst9nQRyizrb2i2fjq14,7152128
 esiaccel/CosimBackend.lib,sha256=UjflmgR93Kl22Du0lTqGhXWQqWEF-V8VwcqUuFo8GNk,4992924
-esiaccel/ESICppRuntime.dll,sha256=cnbfx7k4jo8RHd_1uGRfeauE5xLD1fcrKCLM5JYTDxI,4078592
+esiaccel/ESICppRuntime.dll,sha256=w_UDjb258Zl0TU1mEBnTGRkr6bdhYSMu1-FUReTn0uQ,4078592
 esiaccel/ESICppRuntime.lib,sha256=iGJtktQywYhQCody90jvprSYC7kB9LWt3LEX5yIGEkM,15154004
-esiaccel/EsiCosimDpiServer.dll,sha256=Fj2803pwpUP9-WYlAR5yE6936dXdR50gNcJgMlPocxo,159744
+esiaccel/EsiCosimDpiServer.dll,sha256=xktLQ4-xOA688Du5D07q6BrAEr7wqpW60z7Stjfn2Wk,159744
 esiaccel/EsiCosimDpiServer.lib,sha256=bYBigD0RtRRSEiDxf4_gvpasLjD8fcUmC0CjRgQiQ0s,604164
-esiaccel/MtiPli.dll,sha256=cOA9Yf66yJvYF5NigtBAj8YvcMeOjWSy3c-A1XJvdso,14848
+esiaccel/MtiPli.dll,sha256=gQnnnRHOA7_70UeRxqrjeXuH-w1ppBV82D05JmQnOv0,14848
 esiaccel/MtiPli.lib,sha256=X0PcXwheCUvBMgQ5BAawePxbXQSLNk5M1FFn6V56ydo,14570
 esiaccel/__init__.py,sha256=65xXWHwJwRePsyhWk837NpzuN0qsNhoAX29TOiSYKGc,905
 esiaccel/accelerator.py,sha256=BcXPsUqcQV3YsVVyYbz9P6JnZLlcnuageFbJwID9_3s,3318
 esiaccel/codegen.py,sha256=uoYELtnIabVvgLeCABj-mWras0BvmSKABPH-cd9nDFk,6560
-esiaccel/esi-cosim.py,sha256=JHPgS6jjC655afz7pNBh47cAjyRTiqMKRM3tCsszYM4,14796
-esiaccel/esiCppAccel.cp311-win_amd64.pyd,sha256=2yMe1ow3wydK8BqZgc8gDtorgIteCc0oap1jt8J98SE,502272
-esiaccel/esiquery.exe,sha256=mQ2O-o3mOEFhCCpzp7XUt7-Kd8fhrl6O3YodRPO8nyk,441856
+esiaccel/esi-cosim.py,sha256=P7n3SBgKPnXynwghY5zK1FmpqZkbC_YxfVIvNNQNl6Q,3817
+esiaccel/esiCppAccel.cp311-win_amd64.pyd,sha256=EBeBmtCdIUKEVjq9YKLDSxZytsKoGdKLKlhUdqQ90-E,502272
+esiaccel/esiquery.exe,sha256=l46J-YKhec1EfdEpuVbQ74KMj-kpdxEMGd8OQFh1FXM,441856
 esiaccel/types.py,sha256=LFLzUCvtYF6FLsmKet6eJTMq2ija2Z5kxd5Ks6tkS4U,19044
 esiaccel/utils.py,sha256=q-8fmgJ9tUvmBsIvqZiZ7u845IJhOjvjYTQLhhrNYl0,1515
 esiaccel/cmake/esiaccelConfig.cmake,sha256=u2aW99k1lEcmYTG1P3BTJqtmDrj53wUUaBz_jzw8kYY,565
 esiaccel/cosim/Cosim_DpiPkg.sv,sha256=9qGn1VyAVrzBP5At1thV6xrovg0WghICD01Zz9J221E,3458
-esiaccel/cosim/Cosim_Endpoint.sv,sha256=ri1fHdkiphe8S2-vm6Ru16rBGYiDiS1c8qeCAsl1diU,6498
+esiaccel/cosim/Cosim_Endpoint.sv,sha256=2F7UQYWavUlWx7Iqi_6iawn5geZRPG96H8rDBBDRAQ0,8391
 esiaccel/cosim/Cosim_Manifest.sv,sha256=vl9b6XieEkP880IBw1ferekBnDJwFanZZggJJGertXM,1123
 esiaccel/cosim/driver.cpp,sha256=DrEKkSN7Y_Hu7wcaUulH5mbC2L4yB9xLClRMeRUpzHM,3842
 esiaccel/cosim/driver.sv,sha256=ro-j9GM164A1W0MDPkqYfEn3TUKHSqVvgjO31fnloQI,1428
+esiaccel/cosim/questa.py,sha256=d6PnjzRxQpu47Zpez6hmzTc_aMQdrmQRSmnpOXSPFVU,2386
+esiaccel/cosim/simulator.py,sha256=Yv5PeWDmhsgATDEy-P3drFgXNEaALOlMInsFvsiGy4c,7864
+esiaccel/cosim/verilator.py,sha256=BwCJWLlMOPD_JZyjOoLGUW48-IIndtbj55D2kRvL1l4,1834
 esiaccel/include/esi/Accelerator.h,sha256=RhkZ2HeMZ0iHc5BkHdDWXoeg9J9lyPQciH5bWq5Qc_w,9772
 esiaccel/include/esi/CLI.h,sha256=Nn8tHn_xtEfkrD7USE2tao6ktYOJ6xcbnhZkS9-ox0A,2540
 esiaccel/include/esi/Common.h,sha256=IGJvAU72dlearXFbSmlXFFriy8aomirp7opEBjgewek,5775
@@ -35,9 +38,9 @@ esiaccel/include/esi/Utils.h,sha256=KPd75GajIFeTBVJocXBjwsJqhbZg-ShWZCIe3oQdBss,
 esiaccel/include/esi/backends/Cosim.h,sha256=s7vYd0ra6m1nvk-n37MjvBoGVI-CCUKBt0DU4PKlaHM,2838
 esiaccel/include/esi/backends/RpcServer.h,sha256=WMwnhwU2qnrcglGNeiKg9QQHpkDx1QE1JydKYDK4jqE,1856
 esiaccel/include/esi/backends/Trace.h,sha256=kx4wwLH3a0ndmRUdaDyYGZ1SP83zlpFrk30Nw8ZrJJA,3286
-esiaccel-0.1.5.dev147.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
-esiaccel-0.1.5.dev147.dist-info/METADATA,sha256=oxZUJ15Qr6eLJeMDWCKVnCncAT1a9lAyqNFBrqKtzys,16148
-esiaccel-0.1.5.dev147.dist-info/WHEEL,sha256=JLOMsP7F5qtkAkINx5UnzbFguf8CqZeraV8o04b0I8I,101
-esiaccel-0.1.5.dev147.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
-esiaccel-0.1.5.dev147.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
-esiaccel-0.1.5.dev147.dist-info/RECORD,,
+esiaccel-0.1.5.dev164.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
+esiaccel-0.1.5.dev164.dist-info/METADATA,sha256=5jOaDY4vSlfnWCgt5XqVyfrY_S1jfzgoyO6pRfl6fq8,16148
+esiaccel-0.1.5.dev164.dist-info/WHEEL,sha256=JLOMsP7F5qtkAkINx5UnzbFguf8CqZeraV8o04b0I8I,101
+esiaccel-0.1.5.dev164.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
+esiaccel-0.1.5.dev164.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
+esiaccel-0.1.5.dev164.dist-info/RECORD,,