//===--- AMDGPU.cpp - Implement AMDGPU target feature support -------------===//

//

// 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 implements AMDGPU TargetInfo objects.

//

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

#include "AMDGPU.h"

#include "clang/Basic/Builtins.h"

#include "clang/Basic/CodeGenOptions.h"

#include "clang/Basic/Diagnostic.h"

#include "clang/Basic/LangOptions.h"

#include "clang/Basic/MacroBuilder.h"

#include "clang/Basic/TargetBuiltins.h"

using namespace clang;

using namespace clang::targets;

namespace clang {

namespace targets {

// If you edit the description strings, make sure you update

// getPointerWidthV().

static const char *const DataLayoutStringR600 =

    "e-p:32:32-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128"

    "-v192:256-v256:256-v512:512-v1024:1024-v2048:2048-n32:64-S32-A5-G1";

static const char *const DataLayoutStringAMDGCN =

    "e-p:64:64-p1:64:64-p2:32:32-p3:32:32-p4:64:64-p5:32:32-p6:32:32"

    "-p7:160:256:256:32-p8:128:128-p9:192:256:256:32-i64:64-v16:16-v24:32-v32:"

    "32-v48:64-v96:128"

    "-v192:256-v256:256-v512:512-v1024:1024-v2048:2048-n32:64-S32-A5-G1"

    "-ni:7:8:9";

const LangASMap AMDGPUTargetInfo::AMDGPUDefIsGenMap = {

    llvm::AMDGPUAS::FLAT_ADDRESS,     // Default

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // opencl_global

    llvm::AMDGPUAS::LOCAL_ADDRESS,    // opencl_local

    llvm::AMDGPUAS::CONSTANT_ADDRESS, // opencl_constant

    llvm::AMDGPUAS::PRIVATE_ADDRESS,  // opencl_private

    llvm::AMDGPUAS::FLAT_ADDRESS,     // opencl_generic

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // opencl_global_device

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // opencl_global_host

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // cuda_device

    llvm::AMDGPUAS::CONSTANT_ADDRESS, // cuda_constant

    llvm::AMDGPUAS::LOCAL_ADDRESS,    // cuda_shared

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // sycl_global

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // sycl_global_device

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // sycl_global_host

    llvm::AMDGPUAS::LOCAL_ADDRESS,    // sycl_local

    llvm::AMDGPUAS::PRIVATE_ADDRESS,  // sycl_private

    llvm::AMDGPUAS::FLAT_ADDRESS,     // ptr32_sptr

    llvm::AMDGPUAS::FLAT_ADDRESS,     // ptr32_uptr

    llvm::AMDGPUAS::FLAT_ADDRESS,     // ptr64

    llvm::AMDGPUAS::FLAT_ADDRESS,     // hlsl_groupshared

};

const LangASMap AMDGPUTargetInfo::AMDGPUDefIsPrivMap = {

    llvm::AMDGPUAS::PRIVATE_ADDRESS,  // Default

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // opencl_global

    llvm::AMDGPUAS::LOCAL_ADDRESS,    // opencl_local

    llvm::AMDGPUAS::CONSTANT_ADDRESS, // opencl_constant

    llvm::AMDGPUAS::PRIVATE_ADDRESS,  // opencl_private

    llvm::AMDGPUAS::FLAT_ADDRESS,     // opencl_generic

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // opencl_global_device

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // opencl_global_host

    llvm::AMDGPUAS::GLOBAL_ADDRESS,   // cuda_device

    llvm::AMDGPUAS::CONSTANT_ADDRESS, // cuda_constant

    llvm::AMDGPUAS::LOCAL_ADDRESS,    // cuda_shared

    // SYCL address space values for this map are dummy

    llvm::AMDGPUAS::FLAT_ADDRESS, // sycl_global

    llvm::AMDGPUAS::FLAT_ADDRESS, // sycl_global_device

    llvm::AMDGPUAS::FLAT_ADDRESS, // sycl_global_host

    llvm::AMDGPUAS::FLAT_ADDRESS, // sycl_local

    llvm::AMDGPUAS::FLAT_ADDRESS, // sycl_private

    llvm::AMDGPUAS::FLAT_ADDRESS, // ptr32_sptr

    llvm::AMDGPUAS::FLAT_ADDRESS, // ptr32_uptr

    llvm::AMDGPUAS::FLAT_ADDRESS, // ptr64

    llvm::AMDGPUAS::FLAT_ADDRESS, // hlsl_groupshared

};

} // namespace targets

} // namespace clang

