[Comgr] Add compile-to-exec action and LLVM-IR language

lamb-j · lamb-j · commit 7e5bd4b1d2fd · 2023-12-01T16:45:05.000-05:00
In this patch, we add a new action to allow compilation from
source directly into an executable (.so) file. We also add support
for a new language type, LLVM-IR, which allows users to pass
.ll and .bc files to AMD_COMGR_COMPILE_* actions as input.

Change-Id: I111a10a9b09d1cda84a24579c7ea144f52a6041c
diff --git a/amd/comgr/docs/ReleaseNotes.md b/amd/comgr/docs/ReleaseNotes.md
@@ -98,6 +98,14 @@ of the flag handling to toolchain. Currently only supports HIP.
 - (Data Type) AMD\_COMGR\_DATA\_KIND\_AR\_BUNDLE
   - These data kinds can now be passed to an AMD\_COMGR\_ACTION\_LINK\_BC\_TO\_BC
 action, and Comgr will internally unbundle and link via the OffloadBundler and linkInModule APIs.
+- (Language Type) AMD\_COMGR\_LANGUAGE\_LLVM\_IR
+  - This language can now be passed to AMD\_COMGR\_ACTION\_COMPILE\_\* actions
+  to enable compilation of LLVM IR (.ll or .bc) files. This is useful for MLIR
+  contexts.
+- (Action) AMD\_COMGR\_ACTION\_COMPILE\_SOURCE\_TO\_EXECUTABLE
+  - This action allows compilation from source directly to executable, including
+  linking device libraries.
+
 
 Deprecated Comgr Actions and Data Types
 ---------------------------------------
diff --git a/amd/comgr/include/amd_comgr.h.in b/amd/comgr/include/amd_comgr.h.in
@@ -273,10 +273,14 @@ typedef enum amd_comgr_language_s {
    * HIP.
    */
   AMD_COMGR_LANGUAGE_HIP = 0x4,
+  /**
+   * LLVM IR, either textual (.ll) or bitcode (.bc) format.
+   */
+  AMD_COMGR_LANGUAGE_LLVM_IR = 0x5,
   /**
    * Marker for last valid language.
    */
-  AMD_COMGR_LANGUAGE_LAST = AMD_COMGR_LANGUAGE_HIP
+  AMD_COMGR_LANGUAGE_LAST = AMD_COMGR_LANGUAGE_LLVM_IR
 } amd_comgr_language_t;
 
 /**
@@ -1768,10 +1772,26 @@ typedef enum amd_comgr_action_kind_s {
    * if isa name or language is not set in @p info.
    */
   AMD_COMGR_ACTION_COMPILE_SOURCE_TO_RELOCATABLE = 0x10,
+  /**
+   * Compile each source data object in @p input and create a single executabele
+   * in @p result. Resolve any include source names using the names of include
+   * data objects in @p input. Resolve any include relative path names using the
+   * working directory path in @p info. Produce executable for isa name in @p
+   * info. Compile the source for the language in @p info. Link against
+   * the device-specific and language-specific bitcode device libraries
+   * required for compilation.
+   *
+   * Return @p AMD_COMGR_STATUS_ERROR if any compilation
+   * fails.
+   *
+   * Return @p AMD_COMGR_STATUS_ERROR_INVALID_ARGUMENT
+   * if isa name or language is not set in @p info.
+   */
+  AMD_COMGR_ACTION_COMPILE_SOURCE_TO_EXECUTABLE = 0x11,
   /**
    * Marker for last valid action kind.
    */
