Skip to content

[SYCL][Driver] Update -fsycl-dump-device-code option name. #18908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 18, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions clang/include/clang/Driver/Driver.h
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ class Driver {

IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS;

bool DumpDeviceCode;
bool SaveOffloadCode;

enum DriverMode {
GCCMode,
Expand Down Expand Up @@ -453,7 +453,7 @@ class Driver {
return ClangExecutable.c_str();
}

bool isDumpDeviceCodeEnabled() const { return DumpDeviceCode; }
bool isSaveOffloadCodeEnabled() const { return SaveOffloadCode; }

bool isSaveTempsEnabled() const { return SaveTemps != SaveTempsNone; }
bool isSaveTempsObj() const { return SaveTemps == SaveTempsObj; }
Expand Down
11 changes: 9 additions & 2 deletions clang/include/clang/Driver/Options.td
Original file line number Diff line number Diff line change
Expand Up @@ -7348,9 +7348,14 @@ defm sycl_allow_device_image_dependencies: BoolOptionWithoutMarshalling<"f", "sy
PosFlag<SetTrue, [], [ClangOption], "Allow dependencies between device code images">,
NegFlag<SetFalse, [], [ClangOption], "Do not allow dependencies between device code images (default)">>;

def fsycl_dump_device_code_EQ : Joined<["-"], "fsycl-dump-device-code=">,
def save_offload_code_EQ : Joined<["-"], "save-offload-code=">,
Flags<[NoXarchOption]>,
HelpText<"Dump device code into the user provided directory.">;
Visibility<[ClangOption]>,
HelpText<"Save offload code generated during compilation into the user provided directory.">;
def fsycl_dump_device_code_EQ : Joined<["-"], "fsycl-dump-device-code=">,
Alias<save_offload_code_EQ>,
Flags<[NoXarchOption, Deprecated]>,
HelpText<"Dump device code into the user provided directory. (deprecated)">;
def fsyclbin_EQ : Joined<["-"], "fsyclbin=">, Values<"executable,object,input">,
HelpText<"Output in the SYCLBIN binary format in the state specified by <arg> (input, object or executable (default))">;
def fsyclbin : Flag<["-"], "fsyclbin">, Alias<fsyclbin_EQ>,
Expand Down Expand Up @@ -9586,6 +9591,8 @@ def : Separate<["-"], "Xmicrosoft-windows-sdk-version">,
Alias<_SLASH_winsdkversion>;
def : Separate<["-"], "Xmicrosoft-windows-sys-root">,
Alias<_SLASH_winsysroot>;
def _SLASH_Qsave_offload_code : CLJoined<"Qsave-offload-code=">, Alias<save_offload_code_EQ>,
HelpText<"Save offload code generated during compilation into the user provided directory.">;

// Ignored:

Expand Down
10 changes: 5 additions & 5 deletions clang/lib/Driver/Compilation.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -182,12 +182,12 @@ bool Compilation::CleanupFile(const char *File, bool IssueErrors) const {
// able to remove), or non-regular files. Underlying tools may have
// intentionally not overwritten them.

// Save the device code files if -fsycl-dump-device-code option is enabled.
if (TheDriver.isDumpDeviceCodeEnabled()) {
Arg *DumpDeviceCodeArg =
getArgs().getLastArg(options::OPT_fsycl_dump_device_code_EQ);
// Save the device code files if -save-offload-code option is enabled.
if (TheDriver.isSaveOffloadCodeEnabled()) {
Arg *SaveOffloadCodeArg =
getArgs().getLastArg(options::OPT_save_offload_code_EQ);
std::string ExpectedDir =
DumpDeviceCodeArg ? DumpDeviceCodeArg->getValue() : "";
SaveOffloadCodeArg ? SaveOffloadCodeArg->getValue() : "";
std::string ActualFile(File);

if (ActualFile.find(ExpectedDir) != std::string::npos) {
Expand Down
6 changes: 3 additions & 3 deletions clang/lib/Driver/Driver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ std::string CUIDOptions::getCUID(StringRef InputFile,
Driver::Driver(StringRef ClangExecutable, StringRef TargetTriple,
DiagnosticsEngine &Diags, std::string Title,
IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)
: Diags(Diags), VFS(std::move(VFS)), DumpDeviceCode(false), Mode(GCCMode),
: Diags(Diags), VFS(std::move(VFS)), SaveOffloadCode(false), Mode(GCCMode),
SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
Offload(OffloadHostDevice), CXX20HeaderType(HeaderMode_None),
ModulesModeCXX20(false), LTOMode(LTOK_None), OffloadLTOMode(LTOK_None),
Expand Down Expand Up @@ -2099,8 +2099,8 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
.Default(SaveTempsCwd);
}

if (Args.getLastArg(options::OPT_fsycl_dump_device_code_EQ))
DumpDeviceCode = true;
if (Args.getLastArg(options::OPT_save_offload_code_EQ))
SaveOffloadCode = true;

if (const Arg *A = Args.getLastArg(
options::OPT_offload_host_only, options::OPT_offload_device_only,
Expand Down
16 changes: 8 additions & 8 deletions clang/lib/Driver/ToolChains/Clang.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -10755,15 +10755,15 @@ void SPIRVTranslator::ConstructJob(Compilation &C, const JobAction &JA,
TCArgs.MakeArgString("--out-file-list=" + OutputFileName));
ForeachArgs.push_back(
TCArgs.MakeArgString("--out-replace=" + OutputFileName));
// If fsycl-dump-device-code is passed, put the output files from llvm-spirv
// into the path provided in fsycl-dump-device-code.
if (C.getDriver().isDumpDeviceCodeEnabled()) {
// If save-offload-code is passed, put the output files from llvm-spirv
// into the path provided in save-offload-code.
if (C.getDriver().isSaveOffloadCodeEnabled()) {
SmallString<128> OutputDir;

Arg *DumpDeviceCodeArg =
C.getArgs().getLastArg(options::OPT_fsycl_dump_device_code_EQ);
Arg *SaveOffloadCodeArg =
C.getArgs().getLastArg(options::OPT_save_offload_code_EQ);

OutputDir = (DumpDeviceCodeArg ? DumpDeviceCodeArg->getValue() : "");
OutputDir = (SaveOffloadCodeArg ? SaveOffloadCodeArg->getValue() : "");

// If the output directory path is empty, put the llvm-spirv output in the
// current directory.
Expand Down Expand Up @@ -11417,9 +11417,9 @@ void LinkerWrapper::ConstructJob(Compilation &C, const JobAction &JA,
CmdArgs.push_back(Args.MakeArgString(
Twine("-sycl-device-library-location=") + DeviceLibDir));

if (C.getDriver().isDumpDeviceCodeEnabled()) {
if (C.getDriver().isSaveOffloadCodeEnabled()) {
SmallString<128> DumpDir;
Arg *A = C.getArgs().getLastArg(options::OPT_fsycl_dump_device_code_EQ);
Arg *A = C.getArgs().getLastArg(options::OPT_save_offload_code_EQ);
DumpDir = A ? A->getValue() : "";
CmdArgs.push_back(
Args.MakeArgString(Twine("-sycl-dump-device-code=") + DumpDir));
Expand Down
12 changes: 6 additions & 6 deletions clang/lib/Driver/ToolChains/SYCL.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -248,16 +248,16 @@ void SYCL::constructLLVMForeachCommand(Compilation &C, const JobAction &JA,
C.getArgs().MakeArgString("--out-dir=" + OutputDirName));
}

// If fsycl-dump-device-code is passed, put the PTX files
// into the path provided in fsycl-dump-device-code.
// If save-offload-code is passed, put the PTX files
// into the path provided in save-offload-code.
if (T->getToolChain().getTriple().isNVPTX() &&
C.getDriver().isDumpDeviceCodeEnabled() && Ext == "s") {
C.getDriver().isSaveOffloadCodeEnabled() && Ext == "s") {
SmallString<128> OutputDir;

Arg *DumpDeviceCodeArg =
C.getArgs().getLastArg(options::OPT_fsycl_dump_device_code_EQ);
Arg *SaveOffloadCodeArg =
C.getArgs().getLastArg(options::OPT_save_offload_code_EQ);

OutputDir = (DumpDeviceCodeArg ? DumpDeviceCodeArg->getValue() : "");
OutputDir = (SaveOffloadCodeArg ? SaveOffloadCodeArg->getValue() : "");

// If the output directory path is empty, put the PTX files in the
// current directory.
Expand Down
18 changes: 9 additions & 9 deletions clang/test/Driver/save-ptx-files.cpp
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
// Save PTX files during PTX target processing using -fsycl-dump-device-code option.
// Save PTX files during PTX target processing using -save-offload-code option.

// Verify that -fsycl-dump-device-code saves PTX files in the user provided directory
// Verify that -save-offload-code saves PTX files in the user provided directory
// while targeting CUDA enabled GPUs.

// Linux
// RUN: %clang -### -fsycl -fsycl-targets=nvptx64-nvidia-cuda,spir64-unknown-unknown -target x86_64-unknown-linux-gnu --cuda-path=%S/Inputs/CUDA/usr/local/cuda -fsycl-dump-device-code=/user/input/path %s 2>&1 \
// RUN: %clang -### -fsycl -fsycl-targets=nvptx64-nvidia-cuda,spir64-unknown-unknown -target x86_64-unknown-linux-gnu --cuda-path=%S/Inputs/CUDA/usr/local/cuda -save-offload-code=/user/input/path %s 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHECK-PTX-FILES,CHECK-SPIRV-FILES

// clang --driver-mode=g++
// RUN: %clangxx -### -fsycl -fsycl-targets=nvptx64-nvidia-cuda -target x86_64-unknown-linux-gnu --cuda-path=%S/Inputs/CUDA/usr/local/cuda -fsycl-dump-device-code=/user/input/path %s 2>&1 \
// RUN: %clangxx -### -fsycl -fsycl-targets=nvptx64-nvidia-cuda -target x86_64-unknown-linux-gnu --cuda-path=%S/Inputs/CUDA/usr/local/cuda -save-offload-code=/user/input/path %s 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHECK-PTX-FILES

// RUN: %clang -### -fsycl -fsycl-targets=nvptx64-nvidia-cuda,spir64-unknown-unknown -target x86_64-unknown-linux-gnu --cuda-path=%S/Inputs/CUDA/usr/local/cuda -fsycl-dump-device-code= %s 2>&1 \
// RUN: %clang -### -fsycl -fsycl-targets=nvptx64-nvidia-cuda,spir64-unknown-unknown -target x86_64-unknown-linux-gnu --cuda-path=%S/Inputs/CUDA/usr/local/cuda -save-offload-code= %s 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHECK-PTX-FILES-CWD,CHECK-SPIRV-FILES-CWD

// CHECK-PTX-FILES: llvm-foreach{{.*}} "--out-ext=s"{{.*}} "--out-dir=/user/input/path{{(/|\\\\)}}" "--" "{{.*}}clang{{.*}}" {{.*}} "-fsycl-is-device" {{.*}}.s{{.*}}
Expand All @@ -22,20 +22,20 @@
// Windows - Check if PTX files are saved in the user provided path.
// RUN: %clang_cl -### -fsycl \
// RUN: -fsycl-targets=nvptx64-nvidia-cuda --cuda-path=%S/Inputs/CUDA/usr/local/cuda \
// RUN: -fsycl-dump-device-code=/user/input/path %s 2>&1 \
// RUN: -Qsave-offload-code=/user/input/path %s 2>&1 \
// RUN: | FileCheck -check-prefix=CHECK-PTX-WIN %s

// Windows - Check if PTX and SPV files are saved in user provided path.
// RUN: %clang_cl -### -fsycl \
// RUN: -fsycl-targets=nvptx64-nvidia-cuda,spir64-unknown-unknown --cuda-path=%S/Inputs/CUDA/usr/local/cuda \
// RUN: -fsycl-dump-device-code=/user/input/path %s 2>&1 \
// RUN: -Qsave-offload-code=/user/input/path %s 2>&1 \
// RUN: | FileCheck -check-prefixes=CHECK-PTX-WIN,CHECK-SPV-WIN %s

// Windows - Check PTX files saved in current working directory when -fsycl-dump-device-code
// Windows - Check PTX files saved in current working directory when -save-offload-code
// is empty.
// RUN: %clang_cl -### -fsycl \
// RUN: -fsycl-targets=nvptx64-nvidia-cuda --cuda-path=%S/Inputs/CUDA/usr/local/cuda \
// RUN: -fsycl-dump-device-code= %s 2>&1 \
// RUN: -Qsave-offload-code= %s 2>&1 \
// RUN: | FileCheck -check-prefix=CHECK-PTX-WIN-CWD %s

// CHECK-PTX-WIN: llvm-foreach{{.*}} "--out-ext=s"{{.*}} "--out-dir=/user/input/path{{(/|\\\\)}}" "--" "{{.*}}clang{{.*}}" {{.*}} "-fsycl-is-device" {{.*}}.asm{{.*}}
Expand Down
1 change: 1 addition & 0 deletions clang/test/Driver/sycl-deprecated.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@
// RUN: %clangxx -fsycl -fno-sycl-use-bitcode %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefix=CHECK_REPLACE -DOPTION=-fno-sycl-use-bitcode -DOPTION_REPLACE=-fsycl-device-obj=spirv
// RUN: %clangxx -fsycl -fsycl-fp32-prec-sqrt %s -### 2>&1 | FileCheck %s --check-prefix=CHECK_REPLACE -DOPTION=-fsycl-fp32-prec-sqrt -DOPTION_REPLACE=-foffload-fp32-prec-sqrt
// RUN: %clangxx -fsycl -fsycl-dump-device-code=/path/to/spv/ %s -### 2>&1 | FileCheck %s --check-prefix=CHECK_REPLACE -DOPTION=-fsycl-dump-device-code=/path/to/spv/ -DOPTION_REPLACE=-save-offload-code=/path/to/spv/
// CHECK_REPLACE: option '[[OPTION]]' is deprecated and will be removed in a future release, use '[[OPTION_REPLACE]]' instead
35 changes: 0 additions & 35 deletions clang/test/Driver/sycl-dump-device-code-old-model.cpp

This file was deleted.

34 changes: 0 additions & 34 deletions clang/test/Driver/sycl-dump-device-code.cpp

This file was deleted.

35 changes: 35 additions & 0 deletions clang/test/Driver/sycl-save-offload-code-old-model.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// SYCL offloading tests using -save-offload-code

// Verify that -save-offload-code puts the device code (.spv files)
// in the user provided directory.

// Linux
// clang -fsycl --no-offload-new-driver -target x86_64-unknown-linux-gnu
// RUN: %clang -fsycl --no-offload-new-driver -fno-sycl-instrument-device-code -fno-sycl-device-lib=all -target x86_64-unknown-linux-gnu -save-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code

// clang -fsycl --no-offload-new-driver -fsycl-targets=spir64-unknown-unknown
// RUN: %clang -fsycl --no-offload-new-driver -fsycl-targets=spir64-unknown-unknown -target x86_64-unknown-linux-gnu -save-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code

// clang --driver-mode=g++
// RUN: %clangxx -fsycl --no-offload-new-driver -fsycl-targets=spir64-unknown-unknown -target x86_64-unknown-linux-gnu -save-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code

// Windows
// RUN: %clang_cl -fsycl --no-offload-new-driver -Qsave-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-WIN

// CHK-save-offload-code: llvm-foreach{{.*}} "--out-dir=/user/input/path{{(/|\\\\)}}" "--" "{{.*}}llvm-spirv"
// CHK-save-offload-code-WIN: llvm-foreach{{.*}} "--out-dir=/user/input/path{{(/|\\\\)}}" "--" "{{.*}}llvm-spirv"

// Linux
// RUN: %clang -fsycl --no-offload-new-driver -fsycl-targets=spir64-unknown-unknown -target x86_64-unknown-linux-gnu -save-offload-code= %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-CWD

// Windows
// RUN: %clang_cl -fsycl --no-offload-new-driver -Qsave-offload-code= %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-WIN-CWD

// CHK-save-offload-code-CWD: llvm-foreach{{.*}} "--out-dir=.{{(/|\\\\)}}" "--" "{{.*}}llvm-spirv"
// CHK-save-offload-code-WIN-CWD: llvm-foreach{{.*}} "--out-dir=.{{(/|\\\\)}}" "--" "{{.*}}llvm-spirv"
34 changes: 34 additions & 0 deletions clang/test/Driver/sycl-save-offload-code.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// SYCL offloading tests using -save-offload-code

// Verify that -save-offload-code passes the option to
// clang-linker-wrapper in the new offload model.

// clang -fsycl --offload-new-driver -target x86_64-unknown-linux-gnu
// RUN: %clang -fsycl --offload-new-driver -fno-sycl-instrument-device-code -fno-sycl-device-lib=all -target x86_64-unknown-linux-gnu -save-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-NEW-OFFLOAD

// clang -fsycl --offload-new-driver -fsycl-targets=spir64-unknown-unknown
// RUN: %clang -fsycl --offload-new-driver -fsycl-targets=spir64-unknown-unknown -target x86_64-unknown-linux-gnu -save-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-NEW-OFFLOAD

// clang --driver-mode=g++
// RUN: %clangxx -fsycl --offload-new-driver -fsycl-targets=spir64-unknown-unknown -target x86_64-unknown-linux-gnu -save-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-NEW-OFFLOAD

// Windows
// RUN: %clang_cl -fsycl --offload-new-driver -Qsave-offload-code=/user/input/path %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-WIN-NEW-OFFLOAD

// CHK-save-offload-code-NEW-OFFLOAD: clang-linker-wrapper{{.*}} "-sycl-dump-device-code=/user/input/path"
// CHK-save-offload-code-WIN-NEW-OFFLOAD: clang-linker-wrapper{{.*}} "-sycl-dump-device-code=/user/input/path"

// Linux
// RUN: %clang -fsycl --offload-new-driver -fsycl-targets=spir64-unknown-unknown -target x86_64-unknown-linux-gnu -save-offload-code= %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-CWD-NEW-OFFLOAD

// Windows
// RUN: %clang_cl -fsycl --offload-new-driver -Qsave-offload-code= %s -### 2>&1 \
// RUN: | FileCheck %s --check-prefixes=CHK-save-offload-code-WIN-CWD-NEW-OFFLOAD

// CHK-save-offload-code-CWD-NEW-OFFLOAD: clang-linker-wrapper{{.*}} "-sycl-dump-device-code="
// CHK-save-offload-code-WIN-CWD-NEW-OFFLOAD: clang-linker-wrapper{{.*}} "-sycl-dump-device-code="
Loading