Renamed the tool to be called clang-sycl-linker

asudarsa · asudarsa · commit 679436acf28a · 2024-10-14T19:00:16.000-07:00
Signed-off-by: Arvind Sudarsanam &lt;arvind.sudarsanam@intel.com&gt;
diff --git a/clang/docs/ClangSYCLLinker.rst b/clang/docs/ClangSYCLLinker.rst
@@ -1,24 +1,24 @@
 =======================
-Clang SYCL Link Wrapper
+Clang SYCL Linker
 =======================
 
 .. contents::
    :local:
 
-.. _clang-sycl-link-wrapper:
+.. _clang-sycl-linker:
 
 Introduction
 ============
 
 This tool works as a wrapper around the SYCL device code linking process.
-The purpose of this wrapper is to provide an interface to link SYCL device
-bitcode in LLVM IR format, SYCL device bitcode in SPIR-V IR format, and native
-binary objects, and then use the SPIR-V LLVM Translator tool on fully linked
-device objects to produce the final output.
+The purpose of this tool is to provide an interface to link SYCL device bitcode
+in LLVM IR format, SYCL device bitcode in SPIR-V IR format, and native binary
+objects, and then use the SPIR-V LLVM Translator tool on fully linked device
+objects to produce the final output.
 After the linking stage, the fully linked device code in LLVM IR format may
 undergo several SYCL-specific finalization steps before the SPIR-V code
 generation step.
-The wrapper will also support the Ahead-Of-Time (AOT) compilation flow. AOT
+The tool will also support the Ahead-Of-Time (AOT) compilation flow. AOT
 compilation is the process of invoking the back-end at compile time to produce
 the final binary, as opposed to just-in-time (JIT) compilation when final code
 generation is deferred until application runtime.
@@ -47,7 +47,7 @@ be passed down to downstream tools like 'llvm-link', 'llvm-spirv', etc.
   This enables linking and code generation for SPIR-V JIT targets and AOT
   targets.
 
-  USAGE: clang-sycl-link-wrapper [options]
+  USAGE: clang-sycl-linker [options]
 
   OPTIONS:
     --arch <value>                Specify the name of the target architecture.
@@ -77,4 +77,4 @@ generate the final executable.
 
 .. code-block:: console
 
-  clang-sycl-link-wrapper --triple spirv64 --arch native input.bc
+  clang-sycl-linker --triple spirv64 --arch native input.bc
diff --git a/clang/include/clang/Driver/Options.td b/clang/include/clang/Driver/Options.td
@@ -6730,7 +6730,7 @@ def fno_sycl : Flag<["-"], "fno-sycl">,
   Group<sycl_Group>, HelpText<"Disables SYCL kernels compilation for device">;
 def sycl_link : Flag<["--"], "sycl-link">, Flags<[HelpHidden]>,
   Visibility<[ClangOption, CLOption]>,
-  Group<sycl_Group>, HelpText<"Perform link through clang-sycl-link-wrapper via the target "
+  Group<sycl_Group>, HelpText<"Perform link through clang-sycl-linker via the target "
   "offloading toolchain.">;
 // OS-specific options
 let Flags = [TargetSpecific] in {
diff --git a/clang/lib/Driver/ToolChains/SPIRV.cpp b/clang/lib/Driver/ToolChains/SPIRV.cpp
@@ -95,10 +95,10 @@ void SPIRV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
   CmdArgs.push_back("-o");
   CmdArgs.push_back(Output.getFilename());
 
-  // Use of --sycl-link will call the clang-sycl-link-wrapper instead of
+  // Use of --sycl-link will call the clang-sycl-linker instead of
   // the default linker (spirv-link).
   if (Args.hasArg(options::OPT_sycl_link))
-    Linker = ToolChain.GetProgramPath("clang-sycl-link-wrapper");
+    Linker = ToolChain.GetProgramPath("clang-sycl-linker");
   C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
                                          Args.MakeArgString(Linker), CmdArgs,
                                          Inputs, Output));
diff --git a/clang/test/Driver/clang-sycl-linker-test.cpp b/clang/test/Driver/clang-sycl-linker-test.cpp
@@ -1,8 +1,8 @@
-// Tests the clang-sycl-link-wrapper tool
+// Tests the clang-sycl-linker tool
 //
 // Test a simple case without arguments
 // RUN: %clangxx -fsycl -emit-llvm -c %s -o %t.bc
