esiaccel 0.1.5.dev93__cp310-cp310-win_amd64.whl → 0.1.5.dev107__cp310-cp310-win_amd64.whl

esiaccel/__init__.py

@@ -1,7 +1,8 @@
 #  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 sys
+import os
 from .accelerator import AcceleratorConnection
 
 from .esiCppAccel import (AppID, Type, BundleType, ChannelType, ArrayType,
@@ -11,3 +12,11 @@ __all__ = [
     "AcceleratorConnection", "AppID", "Type", "BundleType", "ChannelType",
     "ArrayType", "StructType", "BitsType", "UIntType", "SIntType"
 ]
+
+if sys.platform == "win32":
+  """Ensure that ESI libraries are in the dll path on Windows. Necessary to
+  call when users build against the esiaccel-provided prebuilt CMake/prebuilt
+  libraries, before they are loaded via. python.
+  """
+  from .utils import get_dll_dir
+  os.add_dll_directory(str(get_dll_dir()))

esiaccel/include/esi/Common.h

@@ -20,6 +20,7 @@
 #include <cstdint>
 #include <map>
 #include <optional>
+#include <span>
 #include <stdexcept>
 #include <string>
 #include <vector>
@@ -115,6 +116,11 @@ public:
   /// Get the data as a vector of bytes.
   const std::vector<uint8_t> &getData() const { return data; }
 
+  /// Implicit conversion to a vector/span of bytes, to play nice with other
+  /// APIs that accept bytearray-like things.
+  operator const std::vector<uint8_t> &() const { return data; }
+  operator std::span<const uint8_t>() const { return data; }
+
   /// Move the data out of this object.
   std::vector<uint8_t> takeData() { return std::move(data); }
 

esiaccel/include/esi/Types.h

@@ -16,11 +16,17 @@
 #ifndef ESI_TYPES_H
 #define ESI_TYPES_H
 
+#include <algorithm>
+#include <any>
 #include <cstdint>
 #include <map>
+#include <span>
+#include <stdexcept>
 #include <string>
 #include <vector>
 
+#include "esi/Common.h"
+
 namespace esi {
 
 /// Root class of the ESI type system.
@@ -33,6 +39,37 @@ public:
   ID getID() const { return id; }
   virtual std::ptrdiff_t getBitWidth() const { return -1; }
 
+  /// Serialize an object to MessageData. The object should be passed as a
+  /// std::any to provide type erasure. Returns a MessageData containing the
+  /// serialized representation.
+  virtual MessageData serialize(const std::any &obj) const {
+    throw std::runtime_error("Serialization not implemented for type " + id);
+  }
+
+  /// Deserialize from a span of bytes to an object. Returns the deserialized
+  /// object as a std::any and a span to the remaining bytes.
+  virtual std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const {
+    throw std::runtime_error("Deserialization not implemented for type " + id);
+  }
+
+  /// Ensure that a std::any object is valid for this type. Throws
+  /// std::runtime_error if the object is not valid.
+  virtual void ensureValid(const std::any &obj) const {
+    throw std::runtime_error("Validation not implemented for type " + id);
+  }
+
+  // Check if a std::any object is valid for this type. Returns an optional
+  // error message if the object is not valid, else, std::nullopt.
+  std::optional<std::string> isValid(const std::any &obj) const {
+    try {
+      ensureValid(obj);
+      return std::nullopt;
+    } catch (const std::runtime_error &e) {
+      return e.what();
+    }
+  }
+
 protected:
   ID id;
 };
@@ -54,12 +91,7 @@ public:
   const ChannelVector &getChannels() const { return channels; }
   std::ptrdiff_t getBitWidth() const override { return -1; };
 
-  std::pair<const Type *, Direction> findChannel(std::string name) const {
-    for (auto [channelName, dir, type] : channels)
-      if (channelName == name)
-        return std::make_pair(type, dir);
-    throw std::runtime_error("Channel '" + name + "' not found in bundle");
-  }
+  std::pair<const Type *, Direction> findChannel(std::string name) const;
 
 protected:
   ChannelVector channels;
@@ -73,6 +105,11 @@ public:
   const Type *getInner() const { return inner; }
   std::ptrdiff_t getBitWidth() const override { return inner->getBitWidth(); };
 
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
+
 private:
   const Type *inner;
 };
