//===--- AArch64.h - Declare AArch64 target feature support -----*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

//

// This file declares AArch64 TargetInfo objects.

//

//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_LIB_BASIC_TARGETS_AARCH64_H

#define LLVM_CLANG_LIB_BASIC_TARGETS_AARCH64_H

#include "OSTargets.h"

#include "clang/Basic/TargetBuiltins.h"

#include "llvm/TargetParser/AArch64TargetParser.h"

#include <optional>

namespace clang {

namespace targets {

class LLVM_LIBRARY_VISIBILITY AArch64TargetInfo : public TargetInfo {

  virtual void setDataLayout() = 0;

  static const TargetInfo::GCCRegAlias GCCRegAliases[];

  static const char *const GCCRegNames[];

  enum FPUModeEnum {

    FPUMode = (1 << 0),

    NeonMode = (1 << 1),

    SveMode = (1 << 2),

  };

  unsigned FPU = FPUMode;

  bool HasCRC = false;

  bool HasAES = false;

  bool HasSHA2 = false;

  bool HasSHA3 = false;

  bool HasSM4 = false;

  bool HasUnaligned = true;

  bool HasFullFP16 = false;

  bool HasDotProd = false;

  bool HasFP16FML = false;

  bool HasMTE = false;

  bool HasTME = false;

  bool HasPAuth = false;

  bool HasLS64 = false;

  bool HasRandGen = false;

  bool HasMatMul = false;

  bool HasBFloat16 = false;

  bool HasSVE2 = false;

  bool HasSVE2AES = false;

  bool HasSVE2SHA3 = false;

  bool HasSVE2SM4 = false;

  bool HasSVE2BitPerm = false;

  bool HasMatmulFP64 = false;

  bool HasMatmulFP32 = false;

  bool HasLSE = false;

  bool HasFlagM = false;

  bool HasAlternativeNZCV = false;

  bool HasMOPS = false;

  bool HasD128 = false;

  bool HasRCPC = false;

  bool HasRDM = false;

  bool HasDIT = false;

  bool HasCCPP = false;

  bool HasCCDP = false;

  bool HasFRInt3264 = false;

  bool HasSME = false;

  bool HasSMEF64F64 = false;

  bool HasSMEI16I64 = false;

  bool HasSB = false;

  bool HasPredRes = false;

  bool HasSSBS = false;

  bool HasBTI = false;

  bool HasWFxT = false;

  bool HasJSCVT = false;

  bool HasFCMA = false;

  bool HasNoFP = false;

  bool HasNoNeon = false;

  bool HasNoSVE = false;

  bool HasFMV = true;

  bool HasGCS = false;

  const llvm::AArch64::ArchInfo *ArchInfo = &llvm::AArch64::ARMV8A;

  std::string ABI;

public:

  AArch64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);

  StringRef getABI() const override;

  bool setABI(const std::string &Name) override;

  bool validateBranchProtection(StringRef Spec, StringRef Arch,

                                BranchProtectionInfo &BPI,

                                StringRef &Err) const override;

  bool isValidCPUName(StringRef Name) const override;

  void fillValidCPUList(SmallVectorImpl<StringRef> &Values) const override;

  bool setCPU(const std::string &Name) override;

  unsigned multiVersionSortPriority(StringRef Name) const override;

  unsigned multiVersionFeatureCost() const override;

  bool

  initFeatureMap(llvm::StringMap<bool> &Features, DiagnosticsEngine &Diags,

                 StringRef CPU,

                 const std::vector<std::string> &FeaturesVec) const override;

  bool useFP16ConversionIntrinsics() const override {

    return false;

  }

  void setArchFeatures();

  void getTargetDefinesARMV81A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV82A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV83A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV84A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV85A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV86A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV87A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV88A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV89A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV9A(const LangOptions &Opts,

                              MacroBuilder &Builder) const;

  void getTargetDefinesARMV91A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV92A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV93A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefinesARMV94A(const LangOptions &Opts,

                               MacroBuilder &Builder) const;

  void getTargetDefines(const LangOptions &Opts,

                        MacroBuilder &Builder) const override;

  ArrayRef<Builtin::Info> getTargetBuiltins() const override;

  std::optional<std::pair<unsigned, unsigned>>

  getVScaleRange(const LangOptions &LangOpts) const override;

  bool doesFeatureAffectCodeGen(StringRef Name) const override;

  StringRef getFeatureDependencies(StringRef Name) const override;

