Fix IMEX config and installation issues. (#553)

silee2 · web-flow · commit 879c46c4a6e3 · 2022-12-12T13:57:19.000-08:00
* Fix IMEXConfig.cmake and IMEXTargets.cmake
* Fix doxygen issue.
* Use if(NOT DEFINED &lt;VAR&gt;) to check if a cmake variable &lt;VAR&gt; is defined.
* Fix install issue.
* Cleanup MLIR/LLVM header include paths.
* Remove meaningless condition checks.
* Fix imex-opt install issue.
* Don't include mlir and llvm headers as SYSTEM.
* Add an example of how to integrate IMEX into an external CMake based
project.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,7 +8,7 @@ endif()
 
 set(IMEX_EXTERNAL_PROJECT_BUILD OFF)
 
-if(NOT (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) AND NOT MLIR_BINARY_DIR)
+if(NOT (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) AND NOT DEFINED MLIR_BINARY_DIR)
     # Building as part of LLVM via the external project mechanism.
     set(IMEX_EXTERNAL_PROJECT_BUILD ON)
     list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")
@@ -39,14 +39,21 @@ if(IMEX_EXTERNAL_PROJECT_BUILD)
         message(FATAL_ERROR "Invalid llvm version")
     endif()
 
+    # Variables needed for mlir_tablegen() to function
     set(MLIR_MAIN_SRC_DIR ${LLVM_MAIN_SRC_DIR}/../mlir )
     set(MLIR_INCLUDE_DIR ${MLIR_MAIN_SRC_DIR}/include )
+
+    set(LLVM_INCLUDE_DIR ${LLVM_MAIN_SRC_DIR}/include )
+
+    # LLVM headers in source tree are already included
+    # as part of LLVM_EXTERNAL_PROJECTS build
+
+    # MLIR headers in source tree
+    include_directories(${MLIR_INCLUDE_DIR})
+    # Generated MLIR headers
     set(MLIR_GENERATED_INCLUDE_DIR ${LLVM_BINARY_DIR}/tools/mlir/include)
-    include_directories(SYSTEM ${MLIR_INCLUDE_DIR})
-    include_directories(SYSTEM ${MLIR_GENERATED_INCLUDE_DIR})
-    include_directories(SYSTEM ${MLIR_TABLEGEN_OUTPUT_DIR})
+    include_directories(${MLIR_GENERATED_INCLUDE_DIR})
 
-    set(BACKEND_PACKAGE_STRING "${PACKAGE_STRING}")
     list(APPEND CMAKE_MODULE_PATH "${MLIR_MAIN_SRC_DIR}/cmake/modules")
 else()
     message(STATUS "Building IMEX with external MLIR")
@@ -66,17 +73,82 @@ else()
     message(STATUS "Using MLIRConfig.cmake in: ${MLIR_DIR}")
     message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
 
+    # For redirecting llvm_add_library() to IMEX's bin and lib folders
     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})
+
+    # LLVM_INCLUDE_DIRS is the same as MLIR_INCLUDE_DIRS in an MLIR install tree
+    include_directories(${MLIR_INCLUDE_DIRS})
 
     list(APPEND CMAKE_MODULE_PATH "${MLIR_CMAKE_DIR}")
     list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
 endif()
 
+# For redirecting add_mlir_doc() to IMEX's doc folder
+set(MLIR_BINARY_DIR ${CMAKE_BINARY_DIR})
+
 include(TableGen)
 include(AddLLVM)
 include(AddMLIR)
