esiaccel 0.1.5.dev67__cp312-cp312-win_amd64.whl → 0.1.5.dev71__cp312-cp312-win_amd64.whl

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,13 @@ 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 +122,13 @@ 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 +158,13 @@ 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 +178,26 @@ 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.
@@ -153,6 +220,13 @@ 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;
+
 private:
   FieldVector fields;
 };
@@ -172,6 +246,13 @@ 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

@@ -15,7 +15,6 @@ from __future__ import annotations
 from . import esiCppAccel as cpp
 
 from typing import TYPE_CHECKING
-
 if TYPE_CHECKING:
   from .accelerator import HWModule
 
@@ -27,33 +26,22 @@ import traceback
 
 def _get_esi_type(cpp_type: cpp.Type):
   """Get the wrapper class for a C++ type."""
-  if isinstance(cpp_type, cpp.ChannelType):
-    return _get_esi_type(cpp_type.inner)
-
-  for cpp_type_cls, wrapper_cls in __esi_mapping.items():
+  for cpp_type_cls, fn in __esi_mapping.items():
     if isinstance(cpp_type, cpp_type_cls):
-      return wrapper_cls.wrap_cpp(cpp_type)
-  return ESIType.wrap_cpp(cpp_type)
+      return fn(cpp_type)
+  return ESIType(cpp_type)
 
 
-# Mapping from C++ types to wrapper classes
-__esi_mapping: Dict[Type, Type] = {}
+# Mapping from C++ types to functions constructing the Python object
+# corresponding to that type.
+__esi_mapping: Dict[Type, Callable] = {
+    cpp.ChannelType: lambda cpp_type: _get_esi_type(cpp_type.inner)
+}
 
 
 class ESIType:
 
-  def __init__(self, id: str):
-    self._init_from_cpp(cpp.Type(id))
-
-  @classmethod
-  def wrap_cpp(cls, cpp_type: cpp.Type):
-    """Wrap a C++ ESI type with its corresponding Python ESI Type."""
-    instance = cls.__new__(cls)
-    instance._init_from_cpp(cpp_type)
-    return instance
-
-  def _init_from_cpp(self, cpp_type: cpp.Type):
-    """Initialize instance attributes from a C++ type object."""
+  def __init__(self, cpp_type: cpp.Type):
     self.cpp_type = cpp_type
 
   @property
@@ -98,9 +86,6 @@ class ESIType:
 
 class VoidType(ESIType):
 
-  def __init__(self, id: str):
-    self._init_from_cpp(cpp.VoidType(id))
-
   def is_valid(self, obj) -> Tuple[bool, Optional[str]]:
     if obj is not None:
       return (False, f"void type cannot must represented by None, not {obj}")
@@ -125,8 +110,8 @@ __esi_mapping[cpp.VoidType] = VoidType
 
 class BitsType(ESIType):
 
-  def __init__(self, id: str, width: int):
-    self._init_from_cpp(cpp.BitsType(id, width))
+  def __init__(self, cpp_type: cpp.BitsType):
+    self.cpp_type: cpp.BitsType = cpp_type
 
   def is_valid(self, obj) -> Tuple[bool, Optional[str]]:
     if not isinstance(obj, (bytearray, bytes, list)):
@@ -158,8 +143,8 @@ __esi_mapping[cpp.BitsType] = BitsType
 
 class IntType(ESIType):
 
-  def __init__(self, id: str, width: int):
-    self._init_from_cpp(cpp.IntegerType(id, width))
+  def __init__(self, cpp_type: cpp.IntegerType):
+    self.cpp_type: cpp.IntegerType = cpp_type
 
   @property
   def bit_width(self) -> int:
@@ -168,9 +153,6 @@ class IntType(ESIType):
 
 class UIntType(IntType):
 
-  def __init__(self, id: str, width: int):
-    self._init_from_cpp(cpp.UIntType(id, width))
-
   def is_valid(self, obj) -> Tuple[bool, Optional[str]]:
     if not isinstance(obj, int):
       return (False, f"must be an int, not {type(obj)}")
@@ -194,9 +176,6 @@ __esi_mapping[cpp.UIntType] = UIntType
 
 class SIntType(IntType):
 
