1//===--- AArch64.h - Declare AArch64 target feature support -----*- 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// This file declares AArch64 TargetInfo objects.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_LIB_BASIC_TARGETS_AARCH64_H
14#define LLVM_CLANG_LIB_BASIC_TARGETS_AARCH64_H
15
16#include "OSTargets.h"
17#include "clang/Basic/TargetBuiltins.h"
18#include "llvm/ADT/DenseSet.h"
19#include "llvm/TargetParser/AArch64TargetParser.h"
20#include <optional>
21
22namespace clang {
23namespace targets {
24
25enum AArch64AddrSpace { ptr32_sptr = 270, ptr32_uptr = 271, ptr64 = 272 };
26
27static constexpr LangASMap ARM64AddrSpaceMap = {
28 {LangAS::ptr32_sptr, static_cast<unsigned>(AArch64AddrSpace::ptr32_sptr)},
29 {LangAS::ptr32_uptr, static_cast<unsigned>(AArch64AddrSpace::ptr32_uptr)},
30 {LangAS::ptr64, static_cast<unsigned>(AArch64AddrSpace::ptr64)},
31};
32
33using AArch64FeatureSet = llvm::SmallDenseSet<StringRef, 32>;
34
35class LLVM_LIBRARY_VISIBILITY AArch64TargetInfo : public TargetInfo {
36 static const TargetInfo::GCCRegAlias GCCRegAliases[];
37 static const char *const GCCRegNames[];
38
39 enum FPUModeEnum {
40 FPUMode = (1 << 0),
41 NeonMode = (1 << 1),
42 SveMode = (1 << 2),
43 };
44
45 unsigned FPU = FPUMode;
46 bool HasCRC = false;
47 bool HasCSSC = false;
48 bool HasAES = false;
49 bool HasSHA2 = false;
50 bool HasSHA3 = false;
51 bool HasSM4 = false;
52 bool HasFullFP16 = false;
53 bool HasDotProd = false;
54 bool HasFP16FML = false;
55 bool HasMTE = false;
56 bool HasPAuth = false;
57 bool HasLS64 = false;
58 bool HasRandGen = false;
59 bool HasMatMul = false;
60 bool HasBFloat16 = false;
61 bool HasSVE2 = false;
62 bool HasSVE2p1 = false;
63 bool HasSVEAES = false;
64 bool HasSVE2SHA3 = false;
65 bool HasSVE2SM4 = false;
66 bool HasSVEB16B16 = false;
67 bool HasSVEBitPerm = false;
68 bool HasMatmulFP64 = false;
69 bool HasMatmulFP32 = false;
70 bool HasLSE = false;
71 bool HasLSCP = false;
72 bool HasFlagM = false;
73 bool HasAlternativeNZCV = false;
74 bool HasMOPS = false;
75 bool HasD128 = false;
76 bool HasRCPC = false;
77 bool HasRDM = false;
78 bool HasDIT = false;
79 bool HasCCPP = false;
80 bool HasCCDP = false;
81 bool HasFRInt3264 = false;
82 bool HasSME = false;
83 bool HasSME2 = false;
84 bool HasSMEF64F64 = false;
85 bool HasSMEI16I64 = false;
86 bool HasSMEF16F16 = false;
87 bool HasSMEB16B16 = false;
88 bool HasSME2p1 = false;
89 bool HasFP8 = false;
90 bool HasFP8FMA = false;
91 bool HasFP8DOT2 = false;
92 bool HasFP8DOT4 = false;
93 bool HasSSVE_FP8DOT2 = false;
94 bool HasSSVE_FP8DOT4 = false;
95 bool HasSSVE_FP8FMA = false;
96 bool HasSME_F8F32 = false;
97 bool HasSME_F8F16 = false;
98 bool HasSB = false;
99 bool HasPredRes = false;
100 bool HasSSBS = false;
101 bool HasBTI = false;
102 bool HasWFxT = false;
103 bool HasJSCVT = false;
104 bool HasFCMA = false;
105 bool HasNoFP = false;
106 bool HasNoNeon = false;
107 bool HasNoSVE = false;
108 bool HasFMV = true;
109 bool HasGCS = false;
110 bool HasRCPC3 = false;
111 bool HasSMEFA64 = false;
112 bool HasPAuthLR = false;
113 bool HasFPRCVT = false;
114 bool HasF8F16MM = false;
115 bool HasF8F32MM = false;
116 bool HasSVE_F16F32MM = false;
117 bool HasSVE_BFSCALE = false;
118 bool HasSVE_AES2 = false;
119 bool HasSSVE_AES = false;
120 bool HasSVE2p2 = false;
121 bool HasSME2p2 = false;
122 bool HasSVE2p3 = false;
123 bool HasSME2p3 = false;
124 bool HasSVE_B16MM = false;
125 bool HasF16MM = false;
126 bool HasF16F32DOT = false;
127 bool HasF16F32MM = false;
128
129 const llvm::AArch64::ArchInfo *ArchInfo = &llvm::AArch64::ARMV8A;
130
131 AArch64FeatureSet HasFeatureLookup;
132
133 void computeFeatureLookup();
134
135protected:
136 std::string ABI;
137
138public:
139 AArch64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);
140
141 StringRef getABI() const override;
142 bool setABI(const std::string &Name) override;
143
144 bool validateBranchProtection(const ParsedTargetAttr &Attr,
145 BranchProtectionInfo &BPI,
146 const LangOptions &LO,
147 StringRef &Err) const override;
148 std::optional<LangOptions::SignReturnAddressHardeningKind>
149 parseSignReturnAddressHardening(StringRef Spec) const override;
150
151 bool isValidCPUName(StringRef Name) const override;
152 void fillValidCPUList(SmallVectorImpl<StringRef> &Values) const override;
153 bool setCPU(StringRef Name) override;
154
155 llvm::APInt getFMVPriority(ArrayRef<StringRef> Features) const override;
156
157 void getTargetDefinesARMV81A(const LangOptions &Opts,
158 MacroBuilder &Builder) const;
159 void getTargetDefinesARMV82A(const LangOptions &Opts,
160 MacroBuilder &Builder) const;
161 void getTargetDefinesARMV83A(const LangOptions &Opts,
162 MacroBuilder &Builder) const;
163 void getTargetDefinesARMV84A(const LangOptions &Opts,
164 MacroBuilder &Builder) const;
165 void getTargetDefinesARMV85A(const LangOptions &Opts,
166 MacroBuilder &Builder) const;
167 void getTargetDefinesARMV86A(const LangOptions &Opts,
168 MacroBuilder &Builder) const;
169 void getTargetDefinesARMV87A(const LangOptions &Opts,
170 MacroBuilder &Builder) const;
171 void getTargetDefinesARMV88A(const LangOptions &Opts,
172 MacroBuilder &Builder) const;
173 void getTargetDefinesARMV89A(const LangOptions &Opts,
174 MacroBuilder &Builder) const;
175 void getTargetDefinesARMV9A(const LangOptions &Opts,
176 MacroBuilder &Builder) const;
177 void getTargetDefinesARMV91A(const LangOptions &Opts,
178 MacroBuilder &Builder) const;
179 void getTargetDefinesARMV92A(const LangOptions &Opts,
180 MacroBuilder &Builder) const;
181 void getTargetDefinesARMV93A(const LangOptions &Opts,
182 MacroBuilder &Builder) const;
183 void getTargetDefinesARMV94A(const LangOptions &Opts,
184 MacroBuilder &Builder) const;
185 void getTargetDefinesARMV95A(const LangOptions &Opts,
186 MacroBuilder &Builder) const;
187 void getTargetDefinesARMV96A(const LangOptions &Opts,
188 MacroBuilder &Builder) const;
189 void getTargetDefinesARMV97A(const LangOptions &Opts,
190 MacroBuilder &Builder) const;
191 void getTargetDefinesARMV98A(const LangOptions &Opts,
192 MacroBuilder &Builder) const;
193 void getTargetDefines(const LangOptions &Opts,
194 MacroBuilder &Builder) const override;
195
196 llvm::SmallVector<Builtin::InfosShard> getTargetBuiltins() const override;
197
198 std::optional<std::pair<unsigned, unsigned>> getVScaleRange(
199 const LangOptions &LangOpts, ArmStreamingKind Mode,
200 const llvm::StringMap<bool> *FeatureMap = nullptr) const override;
201 bool doesFeatureAffectCodeGen(StringRef Name) const override;
202 bool validateCpuSupports(StringRef FeatureStr) const override;
203 bool hasFeature(StringRef Feature) const override;
204 void setFeatureEnabled(llvm::StringMap<bool> &Features, StringRef Name,
205 bool Enabled) const override;
206 bool handleTargetFeatures(std::vector<std::string> &Features,
207 DiagnosticsEngine &Diags) override;
208 ParsedTargetAttr parseTargetAttr(StringRef Str) const override;
209 bool supportsTargetAttributeTune() const override { return true; }
210 bool supportsCpuSupports() const override { return true; }
211 bool checkArithmeticFenceSupported() const override { return true; }
212
213 bool hasBFloat16Type() const override;
214
215 CallingConvCheckResult checkCallingConvention(CallingConv CC) const override;
216
217 bool isCLZForZeroUndef() const override;
218
219 BuiltinVaListKind getBuiltinVaListKind() const override;
220
221 ArrayRef<const char *> getGCCRegNames() const override;
222 ArrayRef<TargetInfo::GCCRegAlias> getGCCRegAliases() const override;
223
224 std::string convertConstraint(const char *&Constraint) const override;
225
226 bool validateAsmConstraint(const char *&Name,
227 TargetInfo::ConstraintInfo &Info) const override;
228 bool
229 validateConstraintModifier(StringRef Constraint, char Modifier, unsigned Size,
230 std::string &SuggestedModifier) const override;
231 std::string_view getClobbers() const override;
232
233 StringRef getConstraintRegister(StringRef Constraint,
234 StringRef Expression) const override {
235 return Expression;
236 }
237
238 int getEHDataRegisterNumber(unsigned RegNo) const override;
239
240 bool validatePointerAuthKey(const llvm::APSInt &value) const override;
241
242 const char *getBFloat16Mangling() const override { return "u6__bf16"; };
243
244 std::pair<unsigned, unsigned> hardwareInterferenceSizes() const override {
245 return std::make_pair(x: 256, y: 64);
246 }
247
248 bool hasInt128Type() const override;
249
250 bool hasBitIntType() const override { return true; }
251
252 bool validateTarget(DiagnosticsEngine &Diags) const override;
253
254 bool validateGlobalRegisterVariable(StringRef RegName, unsigned RegSize,
255 bool &HasSizeMismatch) const override;
256
257 uint64_t getPointerWidthV(LangAS AddrSpace) const override {
258 if (AddrSpace == LangAS::ptr32_sptr || AddrSpace == LangAS::ptr32_uptr)
259 return 32;
260 if (AddrSpace == LangAS::ptr64)
261 return 64;
262 return PointerWidth;
263 }
264
265 uint64_t getPointerAlignV(LangAS AddrSpace) const override {
266 return getPointerWidthV(AddrSpace);
267 }
268};
269
270class LLVM_LIBRARY_VISIBILITY AArch64leTargetInfo : public AArch64TargetInfo {
271public:
272 AArch64leTargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);
273
274 void getTargetDefines(const LangOptions &Opts,
275 MacroBuilder &Builder) const override;
276};
277
278template <>
279inline bool
280LinuxTargetInfo<AArch64leTargetInfo>::setABI(const std::string &Name) {
281 if (Name == "pauthtest") {
282 ABI = Name;
283 return true;
284 }
285 return AArch64leTargetInfo::setABI(Name);
286}
287
288class LLVM_LIBRARY_VISIBILITY WindowsARM64TargetInfo
289 : public WindowsTargetInfo<AArch64leTargetInfo> {
290 const llvm::Triple Triple;
291
292public:
293 WindowsARM64TargetInfo(const llvm::Triple &Triple,
294 const TargetOptions &Opts);
295
296 BuiltinVaListKind getBuiltinVaListKind() const override;
297
298 CallingConvCheckResult checkCallingConvention(CallingConv CC) const override;
299};
300
301// Windows ARM, MS (C++) ABI
302class LLVM_LIBRARY_VISIBILITY MicrosoftARM64TargetInfo
303 : public WindowsARM64TargetInfo {
304public:
305 MicrosoftARM64TargetInfo(const llvm::Triple &Triple,
306 const TargetOptions &Opts);
307
308 void getTargetDefines(const LangOptions &Opts,
309 MacroBuilder &Builder) const override;
310 TargetInfo::CallingConvKind
311 getCallingConvKind(bool ClangABICompat4) const override;
312
313 unsigned getMinGlobalAlign(uint64_t TypeSize,
314 bool HasNonWeakDef) const override;
315};
316
317// ARM64 MinGW target
318class LLVM_LIBRARY_VISIBILITY MinGWARM64TargetInfo
319 : public WindowsARM64TargetInfo {
320public:
321 MinGWARM64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);
322};
323
324// ARM64 UEFI target
325class LLVM_LIBRARY_VISIBILITY UEFIAArch64TargetInfo
326 : public UEFITargetInfo<AArch64leTargetInfo> {
327public:
328 UEFIAArch64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);
329
330 BuiltinVaListKind getBuiltinVaListKind() const override;
331
332 CallingConvCheckResult checkCallingConvention(CallingConv CC) const override;
333
334 TargetInfo::CallingConvKind
335 getCallingConvKind(bool ClangABICompat4) const override;
336};
337
338class LLVM_LIBRARY_VISIBILITY AArch64beTargetInfo : public AArch64TargetInfo {
339public:
340 AArch64beTargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);
341 void getTargetDefines(const LangOptions &Opts,
342 MacroBuilder &Builder) const override;
343};
344
345void getAppleMachOAArch64Defines(MacroBuilder &Builder, const LangOptions &Opts,
346 const llvm::Triple &Triple);
347
348class LLVM_LIBRARY_VISIBILITY AppleMachOAArch64TargetInfo
349 : public AppleMachOTargetInfo<AArch64leTargetInfo> {
350public:
351 AppleMachOAArch64TargetInfo(const llvm::Triple &Triple,
352 const TargetOptions &Opts);
353
354 std::pair<unsigned, unsigned> hardwareInterferenceSizes() const override {
355 // Apple AArch64 cores use a 128-byte cache line, unlike the ARM-documented
356 // value of 256 used by the generic aarch64 triple.
357 return std::make_pair(x: 128, y: 64);
358 }
359
360protected:
361 void getOSDefines(const LangOptions &Opts, const llvm::Triple &Triple,
362 MacroBuilder &Builder) const override;
363};
364
365class LLVM_LIBRARY_VISIBILITY DarwinAArch64TargetInfo
366 : public DarwinTargetInfo<AArch64leTargetInfo> {
367public:
368 DarwinAArch64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);
369
370 BuiltinVaListKind getBuiltinVaListKind() const override;
371
372 std::pair<unsigned, unsigned> hardwareInterferenceSizes() const override {
373 // Apple AArch64 cores use a 128-byte cache line, so 128 (not the generic
374 // AArch64 value of 256) is the right destructive interference size. These
375 // values are implementation-defined and not part of the ABI.
376 return std::make_pair(x: 128, y: 64);
377 }
378
379 protected:
380 void getOSDefines(const LangOptions &Opts, const llvm::Triple &Triple,
381 MacroBuilder &Builder) const override;
382};
383
384} // namespace targets
385} // namespace clang
386
387#endif // LLVM_CLANG_LIB_BASIC_TARGETS_AARCH64_H
388