  bool validateCpuSupports(StringRef FeatureStr) const override;

  bool hasFeature(StringRef Feature) const override;

  void setFeatureEnabled(llvm::StringMap<bool> &Features, StringRef Name,

                         bool Enabled) const override;

  bool handleTargetFeatures(std::vector<std::string> &Features,

                            DiagnosticsEngine &Diags) override;

  ParsedTargetAttr parseTargetAttr(StringRef Str) const override;

  bool supportsTargetAttributeTune() const override { return true; }

  bool checkArithmeticFenceSupported() const override { return true; }

  bool hasBFloat16Type() const override;

  CallingConvCheckResult checkCallingConvention(CallingConv CC) const override;

  bool isCLZForZeroUndef() const override;

  BuiltinVaListKind getBuiltinVaListKind() const override;

  ArrayRef<const char *> getGCCRegNames() const override;

  ArrayRef<TargetInfo::GCCRegAlias> getGCCRegAliases() const override;

  std::string convertConstraint(const char *&Constraint) const override;

  bool validateAsmConstraint(const char *&Name,

                             TargetInfo::ConstraintInfo &Info) const override;

  bool

  validateConstraintModifier(StringRef Constraint, char Modifier, unsigned Size,

                             std::string &SuggestedModifier) const override;

  std::string_view getClobbers() const override;

  StringRef getConstraintRegister(StringRef Constraint,

                                  StringRef Expression) const override {

    return Expression;

  }

  int getEHDataRegisterNumber(unsigned RegNo) const override;

  const char *getBFloat16Mangling() const override { return "u6__bf16"; };

  bool hasInt128Type() const override;

  bool hasBitIntType() const override { return true; }

};

class LLVM_LIBRARY_VISIBILITY AArch64leTargetInfo : public AArch64TargetInfo {

public:

  AArch64leTargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);

  void getTargetDefines(const LangOptions &Opts,

                            MacroBuilder &Builder) const override;

private:

  void setDataLayout() override;

};

class LLVM_LIBRARY_VISIBILITY WindowsARM64TargetInfo

    : public WindowsTargetInfo<AArch64leTargetInfo> {

  const llvm::Triple Triple;

public:

  WindowsARM64TargetInfo(const llvm::Triple &Triple,

                         const TargetOptions &Opts);

  void setDataLayout() override;

  BuiltinVaListKind getBuiltinVaListKind() const override;

  CallingConvCheckResult checkCallingConvention(CallingConv CC) const override;

};

// Windows ARM, MS (C++) ABI

class LLVM_LIBRARY_VISIBILITY MicrosoftARM64TargetInfo

    : public WindowsARM64TargetInfo {

public:

  MicrosoftARM64TargetInfo(const llvm::Triple &Triple,

                           const TargetOptions &Opts);

  void getTargetDefines(const LangOptions &Opts,

                        MacroBuilder &Builder) const override;

  TargetInfo::CallingConvKind

  getCallingConvKind(bool ClangABICompat4) const override;

  unsigned getMinGlobalAlign(uint64_t TypeSize) const override;

};

// ARM64 MinGW target

class LLVM_LIBRARY_VISIBILITY MinGWARM64TargetInfo

    : public WindowsARM64TargetInfo {

public:

  MinGWARM64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);

};

class LLVM_LIBRARY_VISIBILITY AArch64beTargetInfo : public AArch64TargetInfo {

public:

  AArch64beTargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);

  void getTargetDefines(const LangOptions &Opts,

                        MacroBuilder &Builder) const override;

private:

  void setDataLayout() override;

};

class LLVM_LIBRARY_VISIBILITY DarwinAArch64TargetInfo

    : public DarwinTargetInfo<AArch64leTargetInfo> {

public:

  DarwinAArch64TargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts);

  BuiltinVaListKind getBuiltinVaListKind() const override;

 protected:

  void getOSDefines(const LangOptions &Opts, const llvm::Triple &Triple,

                    MacroBuilder &Builder) const override;

};

// 64-bit RenderScript is aarch64

class LLVM_LIBRARY_VISIBILITY RenderScript64TargetInfo

    : public AArch64leTargetInfo {

public:

  RenderScript64TargetInfo(const llvm::Triple &Triple,

                           const TargetOptions &Opts);

  void getTargetDefines(const LangOptions &Opts,

                        MacroBuilder &Builder) const override;

};

} // namespace targets

} // namespace clang

#endif // LLVM_CLANG_LIB_BASIC_TARGETS_AARCH64_H