1//===--- HIPSPV.cpp - HIPSPV ToolChain Implementation -----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "HIPSPV.h"
10#include "HIPUtility.h"
11#include "clang/Driver/CommonArgs.h"
12#include "clang/Driver/Compilation.h"
13#include "clang/Driver/Driver.h"
14#include "clang/Driver/InputInfo.h"
15#include "clang/Options/Options.h"
16#include "llvm/Support/FileSystem.h"
17#include "llvm/Support/Path.h"
18
19using namespace clang::driver;
20using namespace clang::driver::toolchains;
21using namespace clang::driver::tools;
22using namespace clang;
23using namespace llvm::opt;
24
25// Locates HIP pass plugin.
26static std::string findPassPlugin(const Driver &D,
27 const llvm::opt::ArgList &Args) {
28 StringRef Path = Args.getLastArgValue(Id: options::OPT_hipspv_pass_plugin_EQ);
29 if (!Path.empty()) {
30 if (llvm::sys::fs::exists(Path))
31 return Path.str();
32 D.Diag(DiagID: diag::err_drv_no_such_file) << Path;
33 }
34
35 StringRef hipPath = Args.getLastArgValue(Id: options::OPT_hip_path_EQ);
36 if (!hipPath.empty()) {
37 SmallString<128> PluginPath(hipPath);
38 llvm::sys::path::append(path&: PluginPath, a: "lib", b: "libLLVMHipSpvPasses.so");
39 if (llvm::sys::fs::exists(Path: PluginPath))
40 return PluginPath.str().str();
41 PluginPath.assign(RHS: hipPath);
42 llvm::sys::path::append(path&: PluginPath, a: "lib", b: "llvm",
43 c: "libLLVMHipSpvPasses.so");
44 if (llvm::sys::fs::exists(Path: PluginPath))
45 return PluginPath.str().str();
46 }
47
48 return std::string();
49}
50
51void HIPSPV::Linker::constructLinkAndEmitSpirvCommand(
52 Compilation &C, const JobAction &JA, const InputInfoList &Inputs,
53 const InputInfo &Output, const llvm::opt::ArgList &Args) const {
54
55 assert(!Inputs.empty() && "Must have at least one input.");
56 std::string Name = std::string(llvm::sys::path::stem(path: Output.getFilename()));
57 const char *TempFile = HIP::getTempFile(C, Prefix: Name + "-link", Extension: "bc");
58
59 // Link LLVM bitcode.
60 ArgStringList LinkArgs{};
61
62 for (auto Input : Inputs)
63 if (Input.isFilename())
64 LinkArgs.push_back(Elt: Input.getFilename());
65
66 // Add static device libraries using the common helper function.
67 // This handles unbundling archives (.a) containing bitcode bundles.
68 StringRef Arch = getToolChain().getTriple().getArchName();
69 StringRef Target =
70 "generic"; // SPIR-V is generic, no specific target ID like -mcpu
71 tools::AddStaticDeviceLibsLinking(C, T: *this, JA, Inputs, DriverArgs: Args, CmdArgs&: LinkArgs, Arch,
72 Target, /*IsBitCodeSDL=*/isBitCodeSDL: true);
73 tools::constructLLVMLinkCommand(C, T: *this, JA, JobInputs: Inputs, LinkerInputs: LinkArgs, Output, Args,
74 OutputFilename: TempFile);
75
76 // Post-link HIP lowering.
77
78 // Run LLVM IR passes to lower/expand/emulate HIP code that does not translate
79 // to SPIR-V (E.g. dynamic shared memory).
80 auto PassPluginPath = findPassPlugin(D: C.getDriver(), Args);
81 if (!PassPluginPath.empty()) {
82 const char *PassPathCStr = C.getArgs().MakeArgString(Str: PassPluginPath);
83 const char *OptOutput = HIP::getTempFile(C, Prefix: Name + "-lower", Extension: "bc");
84 ArgStringList OptArgs{TempFile, "-load-pass-plugin",
85 PassPathCStr, "-passes=hip-post-link-passes",
86 "-o", OptOutput};
87 const char *Opt = Args.MakeArgString(Str: getToolChain().GetProgramPath(Name: "opt"));
88 C.addCommand(Cmd: std::make_unique<Command>(
89 args: JA, args: *this, args: ResponseFileSupport::None(), args&: Opt, args&: OptArgs, args: Inputs, args: Output));
90 TempFile = OptOutput;
91 }
92
93 // Emit SPIR-V binary.
94 llvm::opt::ArgStringList TrArgs;
95 auto T = getToolChain().getTriple();
96 bool HasNoSubArch = T.getSubArch() == llvm::Triple::NoSubArch;
97 if (T.getOS() == llvm::Triple::ChipStar) {
98 // chipStar needs 1.2 for supporting warp-level primitivies via sub-group
99 // extensions. Strictly put we'd need 1.3 for the standard non-extension
100 // shuffle operations, but it's not supported by any backend driver of the
101 // chipStar.
102 if (HasNoSubArch)
103 TrArgs.push_back(Elt: "--spirv-max-version=1.2");
104 TrArgs.push_back(Elt: "--spirv-ext=-all"
105 // Needed for experimental indirect call support.
106 ",+SPV_INTEL_function_pointers"
107 // Needed for shuffles below SPIR-V 1.3
108 ",+SPV_INTEL_subgroups");
109 } else {
110 if (HasNoSubArch)
111 TrArgs.push_back(Elt: "--spirv-max-version=1.1");
112 TrArgs.push_back(Elt: "--spirv-ext=+all");
113 }
114
115 InputInfo TrInput = InputInfo(types::TY_LLVM_BC, TempFile, "");
116 SPIRV::constructTranslateCommand(C, T: *this, JA, Output, Input: TrInput, Args: TrArgs);
117}
118
119void HIPSPV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
120 const InputInfo &Output,
121 const InputInfoList &Inputs,
122 const ArgList &Args,
123 const char *LinkingOutput) const {
124 if (Inputs.size() > 0 && Inputs[0].getType() == types::TY_Image &&
125 JA.getType() == types::TY_Object)
126 return HIP::constructGenerateObjFileFromHIPFatBinary(C, Output, Inputs,
127 Args, JA, T: *this);
128
129 if (JA.getType() == types::TY_HIP_FATBIN)
130 return HIP::constructHIPFatbinCommand(C, JA, OutputFileName: Output.getFilename(), Inputs,
131 TCArgs: Args, T: *this);
132
133 constructLinkAndEmitSpirvCommand(C, JA, Inputs, Output, Args);
134}
135
136HIPSPVToolChain::HIPSPVToolChain(const Driver &D, const llvm::Triple &Triple,
137 const ToolChain &HostTC, const ArgList &Args)
138 : ToolChain(D, Triple, Args), HostTC(&HostTC) {
139 // Lookup binaries into the driver directory, this is used to
140 // discover the clang-offload-bundler executable.
141 getProgramPaths().push_back(Elt: getDriver().Dir);
142}
143
144// Non-offloading toolchain. Primaly used by clang-offload-linker.
145HIPSPVToolChain::HIPSPVToolChain(const Driver &D, const llvm::Triple &Triple,
146 const ArgList &Args)
147 : ToolChain(D, Triple, Args), HostTC(nullptr) {
148 // Lookup binaries into the driver directory, this is used to
149 // discover the clang-offload-bundler executable.
150 getProgramPaths().push_back(Elt: getDriver().Dir);
151}
152
153void HIPSPVToolChain::addClangTargetOptions(
154 const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args,
155 BoundArch BA, Action::OffloadKind DeviceOffloadingKind) const {
156
157 if (!HostTC) {
158 assert(DeviceOffloadingKind == Action::OFK_None &&
159 "Need host toolchain for offloading!");
160 return;
161 }
162
163 HostTC->addClangTargetOptions(DriverArgs, CC1Args, BA, DeviceOffloadKind: DeviceOffloadingKind);
164
165 assert(DeviceOffloadingKind == Action::OFK_HIP &&
166 "Only HIP offloading kinds are supported for GPUs.");
167
168 CC1Args.append(
169 IL: {"-fcuda-is-device",
170 // A crude workaround for llvm-spirv which does not handle the
171 // autovectorized code well (vector reductions, non-i{8,16,32,64} types).
172 // TODO: Allow autovectorization when SPIR-V backend arrives.
173 "-mllvm", "-vectorize-loops=false", "-mllvm", "-vectorize-slp=false"});
174
175 // Default to "hidden" visibility, as object level linking will not be
176 // supported for the foreseeable future.
177 if (!DriverArgs.hasArg(Ids: options::OPT_fvisibility_EQ,
178 Ids: options::OPT_fvisibility_ms_compat))
179 CC1Args.append(
180 IL: {"-fvisibility=hidden", "-fapply-global-visibility-to-externs"});
181
182 for (const BitCodeLibraryInfo &BCFile :
183 getDeviceLibs(Args: DriverArgs, BA, DeviceOffloadKind: DeviceOffloadingKind))
184 CC1Args.append(
185 IL: {"-mlink-builtin-bitcode", DriverArgs.MakeArgString(Str: BCFile.Path)});
186}
187
188Tool *HIPSPVToolChain::buildLinker() const {
189 assert(getTriple().getArch() == llvm::Triple::spirv64);
190 return new tools::HIPSPV::Linker(*this);
191}
192
193void HIPSPVToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {
194 if (HostTC)
195 HostTC->addClangWarningOptions(CC1Args);
196 ToolChain::addClangWarningOptions(CC1Args);
197}
198
199ToolChain::CXXStdlibType
200HIPSPVToolChain::GetCXXStdlibType(const ArgList &Args) const {
201 if (HostTC)
202 return HostTC->GetCXXStdlibType(Args);
203 return ToolChain::GetCXXStdlibType(Args);
204}
205
206void HIPSPVToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
207 ArgStringList &CC1Args) const {
208 if (HostTC)
209 HostTC->AddClangSystemIncludeArgs(DriverArgs, CC1Args);
210 ToolChain::AddClangSystemIncludeArgs(DriverArgs, CC1Args);
211}
212
213void HIPSPVToolChain::AddClangCXXStdlibIncludeArgs(
214 const ArgList &Args, ArgStringList &CC1Args) const {
215 if (HostTC)
216 HostTC->AddClangCXXStdlibIncludeArgs(DriverArgs: Args, CC1Args);
217 ToolChain::AddClangCXXStdlibIncludeArgs(DriverArgs: Args, CC1Args);
218}
219
220void HIPSPVToolChain::AddIAMCUIncludeArgs(const ArgList &Args,
221 ArgStringList &CC1Args) const {
222 if (HostTC)
223 HostTC->AddIAMCUIncludeArgs(DriverArgs: Args, CC1Args);
224 ToolChain::AddIAMCUIncludeArgs(DriverArgs: Args, CC1Args);
225}
226
227void HIPSPVToolChain::AddHIPIncludeArgs(const ArgList &DriverArgs,
228 ArgStringList &CC1Args) const {
229 if (!DriverArgs.hasFlag(Pos: options::OPT_offload_inc, Neg: options::OPT_no_offload_inc,
230 Default: true))
231 return;
232
233 StringRef hipPath = DriverArgs.getLastArgValue(Id: options::OPT_hip_path_EQ);
234 if (hipPath.empty()) {
235 getDriver().Diag(DiagID: diag::err_drv_hipspv_no_hip_path);
236 return;
237 }
238 SmallString<128> P(hipPath);
239 llvm::sys::path::append(path&: P, a: "include");
240 CC1Args.append(IL: {"-isystem", DriverArgs.MakeArgString(Str: P)});
241}
242
243llvm::SmallVector<ToolChain::BitCodeLibraryInfo, 12>
244HIPSPVToolChain::getDeviceLibs(
245 const llvm::opt::ArgList &DriverArgs, BoundArch BA,
246 const Action::OffloadKind DeviceOffloadingKind) const {
247 llvm::SmallVector<ToolChain::BitCodeLibraryInfo, 12> BCLibs;
248 if (!DriverArgs.hasFlag(Pos: options::OPT_offloadlib, Neg: options::OPT_no_offloadlib,
249 Default: true))
250 return {};
251
252 ArgStringList LibraryPaths;
253 // Find device libraries in --hip-device-lib-path and HIP_DEVICE_LIB_PATH.
254 auto HipDeviceLibPathArgs = DriverArgs.getAllArgValues(
255 // --hip-device-lib-path is alias to this option.
256 Id: options::OPT_rocm_device_lib_path_EQ);
257 for (auto Path : HipDeviceLibPathArgs)
258 LibraryPaths.push_back(Elt: DriverArgs.MakeArgString(Str: Path));
259
260 StringRef HipPath = DriverArgs.getLastArgValue(Id: options::OPT_hip_path_EQ);
261 if (!HipPath.empty()) {
262 SmallString<128> Path(HipPath);
263 llvm::sys::path::append(path&: Path, a: "lib", b: "hip-device-lib");
264 LibraryPaths.push_back(Elt: DriverArgs.MakeArgString(Str: Path));
265 }
266
267 addDirectoryList(Args: DriverArgs, CmdArgs&: LibraryPaths, ArgName: "", EnvVar: "HIP_DEVICE_LIB_PATH");
268
269 // Maintain compatability with --hip-device-lib.
270 auto BCLibArgs = DriverArgs.getAllArgValues(Id: options::OPT_hip_device_lib_EQ);
271 if (!BCLibArgs.empty()) {
272 bool Found = false;
273 for (StringRef BCName : BCLibArgs) {
274 StringRef FullName;
275 for (std::string LibraryPath : LibraryPaths) {
276 SmallString<128> Path(LibraryPath);
277 llvm::sys::path::append(path&: Path, a: BCName);
278 FullName = Path;
279 if (llvm::sys::fs::exists(Path: FullName)) {
280 BCLibs.emplace_back(Args: FullName.str());
281 Found = true;
282 break;
283 }
284 }
285 if (!Found)
286 getDriver().Diag(DiagID: diag::err_drv_no_such_file) << BCName;
287 }
288 } else {
289 // Search device library named as 'hipspv-<triple>.bc'.
290 auto TT = getTriple().normalize();
291 std::string BCName = "hipspv-" + TT + ".bc";
292 for (auto *LibPath : LibraryPaths) {
293 SmallString<128> Path(LibPath);
294 llvm::sys::path::append(path&: Path, a: BCName);
295 if (llvm::sys::fs::exists(Path)) {
296 BCLibs.emplace_back(Args: Path.str().str());
297 return BCLibs;
298 }
299 }
300 getDriver().Diag(DiagID: diag::err_drv_no_hipspv_device_lib)
301 << 1 << ("'" + TT + "' target");
302 return {};
303 }
304
305 return BCLibs;
306}
307
308SanitizerMask HIPSPVToolChain::getSupportedSanitizers(
309 BoundArch BA, Action::OffloadKind DeviceOffloadKind) const {
310 // The HIPSPVToolChain only supports sanitizers in the sense that it allows
311 // sanitizer arguments on the command line if they are supported by the host
312 // toolchain. The HIPSPVToolChain will actually ignore any command line
313 // arguments for any of these "supported" sanitizers. That means that no
314 // sanitization of device code is actually supported at this time.
315 //
316 // This behavior is necessary because the host and device toolchains
317 // invocations often share the command line, so the device toolchain must
318 // tolerate flags meant only for the host toolchain.
319
320 // FIXME: Be accurate and use DeviceOffloadKind.
321 if (HostTC)
322 return HostTC->getSupportedSanitizers(BA, DeviceOffloadKind);
323 return ToolChain::getSupportedSanitizers(BA, DeviceOffloadKind);
324}
325
326VersionTuple HIPSPVToolChain::computeMSVCVersion(const Driver *D,
327 const ArgList &Args) const {
328 if (HostTC)
329 return HostTC->computeMSVCVersion(D, Args);
330 return ToolChain::computeMSVCVersion(D, Args);
331}
332
333void HIPSPVToolChain::adjustDebugInfoKind(
334 llvm::codegenoptions::DebugInfoKind &DebugInfoKind,
335 const llvm::opt::ArgList &Args) const {
336 // Debug info generation is disabled for SPIRV-LLVM-Translator
337 // which currently aborts on the presence of DW_OP_LLVM_convert.
338 // TODO: Enable debug info when the SPIR-V backend arrives.
339 DebugInfoKind = llvm::codegenoptions::NoDebugInfo;
340}
341
342LTOKind HIPSPVToolChain::getLTOMode(const llvm::opt::ArgList &Args,
343 Action::OffloadKind Kind) const {
344 // The old offload driver pipeline does not support LTO output types. Only
345 // default to LTO with the new driver.
346 if (!Args.hasFlag(Pos: options::OPT_offload_new_driver,
347 Neg: options::OPT_no_offload_new_driver, Default: true))
348 return LTOK_None;
349 return ToolChain::getLTOMode(Args, Kind);
350}
351