-// RUN: clang-sycl-link-wrapper --dry-run -triple spirv64 %t.bc --library-path=%S/Inputs -o a.spv 2>&1 \
+// RUN: clang-sycl-linker --dry-run -triple spirv64 %t.bc --library-path=%S/Inputs -o a.spv 2>&1 \
 // RUN:   | FileCheck %s --check-prefix=CMDS
 // CMDS: "{{.*}}llvm-link{{.*}}" {{.*}}.bc -o [[FIRSTLLVMLINKOUT:.*]].bc --suppress-warnings
 // CMDS-NEXT: "{{.*}}llvm-link{{.*}}" -only-needed [[FIRSTLLVMLINKOUT]].bc {{.*}}libsycl-crt.bc {{.*}}libsycl-complex.bc -o [[SECONDLLVMLINKOUT:.*]].bc --suppress-warnings
diff --git a/clang/test/Driver/sycl-link-spirv-target.cpp b/clang/test/Driver/sycl-link-spirv-target.cpp
@@ -4,4 +4,4 @@
 // RUN: touch %t.bc
 // RUN: %clangxx --target=spirv64 --sycl-link -### %t.bc 2>&1 \
 // RUN:   | FileCheck %s -check-prefix=LINK
-// LINK: "{{.*}}clang-sycl-link-wrapper{{.*}}" "{{.*}}.bc" "-o" "a.out"
+// LINK: "{{.*}}clang-sycl-linker{{.*}}" "{{.*}}.bc" "-o" "a.out"
diff --git a/clang/test/lit.cfg.py b/clang/test/lit.cfg.py
@@ -96,6 +96,7 @@
     "yaml2obj",
     "clang-linker-wrapper",
     "clang-nvlink-wrapper",
+    "clang-sycl-linker",
     "llvm-lto",
     "llvm-lto2",
     "llvm-profdata",
diff --git a/clang/tools/CMakeLists.txt b/clang/tools/CMakeLists.txt
@@ -12,7 +12,7 @@ add_clang_subdirectory(clang-nvlink-wrapper)
 add_clang_subdirectory(clang-offload-packager)
 add_clang_subdirectory(clang-offload-bundler)
 add_clang_subdirectory(clang-scan-deps)
-add_clang_subdirectory(clang-sycl-link-wrapper)
+add_clang_subdirectory(clang-sycl-linker)
 add_clang_subdirectory(clang-installapi)
 if(HAVE_CLANG_REPL_SUPPORT)
   add_clang_subdirectory(clang-repl)
diff --git a/clang/tools/clang-sycl-link-wrapper/CMakeLists.txt b/clang/tools/clang-sycl-link-wrapper/CMakeLists.txt
diff --git a/clang/tools/clang-sycl-linker/CMakeLists.txt b/clang/tools/clang-sycl-linker/CMakeLists.txt
@@ -0,0 +1,28 @@
+set(LLVM_LINK_COMPONENTS
+  ${LLVM_TARGETS_TO_BUILD}
+  Option
+  )
+
+set(LLVM_TARGET_DEFINITIONS SYCLLinkOpts.td)
+tablegen(LLVM SYCLLinkOpts.inc -gen-opt-parser-defs)
+add_public_tablegen_target(SYCLLinkerOpts)
+
+if(NOT CLANG_BUILT_STANDALONE)
+  set(tablegen_deps intrinsics_gen SYCLLinkerOpts)
+endif()
+
+add_clang_tool(clang-sycl-linker
+  ClangSYCLLinker.cpp
+
+  DEPENDS
+  ${tablegen_deps}
+  )
+
+set(CLANG_SYCL_LINKER_LIB_DEPS
+  clangBasic
+  )
+
+target_link_libraries(clang-sycl-linker
+  PRIVATE
+  ${CLANG_SYCL_LINKER_LIB_DEPS}
+  )
diff --git a/clang/tools/clang-sycl-linker/ClangSYCLLinker.cpp b/clang/tools/clang-sycl-linker/ClangSYCLLinker.cpp
@@ -1,19 +1,17 @@
-//=-- clang-sycl-link-wrapper/ClangSYCLLinkWrapper.cpp - SYCL linker util --=//
+//=-------- clang-sycl-linker/ClangSYCLLinker.cpp - SYCL Linker util -------=//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===---------------------------------------------------------------------===//
 //
