Clang Project

clang_source_code/lib/Driver/ToolChains/Arch/AArch64.cpp
1//===--- AArch64.cpp - AArch64 (not ARM) Helpers for Tools ------*- 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 "AArch64.h"
10#include "clang/Driver/Driver.h"
11#include "clang/Driver/DriverDiagnostic.h"
12#include "clang/Driver/Options.h"
13#include "llvm/Option/ArgList.h"
14#include "llvm/Support/TargetParser.h"
15
16using namespace clang::driver;
17using namespace clang::driver::tools;
18using namespace clang;
19using namespace llvm::opt;
20
21/// \returns true if the given triple can determine the default CPU type even
22/// if -arch is not specified.
23static bool isCPUDeterminedByTriple(const llvm::Triple &Triple) {
24  return Triple.isOSDarwin();
25}
26
27/// getAArch64TargetCPU - Get the (LLVM) name of the AArch64 cpu we are
28/// targeting. Set \p A to the Arg corresponding to the -mcpu argument if it is
29/// provided, or to nullptr otherwise.
30std::string aarch64::getAArch64TargetCPU(const ArgList &Args,
31                                         const llvm::Triple &Triple, Arg *&A) {
32  std::string CPU;
33  // If we have -mcpu, use that.
34  if ((A = Args.getLastArg(options::OPT_mcpu_EQ))) {
35    StringRef Mcpu = A->getValue();
36    CPU = Mcpu.split("+").first.lower();
37  }
38
39  // Handle CPU name is 'native'.
40  if (CPU == "native")
41    return llvm::sys::getHostCPUName();
42  else if (CPU.size())
43    return CPU;
44
45  // Make sure we pick "cyclone" if -arch is used or when targetting a Darwin
46  // OS.
47  if (Args.getLastArg(options::OPT_arch) || Triple.isOSDarwin())
48    return "cyclone";
49
50  return "generic";
51}
52
53// Decode AArch64 features from string like +[no]featureA+[no]featureB+...
54static bool DecodeAArch64Features(const Driver &D, StringRef text,
55                                  std::vector<StringRef> &Features) {
56  SmallVector<StringRef, 8> Split;
57  text.split(Split, StringRef("+"), -1, false);
58
59  for (StringRef Feature : Split) {
60    StringRef FeatureName = llvm::AArch64::getArchExtFeature(Feature);
61    if (!FeatureName.empty())
62      Features.push_back(FeatureName);
63    else if (Feature == "neon" || Feature == "noneon")
64      D.Diag(clang::diag::err_drv_no_neon_modifier);
65    else
66      return false;
67  }
68  return true;
69}
70
71// Check if the CPU name and feature modifiers in -mcpu are legal. If yes,
72// decode CPU and feature.
73static bool DecodeAArch64Mcpu(const Driver &D, StringRef Mcpu, StringRef &CPU,
74                              std::vector<StringRef> &Features) {
75  std::pair<StringRef, StringRef> Split = Mcpu.split("+");
76  CPU = Split.first;
77
78  if (CPU == "native")
79    CPU = llvm::sys::getHostCPUName();
80
81  if (CPU == "generic") {
82    Features.push_back("+neon");
83  } else {
84    llvm::AArch64::ArchKind ArchKind = llvm::AArch64::parseCPUArch(CPU);
85    if (!llvm::AArch64::getArchFeatures(ArchKind, Features))
86      return false;
87
88    unsigned Extension = llvm::AArch64::getDefaultExtensions(CPU, ArchKind);
89    if (!llvm::AArch64::getExtensionFeatures(Extension, Features))
90      return false;
91   }
92
93  if (Split.second.size() && !DecodeAArch64Features(D, Split.second, Features))
94    return false;
95
96  return true;
97}
98
99static bool
100getAArch64ArchFeaturesFromMarch(const Driver &D, StringRef March,
101                                const ArgList &Args,
102                                std::vector<StringRef> &Features) {
103  std::string MarchLowerCase = March.lower();
104  std::pair<StringRef, StringRef> Split = StringRef(MarchLowerCase).split("+");
105
106  llvm::AArch64::ArchKind ArchKind = llvm::AArch64::parseArch(Split.first);
107  if (ArchKind == llvm::AArch64::ArchKind::INVALID ||
108      !llvm::AArch64::getArchFeatures(ArchKind, Features) ||
109      (Split.second.size() && !DecodeAArch64Features(D, Split.second, Features)))
110    return false;
111
112  return true;
113}
114
115static bool
116getAArch64ArchFeaturesFromMcpu(const Driver &D, StringRef Mcpu,
117                               const ArgList &Args,
118                               std::vector<StringRef> &Features) {
119  StringRef CPU;
120  std::string McpuLowerCase = Mcpu.lower();
121  if (!DecodeAArch64Mcpu(D, McpuLowerCase, CPU, Features))
122    return false;
123
124  return true;
125}
126
127static bool
128getAArch64MicroArchFeaturesFromMtune(const Driver &D, StringRef Mtune,
129                                     const ArgList &Args,
130                                     std::vector<StringRef> &Features) {
131  std::string MtuneLowerCase = Mtune.lower();
132  // Check CPU name is valid
133  std::vector<StringRef> MtuneFeatures;
134  StringRef Tune;
135  if (!DecodeAArch64Mcpu(D, MtuneLowerCase, Tune, MtuneFeatures))
136    return false;
137
138  // Handle CPU name is 'native'.
139  if (MtuneLowerCase == "native")
140    MtuneLowerCase = llvm::sys::getHostCPUName();
141  if (MtuneLowerCase == "cyclone") {
142    Features.push_back("+zcm");
143    Features.push_back("+zcz");
144  }
145  return true;
146}
147
148static bool
149getAArch64MicroArchFeaturesFromMcpu(const Driver &D, StringRef Mcpu,
150                                    const ArgList &Args,
151                                    std::vector<StringRef> &Features) {
152  StringRef CPU;
153  std::vector<StringRef> DecodedFeature;
154  std::string McpuLowerCase = Mcpu.lower();
155  if (!DecodeAArch64Mcpu(D, McpuLowerCase, CPU, DecodedFeature))
156    return false;
157
158  return getAArch64MicroArchFeaturesFromMtune(D, CPU, Args, Features);
159}
160
161void aarch64::getAArch64TargetFeatures(const Driver &D,
162                                       const llvm::Triple &Triple,
163                                       const ArgList &Args,
164                                       std::vector<StringRef> &Features) {
165  Arg *A;
166  bool success = true;
167  // Enable NEON by default.
168  Features.push_back("+neon");
169  if ((A = Args.getLastArg(options::OPT_march_EQ)))
170    success = getAArch64ArchFeaturesFromMarch(D, A->getValue(), Args, Features);
171  else if ((A = Args.getLastArg(options::OPT_mcpu_EQ)))
172    success = getAArch64ArchFeaturesFromMcpu(D, A->getValue(), Args, Features);
173  else if (Args.hasArg(options::OPT_arch) || isCPUDeterminedByTriple(Triple))
174    success = getAArch64ArchFeaturesFromMcpu(
175        D, getAArch64TargetCPU(Args, Triple, A), Args, Features);
176
177  if (success && (A = Args.getLastArg(clang::driver::options::OPT_mtune_EQ)))
178    success =
179        getAArch64MicroArchFeaturesFromMtune(D, A->getValue(), Args, Features);
180  else if (success && (A = Args.getLastArg(options::OPT_mcpu_EQ)))
181    success =
182        getAArch64MicroArchFeaturesFromMcpu(D, A->getValue(), Args, Features);
183  else if (success &&
184           (Args.hasArg(options::OPT_arch) || isCPUDeterminedByTriple(Triple)))
185    success = getAArch64MicroArchFeaturesFromMcpu(
186        D, getAArch64TargetCPU(Args, Triple, A), Args, Features);
187
188  if (!success)
189    D.Diag(diag::err_drv_clang_unsupported) << A->getAsString(Args);
190
191  if (Args.getLastArg(options::OPT_mgeneral_regs_only)) {
192    Features.push_back("-fp-armv8");
193    Features.push_back("-crypto");
194    Features.push_back("-neon");
195  }
196
197  // En/disable crc
198  if (Arg *A = Args.getLastArg(options::OPT_mcrc, options::OPT_mnocrc)) {
199    if (A->getOption().matches(options::OPT_mcrc))
200      Features.push_back("+crc");
201    else
202      Features.push_back("-crc");
203  }
204
205  // Handle (arch-dependent) fp16fml/fullfp16 relationship.
206  // FIXME: this fp16fml option handling will be reimplemented after the
207  // TargetParser rewrite.
208  const auto ItRNoFullFP16 = std::find(Features.rbegin(), Features.rend(), "-fullfp16");
209  const auto ItRFP16FML = std::find(Features.rbegin(), Features.rend(), "+fp16fml");
210  if (llvm::is_contained(Features, "+v8.4a")) {
211    const auto ItRFullFP16  = std::find(Features.rbegin(), Features.rend(), "+fullfp16");
212    if (ItRFullFP16 < ItRNoFullFP16 && ItRFullFP16 < ItRFP16FML) {
213      // Only entangled feature that can be to the right of this +fullfp16 is -fp16fml.
214      // Only append the +fp16fml if there is no -fp16fml after the +fullfp16.
215      if (std::find(Features.rbegin(), ItRFullFP16, "-fp16fml") == ItRFullFP16)
216        Features.push_back("+fp16fml");
217    }
218    else
219      goto fp16_fml_fallthrough;
220  } else {
221fp16_fml_fallthrough:
222    // In both of these cases, putting the 'other' feature on the end of the vector will
223    // result in the same effect as placing it immediately after the current feature.
224    if (ItRNoFullFP16 < ItRFP16FML)
225      Features.push_back("-fp16fml");
226    else if (ItRNoFullFP16 > ItRFP16FML)
227      Features.push_back("+fullfp16");
228  }
229
230  // FIXME: this needs reimplementation too after the TargetParser rewrite
231  //
232  // Context sensitive meaning of Crypto:
233  // 1) For Arch >= ARMv8.4a:  crypto = sm4 + sha3 + sha2 + aes
234  // 2) For Arch <= ARMv8.3a:  crypto = sha2 + aes
235  const auto ItBegin = Features.begin();
236  const auto ItEnd = Features.end();
237  const auto ItRBegin = Features.rbegin();
238  const auto ItREnd = Features.rend();
239  const auto ItRCrypto = std::find(ItRBegin, ItREnd, "+crypto");
240  const auto ItRNoCrypto = std::find(ItRBegin, ItREnd, "-crypto");
241  const auto HasCrypto  = ItRCrypto != ItREnd;
242  const auto HasNoCrypto = ItRNoCrypto != ItREnd;
243  const ptrdiff_t PosCrypto = ItRCrypto - ItRBegin;
244  const ptrdiff_t PosNoCrypto = ItRNoCrypto - ItRBegin;
245
246  bool NoCrypto = false;
247  if (HasCrypto && HasNoCrypto) {
248    if (PosNoCrypto < PosCrypto)
249      NoCrypto = true;
250  }
251
252  if (std::find(ItBegin, ItEnd, "+v8.4a") != ItEnd) {
253    if (HasCrypto && !NoCrypto) {
254      // Check if we have NOT disabled an algorithm with something like:
255      //   +crypto, -algorithm
256      // And if "-algorithm" does not occur, we enable that crypto algorithm.
257      const bool HasSM4  = (std::find(ItBegin, ItEnd, "-sm4") == ItEnd);
258      const bool HasSHA3 = (std::find(ItBegin, ItEnd, "-sha3") == ItEnd);
259      const bool HasSHA2 = (std::find(ItBegin, ItEnd, "-sha2") == ItEnd);
260      const bool HasAES  = (std::find(ItBegin, ItEnd, "-aes") == ItEnd);
261      if (HasSM4)
262        Features.push_back("+sm4");
263      if (HasSHA3)
264        Features.push_back("+sha3");
265      if (HasSHA2)
266        Features.push_back("+sha2");
267      if (HasAES)
268        Features.push_back("+aes");
269    } else if (HasNoCrypto) {
270      // Check if we have NOT enabled a crypto algorithm with something like:
271      //   -crypto, +algorithm
272      // And if "+algorithm" does not occur, we disable that crypto algorithm.
273      const bool HasSM4  = (std::find(ItBegin, ItEnd, "+sm4") != ItEnd);
274      const bool HasSHA3 = (std::find(ItBegin, ItEnd, "+sha3") != ItEnd);
275      const bool HasSHA2 = (std::find(ItBegin, ItEnd, "+sha2") != ItEnd);
276      const bool HasAES  = (std::find(ItBegin, ItEnd, "+aes") != ItEnd);
277      if (!HasSM4)
278        Features.push_back("-sm4");
279      if (!HasSHA3)
280        Features.push_back("-sha3");
281      if (!HasSHA2)
282        Features.push_back("-sha2");
283      if (!HasAES)
284        Features.push_back("-aes");
285    }
286  } else {
287    if (HasCrypto && !NoCrypto) {
288      const bool HasSHA2 = (std::find(ItBegin, ItEnd, "-sha2") == ItEnd);
289      const bool HasAES = (std::find(ItBegin, ItEnd, "-aes") == ItEnd);
290      if (HasSHA2)
291        Features.push_back("+sha2");
292      if (HasAES)
293        Features.push_back("+aes");
294    } else if (HasNoCrypto) {
295      const bool HasSHA2 = (std::find(ItBegin, ItEnd, "+sha2") != ItEnd);
296      const bool HasAES  = (std::find(ItBegin, ItEnd, "+aes") != ItEnd);
297      const bool HasV82a = (std::find(ItBegin, ItEnd, "+v8.2a") != ItEnd);
298      const bool HasV83a = (std::find(ItBegin, ItEnd, "+v8.3a") != ItEnd);
299      const bool HasV84a = (std::find(ItBegin, ItEnd, "+v8.4a") != ItEnd);
300      if (!HasSHA2)
301        Features.push_back("-sha2");
302      if (!HasAES)
303        Features.push_back("-aes");
304      if (HasV82a || HasV83a || HasV84a) {
305        Features.push_back("-sm4");
306        Features.push_back("-sha3");
307      }
308    }
309  }
310
311  if (Arg *A = Args.getLastArg(options::OPT_mno_unaligned_access,
312                               options::OPT_munaligned_access))
313    if (A->getOption().matches(options::OPT_mno_unaligned_access))
314      Features.push_back("+strict-align");
315
316  if (Args.hasArg(options::OPT_ffixed_x1))
317    Features.push_back("+reserve-x1");
318
319  if (Args.hasArg(options::OPT_ffixed_x2))
320    Features.push_back("+reserve-x2");
321
322  if (Args.hasArg(options::OPT_ffixed_x3))
323    Features.push_back("+reserve-x3");
324
325  if (Args.hasArg(options::OPT_ffixed_x4))
326    Features.push_back("+reserve-x4");
327
328  if (Args.hasArg(options::OPT_ffixed_x5))
329    Features.push_back("+reserve-x5");
330
331  if (Args.hasArg(options::OPT_ffixed_x6))
332    Features.push_back("+reserve-x6");
333
334  if (Args.hasArg(options::OPT_ffixed_x7))
335    Features.push_back("+reserve-x7");
336
337  if (Args.hasArg(options::OPT_ffixed_x9))
338    Features.push_back("+reserve-x9");
339
340  if (Args.hasArg(options::OPT_ffixed_x10))
341    Features.push_back("+reserve-x10");
342
343  if (Args.hasArg(options::OPT_ffixed_x11))
344    Features.push_back("+reserve-x11");
345
346  if (Args.hasArg(options::OPT_ffixed_x12))
347    Features.push_back("+reserve-x12");
348
349  if (Args.hasArg(options::OPT_ffixed_x13))
350    Features.push_back("+reserve-x13");
351
352  if (Args.hasArg(options::OPT_ffixed_x14))
353    Features.push_back("+reserve-x14");
354
355  if (Args.hasArg(options::OPT_ffixed_x15))
356    Features.push_back("+reserve-x15");
357
358  if (Args.hasArg(options::OPT_ffixed_x18))
359    Features.push_back("+reserve-x18");
360
361  if (Args.hasArg(options::OPT_ffixed_x20))
362    Features.push_back("+reserve-x20");
363
364  if (Args.hasArg(options::OPT_ffixed_x21))
365    Features.push_back("+reserve-x21");
366
367  if (Args.hasArg(options::OPT_ffixed_x22))
368    Features.push_back("+reserve-x22");
369
370  if (Args.hasArg(options::OPT_ffixed_x23))
371    Features.push_back("+reserve-x23");
372
373  if (Args.hasArg(options::OPT_ffixed_x24))
374    Features.push_back("+reserve-x24");
375
376  if (Args.hasArg(options::OPT_ffixed_x25))
377    Features.push_back("+reserve-x25");
378
379  if (Args.hasArg(options::OPT_ffixed_x26))
380    Features.push_back("+reserve-x26");
381
382  if (Args.hasArg(options::OPT_ffixed_x27))
383    Features.push_back("+reserve-x27");
384
385  if (Args.hasArg(options::OPT_ffixed_x28))
386    Features.push_back("+reserve-x28");
387
388  if (Args.hasArg(options::OPT_fcall_saved_x8))
389    Features.push_back("+call-saved-x8");
390
391  if (Args.hasArg(options::OPT_fcall_saved_x9))
392    Features.push_back("+call-saved-x9");
393
394  if (Args.hasArg(options::OPT_fcall_saved_x10))
395    Features.push_back("+call-saved-x10");
396
397  if (Args.hasArg(options::OPT_fcall_saved_x11))
398    Features.push_back("+call-saved-x11");
399
400  if (Args.hasArg(options::OPT_fcall_saved_x12))
401    Features.push_back("+call-saved-x12");
402
403  if (Args.hasArg(options::OPT_fcall_saved_x13))
404    Features.push_back("+call-saved-x13");
405
406  if (Args.hasArg(options::OPT_fcall_saved_x14))
407    Features.push_back("+call-saved-x14");
408
409  if (Args.hasArg(options::OPT_fcall_saved_x15))
410    Features.push_back("+call-saved-x15");
411
412  if (Args.hasArg(options::OPT_fcall_saved_x18))
413    Features.push_back("+call-saved-x18");
414
415  if (Args.hasArg(options::OPT_mno_neg_immediates))
416    Features.push_back("+no-neg-immediates");
417}
418
CodeThinker, Enjoy your reading code