[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)

README.md

@@ -1,3 +1,8 @@
+This is a huge work-in-progress version adding the [`aie++` C++ programming
+model](docs/CIR.md) to MLIR AIE based on [ClangIR for MLIR AIE
+fork](https://github.com/keryell/clangir/tree/mlir-aie-version).
+
+
 # MLIR-based AI Engine toolchain
 
 [![Build and Test across Python versions](https://github.com/Xilinx/mlir-aie/actions/workflows/buildAndTestPythons.yml/badge.svg)](https://github.com/Xilinx/mlir-aie/actions/workflows/buildAndTestPythons.yml)
@@ -16,14 +21,14 @@ This project is primarily intended to support the open-source community, particu
 
 # Getting Started for AMD Ryzen™ AI - Linux Quick Setup Instructions
 
-These instructions will guide you through everything required for building and executing a program on the Ryzen™ AI NPU, starting from a fresh bare-bones **Ubuntu 24.04.2** or **Ubuntu 24.10** install with included Linux 6.11 kernel. 
+These instructions will guide you through everything required for building and executing a program on the Ryzen™ AI NPU, starting from a fresh bare-bones **Ubuntu 24.10** install with Linux 6.11 kernel.
 
 ## Initial Setup
 
 #### Update BIOS:
 
 Be sure you have the latest BIOS for your laptop or mini PC, this will ensure the NPU (sometimes referred to as IPU) is enabled in the system. You may need to manually enable the NPU:
-   ```Advanced → CPU Configuration → IPU``` 
+   ```Advanced → CPU Configuration → IPU```
 
 > **NOTE:** Some manufacturers only provide Windows executables to update the BIOS, please do this before installing Ubuntu.
 
@@ -36,6 +41,52 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
 
 ### Install the XDNA™ Driver
 
+#### Supporting AMD Ryzen™ AI with AMD XDNA™/AIE-ML (AIE2) and AMD XDNA™ 2 (AIE2P): Install AMD Vitis™ AIE Essentials
+
+1. Install Vitis™ AIE Essentials from [Ryzen AI Software 1.3 Early Accesss](https://account.amd.com/en/member/ryzenai-sw-ea.html#tabs-a5e122f973-item-4757898120-tab). We will assume you use the installation directory, `/tools/ryzen_ai-1.3.0/vitis_aie_essentials`.
+
+   > This is an early access lounge, you must register and be granted access at this time.
+
+    1. Download VAIML Installer for Linux based compilation: `ryzen_ai-1.3.0ea1.tgz`
+
+    1. Extract the required tools:
+
+       ``` bash
+          tar -xzvf ryzen_ai-1.3.0ea1.tgz
+          cd ryzen_ai-1.3.0
+          mkdir vitis_aie_essentials
+          mv vitis_aie_essentials*.whl vitis_aie_essentials
+          cd vitis_aie_essentials
+          unzip vitis_aie_essentials*.whl
+       ```
+
+1. Set up an AI Engine license.
+
+    1. Get a local license for AI Engine tools from [https://www.xilinx.com/getlicense](https://www.xilinx.com/getlicense).
+
+    1. Copy your license file (Xilinx.lic) to your preferred location, e.g. `/opt/Xilinx.lic`:
+
+1. Setup your environment using the following script for Vitis™ for AIETools:
+
+   ```bash
+   #!/bin/bash
+    #################################################################################
+    # Setup Vitis AIE Essentials
+    #################################################################################
+    export AIETOOLS_ROOT=/tools/ryzen_ai-1.3.0/vitis_aie_essentials
+    export PATH=$PATH:${AIETOOLS_ROOT}/bin
+    export LM_LICENSE_FILE=/opt/Xilinx.lic
+   ```
+
+### Install the XDNA™ Driver
+
+1. Install the following prerequisite packages.
+
+   ```bash
+   sudo apt install \
+   libidn11-dev
+   ```
+
 1. Clone the XDNA™ driver repository and its submodules.
     ```bash
     git clone https://github.com/amd/xdna-driver.git
@@ -49,13 +100,13 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
 1. Install XRT. (Below steps are adapted from [here](https://xilinx.github.io/XRT/master/html/build.html).)
 
     1. Install XRT prerequisites.
-    
+
        ```bash
        cd $XDNA_SRC_DIR
        sudo ./tools/amdxdna_deps.sh
        ```
 
-    2. Build XRT.
+    2. Build XRT. Remember to source the aietools/Vitis setup script from [above](#install-xilinx-vitis-20232).
 
        ```bash
        cd $XDNA_SRC_DIR/xrt/build
@@ -66,18 +117,18 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
 
        ```bash
        cd $XDNA_SRC_DIR/xrt/build/Release
-       sudo apt reinstall ./xrt_202510.2.19.0_24.10-amd64-npu.deb
+       sudo apt reinstall ./xrt_202510.2.19.0_22.04-amd64-npu.deb
        ```
 
        > **An error might occur during this proces.** If so, do the following steps.
 
        ```bash
        cd $XDNA_SRC_DIR/xrt/build/Release
        sudo apt remove xrt-npu
-       sudo dpkg -i --force-overwrite ./xrt_202510.2.19.0_24.10-amd64-npu.deb
+       sudo dpkg -i --force-overwrite ./xrt_202510.2.19.0_22.04-amd64-npu.deb
        sudo apt -f install
-       sudo apt reinstall ./xrt_202510.2.19.0_24.10-amd64-npu.deb
-       ```      
+       sudo apt reinstall ./xrt_202510.2.19.0_22.04-amd64-npu.deb
+       ```
 
 1. Build XDNA-Driver. Below steps are adapted from [here](https://github.com/amd/xdna-driver).
 
@@ -91,11 +142,11 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
 
     ```bash
     cd $XDNA_SRC_DIR/build/Release
-    sudo apt reinstall ./xrt_plugin.2.19.0_ubuntu24.10-x86_64-amdxdna.deb
+    sudo apt reinstall ./xrt_plugin.2.19.0_ubuntu22.04-x86_64-amdxdna.deb
     ```
-    
+
 1. Check that the NPU is working if the device appears with xrt-smi:
-   
+
    ```bash
    source /opt/xilinx/xrt/setup.sh
    xrt-smi examine
@@ -104,7 +155,7 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
    > At the bottom of the output you should see:
    >  ```
    >  Devices present
-   >  BDF             :  Name             
+   >  BDF             :  Name
    > ------------------------------------
    >  [0000:66:00.1]  :  RyzenAI-npu1
    >  ```
@@ -115,7 +166,7 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
 
     ```bash
     sudo apt install \
-    build-essential clang clang-14 lld lld-14 cmake python3-venv python3-pip libxrender1 libxtst6 libxi6
+    build-essential clang clang-14 lld lld-14 cmake python3-venv python3-pip libxrender1 libxtst6 libxi6 virtualenv
     ```
 
 1. Install g++13 and opencv needed for some programming examples:
@@ -127,33 +178,30 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
    sudo apt install libopencv-dev python3-opencv
    ```
 
-1. Remember to source the Vitis™ AIE Essentials setup script, if required, from [above](#install-aietools).
-   
+1. Remember to source the Vitis™ AIE Essentials setup script from [above](#install-aietools).
+
 1. Remember to source the XRT setup script: `source /opt/xilinx/xrt/setup.sh`
 
 ## Install IRON for AMD Ryzen™ AI AIE Application Development
 
-1. Clone [the mlir-aie repository](https://github.com/Xilinx/mlir-aie.git), best under /home/username for speed (yourPathToBuildMLIR-AIE): 
+1. Clone [the mlir-aie repository](https://github.com/Xilinx/mlir-aie.git), best under /home/username for speed (yourPathToBuildMLIR-AIE):
    ```bash
    git clone https://github.com/Xilinx/mlir-aie.git
    cd mlir-aie
    ```
 
 1. Source `utils/quick_setup.sh` to setup the prerequisites and
-   install the mlir-aie compiler tools from whls.
+   install the mlir-aie and llvm compiler tools from whls.
 
 ## Build an IRON Design for AIEs in the AMD Ryzen™ AI NPU
 
-> Remember to set up your environment including IRON, and XRT
-> ```
->   source /opt/xilinx/xrt/setup.sh
->   source ironenv/bin/activate
->   source utils/env_setup.sh  
-> ```
-> And, if desired, Vitis™ AIE Essentials, and your license.
+> Remember to set up your environment including Vitis™ AIE Essentials, your license, XRT, and IRON
 > ```
 >   source yourVitisSetupScript.sh
 >   export LM_LICENSE_FILE=/opt/Xilinx.lic
+>   source /opt/xilinx/xrt/setup.sh
+>   source ironenv/bin/activate
+>   source utils/env_setup.sh my_install/mlir_aie my_install/mlir my_install/llvm-aie
 > ```
 
 For your design of interest, for instance from [programming_examples](../programming_examples/), 2 steps are needed: (i) build the AIE design and then (ii) build the host code.
@@ -182,48 +230,7 @@ For your design of interest, for instance from [programming_examples](../program
 
 1. Some MLIR-AIE documentation is available on the [website](https://xilinx.github.io/mlir-aie/)
 
-## Optional: Install AIETools
-
-> You may skip the Vitis™ installation step if you intend to only target AMD XDNA™/AIE-ML (AIE2) and AMD XDNA™ 2 (AIE2P) using our open-source single-core compiler [Peano](https://github.com/Xilinx/llvm-aie). Compiling with `xchesscc` is not supported without installing AMD Vitis™ AIE Essentials. 
-
-### Supporting AMD Ryzen™ AI with AMD XDNA™/AIE-ML (AIE2) and AMD XDNA™ 2 (AIE2P): Install AMD Vitis™ AIE Essentials 
-
-1. Install Vitis™ AIE Essentials from [Ryzen AI Software 1.3 Early Accesss](https://account.amd.com/en/member/ryzenai-sw-ea.html#tabs-a5e122f973-item-4757898120-tab). We will assume you use the installation directory, `/tools/ryzen_ai-1.3.0/vitis_aie_essentials`.
-
-   > This is an early access lounge, you must register and be granted access at this time.
-
-    1. Download VAIML Installer for Linux based compilation: `ryzen_ai-1.3.0ea1.tgz`
-
-    1. Extract the required tools:
-
-       ``` bash
-          tar -xzvf ryzen_ai-1.3.0ea1.tgz
-          cd ryzen_ai-1.3.0
-          mkdir vitis_aie_essentials
-          mv vitis_aie_essentials*.whl vitis_aie_essentials
-          cd vitis_aie_essentials
-          unzip vitis_aie_essentials*.whl
-       ```
-
-1. Set up an AI Engine license.
-
-    1. Get a local license for AI Engine tools from [https://www.xilinx.com/getlicense](https://www.xilinx.com/getlicense).
-
-    1. Copy your license file (Xilinx.lic) to your preferred location, e.g. `/opt/Xilinx.lic`:
-
-1. Setup your environment using the following script for Vitis™ for AIETools:
-
-   ```bash
-   #!/bin/bash
-    #################################################################################
-    # Setup Vitis AIE Essentials
-    #################################################################################
-    export AIETOOLS_ROOT=/tools/ryzen_ai-1.3.0/vitis_aie_essentials
-    export PATH=$PATH:${AIETOOLS_ROOT}/bin
-    export LM_LICENSE_FILE=/opt/Xilinx.lic
-   ```
-
-# Detailed Getting Started Guides and Documentation: 
+# Detailed Getting Started Guides and Documentation:
 
 [Getting Started on a Versal™ board](docs/Building.md)