-  def __init__(self, id: str, width: int):
-    self._init_from_cpp(cpp.SIntType(id, width))
-
   def is_valid(self, obj) -> Tuple[bool, Optional[str]]:
     if not isinstance(obj, int):
       return (False, f"must be an int, not {type(obj)}")
@@ -224,16 +203,11 @@ __esi_mapping[cpp.SIntType] = SIntType
 
 class StructType(ESIType):
 
-  def __init__(self, id: str, fields: List[Tuple[str, "ESIType"]]):
-    # Convert Python ESIType fields to cpp Type fields
-    cpp_fields = [(name, field_type.cpp_type) for name, field_type in fields]
-    self._init_from_cpp(cpp.StructType(id, cpp_fields))
-
-  def _init_from_cpp(self, cpp_type: cpp.StructType):
-    """Initialize instance attributes from a C++ type object."""
-    super()._init_from_cpp(cpp_type)
-    # For wrap_cpp path, we need to convert C++ fields back to Python
-    self.fields = [(name, _get_esi_type(ty)) for (name, ty) in cpp_type.fields]
+  def __init__(self, cpp_type: cpp.StructType):
+    self.cpp_type = cpp_type
+    self.fields: List[Tuple[str, ESIType]] = [
+        (name, _get_esi_type(ty)) for (name, ty) in cpp_type.fields
+    ]
 
   @property
   def bit_width(self) -> int:
@@ -278,12 +252,8 @@ __esi_mapping[cpp.StructType] = StructType
 
 class ArrayType(ESIType):
 
-  def __init__(self, id: str, element_type: "ESIType", size: int):
-    self._init_from_cpp(cpp.ArrayType(id, element_type.cpp_type, size))
-
-  def _init_from_cpp(self, cpp_type: cpp.ArrayType):
-    """Initialize instance attributes from a C++ type object."""
-    super()._init_from_cpp(cpp_type)
+  def __init__(self, cpp_type: cpp.ArrayType):
+    self.cpp_type = cpp_type
     self.element_type = _get_esi_type(cpp_type.element)
     self.size = cpp_type.size
 

{esiaccel-0.1.5.dev67.dist-info → esiaccel-0.1.5.dev71.dist-info}/METADATA

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

{esiaccel-0.1.5.dev67.dist-info → esiaccel-0.1.5.dev71.dist-info}/RECORD

@@ -1,18 +1,18 @@
-esiaccel/CosimBackend.dll,sha256=fgqt-B98or2gN5JGbeYVUXjCwaEKaP6C5_0SmkN-4QI,7150592
-esiaccel/CosimBackend.lib,sha256=8Fyulmz95ENysUTuD0iZJQvYbSmut971I2rTbIrFBzM,4991546
-esiaccel/ESICppRuntime.dll,sha256=sg3vyrI2KH1HyV5O3lyKBBNg91Ef2iPrkvgQMZ2uVIk,3721728
-esiaccel/ESICppRuntime.lib,sha256=6x7L5j_dXvWvnVQqtk7mYYWWECCf7dsiHYtx21_-hDA,14530116
-esiaccel/EsiCosimDpiServer.dll,sha256=ij6phU54C0hgF1Qi6lmDBz7B-PntO-LDovWMFd6Vkco,159744
-esiaccel/EsiCosimDpiServer.lib,sha256=MoMCezJdQ9qhdHtUicRVY7CrmYWfUwM2zK8flQxz5pY,604164
-esiaccel/MtiPli.dll,sha256=2z6x8HKZfHElygB8eBD8QBngGrNrURDw5FsxUBNABL4,14848
-esiaccel/MtiPli.lib,sha256=ZhsT1gjT0a2_jT_SKm_z_RHbFKAZ7kOLJ3U9dfCpjiY,14570
+esiaccel/CosimBackend.dll,sha256=6i8cr_i9aBk_M5uDqeAR7gin0yuJfB-eLBtku-c_jWo,7152128
+esiaccel/CosimBackend.lib,sha256=S1wD7i3dUYU1AmrlONIqggtOUbt9oxOGVmzZwXaPQnk,4992914
+esiaccel/ESICppRuntime.dll,sha256=lzxARaXRQLKb6VGOjULuMZMlSWSFoT_-1xFsW3rJFCw,4068352
+esiaccel/ESICppRuntime.lib,sha256=bWRxqgq0CYXlsMuJQZNetNhRQiw9JJgfM-NLiaMHHqA,15124618
+esiaccel/EsiCosimDpiServer.dll,sha256=rFcPBt-2UvnIIQrBE6AfqmvDCzHJE2MBwQEVrvtNrh0,159744
+esiaccel/EsiCosimDpiServer.lib,sha256=bYBigD0RtRRSEiDxf4_gvpasLjD8fcUmC0CjRgQiQ0s,604164
+esiaccel/MtiPli.dll,sha256=3mGiklSpt-U5-gelGvXfosqcGljVgekRbZoNz40m2SY,14848
+esiaccel/MtiPli.lib,sha256=X0PcXwheCUvBMgQ5BAawePxbXQSLNk5M1FFn6V56ydo,14570
 esiaccel/__init__.py,sha256=C0GLqCQuF5g5qTzmAkf_YAHmBV2XAyiJad3Qz7h8u1g,562
 esiaccel/accelerator.py,sha256=BcXPsUqcQV3YsVVyYbz9P6JnZLlcnuageFbJwID9_3s,3318
 esiaccel/codegen.py,sha256=uoYELtnIabVvgLeCABj-mWras0BvmSKABPH-cd9nDFk,6560
 esiaccel/esi-cosim.py,sha256=GwYfNh4aagypheAhGf0EIX6ojkLYKkc5OMlFR9pfXe8,14381
