esiaccel 0.0.10__cp310-cp310-win_amd64.whl → 0.1.5.dev406__cp310-cp310-win_amd64.whl

esiaccel/include/esi/Utils.h

@@ -28,6 +28,11 @@ namespace utils {
 // Very basic base64 encoding.
 void encodeBase64(const void *data, size_t size, std::string &out);
 
+/// C++'s stdlib doesn't have a hash_combine function. This is a simple one.
+inline size_t hash_combine(size_t h1, size_t h2) {
+  return h1 + 0x9e3779b9 + (h2 << 6) + (h2 >> 2);
+}
+
 /// Thread safe queue. Just wraps std::queue protected with a lock. Long term,
 /// we need to avoid copying data. It has a lot of data copies currently.
 template <typename T>

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

@@ -0,0 +1,85 @@
+//===- Cosim.h - ESI C++ cosimulation backend -------------------*- 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
+//
+//===----------------------------------------------------------------------===//
+//
+// 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.
+//
+// DO NOT EDIT!
+// This file is distributed as part of an ESI package. The source for this file
+// should always be modified within CIRCT (lib/dialect/ESI/runtime/cpp).
+//
+//===----------------------------------------------------------------------===//
+
+// NOLINTNEXTLINE(llvm-header-guard)
+#ifndef ESI_BACKENDS_COSIM_H
+#define ESI_BACKENDS_COSIM_H
+
+#include "esi/Accelerator.h"
+
+#include <memory>
+#include <set>
+
+namespace esi {
+namespace cosim {
+class ChannelDesc;
+}
+
+namespace backends {
+namespace cosim {
+class CosimEngine;
+
+/// Connect to an ESI simulation.
+class CosimAccelerator : public esi::AcceleratorConnection {
+  friend class CosimEngine;
+
+public:
+  CosimAccelerator(Context &, std::string hostname, uint16_t port);
+  ~CosimAccelerator();
+
+  static std::unique_ptr<AcceleratorConnection>
+  connect(Context &, std::string connectionString);
+
+  // Different ways to retrieve the manifest in Cosimulation.
+  enum ManifestMethod {
+    Cosim, // Use the backdoor cosim interface. Default.
+    MMIO,  // Use MMIO emulation.
+  };
+  // 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;
+
+protected:
+  virtual Service *createService(Service::Type service, AppIDPath path,
+                                 std::string implName,
+                                 const ServiceImplDetails &details,
+                                 const HWClientDetails &clients) override;
+
+private:
+  StubContainer *rpcClient;
+
+  // We own all channels connected to rpcClient since their lifetime is tied to
+  // rpcClient.
+  std::set<std::unique_ptr<ChannelPort>> channels;
+
+  ManifestMethod manifestMethod = Cosim;
+};
+
+} // namespace cosim
+} // namespace backends
+} // namespace esi
+
+#endif // ESI_BACKENDS_COSIM_H

esiaccel/include/esi/backends/RpcServer.h

@@ -0,0 +1,55 @@
+//===- RpcServer.h - Run a cosim server -------------------------*- 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
+//
+//===----------------------------------------------------------------------===//
+//
+// Setup and run a server accepting connections via the 'cosim' RPC protocol.
+// Then, one can request ports to and from the clients.
+//
+// Abstract this out to support multi-party communication in the future.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef ESI_COSIM_RPCSERVER_H
+#define ESI_COSIM_RPCSERVER_H
+
+#include "esi/Ports.h"
+
+namespace esi {
+namespace cosim {
+
+/// TODO: make this a proper backend (as much as possible).
+class RpcServer {
+public:
+  ~RpcServer();
+
+  /// Set the manifest and version. There is a race condition here in that the
+  /// RPC server can be started and a connection from the client could happen
+  /// before the manifest is set. TODO: rework the DPI API to require that the
+  /// manifest gets set first.
+  void setManifest(int esiVersion,
+                   const std::vector<uint8_t> &compressedManifest);
+
+  /// Register a read or write port which communicates over RPC.
+  ReadChannelPort &registerReadPort(const std::string &name,
+                                    const std::string &type);
+  WriteChannelPort &registerWritePort(const std::string &name,
+                                      const std::string &type);
+
+  void stop();
+  void run(int port);
+
+  /// Hide the implementation details from this header file.
+  class Impl;
+
+private:
+  Impl *impl = nullptr;
+};
+
+} // namespace cosim
+} // namespace esi
+
+#endif // ESI_COSIM_RPCSERVER_H

esiaccel/include/esi/backends/Trace.h

@@ -43,6 +43,9 @@ public:
     // Data read from the accelerator is read from the trace file.
     // TODO: Full trace mode not yet supported.
     // Read
+
+    // Discard all data sent to the accelerator. Disable trace file generation.
+    Discard,
   };
 
   /// Create a trace-based accelerator backend.
@@ -61,13 +64,13 @@ public:
 
   /// Internal implementation.
   struct Impl;
-
-  /// Request the host side channel ports for a particular instance (identified
-  /// by the AppID path). For convenience, provide the bundle type.
-  std::map<std::string, ChannelPort &>
-  requestChannelsFor(AppIDPath, const BundleType *) override;
+  Impl &getImpl();
 
 protected:
+  void createEngine(const std::string &engineTypeName, AppIDPath idPath,
+                    const ServiceImplDetails &details,
+                    const HWClientDetails &clients) override;
+
   virtual Service *createService(Service::Type service, AppIDPath idPath,
                                  std::string implName,
                                  const ServiceImplDetails &details,