esiaccel 0.1.5.dev254__cp311-cp311-win_amd64.whl → 0.2.3.dev47__cp311-cp311-win_amd64.whl

esiaccel/include/esi/Types.h

@@ -26,6 +26,7 @@
 #include <vector>
 
 #include "esi/Common.h"
+#include "esi/Values.h" // For BitVector / Int / UInt
 
 namespace esi {
 
@@ -39,20 +40,29 @@ 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 {
+  /// Serialize an object to a MutableBitVector (LSB-first stream). The object
+  /// should be passed via std::any. Implementations append fields in the order
+  /// they are iterated (the first serialized field occupies the
+  /// least-significant bits of the result).
+  virtual MutableBitVector 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 {
+  /// Deserialize from a BitVector stream (LSB-first). Implementations consume
+  /// bits from 'data' in-place (via logical right shifts) and return the
+  /// reconstructed value. Remaining bits stay in 'data'.
+  virtual std::any deserialize(BitVector &data) const {
     throw std::runtime_error("Deserialization not implemented for type " + id);
   }
 
+  // Deserialize from a MessageData buffer. Maps the MessageData onto a
+  // MutableBitVector, and proceeds with regular MutableBitVector
+  // deserialization.
+  std::any deserialize(const MessageData &data) const {
+    auto bv = MutableBitVector(std::vector<uint8_t>(data.getData()));
+    return deserialize(bv);
+  }
+
   /// 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 {
@@ -70,6 +80,12 @@ public:
     }
   }
 
+  // Dump a textual representation of this type to the provided stream.
+  void dump(std::ostream &os, bool oneLine = false) const;
+
+  // Return a textual representation of this type.
+  std::string toString(bool oneLine = false) const;
+
 protected:
   ID id;
 };