-esiaccel/esiCppAccel.cp312-win_amd64.pyd,sha256=iqbsgcGfmCBf3MUqZ-q7yCwPfzlMbDcKRYz-ipdYnVo,506880
-esiaccel/esiquery.exe,sha256=ZdkEuzLEWIo-p0fZKXR6oAosHA9yxo4aVff0FcFM9Xc,441856
-esiaccel/types.py,sha256=LtBYmpmSBlzbB-f_4XqcptmseqI6Q0ibnNWJT3G-GI8,18696
+esiaccel/esiCppAccel.cp312-win_amd64.pyd,sha256=G0K6-DKgGIwNfgWTZk6IfQqiZCis7lycJ2fZS6DK930,467968
+esiaccel/esiquery.exe,sha256=7W6bc5Us8HIaPcoN3ct9qcEP5I6ELMwrWapANViM0Pg,441856
+esiaccel/types.py,sha256=xR7XbXQ8LqoiiniThYJhqphG813KBNi5d-yHm5bEXtg,17465
 esiaccel/utils.py,sha256=0_A8Jw3M7mjvjTHeV6u00tvRWxLnWKdFq_6NFKTgbVk,1296
 esiaccel/cmake/esiaccelConfig.cmake,sha256=u2aW99k1lEcmYTG1P3BTJqtmDrj53wUUaBz_jzw8kYY,565
 esiaccel/cosim/Cosim_DpiPkg.sv,sha256=9qGn1VyAVrzBP5At1thV6xrovg0WghICD01Zz9J221E,3458
@@ -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=ZfPCyeVSHIZ7_jwBl1SFd0XrkqFDEk3LvCcBKnGvjF4,8327
 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.dev67.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
-esiaccel-0.1.5.dev67.dist-info/METADATA,sha256=J7tMwe7y1xSpcVIBs0dT8J26XXecyf4cmVCLiz2HInE,16147
-esiaccel-0.1.5.dev67.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
-esiaccel-0.1.5.dev67.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
-esiaccel-0.1.5.dev67.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
-esiaccel-0.1.5.dev67.dist-info/RECORD,,
+esiaccel-0.1.5.dev71.dist-info/licenses/LICENSE,sha256=vtnVnB8_lN1yPYcA5MeT56R8UsQtBhyzZLBvu_KMf7I,13468
+esiaccel-0.1.5.dev71.dist-info/METADATA,sha256=k7H3Z3P-PQ2EMvZlMYHPhNocpRQ_m-y_TG8nFW_tLqg,16147
+esiaccel-0.1.5.dev71.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
+esiaccel-0.1.5.dev71.dist-info/entry_points.txt,sha256=_CuNLV0fyTURxRREFwpzGycifZW_-7-MyuJNEwKK9J8,137
+esiaccel-0.1.5.dev71.dist-info/top_level.txt,sha256=fYWTWMDK4PDu4ePQ9NtcFHas2k8-d1kWhTs2avPpgB4,9
+esiaccel-0.1.5.dev71.dist-info/RECORD,,