[SYCL] Move module splitting functionality from sycl-post-link to SYC…

…LLowerIR (#12622)

This is a part of migration to New Offloading model and
clang-linker-wrapper tool.
The signature of the verifyNoCrossModuleDeviceGlobalUsage is changed so
that it returns an Error instead of aborting the executable.

llvm/tools/sycl-post-link/ModuleSplitter.h → llvm/include/llvm/SYCLLowerIR/ModuleSplitter.h

@@ -10,14 +10,16 @@
 // of the split is new modules containing corresponding callgraph.
 //===----------------------------------------------------------------------===//
 
-#pragma once
+#ifndef LLVM_SYCLLOWERIR_MODULE_SPLITTER_H
+#define LLVM_SYCLLOWERIR_MODULE_SPLITTER_H
 
 #include "llvm/ADT/SetVector.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/IR/Function.h"
 #include "llvm/Support/Error.h"
 
 #include <memory>
+#include <string>
 #include <vector>
 
 namespace llvm {
@@ -229,8 +231,8 @@ class ModuleSplitterBase {
  // For device global variables with the 'device_image_scope' property,
  // the function checks that there are no usages of a single device global
  // variable from kernels grouped to different modules. Otherwise, an error is
- // issued and the tool is aborted.
- void verifyNoCrossModuleDeviceGlobalUsage();
+ // returned.
+ Error verifyNoCrossModuleDeviceGlobalUsage();
 
  virtual ~ModuleSplitterBase() = default;
 
@@ -262,3 +264,5 @@ void dumpEntryPoints(const Module &M, bool OnlyKernelsAreEntryPoints = false,
 } // namespace module_split
 
 } // namespace llvm
+
+#endif // LLVM_SYCLLOWERIR_MODULE_SPLITTER_H

llvm/lib/SYCLLowerIR/CMakeLists.txt

@@ -62,6 +62,7 @@ add_llvm_component_library(LLVMSYCLLowerIR
  LowerInvokeSimd.cpp
  LowerWGLocalMemory.cpp
  LowerWGScope.cpp
+ ModuleSplitter.cpp
  MutatePrintfAddrspace.cpp
  SYCLAddOptLevelAttribute.cpp
  SYCLPropagateAspectsUsage.cpp

llvm/tools/sycl-post-link/ModuleSplitter.cpp → llvm/lib/SYCLLowerIR/ModuleSplitter.cpp

@@ -8,9 +8,7 @@
 // See comments in the header.
 //===----------------------------------------------------------------------===//
 
-#include "ModuleSplitter.h"
-#include "Support.h"
-
+#include "llvm/SYCLLowerIR/ModuleSplitter.h"
 #include "llvm/ADT/SetVector.h"
 #include "llvm/ADT/SmallPtrSet.h"
 #include "llvm/ADT/StringExtras.h"
@@ -23,6 +21,7 @@
 #include "llvm/SYCLLowerIR/DeviceGlobals.h"
 #include "llvm/SYCLLowerIR/LowerInvokeSimd.h"
 #include "llvm/SYCLLowerIR/SYCLUtils.h"
+#include "llvm/Support/Error.h"
 #include "llvm/Transforms/IPO.h"
 #include "llvm/Transforms/IPO/GlobalDCE.h"
 #include "llvm/Transforms/IPO/StripDeadPrototypes.h"
@@ -426,14 +425,15 @@ class ModuleSplitter : public ModuleSplitterBase {
  DependencyGraph CG;
 };
 } // namespace
+
 namespace llvm {
 namespace module_split {
 
-void ModuleSplitterBase::verifyNoCrossModuleDeviceGlobalUsage() {
+Error ModuleSplitterBase::verifyNoCrossModuleDeviceGlobalUsage() {
  const Module &M = getInputModule();
  // Early exit if there is only one group
  if (Groups.size() < 2)
- return;
+ return Error::success();
 
  // Reverse the EntryPointGroupMap to get a map of entry point -> module's name
  unsigned EntryPointNumber = 0;
@@ -451,19 +451,25 @@ void ModuleSplitterBase::verifyNoCrossModuleDeviceGlobalUsage() {
 
  std::optional<StringRef> VarEntryPointModule{};
  auto CheckEntryPointModule = [&VarEntryPointModule, &EntryPointModules,
- &GV](const auto *F) {
+ &GV](const auto *F) -> Error {
  auto EntryPointModulesIt = EntryPointModules.find(F);
- assert(EntryPointModulesIt != EntryPointModules.end() &&
- "There is no group for an entry point");
+ if (EntryPointModulesIt == EntryPointModules.end())
+ return createStringError(inconvertibleErrorCode(),
+ "There is no group for an entry point");
+
  if (!VarEntryPointModule.has_value()) {
  VarEntryPointModule = EntryPointModulesIt->second;
- return;
- }
- if (EntryPointModulesIt->second != *VarEntryPointModule) {
- error("device_global variable '" + Twine(GV.getName()) +
- "' with property \"device_image_scope\" is used in more "
- "than one device image.");
+ return Error::success();
  }
+
+ if (EntryPointModulesIt->second != *VarEntryPointModule)
+ return createStringError(
+ inconvertibleErrorCode(),
+ "device_global variable '" + Twine(GV.getName()) +
+ "' with property \"device_image_scope\" is used in more "
+ "than one device image.");
+
+ return Error::success();
  };
 
  SmallSetVector<const User *, 32> Workqueue;
@@ -478,13 +484,18 @@ void ModuleSplitterBase::verifyNoCrossModuleDeviceGlobalUsage() {
  continue;
  }
  if (auto *F = dyn_cast<const Function>(U)) {
- if (EntryPointModules.count(F))
- CheckEntryPointModule(F);
+ if (EntryPointModules.count(F)) {
+ auto E = CheckEntryPointModule(F);
+ if (E)
+ return E;
+ }
  }
  for (auto *UU : U->users())
  Workqueue.insert(UU);
  }
  }
+
+ return Error::success();
 }
 
 #ifndef NDEBUG

llvm/tools/sycl-post-link/CMakeLists.txt

@@ -24,7 +24,6 @@ include_directories(
 
 add_llvm_tool(sycl-post-link
  sycl-post-link.cpp
- ModuleSplitter.cpp
  SpecConstants.cpp
  SYCLDeviceLibReqMask.cpp
  SYCLKernelParamOptInfo.cpp

llvm/tools/sycl-post-link/SYCLDeviceRequirements.cpp

@@ -7,11 +7,11 @@
 //===----------------------------------------------------------------------===//
 
 #include "SYCLDeviceRequirements.h"
-#include "ModuleSplitter.h"
 
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/IR/Module.h"
+#include "llvm/SYCLLowerIR/ModuleSplitter.h"
 #include "llvm/Support/PropertySetIO.h"
 
 #include <set>

llvm/tools/sycl-post-link/sycl-post-link.cpp

@@ -13,7 +13,6 @@
 // - specialization constant intrinsic transformation
 //===----------------------------------------------------------------------===//
 
-#include "ModuleSplitter.h"
 #include "SYCLDeviceLibReqMask.h"
 #include "SYCLDeviceRequirements.h"
 #include "SYCLKernelParamOptInfo.h"
@@ -40,6 +39,7 @@
 #include "llvm/SYCLLowerIR/ESIMD/LowerESIMD.h"
 #include "llvm/SYCLLowerIR/HostPipes.h"
 #include "llvm/SYCLLowerIR/LowerInvokeSimd.h"
+#include "llvm/SYCLLowerIR/ModuleSplitter.h"
 #include "llvm/SYCLLowerIR/SYCLUtils.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/FileSystem.h"
@@ -1009,8 +1009,11 @@ processInputModule(std::unique_ptr<Module> M) {
  Modified |= SplitOccurred;
 
  // FIXME: this check is not performed for ESIMD splits
- if (DeviceGlobals)
- Splitter->verifyNoCrossModuleDeviceGlobalUsage();
+ if (DeviceGlobals) {
+ auto E = Splitter->verifyNoCrossModuleDeviceGlobalUsage();
+ if (E)
+ error(toString(std::move(E)));
+ }
 
  // It is important that we *DO NOT* preserve all the splits in memory at the
  // same time, because it leads to a huge RAM consumption by the tool on bigger