[clang] [Driver] Update SYCL runtime library name and path for target-specific directories. (PR #192326)
via cfe-commits
cfe-commits at lists.llvm.org
Wed Apr 15 13:52:58 PDT 2026
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-clang
Author: Srividya Sundaram (srividya-sundaram)
<details>
<summary>Changes</summary>
This patch updates the Clang driver to support the renamed SYCL runtime
library (libsycl.so → libLLVMSYCL.so) and its new location in
target-specific directories.
Also, adds support for LLVM_ENABLE_PER_TARGET_RUNTIME_DIR=OFF builds where libLLVMSYCL.so is installed in lib/ rather than lib/<triple>/
---
Full diff: https://github.com/llvm/llvm-project/pull/192326.diff
6 Files Affected:
- (modified) clang/include/clang/Driver/SyclInstallationDetector.h (+2-2)
- (modified) clang/lib/Driver/ToolChains/Linux.cpp (+2-1)
- (modified) clang/lib/Driver/ToolChains/SYCL.cpp (+19-4)
- (renamed) clang/test/Driver/Inputs/SYCL/libLLVMSYCL.ll ()
- (modified) clang/test/Driver/link-device-code.test (+2-2)
- (modified) clang/test/Driver/sycl-offload-jit.cpp (+24-3)
``````````diff
diff --git a/clang/include/clang/Driver/SyclInstallationDetector.h b/clang/include/clang/Driver/SyclInstallationDetector.h
index f92228817f045..8763c7047a49b 100644
--- a/clang/include/clang/Driver/SyclInstallationDetector.h
+++ b/clang/include/clang/Driver/SyclInstallationDetector.h
@@ -22,8 +22,8 @@ class SYCLInstallationDetector {
void addSYCLIncludeArgs(const llvm::opt::ArgList &DriverArgs,
llvm::opt::ArgStringList &CC1Args) const;
- // Return the filesystem path to the SYCL runtime library (libsycl.so), that
- // was detected.
+ // Return the filesystem path to the SYCL runtime library,
+ // that was detected.
StringRef getSYCLRTLibPath() const { return SYCLRTLibPath; }
private:
diff --git a/clang/lib/Driver/ToolChains/Linux.cpp b/clang/lib/Driver/ToolChains/Linux.cpp
index a5277dcac1747..62746e9048cee 100644
--- a/clang/lib/Driver/ToolChains/Linux.cpp
+++ b/clang/lib/Driver/ToolChains/Linux.cpp
@@ -864,7 +864,8 @@ void Linux::addOffloadRTLibs(unsigned ActiveKinds, const ArgList &Args,
if (ActiveKinds & Action::OFK_HIP)
Libraries.emplace_back(RocmInstallation->getLibPath(), "libamdhip64.so");
else if (ActiveKinds & Action::OFK_SYCL)
- Libraries.emplace_back(SYCLInstallation->getSYCLRTLibPath(), "libsycl.so");
+ Libraries.emplace_back(SYCLInstallation->getSYCLRTLibPath(),
+ "libLLVMSYCL.so");
for (auto [Path, Library] : Libraries) {
if (Args.hasFlag(options::OPT_frtlib_add_rpath,
diff --git a/clang/lib/Driver/ToolChains/SYCL.cpp b/clang/lib/Driver/ToolChains/SYCL.cpp
index 033fd98183737..d4d12356263b6 100644
--- a/clang/lib/Driver/ToolChains/SYCL.cpp
+++ b/clang/lib/Driver/ToolChains/SYCL.cpp
@@ -19,15 +19,30 @@ SYCLInstallationDetector::SYCLInstallationDetector(
const Driver &D, const llvm::Triple &HostTriple,
const llvm::opt::ArgList &Args)
: D(D) {
- // Detect the presence of the SYCL runtime library (libsycl.so) in the
+ // Detect the presence of the SYCL runtime library in the
// filesystem. This is used to determine whether a usable SYCL installation
// is available for the current driver invocation.
StringRef SysRoot = D.SysRoot;
SmallString<128> DriverDir(D.Dir);
+ SmallString<128> LibPath(DriverDir);
+ llvm::sys::path::append(LibPath, "..", "lib", HostTriple.str(),
+ "libLLVMSYCL.so");
+ // Flat lib path for LLVM_ENABLE_PER_TARGET_RUNTIME_DIR=OFF builds,
+ // where the library is installed directly in lib/ with no triple subdir.
+ SmallString<128> FlatLibPath(DriverDir);
+ llvm::sys::path::append(FlatLibPath, "..", "lib", "libLLVMSYCL.so");
+
if (DriverDir.starts_with(SysRoot) &&
- (Args.hasArg(options::OPT_fsycl) ||
- D.getVFS().exists(DriverDir + "/../lib/libsycl.so"))) {
- llvm::sys::path::append(DriverDir, "..", "lib");
+ Args.hasFlag(options::OPT_fsycl, options::OPT_fno_sycl, false)) {
+ if (D.getVFS().exists(LibPath))
+ // LLVM_ENABLE_PER_TARGET_RUNTIME_DIR=ON: library is in lib/<triple>/
+ llvm::sys::path::append(DriverDir, "..", "lib", HostTriple.str());
+ else if (D.getVFS().exists(FlatLibPath))
+ // LLVM_ENABLE_PER_TARGET_RUNTIME_DIR=OFF: library is in lib/
+ llvm::sys::path::append(DriverDir, "..", "lib");
+ else
+ // Neither path exists — broken install, leave SYCLRTLibPath unset
+ return;
SYCLRTLibPath = DriverDir;
}
}
diff --git a/clang/test/Driver/Inputs/SYCL/libsycl.ll b/clang/test/Driver/Inputs/SYCL/libLLVMSYCL.ll
similarity index 100%
rename from clang/test/Driver/Inputs/SYCL/libsycl.ll
rename to clang/test/Driver/Inputs/SYCL/libLLVMSYCL.ll
diff --git a/clang/test/Driver/link-device-code.test b/clang/test/Driver/link-device-code.test
index 231f02b6560e0..eb75eaf1fe5c2 100644
--- a/clang/test/Driver/link-device-code.test
+++ b/clang/test/Driver/link-device-code.test
@@ -3,12 +3,12 @@
# RUN: llvm-as %S/Inputs/SYCL/foo.ll -o %t.foo.bc
# RUN: llvm-as %S/Inputs/SYCL/bar.ll -o %t.bar.bc
# RUN: llvm-as %S/Inputs/SYCL/baz.ll -o %t.baz.bc
-# RUN: llvm-as %S/Inputs/SYCL/libsycl.ll -o %t.libsycl.bc
+# RUN: llvm-as %S/Inputs/SYCL/libLLVMSYCL.ll -o %t.libLLVMSYCL.bc
# RUN: clang-sycl-linker %t.foo.bc %t.bar.bc -triple=spirv64 --dry-run -o a.spv --print-linked-module 2>&1 | FileCheck %s --check-prefix=CHECK-SIMPLE
# RUN: not clang-sycl-linker %t.bar.bc %t.baz.bc -triple=spirv64 --dry-run -o a.spv --print-linked-module 2>&1 | FileCheck %s --check-prefix=CHECK-MULTIPLE-DEFS
-# RUN: clang-sycl-linker %t.foo.bc %t.bar.bc -device-libs=%t.libsycl.bc -library-path= -triple=spirv64 --dry-run -o a.spv --print-linked-module 2>&1 | FileCheck %s --check-prefix=CHECK-DEVICE-LIB
+# RUN: clang-sycl-linker %t.foo.bc %t.bar.bc -device-libs=%t.libLLVMSYCL.bc -library-path= -triple=spirv64 --dry-run -o a.spv --print-linked-module 2>&1 | FileCheck %s --check-prefix=CHECK-DEVICE-LIB
; CHECK-SIMPLE: define {{.*}}foo_func1{{.*}}
; CHECK-SIMPLE: define {{.*}}foo_func2{{.*}}
diff --git a/clang/test/Driver/sycl-offload-jit.cpp b/clang/test/Driver/sycl-offload-jit.cpp
index 5bdb56d935a98..d221770bb3870 100644
--- a/clang/test/Driver/sycl-offload-jit.cpp
+++ b/clang/test/Driver/sycl-offload-jit.cpp
@@ -29,13 +29,34 @@
// CHK-DEVICE-TRIPLE-SAME: "-O2"
// CHK-DEVICE-TRIPLE: llvm-offload-binary{{.*}} "--image=file={{.*}}.bc,triple=spirv64-unknown-unknown,arch=generic,kind=sycl"
-// Check if path to libsycl.so is passed to clang-linker-wrapper tool by default for SYCL compilation.
+// Check if path to the SYCL RT is passed to clang-linker-wrapper for SYCL compilation.
// The test also checks if SYCL header include paths are added to the SYCL host and device compilation.
-// RUN: %clang -### --target=x86_64-unknown-linux-gnu -fsycl %s 2>&1 \
+// These tests require a fake install tree with a symlinked clang so that D.Dir points to a
+// controlled location, allowing us to place a dummy libLLVMSYCL.so where the driver expects it.
+// UNSUPPORTED: system-windows, system-cygwin
+
+// Check LLVM_ENABLE_PER_TARGET_RUNTIME_DIR=ON case: library is in lib/<triple>/
+// RUN: rm -rf %t && mkdir -p %t/bin %t/lib/x86_64-unknown-linux-gnu
+// RUN: touch %t/lib/x86_64-unknown-linux-gnu/libLLVMSYCL.so
+// RUN: ln -s %clang %t/bin/clang
+// RUN: %t/bin/clang -### -no-canonical-prefixes --target=x86_64-unknown-linux-gnu -fsycl %s 2>&1 \
// RUN: | FileCheck -check-prefixes=CHECK-LSYCL,CHECK-SYCL-HEADERS-HOST,CHECK-SYCL-HEADERS-DEVICE %s
// CHECK-SYCL-HEADERS-DEVICE: "-fsycl-is-device"{{.*}} "-internal-isystem" "{{.*}}bin{{[/\\]+}}..{{[/\\]+}}include"
// CHECK-SYCL-HEADERS-HOST: "-fsycl-is-host"{{.*}} "-internal-isystem" "{{.*}}bin{{[/\\]+}}..{{[/\\]+}}include"
-// CHECK-LSYCL: clang-linker-wrapper{{.*}} "{{.*}}bin{{[/\\]+}}..{{[/\\]+}}lib{{[/\\]+}}libsycl.so"
+// CHECK-LSYCL: clang-linker-wrapper{{.*}} "{{.*}}bin{{[/\\]+}}..{{[/\\]+}}lib{{[/\\]+}}x86_64-unknown-linux-gnu{{[/\\]+}}libLLVMSYCL.so"
+
+// Check LLVM_ENABLE_PER_TARGET_RUNTIME_DIR=OFF case: library is in lib/ (no triple subdir)
+// RUN: rm -rf %t && mkdir -p %t/bin %t/lib
+// RUN: touch %t/lib/libLLVMSYCL.so
+// RUN: ln -s %clang %t/bin/clang
+// RUN: %t/bin/clang -### -no-canonical-prefixes --target=x86_64-unknown-linux-gnu -fsycl %s 2>&1 \
+// RUN: | FileCheck -check-prefix=CHECK-LSYCL-FLAT %s
+// CHECK-LSYCL-FLAT: clang-linker-wrapper{{.*}} "{{.*}}bin{{[/\\]+}}..{{[/\\]+}}lib{{[/\\]+}}libLLVMSYCL.so"
+
+// Check that -fsycl -fno-sycl does not pass libLLVMSYCL.so to the linker.
+// RUN: %clang -### --target=x86_64-unknown-linux-gnu -fsycl -fno-sycl %s 2>&1 \
+// RUN: | FileCheck -check-prefix=CHECK-NO-SYCL-RT %s
+// CHECK-NO-SYCL-RT-NOT: libLLVMSYCL.so
/// Check -fsycl-is-device is passed when compiling for the device.
/// Check -fsycl-is-host is passed when compiling for host.
``````````
</details>
https://github.com/llvm/llvm-project/pull/192326
More information about the cfe-commits
mailing list