+
+# Instead of creating a separate AddIMEX,
+# redefine some functions included from include(AddMLIR)
+# and change the behavior of add_mlir_* functions to
+# properly generate IMEXConfig.cmake and IMEXTargets.cmake
+function(add_mlir_library_install name)
+  get_target_export_arg(${name} IMEX export_to_mlirtargets UMBRELLA imex-libraries)
+  install(TARGETS ${name}
+    COMPONENT ${name}
+    ${export_to_mlirtargets}
+    LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
+    ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX}
+    RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}"
+    # Note that CMake will create a directory like:
+    #   objects-${CMAKE_BUILD_TYPE}/obj.LibName
+    # and put object files there.
+    OBJECTS DESTINATION lib${LLVM_LIBDIR_SUFFIX}
+  )
+
+  add_llvm_install_targets(install-${name}
+                           DEPENDS ${name}
+                           COMPONENT ${name})
+  set_property(GLOBAL APPEND PROPERTY IMEX_ALL_LIBS ${name})
+  set_property(GLOBAL APPEND PROPERTY IMEX_EXPORTS ${name})
+endfunction()
+
+# Declare the library associated with a dialect.
+function(add_mlir_dialect_library name)
+  set_property(GLOBAL APPEND PROPERTY IMEX_DIALECT_LIBS ${name})
+  add_mlir_library(${ARGV} DEPENDS mlir-headers)
+endfunction(add_mlir_dialect_library)
+
+# Declare the library associated with a conversion.
+function(add_mlir_conversion_library name)
+  set_property(GLOBAL APPEND PROPERTY IMEX_CONVERSION_LIBS ${name})
+  add_mlir_library(${ARGV} DEPENDS mlir-headers)
+endfunction(add_mlir_conversion_library)
+
+# Declare the library associated with a translation.
+function(add_mlir_translation_library name)
+  set_property(GLOBAL APPEND PROPERTY IMEX_TRANSLATION_LIBS ${name})
+  add_mlir_library(${ARGV} DEPENDS mlir-headers)
+endfunction(add_mlir_translation_library)
+
+macro(add_imex_tool name)
+    add_llvm_executable(${name} ${ARGN})
+    get_target_export_arg(${name} IMEX export_to_imexexports)
+    install(TARGETS ${name}
+            ${export_to_imexexports}
+            RUNTIME DESTINATION ${IMEX_TOOLS_INSTALL_DIR}
+            COMPONENT ${name})
+
+    add_llvm_install_targets(install-${name}
+                             DEPENDS ${name}
+                             COMPONENT ${name})
+    set_property(GLOBAL APPEND PROPERTY IMEX_EXPORTS ${name})
+    set_target_properties(${name} PROPERTIES FOLDER "Tools")
+endmacro()
+
 include(HandleLLVMOptions)
 
 set(IMEX_ENABLE_SYCL_RUNTIME 0 CACHE BOOL "Enable the Sycl Runtime")
@@ -110,11 +182,11 @@ if(NOT IMEX_EXTERNAL_PROJECT_BUILD)
         COMPONENTS Interpreter)
 endif()
 
-include_directories(${LLVM_INCLUDE_DIRS})
-include_directories(${MLIR_INCLUDE_DIRS})
+# IMEX headers in source tree
 include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+# Generated IMEX headers
 include_directories(${CMAKE_CURRENT_BINARY_DIR}/include)
-link_directories(${LLVM_BUILD_LIBRARY_DIR})
+message(STATUS "LLVM_DEFINITIONS: ${LLVM_DEFINITIONS}")
 add_definitions(${LLVM_DEFINITIONS})
 
 set(LLVM_LIT_ARGS "-sv" CACHE STRING "lit default options")
@@ -128,6 +200,9 @@ else()
     set(IMEX_LIB_DIR ${IMEX_BINARY_DIR}/lib)
 endif()
 
+set(IMEX_TOOLS_INSTALL_DIR "${CMAKE_INSTALL_BINDIR}" CACHE STRING
+    "Path for binary subdirectory (defaults to '${CMAKE_INSTALL_BINDIR}')")
+
 include(sanitizers)
 
 add_subdirectory(include)
@@ -140,9 +215,14 @@ if (IMEX_INCLUDE_DOCS)
     add_subdirectory(docs)
 endif()
 
-install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/mlir
+# Custom target to install all imex headers
+add_custom_target(imex-headers)
+set_target_properties(imex-headers PROPERTIES FOLDER "Misc")
+
+# Headers in source tree
+install(DIRECTORY include/imex
     DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
-    COMPONENT mlir-headers
+    COMPONENT imex-headers
     FILES_MATCHING
     PATTERN "*.def"
     PATTERN "*.h"
@@ -151,9 +231,10 @@ install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/mlir
     PATTERN "LICENSE.TXT"
 )
 
-install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include
+# Generated headers
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/imex
     DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
-    COMPONENT mlir-headers
+    COMPONENT imex-headers
     FILES_MATCHING
     PATTERN "*.def"
     PATTERN "*.h"
@@ -164,4 +245,26 @@ install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include
     PATTERN "config.h" EXCLUDE
 )
 
+add_llvm_install_targets(install-imex-headers
+                         DEPENDS imex-headers
+                         COMPONENT imex-headers)
+
+
+# Custom target to install all imex libraries
+add_custom_target(imex-libraries)
+set_target_properties(imex-libraries PROPERTIES FOLDER "Misc")
+
+add_llvm_install_targets(install-imex-libraries
+                         DEPENDS imex-libraries
+                         COMPONENT imex-libraries)
+
+get_property(IMEX_LIBS GLOBAL PROPERTY IMEX_ALL_LIBS)
+if(IMEX_LIBS)
+  list(REMOVE_DUPLICATES IMEX_LIBS)
+  foreach(lib ${IMEX_LIBS})
+    add_dependencies(imex-libraries ${lib})
+    add_dependencies(install-imex-libraries install-${lib})
+  endforeach()
+endif()
+
 add_subdirectory(cmake/modules)