@@ -101,14 +117,14 @@ protected:
 /// carry one values of one type.
 class ChannelType : public Type {
 public:
+  using Type::deserialize;
   ChannelType(const ID &id, const Type *inner) : Type(id), inner(inner) {}
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 
 private:
   const Type *inner;
@@ -117,14 +133,14 @@ private:
 /// The "void" type is a special type which can be used to represent no type.
 class VoidType : public Type {
 public:
+  using Type::deserialize;
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 };
 
 /// The "any" type is a special type which can be used to represent any type, as
@@ -154,11 +170,11 @@ private:
 class BitsType : public BitVectorType {
 public:
   using BitVectorType::BitVectorType;
+  using Type::deserialize;
 
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 };
 
 /// Integers are bit vectors which may be signed or unsigned and are interpreted
@@ -172,28 +188,29 @@ public:
 class SIntType : public IntegerType {
 public:
   using IntegerType::IntegerType;
+  using Type::deserialize;
 
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 };
 
 /// Unsigned integer.
 class UIntType : public IntegerType {
 public:
   using IntegerType::IntegerType;
+  using Type::deserialize;
 
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 };
 
 /// Structs are an ordered collection of fields, each with a name and a type.
 class StructType : public Type {
 public:
   using FieldVector = std::vector<std::pair<std::string, const Type *>>;
+  using Type::deserialize;
 
   StructType(const ID &id, const FieldVector &fields, bool reverse = true)
       : Type(id), fields(fields), reverse(reverse) {}
@@ -211,9 +228,8 @@ public:
   }
 
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 
   // Returns whether this struct type should be reversed when
   // serializing/deserializing.
@@ -230,11 +246,14 @@ private:
 /// Arrays have a compile time specified (static) size and an element type.
 class ArrayType : public Type {
 public:
-  ArrayType(const ID &id, const Type *elementType, uint64_t size)
-      : Type(id), elementType(elementType), size(size) {}
+  ArrayType(const ID &id, const Type *elementType, uint64_t size,
+            bool reverse = true)
+      : Type(id), elementType(elementType), size(size), reverse(reverse) {}
+  using Type::deserialize;
 
   const Type *getElementType() const { return elementType; }
   uint64_t getSize() const { return size; }
+  bool isReverse() const { return reverse; }
   std::ptrdiff_t getBitWidth() const override {
     std::ptrdiff_t elementSize = elementType->getBitWidth();
     if (elementSize < 0)
@@ -243,13 +262,71 @@ public:
   }
 
   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;
+  MutableBitVector serialize(const std::any &obj) const override;
+  std::any deserialize(BitVector &data) const override;
 
 private:
   const Type *elementType;
   uint64_t size;
+  // 'reverse' controls whether array elements are reversed during
+  // serialization/deserialization (to match SystemVerilog/Python ordering
+  // expectations).
+  bool reverse;
+};
+
+/// Windows represent a fixed-size sliding window over a stream of data.
+/// They define an "into" type (the data structure being windowed) and a
+/// "loweredType" (the hardware representation including control signals).
+class WindowType : public Type {
+public:
+  /// Field information describing a field within a frame.
+  struct Field {
+    std::string name;
+    uint64_t numItems = 0;       // 0 means not specified (use all items)
+    uint64_t bulkCountWidth = 0; // 0 means parallel encoding, >0 means serial
+  };
+
+  /// Frame information describing which fields are included in a particular
+  /// frame.
+  struct Frame {
+    std::string name;
+    std::vector<Field> fields;
+  };
+
+  WindowType(const ID &id, const std::string &name, const Type *intoType,
+             const Type *loweredType, const std::vector<Frame> &frames)
+      : Type(id), name(name), intoType(intoType), loweredType(loweredType),
+        frames(frames) {}
+
+  const std::string &getName() const { return name; }
+  const Type *getIntoType() const { return intoType; }
+  const Type *getLoweredType() const { return loweredType; }
+  const std::vector<Frame> &getFrames() const { return frames; }
+
+  std::ptrdiff_t getBitWidth() const override {
+    return loweredType->getBitWidth();
+  }
+
+private:
+  std::string name;
+  const Type *intoType;
+  const Type *loweredType;
+  std::vector<Frame> frames;
+};
+
+/// Lists represent variable-length sequences of elements of a single type.
+/// Unlike arrays which have a fixed size, lists can have any length.
+class ListType : public Type {
+public:
+  ListType(const ID &id, const Type *elementType)
+      : Type(id), elementType(elementType) {}
+
+  const Type *getElementType() const { return elementType; }
+
+  std::ptrdiff_t getBitWidth() const override { return -1; }
+
+private:
+  const Type *elementType;
 };
 
 } // namespace esi

esiaccel/include/esi/Values.h

