[WIP][CIR] Single-source C++ lowering with ClangIR MLIR CIR

CMakeLists.txt

@@ -77,6 +77,9 @@ set(PEANO_INSTALL_DIR
 option(LLVM_INCLUDE_TOOLS "Generate build targets for the LLVM tools." ON)
 option(LLVM_BUILD_TOOLS
        "Build the LLVM tools. If OFF, just generate build targets." ON)
+option(CLANGIR_MLIR_FRONTEND
+       "Use ClangIR version of Clang/LLVM to provide aie++ C++ support." OFF)
+
 option(AIE_INCLUDE_INTEGRATION_TESTS
        "Generate build targets for the mlir-aie integration tests." OFF)
 
@@ -85,8 +88,8 @@ execute_process(COMMAND git rev-parse HEAD OUTPUT_VARIABLE AIE_GIT_COMMIT ERROR_
 
 find_package(MLIR REQUIRED CONFIG)
 
-message(STATUS "Using MLIRConfig.cmake in: ${MLIR_DIR}")
 message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
+message(STATUS "Using MLIRConfig.cmake in: ${MLIR_DIR}")
 
 # These are a bit of a hack, because we're hijacking alot of LLVM machinery
 set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/bin)
@@ -135,8 +138,8 @@ set(LLVM_LIT_ARGS
     "${LIT_ARGS_DEFAULT}"
     CACHE STRING "Default options for lit")
 
-list(APPEND CMAKE_MODULE_PATH "${MLIR_CMAKE_DIR}")
 list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
+list(APPEND CMAKE_MODULE_PATH "${MLIR_CMAKE_DIR}")
 
 include(TableGen)
 include(AddLLVM)
@@ -145,6 +148,16 @@ include(HandleLLVMOptions)
 include(ExternalProject)
 include(CMakeDependentOption)
 
+if (CLANGIR_MLIR_FRONTEND)
+  # To understand how to influence the find_package config, see
+  # https://cmake.org/cmake/help/latest/command/find_package.html#config-mode-search-procedure
+  find_package(Clang REQUIRED CONFIG)
+  message(STATUS "Using ClangConfig.cmake in: ${Clang_DIR}")
+  # Use Clang infrastructure like CIR in this project
+  list(APPEND CMAKE_MODULE_PATH "${CLANG_CMAKE_DIR}")
+  include(AddClang)
+endif()
+
 include_directories(${LLVM_INCLUDE_DIRS})
 include_directories(${MLIR_INCLUDE_DIRS})
 include_directories(${PROJECT_SOURCE_DIR}/include)

include/aie/CIR/CIRToAIEPasses.h

@@ -0,0 +1,42 @@
+//===- CIRToAIEpasses.h -----------------------------------------*- C++ -*-===//
+//
+// This file is licensed 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
+//
+// (c) Copyright 2024 Advanced Micro Devices, Inc.
+//===----------------------------------------------------------------------===//
+
+#ifndef CIR_AIE_PASSES_H
+#define CIR_AIE_PASSES_H
+
+#include "aie/Dialect/AIE/IR/AIEDialect.h"
+#include "clang/CIR/Dialect/IR/CIRDialect.h"
+
+#include "mlir/Pass/Pass.h"
+
+namespace xilinx::AIE::CIR {
+
+#define GEN_PASS_CLASSES
+#include "aie/CIR/CIRToAIEPasses.h.inc"
+
+std::unique_ptr<mlir::OperationPass<mlir::ModuleOp>>
+createCIRToAIEPreparePass();
+
+std::unique_ptr<mlir::OperationPass<mlir::ModuleOp>> createCIRToAIEPass();
+
+std::unique_ptr<mlir::OperationPass<mlir::ModuleOp>>
+createCIRToAIEInlineKernelLambdaPass();
+
+std::unique_ptr<mlir::OperationPass<mlir::ModuleOp>>
+createCIRToAIEDecaptureKernelPass();
+
+std::unique_ptr<mlir::OperationPass<mlir::ModuleOp>> createCIRKeepAIEDevice();
+
+/// Generate the code for registering passes.
+#define GEN_PASS_REGISTRATION
+#include "aie/CIR/CIRToAIEPasses.h.inc"
+
+} // namespace xilinx::AIE::CIR
+
+#endif

include/aie/CIR/CIRToAIEPasses.td

@@ -0,0 +1,108 @@
+//===- CIRToAIEpasses.td -----------------------------------*- tablegen -*-===//
+//
+// This file is licensed 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
+//
+// (c) Copyright 2024 AMD
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef AIE_CIR_PASSES
+#define AIE_CIR_PASSES
+
+include "mlir/Pass/PassBase.td"
+
+def CIRToAIEPrepare : Pass<"cir-to-aie-prepare", "mlir::ModuleOp"> {
+  let summary = "Prepare some transformations of some AIE++ patterns in CIR into AIE equivalent operations";
+  let description = [{
+    Some AIE constructs are represented in AIE++ by C++ abstractions expressed
+    in normal C++. These are compiled to CIR as plain C++ constructs.
+    This pass recognize these AIE++ C++ constructs and replace them by
+    equivalent AIE operations.
+  }];
+
+  let constructor = "xilinx::AIE::CIR::createCIRToAIEPreparePass()";
+  let dependentDialects = [
+    "cir::CIRDialect",
+    "xilinx::AIE::AIEDialect",
+  ];
+}
+
+def CIRToAIE : Pass<"cir-to-aie", "mlir::ModuleOp"> {
+  let summary = "Transform some AIE++ patterns in CIR into AIE equivalent operations";
+  let description = [{
+    Some AIE constructs are represented in AIE++ by C++ abstractions expressed
+    in normal C++. These are compiled to CIR as plain C++ constructs.
+    This pass recognize these AIE++ C++ constructs and replace them by
+    equivalent AIE operations.
+  }];
+
+  let constructor = "xilinx::AIE::CIR::createCIRToAIEPass()";
+  let dependentDialects = [
+    "cir::CIRDialect",
+    "xilinx::AIE::AIEDialect",
+  ];
+}
+
+def CIRToAIEInlineKernelLambda : Pass<"cir-to-aie-inline-kernel-lambda", "mlir::ModuleOp"> {
+
+  let summary = "Inline the call to the kernel lambda inside the aie.core operation";
+
+  let description = [{ In aie++ the tile kernel is represented by a lambda
+    called from "aie::tile::program" which end up to be lowered in a aie.core
+    operation.
+
+    This pass remove the call operations to the lambda by inlining the lambda
+    itself.
+
+    TODO: this might be possible to use the inliner in a restrictive way for
+    this, with some SROA, mem2reg...
+  }];
+
+  let constructor = "xilinx::AIE::CIR::createCIRToAIEInlineKernelLambdaPass()";
+  let dependentDialects = [
+    "cir::CIRDialect",
+    "xilinx::AIE::AIEDialect",
+  ];
+}
+
+def CIRToAIEDecaptureKernel : Pass<"cir-to-aie-decapture-kernel", "mlir::ModuleOp"> {
+
+  let summary = "Remove the useless capture storage of a kernel in an aie.core operation";
+
+  let description = [{ After kernel lambda call inlining into an aie.core
+    operation, there is a left-over of capture allocation with write+read for
+    each kernel argument.
+
+    This pass connect directly the kernel argument to their producers without
+    going through the capture storage and then remove the storage itself.
+
+    TODO: this should be handled by a clever mem2reg or after standard dialect
+    lowering with mem2reg.
+  }];
+
+  let constructor = "xilinx::AIE::CIR::createCIRToAIEDecaptureKernelPass()";
+  let dependentDialects = [
+    "cir::CIRDialect",
+    "xilinx::AIE::AIEDialect",
+  ];
+}
+
+def CIRKeepAIEDevice : Pass<"cir-keep-aie-device", "mlir::ModuleOp"> {
+
+  let summary = "Remove everything but the first aie.device";
+
+  let description = [{ Extract the aie.device from a CIR module by removing everything but the first aie.device.
+
+  TODO: handle multiple devices.
+  }];
+
+  let constructor = "xilinx::AIE::CIR::createCIRKeepAIEDevice()";
+  let dependentDialects = [
+    "cir::CIRDialect",
+    "xilinx::AIE::AIEDialect",
+  ];
+}
+
+#endif

include/aie/CIR/CMakeLists.txt

@@ -0,0 +1,13 @@
+#
+# This file is licensed 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
+#
+# (c) Copyright 2024  Advanced Micro Devices, Inc.
+
+
+set(LLVM_TARGET_DEFINITIONS CIRToAIEPasses.td)
+mlir_tablegen(CIRToAIEPasses.h.inc -gen-pass-decls -name CIRToAIE)
+add_public_tablegen_target(MLIRCIRToAIEPassesIncGen)
+
+add_mlir_doc(CIRToAIEPasses CIRToAIEPasses ./ -gen-pass-doc)

include/aie/CIR/runtime/.clang-format

@@ -0,0 +1,8 @@
+Language: Cpp
+BasedOnStyle: LLVM
+AccessModifierOffset: -1
+BreakInheritanceList: BeforeComma
+BreakConstructorInitializers: BeforeComma
+Cpp11BracedListStyle: false
+PointerAlignment: Left
+SpaceBeforeCpp11BracedList: true