Skip to content

[HIP][SPIRV] Enable the SPIRV backend instead of the translator through an experimental flag. #162282

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+49 −9
Open

[HIP][SPIRV] Enable the SPIRV backend instead of the translator through an experimental flag. #162282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e89ce89
[HIP][SPIRV] Enable the SPIRV backend instead of the translator throu…
mgcarrasco Oct 7, 2025
8d56d95
Switch to hip prefix for new flags.
mgcarrasco Oct 10, 2025
d69850d
Remove hip prefix.
mgcarrasco Oct 10, 2025
13d77d9
Remove "COM:".
mgcarrasco Oct 10, 2025
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
10 changes: 10 additions & 0 deletions clang/include/clang/Driver/Options.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1421,6 +1421,16 @@ def fhip_emit_relocatable : Flag<["-"], "fhip-emit-relocatable">,
HelpText<"Compile HIP source to relocatable">;
def fno_hip_emit_relocatable : Flag<["-"], "fno-hip-emit-relocatable">,
HelpText<"Do not override toolchain to compile HIP source to relocatable">;
def use_experimental_spirv_backend
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a defm helper for no variants right?

: Flag<["-"], "use-experimental-spirv-backend">,
Group<hip_Group>,
Flags<[HelpHidden]>,
HelpText<"Use experimental SPIRV backend for compilation ">;
def no_use_experimental_spirv_backend
: Flag<["-"], "no-use-experimental-spirv-backend">,
Group<hip_Group>,
Flags<[HelpHidden]>,
HelpText<"Do not use experimental SPIRV backend for compilation ">;
}

// Clang specific/exclusive options for OpenACC.
Expand Down
36 changes: 27 additions & 9 deletions clang/lib/Driver/ToolChains/HIPAMD.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,15 +175,33 @@ void AMDGCN::Linker::constructLinkAndEmitSpirvCommand(

constructLlvmLinkCommand(C, JA, Inputs, LinkedBCFile, Args);

// Emit SPIR-V binary.
llvm::opt::ArgStringList TrArgs{
"--spirv-max-version=1.6",
"--spirv-ext=+all",
"--spirv-allow-unknown-intrinsics",
"--spirv-lower-const-expr",
"--spirv-preserve-auxdata",
"--spirv-debug-info-version=nonsemantic-shader-200"};
SPIRV::constructTranslateCommand(C, *this, JA, Output, LinkedBCFile, TrArgs);
bool UseSPIRVBackend = Args.hasFlag(
options::OPT_use_experimental_spirv_backend,
options::OPT_no_use_experimental_spirv_backend, /*Default=*/false);

// Emit SPIR-V binary either using the SPIRV backend or the translator.
if (UseSPIRVBackend) {
llvm::opt::ArgStringList CmdArgs;
const char *Triple =
C.getArgs().MakeArgString("-triple=spirv64-amd-amdhsa");
CmdArgs.append({"-cc1", Triple, "-emit-obj", LinkedBCFile.getFilename(),
Copy link
Contributor

@AlexVlx AlexVlx Oct 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should consider invoking llc directly here, rather than round-tripping via clang, since this is an implementation detail. Failing that, we will have to pass a number of flags, and possibly gate which args, if any, get forwarded.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, using llc is vetoed. The correct way to codegen is to use cc1

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also seems to be reinventing driver infrastructure it shouldn't need to? There should be some function to call for this. In particular I'm worried about the hardcoded -emit-obj here, probably breaks -save-temps?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use the backend I don't know why we'd need special handling here. Right now this target stops at LLVM-IR, just make it emit object instead of emit IR. This flag should likely just disable this behavior entirely.

Note how clang --target=spirv64-- works as I would expect.

"-o", Output.getFilename()});
const char *Exec = getToolChain().getDriver().getClangProgramPath();
C.addCommand(std::make_unique<Command>(JA, *this,
ResponseFileSupport::None(), Exec,
CmdArgs, LinkedBCFile, Output));
} else {
// Use the SPIRV translator for code gen.
llvm::opt::ArgStringList TrArgs{
"--spirv-max-version=1.6",
"--spirv-ext=+all",
"--spirv-allow-unknown-intrinsics",
"--spirv-lower-const-expr",
"--spirv-preserve-auxdata",
"--spirv-debug-info-version=nonsemantic-shader-200"};
SPIRV::constructTranslateCommand(C, *this, JA, Output, LinkedBCFile,
TrArgs);
}
}

// For amdgcn the inputs of the linker job are device bitcode and output is
Expand Down
12 changes: 12 additions & 0 deletions clang/test/Driver/hip-spirv-backend-opt.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// This test case validates the behavior of -use-experimental-spirv-backend

// Test that -use-experimental-spirv-backend calls clang -cc1 with the SPIRV triple.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs -ccc-print-bindings and -ccc-print-phases tests.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need special handling because we do not invoke the BE in its default state, with its default flags. The vanilla target working "as you would expect" is not quite surprising, given that it's meant to work with said defaults.

// RUN: %clang -x hip %s --cuda-device-only --offload-arch=amdgcnspirv -use-experimental-spirv-backend -nogpuinc -nogpulib -### 2>&1 | FileCheck %s --check-prefix=CHECK-SPIRV-BACKEND
// CHECK-SPIRV-BACKEND: "{{.*}}clang{{.*}}" "-cc1" "{{.*-triple=spirv64-amd-amdhsa}}"

// Test that -no-use-experimental-spirv-backend calls the SPIRV translator
// RUN: %clang -x hip %s --cuda-device-only --offload-arch=amdgcnspirv -no-use-experimental-spirv-backend -nogpuinc -nogpulib -### 2>&1 | FileCheck %s --check-prefix=CHECK-SPIRV-TRANSLATOR
// CHECK-SPIRV-TRANSLATOR: "{{.*llvm-spirv.*}}" "{{--spirv-max-version=[0-9]+\.[0-9]}}"

// Test that by default we use the translator
// RUN: %clang -x hip %s --cuda-device-only --offload-arch=amdgcnspirv -nogpuinc -nogpulib -### 2>&1 | FileCheck %s --check-prefix=CHECK-SPIRV-TRANSLATOR