static constexpr Builtin::Info BuiltinInfo[] = {

#define BUILTIN(ID, TYPE, ATTRS)                                               \

  {#ID, TYPE, ATTRS, nullptr, HeaderDesc::NO_HEADER, ALL_LANGUAGES},

#define TARGET_BUILTIN(ID, TYPE, ATTRS, FEATURE)                               \

  {#ID, TYPE, ATTRS, FEATURE, HeaderDesc::NO_HEADER, ALL_LANGUAGES},

#include "clang/Basic/BuiltinsAMDGPU.def"

};

const char *const AMDGPUTargetInfo::GCCRegNames[] = {

  "v0", "v1", "v2", "v3", "v4", "v5", "v6", "v7", "v8",

  "v9", "v10", "v11", "v12", "v13", "v14", "v15", "v16", "v17",

  "v18", "v19", "v20", "v21", "v22", "v23", "v24", "v25", "v26",

  "v27", "v28", "v29", "v30", "v31", "v32", "v33", "v34", "v35",

  "v36", "v37", "v38", "v39", "v40", "v41", "v42", "v43", "v44",

  "v45", "v46", "v47", "v48", "v49", "v50", "v51", "v52", "v53",

  "v54", "v55", "v56", "v57", "v58", "v59", "v60", "v61", "v62",

  "v63", "v64", "v65", "v66", "v67", "v68", "v69", "v70", "v71",

  "v72", "v73", "v74", "v75", "v76", "v77", "v78", "v79", "v80",

  "v81", "v82", "v83", "v84", "v85", "v86", "v87", "v88", "v89",

  "v90", "v91", "v92", "v93", "v94", "v95", "v96", "v97", "v98",

  "v99", "v100", "v101", "v102", "v103", "v104", "v105", "v106", "v107",

  "v108", "v109", "v110", "v111", "v112", "v113", "v114", "v115", "v116",

  "v117", "v118", "v119", "v120", "v121", "v122", "v123", "v124", "v125",

  "v126", "v127", "v128", "v129", "v130", "v131", "v132", "v133", "v134",

  "v135", "v136", "v137", "v138", "v139", "v140", "v141", "v142", "v143",

  "v144", "v145", "v146", "v147", "v148", "v149", "v150", "v151", "v152",

  "v153", "v154", "v155", "v156", "v157", "v158", "v159", "v160", "v161",

  "v162", "v163", "v164", "v165", "v166", "v167", "v168", "v169", "v170",

  "v171", "v172", "v173", "v174", "v175", "v176", "v177", "v178", "v179",

  "v180", "v181", "v182", "v183", "v184", "v185", "v186", "v187", "v188",

  "v189", "v190", "v191", "v192", "v193", "v194", "v195", "v196", "v197",

  "v198", "v199", "v200", "v201", "v202", "v203", "v204", "v205", "v206",

  "v207", "v208", "v209", "v210", "v211", "v212", "v213", "v214", "v215",

  "v216", "v217", "v218", "v219", "v220", "v221", "v222", "v223", "v224",

  "v225", "v226", "v227", "v228", "v229", "v230", "v231", "v232", "v233",

  "v234", "v235", "v236", "v237", "v238", "v239", "v240", "v241", "v242",

  "v243", "v244", "v245", "v246", "v247", "v248", "v249", "v250", "v251",

  "v252", "v253", "v254", "v255", "s0", "s1", "s2", "s3", "s4",

  "s5", "s6", "s7", "s8", "s9", "s10", "s11", "s12", "s13",

  "s14", "s15", "s16", "s17", "s18", "s19", "s20", "s21", "s22",

  "s23", "s24", "s25", "s26", "s27", "s28", "s29", "s30", "s31",

  "s32", "s33", "s34", "s35", "s36", "s37", "s38", "s39", "s40",

  "s41", "s42", "s43", "s44", "s45", "s46", "s47", "s48", "s49",

  "s50", "s51", "s52", "s53", "s54", "s55", "s56", "s57", "s58",

  "s59", "s60", "s61", "s62", "s63", "s64", "s65", "s66", "s67",

  "s68", "s69", "s70", "s71", "s72", "s73", "s74", "s75", "s76",

  "s77", "s78", "s79", "s80", "s81", "s82", "s83", "s84", "s85",

  "s86", "s87", "s88", "s89", "s90", "s91", "s92", "s93", "s94",

  "s95", "s96", "s97", "s98", "s99", "s100", "s101", "s102", "s103",

  "s104", "s105", "s106", "s107", "s108", "s109", "s110", "s111", "s112",

  "s113", "s114", "s115", "s116", "s117", "s118", "s119", "s120", "s121",

  "s122", "s123", "s124", "s125", "s126", "s127", "exec", "vcc", "scc",

  "m0", "flat_scratch", "exec_lo", "exec_hi", "vcc_lo", "vcc_hi",

  "flat_scratch_lo", "flat_scratch_hi",

  "a0", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8",

  "a9", "a10", "a11", "a12", "a13", "a14", "a15", "a16", "a17",

  "a18", "a19", "a20", "a21", "a22", "a23", "a24", "a25", "a26",

  "a27", "a28", "a29", "a30", "a31", "a32", "a33", "a34", "a35",

  "a36", "a37", "a38", "a39", "a40", "a41", "a42", "a43", "a44",

  "a45", "a46", "a47", "a48", "a49", "a50", "a51", "a52", "a53",

  "a54", "a55", "a56", "a57", "a58", "a59", "a60", "a61", "a62",

  "a63", "a64", "a65", "a66", "a67", "a68", "a69", "a70", "a71",

  "a72", "a73", "a74", "a75", "a76", "a77", "a78", "a79", "a80",

  "a81", "a82", "a83", "a84", "a85", "a86", "a87", "a88", "a89",

  "a90", "a91", "a92", "a93", "a94", "a95", "a96", "a97", "a98",

  "a99", "a100", "a101", "a102", "a103", "a104", "a105", "a106", "a107",

  "a108", "a109", "a110", "a111", "a112", "a113", "a114", "a115", "a116",

  "a117", "a118", "a119", "a120", "a121", "a122", "a123", "a124", "a125",

  "a126", "a127", "a128", "a129", "a130", "a131", "a132", "a133", "a134",

  "a135", "a136", "a137", "a138", "a139", "a140", "a141", "a142", "a143",

  "a144", "a145", "a146", "a147", "a148", "a149", "a150", "a151", "a152",

  "a153", "a154", "a155", "a156", "a157", "a158", "a159", "a160", "a161",

  "a162", "a163", "a164", "a165", "a166", "a167", "a168", "a169", "a170",

  "a171", "a172", "a173", "a174", "a175", "a176", "a177", "a178", "a179",

  "a180", "a181", "a182", "a183", "a184", "a185", "a186", "a187", "a188",

  "a189", "a190", "a191", "a192", "a193", "a194", "a195", "a196", "a197",

  "a198", "a199", "a200", "a201", "a202", "a203", "a204", "a205", "a206",

  "a207", "a208", "a209", "a210", "a211", "a212", "a213", "a214", "a215",

  "a216", "a217", "a218", "a219", "a220", "a221", "a222", "a223", "a224",

  "a225", "a226", "a227", "a228", "a229", "a230", "a231", "a232", "a233",

  "a234", "a235", "a236", "a237", "a238", "a239", "a240", "a241", "a242",

  "a243", "a244", "a245", "a246", "a247", "a248", "a249", "a250", "a251",

  "a252", "a253", "a254", "a255"

};

ArrayRef<const char *> AMDGPUTargetInfo::getGCCRegNames() const {

  return llvm::ArrayRef(GCCRegNames);

}

bool AMDGPUTargetInfo::initFeatureMap(

    llvm::StringMap<bool> &Features, DiagnosticsEngine &Diags, StringRef CPU,

    const std::vector<std::string> &FeatureVec) const {

  using namespace llvm::AMDGPU;

  fillAMDGPUFeatureMap(CPU, getTriple(), Features);

  if (!TargetInfo::initFeatureMap(Features, Diags, CPU, FeatureVec))

    return false;

  // TODO: Should move this logic into TargetParser

  std::string ErrorMsg;

  if (!insertWaveSizeFeature(CPU, getTriple(), Features, ErrorMsg)) {

    Diags.Report(diag::err_invalid_feature_combination) << ErrorMsg;

    return false;

  }

  return true;

}

void AMDGPUTargetInfo::fillValidCPUList(

    SmallVectorImpl<StringRef> &Values) const {

  if (isAMDGCN(getTriple()))

    llvm::AMDGPU::fillValidArchListAMDGCN(Values);

  else

    llvm::AMDGPU::fillValidArchListR600(Values);

}

void AMDGPUTargetInfo::setAddressSpaceMap(bool DefaultIsPrivate) {

  AddrSpaceMap = DefaultIsPrivate ? &AMDGPUDefIsPrivMap : &AMDGPUDefIsGenMap;

}

AMDGPUTargetInfo::AMDGPUTargetInfo(const llvm::Triple &Triple,

                                   const TargetOptions &Opts)

    : TargetInfo(Triple),

      GPUKind(isAMDGCN(Triple) ?

              llvm::AMDGPU::parseArchAMDGCN(Opts.CPU) :

              llvm::AMDGPU::parseArchR600(Opts.CPU)),

      GPUFeatures(isAMDGCN(Triple) ?

                  llvm::AMDGPU::getArchAttrAMDGCN(GPUKind) :

                  llvm::AMDGPU::getArchAttrR600(GPUKind)) {

  resetDataLayout(isAMDGCN(getTriple()) ? DataLayoutStringAMDGCN

                                        : DataLayoutStringR600);

  setAddressSpaceMap(Triple.getOS() == llvm::Triple::Mesa3D ||

                     !isAMDGCN(Triple));

  UseAddrSpaceMapMangling = true;

  if (isAMDGCN(Triple)) {

    // __bf16 is always available as a load/store only type on AMDGCN.

    BFloat16Width = BFloat16Align = 16;

    BFloat16Format = &llvm::APFloat::BFloat();

  }

  HasLegalHalfType = true;

  HasFloat16 = true;

  WavefrontSize = GPUFeatures & llvm::AMDGPU::FEATURE_WAVE32 ? 32 : 64;

  AllowAMDGPUUnsafeFPAtomics = Opts.AllowAMDGPUUnsafeFPAtomics;

  // Set pointer width and alignment for the generic address space.

  PointerWidth = PointerAlign = getPointerWidthV(LangAS::Default);

  if (getMaxPointerWidth() == 64) {

    LongWidth = LongAlign = 64;

    SizeType = UnsignedLong;

    PtrDiffType = SignedLong;

    IntPtrType = SignedLong;

  }

  MaxAtomicPromoteWidth = MaxAtomicInlineWidth = 64;

  CUMode = !(GPUFeatures & llvm::AMDGPU::FEATURE_WGP);

  for (auto F : {"image-insts", "gws"})

    ReadOnlyFeatures.insert(F);

  HalfArgsAndReturns = true;

}

void AMDGPUTargetInfo::adjust(DiagnosticsEngine &Diags, LangOptions &Opts) {

  TargetInfo::adjust(Diags, Opts);

  // ToDo: There are still a few places using default address space as private

  // address space in OpenCL, which needs to be cleaned up, then Opts.OpenCL

  // can be removed from the following line.

  setAddressSpaceMap(/*DefaultIsPrivate=*/Opts.OpenCL ||

                     !isAMDGCN(getTriple()));

}

ArrayRef<Builtin::Info> AMDGPUTargetInfo::getTargetBuiltins() const {

  return llvm::ArrayRef(BuiltinInfo,

                        clang::AMDGPU::LastTSBuiltin - Builtin::FirstTSBuiltin);

}

void AMDGPUTargetInfo::getTargetDefines(const LangOptions &Opts,

                                        MacroBuilder &Builder) const {

  Builder.defineMacro("__AMD__");

  Builder.defineMacro("__AMDGPU__");

  if (isAMDGCN(getTriple()))

    Builder.defineMacro("__AMDGCN__");

  else

    Builder.defineMacro("__R600__");

  if (GPUKind != llvm::AMDGPU::GK_NONE) {

    StringRef CanonName = isAMDGCN(getTriple()) ?

      getArchNameAMDGCN(GPUKind) : getArchNameR600(GPUKind);

    Builder.defineMacro(Twine("__") + Twine(CanonName) + Twine("__"));

    // Emit macros for gfx family e.g. gfx906 -> __GFX9__, gfx1030 -> __GFX10___

    if (isAMDGCN(getTriple())) {

      assert(CanonName.starts_with("gfx") && "Invalid amdgcn canonical name");

      Builder.defineMacro(Twine("__") + Twine(CanonName.drop_back(2).upper()) +

                          Twine("__"));

    }

    if (isAMDGCN(getTriple())) {

      Builder.defineMacro("__amdgcn_processor__",

                          Twine("\"") + Twine(CanonName) + Twine("\""));

      Builder.defineMacro("__amdgcn_target_id__",

                          Twine("\"") + Twine(*getTargetID()) + Twine("\""));

      for (auto F : getAllPossibleTargetIDFeatures(getTriple(), CanonName)) {

        auto Loc = OffloadArchFeatures.find(F);

        if (Loc != OffloadArchFeatures.end()) {

          std::string NewF = F.str();

          std::replace(NewF.begin(), NewF.end(), '-', '_');

          Builder.defineMacro(Twine("__amdgcn_feature_") + Twine(NewF) +

                                  Twine("__"),

                              Loc->second ? "1" : "0");

        }

      }

    }

  }

  if (AllowAMDGPUUnsafeFPAtomics)

    Builder.defineMacro("__AMDGCN_UNSAFE_FP_ATOMICS__");

  // TODO: __HAS_FMAF__, __HAS_LDEXPF__, __HAS_FP64__ are deprecated and will be

  // removed in the near future.

  if (hasFMAF())

    Builder.defineMacro("__HAS_FMAF__");

  if (hasFastFMAF())

    Builder.defineMacro("FP_FAST_FMAF");

  if (hasLDEXPF())

    Builder.defineMacro("__HAS_LDEXPF__");

  if (hasFP64())

    Builder.defineMacro("__HAS_FP64__");

  if (hasFastFMA())

    Builder.defineMacro("FP_FAST_FMA");

  Builder.defineMacro("__AMDGCN_WAVEFRONT_SIZE__", Twine(WavefrontSize));

  // ToDo: deprecate this macro for naming consistency.

  Builder.defineMacro("__AMDGCN_WAVEFRONT_SIZE", Twine(WavefrontSize));

  Builder.defineMacro("__AMDGCN_CUMODE__", Twine(CUMode));

}

void AMDGPUTargetInfo::setAuxTarget(const TargetInfo *Aux) {

  assert(HalfFormat == Aux->HalfFormat);

  assert(FloatFormat == Aux->FloatFormat);

  assert(DoubleFormat == Aux->DoubleFormat);

  // On x86_64 long double is 80-bit extended precision format, which is

  // not supported by AMDGPU. 128-bit floating point format is also not

  // supported by AMDGPU. Therefore keep its own format for these two types.

  auto SaveLongDoubleFormat = LongDoubleFormat;

  auto SaveFloat128Format = Float128Format;

  auto SaveLongDoubleWidth = LongDoubleWidth;

  auto SaveLongDoubleAlign = LongDoubleAlign;

  copyAuxTarget(Aux);

  LongDoubleFormat = SaveLongDoubleFormat;

  Float128Format = SaveFloat128Format;

  LongDoubleWidth = SaveLongDoubleWidth;

  LongDoubleAlign = SaveLongDoubleAlign;

  // For certain builtin types support on the host target, claim they are

  // support to pass the compilation of the host code during the device-side

  // compilation.

  // FIXME: As the side effect, we also accept `__float128` uses in the device

  // code. To rejct these builtin types supported in the host target but not in

  // the device target, one approach would support `device_builtin` attribute

  // so that we could tell the device builtin types from the host ones. The

  // also solves the different representations of the same builtin type, such

  // as `size_t` in the MSVC environment.

  if (Aux->hasFloat128Type()) {

    HasFloat128 = true;

    Float128Format = DoubleFormat;

  }

}