@@ -83,6 +120,11 @@ public:
   VoidType(const ID &id) : Type(id) {}
   // 'void' is 1 bit by convention.
   std::ptrdiff_t getBitWidth() const override { return 1; };
+
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
 };
 
 /// The "any" type is a special type which can be used to represent any type, as
@@ -112,6 +154,11 @@ private:
 class BitsType : public BitVectorType {
 public:
   using BitVectorType::BitVectorType;
+
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
 };
 
 /// Integers are bit vectors which may be signed or unsigned and are interpreted
@@ -125,12 +172,22 @@ public:
 class SIntType : public IntegerType {
 public:
   using IntegerType::IntegerType;
+
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
 };
 
 /// Unsigned integer.
 class UIntType : public IntegerType {
 public:
   using IntegerType::IntegerType;
+
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
 };
 
 /// Structs are an ordered collection of fields, each with a name and a type.
@@ -138,8 +195,8 @@ class StructType : public Type {
 public:
   using FieldVector = std::vector<std::pair<std::string, const Type *>>;
 
-  StructType(const ID &id, const FieldVector &fields)
-      : Type(id), fields(fields) {}
+  StructType(const ID &id, const FieldVector &fields, bool reverse = true)
+      : Type(id), fields(fields), reverse(reverse) {}
 
   const FieldVector &getFields() const { return fields; }
   std::ptrdiff_t getBitWidth() const override {
@@ -153,8 +210,21 @@ public:
     return size;
   }
 
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
+
+  // Returns whether this struct type should be reversed when
+  // serializing/deserializing.
+  // By default, a truthy value here makes StructType's compatible with system
+  // verilog, which has reversed struct field ordering, wrt. C/software struct
+  // ordering.
+  bool isReverse() const { return reverse; }
+
 private:
   FieldVector fields;
+  bool reverse;
 };
 
 /// Arrays have a compile time specified (static) size and an element type.
@@ -172,6 +242,11 @@ public:
     return elementSize * size;
   }
 
+  void ensureValid(const std::any &obj) const override;
+  MessageData serialize(const std::any &obj) const override;
+  std::pair<std::any, std::span<const uint8_t>>
+  deserialize(std::span<const uint8_t> data) const override;
+
 private:
   const Type *elementType;
   uint64_t size;

esiaccel/types.py

@@ -245,6 +245,8 @@ class StructType(ESIType):
   def is_valid(self, obj) -> Tuple[bool, Optional[str]]:
     fields_count = 0
     if not isinstance(obj, dict):
+      if not hasattr(obj, "__dict__"):
+        return (False, "must be a dict or have __dict__ attribute")
       obj = obj.__dict__
 
     for (fname, ftype) in self.fields:
@@ -260,14 +262,20 @@ class StructType(ESIType):
 
   def serialize(self, obj) -> bytearray:
     ret = bytearray()
-    for (fname, ftype) in reversed(self.fields):
+    if not isinstance(obj, dict):
+      obj = obj.__dict__
+    ordered_fields = reversed(
+        self.fields) if self.cpp_type.reverse else self.fields
+    for (fname, ftype) in ordered_fields:
       fval = obj[fname]
       ret.extend(ftype.serialize(fval))
     return ret
 
   def deserialize(self, data: bytearray) -> Tuple[Dict[str, Any], bytearray]:
     ret = {}
-    for (fname, ftype) in reversed(self.fields):
+    ordered_fields = reversed(
+        self.fields) if self.cpp_type.reverse else self.fields
+    for (fname, ftype) in ordered_fields:
       (fval, data) = ftype.deserialize(data)
       ret[fname] = fval
     return (ret, data)

