1//===--- AMDGPU.h - 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#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_AMDGPU_H
10#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_AMDGPU_H
11
12#include "Gnu.h"
13#include "clang/Basic/TargetID.h"
14#include "clang/Driver/Tool.h"
15#include "clang/Driver/ToolChain.h"
16#include "clang/Options/Options.h"
17#include "llvm/ADT/SmallString.h"
18#include "llvm/TargetParser/AMDGPUTargetParser.h"
19
20#include <map>
21#include <string>
22
23namespace clang {
24namespace driver {
25
26namespace tools {
27namespace amdgpu {
28
29class LLVM_LIBRARY_VISIBILITY Linker final : public Tool {
30public:
31 Linker(const ToolChain &TC) : Tool("amdgpu::Linker", "ld.lld", TC) {}
32 bool isLinkJob() const override { return true; }
33 bool hasIntegratedCPP() const override { return false; }
34 void ConstructJob(Compilation &C, const JobAction &JA,
35 const InputInfo &Output, const InputInfoList &Inputs,
36 const llvm::opt::ArgList &TCArgs,
37 const char *LinkingOutput) const override;
38};
39
40void getAMDGPUTargetFeatures(const Driver &D, const llvm::Triple &Triple,
41 const llvm::opt::ArgList &Args,
42 std::vector<StringRef> &Features);
43
44void addFullLTOPartitionOption(const Driver &D, const llvm::opt::ArgList &Args,
45 llvm::opt::ArgStringList &CmdArgs);
46} // end namespace amdgpu
47} // end namespace tools
48
49namespace toolchains {
50
51class LLVM_LIBRARY_VISIBILITY AMDGPUToolChain : public Generic_ELF {
52protected:
53 const std::map<options::ID, StringRef> OptionsDefault;
54
55 // Optional host toolchain for offloading modes.
56 const ToolChain *HostTC = nullptr;
57
58 /// FIXME: Should merge 2 linkers.
59 const bool UseHIPLinker = false;
60
61 // Whether to link device libraries (for standalone OpenCL/LLVM IR
62 // compilation)
63 bool ShouldLinkDeviceLibs = false;
64
65 Tool *buildLinker() const override;
66 StringRef getOptionDefault(options::ID OptID) const {
67 auto opt = OptionsDefault.find(x: OptID);
68 assert(opt != OptionsDefault.end() && "No Default for Option");
69 return opt->second;
70 }
71
72public:
73 AMDGPUToolChain(const Driver &D, const llvm::Triple &Triple,
74 const llvm::opt::ArgList &Args,
75 const ToolChain *HostTC = nullptr,
76 Action::OffloadKind Kind = Action::OFK_None,
77 bool ShouldLinkDeviceLibs = false);
78 unsigned GetDefaultDwarfVersion() const override { return 5; }
79
80 bool IsMathErrnoDefault() const override { return false; }
81 bool isCrossCompiling() const override { return true; }
82 bool isPICDefault() const override { return true; }
83 bool isPIEDefault(const llvm::opt::ArgList &Args) const override {
84 return false;
85 }
86 bool isPICDefaultForced() const override { return true; }
87 bool SupportsProfiling() const override { return false; }
88
89 llvm::opt::DerivedArgList *
90 TranslateArgs(const llvm::opt::DerivedArgList &Args, BoundArch BA,
91 Action::OffloadKind DeviceOffloadKind) const override;
92
93 void
94 addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
95 llvm::opt::ArgStringList &CC1Args, BoundArch BA,
96 Action::OffloadKind DeviceOffloadKind) const override;
97 void
98 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
99 llvm::opt::ArgStringList &CC1Args) const override;
100
101 /// Return whether denormals should be flushed, and treated as 0 by default
102 /// for the subtarget.
103 static bool getDefaultDenormsAreZeroForTarget(llvm::AMDGPU::GPUKind GPUKind);
104
105 llvm::DenormalMode getDefaultDenormalModeForType(
106 const llvm::opt::ArgList &DriverArgs, const JobAction &JA,
107 const llvm::fltSemantics *FPType = nullptr) const override;
108
109 static bool isWave64(const llvm::opt::ArgList &DriverArgs,
110 llvm::AMDGPU::GPUKind Kind);
111 /// Needed for using lto.
112 bool HasNativeLLVMSupport() const override { return true; }
113
114 /// Needed for translating LTO options.
115 const char *getDefaultLinker() const override { return "ld.lld"; }
116
117 StringRef getSanitizerRequirement(SanitizerMask Kinds,
118 BoundArch BA) const override;
119
120 /// Uses amdgpu-arch tool to get arch of the system GPU. Will return error
121 /// if unable to find one.
122 virtual Expected<SmallVector<std::string>>
123 getSystemGPUArchs(const llvm::opt::ArgList &Args) const override;
124
125 const llvm::Triple *getAuxTriple() const override {
126 return HostTC ? &HostTC->getTriple() : nullptr;
127 }
128
129 llvm::SmallVector<BitCodeLibraryInfo, 12>
130 getDeviceLibs(const llvm::opt::ArgList &Args, BoundArch BA,
131 Action::OffloadKind DeviceOffloadKind) const override;
132
133 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
134
135 void AddClangCXXStdlibIncludeArgs(
136 const llvm::opt::ArgList &Args,
137 llvm::opt::ArgStringList &CC1Args) const override;
138
139 void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
140 llvm::opt::ArgStringList &CC1Args) const override;
141
142 void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs,
143 llvm::opt::ArgStringList &CC1Args) const override;
144
145 VersionTuple
146 computeMSVCVersion(const Driver *D,
147 const llvm::opt::ArgList &Args) const override;
148
149 LTOKind getDefaultLTOMode() const override;
150
151 /// We need to adjust the LTO mode based on user arguments.
152 LTOKind
153 getLTOMode(const llvm::opt::ArgList &Args,
154 Action::OffloadKind Kind = Action::OFK_None) const override;
155
156 // Returns a list of device library names shared by different languages
157 llvm::SmallVector<BitCodeLibraryInfo, 12>
158 getCommonDeviceLibNames(const llvm::opt::ArgList &DriverArgs,
159 llvm::StringRef TargetID, llvm::StringRef GPUArch,
160 Action::OffloadKind DeviceOffloadingKind) const;
161
162protected:
163 /// The struct type returned by getParsedTargetID.
164 struct ParsedTargetIDType {
165 std::optional<std::string> OptionalTargetID;
166 std::optional<std::string> OptionalGPUArch;
167 std::optional<llvm::StringMap<bool>> OptionalFeatureMap;
168 };
169
170 /// Check and diagnose invalid target ID specified by -mcpu.
171 /// Returns the parsed target ID.
172 virtual ParsedTargetIDType
173 checkTargetID(const llvm::opt::ArgList &DriverArgs) const;
174
175 /// Get target ID, GPU arch, and target ID features if the target ID is
176 /// specified and valid.
177 ParsedTargetIDType
178 getParsedTargetID(const llvm::opt::ArgList &DriverArgs) const;
179
180 /// Get GPU arch from -mcpu without checking.
181 StringRef getGPUArch(const llvm::opt::ArgList &DriverArgs) const;
182
183 /// Common warning options shared by AMDGPU HIP, OpenCL and OpenMP toolchains.
184 /// Language specific warning options should go to derived classes.
185 void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override;
186
187 SanitizerMask
188 getSupportedSanitizers(BoundArch BA,
189 Action::OffloadKind DeviceOffloadKind) const override;
190};
191
192} // end namespace toolchains
193} // end namespace driver
194} // end namespace clang
195
196#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_AMDGPU_H
197