@@ -0,0 +1,313 @@
+//===- values.h - ESI value system -------------------------------* C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+// ESI arbitrary width bitvector and integer types.
+// These types are not meant to be highly optimized. Rather, its a simple
+// implementation to support arbitrary bit widths for ESI runtime values.
+//
+//===----------------------------------------------------------------------===//
+// DO NOT EDIT!
+// This file is distributed as part of an ESI package. The source for this file
+// should always be modified within CIRCT.
+//
+//===----------------------------------------------------------------------===//
+
+// NOLINTNEXTLINE(llvm-header-guard)
+#ifndef ESI_VALUES_H
+#define ESI_VALUES_H
+
+#include <cstdint>
+#include <format>
+#include <memory> // (may be removable later)
+#include <optional>
+#include <ostream>
+#include <span>
+#include <stdexcept>
+#include <string>
+#include <vector>
+
+namespace esi {
+
+class MutableBitVector;
+
+/// A lightweight, non-owning bit vector view backed by a byte array span.
+/// BitVector is immutable wrt. modifying the underlying bits, and provides
+/// read-only access to bits. It supports bit-level access and returns new views
+/// for operations.
+class BitVector {
+public:
+  using byte = uint8_t;
+
+  /// Construct from an existing span. Width defaults to the number of bits in
+  /// the span (size * 8). The BitVector does not take ownership.
+  BitVector(std::span<const byte> bytes,
+            std::optional<size_t> width = std::nullopt, uint8_t bitIndex = 0);
+  BitVector() = default;
+  BitVector(const BitVector &other);
+  BitVector &operator=(const BitVector &other);
+
+  size_t width() const { return bitWidth; }
+  size_t size() const { return width(); }
+
+  /// Return the i-th bit (0 = LSB) as boolean.
+  bool getBit(size_t i) const;
+
+  /// Return a handle to the underlying span. Throws if the current bit index
+  /// is not 0 (since a non-zero bit offset breaks raw byte alignment).
+  std::span<const byte> getSpan() const {
+    if (bitIndex != 0)
+      throw std::runtime_error("Cannot get data span with non-zero bit index");
+    return data;
+  }
+
+  /// Logical right shift that drops the least-significant n bits by advancing
+  /// the byte/bit index and reducing width. Returns a new immutable
+  /// view. Does not modify the underlying storage contents.
+  BitVector operator>>(size_t n) const;
+  BitVector &operator>>=(size_t n);
+
+  /// Create a new immutable view of a contiguous bit slice [offset,
+  /// offset+sliceWidth). The returned BitVector is a view (not an owning copy)
+  /// into the same underlying span. Throws if the requested slice exceeds the
+  /// current width.
+  BitVector slice(size_t offset, size_t sliceWidth) const;
+
+  /// Return a view of the N least-significant bits.
+  BitVector lsb(size_t n) const { return slice(0, n); }
+
+  /// Return a view of the N most-significant bits.
+  BitVector msb(size_t n) const {
+    if (n > bitWidth)
+      throw std::invalid_argument("msb width exceeds bit width");
+    return slice(bitWidth - n, n);
+  }
+
+  std::string toString(unsigned base = 16) const;
+
+  bool operator==(const BitVector &rhs) const;
+  bool operator!=(const BitVector &rhs) const { return !(*this == rhs); }
+
+  /// Bitwise AND: creates a new MutableBitVector with the result.
+  friend MutableBitVector operator&(const BitVector &a, const BitVector &b);
+
+  /// Bitwise OR: creates a new MutableBitVector with the result.
+  friend MutableBitVector operator|(const BitVector &a, const BitVector &b);
+
+  /// Bitwise XOR: creates a new MutableBitVector with the result.
+  friend MutableBitVector operator^(const BitVector &a, const BitVector &b);
+
+  /// Forward iterator for iterating over bits from LSB (index 0) to MSB.
+  class bit_iterator {
+  public:
+    using difference_type = std::ptrdiff_t;
+    using value_type = bool;
+    using pointer = const bool *;
+    using reference = bool;
+    using iterator_category = std::forward_iterator_tag;
+
+    /// Default constructor.
+    bit_iterator() = default;
+
+    /// Construct an iterator at the given bit position.
+    bit_iterator(const BitVector *bv, size_t pos = 0)
+        : bitVector(bv), position(pos) {}
+
+    /// Dereference: returns the bit value at the current position.
+    bool operator*() const {
+      if (bitVector == nullptr || position >= bitVector->bitWidth)
+        throw std::out_of_range("bit_iterator dereference out of range");
+      return bitVector->getBit(position);
+    }
+
+    /// Pre-increment: move to next bit.
+    bit_iterator &operator++() {
+      ++position;
+      return *this;
+    }
+
+    /// Post-increment: move to next bit.
+    bit_iterator operator++(int) {
+      bit_iterator tmp = *this;
+      ++position;
+      return tmp;
+    }
+
+    /// Equality comparison.
+    bool operator==(const bit_iterator &other) const {
+      return bitVector == other.bitVector && position == other.position;
+    }
+
+    /// Inequality comparison.
+    bool operator!=(const bit_iterator &other) const {
+      return !(*this == other);
+    }
+
+    /// Less-than comparison (for ranges support).
+    bool operator<(const bit_iterator &other) const {
+      return bitVector == other.bitVector && position < other.position;
+    }
+
+    /// Sentinel-compatible equality (for ranges support).
+    bool operator==(std::default_sentinel_t) const {
+      return bitVector == nullptr || position >= bitVector->bitWidth;
+    }
+
+    /// Sentinel-compatible inequality.
+    bool operator!=(std::default_sentinel_t sent) const {
+      return !(*this == sent);
+    }
+
+  private:
+    const BitVector *bitVector = nullptr;
+    size_t position = 0;
+  };
+
+  /// Return an iterator to the first bit (LSB).
+  bit_iterator begin() const { return bit_iterator(this, 0); }
+
+  /// Return an iterator past the last bit.
+  bit_iterator end() const { return bit_iterator(this, bitWidth); }
+
+protected:
+  // Underlying storage view. const, to allow for non-owning immutable views.
+  std::span<const byte> data{};
+  size_t bitWidth = 0;  // Number of valid bits.
+  uint8_t bitIndex = 0; // Starting bit offset in first byte.
+};
+
+/// A mutable bit vector that owns its underlying storage.
+/// It supports in-place modifications and mutable operations.
+class MutableBitVector : public BitVector {
+public:
+  /// Owning, zero-initialized constructor of a given width.
+  explicit MutableBitVector(size_t width);
+
+  /// Owning constructor from an rvalue vector (must move in).
+  MutableBitVector(std::vector<byte> &&bytes,
+                   std::optional<size_t> width = std::nullopt);
+
+  MutableBitVector() = default;
+
+  // Copy constructor: duplicate storage.
+  MutableBitVector(const MutableBitVector &other);
+
+  // Copy constructor from immutable BitVector: creates owning copy.
+  MutableBitVector(const BitVector &other);
+
+  // Move constructor: transfer ownership.
+  MutableBitVector(MutableBitVector &&other) noexcept;
+
+  // Move constructor from immutable BitVector: creates owning copy.
+  MutableBitVector(BitVector &&other);
+
+  MutableBitVector &operator=(const MutableBitVector &other);
+
+  MutableBitVector &operator=(MutableBitVector &&other) noexcept;
+
+  /// Set the i-th bit.
+  void setBit(size_t i, bool v);
+
+  /// Return a handle to the underlying span (always aligned since bitIndex=0).
+  std::span<const byte> getSpan() const { return data; }
+
+  /// Return and transfer ownership of the underlying storage.
+  std::vector<uint8_t> takeStorage() { return std::move(owner); }
+
+  /// In-place logical right shift that drops the least-significant n bits.
+  /// Reduces width and updates internal state. Does not modify underlying
+  /// storage.
+  MutableBitVector &operator>>=(size_t n);
+
+  /// In-place logical left shift shifts in n zero bits at LSB, shifting
+  /// existing bits upward.
+  MutableBitVector &operator<<=(size_t n);
+
+  /// In-place concatenate: appends bits from other to this.
+  MutableBitVector &operator<<=(const MutableBitVector &other);
+
+  MutableBitVector &operator|=(const MutableBitVector &other);
+  MutableBitVector &operator&=(const MutableBitVector &other);
+  MutableBitVector &operator^=(const MutableBitVector &other);
+  MutableBitVector operator~() const;
+  MutableBitVector operator|(const MutableBitVector &other) const;
+  MutableBitVector operator&(const MutableBitVector &other) const;
+  MutableBitVector operator^(const MutableBitVector &other) const;
+
+private:
+  // Storage owned by this MutableBitVector.
+  std::vector<byte> owner;
+};
+
+std::ostream &operator<<(std::ostream &os, const BitVector &bv);
+
+// Arbitrary width signed integer type built on MutableBitVector.
+class Int : public MutableBitVector {
+public:
+  using MutableBitVector::MutableBitVector;
+  Int() = default;
+  Int(int64_t v, unsigned width = 64);
+  operator int64_t() const { return toI64(); }
+  operator int32_t() const { return toInt<int32_t>(); }
+  operator int16_t() const { return toInt<int16_t>(); }
+  operator int8_t() const { return toInt<int8_t>(); }
+
+private:
+  template <typename T>
+  T toInt() const {
+    static_assert(std::is_integral<T>::value && std::is_signed<T>::value,
+                  "T must be a signed integral type");
+    int64_t v = toI64();
+    fits(v, sizeof(T) * 8);
+    return static_cast<T>(v);
+  }
+
+  // Convert the bitvector to a signed intN_t, throwing if the value doesn't
+  // fit.
+  int64_t toI64() const;
+
+  // Check if the given value fits in the specified bit width.
+  static void fits(int64_t v, unsigned n);
+};
+
+// Arbitrary width unsigned integer type built on MutableBitVector.
+class UInt : public MutableBitVector {
+public:
+  using MutableBitVector::MutableBitVector;
+  UInt() = default;
+  UInt(uint64_t v, unsigned width = 64);
+  operator uint64_t() const { return toUI64(); }
+  operator uint32_t() const { return toUInt<uint32_t>(); }
+  operator uint16_t() const { return toUInt<uint16_t>(); }
+  operator uint8_t() const { return toUInt<uint8_t>(); }
+
+private:
+  uint64_t toUI64() const;
+
+  static void fits(uint64_t v, unsigned n);
+
+  template <typename T>
+  T toUInt() const {
+    static_assert(std::is_integral<T>::value && std::is_unsigned<T>::value,
+                  "T must be an unsigned integral type");
+    uint64_t v = toUI64();
+    fits(v, sizeof(T) * 8);
+    return static_cast<T>(v);
+  }
+};
+
+} // namespace esi
+
+// Enable BitVector and MutableBitVector to work with std::ranges algorithms
+template <>
+inline constexpr bool std::ranges::enable_borrowed_range<esi::BitVector> = true;
+
+template <>
+inline constexpr bool
+    std::ranges::enable_borrowed_range<esi::MutableBitVector> = true;
+
+#endif // ESI_VALUES_H