esiaccel/utils.py

@@ -40,5 +40,15 @@ def run_cppgen():
   return codegen.run()
 
 
-def get_cmake_dir():
+def get_cmake_dir() -> Path:
   return _thisdir / "cmake"
+
+
+def get_dll_dir() -> Path:
+  """Return the directory where the ESI dll's are located"""
+  import sys
+  import os
+  if sys.platform == "win32":
+    return _thisdir
+  else:
+    return _thisdir / "lib"

{esiaccel-0.1.5.dev93.dist-info → esiaccel-0.1.5.dev107.dist-info}/METADATA

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

{esiaccel-0.1.5.dev93.dist-info → esiaccel-0.1.5.dev107.dist-info}/RECORD

@@ -1,19 +1,19 @@
-esiaccel/CosimBackend.dll,sha256=ozoEzvXMWeOlk_1H-52BFZIjvubx-RhniL58MPWhmfs,7150592
-esiaccel/CosimBackend.lib,sha256=5-p0KcNVY5sy5f3H59i2V6w-jXAiy_eVBrXLki3GuAY,4991546
-esiaccel/ESICppRuntime.dll,sha256=LnwmG1RadcFSQSxFYjuMmlvVBlRq4L7u_DZFopK-JRs,3721728
-esiaccel/ESICppRuntime.lib,sha256=PhqlDlxNWjShXt4I58b5VgrerTgIG9DQU787cVqxh30,14530116
-esiaccel/EsiCosimDpiServer.dll,sha256=BD0cUT2uiQv4jUl4IC4Uju1x6DvLQGyrbqHoUQqDBaA,159744
+esiaccel/CosimBackend.dll,sha256=0veW9ijJLlvlM-VPVlxNTxrqd26Ny47gBBIpRBLbASg,7152128
+esiaccel/CosimBackend.lib,sha256=UjflmgR93Kl22Du0lTqGhXWQqWEF-V8VwcqUuFo8GNk,4992924
+esiaccel/ESICppRuntime.dll,sha256=dxcVfC7bm9J__GZVlI9Y_9WIItmSuWxjM4L49q4Lt1Q,4072448
+esiaccel/ESICppRuntime.lib,sha256=zpBXrDVpgUYN8m56gh-qEpMMCgp3C9nOB_1GqKyKDAs,15137922
+esiaccel/EsiCosimDpiServer.dll,sha256=CM-2qznORdac-33xo31lpwnPMJhZrzU48N8nX_ki4fA,159744
 esiaccel/EsiCosimDpiServer.lib,sha256=bYBigD0RtRRSEiDxf4_gvpasLjD8fcUmC0CjRgQiQ0s,604164
-esiaccel/MtiPli.dll,sha256=kZzylUcjHJQ6FB224YnjDTTpdGAfTwQhbpcm8WQz-cg,14848
+esiaccel/MtiPli.dll,sha256=K6fBPe8Qu4MtFoq4iSBPjO0DESRcgPlCO0M7VkGbWSc,14848
 esiaccel/MtiPli.lib,sha256=X0PcXwheCUvBMgQ5BAawePxbXQSLNk5M1FFn6V56ydo,14570
