[CIR] Add 'cir' to LLVM_ENABLE_PROJECTS and make ClangIR build optional via CMAKE

- Also fix the way we do testing and disable when CIR not available.

Author: bcardosolopes

clang/include/clang/CMakeLists.txt

@@ -1,6 +1,8 @@
 add_subdirectory(AST)
 add_subdirectory(Basic)
-add_subdirectory(CIR)
+if(CLANG_ENABLE_CIR)
+  add_subdirectory(CIR)
+endif()
 add_subdirectory(Driver)
 add_subdirectory(Parse)
 add_subdirectory(Sema)

clang/include/clang/Config/config.h.cmake

@@ -104,4 +104,7 @@
 /* Whether to enable opaque pointers by default */
 #cmakedefine01 CLANG_ENABLE_OPAQUE_POINTERS_INTERNAL
 
+/* Whether CIR is built into Clang */
+#cmakedefine01 CLANG_ENABLE_CIR
+
 #endif

clang/lib/CMakeLists.txt

@@ -30,4 +30,7 @@ if(CLANG_INCLUDE_TESTS)
 endif()
 add_subdirectory(Interpreter)
 add_subdirectory(Support)
-add_subdirectory(CIR)
+
+if(CLANG_ENABLE_CIR)
+  add_subdirectory(CIR)
+endif()

clang/lib/FrontendTool/CMakeLists.txt

@@ -9,10 +9,15 @@ set(link_libs
   clangDriver
   clangExtractAPI
   clangFrontend
-  clangCIRFrontendAction
   clangRewriteFrontend
   )
 