esiaccel/include/esi/backends/Cosim.h

@@ -7,8 +7,8 @@
 //===----------------------------------------------------------------------===//
 //
 // This is a specialization of the ESI C++ API (backend) for connection into a
-// simulation of an ESI system. Currently uses Cap'nProto RPC, but that could
-// change. Requires Cap'nProto C++ library.
+// simulation of an ESI system. Currently uses gRPC, but that could change.
+// Requires gRPC C++ library.
 //
 // DO NOT EDIT!
 // This file is distributed as part of an ESI package. The source for this file
@@ -26,13 +26,11 @@
 #include <set>
 
 namespace esi {
-namespace cosim {
-class ChannelDesc;
-}
-
 namespace backends {
 namespace cosim {
+
 class CosimEngine;
+class RpcClient;
 
 /// Connect to an ESI simulation.
 class CosimAccelerator : public esi::AcceleratorConnection {
@@ -53,11 +51,6 @@ public:
   // Set the way this connection will retrieve the manifest.
   void setManifestMethod(ManifestMethod method);
 
-  // C++ doesn't have a mechanism to forward declare a nested class and we don't
-  // want to include the generated header here. So we have to wrap it in a
-  // forward-declared struct we write ourselves.
-  struct StubContainer;
-
   void createEngine(const std::string &engineTypeName, AppIDPath idPath,
                     const ServiceImplDetails &details,
                     const HWClientDetails &clients) override;
@@ -69,7 +62,7 @@ protected:
                                  const HWClientDetails &clients) override;
 
 private:
-  StubContainer *rpcClient;
+  std::unique_ptr<RpcClient> rpcClient;
 
   // We own all channels connected to rpcClient since their lifetime is tied to
   // rpcClient.