diff --git a/cmake/modules/CMakeLists.txt b/cmake/modules/CMakeLists.txt
@@ -73,37 +73,6 @@ function(find_prefix_from_config out_var prefix_var path_to_leave)
 endfunction()
 endif() # if(NOT IMEX_EXTERNAL_PROJECT_BUILD)
 
-# -----------------------------------------------------------------------------#
-# We do not want to recreate the whole MLIR build infrastructure. As such the
-
-# helper function extracts the IMEX dialect, conversion, and transform libs from
-# the global MLIR properties.
-function(get_imex_libs lib_type)
-    if(${lib_type} STREQUAL "ALL")
-        get_property(LIBS GLOBAL PROPERTY MLIR_ALL_LIBS)
-        set(target_property_name "IMEX_ALL_LIBS")
-    elseif(${lib_type} STREQUAL "CONVERSION")
-        get_property(LIBS GLOBAL PROPERTY MLIR_CONVERSION_LIBS)
-        set(target_property_name "IMEX_CONVERSION_LIBS")
-    elseif(${lib_type} STREQUAL "DIALECT")
-        get_property(LIBS GLOBAL PROPERTY MLIR_DIALECT_LIBS)
-        set(target_property_name "IMEX_DIALECT_LIBS")
-    elseif(${lib_type} STREQUAL "TRANSLATION")
-        get_property(LIBS GLOBAL PROPERTY MLIR_TRANSLATION_LIBS)
-        set(target_property_name "IMEX_TRANSLATION_LIBS")
-    else()
-        message(FATAL_ERROR "Unknown category of library type")
-    endif()
-
-    foreach(LIB ${LIBS})
-        string(FIND ${LIB} "IMEX" starts_with_imex)
-
-        if(starts_with_imex GREATER -1)
-            set_property(GLOBAL APPEND PROPERTY ${target_property_name} ${LIB})
-        endif()
-    endforeach(LIB ${LIBS})
-endfunction(get_imex_libs)
-
 # -----------------------------------------------------------------------------#
 
 # Generate a list of CMake library targets so that other CMake projects can
@@ -112,15 +81,10 @@ endfunction(get_imex_libs)
 set(IMEX_INSTALL_PACKAGE_DIR lib${LLVM_LIBDIR_SUFFIX}/cmake/imex)
 set(imex_cmake_builddir "${IMEX_BINARY_DIR}/${IMEX_INSTALL_PACKAGE_DIR}")
 
+# Export build tree targets
 get_property(IMEX_EXPORTS GLOBAL PROPERTY IMEX_EXPORTS)
 export(TARGETS ${IMEX_EXPORTS} FILE ${imex_cmake_builddir}/IMEXTargets.cmake)
 
-# Get the list of the IMEX libs
-get_imex_libs("ALL")
-get_imex_libs("CONVERSION")
-get_imex_libs("DIALECT")
-get_imex_libs("TRANSLATION")
-
 get_property(IMEX_ALL_LIBS GLOBAL PROPERTY IMEX_ALL_LIBS)
 get_property(IMEX_DIALECT_LIBS GLOBAL PROPERTY IMEX_DIALECT_LIBS)
 get_property(IMEX_CONVERSION_LIBS GLOBAL PROPERTY IMEX_CONVERSION_LIBS)
diff --git a/cmake/modules/IMEXConfig.cmake.in b/cmake/modules/IMEXConfig.cmake.in
@@ -2,7 +2,8 @@
 
 @IMEX_CONFIG_CODE@
 
-find_package(LLVM REQUIRED CONFIG)
+# MLIRConfig.cmake calls find_package(LLVM REQUIRED CONFIG)
+# so no need to call that here.
 find_package(MLIR REQUIRED CONFIG)
 
 set(IMEX_EXPORTED_TARGETS "@IMEX_EXPORTS@")
diff --git a/include/imex/Dialect/GPUX/IR/CMakeLists.txt b/include/imex/Dialect/GPUX/IR/CMakeLists.txt
@@ -1,2 +1,2 @@
 add_mlir_dialect(GPUXOps gpux)