-esiaccel/__init__.py,sha256=C0GLqCQuF5g5qTzmAkf_YAHmBV2XAyiJad3Qz7h8u1g,562
+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.cp310-win_amd64.pyd,sha256=36UECYviqC8s5B8puXz8eClZ6XF6BLxAYV-T7yjsaFc,496128
-esiaccel/esiquery.exe,sha256=0FC3KdBHplJlHgI6rsc-KM7uq_HdC99DLR4GY4iHcQc,441856
-esiaccel/types.py,sha256=LtBYmpmSBlzbB-f_4XqcptmseqI6Q0ibnNWJT3G-GI8,18696
-esiaccel/utils.py,sha256=0_A8Jw3M7mjvjTHeV6u00tvRWxLnWKdFq_6NFKTgbVk,1296
+esiaccel/esiCppAccel.cp310-win_amd64.pyd,sha256=GFB_ibSo-ZfG73aNoH93hUW8kdlZQxq6lKrhQYwhl6c,500224
+esiaccel/esiquery.exe,sha256=rGKSf8l-bEruBCe_kM5XCu2_zKID_9iyaJp5f3NCFXM,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
@@ -22,7 +22,7 @@ esiaccel/cosim/driver.cpp,sha256=DrEKkSN7Y_Hu7wcaUulH5mbC2L4yB9xLClRMeRUpzHM,384
 esiaccel/cosim/driver.sv,sha256=ro-j9GM164A1W0MDPkqYfEn3TUKHSqVvgjO31fnloQI,1428
 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=pR2cqBEgKRYeJsHatjE7MC5WAw9SGbcO-JOyIGjIwF8,5503
+esiaccel/include/esi/Common.h,sha256=IGJvAU72dlearXFbSmlXFFriy8aomirp7opEBjgewek,5775
 esiaccel/include/esi/Context.h,sha256=Tk_4nBDtTeVY62GfX4Cs_ZMIQstjSgrWHddN_PKANEA,2396
 esiaccel/include/esi/Design.h,sha256=mU8OwpCYijiWSdDq17l45LMzZxBca93nosudWCXNHfQ,4922
 esiaccel/include/esi/Engines.h,sha256=bbGbhXjYMpIpXh_DR0OS57zyGQUIDXh_S7xHX3su0Y0,4831
@@ -30,14 +30,14 @@ esiaccel/include/esi/Logging.h,sha256=sHqMcpp0lNIHkIEyvSm-BBWx4zXXh6NOATCgZpgzYI
 esiaccel/include/esi/Manifest.h,sha256=j3v9UA0ogtJQBlv6k5s4j_3sCsq-gwF9btVg5dKTBlg,2244
 esiaccel/include/esi/Ports.h,sha256=T2WbPBViUSvFbO5Jjxlcp_eGq9jMitguvNnz3O0564U,10543
 esiaccel/include/esi/Services.h,sha256=H7Iq3F3LivSZHblFJmrC8RAU_MftfKAPDtyGBfJ2nP4,14815
-esiaccel/include/esi/Types.h,sha256=P4ExO8-zvm7qQocUmkM_ATIvamxtDZ8JT2ToLkFo1dk,5483
+esiaccel/include/esi/Types.h,sha256=zAwdD24BtXFXMBNCkEy59pQ0r_NLM4GyxqIgjWuQ6ac,8675
 esiaccel/include/esi/Utils.h,sha256=KPd75GajIFeTBVJocXBjwsJqhbZg-ShWZCIe3oQdBss,3061
 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.dev93.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
-esiaccel-0.1.5.dev93.dist-info/METADATA,sha256=54v_sDwTnOYIdAn_OsDKFrbXthsDYxQWTIDcbfa15vE,16147
-esiaccel-0.1.5.dev93.dist-info/WHEEL,sha256=KUuBC6lxAbHCKilKua8R9W_TM71_-9Sg5uEP3uDWcoU,101
-esiaccel-0.1.5.dev93.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
-esiaccel-0.1.5.dev93.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
-esiaccel-0.1.5.dev93.dist-info/RECORD,,
+esiaccel-0.1.5.dev107.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
+esiaccel-0.1.5.dev107.dist-info/METADATA,sha256=vVWw_5dsXSxjz0I_apI9ldCbqYQdzYCLAyQmi7VAtx0,16148
+esiaccel-0.1.5.dev107.dist-info/WHEEL,sha256=KUuBC6lxAbHCKilKua8R9W_TM71_-9Sg5uEP3uDWcoU,101
+esiaccel-0.1.5.dev107.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
+esiaccel-0.1.5.dev107.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
+esiaccel-0.1.5.dev107.dist-info/RECORD,,