Extract CFDFC from standard level

.vscode/c_cpp_properties.json

@@ -18,7 +18,9 @@
         "${workspaceFolder}/circt/llvm/llvm/include/",
         "${workspaceFolder}/circt/llvm/mlir/include/",
         "${workspaceFolder}/circt/llvm/build/include/",
-        "${workspaceFolder}/circt/llvm/build/tools/mlir/include/"
+        "${workspaceFolder}/circt/llvm/build/tools/mlir/include/",
+        // Gurobi
+        "${env:GUROBI_HOME}/include/"
       ],
       "intelliSenseMode": "linux-clang-x64",
       "compilerPath": "/usr/bin/clang",

CMakeLists.txt

@@ -28,6 +28,8 @@ else ()
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-exceptions -fno-rtti")
 endif ()
 
+include(FindPackageHandleStandardArgs)
+
 #-------------------------------------------------------------------------------
 # CIRCT/MLIR/LLVM configuration
 #-------------------------------------------------------------------------------
@@ -62,13 +64,17 @@ option(LLVM_BUILD_TOOLS "Build the LLVM tools. If OFF, just generate build targe
 # Dynamatic configuration 
 #-------------------------------------------------------------------------------
 
+# Define some variables for Dynamatic
 set(DYNAMATIC_SOURCE_DIR ${CMAKE_SOURCE_DIR})
 set(DYNAMATIC_INCLUDE_DIR ${DYNAMATIC_SOURCE_DIR}/include)
-
 set(DYNAMATIC_BINARY_DIR ${CMAKE_BINARY_DIR})
 set(DYNAMATIC_TOOLS_DIR ${DYNAMATIC_BINARY_DIR}/bin)
 set(DYNAMATIC_BIN_INCLUDE_DIR ${DYNAMATIC_BINARY_DIR}/include)
 
+# Add our own directory to the list of search paths for CMake modules 
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")
+
+# Dynamatic include directories
 include_directories(${DYNAMATIC_INCLUDE_DIR})
 include_directories(${DYNAMATIC_BIN_INCLUDE_DIR})
 include_directories(${DYNAMATIC_SOURCE_DIR}/tutorials/include)
@@ -93,6 +99,25 @@ function(add_dynamatic_dialect_library name)
   add_dynamatic_library(${ARGV} DEPENDS dynamatic-headers)
 endfunction()
 
+#-------------------------------------------------------------------------------
+# Gurobi setup
+#-------------------------------------------------------------------------------
+
+find_package(GUROBI)
+if (GUROBI_FOUND)
+  message(STATUS "Found Gurobi")
+  message(STATUS "${GUROBI_LIBRARY}")
+  message(STATUS "${GUROBI_CXX_LIBRARY}")
+
+  include_directories(${GUROBI_INCLUDE_DIRS})
+else()
+  message(WARNING "Gurobi wasn't found, the buffer placement infrastructure \
+                   that requires solving an MILP will not be built with the \
+                   project.")
+endif()
+
+include_directories(${GUROBI_INCLUDE_DIRS})
+
 #-------------------------------------------------------------------------------
 # Directory setup
 #-------------------------------------------------------------------------------

cmake/modules/FindGUROBI.cmake

@@ -0,0 +1,39 @@
+# From https://support.gurobi.com/hc/en-us/articles/360039499751-How-do-I-use-CMake-to-build-Gurobi-C-C-projects-
+
+find_path(GUROBI_INCLUDE_DIRS
+  NAMES gurobi_c.h
+  HINTS ${GUROBI_DIR} $ENV{GUROBI_HOME}
+  PATH_SUFFIXES include)
+
+find_library(GUROBI_LIBRARY
+  NAMES gurobi gurobi100
+  HINTS ${GUROBI_DIR} $ENV{GUROBI_HOME}
+  PATH_SUFFIXES lib)
+
+
+if(MSVC)
+  set(MSVC_YEAR "2017")
+
+  if(MT)
+      set(M_FLAG "mt")
+  else()
+      set(M_FLAG "md")
+  endif()
+
+  find_library(GUROBI_CXX_LIBRARY
+    NAMES gurobi_c++${M_FLAG}${MSVC_YEAR}
+    HINTS ${GUROBI_DIR} $ENV{GUROBI_HOME}
+    PATH_SUFFIXES lib)
+  find_library(GUROBI_CXX_DEBUG_LIBRARY
+    NAMES gurobi_c++${M_FLAG}d${MSVC_YEAR}
+    HINTS ${GUROBI_DIR} $ENV{GUROBI_HOME}
+    PATH_SUFFIXES lib)
+else()
+  find_library(GUROBI_CXX_LIBRARY
+    NAMES gurobi_c++
+    HINTS ${GUROBI_DIR} $ENV{GUROBI_HOME}
+    PATH_SUFFIXES lib)
+  set(GUROBI_CXX_DEBUG_LIBRARY ${GUROBI_CXX_LIBRARY})
+endif()
+
+find_package_handle_standard_args(GUROBI DEFAULT_MSG GUROBI_LIBRARY)

include/dynamatic/Transforms/BufferPlacement/ExtractMG.h

@@ -0,0 +1,67 @@
+//===- UtilsForExtractMG.h - utils for extracting marked graph *- C++ ---*-===//
+//
+// This file declaresfunction supports for CFDFCircuit extraction.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef DYNAMATIC_TRANSFORMS_EXTRACTMG_H
+#define DYNAMATIC_TRANSFORMS_EXTRACTMG_H
+
+#include "circt/Dialect/Handshake/HandshakeOps.h"
+#include "dynamatic/Support/LLVM.h"
+#include "mlir/Dialect/Func/IR/FuncOps.h"
+#include "mlir/IR/BuiltinTypes.h"
+
+namespace dynamatic {
+namespace buffer {
+
+/// Data structure for archs between the two basic blocks
+/// srcBB: index of the source basic block;
+/// dstBB: index of the destination basic block;
+/// execFreq: execution frequency of the arch;
+/// isBackEdge: whether the arch is a back edge.
+struct ArchBB {
+  unsigned srcBB, dstBB, execFreq;
+  bool isBackEdge;
+};
+
+/// Data structure for control-free dataflow circuits which
+/// stores the units and channels inside it.
+/// The CFDFC has properties for the buffer placement optimization, including
+/// the target period, and maximum period.
+struct CFDFC {
+  double targetCP, maxCP;
+  std::vector<Operation *> units;
+  std::vector<Value> channels;
+
+  unsigned execN = 0; // execution times of CFDFC
+};
+
+/// Read the simulation file of standard level execution and store the results
+/// in the map.
+LogicalResult readSimulateFile(const std::string &fileName,
+                               std::map<ArchBB *, bool> &archs,
+                               std::map<unsigned, bool> &bbs);
+
+/// Define the MILP CFDFC extraction models, and write the optimization results
+/// to the map.
+LogicalResult extractCFDFCircuit(std::map<ArchBB *, bool> &archs,
+                                 std::map<unsigned, bool> &bbs, unsigned &freq);
+
+/// Get the index of the basic block of an operation.
+int getBBIndex(Operation *op);
+
+/// Identify whether the channel is in selected the basic block.
+bool isSelect(std::map<unsigned, bool> &bbs, Value val);
+
+/// Identify whether the channel is in selected archs between the basic block.
+bool isSelect(std::map<ArchBB *, bool> &archs, Value val);
+
+/// Identify whether the connection between the source operation and
+/// the destination operation is a back edge.
+bool isBackEdge(Operation *opSrc, Operation *opDst);
+
+} // namespace buffer
+} // namespace dynamatic
+
+#endif // DYNAMATIC_TRANSFORMS_EXTRACTMG_H

include/dynamatic/Transforms/BufferPlacement/HandshakePlaceBuffers.h

@@ -0,0 +1,21 @@
+//===- HandshakePlaceBuffers.h - Place buffers in DFG -----------*- C++ -*-===//
+//
+// This file declares the --handshake-place-buffers pass.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef DYNAMATIC_TRANSFORMS_PLACEBUFFERS_H
+#define DYNAMATIC_TRANSFORMS_PLACEBUFFERS_H
+
+#include "dynamatic/Support/LLVM.h"
+#include "dynamatic/Transforms/BufferPlacement/ExtractMG.h"
+#include "mlir/Dialect/Func/IR/FuncOps.h"
+
+namespace dynamatic {
+
+std::unique_ptr<mlir::OperationPass<mlir::ModuleOp>>
+createHandshakePlaceBuffersPass(bool firstMG = false,
+                                std::string stdLevelInfo = "");
+
+} // namespace dynamatic
+#endif // DYNAMATIC_TRANSFORMS_PLACEBUFFERS_H

include/dynamatic/Transforms/Passes.h

@@ -10,6 +10,7 @@
 #include "dynamatic/Support/LLVM.h"
 #include "dynamatic/Transforms/AnalyzeMemoryAccesses.h"
 #include "dynamatic/Transforms/ArithReduceArea.h"
+#include "dynamatic/Transforms/BufferPlacement/HandshakePlaceBuffers.h"
 #include "dynamatic/Transforms/FlattenMemRefRowMajor.h"
 #include "dynamatic/Transforms/HandshakeConcretizeIndexType.h"
 #include "dynamatic/Transforms/HandshakeInferBasicBlocks.h"

include/dynamatic/Transforms/Passes.td

@@ -67,7 +67,6 @@ def HandshakePrepareForLegacy : Pass<"handshake-prepare-for-legacy", "mlir::Modu
   let constructor = "dynamatic::createHandshakePrepareForLegacy()";
 }
 
