Integrate Polymer into Polygeist

Co-authored-by: Emil VATAI <[email protected]>
Co-authored-by: William Moses <[email protected]>

Author: 3 people

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: llvm_project_build
+name: Polygeist build and test
 
 on:
   push:
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build:
-    name: Build ${{ matrix.build }} ${{ matrix.os }} ${{ matrix.compiler }}
+    name: Build ${{ matrix.os }} ${{ matrix.compiler }} polymer=${{ matrix.polymer }} pluto ${{ matrix.pluto-build }} mlir ${{ matrix.mlir-build }} polygeist ${{ matrix.polygeist-build }}
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        build: ["Release"] #, "Debug"] # "RelWithDebInfo"
-        os: [ubuntu-latest]
+        pluto-build: ["Release"] # Only Release supported currently
+        mlir-build: ["Release"] #, "Debug"] # "RelWithDebInfo"
+        polygeist-build: ["Release", "Debug"] #, "Debug"] # "RelWithDebInfo"
+        polymer: ["0", "1"]
+        os: [ubuntu-22.04]
         compiler: [gcc, clang]
         cxxcompiler: [g++, clang++]
         exclude:
@@ -32,39 +35,72 @@ jobs:
         path: src
         submodules: 'recursive'
 
+    - name: add dependencies
+      run: sudo apt-get install -y llvm-15-tools ninja-build libbison-dev libtool libgmp-dev #libflex-dev cmake binutils-gold binutils binutils-dev ${{ matrix.compiler }} ${{ matrix.linker-pkg }}
+
+    - name: Cache Pluto
+      id: cache-pluto
+      uses: actions/cache@v3
+      with:
+        path: pluto-build
+        key: ${{ matrix.pluto-build }}-${{ matrix.os }}-pluto-${{ matrix.polymer }}
+
+    - name: Pluto build
+      if: steps.cache-pluto.outputs.cache-hit != 'true' && matrix.polymer == '1'
+      run: |
+        mkdir -p pluto-build
+        PATH="/usr/lib/llvm-15/bin/:$PATH" src/tools/polymer/build_polymer_deps.sh $(pwd)/pluto-build
+        sleep 1s
+    - uses: actions/cache/save@v3
+      if: steps.cache-pluto.outputs.cache-hit != 'true'
+      with:
+        path: pluto-build
+        key: ${{ matrix.pluto-build }}-${{ matrix.os }}-pluto-${{ matrix.polymer }}
+
     - name: Read LLVM commit
       id: getversion
-      run: echo "::set-output name=version::$(cat src/.git/modules/llvm-project/HEAD)"
+      run: echo "version=$(cat src/.git/modules/llvm-project/HEAD)" >> $GITHUB_OUTPUT
 
     - name: Cache MLIR
       id: cache-mlir
       uses: actions/cache@v3
       with:
         path: mlir-build
-        key: ${{ matrix.build }}-${{ matrix.os }}-mlir-${{ steps.getversion.outputs.version }}
-
-    - name: add dependencies
-      run: sudo apt-get install -y ninja-build #cmake binutils-gold binutils binutils-dev ${{ matrix.compiler }} ${{ matrix.linker-pkg }}
+        key: ${{ matrix.mlir-build }}-${{ matrix.os }}-mlir-${{ steps.getversion.outputs.version }}
 
     - name: MLIR build
       if: steps.cache-mlir.outputs.cache-hit != 'true'
       run: |
         mkdir mlir-build
         cd mlir-build
-        CYMBL=OFF cmake ../src/llvm-project/llvm -GNinja -DLLVM_ENABLE_PROJECTS="llvm;clang;mlir;openmp" -DCMAKE_BUILD_TYPE=${{ matrix.build }} -DCMAKE_C_COMPILER=/bin/clang -DCMAKE_CXX_COMPILER=/bin/clang++ -DCMAKE_ASM_COMPILER=/bin/clang -DCMAKE_CXX_FLAGS="-Wno-c++11-narrowing"
+        CYMBL=OFF cmake ../src/llvm-project/llvm -GNinja -DLLVM_ENABLE_PROJECTS="llvm;clang;mlir" -DCMAKE_BUILD_TYPE=${{ matrix.mlir-build }} -DCMAKE_C_COMPILER=/bin/clang -DCMAKE_CXX_COMPILER=/bin/clang++ -DCMAKE_ASM_COMPILER=/bin/clang -DCMAKE_CXX_FLAGS="-Wno-c++11-narrowing"
         #cymbld & disown
-        sleep 10
+        sleep 1
         CYMBL=OFF ninja
+    - uses: actions/cache/save@v3
+      if: steps.cache-mlir.outputs.cache-hit != 'true'
+      with:
+        path: mlir-build
+        key: ${{ matrix.mlir-build }}-${{ matrix.os }}-mlir-${{ steps.getversion.outputs.version }}
 
     - name: mkdir
       run: mkdir build
     - name: cmake
       run: |
         cd build
         ls ../mlir-build/lib/cmake/clang