+if(CLANG_ENABLE_CIR)
+  list(APPEND link_libs
+    clangCIRFrontendAction
+    )
+endif()
+
 if(CLANG_ENABLE_ARCMT)
   list(APPEND link_libs
     clangARCMigrate

clang/lib/FrontendTool/ExecuteCompilerInvocation.cpp

@@ -12,7 +12,6 @@
 //===----------------------------------------------------------------------===//
 
 #include "clang/ARCMigrate/ARCMTActions.h"
-#include "clang/CIRFrontendAction/CIRGenAction.h"
 #include "clang/CodeGen/CodeGenAction.h"
 #include "clang/Config/config.h"
 #include "clang/Driver/Options.h"
@@ -32,8 +31,12 @@
 #include "llvm/Support/BuryPointer.h"
 #include "llvm/Support/DynamicLibrary.h"
 #include "llvm/Support/ErrorHandling.h"
+
+#if CLANG_ENABLE_CIR
+#include "clang/CIRFrontendAction/CIRGenAction.h"
+#endif
+
 using namespace clang;
-using namespace cir;
 using namespace llvm::opt;
 
 namespace clang {
@@ -68,19 +71,29 @@ CreateFrontendBaseAction(CompilerInstance &CI) {
   case DumpTokens:             return std::make_unique<DumpTokensAction>();
   case EmitAssembly:           return std::make_unique<EmitAssemblyAction>();
   case EmitBC:                 return std::make_unique<EmitBCAction>();
-  case EmitCIR:                return std::make_unique<EmitCIRAction>();
-  case EmitCIROnly:            return std::make_unique<EmitCIROnlyAction>();
+#if CLANG_ENABLE_CIR
+  case EmitCIR:                return std::make_unique<::cir::EmitCIRAction>();
+  case EmitCIROnly:            return std::make_unique<::cir::EmitCIROnlyAction>();
+#else
+  case EmitCIR:
+  case EmitCIROnly:
+    llvm_unreachable("CIR suppport not built into clang");
+#endif
   case EmitHTML:               return std::make_unique<HTMLPrintAction>();
   case EmitLLVM: {
+#if CLANG_ENABLE_CIR
     if (UseCIR)
-      return std::make_unique<cir::EmitLLVMAction>();
+      return std::make_unique<::cir::EmitLLVMAction>();
+#endif
     return std::make_unique<EmitLLVMAction>();
   }
   case EmitLLVMOnly:           return std::make_unique<EmitLLVMOnlyAction>();
   case EmitCodeGenOnly:        return std::make_unique<EmitCodeGenOnlyAction>();
   case EmitObj: {
+#if CLANG_ENABLE_CIR
     if (UseCIR)
-      return std::make_unique<cir::EmitObjAction>();
+      return std::make_unique<::cir::EmitObjAction>();
+#endif
     return std::make_unique<EmitObjAction>();
   }
   case ExtractAPI:

clang/test/CIR/lit.local.cfg

@@ -0,0 +1,2 @@
+if not config.root.clang_enable_cir:
+    config.unsupported = True

clang/test/CMakeLists.txt

@@ -10,6 +10,7 @@ llvm_canonicalize_cmake_booleans(
   CLANG_ENABLE_STATIC_ANALYZER
   CLANG_PLUGIN_SUPPORT
   CLANG_SPAWN_CC1
+  CLANG_ENABLE_CIR
   ENABLE_BACKTRACES
   LLVM_ENABLE_ZLIB
   LLVM_ENABLE_ZSTD
@@ -59,7 +60,6 @@ endif ()
 list(APPEND CLANG_TEST_DEPS
   apinotes-test
   c-index-test
-  cir-tool
   clang
   clang-fuzzer-dictionary
   clang-resource-headers
@@ -75,7 +75,13 @@ list(APPEND CLANG_TEST_DEPS
   hmaptool
   mlir-translate
   )
-  
+
+if(CLANG_ENABLE_CIR)
+  list(APPEND CLANG_TEST_DEPS
+    cir-tool
+    )
+endif()
+
 if(CLANG_ENABLE_STATIC_ANALYZER)
   list(APPEND CLANG_TEST_DEPS
     clang-check

clang/test/lit.site.cfg.py.in

@@ -29,6 +29,7 @@ config.clang_default_std_cxx = "@CLANG_DEFAULT_STD_CXX@"
 config.clang_default_cxx_stdlib = "@CLANG_DEFAULT_CXX_STDLIB@"
 config.clang_staticanalyzer = @CLANG_ENABLE_STATIC_ANALYZER@
 config.clang_staticanalyzer_z3 = @LLVM_WITH_Z3@
+config.clang_enable_cir = @CLANG_ENABLE_CIR@
 config.clang_examples = @CLANG_BUILD_EXAMPLES@
 config.enable_shared = @ENABLE_SHARED@
 config.enable_backtrace = @ENABLE_BACKTRACES@

clang/tools/CMakeLists.txt

@@ -3,7 +3,9 @@ create_subdirectory_options(CLANG TOOL)
 add_clang_subdirectory(diagtool)
 add_clang_subdirectory(driver)
 add_clang_subdirectory(apinotes-test)
-add_clang_subdirectory(cir-tool)
+if(CLANG_ENABLE_CIR)
+  add_clang_subdirectory(cir-tool)
+endif()
 add_clang_subdirectory(clang-diff)
 add_clang_subdirectory(clang-format)
 add_clang_subdirectory(clang-format-vs)

llvm/CMakeLists.txt

@@ -109,7 +109,7 @@ endif()
 # LLVM_EXTERNAL_${project}_SOURCE_DIR using LLVM_ALL_PROJECTS
 # This allows an easy way of setting up a build directory for llvm and another
 # one for llvm+clang+... using the same sources.
-set(LLVM_ALL_PROJECTS "bolt;clang;clang-tools-extra;compiler-rt;cross-project-tests;libc;libclc;libcxx;libcxxabi;libunwind;lld;lldb;mlir;openmp;polly;pstl")
+set(LLVM_ALL_PROJECTS "bolt;cir;clang;clang-tools-extra;compiler-rt;cross-project-tests;libc;libclc;libcxx;libcxxabi;libunwind;lld;lldb;mlir;openmp;polly;pstl")
 # The flang project is not yet part of "all" projects (see C++ requirements)
 set(LLVM_EXTRA_PROJECTS "flang")
 # List of all known projects in the mono repo
@@ -143,6 +143,17 @@ if ("flang" IN_LIST LLVM_ENABLE_PROJECTS)
   endif()
 endif()
 
+if ("cir" IN_LIST LLVM_ENABLE_PROJECTS)
+  if (NOT "mlir" IN_LIST LLVM_ENABLE_PROJECTS)
+    message(STATUS "Enabling MLIR as a dependency to CIR")
+    list(APPEND LLVM_ENABLE_PROJECTS "mlir")
+  endif()
+
+  if (NOT "clang" IN_LIST LLVM_ENABLE_PROJECTS)
+    message(FATAL_ERROR "Clang is not enabled, but is required to use CIR")
+  endif()
+endif()
+
 # Select the runtimes to build
 #
 # As we migrate runtimes to using the bootstrapping build, the set of default runtimes
@@ -184,6 +195,13 @@ if (LLVM_ENABLE_PROJECTS_USED OR NOT LLVM_ENABLE_PROJECTS STREQUAL "")
     string(REGEX REPLACE "-" "_" upper_proj ${upper_proj})
     if ("${proj}" IN_LIST LLVM_ENABLE_PROJECTS)
       message(STATUS "${proj} project is enabled")
+      # ClangIR is integrated inside clang and also provides the cir-tool,
+      # it needs some special handling.
+      if ("${proj}" STREQUAL "cir")
+        set(CLANG_ENABLE_CIR ON)
+        continue()
+      endif()
+
       set(SHOULD_ENABLE_PROJECT TRUE)
       set(PROJ_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../${proj}")
       if(NOT EXISTS "${PROJ_DIR}" OR NOT IS_DIRECTORY "${PROJ_DIR}")