-// This tool wraps around the sequence of steps required to link device code in
-// SYCL fat objects. SYCL device code linking requires a complex sequence of
-// steps that include linking of llvm bitcode files, linking device library
-// files with the fully linked source bitcode file(s), running several SYCL
-// specific post-link steps on the fully linked bitcode file(s), and finally
-// generating target-specific device code. This tool can be removed once SYCL
-// linking is ported to `ld.lld`.
-//
+// This tool executes a sequence of steps required to link device code in SYCL
+// fat objects. SYCL device code linking requires a complex sequence of steps
+// that include linking of llvm bitcode files, linking device library files
+// with the fully linked source bitcode file(s), running several SYCL specific
+// post-link steps on the fully linked bitcode file(s), and finally generating
+// target-specific device code.
 //===---------------------------------------------------------------------===//
 
 #include "clang/Basic/Version.h"
@@ -69,7 +67,7 @@ static StringRef OutputFile;
 static SmallString<128> SPIRVDumpDir;
 
 static void printVersion(raw_ostream &OS) {
-  OS << clang::getClangToolFullVersion("clang-sycl-link-wrapper") << '\n';
+  OS << clang::getClangToolFullVersion("clang-sycl-linker") << '\n';
 }
 
 /// The value of `argv[0]` when run.
@@ -213,9 +211,8 @@ Expected<SmallVector<std::string>> getInput(const ArgList &Args) {
 /// Link all SYCL device input files into one before adding device library
 /// files. Device linking is performed using llvm-link tool.
 /// 'InputFiles' is the list of all LLVM IR device input files.
-/// 'Args' encompasses all arguments required for linking and wrapping device
-/// code and will be parsed to generate options required to be passed into the
-/// llvm-link tool.
+/// 'Args' encompasses all arguments required for linking device code and will
+/// be parsed to generate options required to be passed into llvm-link.
 Expected<StringRef> linkDeviceInputFiles(ArrayRef<std::string> InputFiles,
                                          const ArgList &Args) {
   llvm::TimeTraceScope TimeScope("SYCL LinkDeviceInputFiles");
@@ -285,9 +282,8 @@ Expected<SmallVector<std::string>> getSYCLDeviceLibFiles(const ArgList &Args) {
 /// Link all device library files and input file into one LLVM IR file. This
 /// linking is performed using llvm-link tool.
 /// 'InputFiles' is the list of all LLVM IR device input files.
-/// 'Args' encompasses all arguments required for linking and wrapping device
-/// code and will be parsed to generate options required to be passed into the
-/// llvm-link tool.
+/// 'Args' encompasses all arguments required for linking device code and will
+/// be parsed to generate options required to be passed into llvm-link tool.
 static Expected<StringRef> linkDeviceLibFiles(StringRef InputFile,
                                               const ArgList &Args) {
   llvm::TimeTraceScope TimeScope("LinkDeviceLibraryFiles");
@@ -391,9 +387,8 @@ static void getSPIRVTransOpts(const ArgList &Args,
 
 /// Run LLVM to SPIR-V translation.
 /// Converts 'File' from LLVM bitcode to SPIR-V format using llvm-spirv tool.
-/// 'Args' encompasses all arguments required for linking and wrapping device
-/// code and will be parsed to generate options required to be passed into the
-/// llvm-spirv tool.
+/// 'Args' encompasses all arguments required for linking device code and will
+/// be parsed to generate options required to be passed into llvm-spirv tool.
 static Expected<StringRef> runLLVMToSPIRVTranslation(StringRef File,
                                                      const ArgList &Args) {
   llvm::TimeTraceScope TimeScope("LLVMToSPIRVTranslation");
@@ -478,7 +473,7 @@ int main(int argc, char **argv) {
   if (Args.hasArg(OPT_help) || Args.hasArg(OPT_help_hidden)) {
     Tbl.printHelp(
         outs(),
-        "clang-sycl-link-wrapper [options] <options to sycl link steps>",
+        "clang-sycl-linker [options] <options to sycl link steps>",
         "A utility that wraps around several steps required to link SYCL "
         "device files.\n"
         "This enables LLVM IR linking, post-linking and code generation for "
diff --git a/clang/tools/clang-sycl-linker/SYCLLinkOpts.td b/clang/tools/clang-sycl-linker/SYCLLinkOpts.td
