clang 24.0.0git
AMDGPU.cpp
Go to the documentation of this file.
1//===--- AMDGPU.cpp - AMDGPU ToolChain Implementations ----------*- 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 "AMDGPU.h"
10#include "HIPAMD.h"
12#include "clang/Config/config.h"
15#include "clang/Driver/Driver.h"
19#include "llvm/ADT/SmallSet.h"
20#include "llvm/ADT/StringExtras.h"
21#include "llvm/Option/ArgList.h"
22#include "llvm/Support/Error.h"
23#include "llvm/Support/LineIterator.h"
24#include "llvm/Support/Path.h"
25#include "llvm/Support/Process.h"
26#include "llvm/Support/VirtualFileSystem.h"
27#include "llvm/TargetParser/AMDGPUTargetParser.h"
28#include "llvm/TargetParser/Host.h"
29#include <optional>
30#include <system_error>
31
32using namespace clang::driver;
33using namespace clang::driver::tools;
34using namespace clang::driver::toolchains;
35using namespace clang;
36using namespace llvm::opt;
37
38RocmInstallationDetector::CommonBitcodeLibsPreferences::
39 CommonBitcodeLibsPreferences(const Driver &D,
40 const llvm::opt::ArgList &DriverArgs,
41 StringRef GPUArch,
42 const Action::OffloadKind DeviceOffloadingKind,
43 const bool NeedsASanRT)
44 : ABIVer(DeviceLibABIVersion::fromCodeObjectVersion(
45 tools::getAMDGPUCodeObjectVersion(D, DriverArgs))) {
46 const auto Kind = llvm::AMDGPU::parseArchAMDGCN(GPUArch);
47 const unsigned ArchAttr = llvm::AMDGPU::getArchAttrAMDGCN(Kind);
48
49 IsOpenMP = DeviceOffloadingKind == Action::OFK_OpenMP;
50
51 const bool HasWave32 = (ArchAttr & llvm::AMDGPU::FEATURE_WAVE32);
52 Wave64 =
53 !HasWave32 || DriverArgs.hasFlag(options::OPT_mwavefrontsize64,
54 options::OPT_mno_wavefrontsize64, false);
55
56 const bool IsKnownOffloading = DeviceOffloadingKind == Action::OFK_OpenMP ||
57 DeviceOffloadingKind == Action::OFK_HIP;
58
59 // Default to enabling f32 denormals on subtargets where fma is fast with
60 // denormals
61 const bool DefaultDAZ =
62 (Kind == llvm::AMDGPU::GK_NONE)
63 ? false
64 : !((ArchAttr & llvm::AMDGPU::FEATURE_FAST_FMA_F32) &&
65 (ArchAttr & llvm::AMDGPU::FEATURE_FAST_DENORMAL_F32));
66 // TODO: There are way too many flags that change this. Do we need to
67 // check them all?
68 DAZ = IsKnownOffloading
69 ? DriverArgs.hasFlag(options::OPT_fgpu_flush_denormals_to_zero,
70 options::OPT_fno_gpu_flush_denormals_to_zero,
71 DefaultDAZ)
72 : DriverArgs.hasArg(options::OPT_cl_denorms_are_zero) || DefaultDAZ;
73
74 FiniteOnly = DriverArgs.hasArg(options::OPT_cl_finite_math_only) ||
75 DriverArgs.hasFlag(options::OPT_ffinite_math_only,
76 options::OPT_fno_finite_math_only, false);
77
78 UnsafeMathOpt =
79 DriverArgs.hasArg(options::OPT_cl_unsafe_math_optimizations) ||
80 DriverArgs.hasFlag(options::OPT_funsafe_math_optimizations,
81 options::OPT_fno_unsafe_math_optimizations, false);
82
83 FastRelaxedMath = DriverArgs.hasArg(options::OPT_cl_fast_relaxed_math) ||
84 DriverArgs.hasFlag(options::OPT_ffast_math,
85 options::OPT_fno_fast_math, false);
86
87 // GPU Sanitizer currently only supports ASan and is enabled through host
88 // ASan.
89 GPUSan = (DriverArgs.hasFlag(options::OPT_fgpu_sanitize,
90 options::OPT_fno_gpu_sanitize, true) &&
91 NeedsASanRT);
92}
93
94void RocmInstallationDetector::scanLibDevicePath(llvm::StringRef Path) {
95 assert(!Path.empty());
96
97 const StringRef Suffix(".bc");
98 const StringRef Suffix2(".amdgcn.bc");
99
100 std::error_code EC;
101 for (llvm::vfs::directory_iterator LI = D.getVFS().dir_begin(Path, EC), LE;
102 !EC && LI != LE; LI = LI.increment(EC)) {
103 StringRef FilePath = LI->path();
104 StringRef FileName = llvm::sys::path::filename(FilePath);
105 if (!FileName.ends_with(Suffix))
106 continue;
107
108 StringRef BaseName;
109 if (FileName.ends_with(Suffix2))
110 BaseName = FileName.drop_back(Suffix2.size());
111 else if (FileName.ends_with(Suffix))
112 BaseName = FileName.drop_back(Suffix.size());
113
114 const StringRef ABIVersionPrefix = "oclc_abi_version_";
115 if (BaseName == "ocml") {
116 OCML = FilePath;
117 } else if (BaseName == "ockl") {
118 OCKL = FilePath;
119 } else if (BaseName == "opencl") {
120 OpenCL = FilePath;
121 } else if (BaseName == "asanrtl") {
122 AsanRTL = FilePath;
123 } else if (BaseName == "oclc_finite_only_off") {
124 FiniteOnly.Off = FilePath;
125 } else if (BaseName == "oclc_finite_only_on") {
126 FiniteOnly.On = FilePath;
127 } else if (BaseName == "oclc_unsafe_math_on") {
128 UnsafeMath.On = FilePath;
129 } else if (BaseName == "oclc_unsafe_math_off") {
130 UnsafeMath.Off = FilePath;
131 } else if (BaseName == "oclc_wavefrontsize64_on") {
132 WavefrontSize64.On = FilePath;
133 } else if (BaseName == "oclc_wavefrontsize64_off") {
134 WavefrontSize64.Off = FilePath;
135 } else if (BaseName.starts_with(ABIVersionPrefix)) {
136 unsigned ABIVersionNumber;
137 if (BaseName.drop_front(ABIVersionPrefix.size())
138 .getAsInteger(/*Redex=*/0, ABIVersionNumber))
139 continue;
140 ABIVersionMap[ABIVersionNumber] = FilePath.str();
141 } else {
142 // Process all bitcode filenames that look like
143 // ocl_isa_version_XXX.amdgcn.bc
144 const StringRef DeviceLibPrefix = "oclc_isa_version_";
145 if (!BaseName.starts_with(DeviceLibPrefix))
146 continue;
147
148 StringRef IsaVersionNumber =
149 BaseName.drop_front(DeviceLibPrefix.size());
150
151 llvm::Twine GfxName = Twine("gfx") + IsaVersionNumber;
152 SmallString<8> Tmp;
153 LibDeviceMap.insert({GfxName.toStringRef(Tmp), FilePath.str()});
154 }
155 }
156}
157
158// Parse and extract version numbers from `.hipVersion`. Return `true` if
159// the parsing fails.
160bool RocmInstallationDetector::parseHIPVersionFile(llvm::StringRef V) {
161 SmallVector<StringRef, 4> VersionParts;
162 V.split(VersionParts, '\n');
163 unsigned Major = ~0U;
164 unsigned Minor = ~0U;
165 for (auto Part : VersionParts) {
166 auto Splits = Part.rtrim().split('=');
167 if (Splits.first == "HIP_VERSION_MAJOR") {
168 if (Splits.second.getAsInteger(0, Major))
169 return true;
170 } else if (Splits.first == "HIP_VERSION_MINOR") {
171 if (Splits.second.getAsInteger(0, Minor))
172 return true;
173 } else if (Splits.first == "HIP_VERSION_PATCH")
174 VersionPatch = Splits.second.str();
175 }
176 if (Major == ~0U || Minor == ~0U)
177 return true;
178 VersionMajorMinor = llvm::VersionTuple(Major, Minor);
179 DetectedVersion =
180 (Twine(Major) + "." + Twine(Minor) + "." + VersionPatch).str();
181 return false;
182}
183
184/// \returns a list of candidate directories for ROCm installation, which is
185/// cached and populated only once.
186const SmallVectorImpl<RocmInstallationDetector::Candidate> &
187RocmInstallationDetector::getInstallationPathCandidates() {
188
189 // Return the cached candidate list if it has already been populated.
190 if (!ROCmSearchDirs.empty())
191 return ROCmSearchDirs;
192
193 auto DoPrintROCmSearchDirs = [&]() {
194 if (PrintROCmSearchDirs)
195 for (auto Cand : ROCmSearchDirs) {
196 llvm::errs() << "ROCm installation search path: " << Cand.Path << '\n';
197 }
198 };
199
200 // For candidate specified by --rocm-path we do not do strict check, i.e.,
201 // checking existence of HIP version file and device library files.
202 if (!RocmPathArg.empty()) {
203 ROCmSearchDirs.emplace_back(RocmPathArg.str());
204 DoPrintROCmSearchDirs();
205 return ROCmSearchDirs;
206 } else if (std::optional<std::string> RocmPathEnv =
207 llvm::sys::Process::GetEnv("ROCM_PATH")) {
208 if (!RocmPathEnv->empty()) {
209 ROCmSearchDirs.emplace_back(std::move(*RocmPathEnv));
210 DoPrintROCmSearchDirs();
211 return ROCmSearchDirs;
212 }
213 }
214
215 // Try to find relative to the compiler binary.
216 StringRef InstallDir = D.Dir;
217
218 // Check both a normal Unix prefix position of the clang binary, as well as
219 // the Windows-esque layout the ROCm packages use with the host architecture
220 // subdirectory of bin.
221 auto DeduceROCmPath = [](StringRef ClangPath) {
222 // Strip off directory (usually bin)
223 StringRef ParentDir = llvm::sys::path::parent_path(ClangPath);
224 StringRef ParentName = llvm::sys::path::filename(ParentDir);
225
226 // Some builds use bin/{host arch}, so go up again.
227 if (ParentName == "bin") {
228 ParentDir = llvm::sys::path::parent_path(ParentDir);
229 ParentName = llvm::sys::path::filename(ParentDir);
230 }
231
232 // Some versions of the rocm llvm package install to /opt/rocm/llvm/bin
233 // Some versions of the aomp package install to /opt/rocm/aomp/bin
234 if (ParentName == "llvm" || ParentName.starts_with("aomp")) {
235 ParentDir = llvm::sys::path::parent_path(ParentDir);
236 ParentName = llvm::sys::path::filename(ParentDir);
237
238 // Some versions of the rocm llvm package install to
239 // /opt/rocm/lib/llvm/bin, so also back up if within the lib dir still
240 if (ParentName == "lib")
241 ParentDir = llvm::sys::path::parent_path(ParentDir);
242 }
243
244 return Candidate(ParentDir.str(), /*StrictChecking=*/true);
245 };
246
247 // Deduce ROCm path by the path used to invoke clang. Do not resolve symbolic
248 // link of clang itself.
249 ROCmSearchDirs.emplace_back(DeduceROCmPath(InstallDir));
250
251 // Deduce ROCm path by the real path of the invoked clang, resolving symbolic
252 // link of clang itself.
253 llvm::SmallString<256> RealClangPath;
254 llvm::sys::fs::real_path(D.getDriverProgramPath(), RealClangPath);
255 auto ParentPath = llvm::sys::path::parent_path(RealClangPath);
256 if (ParentPath != InstallDir)
257 ROCmSearchDirs.emplace_back(DeduceROCmPath(ParentPath));
258
259 // Device library may be installed in clang or resource directory.
260 auto ClangRoot = llvm::sys::path::parent_path(InstallDir);
261 auto RealClangRoot = llvm::sys::path::parent_path(ParentPath);
262 ROCmSearchDirs.emplace_back(ClangRoot.str(), /*StrictChecking=*/true);
263 if (RealClangRoot != ClangRoot)
264 ROCmSearchDirs.emplace_back(RealClangRoot.str(), /*StrictChecking=*/true);
265 ROCmSearchDirs.emplace_back(D.ResourceDir,
266 /*StrictChecking=*/true);
267
268 ROCmSearchDirs.emplace_back(D.SysRoot + "/opt/rocm",
269 /*StrictChecking=*/true);
270
271 // Find the latest /opt/rocm-{release} directory.
272 std::error_code EC;
273 std::string LatestROCm;
274 llvm::VersionTuple LatestVer;
275 // Get ROCm version from ROCm directory name.
276 auto GetROCmVersion = [](StringRef DirName) {
277 llvm::VersionTuple V;
278 std::string VerStr = DirName.drop_front(strlen("rocm-")).str();
279 // The ROCm directory name follows the format of
280 // rocm-{major}.{minor}.{subMinor}[-{build}]
281 llvm::replace(VerStr, '-', '.');
282 V.tryParse(VerStr);
283 return V;
284 };
285 for (llvm::vfs::directory_iterator
286 File = D.getVFS().dir_begin(D.SysRoot + "/opt", EC),
287 FileEnd;
288 File != FileEnd && !EC; File.increment(EC)) {
289 llvm::StringRef FileName = llvm::sys::path::filename(File->path());
290 if (!FileName.starts_with("rocm-"))
291 continue;
292 if (LatestROCm.empty()) {
293 LatestROCm = FileName.str();
294 LatestVer = GetROCmVersion(LatestROCm);
295 continue;
296 }
297 auto Ver = GetROCmVersion(FileName);
298 if (LatestVer < Ver) {
299 LatestROCm = FileName.str();
300 LatestVer = Ver;
301 }
302 }
303 if (!LatestROCm.empty())
304 ROCmSearchDirs.emplace_back(D.SysRoot + "/opt/" + LatestROCm,
305 /*StrictChecking=*/true);
306
307 ROCmSearchDirs.emplace_back(D.SysRoot + "/usr/local",
308 /*StrictChecking=*/true);
309 ROCmSearchDirs.emplace_back(D.SysRoot + "/usr",
310 /*StrictChecking=*/true);
311
312 DoPrintROCmSearchDirs();
313 return ROCmSearchDirs;
314}
315
317 const Driver &D, const llvm::Triple &HostTriple,
318 const llvm::opt::ArgList &Args, bool DetectHIPRuntime)
319 : D(D) {
320 Verbose = Args.hasArg(options::OPT_v);
321 RocmPathArg = Args.getLastArgValue(options::OPT_rocm_path_EQ);
322 PrintROCmSearchDirs = Args.hasArg(options::OPT_print_rocm_search_dirs);
323 RocmDeviceLibPathArg =
324 Args.getAllArgValues(options::OPT_rocm_device_lib_path_EQ);
325 HIPPathArg = Args.getLastArgValue(options::OPT_hip_path_EQ);
326 HIPStdParPathArg = Args.getLastArgValue(options::OPT_hipstdpar_path_EQ);
327 HasHIPStdParLibrary =
328 !HIPStdParPathArg.empty() && D.getVFS().exists(HIPStdParPathArg +
329 "/hipstdpar_lib.hpp");
330 HIPRocThrustPathArg =
331 Args.getLastArgValue(options::OPT_hipstdpar_thrust_path_EQ);
332 HasRocThrustLibrary = !HIPRocThrustPathArg.empty() &&
333 D.getVFS().exists(HIPRocThrustPathArg + "/thrust");
334 HIPRocPrimPathArg = Args.getLastArgValue(options::OPT_hipstdpar_prim_path_EQ);
335 HasRocPrimLibrary = !HIPRocPrimPathArg.empty() &&
336 D.getVFS().exists(HIPRocPrimPathArg + "/rocprim");
337
338 if (auto *A = Args.getLastArg(options::OPT_hip_version_EQ)) {
339 HIPVersionArg = A->getValue();
340 unsigned Major = ~0U;
341 unsigned Minor = ~0U;
342 SmallVector<StringRef, 3> Parts;
343 HIPVersionArg.split(Parts, '.');
344 if (!Parts.empty())
345 Parts[0].getAsInteger(0, Major);
346 if (Parts.size() > 1)
347 Parts[1].getAsInteger(0, Minor);
348 if (Parts.size() > 2)
349 VersionPatch = Parts[2].str();
350 if (VersionPatch.empty())
351 VersionPatch = "0";
352 if (Major != ~0U && Minor == ~0U)
353 Minor = 0;
354 if (Major == ~0U || Minor == ~0U)
355 D.Diag(diag::err_drv_invalid_value)
356 << A->getAsString(Args) << HIPVersionArg;
357
358 VersionMajorMinor = llvm::VersionTuple(Major, Minor);
359 DetectedVersion =
360 (Twine(Major) + "." + Twine(Minor) + "." + VersionPatch).str();
361 } else {
362 VersionPatch = DefaultVersionPatch;
363 VersionMajorMinor =
364 llvm::VersionTuple(DefaultVersionMajor, DefaultVersionMinor);
365 DetectedVersion = (Twine(DefaultVersionMajor) + "." +
366 Twine(DefaultVersionMinor) + "." + VersionPatch)
367 .str();
368 }
369
370 if (DetectHIPRuntime)
372}
373
375 assert(LibDevicePath.empty());
376
377 if (!RocmDeviceLibPathArg.empty())
378 LibDevicePath = RocmDeviceLibPathArg.back();
379 else if (std::optional<std::string> LibPathEnv =
380 llvm::sys::Process::GetEnv("HIP_DEVICE_LIB_PATH"))
381 LibDevicePath = std::move(*LibPathEnv);
382
383 auto &FS = D.getVFS();
384 if (!LibDevicePath.empty()) {
385 // Maintain compatability with HIP flag/envvar pointing directly at the
386 // bitcode library directory. This points directly at the library path instead
387 // of the rocm root installation.
388 if (!FS.exists(LibDevicePath))
389 return;
390
391 scanLibDevicePath(LibDevicePath);
392 HasDeviceLibrary = allGenericLibsValid() && !LibDeviceMap.empty();
393 return;
394 }
395
396 // Check device library exists at the given path.
397 auto CheckDeviceLib = [&](StringRef Path, bool StrictChecking) {
398 bool CheckLibDevice = (!NoBuiltinLibs || StrictChecking);
399 if (CheckLibDevice && !FS.exists(Path))
400 return false;
401
402 scanLibDevicePath(Path);
403
404 if (!NoBuiltinLibs) {
405 // Check that the required non-target libraries are all available.
406 if (!allGenericLibsValid())
407 return false;
408
409 // Check that we have found at least one libdevice that we can link in
410 // if -nobuiltinlib hasn't been specified.
411 if (LibDeviceMap.empty())
412 return false;
413 }
414 return true;
415 };
416
417 // Find device libraries in <LLVM_DIR>/lib/clang/<ver>/lib/amdgcn/bitcode
418 LibDevicePath = D.ResourceDir;
419 llvm::sys::path::append(LibDevicePath, CLANG_INSTALL_LIBDIR_BASENAME,
420 "amdgcn", "bitcode");
421 HasDeviceLibrary = CheckDeviceLib(LibDevicePath, true);
422 if (HasDeviceLibrary)
423 return;
424
425 // Find device libraries in a legacy ROCm directory structure
426 // ${ROCM_ROOT}/amdgcn/bitcode/*
427 auto &ROCmDirs = getInstallationPathCandidates();
428 for (const auto &Candidate : ROCmDirs) {
429 LibDevicePath = Candidate.Path;
430 llvm::sys::path::append(LibDevicePath, "amdgcn", "bitcode");
431 HasDeviceLibrary = CheckDeviceLib(LibDevicePath, Candidate.StrictChecking);
432 if (HasDeviceLibrary)
433 return;
434 }
435}
436
438 SmallVector<Candidate, 4> HIPSearchDirs;
439 if (!HIPPathArg.empty())
440 HIPSearchDirs.emplace_back(HIPPathArg.str());
441 else if (std::optional<std::string> HIPPathEnv =
442 llvm::sys::Process::GetEnv("HIP_PATH")) {
443 if (!HIPPathEnv->empty())
444 HIPSearchDirs.emplace_back(std::move(*HIPPathEnv));
445 }
446 if (HIPSearchDirs.empty())
447 HIPSearchDirs.append(getInstallationPathCandidates());
448 auto &FS = D.getVFS();
449
450 for (const auto &Candidate : HIPSearchDirs) {
451 InstallPath = Candidate.Path;
452 if (InstallPath.empty() || !FS.exists(InstallPath))
453 continue;
454
455 BinPath = InstallPath;
456 llvm::sys::path::append(BinPath, "bin");
457 IncludePath = InstallPath;
458 llvm::sys::path::append(IncludePath, "include");
459 LibPath = InstallPath;
460 llvm::sys::path::append(LibPath, "lib");
461 SharePath = InstallPath;
462 llvm::sys::path::append(SharePath, "share");
463
464 // Get parent of InstallPath and append "share"
465 SmallString<0> ParentSharePath = llvm::sys::path::parent_path(InstallPath);
466 llvm::sys::path::append(ParentSharePath, "share");
467
468 auto Append = [](SmallString<0> &path, const Twine &a, const Twine &b = "",
469 const Twine &c = "", const Twine &d = "") {
470 SmallString<0> newpath = path;
471 llvm::sys::path::append(newpath, a, b, c, d);
472 return newpath;
473 };
474 // If HIP version file can be found and parsed, use HIP version from there.
475 std::vector<SmallString<0>> VersionFilePaths = {
476 Append(SharePath, "hip", "version"),
477 InstallPath != D.SysRoot + "/usr/local"
478 ? Append(ParentSharePath, "hip", "version")
479 : SmallString<0>(),
480 Append(BinPath, ".hipVersion")};
481
482 for (const auto &VersionFilePath : VersionFilePaths) {
483 if (VersionFilePath.empty())
484 continue;
485 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> VersionFile =
486 FS.getBufferForFile(VersionFilePath);
487 if (!VersionFile)
488 continue;
489 if (HIPVersionArg.empty() && VersionFile)
490 if (parseHIPVersionFile((*VersionFile)->getBuffer()))
491 continue;
492
493 HasHIPRuntime = true;
494 return;
495 }
496 // Otherwise, if -rocm-path is specified (no strict checking), use the
497 // default HIP version or specified by --hip-version.
498 if (!Candidate.StrictChecking) {
499 HasHIPRuntime = true;
500 return;
501 }
502 }
503 HasHIPRuntime = false;
504}
505
506void RocmInstallationDetector::print(raw_ostream &OS) const {
507 if (hasHIPRuntime())
508 OS << "Found HIP installation: " << InstallPath << ", version "
509 << DetectedVersion << '\n';
510}
511
512void RocmInstallationDetector::AddHIPIncludeArgs(const ArgList &DriverArgs,
513 ArgStringList &CC1Args) const {
514 bool UsesRuntimeWrapper = VersionMajorMinor > llvm::VersionTuple(3, 5) &&
515 !DriverArgs.hasArg(options::OPT_nohipwrapperinc);
516 bool HasHipStdPar = DriverArgs.hasArg(options::OPT_hipstdpar);
517
518 if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
519 // HIP header includes standard library wrapper headers under clang
520 // cuda_wrappers directory. Since these wrapper headers include_next
521 // standard C++ headers, whereas libc++ headers include_next other clang
522 // headers. The include paths have to follow this order:
523 // - wrapper include path
524 // - standard C++ include path
525 // - other clang include path
526 // Since standard C++ and other clang include paths are added in other
527 // places after this function, here we only need to make sure wrapper
528 // include path is added.
529 //
530 // ROCm 3.5 does not fully support the wrapper headers. Therefore it needs
531 // a workaround.
532 SmallString<128> P(D.ResourceDir);
533 if (UsesRuntimeWrapper)
534 llvm::sys::path::append(P, "include", "cuda_wrappers");
535 CC1Args.push_back("-internal-isystem");
536 CC1Args.push_back(DriverArgs.MakeArgString(P));
537 }
538
539 const auto HandleHipStdPar = [=, &DriverArgs, &CC1Args]() {
540 StringRef Inc = getIncludePath();
541 auto &FS = D.getVFS();
542
543 if (!hasHIPStdParLibrary())
544 if (!HIPStdParPathArg.empty() ||
545 !FS.exists(Inc + "/thrust/system/hip/hipstdpar/hipstdpar_lib.hpp")) {
546 D.Diag(diag::err_drv_no_hipstdpar_lib);
547 return;
548 }
549 if (!HasRocThrustLibrary && !FS.exists(Inc + "/thrust")) {
550 D.Diag(diag::err_drv_no_hipstdpar_thrust_lib);
551 return;
552 }
553 if (!HasRocPrimLibrary && !FS.exists(Inc + "/rocprim")) {
554 D.Diag(diag::err_drv_no_hipstdpar_prim_lib);
555 return;
556 }
557 const char *ThrustPath;
558 if (HasRocThrustLibrary)
559 ThrustPath = DriverArgs.MakeArgString(HIPRocThrustPathArg);
560 else
561 ThrustPath = DriverArgs.MakeArgString(Inc + "/thrust");
562
563 const char *HIPStdParPath;
565 HIPStdParPath = DriverArgs.MakeArgString(HIPStdParPathArg);
566 else
567 HIPStdParPath = DriverArgs.MakeArgString(StringRef(ThrustPath) +
568 "/system/hip/hipstdpar");
569
570 const char *PrimPath;
571 if (HasRocPrimLibrary)
572 PrimPath = DriverArgs.MakeArgString(HIPRocPrimPathArg);
573 else
574 PrimPath = DriverArgs.MakeArgString(getIncludePath() + "/rocprim");
575
576 CC1Args.append({"-idirafter", ThrustPath, "-idirafter", PrimPath,
577 "-idirafter", HIPStdParPath, "-include",
578 "hipstdpar_lib.hpp"});
579 };
580
581 if (!DriverArgs.hasFlag(options::OPT_offload_inc, options::OPT_no_offload_inc,
582 true)) {
583 if (HasHipStdPar)
584 HandleHipStdPar();
585
586 return;
587 }
588
589 if (!hasHIPRuntime()) {
590 D.Diag(diag::err_drv_no_hip_runtime);
591 return;
592 }
593
594 CC1Args.push_back("-idirafter");
595 CC1Args.push_back(DriverArgs.MakeArgString(getIncludePath()));
596 if (UsesRuntimeWrapper)
597 CC1Args.append({"-include", "__clang_hip_runtime_wrapper.h"});
598 if (HasHipStdPar)
599 HandleHipStdPar();
600}
601
603 const InputInfo &Output,
604 const InputInfoList &Inputs,
605 const ArgList &Args,
606 const char *LinkingOutput) const {
607 std::string Linker = getToolChain().GetLinkerPath();
608 ArgStringList CmdArgs;
609 if (!Args.hasArg(options::OPT_r)) {
610 CmdArgs.push_back("--no-undefined");
611 CmdArgs.push_back("-shared");
612 }
613
614 if (Args.hasArg(options::OPT_hipstdpar))
615 CmdArgs.push_back("-plugin-opt=-amdgpu-enable-hipstdpar");
616
617 if (auto LTO = getToolChain().getLTOMode(Args); LTO != LTOK_None) {
618 addLTOOptions(getToolChain(), Args, CmdArgs, Output, Inputs,
619 LTO == LTOK_Thin);
620 } else if (Args.hasArg(options::OPT_mcpu_EQ)) {
621 CmdArgs.push_back(Args.MakeArgString(
622 "-plugin-opt=mcpu=" +
624 Args.getLastArgValue(options::OPT_mcpu_EQ))));
625 }
627 getToolChain().AddFilePathLibArgs(Args, CmdArgs);
628 Args.AddAllArgs(CmdArgs, options::OPT_L);
629 AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
630
631 // Always pass the target-id features to the LTO job.
632 std::vector<StringRef> Features;
633 getAMDGPUTargetFeatures(C.getDriver(), getToolChain().getEffectiveTriple(),
634 Args, Features);
635 if (!Features.empty()) {
636 CmdArgs.push_back(
637 Args.MakeArgString("-plugin-opt=-mattr=" + llvm::join(Features, ",")));
638 }
639
640 getToolChain().addProfileRTLibs(Args, CmdArgs);
641 addSanitizerRuntimes(getToolChain(), Args, CmdArgs);
642
643 if (Args.hasArg(options::OPT_stdlib))
644 CmdArgs.append({"-lc", "-lm"});
645 if (Args.hasArg(options::OPT_startfiles)) {
646 std::optional<std::string> IncludePath = getToolChain().getStdlibPath();
647 if (!IncludePath)
648 IncludePath = "/lib";
649 SmallString<128> P(*IncludePath);
650 llvm::sys::path::append(P, "crt1.o");
651 CmdArgs.push_back(Args.MakeArgString(P));
652 }
653
654 CmdArgs.push_back("-o");
655 CmdArgs.push_back(Output.getFilename());
656 C.addCommand(std::make_unique<Command>(
657 JA, *this, ResponseFileSupport::AtFileCurCP(), Args.MakeArgString(Linker),
658 CmdArgs, Inputs, Output));
659}
660
662 const llvm::Triple &Triple,
663 const llvm::opt::ArgList &Args,
664 std::vector<StringRef> &Features,
665 bool ForAS) {
666 if (Args.hasFlag(options::OPT_mwavefrontsize64,
667 options::OPT_mno_wavefrontsize64, false))
668 Features.push_back("+wavefrontsize64");
669
670 if (Args.hasFlag(options::OPT_mamdgpu_precise_memory_op,
671 options::OPT_mno_amdgpu_precise_memory_op, false))
672 Features.push_back("+precise-memory");
673
674 // When assembling, the xnack/sramecc mode cannot come from a module flag
675 // (there is no module), so forward it to the assembler as a feature.
676 if (ForAS) {
677 if (Arg *A = Args.getLastArg(options::OPT_mxnack, options::OPT_mno_xnack)) {
678 Features.push_back(
679 A->getOption().matches(options::OPT_mxnack) ? "+xnack" : "-xnack");
680 }
681
682 if (Arg *A =
683 Args.getLastArg(options::OPT_msramecc, options::OPT_mno_sramecc)) {
684 Features.push_back(A->getOption().matches(options::OPT_msramecc)
685 ? "+sramecc"
686 : "-sramecc");
687 }
688 }
689
690 handleTargetFeaturesGroup(D, Triple, Args, Features,
691 options::OPT_m_amdgpu_Features_Group);
692}
693
694/// AMDGPU Toolchain
695AMDGPUToolChain::AMDGPUToolChain(const Driver &D, const llvm::Triple &Triple,
696 const ArgList &Args, const ToolChain *HostTC_,
699 : Generic_ELF(D, Triple, Args),
701 {{options::OPT_O, "3"}, {options::OPT_cl_std_EQ, "CL1.2"}}),
702 HostTC(HostTC_), UseHIPLinker(Kind == Action::OFK_HIP),
703 ShouldLinkDeviceLibs(ShouldLinkDeviceLibs) {
704 loadMultilibsFromYAML(Args, D);
705
706 // Check code object version options. Emit warnings for legacy options
707 // and errors for the last invalid code object version options.
708 // It is done here to avoid repeated warning or error messages for
709 // each tool invocation.
711
712 if (Triple.getOS() == llvm::Triple::AMDHSA &&
713 Triple.getEnvironment() != llvm::Triple::LLVM)
714 RocmInstallation->detectDeviceLibrary();
715
716 if (HostTC)
717 getProgramPaths().push_back(getDriver().Dir);
718}
719
721 // FIXME: Should not have 2 linker paths.
722 if (UseHIPLinker)
723 return new tools::AMDGCN::Linker(*this);
724 return new tools::amdgpu::Linker(*this);
725}
726
727DerivedArgList *
728AMDGPUToolChain::TranslateArgs(const DerivedArgList &Args, BoundArch BA,
729 Action::OffloadKind DeviceOffloadKind) const {
730 DerivedArgList *DAL = Generic_ELF::TranslateArgs(Args, BA, DeviceOffloadKind);
731 if (!DAL) {
732 DAL = new DerivedArgList(Args.getBaseArgs());
733 for (Arg *A : Args)
734 DAL->append(A);
735 }
736
737 const OptTable &Opts = getDriver().getOpts();
738
739 if (DeviceOffloadKind == Action::OFK_None) {
740 // AMDGPU is intended to use `-mcpu` but we accept `-march` for legacy.
741 if (Arg *A = DAL->getLastArg(options::OPT_march_EQ)) {
742 DAL->eraseArg(options::OPT_march_EQ);
743 if (!DAL->hasArg(options::OPT_mcpu_EQ))
744 DAL->AddJoinedArg(A, Opts.getOption(options::OPT_mcpu_EQ),
745 A->getValue());
746 }
747 }
748
749 // Replace -mcpu=native with detected GPU.
750 Arg *LastMCPUArg = DAL->getLastArg(options::OPT_mcpu_EQ);
751 if (LastMCPUArg && StringRef(LastMCPUArg->getValue()) == "native") {
752 DAL->eraseArg(options::OPT_mcpu_EQ);
753 auto GPUsOrErr = getSystemGPUArchs(Args);
754 if (!GPUsOrErr) {
755 getDriver().Diag(diag::err_drv_undetermined_gpu_arch)
756 << getArchName() << llvm::toString(GPUsOrErr.takeError()) << "-mcpu";
757 } else {
758 auto &GPUs = *GPUsOrErr;
759 if (!llvm::all_equal(GPUs))
760 getDriver().Diag(diag::warn_drv_multi_gpu_arch)
761 << getArchName() << llvm::join(GPUs, ", ") << "-mcpu";
762 DAL->AddJoinedArg(nullptr, Opts.getOption(options::OPT_mcpu_EQ),
763 Args.MakeArgString(GPUs.front()));
764 }
765 }
766
767 if (!BA.empty()) {
768 DAL->eraseArg(options::OPT_mcpu_EQ);
769 DAL->AddJoinedArg(nullptr, Opts.getOption(options::OPT_mcpu_EQ),
770 BA.ArchName);
771 }
772
773 if (!getTriple().isSPIRV()) {
775
776 // Synthesize feature flags for target ID modifiers (xnack, sramecc).
777 if (PTID.OptionalFeatureMap) {
778 const llvm::StringMap<bool> &FeatureMap = *PTID.OptionalFeatureMap;
779
780 auto XnackIt = FeatureMap.find("xnack");
781 if (XnackIt != FeatureMap.end()) {
782 DAL->AddFlagArg(nullptr, Opts.getOption(XnackIt->second
783 ? options::OPT_mxnack
784 : options::OPT_mno_xnack));
785 }
786
787 auto SrameccIt = FeatureMap.find("sramecc");
788 if (SrameccIt != FeatureMap.end()) {
789 DAL->AddFlagArg(nullptr,
790 Opts.getOption(SrameccIt->second
791 ? options::OPT_msramecc
792 : options::OPT_mno_sramecc));
793 }
794 }
795 }
796
797 // Filter out sanitizer coverage options that are not supported for AMDGPU.
798 for (Arg *A : Args) {
799 // Sanitizer coverage is currently not supported for AMDGPU.
800 if (A->getOption().matches(options::OPT_fsan_cov_Group)) {
801 // Upgrade to error if the option was explicitly specified for device
802 bool IsExplicitDevice =
803 A->getBaseArg().getOption().matches(options::OPT_Xarch_device);
804 getDriver().Diag(IsExplicitDevice
805 ? diag::err_drv_unsupported_option_for_target
806 : diag::warn_drv_unsupported_option_for_target)
807 << A->getAsString(Args) << getTriple().str();
808 }
809 }
810
811 if (Args.getLastArgValue(options::OPT_x) != "cl")
812 return DAL;
813
814 // Phase 1 (.cl -> .bc)
815 if (Args.hasArg(options::OPT_c) && Args.hasArg(options::OPT_emit_llvm)) {
816 // Have to check OPT_O4, OPT_O0 & OPT_Ofast separately
817 // as they defined that way in Options.td
818 if (!Args.hasArg(options::OPT_O, options::OPT_O0, options::OPT_O4,
819 options::OPT_Ofast))
820 DAL->AddJoinedArg(nullptr, Opts.getOption(options::OPT_O),
821 getOptionDefault(options::OPT_O));
822 }
823
824 return DAL;
825}
826
828 llvm::AMDGPU::GPUKind Kind) {
829
830 // Assume nothing without a specific target.
831 if (Kind == llvm::AMDGPU::GK_NONE)
832 return false;
833
834 const unsigned ArchAttr = llvm::AMDGPU::getArchAttrAMDGCN(Kind);
835
836 // Default to enabling f32 denormals by default on subtargets where fma is
837 // fast with denormals
838 const bool BothDenormAndFMAFast =
839 (ArchAttr & llvm::AMDGPU::FEATURE_FAST_FMA_F32) &&
840 (ArchAttr & llvm::AMDGPU::FEATURE_FAST_DENORMAL_F32);
841 return !BothDenormAndFMAFast;
842}
843
845 const llvm::opt::ArgList &DriverArgs, const JobAction &JA,
846 const llvm::fltSemantics *FPType) const {
847 // Denormals should always be enabled for f16 and f64.
848 if (!FPType || FPType != &llvm::APFloat::IEEEsingle())
849 return llvm::DenormalMode::getIEEE();
850
854 // FIXME: Missing conversion from OffloadArch to GPUKind
856 auto Kind = llvm::AMDGPU::parseArchAMDGCN(Arch);
857 if (FPType && FPType == &llvm::APFloat::IEEEsingle() &&
858 DriverArgs.hasFlag(options::OPT_fgpu_flush_denormals_to_zero,
859 options::OPT_fno_gpu_flush_denormals_to_zero,
861 return llvm::DenormalMode::getPreserveSign();
862
863 return llvm::DenormalMode::getIEEE();
864 }
865
866 const StringRef GpuArch = getGPUArch(DriverArgs);
867 auto Kind = llvm::AMDGPU::parseArchAMDGCN(GpuArch);
868
869 // TODO: There are way too many flags that change this. Do we need to check
870 // them all?
871 bool DAZ = DriverArgs.hasArg(options::OPT_cl_denorms_are_zero) ||
873
874 // Outputs are flushed to zero (FTZ), preserving sign. Denormal inputs are
875 // also implicit treated as zero (DAZ).
876 return DAZ ? llvm::DenormalMode::getPreserveSign() :
877 llvm::DenormalMode::getIEEE();
878}
879
880bool AMDGPUToolChain::isWave64(const llvm::opt::ArgList &DriverArgs,
881 llvm::AMDGPU::GPUKind Kind) {
882 const unsigned ArchAttr = llvm::AMDGPU::getArchAttrAMDGCN(Kind);
883 bool HasWave32 = (ArchAttr & llvm::AMDGPU::FEATURE_WAVE32);
884
885 return !HasWave32 || DriverArgs.hasFlag(
886 options::OPT_mwavefrontsize64, options::OPT_mno_wavefrontsize64, false);
887}
888
890 const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args,
891 BoundArch BA, Action::OffloadKind DeviceOffloadingKind) const {
892 if (DeviceOffloadingKind == Action::OFK_HIP) {
893 CC1Args.append({"-fcuda-is-device", "-fno-threadsafe-statics"});
894
895 if (!DriverArgs.hasFlag(options::OPT_fgpu_rdc, options::OPT_fno_gpu_rdc,
896 false)) {
897 CC1Args.append({"-mllvm", "-amdgpu-internalize-symbols"});
898 if (DriverArgs.hasArgNoClaim(options::OPT_hipstdpar))
899 CC1Args.append({"-mllvm", "-amdgpu-enable-hipstdpar"});
900 }
901 }
902
903 DriverArgs.AddLastArg(CC1Args, options::OPT_gpu_max_threads_per_block_EQ);
904
905 // Default to "hidden" visibility, as object level linking will not be
906 // supported for the foreseeable future.
907 // TODO: remove the SPIR-V bypass once it can encode (hidden) visibility.
908 if (!DriverArgs.hasArg(options::OPT_fvisibility_EQ,
909 options::OPT_fvisibility_ms_compat) &&
910 !getEffectiveTriple().isSPIRV() && !getDriver().IsFlangMode()) {
911 CC1Args.push_back("-fvisibility=hidden");
912 CC1Args.push_back("-fapply-global-visibility-to-externs");
913 }
914
915 if (getEffectiveTriple().isSPIRV()) {
916 // For HIP + SPIRV, embed the command-line into the generated binary
917 if (DeviceOffloadingKind == Action::OFK_HIP &&
918 !DriverArgs.hasArg(options::OPT_fembed_bitcode_marker))
919 CC1Args.push_back("-fembed-bitcode=marker");
920
921 // For SPIR-V we want to retain the pristine output of Clang CodeGen, since
922 // optimizations might lose structure / information that is necessary for
923 // generating optimal concrete AMDGPU code.
924 //
925 // For standalone SPIR-V, use -disable-llvm-optzns
926 // TODO: using the below option is a temporary placeholder until Clang
927 // provides the required functionality, which essentially boils down
928 // to -O0 being refactored / reworked to not imply optnone / remove
929 // TBAA. Once that is added, we should pivot to that functionality,
930 // being mindful to not corrupt the user provided and subsequently
931 // embedded command-line (i.e. if the user asks for -O3 this is what
932 // the finalisation should use).
933 if (!DriverArgs.hasArg(options::OPT_disable_llvm_optzns))
934 CC1Args.push_back("-disable-llvm-optzns");
935
936 return; // No DeviceLibs for SPIR-V.
937 }
938
939 if (DeviceOffloadingKind == Action::OFK_None) {
940 // For the OpenCL case where there is no offload target, accept -nostdlib to
941 // disable bitcode linking.
942 if (DriverArgs.hasArg(options::OPT_nostdlib))
943 return;
944
945 if (addOpenCLBuiltinsLib(getDriver(), getTriple(), DriverArgs, CC1Args))
946 return;
947 }
948
949 if (!DriverArgs.hasFlag(options::OPT_offloadlib, options::OPT_no_offloadlib,
950 true))
951 return;
952
953 // With an LLVM environment, only use libraries provided by the resource
954 // directory.
955 if (getEffectiveTriple().getEnvironment() == llvm::Triple::LLVM)
956 return;
957
958 // Link device libraries for OpenCL, HIP, and OpenMP
959 for (auto BCFile : getDeviceLibs(DriverArgs, BA, DeviceOffloadingKind)) {
960 CC1Args.push_back(BCFile.ShouldInternalize ? "-mlink-builtin-bitcode"
961 : "-mlink-bitcode-file");
962 CC1Args.push_back(DriverArgs.MakeArgStringRef(BCFile.Path));
963 }
964}
965
966void AMDGPUToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {
967 // AMDGPU does not support atomic lib call. Treat atomic alignment
968 // warnings as errors.
969 CC1Args.push_back("-Werror=atomic-alignment");
970}
971
972void AMDGPUToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
973 ArgStringList &CC1Args) const {
974 // In an offloading compilation the device toolchain must pick up the host's
975 // system include paths, even when compiling device code.
976 if (HostTC) {
977 HostTC->AddClangSystemIncludeArgs(DriverArgs, CC1Args);
978 return;
979 }
980
981 if (DriverArgs.hasArg(options::OPT_nostdinc) ||
982 DriverArgs.hasArg(options::OPT_nostdlibinc))
983 return;
984
985 // Add multilib variant include paths in priority order.
986 for (const Multilib &M : getOrderedMultilibs()) {
987 if (M.isDefault())
988 continue;
989 if (std::optional<std::string> StdlibIncDir = getStdlibIncludePath()) {
990 SmallString<128> Dir(*StdlibIncDir);
991 llvm::sys::path::append(Dir, M.includeSuffix());
992 if (getDriver().getVFS().exists(Dir))
993 addSystemInclude(DriverArgs, CC1Args, Dir);
994 }
995 }
996
997 if (std::optional<std::string> Path = getStdlibIncludePath())
998 addSystemInclude(DriverArgs, CC1Args, *Path);
999}
1000
1001StringRef
1002AMDGPUToolChain::getGPUArch(const llvm::opt::ArgList &DriverArgs) const {
1004 getTriple(), DriverArgs.getLastArgValue(options::OPT_mcpu_EQ));
1005}
1006
1008AMDGPUToolChain::getParsedTargetID(const llvm::opt::ArgList &DriverArgs) const {
1009 StringRef TargetID = DriverArgs.getLastArgValue(options::OPT_mcpu_EQ);
1010 if (TargetID.empty())
1011 return {};
1012
1013 llvm::StringMap<bool> FeatureMap;
1014 auto OptionalGpuArch = parseTargetID(getTriple(), TargetID, &FeatureMap);
1015 if (!OptionalGpuArch)
1016 return {TargetID.str(), std::nullopt, std::nullopt};
1017
1018 return {TargetID.str(), OptionalGpuArch->str(), FeatureMap};
1019}
1020
1022AMDGPUToolChain::checkTargetID(const llvm::opt::ArgList &DriverArgs) const {
1023 auto PTID = getParsedTargetID(DriverArgs);
1024 if (PTID.OptionalTargetID && !PTID.OptionalGPUArch) {
1025 getDriver().Diag(clang::diag::err_drv_bad_target_id)
1026 << *PTID.OptionalTargetID;
1027 }
1028 return PTID;
1029}
1030
1032AMDGPUToolChain::getSystemGPUArchs(const ArgList &Args) const {
1033 // Detect AMD GPUs availible on the system.
1034 std::string Program;
1035 if (Arg *A = Args.getLastArg(options::OPT_offload_arch_tool_EQ))
1036 Program = A->getValue();
1037 else
1038 Program = GetProgramPath("amdgpu-arch");
1039
1040 auto StdoutOrErr = getDriver().executeProgram({Program});
1041 if (!StdoutOrErr)
1042 return StdoutOrErr.takeError();
1043
1045 for (StringRef Arch : llvm::split((*StdoutOrErr)->getBuffer(), "\n"))
1046 if (!Arch.empty())
1047 GPUArchs.push_back(Arch.str());
1048
1049 if (GPUArchs.empty())
1050 return llvm::createStringError(std::error_code(),
1051 "No AMD GPU detected in the system");
1052
1053 return std::move(GPUArchs);
1054}
1055
1057 StringRef GPUArch, StringRef LibDeviceFile,
1058 DeviceLibABIVersion ABIVer) const {
1059 if (!hasDeviceLibrary()) {
1060 D.Diag(diag::err_drv_no_rocm_device_lib) << 0;
1061 return false;
1062 }
1063 if (LibDeviceFile.empty()) {
1064 D.Diag(diag::err_drv_no_rocm_device_lib) << 1 << GPUArch;
1065 return false;
1066 }
1067 if (ABIVer.requiresLibrary() && getABIVersionPath(ABIVer).empty()) {
1068 // Starting from COV6, we will report minimum ROCm version requirement in
1069 // the error message.
1070 if (ABIVer.getAsCodeObjectVersion() < 6)
1071 D.Diag(diag::err_drv_no_rocm_device_lib) << 2 << ABIVer.toString() << 0;
1072 else
1073 D.Diag(diag::err_drv_no_rocm_device_lib)
1074 << 2 << ABIVer.toString() << 1 << "6.3";
1075 return false;
1076 }
1077 return true;
1078}
1079
1082 const llvm::opt::ArgList &DriverArgs, StringRef LibDeviceFile,
1083 StringRef GPUArch, const Action::OffloadKind DeviceOffloadingKind,
1084 const bool NeedsASanRT) const {
1086
1087 CommonBitcodeLibsPreferences Pref{D, DriverArgs, GPUArch,
1088 DeviceOffloadingKind, NeedsASanRT};
1089
1090 auto AddBCLib = [&](ToolChain::BitCodeLibraryInfo BCLib,
1091 bool Internalize = true) {
1092 if (!BCLib.Path.empty()) {
1093 BCLib.ShouldInternalize = Internalize;
1094 BCLibs.emplace_back(BCLib);
1095 }
1096 };
1097 auto AddSanBCLibs = [&]() {
1098 if (Pref.GPUSan)
1099 AddBCLib(getAsanRTLPath(), false);
1100 };
1101
1102 AddSanBCLibs();
1103 AddBCLib(getOCMLPath());
1104 if (!Pref.IsOpenMP)
1105 AddBCLib(getOCKLPath());
1106 else if (Pref.GPUSan && Pref.IsOpenMP)
1107 AddBCLib(getOCKLPath());
1108 AddBCLib(getUnsafeMathPath(Pref.UnsafeMathOpt || Pref.FastRelaxedMath));
1109 AddBCLib(getFiniteOnlyPath(Pref.FiniteOnly || Pref.FastRelaxedMath));
1110 AddBCLib(getWavefrontSize64Path(Pref.Wave64));
1111 AddBCLib(LibDeviceFile);
1112 auto ABIVerPath = getABIVersionPath(Pref.ABIVer);
1113 if (!ABIVerPath.empty())
1114 AddBCLib(ABIVerPath);
1115
1116 return BCLibs;
1117}
1118
1121 const llvm::opt::ArgList &DriverArgs, llvm::StringRef TargetID,
1122 llvm::StringRef GPUArch, Action::OffloadKind DeviceOffloadingKind) const {
1123 auto Kind = llvm::AMDGPU::parseArchAMDGCN(GPUArch);
1124 const StringRef CanonArch = llvm::AMDGPU::getArchNameAMDGCN(Kind);
1125
1126 StringRef LibDeviceFile = RocmInstallation->getLibDeviceFile(CanonArch);
1128 getAMDGPUCodeObjectVersion(getDriver(), DriverArgs));
1129 if (!RocmInstallation->checkCommonBitcodeLibs(CanonArch, LibDeviceFile,
1130 ABIVer))
1131 return {};
1132
1133 return RocmInstallation->getCommonBitcodeLibs(
1134 DriverArgs, LibDeviceFile, GPUArch, DeviceOffloadingKind,
1135 getSanitizerArgs(DriverArgs, BoundArch(TargetID), DeviceOffloadingKind)
1136 .needsAsanRt());
1137}
1138
1140AMDGPUToolChain::getDeviceLibs(const llvm::opt::ArgList &DriverArgs,
1141 BoundArch BA,
1142 Action::OffloadKind DeviceOffloadKind) const {
1143 assert(getEffectiveTriple().isAMDGPU() &&
1144 "spirv should not try to link device libs");
1145
1146 if (!DriverArgs.hasFlag(options::OPT_offloadlib, options::OPT_no_offloadlib,
1147 true) ||
1148 getEffectiveTriple().getEnvironment() == llvm::Triple::LLVM)
1149 return {};
1150
1151 if (getTriple().getOS() != llvm::Triple::AMDHSA)
1152 return {};
1153
1154 StringRef GpuArch;
1155 StringRef TargetID;
1156 if (DeviceOffloadKind == Action::OFK_None) {
1157 TargetID = DriverArgs.getLastArgValue(options::OPT_mcpu_EQ);
1158 GpuArch = getProcessorFromTargetID(getTriple(), TargetID);
1159 } else {
1160 TargetID = BA.ArchName;
1162 }
1163
1165
1166 // HIP-specific handling
1167 if (DeviceOffloadKind == Action::OFK_HIP) {
1168 // Handle --hip-device-lib manual override
1169 auto BCLibArgs = DriverArgs.getAllArgValues(options::OPT_hip_device_lib_EQ);
1170 if (!BCLibArgs.empty()) {
1171 ArgStringList LibraryPaths;
1172 for (StringRef Path : RocmInstallation->getRocmDeviceLibPathArg())
1173 LibraryPaths.push_back(DriverArgs.MakeArgStringRef(Path));
1174 addDirectoryList(DriverArgs, LibraryPaths, "", "HIP_DEVICE_LIB_PATH");
1175
1176 for (StringRef BCName : BCLibArgs) {
1177 bool Found = false;
1178 for (StringRef LibraryPath : LibraryPaths) {
1179 SmallString<128> Path(LibraryPath);
1180 llvm::sys::path::append(Path, BCName);
1181 if (llvm::sys::fs::exists(Path)) {
1182 BCLibs.emplace_back(Path);
1183 Found = true;
1184 break;
1185 }
1186 }
1187 if (!Found)
1188 getDriver().Diag(diag::err_drv_no_such_file) << BCName;
1189 }
1190 return BCLibs;
1191 }
1192
1193 if (!RocmInstallation->hasDeviceLibrary()) {
1194 getDriver().Diag(diag::err_drv_no_rocm_device_lib) << 0;
1195 return {};
1196 }
1197
1198 // Add common device libraries
1199 for (auto N : getCommonDeviceLibNames(DriverArgs, TargetID, GpuArch,
1200 DeviceOffloadKind))
1201 BCLibs.emplace_back(N);
1202
1203 // Add instrument lib for HIP
1204 auto InstLib =
1205 DriverArgs.getLastArgValue(options::OPT_gpu_instrument_lib_EQ);
1206 if (!InstLib.empty()) {
1207 if (llvm::sys::fs::exists(InstLib))
1208 BCLibs.emplace_back(InstLib);
1209 else
1210 getDriver().Diag(diag::err_drv_no_such_file) << InstLib;
1211 }
1212
1213 return BCLibs;
1214 }
1215
1216 // OpenMP handling
1217 if (DeviceOffloadKind == Action::OFK_OpenMP) {
1218 for (auto BCLib : getCommonDeviceLibNames(DriverArgs, TargetID, GpuArch,
1219 DeviceOffloadKind))
1220 BCLibs.emplace_back(BCLib);
1221 return BCLibs;
1222 }
1223
1224 // The libraries are currently only built for amdhsa.
1225 if (getTriple().getOS() != llvm::Triple::AMDHSA)
1226 return {};
1227
1228 // Only link device libraries if requested (set by Driver based on input type)
1230 return {};
1231
1232 StringRef LibDeviceFile = RocmInstallation->getLibDeviceFile(GpuArch);
1233
1235 getAMDGPUCodeObjectVersion(getDriver(), DriverArgs));
1236 if (!RocmInstallation->checkCommonBitcodeLibs(GpuArch, LibDeviceFile, ABIVer))
1237 return {};
1238
1239 // Add the OpenCL specific bitcode library
1240 BCLibs.emplace_back(RocmInstallation->getOpenCLPath().str());
1241
1242 // Add the generic set of libraries
1243 BCLibs.append(RocmInstallation->getCommonBitcodeLibs(
1244 DriverArgs, LibDeviceFile, GpuArch, DeviceOffloadKind,
1245 getSanitizerArgs(DriverArgs, BoundArch{TargetID}, DeviceOffloadKind)
1246 .needsAsanRt()));
1247
1248 return BCLibs;
1249}
1250
1252AMDGPUToolChain::GetCXXStdlibType(const ArgList &Args) const {
1253 if (HostTC)
1254 return HostTC->GetCXXStdlibType(Args);
1255 return ToolChain::GetCXXStdlibType(Args);
1256}
1257
1259 const ArgList &Args, ArgStringList &CC1Args) const {
1260 if (HostTC)
1261 HostTC->AddClangCXXStdlibIncludeArgs(Args, CC1Args);
1262 else
1264}
1265
1267 ArgStringList &CC1Args) const {
1268 if (HostTC)
1269 HostTC->AddIAMCUIncludeArgs(Args, CC1Args);
1270}
1271
1272void AMDGPUToolChain::AddHIPIncludeArgs(const ArgList &DriverArgs,
1273 ArgStringList &CC1Args) const {
1274 if (getTriple().getEnvironment() == llvm::Triple::LLVM) {
1275 if (DriverArgs.hasFlag(options::OPT_offload_inc,
1276 options::OPT_no_offload_inc, true) &&
1277 !DriverArgs.hasArg(options::OPT_nohipwrapperinc) &&
1278 !DriverArgs.hasArg(options::OPT_nobuiltininc))
1279 CC1Args.append({"-include", "__clang_gpu_device_functions.h"});
1280 return;
1281 }
1282
1283 RocmInstallation->AddHIPIncludeArgs(DriverArgs, CC1Args);
1284}
1285
1287 const ArgList &Args) const {
1288 if (HostTC)
1289 return HostTC->computeMSVCVersion(D, Args);
1290 return ToolChain::computeMSVCVersion(D, Args);
1291}
1292
1294 // Offload toolchains use full LTO by default.
1295 return HostTC == nullptr ? LTOK_None : LTOK_Full;
1296}
1297
1299 Action::OffloadKind Kind) const {
1300 if (getTriple().isAMDGCN() && getDriver().offloadDeviceOnly() &&
1301 !Args.hasFlag(options::OPT_fgpu_rdc, options::OPT_fno_gpu_rdc, false) &&
1302 !Args.hasArg(options::OPT_foffload_lto, options::OPT_foffload_lto_EQ))
1303 return LTOK_None;
1304 return ToolChain::getLTOMode(Args, Kind);
1305}
1306
1307static bool isXnackAvailable(const llvm::Triple &TT, llvm::StringRef TargetID) {
1308 // Arch-specific check - only report as supported if arch has xnack+
1309 if (!TT.isAMDGCN())
1310 return false;
1311 llvm::StringRef Processor = getProcessorFromTargetID(TT, TargetID);
1312 llvm::AMDGPU::GPUKind ProcKind = llvm::AMDGPU::parseArchAMDGCN(Processor);
1313 unsigned Features = llvm::AMDGPU::getArchAttrAMDGCN(ProcKind);
1314
1315 // If processor has xnack but doesn't support on/off modes, xnack is always on
1316 bool XnackAlwaysOn = (Features & llvm::AMDGPU::FEATURE_XNACK) &&
1317 !(Features & llvm::AMDGPU::FEATURE_XNACK_ON_OFF_MODES);
1318 if (XnackAlwaysOn)
1319 return true;
1320
1321 // Otherwise, check if xnack+ is explicitly enabled in the target ID
1322 llvm::StringMap<bool> FeatureMap;
1323 auto OptionalGpuArch = parseTargetID(TT, TargetID, &FeatureMap);
1324 if (!OptionalGpuArch)
1325 return false;
1326 auto Loc = FeatureMap.find("xnack");
1327 return (Loc != FeatureMap.end() && Loc->second);
1328}
1329
1331 BoundArch BA, Action::OffloadKind DeviceOffloadKind) const {
1332 SanitizerMask SupportedMask =
1333 ToolChain::getSupportedSanitizers(BA, DeviceOffloadKind);
1334
1335 // Address sanitizer is potentially supported, but depends on the exact target
1336 // arch xnack support.
1337 if (!BA || isXnackAvailable(getTriple(), BA.ArchName))
1338 SupportedMask |= SanitizerKind::Address;
1339
1340 return SupportedMask;
1341}
1342
1344 BoundArch BA) const {
1345 // Address sanitizer requires xnack+ feature
1346 if ((Kinds & SanitizerKind::Address) && BA &&
1348 return "xnack+";
1349 }
1350 return "";
1351}
#define V(N, I)
static bool isXnackAvailable(const llvm::Triple &TT, llvm::StringRef TargetID)
Definition AMDGPU.cpp:1307
static StringRef getTriple(const Command &Job)
static void Append(char *Start, char *End, char *&Buffer, unsigned &BufferSize, unsigned &BufferCapacity)
BoundArch getOffloadingArch() const
Definition Action.h:217
OffloadKind getOffloadingDeviceKind() const
Definition Action.h:216
Compilation - A set of tasks to perform for a single driver invocation.
Definition Compilation.h:46
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition Driver.h:95
llvm::Expected< std::unique_ptr< llvm::MemoryBuffer > > executeProgram(llvm::ArrayRef< llvm::StringRef > Args) const
Definition Driver.cpp:415
DiagnosticBuilder Diag(unsigned DiagID) const
Definition Driver.h:159
const llvm::opt::OptTable & getOpts() const
Definition Driver.h:407
InputInfo - Wrapper for information about an input source.
Definition InputInfo.h:22
const char * getFilename() const
Definition InputInfo.h:83
This corresponds to a single GCC Multilib, or a segment of one controlled by a command line flag.
Definition Multilib.h:35
StringRef getIncludePath() const
Get the detected path to Rocm's bin directory.
StringRef getAsanRTLPath() const
Returns empty string of Asan runtime library is not available.
RocmInstallationDetector(const Driver &D, const llvm::Triple &HostTriple, const llvm::opt::ArgList &Args, bool DetectHIPRuntime=true)
Definition AMDGPU.cpp:316
bool hasDeviceLibrary() const
Check whether we detected a valid ROCm device library.
bool checkCommonBitcodeLibs(StringRef GPUArch, StringRef LibDeviceFile, DeviceLibABIVersion ABIVer) const
Check file paths of default bitcode libraries common to AMDGPU based toolchains.
Definition AMDGPU.cpp:1056
bool hasHIPStdParLibrary() const
Check whether we detected a valid HIP STDPAR Acceleration library.
StringRef getABIVersionPath(DeviceLibABIVersion ABIVer) const
llvm::SmallVector< ToolChain::BitCodeLibraryInfo, 12 > getCommonBitcodeLibs(const llvm::opt::ArgList &DriverArgs, StringRef LibDeviceFile, StringRef GPUArch, const Action::OffloadKind DeviceOffloadingKind, const bool NeedsASanRT) const
Get file paths of default bitcode libraries common to AMDGPU based toolchains.
Definition AMDGPU.cpp:1081
bool hasHIPRuntime() const
Check whether we detected a valid HIP runtime.
void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
Definition AMDGPU.cpp:512
StringRef getWavefrontSize64Path(bool Enabled) const
void print(raw_ostream &OS) const
Print information about the detected ROCm installation.
Definition AMDGPU.cpp:506
static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory to CC1 arguments.
StringRef getOS() const
Definition ToolChain.h:305
virtual SanitizerMask getSupportedSanitizers(BoundArch BA, Action::OffloadKind DeviceOffloadKind) const
Return sanitizers which are available in this toolchain.
const Driver & getDriver() const
Definition ToolChain.h:286
llvm::vfs::FileSystem & getVFS() const
ToolChain(const Driver &D, const llvm::Triple &T, const llvm::opt::ArgList &Args)
Definition ToolChain.cpp:91
virtual llvm::opt::DerivedArgList * TranslateArgs(const llvm::opt::DerivedArgList &Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const
TranslateArgs - Create a new derived argument list for any argument translations this ToolChain may w...
Definition ToolChain.h:401
virtual LTOKind getLTOMode(const llvm::opt::ArgList &Args, Action::OffloadKind Kind=Action::OFK_None) const
Resolve the requested LTO mode for this toolchain.
const llvm::Triple & getEffectiveTriple() const
Get the toolchain's effective clang triple.
Definition ToolChain.h:314
const llvm::Triple & getTriple() const
Definition ToolChain.h:288
OrderedMultilibs getOrderedMultilibs() const
Get selected multilibs in priority order with default fallback.
std::string GetProgramPath(const char *Name) const
virtual void AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for...
virtual VersionTuple computeMSVCVersion(const Driver *D, const llvm::opt::ArgList &Args) const
On Windows, returns the MSVC compatibility version.
std::optional< std::string > getStdlibIncludePath() const
virtual CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const
SanitizerArgs getSanitizerArgs(const llvm::opt::ArgList &JobArgs, BoundArch BA={}, Action::OffloadKind DeviceOffloadKind=Action::OFK_None) const
StringRef getArchName() const
Definition ToolChain.h:303
Tool - Information on a specific compilation tool.
Definition Tool.h:32
const ToolChain & getToolChain() const
Definition Tool.h:52
llvm::opt::DerivedArgList * TranslateArgs(const llvm::opt::DerivedArgList &Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
TranslateArgs - Create a new derived argument list for any argument translations this ToolChain may w...
Definition AMDGPU.cpp:728
llvm::DenormalMode getDefaultDenormalModeForType(const llvm::opt::ArgList &DriverArgs, const JobAction &JA, const llvm::fltSemantics *FPType=nullptr) const override
Returns the output denormal handling type in the default floating point environment for the given FPT...
Definition AMDGPU.cpp:844
static bool getDefaultDenormsAreZeroForTarget(llvm::AMDGPU::GPUKind GPUKind)
Return whether denormals should be flushed, and treated as 0 by default for the subtarget.
Definition AMDGPU.cpp:827
StringRef getGPUArch(const llvm::opt::ArgList &DriverArgs) const
Get GPU arch from -mcpu without checking.
Definition AMDGPU.cpp:1002
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Add options that need to be passed to cc1 for this target.
Definition AMDGPU.cpp:889
const std::map< options::ID, StringRef > OptionsDefault
Definition AMDGPU.h:54
const bool UseHIPLinker
FIXME: Should merge 2 linkers.
Definition AMDGPU.h:60
Tool * buildLinker() const override
Definition AMDGPU.cpp:720
VersionTuple computeMSVCVersion(const Driver *D, const llvm::opt::ArgList &Args) const override
On Windows, returns the MSVC compatibility version.
Definition AMDGPU.cpp:1286
virtual ParsedTargetIDType checkTargetID(const llvm::opt::ArgList &DriverArgs) const
Check and diagnose invalid target ID specified by -mcpu.
Definition AMDGPU.cpp:1022
AMDGPUToolChain(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, const ToolChain *HostTC=nullptr, Action::OffloadKind Kind=Action::OFK_None, bool ShouldLinkDeviceLibs=false)
AMDGPU Toolchain.
Definition AMDGPU.cpp:695
static bool isWave64(const llvm::opt::ArgList &DriverArgs, llvm::AMDGPU::GPUKind Kind)
Definition AMDGPU.cpp:880
LTOKind getLTOMode(const llvm::opt::ArgList &Args, Action::OffloadKind Kind=Action::OFK_None) const override
We need to adjust the LTO mode based on user arguments.
Definition AMDGPU.cpp:1298
void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override
Common warning options shared by AMDGPU HIP, OpenCL and OpenMP toolchains.
Definition AMDGPU.cpp:966
void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add arguments to use MCU GCC toolchain includes.
Definition AMDGPU.cpp:1266
void AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CC1Args) const override
AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for...
Definition AMDGPU.cpp:1258
ParsedTargetIDType getParsedTargetID(const llvm::opt::ArgList &DriverArgs) const
Get target ID, GPU arch, and target ID features if the target ID is specified and valid.
Definition AMDGPU.cpp:1008
CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override
Definition AMDGPU.cpp:1252
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition AMDGPU.cpp:972
SanitizerMask getSupportedSanitizers(BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Return sanitizers which are available in this toolchain.
Definition AMDGPU.cpp:1330
void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add arguments to use system-specific HIP includes.
Definition AMDGPU.cpp:1272
StringRef getSanitizerRequirement(SanitizerMask Kinds, BoundArch BA) const override
Returns the feature requirement for a sanitizer on a specific arch for diagnostic purposes.
Definition AMDGPU.cpp:1343
StringRef getOptionDefault(options::ID OptID) const
Definition AMDGPU.h:67
llvm::SmallVector< BitCodeLibraryInfo, 12 > getCommonDeviceLibNames(const llvm::opt::ArgList &DriverArgs, llvm::StringRef TargetID, llvm::StringRef GPUArch, Action::OffloadKind DeviceOffloadingKind) const
Definition AMDGPU.cpp:1120
virtual Expected< SmallVector< std::string > > getSystemGPUArchs(const llvm::opt::ArgList &Args) const override
Uses amdgpu-arch tool to get arch of the system GPU.
Definition AMDGPU.cpp:1032
LTOKind getDefaultLTOMode() const override
Returns the default LTO mode for this toolchain.
Definition AMDGPU.cpp:1293
llvm::SmallVector< BitCodeLibraryInfo, 12 > getDeviceLibs(const llvm::opt::ArgList &Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Get paths for device libraries.
Definition AMDGPU.cpp:1140
Generic_ELF(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition Gnu.h:439
LazyDetector< RocmInstallationDetector > RocmInstallation
Definition Gnu.h:359
Linker(const ToolChain &TC)
Definition AMDGPU.h:31
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition AMDGPU.cpp:602
AMDGPU builtins.
void getAMDGPUTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, bool ForAS=false)
Definition AMDGPU.cpp:661
void handleTargetFeaturesGroup(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier Group)
Iterate Args and convert -mxxx to +xxx and -mno-xxx to -xxx and append it to Features.
void checkAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output, const InputInfoList &Inputs, bool IsThinLTO)
void addDirectoryList(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const char *ArgName, const char *EnvVar)
EnvVar is split by system delimiter for environment variables.
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void addLinkerCompressDebugSectionsOption(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
unsigned getAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
bool addOpenCLBuiltinsLib(const Driver &D, const llvm::Triple &TT, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args)
Try to link libclc, depending on the target ABI and command line arguments.
LTOKind
Describes the kind of LTO mode selected via -f(no-)?lto(=.*)? options.
Definition Driver.h:59
SmallVector< InputInfo, 4 > InputInfoList
Definition Driver.h:51
The JSON file list parser is used to communicate input to InstallAPI.
if(T->getSizeExpr()) TRY_TO(TraverseStmt(const_cast< Expr * >(T -> getSizeExpr())))
std::optional< llvm::StringRef > parseTargetID(const llvm::Triple &T, llvm::StringRef OffloadArch, llvm::StringMap< bool > *FeatureMap)
Parse a target ID to get processor and feature map.
Definition TargetID.cpp:109
llvm::StringRef getProcessorFromTargetID(const llvm::Triple &T, llvm::StringRef OffloadArch)
Get processor name from target ID.
Definition TargetID.cpp:58
Diagnostic wrappers for TextAPI types for error reporting.
Definition Dominators.h:30
Represents a bound architecture for offload / multiple architecture compilation.
llvm::StringRef ArchName
bool empty() const
static DeviceLibABIVersion fromCodeObjectVersion(unsigned CodeObjectVersion)
bool requiresLibrary()
Whether ABI version bc file is requested.
static constexpr ResponseFileSupport AtFileCurCP()
Definition Job.h:93
The struct type returned by getParsedTargetID.
Definition AMDGPU.h:165
std::optional< llvm::StringMap< bool > > OptionalFeatureMap
Definition AMDGPU.h:168