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 "CommonArgs.h"
11#include "HIPUtility.h"
12#include "clang/Driver/Compilation.h"
13#include "clang/Driver/Driver.h"
14#include "clang/Driver/DriverDiagnostic.h"
15#include "clang/Driver/InputInfo.h"
16#include "clang/Driver/Options.h"
17#include "llvm/Support/FileSystem.h"
18#include "llvm/Support/Path.h"
19
20using namespace clang::driver;
21using namespace clang::driver::toolchains;
22using namespace clang::driver::tools;
23using namespace clang;
24using namespace llvm::opt;
25
26// Convenience function for creating temporary file for both modes of
27// isSaveTempsEnabled().
28static const char *getTempFile(Compilation &C, StringRef Prefix,
29                               StringRef Extension) {
30  if (C.getDriver().isSaveTempsEnabled()) {
31    return C.getArgs().MakeArgString(Prefix + "." + Extension);
32  }
33  auto TmpFile = C.getDriver().GetTemporaryPath(Prefix, Extension);
34  return C.addTempFile(C.getArgs().MakeArgString(TmpFile));
35}
36
37// Locates HIP pass plugin.
38static std::string findPassPlugin(const Driver &D,
39                                  const llvm::opt::ArgList &Args) {
40  StringRef Path = Args.getLastArgValue(options::OPT_hipspv_pass_plugin_EQ);
41  if (!Path.empty()) {
42    if (llvm::sys::fs::exists(Path))
43      return Path.str();
44    D.Diag(diag::err_drv_no_such_file) << Path;
45  }
46
47  StringRef hipPath = Args.getLastArgValue(options::OPT_hip_path_EQ);
48  if (!hipPath.empty()) {
49    SmallString<128> PluginPath(hipPath);
50    llvm::sys::path::append(PluginPath, "lib", "libLLVMHipSpvPasses.so");
51    if (llvm::sys::fs::exists(PluginPath))
52      return PluginPath.str().str();
53    PluginPath.assign(hipPath);
54    llvm::sys::path::append(PluginPath, "lib", "llvm",
55                            "libLLVMHipSpvPasses.so");
56    if (llvm::sys::fs::exists(PluginPath))
57      return PluginPath.str().str();
58  }
59
60  return std::string();
61}
62
63void HIPSPV::Linker::constructLinkAndEmitSpirvCommand(
64    Compilation &C, const JobAction &JA, const InputInfoList &Inputs,
65    const InputInfo &Output, const llvm::opt::ArgList &Args) const {
66
67  assert(!Inputs.empty() && "Must have at least one input.");
68  std::string Name = std::string(llvm::sys::path::stem(Output.getFilename()));
69  const char *TempFile = getTempFile(C, Name + "-link", "bc");
70
71  // Link LLVM bitcode.
72  ArgStringList LinkArgs{};
73  for (auto Input : Inputs)
74    LinkArgs.push_back(Input.getFilename());
75  LinkArgs.append({"-o", TempFile});
76  const char *LlvmLink =
77      Args.MakeArgString(getToolChain().GetProgramPath("llvm-link"));
78  C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
79                                         LlvmLink, LinkArgs, Inputs, Output));
80
81  // Post-link HIP lowering.
82
83  // Run LLVM IR passes to lower/expand/emulate HIP code that does not translate
84  // to SPIR-V (E.g. dynamic shared memory).
85  auto PassPluginPath = findPassPlugin(C.getDriver(), Args);
86  if (!PassPluginPath.empty()) {
87    const char *PassPathCStr = C.getArgs().MakeArgString(PassPluginPath);
88    const char *OptOutput = getTempFile(C, Name + "-lower", "bc");
89    ArgStringList OptArgs{TempFile,     "-load-pass-plugin",
90                          PassPathCStr, "-passes=hip-post-link-passes",
91                          "-o",         OptOutput};
92    const char *Opt = Args.MakeArgString(getToolChain().GetProgramPath("opt"));
93    C.addCommand(std::make_unique<Command>(
94        JA, *this, ResponseFileSupport::None(), Opt, OptArgs, Inputs, Output));
95    TempFile = OptOutput;
96  }
97
98  // Emit SPIR-V binary.
99
100  llvm::opt::ArgStringList TrArgs{"--spirv-max-version=1.1",
101                                  "--spirv-ext=+all"};
102  InputInfo TrInput = InputInfo(types::TY_LLVM_BC, TempFile, "");
103  SPIRV::constructTranslateCommand(C, *this, JA, Output, TrInput, TrArgs);
104}
105
106void HIPSPV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
107                                  const InputInfo &Output,
108                                  const InputInfoList &Inputs,
109                                  const ArgList &Args,
110                                  const char *LinkingOutput) const {
111  if (Inputs.size() > 0 && Inputs[0].getType() == types::TY_Image &&
112      JA.getType() == types::TY_Object)
113    return HIP::constructGenerateObjFileFromHIPFatBinary(C, Output, Inputs,
114                                                         Args, JA, *this);
115
116  if (JA.getType() == types::TY_HIP_FATBIN)
117    return HIP::constructHIPFatbinCommand(C, JA, Output.getFilename(), Inputs,
118                                          Args, *this);
119
120  constructLinkAndEmitSpirvCommand(C, JA, Inputs, Output, Args);
121}
122
123HIPSPVToolChain::HIPSPVToolChain(const Driver &D, const llvm::Triple &Triple,
124                                 const ToolChain &HostTC, const ArgList &Args)
125    : ToolChain(D, Triple, Args), HostTC(HostTC) {
126  // Lookup binaries into the driver directory, this is used to
127  // discover the clang-offload-bundler executable.
128  getProgramPaths().push_back(getDriver().Dir);
129}
130
131void HIPSPVToolChain::addClangTargetOptions(
132    const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args,
133    Action::OffloadKind DeviceOffloadingKind) const {
134  HostTC.addClangTargetOptions(DriverArgs, CC1Args, DeviceOffloadingKind);
135
136  assert(DeviceOffloadingKind == Action::OFK_HIP &&
137         "Only HIP offloading kinds are supported for GPUs.");
138
139  CC1Args.append(
140      {"-fcuda-is-device", "-fcuda-allow-variadic-functions",
141       // A crude workaround for llvm-spirv which does not handle the
142       // autovectorized code well (vector reductions, non-i{8,16,32,64} types).
143       // TODO: Allow autovectorization when SPIR-V backend arrives.
144       "-mllvm", "-vectorize-loops=false", "-mllvm", "-vectorize-slp=false"});
145
146  // Default to "hidden" visibility, as object level linking will not be
147  // supported for the foreseeable future.
148  if (!DriverArgs.hasArg(options::OPT_fvisibility_EQ,
149                         options::OPT_fvisibility_ms_compat))
150    CC1Args.append(
151        {"-fvisibility=hidden", "-fapply-global-visibility-to-externs"});
152
153  llvm::for_each(getDeviceLibs(DriverArgs),
154                 [&](const BitCodeLibraryInfo &BCFile) {
155                   CC1Args.append({"-mlink-builtin-bitcode",
156                                   DriverArgs.MakeArgString(BCFile.Path)});
157                 });
158}
159
160Tool *HIPSPVToolChain::buildLinker() const {
161  assert(getTriple().getArch() == llvm::Triple::spirv64);
162  return new tools::HIPSPV::Linker(*this);
163}
164
165void HIPSPVToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {
166  HostTC.addClangWarningOptions(CC1Args);
167}
168
169ToolChain::CXXStdlibType
170HIPSPVToolChain::GetCXXStdlibType(const ArgList &Args) const {
171  return HostTC.GetCXXStdlibType(Args);
172}
173
174void HIPSPVToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
175                                                ArgStringList &CC1Args) const {
176  HostTC.AddClangSystemIncludeArgs(DriverArgs, CC1Args);
177}
178
179void HIPSPVToolChain::AddClangCXXStdlibIncludeArgs(
180    const ArgList &Args, ArgStringList &CC1Args) const {
181  HostTC.AddClangCXXStdlibIncludeArgs(Args, CC1Args);
182}
183
184void HIPSPVToolChain::AddIAMCUIncludeArgs(const ArgList &Args,
185                                          ArgStringList &CC1Args) const {
186  HostTC.AddIAMCUIncludeArgs(Args, CC1Args);
187}
188
189void HIPSPVToolChain::AddHIPIncludeArgs(const ArgList &DriverArgs,
190                                        ArgStringList &CC1Args) const {
191  if (DriverArgs.hasArg(options::OPT_nogpuinc))
192    return;
193
194  StringRef hipPath = DriverArgs.getLastArgValue(options::OPT_hip_path_EQ);
195  if (hipPath.empty()) {
196    getDriver().Diag(diag::err_drv_hipspv_no_hip_path) << 1 << "'-nogpuinc'";
197    return;
198  }
199  SmallString<128> P(hipPath);
200  llvm::sys::path::append(P, "include");
201  CC1Args.append({"-isystem", DriverArgs.MakeArgString(P)});
202}
203
204llvm::SmallVector<ToolChain::BitCodeLibraryInfo, 12>
205HIPSPVToolChain::getDeviceLibs(const llvm::opt::ArgList &DriverArgs) const {
206  llvm::SmallVector<ToolChain::BitCodeLibraryInfo, 12> BCLibs;
207  if (DriverArgs.hasArg(options::OPT_nogpulib))
208    return {};
209
210  ArgStringList LibraryPaths;
211  // Find device libraries in --hip-device-lib-path and HIP_DEVICE_LIB_PATH.
212  auto HipDeviceLibPathArgs = DriverArgs.getAllArgValues(
213      // --hip-device-lib-path is alias to this option.
214      clang::driver::options::OPT_rocm_device_lib_path_EQ);
215  for (auto Path : HipDeviceLibPathArgs)
216    LibraryPaths.push_back(DriverArgs.MakeArgString(Path));
217
218  StringRef HipPath = DriverArgs.getLastArgValue(options::OPT_hip_path_EQ);
219  if (!HipPath.empty()) {
220    SmallString<128> Path(HipPath);
221    llvm::sys::path::append(Path, "lib", "hip-device-lib");
222    LibraryPaths.push_back(DriverArgs.MakeArgString(Path));
223  }
224
225  addDirectoryList(DriverArgs, LibraryPaths, "", "HIP_DEVICE_LIB_PATH");
226
227  // Maintain compatability with --hip-device-lib.
228  auto BCLibArgs = DriverArgs.getAllArgValues(options::OPT_hip_device_lib_EQ);
229  if (!BCLibArgs.empty()) {
230    llvm::for_each(BCLibArgs, [&](StringRef BCName) {
231      StringRef FullName;
232      for (std::string LibraryPath : LibraryPaths) {
233        SmallString<128> Path(LibraryPath);
234        llvm::sys::path::append(Path, BCName);
235        FullName = Path;
236        if (llvm::sys::fs::exists(FullName)) {
237          BCLibs.emplace_back(FullName.str());
238          return;
239        }
240      }
241      getDriver().Diag(diag::err_drv_no_such_file) << BCName;
242    });
243  } else {
244    // Search device library named as 'hipspv-<triple>.bc'.
245    auto TT = getTriple().normalize();
246    std::string BCName = "hipspv-" + TT + ".bc";
247    for (auto *LibPath : LibraryPaths) {
248      SmallString<128> Path(LibPath);
249      llvm::sys::path::append(Path, BCName);
250      if (llvm::sys::fs::exists(Path)) {
251        BCLibs.emplace_back(Path.str().str());
252        return BCLibs;
253      }
254    }
255    getDriver().Diag(diag::err_drv_no_hipspv_device_lib)
256        << 1 << ("'" + TT + "' target");
257    return {};
258  }
259
260  return BCLibs;
261}
262
263SanitizerMask HIPSPVToolChain::getSupportedSanitizers() const {
264  // The HIPSPVToolChain only supports sanitizers in the sense that it allows
265  // sanitizer arguments on the command line if they are supported by the host
266  // toolchain. The HIPSPVToolChain will actually ignore any command line
267  // arguments for any of these "supported" sanitizers. That means that no
268  // sanitization of device code is actually supported at this time.
269  //
270  // This behavior is necessary because the host and device toolchains
271  // invocations often share the command line, so the device toolchain must
272  // tolerate flags meant only for the host toolchain.
273  return HostTC.getSupportedSanitizers();
274}
275
276VersionTuple HIPSPVToolChain::computeMSVCVersion(const Driver *D,
277                                                 const ArgList &Args) const {
278  return HostTC.computeMSVCVersion(D, Args);
279}
280
281void HIPSPVToolChain::adjustDebugInfoKind(
282    llvm::codegenoptions::DebugInfoKind &DebugInfoKind,
283    const llvm::opt::ArgList &Args) const {
284  // Debug info generation is disabled for SPIRV-LLVM-Translator
285  // which currently aborts on the presence of DW_OP_LLVM_convert.
286  // TODO: Enable debug info when the SPIR-V backend arrives.
287  DebugInfoKind = llvm::codegenoptions::NoDebugInfo;
288}
289