-add_mlir_doc(GPUXOps GPUXDialect Dialects/ -gen-dialect-doc)
+add_mlir_doc(GPUXOps GPUXDialect Dialects/ -gen-dialect-doc -dialect=gpux)
diff --git a/integration/example/CMakeLists.txt b/integration/example/CMakeLists.txt
@@ -0,0 +1,52 @@
+cmake_minimum_required(VERSION 3.13.4...3.18)
+
+# CMP0116: Ninja generators transform `DEPFILE`s from `add_custom_command()`
+# New in CMake 3.20. https://cmake.org/cmake/help/latest/policy/CMP0116.html
+if(POLICY CMP0116)
+    cmake_policy(SET CMP0116 OLD)
+endif()
+
+# Building standalone.
+project(imex-integration-example LANGUAGES CXX C)
+
+set(CMAKE_CXX_STANDARD 17 CACHE STRING "C++ standard to conform to")
+
+find_package(IMEX REQUIRED CONFIG)
+
+message(STATUS "Using IMEXConfig.cmake in: ${IMEX_DIR}")
+message(STATUS "Using MLIRConfig.cmake in: ${MLIR_DIR}")
+message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
+
+# For redirecting llvm_add_library() and others
+set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/bin)
+set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/lib)
+
+# LLVM_INCLUDE_DIRS is the same as MLIR_INCLUDE_DIRS in an MLIR install tree
+include_directories(${MLIR_INCLUDE_DIRS})
+include_directories(${IMEX_INCLUDE_DIRS})
+
+list(APPEND CMAKE_MODULE_PATH "${MLIR_CMAKE_DIR}")
+list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
+
+include(TableGen)
+include(AddLLVM)
+include(AddMLIR)
+include(HandleLLVMOptions)
+
+get_property(mlir_dialect_libs GLOBAL PROPERTY MLIR_DIALECT_LIBS)
+get_property(mlir_conversion_libs GLOBAL PROPERTY MLIR_CONVERSION_LIBS)
+get_property(imex_dialect_libs GLOBAL PROPERTY IMEX_DIALECT_LIBS)
+get_property(imex_conversion_libs GLOBAL PROPERTY IMEX_CONVERSION_LIBS)
+set(LIBS
+        ${mlir_dialect_libs}
+        ${mlir_conversion_libs}
+        ${imex_dialect_libs}
+        ${imex_conversion_libs}
+        MLIROptLib
+        IMEXTransforms
+        IMEXUtil
+        )
+add_llvm_executable(sample-opt sample-opt.cpp)
+
+llvm_update_compile_flags(sample-opt)
+target_link_libraries(sample-opt PRIVATE ${LIBS} IMEXTransforms)
diff --git a/integration/example/README.md b/integration/example/README.md
@@ -0,0 +1,24 @@
+<!--
+SPDX-FileCopyrightText: 2022 Intel Corporation
+
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+-->
+
+# IMEX Integration Example
+
+Example showing how to use IMEX as an external library from another CMake based project.
+
+## Prestep for building
+
+Build and install IMEX
+
+## Building sample-opt
+```
+cmake -B build -S . -GNinja -DIMEX_DIR=<path to directory with IMEXConfig.cmake> -DMLIR_DIR=<path to directory with MLIRConfig.cmake>
+cmake --build build
+```
+You can find executable sample-opt at build/bin/sample-opt
+
+## License
+This code is made available under the Apache License 2.0 with LLVM Exceptions.
+See the `LICENSE.txt` file for more details.
diff --git a/integration/example/sample-opt.cpp b/integration/example/sample-opt.cpp
@@ -0,0 +1,44 @@
+//===- sample-opt.cpp ---------------------------------------------*- C++
+//-*-===//
+//
+// Copyright 2022 Intel Corporation
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the IMEX optimizer driver.
+//
+//===----------------------------------------------------------------------===//
+
+#include <llvm/Support/CommandLine.h>
+#include <llvm/Support/InitLLVM.h>
+#include <llvm/Support/SourceMgr.h>
+#include <llvm/Support/ToolOutputFile.h>
+#include <mlir/IR/Dialect.h>
+#include <mlir/IR/MLIRContext.h>
+#include <mlir/InitAllDialects.h>
+#include <mlir/InitAllPasses.h>
+#include <mlir/Pass/Pass.h>
+#include <mlir/Pass/PassManager.h>
+#include <mlir/Support/FileUtilities.h>
+#include <mlir/Tools/mlir-opt/MlirOptMain.h>
+
+#include <imex/InitIMEXDialects.h>
+#include <imex/InitIMEXPasses.h>
+#include <imex/Transforms/Passes.h>
+
+int main(int argc, char **argv) {
+  ::mlir::registerAllPasses();
+  ::imex::registerAllPasses();
+
+  ::mlir::DialectRegistry registry;
+  ::mlir::registerAllDialects(registry);
+  ::imex::registerAllDialects(registry);
+
+  return ::mlir::asMainReturnCode(::mlir::MlirOptMain(
+      argc, argv,
+      "IMEX integration example: out of tree IMEX optimizer driver\n",
+      registry));
+}
diff --git a/tools/imex-opt/CMakeLists.txt b/tools/imex-opt/CMakeLists.txt

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`add_mlir_dialect(GPUXOps gpux)`
`2`		`-add_mlir_doc(GPUXOps GPUXDialect Dialects/ -gen-dialect-doc)`
	`2`	`+add_mlir_doc(GPUXOps GPUXDialect Dialects/ -gen-dialect-doc -dialect=gpux)`