-        cmake ../src/ -GNinja -DMLIR_DIR=`pwd`/../mlir-build/lib/cmake/mlir -DLLVM_EXTERNAL_LIT=`pwd`/../mlir-build/bin/llvm-lit -DClang_DIR=`pwd`/../mlir-build/lib/cmake/clang -DCMAKE_BUILD_TYPE=${{ matrix.build }} -DCMAKE_C_COMPILER=${{matrix.compiler}} -DCMAKE_CXX_COMPILER=${{matrix.cxxcompiler}}
+        cmake ../src/ -GNinja -DMLIR_DIR=`pwd`/../mlir-build/lib/cmake/mlir -DLLVM_EXTERNAL_LIT=`pwd`/../mlir-build/bin/llvm-lit -DClang_DIR=`pwd`/../mlir-build/lib/cmake/clang -DCMAKE_BUILD_TYPE=${{ matrix.polygeist-build }} -DCMAKE_C_COMPILER=${{matrix.compiler}} -DCMAKE_CXX_COMPILER=${{matrix.cxxcompiler}} -DPOLYGEIST_ENABLE_POLYMER=${{ matrix.polymer }} -DPOLYMER_DEP_DIR=$(pwd)/../pluto-build/
+
     - name: test cgeist
       run: |
         cd build
+        ninja -j1
         ninja check-polygeist-opt
         ninja check-cgeist
+
+    - name: test polymer
+      if: matrix.polymer == '1'
+      run: |
+        cd build
+        ninja
+        PATH="`pwd`/../mlir-build/bin:$PATH" LLVM_SYMBOLIZER_PATH="`pwd`/../mlir-build/bin/llvm-symbolizer" ninja check-polymer

.github/workflows/clang-format.yml

@@ -16,6 +16,6 @@ jobs:
           fetch-depth: 1
     - uses: DoozyX/[email protected]
       with:
-        exclude: './tools/cgeist/Test ./test'
+        exclude: './tools/cgeist/Test ./test ./tools/polymer/example'
         clangFormatVersion: 11
         style: llvm

CMakeLists.txt

@@ -1,10 +1,22 @@
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.13.4)
 
 include(CheckCXXSourceCompiles)
 
 set(POLYGEIST_ENABLE_CUDA 0 CACHE BOOL "Enable CUDA frontend and backend")
 set(POLYGEIST_ENABLE_ROCM 0 CACHE BOOL "Enable ROCM backend")
 
+set(POLYGEIST_ENABLE_POLYMER 0 CACHE BOOL "Enable Polymer")
+
+set(POLYMER_DEP_DIR "" CACHE STRING "Pluto build root directory")
+
+if ("${POLYMER_DEP_DIR}" STREQUAL "")
+    set(POLYGEIST_PLUTO_DIR ${CMAKE_CURRENT_BINARY_DIR})
+else()
+    set(POLYGEIST_PLUTO_DIR ${POLYMER_DEP_DIR})
+endif()
+  
+message(STATUS "polygeist_pluto_dir '${POLYGEIST_PLUTO_DIR}'")
+
 if(POLICY CMP0068)
   cmake_policy(SET CMP0068 NEW)
   set(CMAKE_BUILD_WITH_INSTALL_NAME_DIR ON)

README.md

