DFCxx kernel instantiation

examples/addconst/addconst.h

@@ -10,7 +10,7 @@
 
 class AddConst : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "AddConst";
   }
 

examples/idct/idct.h

@@ -13,7 +13,7 @@ static const int32_t kSIZE = kDIM * kDIM;
 
 class IDCT : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "IDCT";
   }
 

examples/matrixmul2/matrixmul2.h

@@ -10,7 +10,7 @@
 
 class MatrixMul2 : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "MatrixMul2";
   }
 

examples/movingsum/movingsum.h

@@ -10,7 +10,7 @@
 
 class MovingSum : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "MovingSum";
   }
 

examples/muxmul/muxmul.h

@@ -10,7 +10,7 @@
 
 class MuxMul : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "MuxMul";
   }
 

examples/polynomial2/polynomial2.h

@@ -10,7 +10,7 @@
 
 class Polynomial2 : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "Polynomial2";
   }
 

examples/polynomial2_inst/add_int_2_mul_int3.json

@@ -0,0 +1,4 @@
+{
+  "ADD_INT": 2,
+  "MUL_INT": 3
+}

examples/polynomial2_inst/polynomial2_inst.cpp

@@ -0,0 +1,16 @@
+//===----------------------------------------------------------------------===//
+//
+// Part of the Utopia HLS Project, under the Apache License v2.0
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2024 ISP RAS (http://www.ispras.ru)
+//
+//===----------------------------------------------------------------------===//
+
+#include "polynomial2_inst.h"
+
+#include <memory>
+
+std::unique_ptr<dfcxx::Kernel> start() {
+  Polynomial2Inst *kernel = new Polynomial2Inst();
+  return std::unique_ptr<dfcxx::Kernel>(kernel);
+}

examples/polynomial2_inst/polynomial2_inst.h

@@ -0,0 +1,55 @@
+//===----------------------------------------------------------------------===//
+//
+// Part of the Utopia HLS Project, under the Apache License v2.0
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2024 ISP RAS (http://www.ispras.ru)
+//
+//===----------------------------------------------------------------------===//
+
+#include "dfcxx/DFCXX.h"
+
+class Polynomial2 : public dfcxx::Kernel {
+public:
+  std::string_view getName() const override {
+    return "Polynomial2";
+  }
+
+  ~Polynomial2() override = default;
+
+  Polynomial2() : dfcxx::Kernel() {
+    using dfcxx::DFType;
+    using dfcxx::DFVariable;
+
+    const DFType &type = dfUInt(32);
+    DFVariable x = io.input("x", type);
+    DFVariable squared = x * x;
+    DFVariable squaredPlusX = squared + x;
+    DFVariable result = squaredPlusX + x;
+    DFVariable out = io.output("out", type);
+    out.connect(result);
+  }
+};
+
+class Polynomial2Inst : public dfcxx::Kernel {
+public:
+  std::string_view getName() const override {
+    return "Polynomial2Inst";
+  }
+
+  ~Polynomial2Inst() override = default;
+
+  Polynomial2Inst() : dfcxx::Kernel() {
+    using dfcxx::DFType;
+    using dfcxx::DFVariable;
+
+    const DFType &type = dfUInt(32);
+    DFVariable x = io.input("x", type);
+    DFVariable intermediate = io.hollow(type);
+    instance<Polynomial2>({
+      {x, "x"},
+      {intermediate, "out"}
+    });
+    DFVariable out = io.output("out", type);
+    out.connect(intermediate);
+  }
+};

examples/polynomial2_inst/sim.txt

@@ -0,0 +1,5 @@
+x 0x32
+
+x 0x45
+
+x 0x56

examples/scalar3/scalar3.h

@@ -10,7 +10,7 @@
 
 class Scalar3 : public dfcxx::Kernel {
 public:
-  std::string_view getName() override {
+  std::string_view getName() const override {
     return "Scalar3";
   }
 

src/main.cpp

@@ -44,6 +44,7 @@ struct SimContext {
 
 int hlsMain(const HlsContext &context) {
   auto kernel = start();
+  if (!kernel->check()) { return 1; }
   bool useASAP = context.options.asapScheduler;
   return !kernel->compile(context.options.latencyCfg,
                           context.options.outNames,

src/model/dfcxx/include/dfcxx/graph.h

@@ -13,6 +13,7 @@
 #include "dfcxx/node.h"
 #include "dfcxx/vars/var.h"
 
+#include <string_view>
 #include <unordered_map>
 #include <unordered_set>
 #include <vector>
@@ -21,6 +22,7 @@ namespace dfcxx {
 
 class Graph {
 private:
+  std::unordered_map<std::string_view, Node> nameMap;
   std::unordered_set<Node> nodes;
   std::unordered_set<Node> startNodes;
   std::unordered_map<Node, std::vector<Channel>> inputs;
@@ -44,6 +46,18 @@ class Graph {
 
   void addChannel(DFVariableImpl *source, DFVariableImpl *target,
                   unsigned opInd, bool connect);
+
+  void transferFrom(Graph &&graph);
+
+  Node getNodeByName(const std::string &name);
+
+  void resetNodeName(const std::string &name);
+
+  void deleteNode(Node node);
+
+  void rebindInput(Node source, Node input, Graph &graph);
+
+  Node rebindOutput(Node output, Node target, Graph &graph);
 };
 
 } // namespace dfcxx

src/model/dfcxx/include/dfcxx/io.h

@@ -28,6 +28,10 @@ class IO {
 
   DFVariable inputScalar(const std::string &name, const DFType &type);
 
+  DFVariable hollow(const DFType &type);
+
+  DFVariable hollowScalar(const DFType &type);
+
   DFVariable output(const std::string &name, const DFType &type);
 
   DFVariable outputScalar(const std::string &name, const DFType &type);

src/model/dfcxx/include/dfcxx/kernel.h

@@ -18,9 +18,11 @@
 #include "dfcxx/types/type.h"
 #include "dfcxx/vars/var.h"
 
+#include <initializer_list>
 #include <ostream>
 #include <string>
 #include <string_view>
+#include <utility>
 #include <vector>
 
 // This forward declaration is needed to avoid
@@ -37,6 +39,12 @@ class Kernel {
 
   bool compileDot(llvm::raw_fd_ostream *stream);
 
+  void rebindInput(DFVariable source, Node input, Kernel &kern);
+
+  DFVariable rebindOutput(Node output, DFVariable target, Kernel &kern);
+
+  void deleteNode(Node node);
+
 protected:
   IO io;
   Offset offset;
@@ -51,12 +59,31 @@ class Kernel {
 
   DFType dfBool();
 
+  using IOBinding = std::pair<DFVariable&, std::string>;
+
+  template <typename Kern, typename... Args>
+  void instance(std::initializer_list<IOBinding> bindings, Args && ...args) {
+    Kern kern(std::forward<Args>(args)...);
+
+    for (auto &binding: bindings) {
+      Node node = kern.meta.graph.getNodeByName(binding.second);
+      kern.meta.graph.resetNodeName(binding.second);
+      if (node.type == OpType::IN) {
+        rebindInput(binding.first, node, kern);
+      } else {
+        binding.first = rebindOutput(node, binding.first, kern);
+      } 
+    }
+
+    meta.transferFrom(std::move(kern.meta));
+  }
+
   Kernel();
 
 public:
   virtual ~Kernel() = default;
 
-  virtual std::string_view getName() = 0;
+  virtual std::string_view getName() const = 0;
 
   const Graph &getGraph() const;
 
@@ -71,6 +98,11 @@ class Kernel {
   bool simulate(const std::string &inDataPath,
                 const std::string &outFilePath);
 
+  bool check() const;
+
+// Checker methods.
+private:
+  bool checkValidNodes() const;
 };
 
 } // namespace dfcxx

src/model/dfcxx/include/dfcxx/kernmeta.h

@@ -25,6 +25,8 @@ struct KernMeta {
   KernMeta() = default;
   KernMeta(const KernMeta &) = delete;
   ~KernMeta() = default;
+
+  void transferFrom(KernMeta &&meta);
 };
 
 } // namespace dfcxx

src/model/dfcxx/include/dfcxx/kernstorage.h

@@ -26,7 +26,11 @@ class KernStorage {
 
   DFVariableImpl *addVariable(DFVariableImpl *var);
 
+  void deleteVariable(DFVariableImpl *var);
+
   ~KernStorage();
+
+  void transferFrom(KernStorage &&storage);
 };
 
 } // namespace dfcxx

src/model/dfcxx/include/dfcxx/node.h

@@ -14,7 +14,8 @@
 namespace dfcxx {
 
 enum OpType : uint8_t {
-  OFFSET = 0,
+  NONE = 0, // Is not allowed in a fully constructed kernel.
+  OFFSET,
   IN,
   OUT,
   CONST,
@@ -53,6 +54,7 @@ struct Node {
   Node(DFVariableImpl *var, OpType type, NodeData data);
 
   bool operator==(const Node &node) const;
+  bool operator!=(const Node &node) const { return !(*this == node); }
 };
 
 } // namespace dfcxx

src/model/dfcxx/include/dfcxx/vars/var.h

@@ -50,6 +50,8 @@ class DFVariableImpl {
 
   std::string_view getName() const;
 
+  void resetName();
+
   IODirection getDirection() const;
 
   const KernMeta &getMeta() const;

src/model/dfcxx/lib/dfcxx/CMakeLists.txt

@@ -18,6 +18,7 @@ set(SOURCES
   ${VAR_BUILDERS_SOURCES}
   ${TYPE_BUILDERS_SOURCES}
   converter.cpp
+  kernmeta.cpp
   kernstorage.cpp
   io.cpp
   offset.cpp

src/model/dfcxx/lib/dfcxx/IRbuilders/builder.cpp

@@ -275,16 +275,17 @@ void DFCIRBuilder::translate(Node node, const Graph &graph,
     }
     default: {
       // TODO: Add proper logging: https://github.com/ispras/utopia-hls/issues/13
-      std::cout << "[ERROR] Unknown node type id: " << node.type << std::endl;
+      std::cout << "[ERROR] Unknown/unsupported node type id: " << node.type << std::endl;
       assert(false);
     };
   }
 
   map[node] = newOp->getResult(0);
 
   auto &connections = graph.getConnections();
-  if (connections.find(node) != connections.end()) {
-    auto conSrc = connections.at(node).source;
+  auto it = connections.find(node);
+  if (it != connections.end()) {
+    auto conSrc = it->second.source;
     builder.create<mlir::dfcir::ConnectOp>(loc, map[node], map[conSrc]);
   }
 }