esiaccel 0.1.5.dev138__cp313-cp313-win_amd64.whl → 0.1.5.dev163__cp313-cp313-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/esi-cosim.py

@@ -82,6 +82,24 @@ class SourceFiles:
     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
@@ -135,6 +153,65 @@ class Simulator:
     """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,
@@ -146,83 +223,23 @@ class Simulator:
     # syntax errors in that block.
     simProc = None
     try:
-      # 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"
-      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 > 200 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)
-
+      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 {port} - Press anything to kill the server..."
+            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(port)
+        testEnv["ESI_COSIM_PORT"] = str(simProc.port)
         testEnv["ESI_COSIM_HOST"] = "localhost"
         return subprocess.run(inner_command, cwd=os.getcwd(),
                               env=testEnv).returncode
     finally:
-      # Make sure to stop the simulation no matter what.
       if simProc:
-        os.killpg(os.getpgid(simProc.pid), signal.SIGINT)
-        # Allow the simulation time to flush its outputs.
-        try:
-          simProc.wait(timeout=1.0)
-        except subprocess.TimeoutExpired:
-          # If the simulation doesn't exit of its own free will, kill it.
-          simProc.kill()
+        simProc.force_stop()
 
 
 class Verilator(Simulator):
@@ -247,8 +264,11 @@ class Verilator(Simulator):
         "-Wno-TIMESCALEMOD",
         "-Wno-fatal",
         "-sv",
-        "--build",
         "--exe",
+        "--build",
+        "-j",
+        "0",
+        "--output-split",
         "--assert",
         str(Verilator.DefaultDriver),
     ]

{esiaccel-0.1.5.dev138.dist-info → esiaccel-0.1.5.dev163.dist-info}/METADATA

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

{esiaccel-0.1.5.dev138.dist-info → esiaccel-0.1.5.dev163.dist-info}/RECORD

@@ -1,22 +1,22 @@
-esiaccel/CosimBackend.dll,sha256=wde-KSetQ_kLivkwaz2QZojox23PltB56S98L-K1hwE,7152128
+esiaccel/CosimBackend.dll,sha256=tluLZykVh08ULYF-jlZJzND_NIgETI2RSMso4TwrKT0,7152128
 esiaccel/CosimBackend.lib,sha256=UjflmgR93Kl22Du0lTqGhXWQqWEF-V8VwcqUuFo8GNk,4992924
-esiaccel/ESICppRuntime.dll,sha256=eqVIWzyibawtNVr3IU8wuHDn4Ou1WGMkjDyugddc3L0,4078592
+esiaccel/ESICppRuntime.dll,sha256=zXaoMVYtpCEfxAb304cwTzptTADyXlDxxY6WoqbLynM,4078592
 esiaccel/ESICppRuntime.lib,sha256=iGJtktQywYhQCody90jvprSYC7kB9LWt3LEX5yIGEkM,15154004
-esiaccel/EsiCosimDpiServer.dll,sha256=7rhUY6s7vN04EW18DbRfLaYjc4pJfMmeJiZmI-9Aqiw,159744
+esiaccel/EsiCosimDpiServer.dll,sha256=JOp6ThE_y7VSo9YrI5X3RFNsTteieP9-NTwGRmGzJlk,159744
 esiaccel/EsiCosimDpiServer.lib,sha256=bYBigD0RtRRSEiDxf4_gvpasLjD8fcUmC0CjRgQiQ0s,604164
-esiaccel/MtiPli.dll,sha256=SG3AJtLGHG6t6QlWQDEzfKBAGykuXKSn-8jZRjSEmWA,14848
+esiaccel/MtiPli.dll,sha256=yj9Mwa8hMbpYMYqt6eOissa99wtQ7gn_g4gnGn7vO8U,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=GwYfNh4aagypheAhGf0EIX6ojkLYKkc5OMlFR9pfXe8,14381
-esiaccel/esiCppAccel.cp313-win_amd64.pyd,sha256=YtEbmof0UAdO4FccGknyvqAgH6T9gIWFnsLTucwy1Ec,510976
-esiaccel/esiquery.exe,sha256=-GvmCGvb94CkMGDuO0KAJIO0x3AKWxj0evmWsIsMLe4,441856
+esiaccel/esi-cosim.py,sha256=Z8gBKNr4iWtrokBLd2xym9ClwsFP0kQNRCnjMRfytcY,14852
+esiaccel/esiCppAccel.cp313-win_amd64.pyd,sha256=EpCMBwO8_SnfxK8xWx61JsnIkDasDh14zdeP5_Qq_IE,510976
+esiaccel/esiquery.exe,sha256=sFRe_IuJx04LhxgTIIe55yq01_RfczDa25dIZno9QeU,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
@@ -35,9 +35,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.dev138.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
-esiaccel-0.1.5.dev138.dist-info/METADATA,sha256=YQqAggLDdoG1ATE0w2j-xfAXui1Bw-luzvKtRRlPnzw,16148
-esiaccel-0.1.5.dev138.dist-info/WHEEL,sha256=qV0EIPljj1XC_vuSatRWjn02nZIz3N1t8jsZz7HBr2U,101
-esiaccel-0.1.5.dev138.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
-esiaccel-0.1.5.dev138.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
-esiaccel-0.1.5.dev138.dist-info/RECORD,,
+esiaccel-0.1.5.dev163.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
+esiaccel-0.1.5.dev163.dist-info/METADATA,sha256=ghDk1XHfRI5GwmYRAW9aWvWpO3HcAE5he_FeHu2NtNk,16148
+esiaccel-0.1.5.dev163.dist-info/WHEEL,sha256=qV0EIPljj1XC_vuSatRWjn02nZIz3N1t8jsZz7HBr2U,101
+esiaccel-0.1.5.dev163.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
+esiaccel-0.1.5.dev163.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
+esiaccel-0.1.5.dev163.dist-info/RECORD,,