@@ -50,11 +50,23 @@ ninja
 ninja check-polygeist-opt && ninja check-cgeist
 ```
 
-To enable compilation to cuda add `-DPOLYGEIST_ENABLE_CUDA=1`
+For faster compilation we recommend using `-DPOLYGEIST_USE_LINKER=lld`.
+
+    1. GPU backends
+
+To enable the CUDA backend add `-DPOLYGEIST_ENABLE_CUDA=1`
 
 To enable the ROCM backend add `-DPOLYGEIST_ENABLE_ROCM=1`
 
-For faster compilation we recommend using `-DPOLYGEIST_USE_LINKER=lld`.
+    2. Polymer
+
+To enable polymer, add `-DPOLYGEIST_ENABLE_POLYMER=1`
+
+This will cause the cmake invokation to pull and build the dependencies for polymer. To specify a custom directory for the dependencies, specify `-DPOLYMER_DEP_DIR=<absolute-dir>`. The dependencies will be build using the `tools/polymer/build_polymer_deps.sh`.
+
+To run the polymer tests, use `ninja check-polymer`.
+
+
 
 #### Option 2: Using unified LLVM, MLIR, Clang, and Polygeist build
 

tools/CMakeLists.txt

@@ -1,2 +1,6 @@
 add_subdirectory(polygeist-opt)
 add_subdirectory(cgeist)
+
+if(POLYGEIST_ENABLE_POLYMER)
+  add_subdirectory(polymer)
+endif()

tools/cgeist/Test/polybench/stencils/seidel-2d/seidel-2d.pluto.i64.pluto.cloog

@@ -1,87 +1,20 @@
-# Check if Polymer is built as a standalone out-of-(llvm/mlir)-tree project.
-if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY
+  "${CMAKE_CURRENT_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX}")
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
 
-  project(polymer LANGUAGES CXX C)
-  cmake_minimum_required(VERSION 3.13.4)
-
-  message (STATUS "Building Polymer as a standalone project")
-
-  # Policies requried by LLVM.
-  if(POLICY CMP0068)
-    cmake_policy(SET CMP0068 NEW)
-    set(CMAKE_BUILD_WITH_INSTALL_NAME_DIR ON)
-  endif()
-
-  if(POLICY CMP0075)
-    cmake_policy(SET CMP0075 NEW)
-  endif()
-
-  if(POLICY CMP0077)
-    cmake_policy(SET CMP0077 NEW)
-  endif()
-
-  set(CMAKE_CXX_STANDARD 14)
-  set(CMAKE_CXX_STANDARD_REQUIRED YES)
-
-  # ----------------------------- LLVM/MLIR references
-  find_package(LLVM REQUIRED CONFIG)
-  find_package(MLIR REQUIRED CONFIG)
-
-  include_directories("${LLVM_INCLUDE_DIRS}")
-  include_directories("${MLIR_INCLUDE_DIRS}")
-
-  list(APPEND CMAKE_MODULE_PATH "${MLIR_CMAKE_DIR}")
-  list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
-  list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")
-
-  include(TableGen)
-  include(AddLLVM)
-  include(AddMLIR)
-  include(HandleLLVMOptions)
-
-  message(STATUS "Using MLIRConfig.cmake in: ${MLIR_DIR}")
-  message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
-
-  set(LLVM_RUNTIME_OUTPUT_INTDIR "${CMAKE_BINARY_DIR}/bin")
-  set(LLVM_LIBRARY_OUTPUT_INTDIR "${CMAKE_BINARY_DIR}/lib")
-  set(MLIR_BINARY_DIR "${CMAKE_BINARY_DIR}")
-
-  link_directories(${LLVM_BUILD_LIBRARY_DIR})
-  add_definitions(${LLVM_DEFINITIONS})
-
-  # ----------------------------- Testing with LIT
-  # Define the default arguments to use with 'lit', and an option for the user to
-  # override.
-  set(LIT_ARGS_DEFAULT "-sv")
-  if (MSVC_IDE OR XCODE)
-    set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
-  endif()
-  set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
-
-  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY
-    "${CMAKE_CURRENT_BINARY_DIR}/lib${LLVM_LIBDIR_SUFFIX}")
-  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
-
-  set(POLYMER_TRANSFORM_DEPENDS "")
-
-else()
-  # Build as an external project to MLIR.
-  # Need to wait until these targets are built.
-  set(POLYMER_TRANSFORM_DEPENDS
-    MLIRAffineOpsIncGen
-    MLIRAffinePassIncGen
-    MLIRLoopLikeInterfaceIncGen
-  )
-
-endif()
+set(POLYMER_TRANSFORM_DEPENDS
+  MLIRAffineOpsIncGen
+  MLIRAffinePassIncGen
+  MLIRLoopLikeInterfaceIncGen
+)
 
 set(POLYMER_MAIN_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}" )
 set(POLYMER_MAIN_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include" )
 
 set(POLYMER_SOURCE_DIR  "${CMAKE_CURRENT_SOURCE_DIR}")
 set(POLYMER_BINARY_DIR  "${CMAKE_CURRENT_BINARY_DIR}/bin")
 set(POLYMER_INCLUDE_DIR "${CMAKE_CURRENT_BINARY_DIR}/include" ) 
-set(POLYMER_TOOLS_DIR   "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/bin")
+set(POLYMER_TOOLS_DIR   ${CMAKE_BINARY_DIR}/bin)
 
 # ----------------------------- Customize CMake
 
@@ -91,11 +24,23 @@ set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
 # Find whether the GMP package exists.
 find_package(GMP REQUIRED)
 
-# Configure and build PLUTO to ${CMAKE_BUILD_DIR}/pluto
+# build pluto, openscop, cloog
+execute_process(
+  COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/build_polymer_deps.sh" "${POLYGEIST_PLUTO_DIR}"
+  COMMAND_ERROR_IS_FATAL ANY
+)
+# configure the cmake variables for pluto
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/AddPluto.cmake")
 include_directories("${PLUTO_INCLUDE_DIR}")
 message(STATUS "Will build and use Polymer-bundled Pluto")
 
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/OpenScop.cmake")
+include_directories("${OSL_INCLUDE_DIR}")
+
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/CLooG.cmake")
+include_directories("${CLOOG_INCLUDE_DIR}")
+
+
 # ------------------------------------------------- This project
 include_directories("${POLYMER_MAIN_INCLUDE_DIR}")
 include_directories("${POLYMER_INCLUDE_DIR}")
@@ -111,7 +56,7 @@ add_subdirectory(tools)
 add_subdirectory(test)
 
 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
-  install(DIRECTORY include/polymer 
+  install(DIRECTORY include/polymer
     DESTINATION include
     FILES_MATCHING
     PATTERN "*.h"