#------------------------------------------------------------------------------- # Project setup and globals #------------------------------------------------------------------------------- cmake_minimum_required(VERSION 3.12) 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() if(POLICY CMP0116) cmake_policy(SET CMP0116 OLD) endif() project(torch-mlir LANGUAGES CXX C) set(CMAKE_C_STANDARD 11) set(CMAKE_CXX_STANDARD 17) include(CMakeDependentOption) #------------------------------------------------------------------------------- # Project options #------------------------------------------------------------------------------- option(TORCH_MLIR_ENABLE_WERROR_FLAG "Enable `-Werror` flag on supported directories, treat error as warning" OFF) option(TORCH_MLIR_USE_INSTALLED_PYTORCH "If depending on PyTorch use it as installed in the current Python environment" ON) option(TORCH_MLIR_ENABLE_REFBACKEND "Enable reference backend" ON) if(TORCH_MLIR_ENABLE_REFBACKEND) add_definitions(-DTORCH_MLIR_ENABLE_REFBACKEND) endif() option(TORCH_MLIR_ENABLE_STABLEHLO "Add stablehlo dialect" ON) if(TORCH_MLIR_ENABLE_STABLEHLO) add_definitions(-DTORCH_MLIR_ENABLE_STABLEHLO) endif() option(TORCH_MLIR_OUT_OF_TREE_BUILD "Specifies an out of tree build" OFF) # PyTorch native extension gate. If OFF, then no features which depend on # native extensions will be built.TORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS is disabled by default. # But it will be manually enabled in CI build to enable the jit_ir_importer.build_tools.torch_ods_gen # and abstract_interp_lib_gen.py. Once pure python version of build_tools finished, no need to set it in CI. option(TORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS "Enables PyTorch native extension features" OFF) if(TORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS) add_definitions(-DTORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS) endif() # NOTE: The JIT_IR_IMPORTER paths have become unsupportable due to age and lack of maintainers. # Turning this off disables the old TorchScript path, leaving FX based import as the current supported option. # The option will be retained for a time, and if a maintainer is interested in setting up testing for it, # please reach out on the list and speak up for it. It will only be enabled in CI for test usage. cmake_dependent_option(TORCH_MLIR_ENABLE_JIT_IR_IMPORTER "Enables JIT IR Importer" ON TORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS OFF) cmake_dependent_option(TORCH_MLIR_ENABLE_LTC "Enables LTC backend" OFF TORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS OFF) option(TORCH_MLIR_ENABLE_ONNX_C_IMPORTER "Enables the ONNX C importer" OFF) macro(torch_mlir_enable_werror) if(TORCH_MLIR_ENABLE_WERROR_FLAG) if(NOT MSVC) add_compile_options(-Werror) endif() endif() endmacro() #------------------------------------------------------------------------------- # Configure out-of-tree vs in-tree build #------------------------------------------------------------------------------- if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR OR TORCH_MLIR_OUT_OF_TREE_BUILD) message(STATUS "Torch-MLIR out-of-tree build.") # Out-of-tree build #------------------------------------------------------------------------------- # MLIR/LLVM Configuration #------------------------------------------------------------------------------- find_package(MLIR REQUIRED CONFIG) 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(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) # 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") list(APPEND CMAKE_MODULE_PATH "${MLIR_CMAKE_DIR}") list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}") include(TableGen) include(AddLLVM) include(AddMLIR) include(HandleLLVMOptions) # Don't try to compile the python extensions at the moment. We need # to import lots of dependencies from AddMLIRPython to make this work. set(MLIR_ENABLE_BINDINGS_PYTHON ON) set(TORCH-MLIR_BUILT_STANDALONE ON) set(BACKEND_PACKAGE_STRING "LLVM ${LLVM_PACKAGE_VERSION}") else() message(STATUS "Torch-MLIR in-tree build.") # In-tree build with LLVM_EXTERNAL_PROJECTS=torch-mlir option(MLIR_ENABLE_BINDINGS_PYTHON "Enables MLIR Python Bindings" OFF) # TODO: Fix this upstream so that global include directories are not needed. set(MLIR_MAIN_SRC_DIR ${LLVM_MAIN_SRC_DIR}/../mlir) set(MLIR_INCLUDE_DIR ${LLVM_MAIN_SRC_DIR}/../mlir/include) set(MLIR_GENERATED_INCLUDE_DIR ${LLVM_BINARY_DIR}/tools/mlir/include) set(MLIR_INCLUDE_DIRS "${MLIR_INCLUDE_DIR};${MLIR_GENERATED_INCLUDE_DIR}") endif() set(TORCH_MLIR_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}") set(TORCH_MLIR_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}") message(STATUS "Building torch-mlir project at ${TORCH_MLIR_SOURCE_DIR} (into ${TORCH_MLIR_BINARY_DIR})") include_directories(${LLVM_INCLUDE_DIRS}) include_directories(${MLIR_INCLUDE_DIRS}) include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include) include_directories(${CMAKE_CURRENT_BINARY_DIR}/include) function(torch_mlir_target_includes target) set(_dirs $ $ $ ) # In LLVM parlance, the actual target may just be an interface and may not # be responsible for actually compiling anything. The corresponding obj. # target, when present, is just used for compilation and does not # contribute to the interface properties. # TODO: Normalize this upstream. target_include_directories(${target} PUBLIC ${_dirs}) if(TARGET obj.${target}) target_include_directories(obj.${target} PRIVATE ${_dirs}) endif() endfunction() # Configure CMake. list(APPEND CMAKE_MODULE_PATH ${MLIR_MAIN_SRC_DIR}/cmake/modules) list(APPEND CMAKE_MODULE_PATH ${LLVM_MAIN_SRC_DIR}/cmake) list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/build_tools/cmake) include(TableGen) include(AddLLVM) include(AddMLIR) include(AddMLIRPython) ################################################################################ # Setup python. ################################################################################ if(MLIR_ENABLE_BINDINGS_PYTHON) include(MLIRDetectPythonEnv) mlir_configure_python_dev_packages() endif() add_subdirectory(include) add_subdirectory(lib) add_subdirectory(tools) add_custom_target(check-torch-mlir-all) add_dependencies(check-torch-mlir-all check-torch-mlir) if(MLIR_ENABLE_BINDINGS_PYTHON) # If parent projects want to configure where to place the python packages, # respect that. if(NOT TORCH_MLIR_PYTHON_PACKAGES_DIR) set(TORCH_MLIR_PYTHON_PACKAGES_DIR "${CMAKE_CURRENT_BINARY_DIR}/python_packages") endif() endif() add_subdirectory(test) if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY) install(DIRECTORY include/torch-mlir include/torch-mlir-c DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}" COMPONENT torch-mlir-headers FILES_MATCHING PATTERN "*.def" PATTERN "*.h" PATTERN "*.inc" PATTERN "*.td" PATTERN "LICENSE.TXT" ) install(DIRECTORY ${TORCH_MLIR_BINARY_DIR}/include/torch-mlir DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}" COMPONENT torch-mlir-headers FILES_MATCHING PATTERN "*.def" PATTERN "*.h" PATTERN "*.gen" PATTERN "*.inc" PATTERN "*.td" PATTERN "CMakeFiles" EXCLUDE PATTERN "config.h" EXCLUDE ) if (NOT LLVM_ENABLE_IDE) add_llvm_install_targets(install-torch-mlir-headers DEPENDS torch-mlir-headers COMPONENT torch-mlir-headers) endif() endif() # Important: If loading StableHLO in this fashion, it must come last, # after all of our libraries and test targets have been defined. # It seems that they both abuse upstream CMake macros that accumulate # properties. # Getting this wrong results in building large parts of the stablehlo # project that we don't actually depend on. Further some of those parts # do not even compile on all platforms. if (TORCH_MLIR_ENABLE_STABLEHLO) set(STABLEHLO_BUILD_EMBEDDED ON) set(STABLEHLO_ENABLE_BINDINGS_PYTHON ON) add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/externals/stablehlo ${CMAKE_CURRENT_BINARY_DIR}/stablehlo EXCLUDE_FROM_ALL) include_directories(${CMAKE_CURRENT_SOURCE_DIR}/externals/stablehlo) endif() #------------------------------------------------------------------------------- # Sub-projects #------------------------------------------------------------------------------- # Sub-projects can bundle additional PyTorch extensions by adding them to this # source target. It is typically empty unless if features are enabled. if(MLIR_ENABLE_BINDINGS_PYTHON) declare_mlir_python_sources(TorchMLIRPythonTorchExtensionsSources) endif() # Build projects first as it may populate additional Python deps. add_subdirectory(projects) # Finish with top-level Python bindings so it can handle additional deps. if(MLIR_ENABLE_BINDINGS_PYTHON) add_subdirectory(python) endif()