-
 def HandshakeOptimizeBits : Pass<"optimize-bits" , "mlir::ModuleOp"> {
   let summary = "Optimize bits width that can be reduced.";
   let description = [{
@@ -107,6 +106,20 @@ def HandshakeMinimizeCstWidth : Pass<"handshake-minimize-cst-width", "mlir::Modu
   let dependentDialects = ["mlir::arith::ArithDialect"];
 }
 
+def HandshakePlaceBuffers : Pass<"handshake-place-buffers", "mlir::ModuleOp"> {
+  let summary = "Insert buffers in dataflow graphs.";
+  let description = [{
+    The pass analyzes the circuit's channel prerequisites. Based the channel
+    prerequisite, the pass optimize the circuit performance by inserting buffers.
+  }];
+  let constructor = "dynamatic::createHandshakePlaceBuffersPass()";
+  let options = [
+    Option<"firstMG", "firstMG", "bool", "false",
+    "if true, only extract the first MG from the input file">,
+    Option<"stdLevelInfo", "std-level-info", "std::string", "",
+    "if true, extract CFDFC from standard level simluation">];
+}
+
 //===----------------------------------------------------------------------===//
 // Other passes
 //===----------------------------------------------------------------------===//

lib/Transforms/BufferPlacement/CMakeLists.txt

@@ -0,0 +1,25 @@
+if (NOT GUROBI_FOUND)
+  add_compile_definitions(DYNAMATIC_GUROBI_NOT_INSTALLED)
+endif()
+
+add_dynamatic_library(DynamaticBufferPlacement
+  ExtractMG.cpp
+  HandshakePlaceBuffers.cpp
+
+  DEPENDS
+  DynamaticTransformsPassIncGen
+
+  LINK_LIBS PUBLIC
+  MLIRIR
+  MLIRMemRefDialect
+  MLIRFuncDialect
+  MLIRSupport
+  MLIRTransformUtils
+  DynamaticSupport
+)
+
+target_link_libraries(DynamaticBufferPlacement
+  PUBLIC
+  ${GUROBI_CXX_LIBRARY}
+  ${GUROBI_LIBRARY}
+)