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