-  AMD_COMGR_ACTION_LAST = AMD_COMGR_ACTION_COMPILE_SOURCE_TO_RELOCATABLE
+  AMD_COMGR_ACTION_LAST = AMD_COMGR_ACTION_COMPILE_SOURCE_TO_EXECUTABLE
 } amd_comgr_action_kind_t;
 
 /**
diff --git a/amd/comgr/src/comgr-compiler.cpp b/amd/comgr/src/comgr-compiler.cpp
@@ -1039,6 +1039,9 @@ amd_comgr_status_t AMDGPUCompiler::addCompilationFlags() {
   Args.push_back("-x");
 
   switch (ActionInfo->Language) {
+  case AMD_COMGR_LANGUAGE_LLVM_IR:
+    Args.push_back("ir");
+    break;
   case AMD_COMGR_LANGUAGE_OPENCL_1_2:
     Args.push_back("cl");
     Args.push_back("-std=cl1.2");
@@ -1151,6 +1154,36 @@ amd_comgr_status_t AMDGPUCompiler::compileToBitcode(bool WithDeviceLibs) {
   return processFiles(AMD_COMGR_DATA_KIND_BC, ".bc");
 }
 
+amd_comgr_status_t AMDGPUCompiler::compileToExecutable() {
+  if (auto Status = createTmpDirs()) {
+    return Status;
+  }
+
+  if (ActionInfo->IsaName) {
+    if (auto Status = addTargetIdentifierFlags(ActionInfo->IsaName, true)) {
+      return Status;
+    }
+  }
+
+  if (auto Status = addIncludeFlags()) {
+    return Status;
+  }
+
+  if (auto Status = addCompilationFlags()) {
+    return Status;
+  }
+
+#if _WIN32
+  Args.push_back("-fshort-wchar");
+#endif
+
+  if (auto Status = addDeviceLibraries()) {
+    return Status;
+  }
+
+  return processFiles(AMD_COMGR_DATA_KIND_EXECUTABLE, ".so");
+}
+
 amd_comgr_status_t AMDGPUCompiler::compileToRelocatable() {
   if (auto Status = createTmpDirs()) {
     return Status;
diff --git a/amd/comgr/src/comgr-compiler.h b/amd/comgr/src/comgr-compiler.h
@@ -150,6 +150,7 @@ class AMDGPUCompiler {
   amd_comgr_status_t linkToRelocatable();
   amd_comgr_status_t linkToExecutable();
   amd_comgr_status_t compileToFatBin();
+  amd_comgr_status_t compileToExecutable();
 
   amd_comgr_language_t getLanguage() const { return ActionInfo->Language; }
 };
diff --git a/amd/comgr/src/comgr.cpp b/amd/comgr/src/comgr.cpp
@@ -182,6 +182,8 @@ dispatchCompilerAction(amd_comgr_action_kind_t ActionKind,
     return Compiler.compileToRelocatable();
   case AMD_COMGR_ACTION_COMPILE_SOURCE_WITH_DEVICE_LIBS_TO_BC:
     return Compiler.compileToBitcode(true);
+  case AMD_COMGR_ACTION_COMPILE_SOURCE_TO_EXECUTABLE:
+    return Compiler.compileToExecutable();
 
   default:
     return AMD_COMGR_STATUS_ERROR_INVALID_ARGUMENT;
@@ -242,6 +244,8 @@ StringRef getActionKindName(amd_comgr_action_kind_t ActionKind) {
     return "AMD_COMGR_ACTION_COMPILE_SOURCE_TO_FATBIN";
   case AMD_COMGR_ACTION_COMPILE_SOURCE_WITH_DEVICE_LIBS_TO_BC:
     return "AMD_COMGR_ACTION_COMPILE_SOURCE_WITH_DEVICE_LIBS_TO_BC";
+  case AMD_COMGR_ACTION_COMPILE_SOURCE_TO_EXECUTABLE:
+    return "AMD_COMGR_ACTION_COMPILE_SOURCE_TO_EXECUTABLE";
   }
 
   llvm_unreachable("invalid action");
@@ -259,6 +263,8 @@ static StringRef getLanguageName(amd_comgr_language_t Language) {
     return "AMD_COMGR_LANGUAGE_HC";
   case AMD_COMGR_LANGUAGE_HIP:
     return "AMD_COMGR_LANGUAGE_HIP";
+  case AMD_COMGR_LANGUAGE_LLVM_IR:
+    return "AMD_COMGR_LANGUAGE_LLVM_IR";
   }
 
   llvm_unreachable("invalid language");
@@ -1360,6 +1366,7 @@ amd_comgr_status_t AMD_COMGR_API
     case AMD_COMGR_ACTION_COMPILE_SOURCE_TO_RELOCATABLE:
     case AMD_COMGR_ACTION_COMPILE_SOURCE_TO_FATBIN:
     case AMD_COMGR_ACTION_COMPILE_SOURCE_WITH_DEVICE_LIBS_TO_BC:
+    case AMD_COMGR_ACTION_COMPILE_SOURCE_TO_EXECUTABLE:
       ActionStatus = dispatchCompilerAction(ActionKind, ActionInfoP, InputSetP,
                                             ResultSetP, *LogP);
       break;
diff --git a/amd/comgr/test/CMakeLists.txt b/amd/comgr/test/CMakeLists.txt
@@ -91,6 +91,7 @@ add_test_input_binary(reloc2 source/reloc2.cl source/reloc2.o -c -mcode-object-v
 add_test_input_binary(reloc-asm source/reloc-asm.s source/reloc-asm.o -c -mcode-object-version=4)
 add_test_input_binary(shared source/shared.cl source/shared.so -mcode-object-version=4)
 add_test_input_binary(shared-debug source/shared.cl source/shared-debug.so -g -mcode-object-version=4)
+add_test_input_bitcode(source1 source/source1.cl source/source1.bc)
 
 configure_file("source/source1.cl" "source/source1.cl" COPYONLY)
 configure_file("source/source2.cl" "source/source2.cl" COPYONLY)
@@ -201,6 +202,7 @@ add_comgr_test(multithread_test cpp)
 add_comgr_test(name_expression_map_test c)
 add_comgr_test(nested_kernel_test c)
 add_comgr_test(map_elf_virtual_address_test c)
+add_comgr_test(compile_source_to_executable c)
 
 # Test : Compile HIP tests only if HIP-Clang is installed.
 if (DEFINED HIP_COMPILER AND "${HIP_COMPILER}" STREQUAL "clang")
diff --git a/amd/comgr/test/compile_source_to_executable.c b/amd/comgr/test/compile_source_to_executable.c
