[Comgr][SPIRV] Add Comgr CMake option to disable SPIRV

By passing -DCOMGR_DISABLE_SPIRV=1 when building Comgr via cmake,
a user can avoid installing and linking against the
SPIRV-LLVM-Translator

Change-Id: Id1624af4b3a0eb14a31ddedf3fd4474a3af95931

Author: lamb-j

amd/comgr/CMakeLists.txt

@@ -166,6 +166,10 @@ set(AMD_COMGR_PRIVATE_COMPILE_DEFINITIONS ${LLVM_DEFINITIONS})
 set(AMD_COMGR_PUBLIC_LINKER_OPTIONS)
 set(AMD_COMGR_PRIVATE_LINKER_OPTIONS)
 
+if(${COMGR_DISABLE_SPIRV})
+  list(APPEND AMD_COMGR_PRIVATE_COMPILE_OPTIONS "-DCOMGR_DISABLE_SPIRV")
+endif()
+
 list(APPEND AMD_COMGR_PRIVATE_COMPILE_OPTIONS "-DAMD_COMGR_GIT_COMMIT=${AMD_COMGR_GIT_COMMIT}")
 list(APPEND AMD_COMGR_PRIVATE_COMPILE_OPTIONS "-DAMD_COMGR_GIT_BRANCH=${AMD_COMGR_GIT_BRANCH}")
 message("----COMGR_GIT_COMMIT: ${AMD_COMGR_GIT_COMMIT}")
@@ -383,8 +387,18 @@ set(LLD_LIBS
   lldELF
   lldCommon)
 
+if (${COMGR_DISABLE_SPIRV})
+  message("-- Comgr SPIRV Disabled")
+  set(SPIRV_DYNAMIC_LIB "")
+  set(SPIRV_STATIC_LIB "")
+else()
+  message("-- Comgr SPIRV Enabled")
+  set(SPIRV_DYNAMIC_LIB "LLVMSPIRVAMDLib")
+  set(SPIRV_STATIC_LIB "SPIRVAMDLib")
+endif()
+
 if (LLVM_LINK_LLVM_DYLIB)
-  set(LLVM_LIBS LLVM)
+  set(LLVM_LIBS LLVM ${SPIRV_DYNAMIC_LIB})
 else()
   llvm_map_components_to_libnames(LLVM_LIBS
     ${LLVM_TARGETS_TO_BUILD}
@@ -405,7 +419,7 @@ else()
     Support
     Symbolize
     TargetParser
-    SPIRVAMDLib
+    ${SPIRV_STATIC_LIB}
     )
 endif()
 

amd/comgr/README.md

@@ -80,6 +80,10 @@ may be enabled during development via `-DADDRESS_SANITIZER=On` during the Comgr
 Comgr can be built as a static library by passing
 `-DCOMGR_BUILD_SHARED_LIBS=OFF` during the Comgr `cmake` step.
 
+Comgr SPIRV-related APIs can be disabled by passing
+`-DCOMGR_DISABLE_SPIRV=1` during the Comgr `cmake` step. This removes any
+dependency on LLVM SPIRV libraries or the llvm-spirv tool.
+
 Depending on the Code Object Manager
 ------------------------------------
 

amd/comgr/src/comgr-compiler.cpp

@@ -81,7 +81,10 @@
 #include "llvm/Support/WithColor.h"
 #include "llvm/TargetParser/Host.h"
 
+#ifndef COMGR_DISABLE_SPIRV
 #include "LLVMSPIRVLib/LLVMSPIRVLib.h"
+#endif
+
 #include "time-stat/ts-interface.h"
 
 #include <csignal>
@@ -1852,6 +1855,12 @@ amd_comgr_status_t AMDGPUCompiler::linkToExecutable() {
 }
 
 amd_comgr_status_t AMDGPUCompiler::translateSpirvToBitcode() {
+#ifdef COMGR_DISABLE_SPIRV
+  LogS << "Calling AMDGPUCompiler::translateSpirvToBitcode() not supported "
+    << "Comgr is built with -DCOMGR_DISABLE_SPIRV. Re-build LLVM and Comgr "
+    << "with LLVM-SPIRV-Translator support to continue.\n";
+  return AMD_COMGR_STATUS_ERROR;
+#else
   if (auto Status = createTmpDirs()) {
     return Status;
   }
@@ -1906,6 +1915,7 @@ amd_comgr_status_t AMDGPUCompiler::translateSpirvToBitcode() {
   }
 
   return AMD_COMGR_STATUS_SUCCESS;
+#endif
 }
 
 AMDGPUCompiler::AMDGPUCompiler(DataAction *ActionInfo, DataSet *InSet,