/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/CodeGen/CGDebugInfo.cpp

Bug Summary

File:	clang/lib/CodeGen/CGDebugInfo.cpp
Warning:	line 1597, column 19 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name CGDebugInfo.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -relaxed-aliasing -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/lib/CodeGen -resource-dir /usr/lib/llvm-14/lib/clang/14.0.0 -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/lib/CodeGen -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/CodeGen -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/llvm/include -D NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-14/lib/clang/14.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/lib/CodeGen -fdebug-prefix-map=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e=. -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2021-09-04-040900-46481-1 -x c++ /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/CodeGen/CGDebugInfo.cpp

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/CodeGen/CGDebugInfo.cpp

→

1//===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
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 coordinates the debug information generation while generating code.
10//
11//===----------------------------------------------------------------------===//

13#include "CGDebugInfo.h"
14#include "CGBlocks.h"
15#include "CGCXXABI.h"
16#include "CGObjCRuntime.h"
17#include "CGRecordLayout.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
20#include "ConstantEmitter.h"
21#include "clang/AST/ASTContext.h"
22#include "clang/AST/Attr.h"
23#include "clang/AST/DeclFriend.h"
24#include "clang/AST/DeclObjC.h"
25#include "clang/AST/DeclTemplate.h"
26#include "clang/AST/Expr.h"
27#include "clang/AST/RecordLayout.h"
28#include "clang/Basic/CodeGenOptions.h"
29#include "clang/Basic/FileManager.h"
30#include "clang/Basic/SourceManager.h"
31#include "clang/Basic/Version.h"
32#include "clang/Frontend/FrontendOptions.h"
33#include "clang/Lex/HeaderSearchOptions.h"
34#include "clang/Lex/ModuleMap.h"
35#include "clang/Lex/PreprocessorOptions.h"
36#include "llvm/ADT/DenseSet.h"
37#include "llvm/ADT/SmallVector.h"
38#include "llvm/ADT/StringExtras.h"
39#include "llvm/IR/Constants.h"
40#include "llvm/IR/DataLayout.h"
41#include "llvm/IR/DerivedTypes.h"
42#include "llvm/IR/Instructions.h"
43#include "llvm/IR/Intrinsics.h"
44#include "llvm/IR/Metadata.h"
45#include "llvm/IR/Module.h"
46#include "llvm/Support/FileSystem.h"
47#include "llvm/Support/MD5.h"
48#include "llvm/Support/Path.h"
49#include "llvm/Support/TimeProfiler.h"
50using namespace clang;
51using namespace clang::CodeGen;

53static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
auto TI = Ctx.getTypeInfo(Ty);
return TI.isAlignRequired() ? TI.Align : 0;
56}

58static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
60}

62static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
64}

66CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
  : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
    DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
    DBuilder(CGM.getModule()) {
for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
  DebugPrefixMap[KV.first] = KV.second;
CreateCompileUnit();
73}

75CGDebugInfo::~CGDebugInfo() {
assert(LexicalBlockStack.empty() &&(static_cast<void> (0))
       "Region stack mismatch, stack not empty!")(static_cast<void> (0));
78}

80ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
                                     SourceLocation TemporaryLocation)
  : CGF(&CGF) {
init(TemporaryLocation);
84}

86ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
                                     bool DefaultToEmpty,
                                     SourceLocation TemporaryLocation)
  : CGF(&CGF) {
init(TemporaryLocation, DefaultToEmpty);
91}

93void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
                            bool DefaultToEmpty) {
auto *DI = CGF->getDebugInfo();
if (!DI) {
  CGF = nullptr;
  return;
}

OriginalLocation = CGF->Builder.getCurrentDebugLocation();

if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
  return;

if (TemporaryLocation.isValid()) {
  DI->EmitLocation(CGF->Builder, TemporaryLocation);
  return;
}

if (DefaultToEmpty) {
  CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
  return;
}

// Construct a location that has a valid scope, but no line info.
assert(!DI->LexicalBlockStack.empty())(static_cast<void> (0));
CGF->Builder.SetCurrentDebugLocation(
    llvm::DILocation::get(DI->LexicalBlockStack.back()->getContext(), 0, 0,
                          DI->LexicalBlockStack.back(), DI->getInlinedAt()));
121}

123ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
  : CGF(&CGF) {
init(E->getExprLoc());
126}

128ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
  : CGF(&CGF) {
if (!CGF.getDebugInfo()) {
  this->CGF = nullptr;
  return;
}
OriginalLocation = CGF.Builder.getCurrentDebugLocation();
if (Loc)
  CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
137}

139ApplyDebugLocation::~ApplyDebugLocation() {
// Query CGF so the location isn't overwritten when location updates are
// temporarily disabled (for C++ default function arguments)
if (CGF)
  CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
144}

146ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
                                                 GlobalDecl InlinedFn)
  : CGF(&CGF) {
if (!CGF.getDebugInfo()) {
  this->CGF = nullptr;
  return;
}
auto &DI = *CGF.getDebugInfo();
SavedLocation = DI.getLocation();
assert((DI.getInlinedAt() ==(static_cast<void> (0))
        CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&(static_cast<void> (0))
       "CGDebugInfo and IRBuilder are out of sync")(static_cast<void> (0));

DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
160}

162ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
if (!CGF)
  return;
auto &DI = *CGF->getDebugInfo();
DI.EmitInlineFunctionEnd(CGF->Builder);
DI.EmitLocation(CGF->Builder, SavedLocation);
168}

170void CGDebugInfo::setLocation(SourceLocation Loc) {
// If the new location isn't valid return.
if (Loc.isInvalid())
  return;

CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);

// If we've changed files in the middle of a lexical scope go ahead
// and create a new lexical scope with file node if it's different
// from the one in the scope.
if (LexicalBlockStack.empty())
  return;

SourceManager &SM = CGM.getContext().getSourceManager();
auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
if (PCLoc.isInvalid() || Scope->getFile() == getOrCreateFile(CurLoc))
  return;

if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
  LexicalBlockStack.pop_back();
  LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
      LBF->getScope(), getOrCreateFile(CurLoc)));
} else if (isa<llvm::DILexicalBlock>(Scope) ||
           isa<llvm::DISubprogram>(Scope)) {
  LexicalBlockStack.pop_back();
  LexicalBlockStack.emplace_back(
      DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
}
199}

201llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
llvm::DIScope *Mod = getParentModuleOrNull(D);
return getContextDescriptor(cast<Decl>(D->getDeclContext()),
                            Mod ? Mod : TheCU);
205}

207llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
                                               llvm::DIScope *Default) {
if (!Context)
  return Default;

auto I = RegionMap.find(Context);
if (I != RegionMap.end()) {
  llvm::Metadata *V = I->second;
  return dyn_cast_or_null<llvm::DIScope>(V);
}

// Check namespace.
if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
  return getOrCreateNamespace(NSDecl);

if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
  if (!RDecl->isDependentType())
    return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
                           TheCU->getFile());
return Default;
227}

229PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
PrintingPolicy PP = CGM.getContext().getPrintingPolicy();

// If we're emitting codeview, it's important to try to match MSVC's naming so
// that visualizers written for MSVC will trigger for our class names. In
// particular, we can't have spaces between arguments of standard templates
// like basic_string and vector, but we must have spaces between consecutive
// angle brackets that close nested template argument lists.
if (CGM.getCodeGenOpts().EmitCodeView) {
  PP.MSVCFormatting = true;
  PP.SplitTemplateClosers = true;
} else {
  // For DWARF, printing rules are underspecified.
  // SplitTemplateClosers yields better interop with GCC and GDB (PR46052).
  PP.SplitTemplateClosers = true;
}

// Apply -fdebug-prefix-map.
PP.Callbacks = &PrintCB;
return PP;
249}

251StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
return internString(GetName(FD));
253}

255StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
SmallString<256> MethodName;
llvm::raw_svector_ostream OS(MethodName);
OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
const DeclContext *DC = OMD->getDeclContext();
if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
  OS << OID->getName();
} else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
  OS << OID->getName();
} else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
  if (OC->IsClassExtension()) {
    OS << OC->getClassInterface()->getName();
  } else {
    OS << OC->getIdentifier()->getNameStart() << '('
       << OC->getIdentifier()->getNameStart() << ')';
  }
} else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
  OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
}
OS << ' ' << OMD->getSelector().getAsString() << ']';

return internString(OS.str());
277}

279StringRef CGDebugInfo::getSelectorName(Selector S) {
return internString(S.getAsString());
281}

283StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
if (isa<ClassTemplateSpecializationDecl>(RD)) {
  // Copy this name on the side and use its reference.
  return internString(GetName(RD));
}

// quick optimization to avoid having to intern strings that are already
// stored reliably elsewhere
if (const IdentifierInfo *II = RD->getIdentifier())
  return II->getName();

// The CodeView printer in LLVM wants to see the names of unnamed types
// because they need to have a unique identifier.
// These names are used to reconstruct the fully qualified type names.
if (CGM.getCodeGenOpts().EmitCodeView) {
  if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
    assert(RD->getDeclContext() == D->getDeclContext() &&(static_cast<void> (0))
           "Typedef should not be in another decl context!")(static_cast<void> (0));
    assert(D->getDeclName().getAsIdentifierInfo() &&(static_cast<void> (0))
           "Typedef was not named!")(static_cast<void> (0));
    return D->getDeclName().getAsIdentifierInfo()->getName();
  }

  if (CGM.getLangOpts().CPlusPlus) {
    StringRef Name;

    ASTContext &Context = CGM.getContext();
    if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
      // Anonymous types without a name for linkage purposes have their
      // declarator mangled in if they have one.
      Name = DD->getName();
    else if (const TypedefNameDecl *TND =
                 Context.getTypedefNameForUnnamedTagDecl(RD))
      // Anonymous types without a name for linkage purposes have their
      // associate typedef mangled in if they have one.
      Name = TND->getName();

    // Give lambdas a display name based on their name mangling.
    if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
      if (CXXRD->isLambda())
        return internString(
            CGM.getCXXABI().getMangleContext().getLambdaString(CXXRD));

    if (!Name.empty()) {
      SmallString<256> UnnamedType("<unnamed-type-");
      UnnamedType += Name;
      UnnamedType += '>';
      return internString(UnnamedType);
    }
  }
}

return StringRef();
336}

338Optional<llvm::DIFile::ChecksumKind>
339CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
Checksum.clear();

if (!CGM.getCodeGenOpts().EmitCodeView &&
    CGM.getCodeGenOpts().DwarfVersion < 5)
  return None;

SourceManager &SM = CGM.getContext().getSourceManager();
Optional<llvm::MemoryBufferRef> MemBuffer = SM.getBufferOrNone(FID);
if (!MemBuffer)
  return None;

llvm::MD5 Hash;
llvm::MD5::MD5Result Result;

Hash.update(MemBuffer->getBuffer());
Hash.final(Result);

Hash.stringifyResult(Result, Checksum);
return llvm::DIFile::CSK_MD5;
359}

361Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
                                         FileID FID) {
if (!CGM.getCodeGenOpts().EmbedSource)
  return None;

bool SourceInvalid = false;
StringRef Source = SM.getBufferData(FID, &SourceInvalid);

if (SourceInvalid)
  return None;

return Source;
373}

375llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
SourceManager &SM = CGM.getContext().getSourceManager();
StringRef FileName;
FileID FID;

if (Loc.isInvalid()) {
  // The DIFile used by the CU is distinct from the main source file. Call
  // createFile() below for canonicalization if the source file was specified
  // with an absolute path.
  FileName = TheCU->getFile()->getFilename();
} else {
  PresumedLoc PLoc = SM.getPresumedLoc(Loc);
  FileName = PLoc.getFilename();
  
  if (FileName.empty()) {
    FileName = TheCU->getFile()->getFilename();
  } else {
    FileName = PLoc.getFilename();
  }
  FID = PLoc.getFileID();
}

// Cache the results.
auto It = DIFileCache.find(FileName.data());
if (It != DIFileCache.end()) {
  // Verify that the information still exists.
  if (llvm::Metadata *V = It->second)
    return cast<llvm::DIFile>(V);
}

SmallString<32> Checksum;

Optional<llvm::DIFile::ChecksumKind> CSKind = computeChecksum(FID, Checksum);
Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
if (CSKind)
  CSInfo.emplace(*CSKind, Checksum);
return createFile(FileName, CSInfo, getSource(SM, SM.getFileID(Loc)));
412}

414llvm::DIFile *
415CGDebugInfo::createFile(StringRef FileName,
                      Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
                      Optional<StringRef> Source) {
StringRef Dir;
StringRef File;
std::string RemappedFile = remapDIPath(FileName);
std::string CurDir = remapDIPath(getCurrentDirname());
SmallString<128> DirBuf;
SmallString<128> FileBuf;
if (llvm::sys::path::is_absolute(RemappedFile)) {
  // Strip the common prefix (if it is more than just "/") from current
  // directory and FileName for a more space-efficient encoding.
  auto FileIt = llvm::sys::path::begin(RemappedFile);
  auto FileE = llvm::sys::path::end(RemappedFile);
  auto CurDirIt = llvm::sys::path::begin(CurDir);
  auto CurDirE = llvm::sys::path::end(CurDir);
  for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
    llvm::sys::path::append(DirBuf, *CurDirIt);
  if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
    // Don't strip the common prefix if it is only the root "/"
    // since that would make LLVM diagnostic locations confusing.
    Dir = {};
    File = RemappedFile;
  } else {
    for (; FileIt != FileE; ++FileIt)
      llvm::sys::path::append(FileBuf, *FileIt);
    Dir = DirBuf;
    File = FileBuf;
  }
} else {
  Dir = CurDir;
  File = RemappedFile;
}
llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
DIFileCache[FileName.data()].reset(F);
return F;
451}

453std::string CGDebugInfo::remapDIPath(StringRef Path) const {
if (DebugPrefixMap.empty())
  return Path.str();

SmallString<256> P = Path;
for (const auto &Entry : DebugPrefixMap)
  if (llvm::sys::path::replace_path_prefix(P, Entry.first, Entry.second))
    break;
return P.str().str();
462}

464unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
if (Loc.isInvalid())
  return 0;
SourceManager &SM = CGM.getContext().getSourceManager();
return SM.getPresumedLoc(Loc).getLine();
469}

471unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
// We may not want column information at all.
if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
  return 0;

// If the location is invalid then use the current column.
if (Loc.isInvalid() && CurLoc.isInvalid())
  return 0;
SourceManager &SM = CGM.getContext().getSourceManager();
PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
return PLoc.isValid() ? PLoc.getColumn() : 0;
482}

484StringRef CGDebugInfo::getCurrentDirname() {
if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
  return CGM.getCodeGenOpts().DebugCompilationDir;

if (!CWDName.empty())
  return CWDName;
SmallString<256> CWD;
llvm::sys::fs::current_path(CWD);
return CWDName = internString(CWD);
493}

495void CGDebugInfo::CreateCompileUnit() {
SmallString<32> Checksum;
Optional<llvm::DIFile::ChecksumKind> CSKind;
Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;

// Should we be asking the SourceManager for the main file name, instead of
// accepting it as an argument? This just causes the main file name to
// mismatch with source locations and create extra lexical scopes or
// mismatched debug info (a CU with a DW_AT_file of "-", because that's what
// the driver passed, but functions/other things have DW_AT_file of "<stdin>"
// because that's what the SourceManager says)

// Get absolute path name.
SourceManager &SM = CGM.getContext().getSourceManager();
std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
if (MainFileName.empty())
  MainFileName = "<stdin>";

// The main file name provided via the "-main-file-name" option contains just
// the file name itself with no path information. This file name may have had
// a relative path, so we look into the actual file entry for the main
// file to determine the real absolute path for the file.
std::string MainFileDir;
if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
  MainFileDir = std::string(MainFile->getDir()->getName());
  if (!llvm::sys::path::is_absolute(MainFileName)) {
    llvm::SmallString<1024> MainFileDirSS(MainFileDir);
    llvm::sys::path::append(MainFileDirSS, MainFileName);
    MainFileName =
        std::string(llvm::sys::path::remove_leading_dotslash(MainFileDirSS));
  }
  // If the main file name provided is identical to the input file name, and
  // if the input file is a preprocessed source, use the module name for
  // debug info. The module name comes from the name specified in the first
  // linemarker if the input is a preprocessed source.
  if (MainFile->getName() == MainFileName &&
      FrontendOptions::getInputKindForExtension(
          MainFile->getName().rsplit('.').second)
          .isPreprocessed())
    MainFileName = CGM.getModule().getName().str();

  CSKind = computeChecksum(SM.getMainFileID(), Checksum);
}

llvm::dwarf::SourceLanguage LangTag;
const LangOptions &LO = CGM.getLangOpts();
if (LO.CPlusPlus) {
  if (LO.ObjC)
    LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
  else if (LO.CPlusPlus14 && (!CGM.getCodeGenOpts().DebugStrictDwarf ||
                              CGM.getCodeGenOpts().DwarfVersion >= 5))
    LangTag = llvm::dwarf::DW_LANG_C_plus_plus_14;
  else if (LO.CPlusPlus11 && (!CGM.getCodeGenOpts().DebugStrictDwarf ||
                              CGM.getCodeGenOpts().DwarfVersion >= 5))
    LangTag = llvm::dwarf::DW_LANG_C_plus_plus_11;
  else
    LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
} else if (LO.ObjC) {
  LangTag = llvm::dwarf::DW_LANG_ObjC;
} else if (LO.OpenCL && (!CGM.getCodeGenOpts().DebugStrictDwarf ||
                         CGM.getCodeGenOpts().DwarfVersion >= 5)) {
  LangTag = llvm::dwarf::DW_LANG_OpenCL;
} else if (LO.RenderScript) {
  LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
} else if (LO.C99) {
  LangTag = llvm::dwarf::DW_LANG_C99;
} else {
  LangTag = llvm::dwarf::DW_LANG_C89;
}

std::string Producer = getClangFullVersion();

// Figure out which version of the ObjC runtime we have.
unsigned RuntimeVers = 0;
if (LO.ObjC)
  RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;

llvm::DICompileUnit::DebugEmissionKind EmissionKind;
switch (DebugKind) {
case codegenoptions::NoDebugInfo:
case codegenoptions::LocTrackingOnly:
  EmissionKind = llvm::DICompileUnit::NoDebug;
  break;
case codegenoptions::DebugLineTablesOnly:
  EmissionKind = llvm::DICompileUnit::LineTablesOnly;
  break;
case codegenoptions::DebugDirectivesOnly:
  EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
  break;
case codegenoptions::DebugInfoConstructor:
case codegenoptions::LimitedDebugInfo:
case codegenoptions::FullDebugInfo:
case codegenoptions::UnusedTypeInfo:
  EmissionKind = llvm::DICompileUnit::FullDebug;
  break;
}

uint64_t DwoId = 0;
auto &CGOpts = CGM.getCodeGenOpts();
// The DIFile used by the CU is distinct from the main source
// file. Its directory part specifies what becomes the
// DW_AT_comp_dir (the compilation directory), even if the source
// file was specified with an absolute path.
if (CSKind)
  CSInfo.emplace(*CSKind, Checksum);
llvm::DIFile *CUFile = DBuilder.createFile(
    remapDIPath(MainFileName), remapDIPath(getCurrentDirname()), CSInfo,
    getSource(SM, SM.getMainFileID()));

StringRef Sysroot, SDK;
if (CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB) {
  Sysroot = CGM.getHeaderSearchOpts().Sysroot;
  auto B = llvm::sys::path::rbegin(Sysroot);
  auto E = llvm::sys::path::rend(Sysroot);
  auto It = std::find_if(B, E, [](auto SDK) { return SDK.endswith(".sdk"); });
  if (It != E)
    SDK = *It;
}

// Create new compile unit.
TheCU = DBuilder.createCompileUnit(
    LangTag, CUFile, CGOpts.EmitVersionIdentMetadata ? Producer : "",
    LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
    CGOpts.DwarfDebugFlags, RuntimeVers, CGOpts.SplitDwarfFile, EmissionKind,
    DwoId, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
    CGM.getTarget().getTriple().isNVPTX()
        ? llvm::DICompileUnit::DebugNameTableKind::None
        : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
              CGOpts.DebugNameTable),
    CGOpts.DebugRangesBaseAddress, remapDIPath(Sysroot), SDK);
625}

627llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
llvm::dwarf::TypeKind Encoding;
StringRef BTName;
switch (BT->getKind()) {
631#define BUILTIN_TYPE(Id, SingletonId)
632#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
633#include "clang/AST/BuiltinTypes.def"
case BuiltinType::Dependent:
  llvm_unreachable("Unexpected builtin type")__builtin_unreachable();
case BuiltinType::NullPtr:
  return DBuilder.createNullPtrType();
case BuiltinType::Void:
  return nullptr;
case BuiltinType::ObjCClass:
  if (!ClassTy)
    ClassTy =
        DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
                                   "objc_class", TheCU, TheCU->getFile(), 0);
  return ClassTy;
case BuiltinType::ObjCId: {
  // typedef struct objc_class *Class;
  // typedef struct objc_object {
  //  Class isa;
  // } *id;

  if (ObjTy)
    return ObjTy;

  if (!ClassTy)
    ClassTy =
        DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
                                   "objc_class", TheCU, TheCU->getFile(), 0);

  unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);

  auto *ISATy = DBuilder.createPointerType(ClassTy, Size);

  ObjTy = DBuilder.createStructType(TheCU, "objc_object", TheCU->getFile(), 0,
                                    0, 0, llvm::DINode::FlagZero, nullptr,
                                    llvm::DINodeArray());

  DBuilder.replaceArrays(
      ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
                 ObjTy, "isa", TheCU->getFile(), 0, Size, 0, 0,
                 llvm::DINode::FlagZero, ISATy)));
  return ObjTy;
}
case BuiltinType::ObjCSel: {
  if (!SelTy)
    SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
                                       "objc_selector", TheCU,
                                       TheCU->getFile(), 0);
  return SelTy;
}

682#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
case BuiltinType::Id:                                                        \
  return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t",       \
                                  SingletonId);
686#include "clang/Basic/OpenCLImageTypes.def"
case BuiltinType::OCLSampler:
  return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
case BuiltinType::OCLEvent:
  return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
case BuiltinType::OCLClkEvent:
  return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
case BuiltinType::OCLQueue:
  return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
case BuiltinType::OCLReserveID:
  return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
697#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
case BuiltinType::Id: \
  return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
700#include "clang/Basic/OpenCLExtensionTypes.def"

702#define SVE_TYPE(Name, Id, SingletonId) case BuiltinType::Id:
703#include "clang/Basic/AArch64SVEACLETypes.def"
  {
    ASTContext::BuiltinVectorTypeInfo Info =
        CGM.getContext().getBuiltinVectorTypeInfo(BT);
    unsigned NumElemsPerVG = (Info.EC.getKnownMinValue() * Info.NumVectors) / 2;

    // Debuggers can't extract 1bit from a vector, so will display a
    // bitpattern for svbool_t instead.
    if (Info.ElementType == CGM.getContext().BoolTy) {
      NumElemsPerVG /= 8;
      Info.ElementType = CGM.getContext().UnsignedCharTy;
    }

    auto *LowerBound =
        llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
            llvm::Type::getInt64Ty(CGM.getLLVMContext()), 0));
    SmallVector<int64_t, 9> Expr(
        {llvm::dwarf::DW_OP_constu, NumElemsPerVG, llvm::dwarf::DW_OP_bregx,
         /* AArch64::VG */ 46, 0, llvm::dwarf::DW_OP_mul,
         llvm::dwarf::DW_OP_constu, 1, llvm::dwarf::DW_OP_minus});
    auto *UpperBound = DBuilder.createExpression(Expr);

    llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(
        /*count*/ nullptr, LowerBound, UpperBound, /*stride*/ nullptr);
    llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
    llvm::DIType *ElemTy =
        getOrCreateType(Info.ElementType, TheCU->getFile());
    auto Align = getTypeAlignIfRequired(BT, CGM.getContext());
    return DBuilder.createVectorType(/*Size*/ 0, Align, ElemTy,
                                     SubscriptArray);
  }
// It doesn't make sense to generate debug info for PowerPC MMA vector types.
// So we return a safe type here to avoid generating an error.
736#define PPC_VECTOR_TYPE(Name, Id, size) \
case BuiltinType::Id:
738#include "clang/Basic/PPCTypes.def"
  return CreateType(cast<const BuiltinType>(CGM.getContext().IntTy));

741#define RVV_TYPE(Name, Id, SingletonId) case BuiltinType::Id:
742#include "clang/Basic/RISCVVTypes.def"
  {
    ASTContext::BuiltinVectorTypeInfo Info =
        CGM.getContext().getBuiltinVectorTypeInfo(BT);

    unsigned ElementCount = Info.EC.getKnownMinValue();
    unsigned SEW = CGM.getContext().getTypeSize(Info.ElementType);

    bool Fractional = false;
    unsigned LMUL;
    unsigned FixedSize = ElementCount * SEW;
    if (Info.ElementType == CGM.getContext().BoolTy) {
      // Mask type only occupies one vector register.
      LMUL = 1;
    } else if (FixedSize < 64) {
      // In RVV scalable vector types, we encode 64 bits in the fixed part.
      Fractional = true;
      LMUL = 64 / FixedSize;
    } else {
      LMUL = FixedSize / 64;
    }

    // Element count = (VLENB / SEW) x LMUL
    SmallVector<int64_t, 9> Expr(
        // The DW_OP_bregx operation has two operands: a register which is
        // specified by an unsigned LEB128 number, followed by a signed LEB128
        // offset.
        {llvm::dwarf::DW_OP_bregx, // Read the contents of a register.
         4096 + 0xC22,             // RISC-V VLENB CSR register.
         0, // Offset for DW_OP_bregx. It is dummy here.
         llvm::dwarf::DW_OP_constu,
         SEW / 8, // SEW is in bits.
         llvm::dwarf::DW_OP_div, llvm::dwarf::DW_OP_constu, LMUL});
    if (Fractional)
      Expr.push_back(llvm::dwarf::DW_OP_div);
    else
      Expr.push_back(llvm::dwarf::DW_OP_mul);

    auto *LowerBound =
        llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
            llvm::Type::getInt64Ty(CGM.getLLVMContext()), 0));
    auto *UpperBound = DBuilder.createExpression(Expr);
    llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(
        /*count*/ nullptr, LowerBound, UpperBound, /*stride*/ nullptr);
    llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
    llvm::DIType *ElemTy =
        getOrCreateType(Info.ElementType, TheCU->getFile());

    auto Align = getTypeAlignIfRequired(BT, CGM.getContext());
    return DBuilder.createVectorType(/*Size=*/0, Align, ElemTy,
                                     SubscriptArray);
  }
case BuiltinType::UChar:
case BuiltinType::Char_U:
  Encoding = llvm::dwarf::DW_ATE_unsigned_char;
  break;
case BuiltinType::Char_S:
case BuiltinType::SChar:
  Encoding = llvm::dwarf::DW_ATE_signed_char;
  break;
case BuiltinType::Char8:
case BuiltinType::Char16:
case BuiltinType::Char32:
  Encoding = llvm::dwarf::DW_ATE_UTF;
  break;
case BuiltinType::UShort:
case BuiltinType::UInt:
case BuiltinType::UInt128:
case BuiltinType::ULong:
case BuiltinType::WChar_U:
case BuiltinType::ULongLong:
  Encoding = llvm::dwarf::DW_ATE_unsigned;
  break;
case BuiltinType::Short:
case BuiltinType::Int:
case BuiltinType::Int128:
case BuiltinType::Long:
case BuiltinType::WChar_S:
case BuiltinType::LongLong:
  Encoding = llvm::dwarf::DW_ATE_signed;
  break;
case BuiltinType::Bool:
  Encoding = llvm::dwarf::DW_ATE_boolean;
  break;
case BuiltinType::Half:
case BuiltinType::Float:
case BuiltinType::LongDouble:
case BuiltinType::Float16:
case BuiltinType::BFloat16:
case BuiltinType::Float128:
case BuiltinType::Double:
  // FIXME: For targets where long double and __float128 have the same size,
  // they are currently indistinguishable in the debugger without some
  // special treatment. However, there is currently no consensus on encoding
  // and this should be updated once a DWARF encoding exists for distinct
  // floating point types of the same size.
  Encoding = llvm::dwarf::DW_ATE_float;
  break;
case BuiltinType::ShortAccum:
case BuiltinType::Accum:
case BuiltinType::LongAccum:
case BuiltinType::ShortFract:
case BuiltinType::Fract:
case BuiltinType::LongFract:
case BuiltinType::SatShortFract:
case BuiltinType::SatFract:
case BuiltinType::SatLongFract:
case BuiltinType::SatShortAccum:
case BuiltinType::SatAccum:
case BuiltinType::SatLongAccum:
  Encoding = llvm::dwarf::DW_ATE_signed_fixed;
  break;
case BuiltinType::UShortAccum:
case BuiltinType::UAccum:
case BuiltinType::ULongAccum:
case BuiltinType::UShortFract:
case BuiltinType::UFract:
case BuiltinType::ULongFract:
case BuiltinType::SatUShortAccum:
case BuiltinType::SatUAccum:
case BuiltinType::SatULongAccum:
case BuiltinType::SatUShortFract:
case BuiltinType::SatUFract:
case BuiltinType::SatULongFract:
  Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
  break;
}

switch (BT->getKind()) {
case BuiltinType::Long:
  BTName = "long int";
  break;
case BuiltinType::LongLong:
  BTName = "long long int";
  break;
case BuiltinType::ULong:
  BTName = "long unsigned int";
  break;
case BuiltinType::ULongLong:
  BTName = "long long unsigned int";
  break;
default:
  BTName = BT->getName(CGM.getLangOpts());
  break;
}
// Bit size and offset of the type.
uint64_t Size = CGM.getContext().getTypeSize(BT);
return DBuilder.createBasicType(BTName, Size, Encoding);
890}

892llvm::DIType *CGDebugInfo::CreateType(const AutoType *Ty) {
return DBuilder.createUnspecifiedType("auto");
894}

896llvm::DIType *CGDebugInfo::CreateType(const ExtIntType *Ty) {

StringRef Name = Ty->isUnsigned() ? "unsigned _ExtInt" : "_ExtInt";
llvm::dwarf::TypeKind Encoding = Ty->isUnsigned()
                                     ? llvm::dwarf::DW_ATE_unsigned
                                     : llvm::dwarf::DW_ATE_signed;

return DBuilder.createBasicType(Name, CGM.getContext().getTypeSize(Ty),
                                Encoding);
905}

907llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
// Bit size and offset of the type.
llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
if (Ty->isComplexIntegerType())
  Encoding = llvm::dwarf::DW_ATE_lo_user;

uint64_t Size = CGM.getContext().getTypeSize(Ty);
return DBuilder.createBasicType("complex", Size, Encoding);
915}

917llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
                                             llvm::DIFile *Unit) {
QualifierCollector Qc;
const Type *T = Qc.strip(Ty);

// Ignore these qualifiers for now.
Qc.removeObjCGCAttr();
Qc.removeAddressSpace();
Qc.removeObjCLifetime();

// We will create one Derived type for one qualifier and recurse to handle any
// additional ones.
llvm::dwarf::Tag Tag;
if (Qc.hasConst()) {
  Tag = llvm::dwarf::DW_TAG_const_type;
  Qc.removeConst();
} else if (Qc.hasVolatile()) {
  Tag = llvm::dwarf::DW_TAG_volatile_type;
  Qc.removeVolatile();
} else if (Qc.hasRestrict()) {
  Tag = llvm::dwarf::DW_TAG_restrict_type;
  Qc.removeRestrict();
} else {
  assert(Qc.empty() && "Unknown type qualifier for debug info")(static_cast<void> (0));
  return getOrCreateType(QualType(T, 0), Unit);
}

auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);

// No need to fill in the Name, Line, Size, Alignment, Offset in case of
// CVR derived types.
return DBuilder.createQualifiedType(Tag, FromTy);
949}

951llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
                                    llvm::DIFile *Unit) {

// The frontend treats 'id' as a typedef to an ObjCObjectType,
// whereas 'id<protocol>' is treated as an ObjCPointerType. For the
// debug info, we want to emit 'id' in both cases.
if (Ty->isObjCQualifiedIdType())
  return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);

return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
                             Ty->getPointeeType(), Unit);
962}

964llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
                                    llvm::DIFile *Unit) {
return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
                             Ty->getPointeeType(), Unit);
968}

970/// \return whether a C++ mangling exists for the type defined by TD.
971static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
switch (TheCU->getSourceLanguage()) {
case llvm::dwarf::DW_LANG_C_plus_plus:
case llvm::dwarf::DW_LANG_C_plus_plus_11:
case llvm::dwarf::DW_LANG_C_plus_plus_14:
  return true;
case llvm::dwarf::DW_LANG_ObjC_plus_plus:
  return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
default:
  return false;
}
982}

984// Determines if the debug info for this tag declaration needs a type
985// identifier. The purpose of the unique identifier is to deduplicate type
986// information for identical types across TUs. Because of the C++ one definition
987// rule (ODR), it is valid to assume that the type is defined the same way in
988// every TU and its debug info is equivalent.
989//
990// C does not have the ODR, and it is common for codebases to contain multiple
991// different definitions of a struct with the same name in different TUs.
992// Therefore, if the type doesn't have a C++ mangling, don't give it an
993// identifer. Type information in C is smaller and simpler than C++ type
994// information, so the increase in debug info size is negligible.
995//
996// If the type is not externally visible, it should be unique to the current TU,
997// and should not need an identifier to participate in type deduplication.
998// However, when emitting CodeView, the format internally uses these
999// unique type name identifers for references between debug info. For example,
1000// the method of a class in an anonymous namespace uses the identifer to refer
1001// to its parent class. The Microsoft C++ ABI attempts to provide unique names
1002// for such types, so when emitting CodeView, always use identifiers for C++
1003// types. This may create problems when attempting to emit CodeView when the MS
1004// C++ ABI is not in use.
1005static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
                              llvm::DICompileUnit *TheCU) {
// We only add a type identifier for types with C++ name mangling.
if (!hasCXXMangling(TD, TheCU))
  return false;

// Externally visible types with C++ mangling need a type identifier.
if (TD->isExternallyVisible())
  return true;

// CodeView types with C++ mangling need a type identifier.
if (CGM.getCodeGenOpts().EmitCodeView)
  return true;

return false;
1020}

1022// Returns a unique type identifier string if one exists, or an empty string.
1023static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
                                        llvm::DICompileUnit *TheCU) {
SmallString<256> Identifier;
const TagDecl *TD = Ty->getDecl();

if (!needsTypeIdentifier(TD, CGM, TheCU))
  return Identifier;
if (const auto *RD = dyn_cast<CXXRecordDecl>(TD))
  if (RD->getDefinition())
    if (RD->isDynamicClass() &&
        CGM.getVTableLinkage(RD) == llvm::GlobalValue::ExternalLinkage)
      return Identifier;

// TODO: This is using the RTTI name. Is there a better way to get
// a unique string for a type?
llvm::raw_svector_ostream Out(Identifier);
CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
return Identifier;
1041}

1043/// \return the appropriate DWARF tag for a composite type.
1044static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
llvm::dwarf::Tag Tag;
if (RD->isStruct() || RD->isInterface())
  Tag = llvm::dwarf::DW_TAG_structure_type;
else if (RD->isUnion())
  Tag = llvm::dwarf::DW_TAG_union_type;
else {
  // FIXME: This could be a struct type giving a default visibility different
  // than C++ class type, but needs llvm metadata changes first.
  assert(RD->isClass())(static_cast<void> (0));
  Tag = llvm::dwarf::DW_TAG_class_type;
}
return Tag;
1057}

1059llvm::DICompositeType *
1060CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
                                    llvm::DIScope *Ctx) {
const RecordDecl *RD = Ty->getDecl();
if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
  return cast<llvm::DICompositeType>(T);
llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
const unsigned Line =
    getLineNumber(RD->getLocation().isValid() ? RD->getLocation() : CurLoc);
StringRef RDName = getClassName(RD);

uint64_t Size = 0;
uint32_t Align = 0;

const RecordDecl *D = RD->getDefinition();
if (D && D->isCompleteDefinition())
  Size = CGM.getContext().getTypeSize(Ty);

llvm::DINode::DIFlags Flags = llvm::DINode::FlagFwdDecl;

// Add flag to nontrivial forward declarations. To be consistent with MSVC,
// add the flag if a record has no definition because we don't know whether
// it will be trivial or not.
if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
  if (!CXXRD->hasDefinition() ||
      (CXXRD->hasDefinition() && !CXXRD->isTrivial()))
    Flags |= llvm::DINode::FlagNonTrivial;

// Create the type.
SmallString<256> Identifier;
// Don't include a linkage name in line tables only.
if (CGM.getCodeGenOpts().hasReducedDebugInfo())
  Identifier = getTypeIdentifier(Ty, CGM, TheCU);
llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
    getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align, Flags,
    Identifier);
if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
  if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
    DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
                           CollectCXXTemplateParams(TSpecial, DefUnit));
ReplaceMap.emplace_back(
    std::piecewise_construct, std::make_tuple(Ty),
    std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
return RetTy;
1103}

1105llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
                                               const Type *Ty,
                                               QualType PointeeTy,
                                               llvm::DIFile *Unit) {
// Bit size, align and offset of the type.
// Size is always the size of a pointer. We can't use getTypeSize here
// because that does not return the correct value for references.
unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Optional<unsigned> DWARFAddressSpace =
    CGM.getTarget().getDWARFAddressSpace(AddressSpace);

if (Tag == llvm::dwarf::DW_TAG_reference_type ||
    Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
  return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
                                      Size, Align, DWARFAddressSpace);
else
  return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
                                    Align, DWARFAddressSpace);
1125}

1127llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
                                                  llvm::DIType *&Cache) {
if (Cache)
  return Cache;
Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
                                   TheCU, TheCU->getFile(), 0);
unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Cache = DBuilder.createPointerType(Cache, Size);
return Cache;
1136}

1138uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
  const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
  unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
QualType FType;

// Advanced by calls to CreateMemberType in increments of FType, then
// returned as the overall size of the default elements.
uint64_t FieldOffset = 0;

// Blocks in OpenCL have unique constraints which make the standard fields
// redundant while requiring size and align fields for enqueue_kernel. See
// initializeForBlockHeader in CGBlocks.cpp
if (CGM.getLangOpts().OpenCL) {
  FType = CGM.getContext().IntTy;
  EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
  EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
} else {
  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
  EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
  FType = CGM.getContext().IntTy;
  EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
  EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
  FType = CGM.getContext().getPointerType(Ty->getPointeeType());
  EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
  uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
  uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
  EltTys.push_back(DBuilder.createMemberType(
      Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
      FieldOffset, llvm::DINode::FlagZero, DescTy));
  FieldOffset += FieldSize;
}

return FieldOffset;
1172}

1174llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
                                    llvm::DIFile *Unit) {
SmallVector<llvm::Metadata *, 8> EltTys;
QualType FType;
uint64_t FieldOffset;
llvm::DINodeArray Elements;

FieldOffset = 0;
FType = CGM.getContext().UnsignedLongTy;
EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));

Elements = DBuilder.getOrCreateArray(EltTys);
EltTys.clear();

llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;

auto *EltTy =
    DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
                              FieldOffset, 0, Flags, nullptr, Elements);

// Bit size, align and offset of the type.
uint64_t Size = CGM.getContext().getTypeSize(Ty);

auto *DescTy = DBuilder.createPointerType(EltTy, Size);

FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
                                                        0, EltTys);

Elements = DBuilder.getOrCreateArray(EltTys);

// The __block_literal_generic structs are marked with a special
// DW_AT_APPLE_BLOCK attribute and are an implementation detail only
// the debugger needs to know about. To allow type uniquing, emit
// them without a name or a location.
EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
                                  Flags, nullptr, Elements);

return DBuilder.createPointerType(EltTy, Size);
1213}

1215llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
                                    llvm::DIFile *Unit) {
assert(Ty->isTypeAlias())(static_cast<void> (0));
llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);

auto *AliasDecl =
    cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
        ->getTemplatedDecl();

if (AliasDecl->hasAttr<NoDebugAttr>())
  return Src;

SmallString<128> NS;
llvm::raw_svector_ostream OS(NS);
Ty->getTemplateName().print(OS, getPrintingPolicy(),
                            TemplateName::Qualified::None);
printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());

SourceLocation Loc = AliasDecl->getLocation();
return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
                              getLineNumber(Loc),
                              getDeclContextDescriptor(AliasDecl));
1237}

1239llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
                                    llvm::DIFile *Unit) {
llvm::DIType *Underlying =
    getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);

if (Ty->getDecl()->hasAttr<NoDebugAttr>())
  return Underlying;

// We don't set size information, but do specify where the typedef was
// declared.
SourceLocation Loc = Ty->getDecl()->getLocation();

uint32_t Align = getDeclAlignIfRequired(Ty->getDecl(), CGM.getContext());
// Typedefs are derived from some other type.
return DBuilder.createTypedef(Underlying, Ty->getDecl()->getName(),
                              getOrCreateFile(Loc), getLineNumber(Loc),
                              getDeclContextDescriptor(Ty->getDecl()), Align);
1256}

1258static unsigned getDwarfCC(CallingConv CC) {
switch (CC) {
case CC_C:
  // Avoid emitting DW_AT_calling_convention if the C convention was used.
  return 0;

case CC_X86StdCall:
  return llvm::dwarf::DW_CC_BORLAND_stdcall;
case CC_X86FastCall:
  return llvm::dwarf::DW_CC_BORLAND_msfastcall;
case CC_X86ThisCall:
  return llvm::dwarf::DW_CC_BORLAND_thiscall;
case CC_X86VectorCall:
  return llvm::dwarf::DW_CC_LLVM_vectorcall;
case CC_X86Pascal:
  return llvm::dwarf::DW_CC_BORLAND_pascal;
case CC_Win64:
  return llvm::dwarf::DW_CC_LLVM_Win64;
case CC_X86_64SysV:
  return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
case CC_AAPCS:
case CC_AArch64VectorCall:
  return llvm::dwarf::DW_CC_LLVM_AAPCS;
case CC_AAPCS_VFP:
  return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
case CC_IntelOclBicc:
  return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
case CC_SpirFunction:
  return llvm::dwarf::DW_CC_LLVM_SpirFunction;
case CC_OpenCLKernel:
  return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
case CC_Swift:
  return llvm::dwarf::DW_CC_LLVM_Swift;
case CC_SwiftAsync:
  // [FIXME: swiftasynccc] Update to SwiftAsync once LLVM support lands.
  return llvm::dwarf::DW_CC_LLVM_Swift;
case CC_PreserveMost:
  return llvm::dwarf::DW_CC_LLVM_PreserveMost;
case CC_PreserveAll:
  return llvm::dwarf::DW_CC_LLVM_PreserveAll;
case CC_X86RegCall:
  return llvm::dwarf::DW_CC_LLVM_X86RegCall;
}
return 0;
1302}

1304llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
                                    llvm::DIFile *Unit) {
SmallVector<llvm::Metadata *, 16> EltTys;

// Add the result type at least.
EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));

// Set up remainder of arguments if there is a prototype.
// otherwise emit it as a variadic function.
if (isa<FunctionNoProtoType>(Ty))
  EltTys.push_back(DBuilder.createUnspecifiedParameter());
else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
  for (const QualType &ParamType : FPT->param_types())
    EltTys.push_back(getOrCreateType(ParamType, Unit));
  if (FPT->isVariadic())
    EltTys.push_back(DBuilder.createUnspecifiedParameter());
}

llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
                                     getDwarfCC(Ty->getCallConv()));
1325}

1327/// Convert an AccessSpecifier into the corresponding DINode flag.
1328/// As an optimization, return 0 if the access specifier equals the
1329/// default for the containing type.
1330static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
                                         const RecordDecl *RD) {
AccessSpecifier Default = clang::AS_none;
if (RD && RD->isClass())
  Default = clang::AS_private;
else if (RD && (RD->isStruct() || RD->isUnion()))
  Default = clang::AS_public;

if (Access == Default)
  return llvm::DINode::FlagZero;

switch (Access) {
case clang::AS_private:
  return llvm::DINode::FlagPrivate;
case clang::AS_protected:
  return llvm::DINode::FlagProtected;
case clang::AS_public:
  return llvm::DINode::FlagPublic;
case clang::AS_none:
  return llvm::DINode::FlagZero;
}
llvm_unreachable("unexpected access enumerator")__builtin_unreachable();
1352}

1354llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
                                            llvm::DIScope *RecordTy,
                                            const RecordDecl *RD) {
StringRef Name = BitFieldDecl->getName();
QualType Ty = BitFieldDecl->getType();
SourceLocation Loc = BitFieldDecl->getLocation();
llvm::DIFile *VUnit = getOrCreateFile(Loc);
llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);

// Get the location for the field.
llvm::DIFile *File = getOrCreateFile(Loc);
unsigned Line = getLineNumber(Loc);

const CGBitFieldInfo &BitFieldInfo =
    CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
uint64_t SizeInBits = BitFieldInfo.Size;
assert(SizeInBits > 0 && "found named 0-width bitfield")(static_cast<void> (0));
uint64_t StorageOffsetInBits =
    CGM.getContext().toBits(BitFieldInfo.StorageOffset);
uint64_t Offset = BitFieldInfo.Offset;
// The bit offsets for big endian machines are reversed for big
// endian target, compensate for that as the DIDerivedType requires
// un-reversed offsets.
if (CGM.getDataLayout().isBigEndian())
  Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
uint64_t OffsetInBits = StorageOffsetInBits + Offset;
llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
llvm::DINodeArray Annotations = CollectBTFTagAnnotations(BitFieldDecl);
return DBuilder.createBitFieldMemberType(
    RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
    Flags, DebugType, Annotations);
1385}

1387llvm::DIType *CGDebugInfo::createFieldType(
  StringRef name, QualType type, SourceLocation loc, AccessSpecifier AS,
  uint64_t offsetInBits, uint32_t AlignInBits, llvm::DIFile *tunit,
  llvm::DIScope *scope, const RecordDecl *RD, llvm::DINodeArray Annotations) {
llvm::DIType *debugType = getOrCreateType(type, tunit);

// Get the location for the field.
llvm::DIFile *file = getOrCreateFile(loc);
const unsigned line = getLineNumber(loc.isValid() ? loc : CurLoc);

uint64_t SizeInBits = 0;
auto Align = AlignInBits;
if (!type->isIncompleteArrayType()) {
  TypeInfo TI = CGM.getContext().getTypeInfo(type);
  SizeInBits = TI.Width;
  if (!Align)
    Align = getTypeAlignIfRequired(type, CGM.getContext());
}

llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
                                 offsetInBits, flags, debugType, Annotations);
1409}

1411void CGDebugInfo::CollectRecordLambdaFields(
  const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
  llvm::DIType *RecordTy) {
// For C++11 Lambdas a Field will be the same as a Capture, but the Capture
// has the name and the location of the variable so we should iterate over
// both concurrently.
const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
RecordDecl::field_iterator Field = CXXDecl->field_begin();
unsigned fieldno = 0;
for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
                                           E = CXXDecl->captures_end();
     I != E; ++I, ++Field, ++fieldno) {
  const LambdaCapture &C = *I;
  if (C.capturesVariable()) {
    SourceLocation Loc = C.getLocation();
    assert(!Field->isBitField() && "lambdas don't have bitfield members!")(static_cast<void> (0));
    VarDecl *V = C.getCapturedVar();
    StringRef VName = V->getName();
    llvm::DIFile *VUnit = getOrCreateFile(Loc);
    auto Align = getDeclAlignIfRequired(V, CGM.getContext());
    llvm::DIType *FieldType = createFieldType(
        VName, Field->getType(), Loc, Field->getAccess(),
        layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
    elements.push_back(FieldType);
  } else if (C.capturesThis()) {
    // TODO: Need to handle 'this' in some way by probably renaming the
    // this of the lambda class and having a field member of 'this' or
    // by using AT_object_pointer for the function and having that be
    // used as 'this' for semantic references.
    FieldDecl *f = *Field;
    llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
    QualType type = f->getType();
    llvm::DIType *fieldType = createFieldType(
        "this", type, f->getLocation(), f->getAccess(),
        layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);

    elements.push_back(fieldType);
  }
}
1450}

1452llvm::DIDerivedType *
1453CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
                                   const RecordDecl *RD) {
// Create the descriptor for the static variable, with or without
// constant initializers.
Var = Var->getCanonicalDecl();
llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);

unsigned LineNumber = getLineNumber(Var->getLocation());
StringRef VName = Var->getName();
llvm::Constant *C = nullptr;
if (Var->getInit()) {
  const APValue *Value = Var->evaluateValue();
  if (Value) {
    if (Value->isInt())
      C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
    if (Value->isFloat())
      C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
  }
}

llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
    RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
return GV;
1480}

1482void CGDebugInfo::CollectRecordNormalField(
  const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
  SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
  const RecordDecl *RD) {
StringRef name = field->getName();
QualType type = field->getType();

// Ignore unnamed fields unless they're anonymous structs/unions.
if (name.empty() && !type->isRecordType())
  return;

llvm::DIType *FieldType;
if (field->isBitField()) {
  FieldType = createBitFieldType(field, RecordTy, RD);
} else {
  auto Align = getDeclAlignIfRequired(field, CGM.getContext());
  llvm::DINodeArray Annotations = CollectBTFTagAnnotations(field);
  FieldType =
      createFieldType(name, type, field->getLocation(), field->getAccess(),
                      OffsetInBits, Align, tunit, RecordTy, RD, Annotations);
}

elements.push_back(FieldType);
1505}

1507void CGDebugInfo::CollectRecordNestedType(
  const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
QualType Ty = CGM.getContext().getTypeDeclType(TD);
// Injected class names are not considered nested records.
if (isa<InjectedClassNameType>(Ty))
  return;
SourceLocation Loc = TD->getLocation();
llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
elements.push_back(nestedType);
1516}

1518void CGDebugInfo::CollectRecordFields(
  const RecordDecl *record, llvm::DIFile *tunit,
  SmallVectorImpl<llvm::Metadata *> &elements,
  llvm::DICompositeType *RecordTy) {
const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);

if (CXXDecl && CXXDecl->isLambda())
  CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
else {
  const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);

  // Field number for non-static fields.
  unsigned fieldNo = 0;

  // Static and non-static members should appear in the same order as
  // the corresponding declarations in the source program.
  for (const auto *I : record->decls())
    if (const auto *V = dyn_cast<VarDecl>(I)) {
      if (V->hasAttr<NoDebugAttr>())
        continue;

      // Skip variable template specializations when emitting CodeView. MSVC
      // doesn't emit them.
      if (CGM.getCodeGenOpts().EmitCodeView &&
          isa<VarTemplateSpecializationDecl>(V))
        continue;

      if (isa<VarTemplatePartialSpecializationDecl>(V))
        continue;

      // Reuse the existing static member declaration if one exists
      auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
      if (MI != StaticDataMemberCache.end()) {
        assert(MI->second &&(static_cast<void> (0))
               "Static data member declaration should still exist")(static_cast<void> (0));
        elements.push_back(MI->second);
      } else {
        auto Field = CreateRecordStaticField(V, RecordTy, record);
        elements.push_back(Field);
      }
    } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
      CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
                               elements, RecordTy, record);

      // Bump field number for next field.
      ++fieldNo;
    } else if (CGM.getCodeGenOpts().EmitCodeView) {
      // Debug info for nested types is included in the member list only for
      // CodeView.
      if (const auto *nestedType = dyn_cast<TypeDecl>(I))
        if (!nestedType->isImplicit() &&
            nestedType->getDeclContext() == record)
          CollectRecordNestedType(nestedType, elements);
    }
}
1573}

1575llvm::DISubroutineType *
1576CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
                                 llvm::DIFile *Unit, bool decl) {
const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
if (Method->isStatic())
  return cast_or_null<llvm::DISubroutineType>(
      getOrCreateType(QualType(Func, 0), Unit));
return getOrCreateInstanceMethodType(Method->getThisType(), Func, Unit, decl);
1583}

1585llvm::DISubroutineType *
1586CGDebugInfo::getOrCreateInstanceMethodType(QualType ThisPtr,
                                         const FunctionProtoType *Func,
                                         llvm::DIFile *Unit, bool decl) {
// Add "this" pointer.
llvm::DITypeRefArray Args(
    cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
22
←
The object is a 'DISubroutineType'→
        ->getTypeArray());
assert(Args.size() && "Invalid number of arguments!")(static_cast<void> (0));

SmallVector<llvm::Metadata *, 16> Elts;
// First element is always return type. For 'void' functions it is NULL.
QualType temp = Func->getReturnType();
23
←
Called C++ object pointer is null
if (temp->getTypeClass() == Type::Auto && decl)
  Elts.push_back(CreateType(cast<AutoType>(temp)));
else
  Elts.push_back(Args[0]);

// "this" pointer is always first argument.
const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
if (isa<ClassTemplateSpecializationDecl>(RD)) {
  // Create pointer type directly in this case.
  const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
  QualType PointeeTy = ThisPtrTy->getPointeeType();
  unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
  uint64_t Size = CGM.getTarget().getPointerWidth(AS);
  auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
  llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
  llvm::DIType *ThisPtrType =
      DBuilder.createPointerType(PointeeType, Size, Align);
  TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
  // TODO: This and the artificial type below are misleading, the
  // types aren't artificial the argument is, but the current
  // metadata doesn't represent that.
  ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
  Elts.push_back(ThisPtrType);
} else {
  llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
  TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
  ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
  Elts.push_back(ThisPtrType);
}

// Copy rest of the arguments.
for (unsigned i = 1, e = Args.size(); i != e; ++i)
  Elts.push_back(Args[i]);

llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);

llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
  Flags |= llvm::DINode::FlagLValueReference;
if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
  Flags |= llvm::DINode::FlagRValueReference;

return DBuilder.createSubroutineType(EltTypeArray, Flags,
                                     getDwarfCC(Func->getCallConv()));
1642}

1644/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1645/// inside a function.
1646static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
  return isFunctionLocalClass(NRD);
if (isa<FunctionDecl>(RD->getDeclContext()))
  return true;
return false;
1652}

1654llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
  const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
bool IsCtorOrDtor =
    isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);

StringRef MethodName = getFunctionName(Method);
llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit, true);

// Since a single ctor/dtor corresponds to multiple functions, it doesn't
// make sense to give a single ctor/dtor a linkage name.
StringRef MethodLinkageName;
// FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
// property to use here. It may've been intended to model "is non-external
// type" but misses cases of non-function-local but non-external classes such
// as those in anonymous namespaces as well as the reverse - external types
// that are function local, such as those in (non-local) inline functions.
if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
  MethodLinkageName = CGM.getMangledName(Method);

// Get the location for the method.
llvm::DIFile *MethodDefUnit = nullptr;
unsigned MethodLine = 0;
if (!Method->isImplicit()) {
  MethodDefUnit = getOrCreateFile(Method->getLocation());
  MethodLine = getLineNumber(Method->getLocation());
}

// Collect virtual method info.
llvm::DIType *ContainingType = nullptr;
unsigned VIndex = 0;
llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
int ThisAdjustment = 0;

if (Method->isVirtual()) {
  if (Method->isPure())
    SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
  else
    SPFlags |= llvm::DISubprogram::SPFlagVirtual;

  if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
    // It doesn't make sense to give a virtual destructor a vtable index,
    // since a single destructor has two entries in the vtable.
    if (!isa<CXXDestructorDecl>(Method))
      VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
  } else {
    // Emit MS ABI vftable information.  There is only one entry for the
    // deleting dtor.
    const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
    GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
    MethodVFTableLocation ML =
        CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
    VIndex = ML.Index;

    // CodeView only records the vftable offset in the class that introduces
    // the virtual method. This is possible because, unlike Itanium, the MS
    // C++ ABI does not include all virtual methods from non-primary bases in
    // the vtable for the most derived class. For example, if C inherits from
    // A and B, C's primary vftable will not include B's virtual methods.
    if (Method->size_overridden_methods() == 0)
      Flags |= llvm::DINode::FlagIntroducedVirtual;

    // The 'this' adjustment accounts for both the virtual and non-virtual
    // portions of the adjustment. Presumably the debugger only uses it when
    // it knows the dynamic type of an object.
    ThisAdjustment = CGM.getCXXABI()
                         .getVirtualFunctionPrologueThisAdjustment(GD)
                         .getQuantity();
  }
  ContainingType = RecordTy;
}

// We're checking for deleted C++ special member functions
// [Ctors,Dtors, Copy/Move]
auto checkAttrDeleted = [&](const auto *Method) {
  if (Method->getCanonicalDecl()->isDeleted())
    SPFlags |= llvm::DISubprogram::SPFlagDeleted;
};

switch (Method->getKind()) {

case Decl::CXXConstructor:
case Decl::CXXDestructor:
  checkAttrDeleted(Method);
  break;
case Decl::CXXMethod:
  if (Method->isCopyAssignmentOperator() ||
      Method->isMoveAssignmentOperator())
    checkAttrDeleted(Method);
  break;
default:
  break;
}

if (Method->isNoReturn())
  Flags |= llvm::DINode::FlagNoReturn;

if (Method->isStatic())
  Flags |= llvm::DINode::FlagStaticMember;
if (Method->isImplicit())
  Flags |= llvm::DINode::FlagArtificial;
Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
  if (CXXC->isExplicit())
    Flags |= llvm::DINode::FlagExplicit;
} else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
  if (CXXC->isExplicit())
    Flags |= llvm::DINode::FlagExplicit;
}
if (Method->hasPrototype())
  Flags |= llvm::DINode::FlagPrototyped;
if (Method->getRefQualifier() == RQ_LValue)
  Flags |= llvm::DINode::FlagLValueReference;
if (Method->getRefQualifier() == RQ_RValue)
  Flags |= llvm::DINode::FlagRValueReference;
if (!Method->isExternallyVisible())
  SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
if (CGM.getLangOpts().Optimize)
  SPFlags |= llvm::DISubprogram::SPFlagOptimized;

// In this debug mode, emit type info for a class when its constructor type
// info is emitted.
if (DebugKind == codegenoptions::DebugInfoConstructor)
  if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Method))
    completeUnusedClass(*CD->getParent());

llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
llvm::DISubprogram *SP = DBuilder.createMethod(
    RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
    MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
    TParamsArray.get());

SPCache[Method->getCanonicalDecl()].reset(SP);

return SP;
1789}

1791void CGDebugInfo::CollectCXXMemberFunctions(
  const CXXRecordDecl *RD, llvm::DIFile *Unit,
  SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {

// Since we want more than just the individual member decls if we
// have templated functions iterate over every declaration to gather
// the functions.
for (const auto *I : RD->decls()) {
  const auto *Method = dyn_cast<CXXMethodDecl>(I);
  // If the member is implicit, don't add it to the member list. This avoids
  // the member being added to type units by LLVM, while still allowing it
  // to be emitted into the type declaration/reference inside the compile
  // unit.
  // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
  // FIXME: Handle Using(Shadow?)Decls here to create
  // DW_TAG_imported_declarations inside the class for base decls brought into
  // derived classes. GDB doesn't seem to notice/leverage these when I tried
  // it, so I'm not rushing to fix this. (GCC seems to produce them, if
  // referenced)
  if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
    continue;

  if (Method->getType()->castAs<FunctionProtoType>()->getContainedAutoType())
    continue;

  // Reuse the existing member function declaration if it exists.
  // It may be associated with the declaration of the type & should be
  // reused as we're building the definition.
  //
  // This situation can arise in the vtable-based debug info reduction where
  // implicit members are emitted in a non-vtable TU.
  auto MI = SPCache.find(Method->getCanonicalDecl());
  EltTys.push_back(MI == SPCache.end()
                       ? CreateCXXMemberFunction(Method, Unit, RecordTy)
                       : static_cast<llvm::Metadata *>(MI->second));
}
1827}

1829void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
                                SmallVectorImpl<llvm::Metadata *> &EltTys,
                                llvm::DIType *RecordTy) {
llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
                   llvm::DINode::FlagZero);

// If we are generating CodeView debug info, we also need to emit records for
// indirect virtual base classes.
if (CGM.getCodeGenOpts().EmitCodeView) {
  CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
                     llvm::DINode::FlagIndirectVirtualBase);
}
1842}

1844void CGDebugInfo::CollectCXXBasesAux(
  const CXXRecordDecl *RD, llvm::DIFile *Unit,
  SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
  const CXXRecordDecl::base_class_const_range &Bases,
  llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
  llvm::DINode::DIFlags StartingFlags) {
const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
for (const auto &BI : Bases) {
  const auto *Base =
      cast<CXXRecordDecl>(BI.getType()->castAs<RecordType>()->getDecl());
  if (!SeenTypes.insert(Base).second)
    continue;
  auto *BaseTy = getOrCreateType(BI.getType(), Unit);
  llvm::DINode::DIFlags BFlags = StartingFlags;
  uint64_t BaseOffset;
  uint32_t VBPtrOffset = 0;

  if (BI.isVirtual()) {
    if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
      // virtual base offset offset is -ve. The code generator emits dwarf
      // expression where it expects +ve number.
      BaseOffset = 0 - CGM.getItaniumVTableContext()
                           .getVirtualBaseOffsetOffset(RD, Base)
                           .getQuantity();
    } else {
      // In the MS ABI, store the vbtable offset, which is analogous to the
      // vbase offset offset in Itanium.
      BaseOffset =
          4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
      VBPtrOffset = CGM.getContext()
                        .getASTRecordLayout(RD)
                        .getVBPtrOffset()
                        .getQuantity();
    }
    BFlags |= llvm::DINode::FlagVirtual;
  } else
    BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
  // FIXME: Inconsistent units for BaseOffset. It is in bytes when
  // BI->isVirtual() and bits when not.

  BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
  llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
                                                 VBPtrOffset, BFlags);
  EltTys.push_back(DTy);
}
1889}

1891llvm::DINodeArray
1892CGDebugInfo::CollectTemplateParams(Optional<TemplateArgs> OArgs,
                                 llvm::DIFile *Unit) {
if (!OArgs)
  return llvm::DINodeArray();
TemplateArgs &Args = *OArgs;
SmallVector<llvm::Metadata *, 16> TemplateParams;
for (unsigned i = 0, e = Args.Args.size(); i != e; ++i) {
  const TemplateArgument &TA = Args.Args[i];
  StringRef Name;
  bool defaultParameter = false;
  if (Args.TList)
    Name = Args.TList->getParam(i)->getName();
  switch (TA.getKind()) {
  case TemplateArgument::Type: {
    llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);

    if (Args.TList)
      if (auto *templateType =
              dyn_cast_or_null<TemplateTypeParmDecl>(Args.TList->getParam(i)))
        if (templateType->hasDefaultArgument())
          defaultParameter =
              templateType->getDefaultArgument() == TA.getAsType();

    TemplateParams.push_back(DBuilder.createTemplateTypeParameter(
        TheCU, Name, TTy, defaultParameter));

  } break;
  case TemplateArgument::Integral: {
    llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
    if (Args.TList && CGM.getCodeGenOpts().DwarfVersion >= 5)
      if (auto *templateType = dyn_cast_or_null<NonTypeTemplateParmDecl>(
              Args.TList->getParam(i)))
        if (templateType->hasDefaultArgument() &&
            !templateType->getDefaultArgument()->isValueDependent())
          defaultParameter = llvm::APSInt::isSameValue(
              templateType->getDefaultArgument()->EvaluateKnownConstInt(
                  CGM.getContext()),
              TA.getAsIntegral());

    TemplateParams.push_back(DBuilder.createTemplateValueParameter(
        TheCU, Name, TTy, defaultParameter,
        llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
  } break;
  case TemplateArgument::Declaration: {
    const ValueDecl *D = TA.getAsDecl();
    QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
    llvm::DIType *TTy = getOrCreateType(T, Unit);
    llvm::Constant *V = nullptr;
    // Skip retrieve the value if that template parameter has cuda device
    // attribute, i.e. that value is not available at the host side.
    if (!CGM.getLangOpts().CUDA || CGM.getLangOpts().CUDAIsDevice ||
        !D->hasAttr<CUDADeviceAttr>()) {
      const CXXMethodDecl *MD;
      // Variable pointer template parameters have a value that is the address
      // of the variable.
      if (const auto *VD = dyn_cast<VarDecl>(D))
        V = CGM.GetAddrOfGlobalVar(VD);
      // Member function pointers have special support for building them,
      // though this is currently unsupported in LLVM CodeGen.
      else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
        V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
      else if (const auto *FD = dyn_cast<FunctionDecl>(D))
        V = CGM.GetAddrOfFunction(FD);
      // Member data pointers have special handling too to compute the fixed
      // offset within the object.
      else if (const auto *MPT =
                   dyn_cast<MemberPointerType>(T.getTypePtr())) {
        // These five lines (& possibly the above member function pointer
        // handling) might be able to be refactored to use similar code in
        // CodeGenModule::getMemberPointerConstant
        uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
        CharUnits chars =
            CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
        V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
      } else if (const auto *GD = dyn_cast<MSGuidDecl>(D)) {
        V = CGM.GetAddrOfMSGuidDecl(GD).getPointer();
      } else if (const auto *TPO = dyn_cast<TemplateParamObjectDecl>(D)) {
        if (T->isRecordType())
          V = ConstantEmitter(CGM).emitAbstract(
              SourceLocation(), TPO->getValue(), TPO->getType());
        else
          V = CGM.GetAddrOfTemplateParamObject(TPO).getPointer();
      }
      assert(V && "Failed to find template parameter pointer")(static_cast<void> (0));
      V = V->stripPointerCasts();
    }
    TemplateParams.push_back(DBuilder.createTemplateValueParameter(
        TheCU, Name, TTy, defaultParameter, cast_or_null<llvm::Constant>(V)));
  } break;
  case TemplateArgument::NullPtr: {
    QualType T = TA.getNullPtrType();
    llvm::DIType *TTy = getOrCreateType(T, Unit);
    llvm::Constant *V = nullptr;
    // Special case member data pointer null values since they're actually -1
    // instead of zero.
    if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
      // But treat member function pointers as simple zero integers because
      // it's easier than having a special case in LLVM's CodeGen. If LLVM
      // CodeGen grows handling for values of non-null member function
      // pointers then perhaps we could remove this special case and rely on
      // EmitNullMemberPointer for member function pointers.
      if (MPT->isMemberDataPointer())
        V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
    if (!V)
      V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
    TemplateParams.push_back(DBuilder.createTemplateValueParameter(
        TheCU, Name, TTy, defaultParameter, V));
  } break;
  case TemplateArgument::Template:
    TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
        TheCU, Name, nullptr,
        TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
    break;
  case TemplateArgument::Pack:
    TemplateParams.push_back(DBuilder.createTemplateParameterPack(
        TheCU, Name, nullptr,
        CollectTemplateParams({{nullptr, TA.getPackAsArray()}}, Unit)));
    break;
  case TemplateArgument::Expression: {
    const Expr *E = TA.getAsExpr();
    QualType T = E->getType();
    if (E->isGLValue())
      T = CGM.getContext().getLValueReferenceType(T);
    llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
    assert(V && "Expression in template argument isn't constant")(static_cast<void> (0));
    llvm::DIType *TTy = getOrCreateType(T, Unit);
    TemplateParams.push_back(DBuilder.createTemplateValueParameter(
        TheCU, Name, TTy, defaultParameter, V->stripPointerCasts()));
  } break;
  // And the following should never occur:
  case TemplateArgument::TemplateExpansion:
  case TemplateArgument::Null:
    llvm_unreachable(__builtin_unreachable()
        "These argument types shouldn't exist in concrete types")__builtin_unreachable();
  }
}
return DBuilder.getOrCreateArray(TemplateParams);
2029}

2031Optional<CGDebugInfo::TemplateArgs>
2032CGDebugInfo::GetTemplateArgs(const FunctionDecl *FD) const {
if (FD->getTemplatedKind() ==
    FunctionDecl::TK_FunctionTemplateSpecialization) {
  const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
                                           ->getTemplate()
                                           ->getTemplateParameters();
  return {{TList, FD->getTemplateSpecializationArgs()->asArray()}};
}
return None;
2041}
2042Optional<CGDebugInfo::TemplateArgs>
2043CGDebugInfo::GetTemplateArgs(const VarDecl *VD) const {
// Always get the full list of parameters, not just the ones from the
// specialization. A partial specialization may have fewer parameters than
// there are arguments.
auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VD);
if (!TS)
  return None;
VarTemplateDecl *T = TS->getSpecializedTemplate();
const TemplateParameterList *TList = T->getTemplateParameters();
auto TA = TS->getTemplateArgs().asArray();
return {{TList, TA}};
2054}
2055Optional<CGDebugInfo::TemplateArgs>
2056CGDebugInfo::GetTemplateArgs(const RecordDecl *RD) const {
if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD)) {
  // Always get the full list of parameters, not just the ones from the
  // specialization. A partial specialization may have fewer parameters than
  // there are arguments.
  TemplateParameterList *TPList =
      TSpecial->getSpecializedTemplate()->getTemplateParameters();
  const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
  return {{TPList, TAList.asArray()}};
}
return None;
2067}

2069llvm::DINodeArray
2070CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
                                         llvm::DIFile *Unit) {
return CollectTemplateParams(GetTemplateArgs(FD), Unit);
2073}

2075llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
                                                      llvm::DIFile *Unit) {
return CollectTemplateParams(GetTemplateArgs(VL), Unit);
2078}

2080llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(const RecordDecl *RD,
                                                      llvm::DIFile *Unit) {
return CollectTemplateParams(GetTemplateArgs(RD), Unit);
2083}

2085llvm::DINodeArray CGDebugInfo::CollectBTFTagAnnotations(const Decl *D) {
if (!D->hasAttr<BTFTagAttr>())
  return nullptr;

SmallVector<llvm::Metadata *, 4> Annotations;
for (const auto *I : D->specific_attrs<BTFTagAttr>()) {
  llvm::Metadata *Ops[2] = {
      llvm::MDString::get(CGM.getLLVMContext(), StringRef("btf_tag")),
      llvm::MDString::get(CGM.getLLVMContext(), I->getBTFTag())};
  Annotations.push_back(llvm::MDNode::get(CGM.getLLVMContext(), Ops));
}
return DBuilder.getOrCreateArray(Annotations);
2097}

2099llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
if (VTablePtrType)
  return VTablePtrType;

ASTContext &Context = CGM.getContext();

/* Function type */
llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
Optional<unsigned> DWARFAddressSpace =
    CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);

llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
    SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
return VTablePtrType;
2118}

2120StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
// Copy the gdb compatible name on the side and use its reference.
return internString("_vptr$", RD->getNameAsString());
2123}

2125StringRef CGDebugInfo::getDynamicInitializerName(const VarDecl *VD,
                                               DynamicInitKind StubKind,
                                               llvm::Function *InitFn) {
// If we're not emitting codeview, use the mangled name. For Itanium, this is
// arbitrary.
if (!CGM.getCodeGenOpts().EmitCodeView ||
    StubKind == DynamicInitKind::GlobalArrayDestructor)
  return InitFn->getName();

// Print the normal qualified name for the variable, then break off the last
// NNS, and add the appropriate other text. Clang always prints the global
// variable name without template arguments, so we can use rsplit("::") and
// then recombine the pieces.
SmallString<128> QualifiedGV;
StringRef Quals;
StringRef GVName;
{
  llvm::raw_svector_ostream OS(QualifiedGV);
  VD->printQualifiedName(OS, getPrintingPolicy());
  std::tie(Quals, GVName) = OS.str().rsplit("::");
  if (GVName.empty())
    std::swap(Quals, GVName);
}

SmallString<128> InitName;
llvm::raw_svector_ostream OS(InitName);
if (!Quals.empty())
  OS << Quals << "::";

switch (StubKind) {
case DynamicInitKind::NoStub:
case DynamicInitKind::GlobalArrayDestructor:
  llvm_unreachable("not an initializer")__builtin_unreachable();
case DynamicInitKind::Initializer:
  OS << "`dynamic initializer for '";
  break;
case DynamicInitKind::AtExit:
  OS << "`dynamic atexit destructor for '";
  break;
}

OS << GVName;

// Add any template specialization args.
if (const auto *VTpl = dyn_cast<VarTemplateSpecializationDecl>(VD)) {
  printTemplateArgumentList(OS, VTpl->getTemplateArgs().asArray(),
                            getPrintingPolicy());
}

OS << '\'';

return internString(OS.str());
2177}

2179void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
                                  SmallVectorImpl<llvm::Metadata *> &EltTys) {
// If this class is not dynamic then there is not any vtable info to collect.
if (!RD->isDynamicClass())
  return;

// Don't emit any vtable shape or vptr info if this class doesn't have an
// extendable vfptr. This can happen if the class doesn't have virtual
// methods, or in the MS ABI if those virtual methods only come from virtually
// inherited bases.
const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
if (!RL.hasExtendableVFPtr())
  return;

// CodeView needs to know how large the vtable of every dynamic class is, so
// emit a special named pointer type into the element list. The vptr type
// points to this type as well.
llvm::DIType *VPtrTy = nullptr;
bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
                       CGM.getTarget().getCXXABI().isMicrosoft();
if (NeedVTableShape) {
  uint64_t PtrWidth =
      CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
  const VTableLayout &VFTLayout =
      CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
  unsigned VSlotCount =
      VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
  unsigned VTableWidth = PtrWidth * VSlotCount;
  unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
  Optional<unsigned> DWARFAddressSpace =
      CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);

  // Create a very wide void* type and insert it directly in the element list.
  llvm::DIType *VTableType = DBuilder.createPointerType(
      nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
  EltTys.push_back(VTableType);

  // The vptr is a pointer to this special vtable type.
  VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
}

// If there is a primary base then the artificial vptr member lives there.
if (RL.getPrimaryBase())
  return;

if (!VPtrTy)
  VPtrTy = getOrCreateVTablePtrType(Unit);

unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
llvm::DIType *VPtrMember =
    DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
                              llvm::DINode::FlagArtificial, VPtrTy);
EltTys.push_back(VPtrMember);
2232}

2234llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
                                               SourceLocation Loc) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
return T;
2239}

2241llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
                                                  SourceLocation Loc) {
return getOrCreateStandaloneType(D, Loc);
2244}

2246llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
                                                   SourceLocation Loc) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
assert(!D.isNull() && "null type")(static_cast<void> (0));
llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
assert(T && "could not create debug info for type")(static_cast<void> (0));

RetainedTypes.push_back(D.getAsOpaquePtr());
return T;
2255}

2257void CGDebugInfo::addHeapAllocSiteMetadata(llvm::CallBase *CI,
                                         QualType AllocatedTy,
                                         SourceLocation Loc) {
if (CGM.getCodeGenOpts().getDebugInfo() <=
    codegenoptions::DebugLineTablesOnly)
  return;
llvm::MDNode *node;
if (AllocatedTy->isVoidType())
  node = llvm::MDNode::get(CGM.getLLVMContext(), None);
else
  node = getOrCreateType(AllocatedTy, getOrCreateFile(Loc));

CI->setMetadata("heapallocsite", node);
2270}

2272void CGDebugInfo::completeType(const EnumDecl *ED) {
if (DebugKind <= codegenoptions::DebugLineTablesOnly)
  return;
QualType Ty = CGM.getContext().getEnumType(ED);
void *TyPtr = Ty.getAsOpaquePtr();
auto I = TypeCache.find(TyPtr);
if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
  return;
llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
assert(!Res->isForwardDecl())(static_cast<void> (0));
TypeCache[TyPtr].reset(Res);
2283}

2285void CGDebugInfo::completeType(const RecordDecl *RD) {
if (DebugKind > codegenoptions::LimitedDebugInfo ||
    !CGM.getLangOpts().CPlusPlus)
  completeRequiredType(RD);
2289}

2291/// Return true if the class or any of its methods are marked dllimport.
2292static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
if (RD->hasAttr<DLLImportAttr>())
  return true;
for (const CXXMethodDecl *MD : RD->methods())
  if (MD->hasAttr<DLLImportAttr>())
    return true;
return false;
2299}

2301/// Does a type definition exist in an imported clang module?
2302static bool isDefinedInClangModule(const RecordDecl *RD) {
// Only definitions that where imported from an AST file come from a module.
if (!RD || !RD->isFromASTFile())
  return false;
// Anonymous entities cannot be addressed. Treat them as not from module.
if (!RD->isExternallyVisible() && RD->getName().empty())
  return false;
if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
  if (!CXXDecl->isCompleteDefinition())
    return false;
  // Check wether RD is a template.
  auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
  if (TemplateKind != TSK_Undeclared) {
    // Unfortunately getOwningModule() isn't accurate enough to find the
    // owning module of a ClassTemplateSpecializationDecl that is inside a
    // namespace spanning multiple modules.
    bool Explicit = false;
    if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
      Explicit = TD->isExplicitInstantiationOrSpecialization();
    if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
      return false;
    // This is a template, check the origin of the first member.
    if (CXXDecl->field_begin() == CXXDecl->field_end())
      return TemplateKind == TSK_ExplicitInstantiationDeclaration;
    if (!CXXDecl->field_begin()->isFromASTFile())
      return false;
  }
}
return true;
2331}

2333void CGDebugInfo::completeClassData(const RecordDecl *RD) {
if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
  if (CXXRD->isDynamicClass() &&
      CGM.getVTableLinkage(CXXRD) ==
          llvm::GlobalValue::AvailableExternallyLinkage &&
      !isClassOrMethodDLLImport(CXXRD))
    return;

if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
  return;

completeClass(RD);
2345}

2347void CGDebugInfo::completeClass(const RecordDecl *RD) {
if (DebugKind <= codegenoptions::DebugLineTablesOnly)
  return;
QualType Ty = CGM.getContext().getRecordType(RD);
void *TyPtr = Ty.getAsOpaquePtr();
auto I = TypeCache.find(TyPtr);
if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
  return;
llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
assert(!Res->isForwardDecl())(static_cast<void> (0));
TypeCache[TyPtr].reset(Res);
2358}

2360static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
                                      CXXRecordDecl::method_iterator End) {
for (CXXMethodDecl *MD : llvm::make_range(I, End))
  if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
    if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
        !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
      return true;
return false;
2368}

2370static bool canUseCtorHoming(const CXXRecordDecl *RD) {
// Constructor homing can be used for classes that cannnot be constructed
// without emitting code for one of their constructors. This is classes that
// don't have trivial or constexpr constructors, or can be created from
// aggregate initialization. Also skip lambda objects because they don't call
// constructors.

// Skip this optimization if the class or any of its methods are marked
// dllimport.
if (isClassOrMethodDLLImport(RD))
  return false;

return !RD->isLambda() && !RD->isAggregate() &&
       !RD->hasTrivialDefaultConstructor() &&
       !RD->hasConstexprNonCopyMoveConstructor();
2385}

2387static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
                               bool DebugTypeExtRefs, const RecordDecl *RD,
                               const LangOptions &LangOpts) {
if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
  return true;

if (auto *ES = RD->getASTContext().getExternalSource())
  if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
    return true;

// Only emit forward declarations in line tables only to keep debug info size
// small. This only applies to CodeView, since we don't emit types in DWARF
// line tables only.
if (DebugKind == codegenoptions::DebugLineTablesOnly)
  return true;

if (DebugKind > codegenoptions::LimitedDebugInfo ||
    RD->hasAttr<StandaloneDebugAttr>())
  return false;

if (!LangOpts.CPlusPlus)
  return false;

if (!RD->isCompleteDefinitionRequired())
  return true;

const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);

if (!CXXDecl)
  return false;

// Only emit complete debug info for a dynamic class when its vtable is
// emitted.  However, Microsoft debuggers don't resolve type information
// across DLL boundaries, so skip this optimization if the class or any of its
// methods are marked dllimport. This isn't a complete solution, since objects
// without any dllimport methods can be used in one DLL and constructed in
// another, but it is the current behavior of LimitedDebugInfo.
if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
    !isClassOrMethodDLLImport(CXXDecl))
  return true;

TemplateSpecializationKind Spec = TSK_Undeclared;
if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
  Spec = SD->getSpecializationKind();

if (Spec == TSK_ExplicitInstantiationDeclaration &&
    hasExplicitMemberDefinition(CXXDecl->method_begin(),
                                CXXDecl->method_end()))
  return true;

// In constructor homing mode, only emit complete debug info for a class
// when its constructor is emitted.
if ((DebugKind == codegenoptions::DebugInfoConstructor) &&
    canUseCtorHoming(CXXDecl))
  return true;

return false;
2444}

2446void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
  return;

QualType Ty = CGM.getContext().getRecordType(RD);
llvm::DIType *T = getTypeOrNull(Ty);
if (T && T->isForwardDecl())
  completeClassData(RD);
2454}

2456llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
RecordDecl *RD = Ty->getDecl();
llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
                              CGM.getLangOpts())) {
  if (!T)
    T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
  return T;
}

return CreateTypeDefinition(Ty);
2467}

2469llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
RecordDecl *RD = Ty->getDecl();

// Get overall information about the record type for the debug info.
llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());

// Records and classes and unions can all be recursive.  To handle them, we
// first generate a debug descriptor for the struct as a forward declaration.
// Then (if it is a definition) we go through and get debug info for all of
// its members.  Finally, we create a descriptor for the complete type (which
// may refer to the forward decl if the struct is recursive) and replace all
// uses of the forward declaration with the final definition.
llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty);

const RecordDecl *D = RD->getDefinition();
if (!D || !D->isCompleteDefinition())
  return FwdDecl;

if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
  CollectContainingType(CXXDecl, FwdDecl);

// Push the struct on region stack.
LexicalBlockStack.emplace_back(&*FwdDecl);
RegionMap[Ty->getDecl()].reset(FwdDecl);

// Convert all the elements.
SmallVector<llvm::Metadata *, 16> EltTys;
// what about nested types?

// Note: The split of CXXDecl information here is intentional, the
// gdb tests will depend on a certain ordering at printout. The debug
// information offsets are still correct if we merge them all together
// though.
const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
if (CXXDecl) {
  CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
  CollectVTableInfo(CXXDecl, DefUnit, EltTys);
}

// Collect data fields (including static variables and any initializers).
CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
if (CXXDecl)
  CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);

LexicalBlockStack.pop_back();
RegionMap.erase(Ty->getDecl());

llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
DBuilder.replaceArrays(FwdDecl, Elements);

if (FwdDecl->isTemporary())
  FwdDecl =
      llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));

RegionMap[Ty->getDecl()].reset(FwdDecl);
return FwdDecl;
2525}

2527llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
                                    llvm::DIFile *Unit) {
// Ignore protocols.
return getOrCreateType(Ty->getBaseType(), Unit);
2531}

2533llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
                                    llvm::DIFile *Unit) {
// Ignore protocols.
SourceLocation Loc = Ty->getDecl()->getLocation();

// Use Typedefs to represent ObjCTypeParamType.
return DBuilder.createTypedef(
    getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
    Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
    getDeclContextDescriptor(Ty->getDecl()));
2543}

2545/// \return true if Getter has the default name for the property PD.
2546static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
                               const ObjCMethodDecl *Getter) {
assert(PD)(static_cast<void> (0));
if (!Getter)
  return true;

assert(Getter->getDeclName().isObjCZeroArgSelector())(static_cast<void> (0));
return PD->getName() ==
       Getter->getDeclName().getObjCSelector().getNameForSlot(0);
2555}

2557/// \return true if Setter has the default name for the property PD.
2558static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
                               const ObjCMethodDecl *Setter) {
assert(PD)(static_cast<void> (0));
if (!Setter)
  return true;

assert(Setter->getDeclName().isObjCOneArgSelector())(static_cast<void> (0));
return SelectorTable::constructSetterName(PD->getName()) ==
       Setter->getDeclName().getObjCSelector().getNameForSlot(0);
2567}

2569llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
                                    llvm::DIFile *Unit) {
ObjCInterfaceDecl *ID = Ty->getDecl();
if (!ID)
  return nullptr;

// Return a forward declaration if this type was imported from a clang module,
// and this is not the compile unit with the implementation of the type (which
// may contain hidden ivars).
if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
    !ID->getImplementation())
  return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
                                    ID->getName(),
                                    getDeclContextDescriptor(ID), Unit, 0);

// Get overall information about the record type for the debug info.
llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
unsigned Line = getLineNumber(ID->getLocation());
auto RuntimeLang =
    static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());

// If this is just a forward declaration return a special forward-declaration
// debug type since we won't be able to lay out the entire type.
ObjCInterfaceDecl *Def = ID->getDefinition();
if (!Def || !Def->getImplementation()) {
  llvm::DIScope *Mod = getParentModuleOrNull(ID);
  llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
      llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
      DefUnit, Line, RuntimeLang);
  ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
  return FwdDecl;
}

return CreateTypeDefinition(Ty, Unit);
2603}

2605llvm::DIModule *CGDebugInfo::getOrCreateModuleRef(ASTSourceDescriptor Mod,
                                                bool CreateSkeletonCU) {
// Use the Module pointer as the key into the cache. This is a
// nullptr if the "Module" is a PCH, which is safe because we don't
// support chained PCH debug info, so there can only be a single PCH.
const Module *M = Mod.getModuleOrNull();
auto ModRef = ModuleCache.find(M);
if (ModRef != ModuleCache.end())
  return cast<llvm::DIModule>(ModRef->second);

// Macro definitions that were defined with "-D" on the command line.
SmallString<128> ConfigMacros;
{
  llvm::raw_svector_ostream OS(ConfigMacros);
  const auto &PPOpts = CGM.getPreprocessorOpts();
  unsigned I = 0;
  // Translate the macro definitions back into a command line.
  for (auto &M : PPOpts.Macros) {
    if (++I > 1)
      OS << " ";
    const std::string &Macro = M.first;
    bool Undef = M.second;
    OS << "\"-" << (Undef ? 'U' : 'D');
    for (char c : Macro)
      switch (c) {
      case '\\':
        OS << "\\\\";
        break;
      case '"':
        OS << "\\\"";
        break;
      default:
        OS << c;
      }
    OS << '\"';
  }
}

bool IsRootModule = M ? !M->Parent : true;
// When a module name is specified as -fmodule-name, that module gets a
// clang::Module object, but it won't actually be built or imported; it will
// be textual.
if (CreateSkeletonCU && IsRootModule && Mod.getASTFile().empty() && M)
  assert(StringRef(M->Name).startswith(CGM.getLangOpts().ModuleName) &&(static_cast<void> (0))
         "clang module without ASTFile must be specified by -fmodule-name")(static_cast<void> (0));

// Return a StringRef to the remapped Path.
auto RemapPath = [this](StringRef Path) -> std::string {
  std::string Remapped = remapDIPath(Path);
  StringRef Relative(Remapped);
  StringRef CompDir = TheCU->getDirectory();
  if (Relative.consume_front(CompDir))
    Relative.consume_front(llvm::sys::path::get_separator());

  return Relative.str();
};

if (CreateSkeletonCU && IsRootModule && !Mod.getASTFile().empty()) {
  // PCH files don't have a signature field in the control block,
  // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
  // We use the lower 64 bits for debug info.

  uint64_t Signature = 0;
  if (const auto &ModSig = Mod.getSignature())
    Signature = ModSig.truncatedValue();
  else
    Signature = ~1ULL;

  llvm::DIBuilder DIB(CGM.getModule());
  SmallString<0> PCM;
  if (!llvm::sys::path::is_absolute(Mod.getASTFile()))
    PCM = Mod.getPath();
  llvm::sys::path::append(PCM, Mod.getASTFile());
  DIB.createCompileUnit(
      TheCU->getSourceLanguage(),
      // TODO: Support "Source" from external AST providers?
      DIB.createFile(Mod.getModuleName(), TheCU->getDirectory()),
      TheCU->getProducer(), false, StringRef(), 0, RemapPath(PCM),
      llvm::DICompileUnit::FullDebug, Signature);
  DIB.finalize();
}

llvm::DIModule *Parent =
    IsRootModule ? nullptr
                 : getOrCreateModuleRef(ASTSourceDescriptor(*M->Parent),
                                        CreateSkeletonCU);
std::string IncludePath = Mod.getPath().str();
llvm::DIModule *DIMod =
    DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
                          RemapPath(IncludePath));
ModuleCache[M].reset(DIMod);
return DIMod;
2697}

2699llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
                                              llvm::DIFile *Unit) {
ObjCInterfaceDecl *ID = Ty->getDecl();
llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
unsigned Line = getLineNumber(ID->getLocation());
unsigned RuntimeLang = TheCU->getSourceLanguage();

// Bit size, align and offset of the type.
uint64_t Size = CGM.getContext().getTypeSize(Ty);
auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());

llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
if (ID->getImplementation())
  Flags |= llvm::DINode::FlagObjcClassComplete;

llvm::DIScope *Mod = getParentModuleOrNull(ID);
llvm::DICompositeType *RealDecl = DBuilder.createStructType(
    Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
    nullptr, llvm::DINodeArray(), RuntimeLang);

QualType QTy(Ty, 0);
TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);

// Push the struct on region stack.
LexicalBlockStack.emplace_back(RealDecl);
RegionMap[Ty->getDecl()].reset(RealDecl);

// Convert all the elements.
SmallVector<llvm::Metadata *, 16> EltTys;

ObjCInterfaceDecl *SClass = ID->getSuperClass();
if (SClass) {
  llvm::DIType *SClassTy =
      getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
  if (!SClassTy)
    return nullptr;

  llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
                                                    llvm::DINode::FlagZero);
  EltTys.push_back(InhTag);
}

// Create entries for all of the properties.
auto AddProperty = [&](const ObjCPropertyDecl *PD) {
  SourceLocation Loc = PD->getLocation();
  llvm::DIFile *PUnit = getOrCreateFile(Loc);
  unsigned PLine = getLineNumber(Loc);
  ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
  ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
  llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
      PD->getName(), PUnit, PLine,
      hasDefaultGetterName(PD, Getter) ? ""
                                       : getSelectorName(PD->getGetterName()),
      hasDefaultSetterName(PD, Setter) ? ""
                                       : getSelectorName(PD->getSetterName()),
      PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
  EltTys.push_back(PropertyNode);
};
{
  // Use 'char' for the isClassProperty bit as DenseSet requires space for
  // empty/tombstone keys in the data type (and bool is too small for that).
  typedef std::pair<char, const IdentifierInfo *> IsClassAndIdent;
  /// List of already emitted properties. Two distinct class and instance
  /// properties can share the same identifier (but not two instance
  /// properties or two class properties).
  llvm::DenseSet<IsClassAndIdent> PropertySet;
  /// Returns the IsClassAndIdent key for the given property.
  auto GetIsClassAndIdent = [](const ObjCPropertyDecl *PD) {
    return std::make_pair(PD->isClassProperty(), PD->getIdentifier());
  };
  for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
    for (auto *PD : ClassExt->properties()) {
      PropertySet.insert(GetIsClassAndIdent(PD));
      AddProperty(PD);
    }
  for (const auto *PD : ID->properties()) {
    // Don't emit duplicate metadata for properties that were already in a
    // class extension.
    if (!PropertySet.insert(GetIsClassAndIdent(PD)).second)
      continue;
    AddProperty(PD);
  }
}

const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
unsigned FieldNo = 0;
for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
     Field = Field->getNextIvar(), ++FieldNo) {
  llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
  if (!FieldTy)
    return nullptr;

  StringRef FieldName = Field->getName();

  // Ignore unnamed fields.
  if (FieldName.empty())
    continue;

  // Get the location for the field.
  llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
  unsigned FieldLine = getLineNumber(Field->getLocation());
  QualType FType = Field->getType();
  uint64_t FieldSize = 0;
  uint32_t FieldAlign = 0;

  if (!FType->isIncompleteArrayType()) {

    // Bit size, align and offset of the type.
    FieldSize = Field->isBitField()
                    ? Field->getBitWidthValue(CGM.getContext())
                    : CGM.getContext().getTypeSize(FType);
    FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
  }

  uint64_t FieldOffset;
  if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
    // We don't know the runtime offset of an ivar if we're using the
    // non-fragile ABI.  For bitfields, use the bit offset into the first
    // byte of storage of the bitfield.  For other fields, use zero.
    if (Field->isBitField()) {
      FieldOffset =
          CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
      FieldOffset %= CGM.getContext().getCharWidth();
    } else {
      FieldOffset = 0;
    }
  } else {
    FieldOffset = RL.getFieldOffset(FieldNo);
  }

  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
  if (Field->getAccessControl() == ObjCIvarDecl::Protected)
    Flags = llvm::DINode::FlagProtected;
  else if (Field->getAccessControl() == ObjCIvarDecl::Private)
    Flags = llvm::DINode::FlagPrivate;
  else if (Field->getAccessControl() == ObjCIvarDecl::Public)
    Flags = llvm::DINode::FlagPublic;

  llvm::MDNode *PropertyNode = nullptr;
  if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
    if (ObjCPropertyImplDecl *PImpD =
            ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
      if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
        SourceLocation Loc = PD->getLocation();
        llvm::DIFile *PUnit = getOrCreateFile(Loc);
        unsigned PLine = getLineNumber(Loc);
        ObjCMethodDecl *Getter = PImpD->getGetterMethodDecl();
        ObjCMethodDecl *Setter = PImpD->getSetterMethodDecl();
        PropertyNode = DBuilder.createObjCProperty(
            PD->getName(), PUnit, PLine,
            hasDefaultGetterName(PD, Getter)
                ? ""
                : getSelectorName(PD->getGetterName()),
            hasDefaultSetterName(PD, Setter)
                ? ""
                : getSelectorName(PD->getSetterName()),
            PD->getPropertyAttributes(),
            getOrCreateType(PD->getType(), PUnit));
      }
    }
  }
  FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
                                    FieldSize, FieldAlign, FieldOffset, Flags,
                                    FieldTy, PropertyNode);
  EltTys.push_back(FieldTy);
}

llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
DBuilder.replaceArrays(RealDecl, Elements);

LexicalBlockStack.pop_back();
return RealDecl;
2871}

2873llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
                                    llvm::DIFile *Unit) {
llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
int64_t Count = Ty->getNumElements();

llvm::Metadata *Subscript;
QualType QTy(Ty, 0);
auto SizeExpr = SizeExprCache.find(QTy);
if (SizeExpr != SizeExprCache.end())
  Subscript = DBuilder.getOrCreateSubrange(
      SizeExpr->getSecond() /*count*/, nullptr /*lowerBound*/,
      nullptr /*upperBound*/, nullptr /*stride*/);
else {
  auto *CountNode =
      llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
          llvm::Type::getInt64Ty(CGM.getLLVMContext()), Count ? Count : -1));
  Subscript = DBuilder.getOrCreateSubrange(
      CountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
      nullptr /*stride*/);
}
llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);

uint64_t Size = CGM.getContext().getTypeSize(Ty);
auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());

return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2899}

2901llvm::DIType *CGDebugInfo::CreateType(const ConstantMatrixType *Ty,
                                    llvm::DIFile *Unit) {
// FIXME: Create another debug type for matrices
// For the time being, it treats it like a nested ArrayType.

llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
uint64_t Size = CGM.getContext().getTypeSize(Ty);
uint32_t Align = getTypeAlignIfRequired(Ty, CGM.getContext());

// Create ranges for both dimensions.
llvm::SmallVector<llvm::Metadata *, 2> Subscripts;
auto *ColumnCountNode =
    llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
        llvm::Type::getInt64Ty(CGM.getLLVMContext()), Ty->getNumColumns()));
auto *RowCountNode =
    llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
        llvm::Type::getInt64Ty(CGM.getLLVMContext()), Ty->getNumRows()));
Subscripts.push_back(DBuilder.getOrCreateSubrange(
    ColumnCountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
    nullptr /*stride*/));
Subscripts.push_back(DBuilder.getOrCreateSubrange(
    RowCountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
    nullptr /*stride*/));
llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
return DBuilder.createArrayType(Size, Align, ElementTy, SubscriptArray);
2926}

2928llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
uint64_t Size;
uint32_t Align;

// FIXME: make getTypeAlign() aware of VLAs and incomplete array types
if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
  Size = 0;
  Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
                                 CGM.getContext());
} else if (Ty->isIncompleteArrayType()) {
  Size = 0;
  if (Ty->getElementType()->isIncompleteType())
    Align = 0;
  else
    Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
} else if (Ty->isIncompleteType()) {
  Size = 0;
  Align = 0;
} else {
  // Size and align of the whole array, not the element type.
  Size = CGM.getContext().getTypeSize(Ty);
  Align = getTypeAlignIfRequired(Ty, CGM.getContext());
}

// Add the dimensions of the array.  FIXME: This loses CV qualifiers from
// interior arrays, do we care?  Why aren't nested arrays represented the
// obvious/recursive way?
SmallVector<llvm::Metadata *, 8> Subscripts;
QualType EltTy(Ty, 0);
while ((Ty = dyn_cast<ArrayType>(EltTy))) {
  // If the number of elements is known, then count is that number. Otherwise,
  // it's -1. This allows us to represent a subrange with an array of 0
  // elements, like this:
  //
  //   struct foo {
  //     int x[0];
  //   };
  int64_t Count = -1; // Count == -1 is an unbounded array.
  if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
    Count = CAT->getSize().getZExtValue();
  else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
    if (Expr *Size = VAT->getSizeExpr()) {
      Expr::EvalResult Result;
      if (Size->EvaluateAsInt(Result, CGM.getContext()))
        Count = Result.Val.getInt().getExtValue();
    }
  }

  auto SizeNode = SizeExprCache.find(EltTy);
  if (SizeNode != SizeExprCache.end())
    Subscripts.push_back(DBuilder.getOrCreateSubrange(
        SizeNode->getSecond() /*count*/, nullptr /*lowerBound*/,
        nullptr /*upperBound*/, nullptr /*stride*/));
  else {
    auto *CountNode =
        llvm::ConstantAsMetadata::get(llvm::ConstantInt::getSigned(
            llvm::Type::getInt64Ty(CGM.getLLVMContext()), Count));
    Subscripts.push_back(DBuilder.getOrCreateSubrange(
        CountNode /*count*/, nullptr /*lowerBound*/, nullptr /*upperBound*/,
        nullptr /*stride*/));
  }
  EltTy = Ty->getElementType();
}

llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);

return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
                                SubscriptArray);
2996}

2998llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
                                    llvm::DIFile *Unit) {
return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
                             Ty->getPointeeType(), Unit);
3002}

3004llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
                                    llvm::DIFile *Unit) {
llvm::dwarf::Tag Tag = llvm::dwarf::DW_TAG_rvalue_reference_type;
// DW_TAG_rvalue_reference_type was introduced in DWARF 4.
if (CGM.getCodeGenOpts().DebugStrictDwarf &&
    CGM.getCodeGenOpts().DwarfVersion < 4)
  Tag = llvm::dwarf::DW_TAG_reference_type;

return CreatePointerLikeType(Tag, Ty, Ty->getPointeeType(), Unit);
3013}

3015llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
                                    llvm::DIFile *U) {
llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
uint64_t Size = 0;

if (!Ty->isIncompleteType()) {
10
←
Assuming the condition is false→
11
←
Taking false branch→
  Size = CGM.getContext().getTypeSize(Ty);

  // Set the MS inheritance model. There is no flag for the unspecified model.
  if (CGM.getTarget().getCXXABI().isMicrosoft()) {
    switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
    case MSInheritanceModel::Single:
      Flags |= llvm::DINode::FlagSingleInheritance;
      break;
    case MSInheritanceModel::Multiple:
      Flags |= llvm::DINode::FlagMultipleInheritance;
      break;
    case MSInheritanceModel::Virtual:
      Flags |= llvm::DINode::FlagVirtualInheritance;
      break;
    case MSInheritanceModel::Unspecified:
      break;
    }
  }
}

llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
if (Ty->isMemberDataPointerType())
12
←
Calling 'Type::isMemberDataPointerType'→
16
←
Returning from 'Type::isMemberDataPointerType'→
17
←
Taking false branch→
  return DBuilder.createMemberPointerType(
      getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
      Flags);

const FunctionProtoType *FPT =
19
←
'FPT' initialized to a null pointer value→
    Ty->getPointeeType()->getAs<FunctionProtoType>();
18
←
Assuming the object is not a 'FunctionProtoType'→
return DBuilder.createMemberPointerType(
    getOrCreateInstanceMethodType(
21
←
Calling 'CGDebugInfo::getOrCreateInstanceMethodType'→
        CXXMethodDecl::getThisType(FPT, Ty->getMostRecentCXXRecordDecl()),
        FPT, U, false),
20
←
Passing null pointer value via 2nd parameter 'Func'→
    ClassType, Size, /*Align=*/0, Flags);
3054}

3056llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
auto *FromTy = getOrCreateType(Ty->getValueType(), U);
return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
3059}

3061llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
return getOrCreateType(Ty->getElementType(), U);
3063}

3065llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
const EnumDecl *ED = Ty->getDecl();

uint64_t Size = 0;
uint32_t Align = 0;
if (!ED->getTypeForDecl()->isIncompleteType()) {
  Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
  Align = getDeclAlignIfRequired(ED, CGM.getContext());
}

SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);

bool isImportedFromModule =
    DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();

// If this is just a forward declaration, construct an appropriately
// marked node and just return it.
if (isImportedFromModule || !ED->getDefinition()) {
  // Note that it is possible for enums to be created as part of
  // their own declcontext. In this case a FwdDecl will be created
  // twice. This doesn't cause a problem because both FwdDecls are
  // entered into the ReplaceMap: finalize() will replace the first
  // FwdDecl with the second and then replace the second with
  // complete type.
  llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
  llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
  llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
      llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));

  unsigned Line = getLineNumber(ED->getLocation());
  StringRef EDName = ED->getName();
  llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
      llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
      0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);

  ReplaceMap.emplace_back(
      std::piecewise_construct, std::make_tuple(Ty),
      std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
  return RetTy;
}

return CreateTypeDefinition(Ty);
3107}

3109llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
const EnumDecl *ED = Ty->getDecl();
uint64_t Size = 0;
uint32_t Align = 0;
if (!ED->getTypeForDecl()->isIncompleteType()) {
  Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
  Align = getDeclAlignIfRequired(ED, CGM.getContext());
}

SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);

SmallVector<llvm::Metadata *, 16> Enumerators;
ED = ED->getDefinition();
for (const auto *Enum : ED->enumerators()) {
  Enumerators.push_back(
      DBuilder.createEnumerator(Enum->getName(), Enum->getInitVal()));
}

// Return a CompositeType for the enum itself.
llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);

llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
unsigned Line = getLineNumber(ED->getLocation());
llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
                                      Line, Size, Align, EltArray, ClassTy,
                                      Identifier, ED->isScoped());
3137}

3139llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
                                      unsigned MType, SourceLocation LineLoc,
                                      StringRef Name, StringRef Value) {
unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
return DBuilder.createMacro(Parent, Line, MType, Name, Value);
3144}

3146llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
                                                  SourceLocation LineLoc,
                                                  SourceLocation FileLoc) {
llvm::DIFile *FName = getOrCreateFile(FileLoc);
unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
return DBuilder.createTempMacroFile(Parent, Line, FName);
3152}

3154static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
Qualifiers Quals;
do {
  Qualifiers InnerQuals = T.getLocalQualifiers();
  // Qualifiers::operator+() doesn't like it if you add a Qualifier
  // that is already there.
  Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
  Quals += InnerQuals;
  QualType LastT = T;
  switch (T->getTypeClass()) {
  default:
    return C.getQualifiedType(T.getTypePtr(), Quals);
  case Type::TemplateSpecialization: {
    const auto *Spec = cast<TemplateSpecializationType>(T);
    if (Spec->isTypeAlias())
      return C.getQualifiedType(T.getTypePtr(), Quals);
    T = Spec->desugar();
    break;
  }
  case Type::TypeOfExpr:
    T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
    break;
  case Type::TypeOf:
    T = cast<TypeOfType>(T)->getUnderlyingType();
    break;
  case Type::Decltype:
    T = cast<DecltypeType>(T)->getUnderlyingType();
    break;
  case Type::UnaryTransform:
    T = cast<UnaryTransformType>(T)->getUnderlyingType();
    break;
  case Type::Attributed:
    T = cast<AttributedType>(T)->getEquivalentType();
    break;
  case Type::Elaborated:
    T = cast<ElaboratedType>(T)->getNamedType();
    break;
  case Type::Paren:
    T = cast<ParenType>(T)->getInnerType();
    break;
  case Type::MacroQualified:
    T = cast<MacroQualifiedType>(T)->getUnderlyingType();
    break;
  case Type::SubstTemplateTypeParm:
    T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
    break;
  case Type::Auto:
  case Type::DeducedTemplateSpecialization: {
    QualType DT = cast<DeducedType>(T)->getDeducedType();
    assert(!DT.isNull() && "Undeduced types shouldn't reach here.")(static_cast<void> (0));
    T = DT;
    break;
  }
  case Type::Adjusted:
  case Type::Decayed:
    // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
    T = cast<AdjustedType>(T)->getAdjustedType();
    break;
  }

  assert(T != LastT && "Type unwrapping failed to unwrap!")(static_cast<void> (0));
  (void)LastT;
} while (true);
3217}

3219llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
assert(Ty == UnwrapTypeForDebugInfo(Ty, CGM.getContext()))(static_cast<void> (0));
auto It = TypeCache.find(Ty.getAsOpaquePtr());
if (It != TypeCache.end()) {
  // Verify that the debug info still exists.
  if (llvm::Metadata *V = It->second)
    return cast<llvm::DIType>(V);
}

return nullptr;
3229}

3231void CGDebugInfo::completeTemplateDefinition(
  const ClassTemplateSpecializationDecl &SD) {
completeUnusedClass(SD);
3234}

3236void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
if (DebugKind <= codegenoptions::DebugLineTablesOnly)
  return;

completeClassData(&D);
// In case this type has no member function definitions being emitted, ensure
// it is retained
RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
3244}

3246llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
if (Ty.isNull())
3
←
Taking false branch→
  return nullptr;

llvm::TimeTraceScope TimeScope("DebugType", [&]() {
  std::string Name;
  llvm::raw_string_ostream OS(Name);
  Ty.print(OS, getPrintingPolicy());
  return Name;
});

// Unwrap the type as needed for debug information.
Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());

if (auto *T3.1
'T' is null
1
'T' is null
 = getTypeOrNull(Ty))
4
←
Taking false branch→
  return T;

llvm::DIType *Res = CreateTypeNode(Ty, Unit);
5
←
Calling 'CGDebugInfo::CreateTypeNode'→
void *TyPtr = Ty.getAsOpaquePtr();

// And update the type cache.
TypeCache[TyPtr].reset(Res);

return Res;
3270}

3272llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
// A forward declaration inside a module header does not belong to the module.
if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
  return nullptr;
if (DebugTypeExtRefs && D->isFromASTFile()) {
  // Record a reference to an imported clang module or precompiled header.
  auto *Reader = CGM.getContext().getExternalSource();
  auto Idx = D->getOwningModuleID();
  auto Info = Reader->getSourceDescriptor(Idx);
  if (Info)
    return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
} else if (ClangModuleMap) {
  // We are building a clang module or a precompiled header.
  //
  // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
  // and it wouldn't be necessary to specify the parent scope
  // because the type is already unique by definition (it would look
  // like the output of -fno-standalone-debug). On the other hand,
  // the parent scope helps a consumer to quickly locate the object
  // file where the type's definition is located, so it might be
  // best to make this behavior a command line or debugger tuning
  // option.
  if (Module *M = D->getOwningModule()) {
    // This is a (sub-)module.
    auto Info = ASTSourceDescriptor(*M);
    return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
  } else {
    // This the precompiled header being built.
    return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
  }
}

return nullptr;
3305}

3307llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
// Handle qualifiers, which recursively handles what they refer to.
if (Ty.hasLocalQualifiers())
6
←
Assuming the condition is false→
7
←
Taking false branch→
  return CreateQualifiedType(Ty, Unit);

// Work out details of type.
switch (Ty->getTypeClass()) {
8
←
Control jumps to 'case MemberPointer:'  at line 3361→
3314#define TYPE(Class, Base)
3315#define ABSTRACT_TYPE(Class, Base)
3316#define NON_CANONICAL_TYPE(Class, Base)
3317#define DEPENDENT_TYPE(Class, Base) case Type::Class:
3318#include "clang/AST/TypeNodes.inc"
  llvm_unreachable("Dependent types cannot show up in debug information")__builtin_unreachable();

case Type::ExtVector:
case Type::Vector:
  return CreateType(cast<VectorType>(Ty), Unit);
case Type::ConstantMatrix:
  return CreateType(cast<ConstantMatrixType>(Ty), Unit);
case Type::ObjCObjectPointer:
  return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
case Type::ObjCObject:
  return CreateType(cast<ObjCObjectType>(Ty), Unit);
case Type::ObjCTypeParam:
  return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
case Type::ObjCInterface:
  return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
case Type::Builtin:
  return CreateType(cast<BuiltinType>(Ty));
case Type::Complex:
  return CreateType(cast<ComplexType>(Ty));
case Type::Pointer:
  return CreateType(cast<PointerType>(Ty), Unit);
case Type::BlockPointer:
  return CreateType(cast<BlockPointerType>(Ty), Unit);
case Type::Typedef:
  return CreateType(cast<TypedefType>(Ty), Unit);
case Type::Record:
  return CreateType(cast<RecordType>(Ty));
case Type::Enum:
  return CreateEnumType(cast<EnumType>(Ty));
case Type::FunctionProto:
case Type::FunctionNoProto:
  return CreateType(cast<FunctionType>(Ty), Unit);
case Type::ConstantArray:
case Type::VariableArray:
case Type::IncompleteArray:
  return CreateType(cast<ArrayType>(Ty), Unit);

case Type::LValueReference:
  return CreateType(cast<LValueReferenceType>(Ty), Unit);
case Type::RValueReference:
  return CreateType(cast<RValueReferenceType>(Ty), Unit);

case Type::MemberPointer:
  return CreateType(cast<MemberPointerType>(Ty), Unit);
9
←
Calling 'CGDebugInfo::CreateType'→

case Type::Atomic:
  return CreateType(cast<AtomicType>(Ty), Unit);

case Type::ExtInt:
  return CreateType(cast<ExtIntType>(Ty));
case Type::Pipe:
  return CreateType(cast<PipeType>(Ty), Unit);

case Type::TemplateSpecialization:
  return CreateType(cast<TemplateSpecializationType>(Ty), Unit);

case Type::Auto:
case Type::Attributed:
case Type::Adjusted:
case Type::Decayed:
case Type::DeducedTemplateSpecialization:
case Type::Elaborated:
case Type::Paren:
case Type::MacroQualified:
case Type::SubstTemplateTypeParm:
case Type::TypeOfExpr:
case Type::TypeOf:
case Type::Decltype:
case Type::UnaryTransform:
  break;
}

llvm_unreachable("type should have been unwrapped!")__builtin_unreachable();
3392}

3394llvm::DICompositeType *
3395CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty) {
QualType QTy(Ty, 0);

auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));

// We may have cached a forward decl when we could have created
// a non-forward decl. Go ahead and create a non-forward decl
// now.
if (T && !T->isForwardDecl())
  return T;

// Otherwise create the type.
llvm::DICompositeType *Res = CreateLimitedType(Ty);

// Propagate members from the declaration to the definition
// CreateType(const RecordType*) will overwrite this with the members in the
// correct order if the full type is needed.
DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());

// And update the type cache.
TypeCache[QTy.getAsOpaquePtr()].reset(Res);
return Res;
3417}

3419// TODO: Currently used for context chains when limiting debug info.
3420llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
RecordDecl *RD = Ty->getDecl();

// Get overall information about the record type for the debug info.
StringRef RDName = getClassName(RD);
const SourceLocation Loc = RD->getLocation();
llvm::DIFile *DefUnit = nullptr;
unsigned Line = 0;
if (Loc.isValid()) {
  DefUnit = getOrCreateFile(Loc);
  Line = getLineNumber(Loc);
}

llvm::DIScope *RDContext = getDeclContextDescriptor(RD);

// If we ended up creating the type during the context chain construction,
// just return that.
auto *T = cast_or_null<llvm::DICompositeType>(
    getTypeOrNull(CGM.getContext().getRecordType(RD)));
if (T && (!T->isForwardDecl() || !RD->getDefinition()))
  return T;

// If this is just a forward or incomplete declaration, construct an
// appropriately marked node and just return it.
const RecordDecl *D = RD->getDefinition();
if (!D || !D->isCompleteDefinition())
  return getOrCreateRecordFwdDecl(Ty, RDContext);

uint64_t Size = CGM.getContext().getTypeSize(Ty);
auto Align = getDeclAlignIfRequired(D, CGM.getContext());

SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);

// Explicitly record the calling convention and export symbols for C++
// records.
auto Flags = llvm::DINode::FlagZero;
if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
  if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
    Flags |= llvm::DINode::FlagTypePassByReference;
  else
    Flags |= llvm::DINode::FlagTypePassByValue;

  // Record if a C++ record is non-trivial type.
  if (!CXXRD->isTrivial())
    Flags |= llvm::DINode::FlagNonTrivial;

  // Record exports it symbols to the containing structure.
  if (CXXRD->isAnonymousStructOrUnion())
      Flags |= llvm::DINode::FlagExportSymbols;
}

llvm::DINodeArray Annotations = CollectBTFTagAnnotations(D);
llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
    getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
    Flags, Identifier, Annotations);

// Elements of composite types usually have back to the type, creating
// uniquing cycles.  Distinct nodes are more efficient.
switch (RealDecl->getTag()) {
default:
  llvm_unreachable("invalid composite type tag")__builtin_unreachable();

case llvm::dwarf::DW_TAG_array_type:
case llvm::dwarf::DW_TAG_enumeration_type:
  // Array elements and most enumeration elements don't have back references,
  // so they don't tend to be involved in uniquing cycles and there is some
  // chance of merging them when linking together two modules.  Only make
  // them distinct if they are ODR-uniqued.
  if (Identifier.empty())
    break;
  LLVM_FALLTHROUGH[[gnu::fallthrough]];

case llvm::dwarf::DW_TAG_structure_type:
case llvm::dwarf::DW_TAG_union_type:
case llvm::dwarf::DW_TAG_class_type:
  // Immediately resolve to a distinct node.
  RealDecl =
      llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
  break;
}

RegionMap[Ty->getDecl()].reset(RealDecl);
TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);

if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
  DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
                         CollectCXXTemplateParams(TSpecial, DefUnit));
return RealDecl;
3508}

3510void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
                                      llvm::DICompositeType *RealDecl) {
// A class's primary base or the class itself contains the vtable.
llvm::DICompositeType *ContainingType = nullptr;
const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
  // Seek non-virtual primary base root.
  while (1) {
    const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
    const CXXRecordDecl *PBT = BRL.getPrimaryBase();
    if (PBT && !BRL.isPrimaryBaseVirtual())
      PBase = PBT;
    else
      break;
  }
  ContainingType = cast<llvm::DICompositeType>(
      getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
                      getOrCreateFile(RD->getLocation())));
} else if (RD->isDynamicClass())
  ContainingType = RealDecl;

DBuilder.replaceVTableHolder(RealDecl, ContainingType);
3532}

3534llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
                                          StringRef Name, uint64_t *Offset) {
llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
llvm::DIType *Ty =
    DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
                              *Offset, llvm::DINode::FlagZero, FieldTy);
*Offset += FieldSize;
return Ty;
3544}

3546void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
                                         StringRef &Name,
                                         StringRef &LinkageName,
                                         llvm::DIScope *&FDContext,
                                         llvm::DINodeArray &TParamsArray,
                                         llvm::DINode::DIFlags &Flags) {
const auto *FD = cast<FunctionDecl>(GD.getCanonicalDecl().getDecl());
Name = getFunctionName(FD);
// Use mangled name as linkage name for C/C++ functions.
if (FD->getType()->getAs<FunctionProtoType>())
  LinkageName = CGM.getMangledName(GD);
if (FD->hasPrototype())
  Flags |= llvm::DINode::FlagPrototyped;
// No need to replicate the linkage name if it isn't different from the
// subprogram name, no need to have it at all unless coverage is enabled or
// debug is set to more than just line tables or extra debug info is needed.
if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
                            !CGM.getCodeGenOpts().EmitGcovNotes &&
                            !CGM.getCodeGenOpts().DebugInfoForProfiling &&
                            !CGM.getCodeGenOpts().PseudoProbeForProfiling &&
                            DebugKind <= codegenoptions::DebugLineTablesOnly))
  LinkageName = StringRef();

// Emit the function scope in line tables only mode (if CodeView) to
// differentiate between function names.
if (CGM.getCodeGenOpts().hasReducedDebugInfo() ||
    (DebugKind == codegenoptions::DebugLineTablesOnly &&
     CGM.getCodeGenOpts().EmitCodeView)) {
  if (const NamespaceDecl *NSDecl =
          dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
    FDContext = getOrCreateNamespace(NSDecl);
  else if (const RecordDecl *RDecl =
               dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
    llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
    FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
  }
}
if (CGM.getCodeGenOpts().hasReducedDebugInfo()) {
  // Check if it is a noreturn-marked function
  if (FD->isNoReturn())
    Flags |= llvm::DINode::FlagNoReturn;
  // Collect template parameters.
  TParamsArray = CollectFunctionTemplateParams(FD, Unit);
}
3590}

3592void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
                                    unsigned &LineNo, QualType &T,
                                    StringRef &Name, StringRef &LinkageName,
                                    llvm::MDTuple *&TemplateParameters,
                                    llvm::DIScope *&VDContext) {
Unit = getOrCreateFile(VD->getLocation());
LineNo = getLineNumber(VD->getLocation());

setLocation(VD->getLocation());

T = VD->getType();
if (T->isIncompleteArrayType()) {
  // CodeGen turns int[] into int[1] so we'll do the same here.
  llvm::APInt ConstVal(32, 1);
  QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();

  T = CGM.getContext().getConstantArrayType(ET, ConstVal, nullptr,
                                            ArrayType::Normal, 0);
}

Name = VD->getName();
if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
    !isa<ObjCMethodDecl>(VD->getDeclContext()))
  LinkageName = CGM.getMangledName(VD);
if (LinkageName == Name)
  LinkageName = StringRef();

if (isa<VarTemplateSpecializationDecl>(VD)) {
  llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
  TemplateParameters = parameterNodes.get();
} else {
  TemplateParameters = nullptr;
}

// Since we emit declarations (DW_AT_members) for static members, place the
// definition of those static members in the namespace they were declared in
// in the source code (the lexical decl context).
// FIXME: Generalize this for even non-member global variables where the
// declaration and definition may have different lexical decl contexts, once
// we have support for emitting declarations of (non-member) global variables.
const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
                                                 : VD->getDeclContext();
// When a record type contains an in-line initialization of a static data
// member, and the record type is marked as __declspec(dllexport), an implicit
// definition of the member will be created in the record context.  DWARF
// doesn't seem to have a nice way to describe this in a form that consumers
// are likely to understand, so fake the "normal" situation of a definition
// outside the class by putting it in the global scope.
if (DC->isRecord())
  DC = CGM.getContext().getTranslationUnitDecl();

llvm::DIScope *Mod = getParentModuleOrNull(VD);
VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
3645}

3647llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
                                                        bool Stub) {
llvm::DINodeArray TParamsArray;
StringRef Name, LinkageName;
llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
SourceLocation Loc = GD.getDecl()->getLocation();
llvm::DIFile *Unit = getOrCreateFile(Loc);
llvm::DIScope *DContext = Unit;
unsigned Line = getLineNumber(Loc);
collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
                         Flags);
auto *FD = cast<FunctionDecl>(GD.getDecl());

// Build function type.
SmallVector<QualType, 16> ArgTypes;
for (const ParmVarDecl *Parm : FD->parameters())
  ArgTypes.push_back(Parm->getType());

CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
QualType FnType = CGM.getContext().getFunctionType(
    FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
if (!FD->isExternallyVisible())
  SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
if (CGM.getLangOpts().Optimize)
  SPFlags |= llvm::DISubprogram::SPFlagOptimized;

if (Stub) {
  Flags |= getCallSiteRelatedAttrs();
  SPFlags |= llvm::DISubprogram::SPFlagDefinition;
  return DBuilder.createFunction(
      DContext, Name, LinkageName, Unit, Line,
      getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
      TParamsArray.get(), getFunctionDeclaration(FD));
}

llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
    DContext, Name, LinkageName, Unit, Line,
    getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
    TParamsArray.get(), getFunctionDeclaration(FD));
const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
                               std::make_tuple(CanonDecl),
                               std::make_tuple(SP));
return SP;
3692}

3694llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3696}

3698llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3700}

3702llvm::DIGlobalVariable *
3703CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
QualType T;
StringRef Name, LinkageName;
SourceLocation Loc = VD->getLocation();
llvm::DIFile *Unit = getOrCreateFile(Loc);
llvm::DIScope *DContext = Unit;
unsigned Line = getLineNumber(Loc);
llvm::MDTuple *TemplateParameters = nullptr;

collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
                    DContext);
auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
    DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
    !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
FwdDeclReplaceMap.emplace_back(
    std::piecewise_construct,
    std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
    std::make_tuple(static_cast<llvm::Metadata *>(GV)));
return GV;
3723}

3725llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
// We only need a declaration (not a definition) of the type - so use whatever
// we would otherwise do to get a type for a pointee. (forward declarations in
// limited debug info, full definitions (if the type definition is available)
// in unlimited debug info)
if (const auto *TD = dyn_cast<TypeDecl>(D))
  return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
                         getOrCreateFile(TD->getLocation()));
auto I = DeclCache.find(D->getCanonicalDecl());

if (I != DeclCache.end()) {
  auto N = I->second;
  if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
    return GVE->getVariable();
  return dyn_cast_or_null<llvm::DINode>(N);
}

// No definition for now. Emit a forward definition that might be
// merged with a potential upcoming definition.
if (const auto *FD = dyn_cast<FunctionDecl>(D))
  return getFunctionForwardDeclaration(FD);
else if (const auto *VD = dyn_cast<VarDecl>(D))
  return getGlobalVariableForwardDeclaration(VD);

return nullptr;
3750}

3752llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
  return nullptr;

const auto *FD = dyn_cast<FunctionDecl>(D);
if (!FD)
  return nullptr;

// Setup context.
auto *S = getDeclContextDescriptor(D);

auto MI = SPCache.find(FD->getCanonicalDecl());
if (MI == SPCache.end()) {
  if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
    return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
                                   cast<llvm::DICompositeType>(S));
  }
}
if (MI != SPCache.end()) {
  auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
  if (SP && !SP->isDefinition())
    return SP;
}

for (auto NextFD : FD->redecls()) {
  auto MI = SPCache.find(NextFD->getCanonicalDecl());
  if (MI != SPCache.end()) {
    auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
    if (SP && !SP->isDefinition())
      return SP;
  }
}
return nullptr;
3785}

3787llvm::DISubprogram *CGDebugInfo::getObjCMethodDeclaration(
  const Decl *D, llvm::DISubroutineType *FnType, unsigned LineNo,
  llvm::DINode::DIFlags Flags, llvm::DISubprogram::DISPFlags SPFlags) {
if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
  return nullptr;

const auto *OMD = dyn_cast<ObjCMethodDecl>(D);
if (!OMD)
  return nullptr;

if (CGM.getCodeGenOpts().DwarfVersion < 5 && !OMD->isDirectMethod())
  return nullptr;

if (OMD->isDirectMethod())
  SPFlags |= llvm::DISubprogram::SPFlagObjCDirect;

// Starting with DWARF V5 method declarations are emitted as children of
// the interface type.
auto *ID = dyn_cast_or_null<ObjCInterfaceDecl>(D->getDeclContext());
if (!ID)
  ID = OMD->getClassInterface();
if (!ID)
  return nullptr;
QualType QTy(ID->getTypeForDecl(), 0);
auto It = TypeCache.find(QTy.getAsOpaquePtr());
if (It == TypeCache.end())
  return nullptr;
auto *InterfaceType = cast<llvm::DICompositeType>(It->second);
llvm::DISubprogram *FD = DBuilder.createFunction(
    InterfaceType, getObjCMethodName(OMD), StringRef(),
    InterfaceType->getFile(), LineNo, FnType, LineNo, Flags, SPFlags);
DBuilder.finalizeSubprogram(FD);
ObjCMethodCache[ID].push_back({FD, OMD->isDirectMethod()});
return FD;
3821}

3823// getOrCreateFunctionType - Construct type. If it is a c++ method, include
3824// implicit parameter "this".
3825llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
                                                           QualType FnType,
                                                           llvm::DIFile *F) {
// In CodeView, we emit the function types in line tables only because the
// only way to distinguish between functions is by display name and type.
if (!D || (DebugKind <= codegenoptions::DebugLineTablesOnly &&
           !CGM.getCodeGenOpts().EmitCodeView))
  // Create fake but valid subroutine type. Otherwise -verify would fail, and
  // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
  return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));

if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
  return getOrCreateMethodType(Method, F, false);

const auto *FTy = FnType->getAs<FunctionType>();
CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;

if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
  // Add "self" and "_cmd"
  SmallVector<llvm::Metadata *, 16> Elts;

  // First element is always return type. For 'void' functions it is NULL.
  QualType ResultTy = OMethod->getReturnType();

  // Replace the instancetype keyword with the actual type.
  if (ResultTy == CGM.getContext().getObjCInstanceType())
    ResultTy = CGM.getContext().getPointerType(
        QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));

  Elts.push_back(getOrCreateType(ResultTy, F));
  // "self" pointer is always first argument.
  QualType SelfDeclTy;
  if (auto *SelfDecl = OMethod->getSelfDecl())
    SelfDeclTy = SelfDecl->getType();
  else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
    if (FPT->getNumParams() > 1)
      SelfDeclTy = FPT->getParamType(0);
  if (!SelfDeclTy.isNull())
    Elts.push_back(
        CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
  // "_cmd" pointer is always second argument.
  Elts.push_back(DBuilder.createArtificialType(
      getOrCreateType(CGM.getContext().getObjCSelType(), F)));
  // Get rest of the arguments.
  for (const auto *PI : OMethod->parameters())
    Elts.push_back(getOrCreateType(PI->getType(), F));
  // Variadic methods need a special marker at the end of the type list.
  if (OMethod->isVariadic())
    Elts.push_back(DBuilder.createUnspecifiedParameter());

  llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
  return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
                                       getDwarfCC(CC));
}

// Handle variadic function types; they need an additional
// unspecified parameter.
if (const auto *FD = dyn_cast<FunctionDecl>(D))
  if (FD->isVariadic()) {
    SmallVector<llvm::Metadata *, 16> EltTys;
    EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
    if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
      for (QualType ParamType : FPT->param_types())
        EltTys.push_back(getOrCreateType(ParamType, F));
    EltTys.push_back(DBuilder.createUnspecifiedParameter());
    llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
    return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
                                         getDwarfCC(CC));
  }

return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
3896}

3898void CGDebugInfo::emitFunctionStart(GlobalDecl GD, SourceLocation Loc,
                                  SourceLocation ScopeLoc, QualType FnType,
                                  llvm::Function *Fn, bool CurFuncIsThunk) {
StringRef Name;
StringRef LinkageName;

FnBeginRegionCount.push_back(LexicalBlockStack.size());

const Decl *D = GD.getDecl();
bool HasDecl = (D != nullptr);

llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
llvm::DIFile *Unit = getOrCreateFile(Loc);
llvm::DIScope *FDContext = Unit;
llvm::DINodeArray TParamsArray;
if (!HasDecl) {
  // Use llvm function name.
  LinkageName = Fn->getName();
} else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
  // If there is a subprogram for this function available then use it.
  auto FI = SPCache.find(FD->getCanonicalDecl());
  if (FI != SPCache.end()) {
    auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
    if (SP && SP->isDefinition()) {
      LexicalBlockStack.emplace_back(SP);
      RegionMap[D].reset(SP);
      return;
    }
  }
  collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
                           TParamsArray, Flags);
} else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
  Name = getObjCMethodName(OMD);
  Flags |= llvm::DINode::FlagPrototyped;
} else if (isa<VarDecl>(D) &&
           GD.getDynamicInitKind() != DynamicInitKind::NoStub) {
  // This is a global initializer or atexit destructor for a global variable.
  Name = getDynamicInitializerName(cast<VarDecl>(D), GD.getDynamicInitKind(),
                                   Fn);
} else {
  Name = Fn->getName();

  if (isa<BlockDecl>(D))
    LinkageName = Name;

  Flags |= llvm::DINode::FlagPrototyped;
}
if (Name.startswith("\01"))
  Name = Name.substr(1);

if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>() ||
    (isa<VarDecl>(D) && GD.getDynamicInitKind() != DynamicInitKind::NoStub)) {
  Flags |= llvm::DINode::FlagArtificial;
  // Artificial functions should not silently reuse CurLoc.
  CurLoc = SourceLocation();
}

if (CurFuncIsThunk)
  Flags |= llvm::DINode::FlagThunk;

if (Fn->hasLocalLinkage())
  SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
if (CGM.getLangOpts().Optimize)
  SPFlags |= llvm::DISubprogram::SPFlagOptimized;

llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
llvm::DISubprogram::DISPFlags SPFlagsForDef =
    SPFlags | llvm::DISubprogram::SPFlagDefinition;

const unsigned LineNo = getLineNumber(Loc.isValid() ? Loc : CurLoc);
unsigned ScopeLine = getLineNumber(ScopeLoc);
llvm::DISubroutineType *DIFnType = getOrCreateFunctionType(D, FnType, Unit);
llvm::DISubprogram *Decl = nullptr;
llvm::DINodeArray Annotations = nullptr;
if (D) {
  Decl = isa<ObjCMethodDecl>(D)
             ? getObjCMethodDeclaration(D, DIFnType, LineNo, Flags, SPFlags)
             : getFunctionDeclaration(D);
  Annotations = CollectBTFTagAnnotations(D);
}

// FIXME: The function declaration we're constructing here is mostly reusing
// declarations from CXXMethodDecl and not constructing new ones for arbitrary
// FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
// all subprograms instead of the actual context since subprogram definitions
// are emitted as CU level entities by the backend.
llvm::DISubprogram *SP = DBuilder.createFunction(
    FDContext, Name, LinkageName, Unit, LineNo, DIFnType, ScopeLine,
    FlagsForDef, SPFlagsForDef, TParamsArray.get(), Decl, nullptr,
    Annotations);
Fn->setSubprogram(SP);
// We might get here with a VarDecl in the case we're generating
// code for the initialization of globals. Do not record these decls
// as they will overwrite the actual VarDecl Decl in the cache.
if (HasDecl && isa<FunctionDecl>(D))
  DeclCache[D->getCanonicalDecl()].reset(SP);

// Push the function onto the lexical block stack.
LexicalBlockStack.emplace_back(SP);

if (HasDecl)
  RegionMap[D].reset(SP);
4001}

4003void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
                                 QualType FnType, llvm::Function *Fn) {
StringRef Name;
StringRef LinkageName;

const Decl *D = GD.getDecl();
if (!D)
  return;

llvm::TimeTraceScope TimeScope("DebugFunction", [&]() {
  return GetName(D, true);
});

llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
llvm::DIFile *Unit = getOrCreateFile(Loc);
bool IsDeclForCallSite = Fn ? true : false;
llvm::DIScope *FDContext =
    IsDeclForCallSite ? Unit : getDeclContextDescriptor(D);
llvm::DINodeArray TParamsArray;
if (isa<FunctionDecl>(D)) {
  // If there is a DISubprogram for this function available then use it.
  collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
                           TParamsArray, Flags);
} else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
  Name = getObjCMethodName(OMD);
  Flags |= llvm::DINode::FlagPrototyped;
} else {
  llvm_unreachable("not a function or ObjC method")__builtin_unreachable();
}
if (!Name.empty() && Name[0] == '\01')
  Name = Name.substr(1);

if (D->isImplicit()) {
  Flags |= llvm::DINode::FlagArtificial;
  // Artificial functions without a location should not silently reuse CurLoc.
  if (Loc.isInvalid())
    CurLoc = SourceLocation();
}
unsigned LineNo = getLineNumber(Loc);
unsigned ScopeLine = 0;
llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
if (CGM.getLangOpts().Optimize)
  SPFlags |= llvm::DISubprogram::SPFlagOptimized;

llvm::DINodeArray Annotations = CollectBTFTagAnnotations(D);
llvm::DISubprogram *SP = DBuilder.createFunction(
    FDContext, Name, LinkageName, Unit, LineNo,
    getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
    TParamsArray.get(), getFunctionDeclaration(D), nullptr, Annotations);

if (IsDeclForCallSite)
  Fn->setSubprogram(SP);

DBuilder.finalizeSubprogram(SP);
4057}

4059void CGDebugInfo::EmitFuncDeclForCallSite(llvm::CallBase *CallOrInvoke,
                                        QualType CalleeType,
                                        const FunctionDecl *CalleeDecl) {
if (!CallOrInvoke)
  return;
auto *Func = CallOrInvoke->getCalledFunction();
if (!Func)
  return;
if (Func->getSubprogram())
  return;

// Do not emit a declaration subprogram for a builtin, a function with nodebug
// attribute, or if call site info isn't required. Also, elide declarations
// for functions with reserved names, as call site-related features aren't
// interesting in this case (& also, the compiler may emit calls to these
// functions without debug locations, which makes the verifier complain).
if (CalleeDecl->getBuiltinID() != 0 || CalleeDecl->hasAttr<NoDebugAttr>() ||
    getCallSiteRelatedAttrs() == llvm::DINode::FlagZero)
  return;
if (CalleeDecl->isReserved(CGM.getLangOpts()) !=
    ReservedIdentifierStatus::NotReserved)
  return;

// If there is no DISubprogram attached to the function being called,
// create the one describing the function in order to have complete
// call site debug info.
if (!CalleeDecl->isStatic() && !CalleeDecl->isInlined())
  EmitFunctionDecl(CalleeDecl, CalleeDecl->getLocation(), CalleeType, Func);
4087}

4089void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
const auto *FD = cast<FunctionDecl>(GD.getDecl());
// If there is a subprogram for this function available then use it.
auto FI = SPCache.find(FD->getCanonicalDecl());
llvm::DISubprogram *SP = nullptr;
if (FI != SPCache.end())
  SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
if (!SP || !SP->isDefinition())
  SP = getFunctionStub(GD);
FnBeginRegionCount.push_back(LexicalBlockStack.size());
LexicalBlockStack.emplace_back(SP);
setInlinedAt(Builder.getCurrentDebugLocation());
EmitLocation(Builder, FD->getLocation());
4102}

4104void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
assert(CurInlinedAt && "unbalanced inline scope stack")(static_cast<void> (0));
EmitFunctionEnd(Builder, nullptr);
setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
4108}

4110void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
// Update our current location
setLocation(Loc);

if (CurLoc.isInvalid() || CurLoc.isMacroID() || LexicalBlockStack.empty())
  return;

llvm::MDNode *Scope = LexicalBlockStack.back();
Builder.SetCurrentDebugLocation(
    llvm::DILocation::get(CGM.getLLVMContext(), getLineNumber(CurLoc),
                          getColumnNumber(CurLoc), Scope, CurInlinedAt));
4121}

4123void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
llvm::MDNode *Back = nullptr;
if (!LexicalBlockStack.empty())
  Back = LexicalBlockStack.back().get();
LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
    cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
    getColumnNumber(CurLoc)));
4130}

4132void CGDebugInfo::AppendAddressSpaceXDeref(
  unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
Optional<unsigned> DWARFAddressSpace =
    CGM.getTarget().getDWARFAddressSpace(AddressSpace);
if (!DWARFAddressSpace)
  return;

Expr.push_back(llvm::dwarf::DW_OP_constu);
Expr.push_back(DWARFAddressSpace.getValue());
Expr.push_back(llvm::dwarf::DW_OP_swap);
Expr.push_back(llvm::dwarf::DW_OP_xderef);
4143}

4145void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
                                      SourceLocation Loc) {
// Set our current location.
setLocation(Loc);

// Emit a line table change for the current location inside the new scope.
Builder.SetCurrentDebugLocation(llvm::DILocation::get(
    CGM.getLLVMContext(), getLineNumber(Loc), getColumnNumber(Loc),
    LexicalBlockStack.back(), CurInlinedAt));

if (DebugKind <= codegenoptions::DebugLineTablesOnly)
  return;

// Create a new lexical block and push it on the stack.
CreateLexicalBlock(Loc);
4160}

4162void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
                                    SourceLocation Loc) {
assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!")(static_cast<void> (0));

// Provide an entry in the line table for the end of the block.
EmitLocation(Builder, Loc);

if (DebugKind <= codegenoptions::DebugLineTablesOnly)
  return;

LexicalBlockStack.pop_back();
4173}

4175void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!")(static_cast<void> (0));
unsigned RCount = FnBeginRegionCount.back();
assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch")(static_cast<void> (0));

// Pop all regions for this function.
while (LexicalBlockStack.size() != RCount) {
  // Provide an entry in the line table for the end of the block.
  EmitLocation(Builder, CurLoc);
  LexicalBlockStack.pop_back();
}
FnBeginRegionCount.pop_back();

if (Fn && Fn->getSubprogram())
  DBuilder.finalizeSubprogram(Fn->getSubprogram());
4190}

4192CGDebugInfo::BlockByRefType
4193CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
                                        uint64_t *XOffset) {
SmallVector<llvm::Metadata *, 5> EltTys;
QualType FType;
uint64_t FieldSize, FieldOffset;
uint32_t FieldAlign;

llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
QualType Type = VD->getType();

FieldOffset = 0;
FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
FType = CGM.getContext().IntTy;
EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));

bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
if (HasCopyAndDispose) {
  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
  EltTys.push_back(
      CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
  EltTys.push_back(
      CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
}
bool HasByrefExtendedLayout;
Qualifiers::ObjCLifetime Lifetime;
if (CGM.getContext().getByrefLifetime(Type, Lifetime,
                                      HasByrefExtendedLayout) &&
    HasByrefExtendedLayout) {
  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
  EltTys.push_back(
      CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
}

CharUnits Align = CGM.getContext().getDeclAlign(VD);
if (Align > CGM.getContext().toCharUnitsFromBits(
                CGM.getTarget().getPointerAlign(0))) {
  CharUnits FieldOffsetInBytes =
      CGM.getContext().toCharUnitsFromBits(FieldOffset);
  CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
  CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;

  if (NumPaddingBytes.isPositive()) {
    llvm::APInt pad(32, NumPaddingBytes.getQuantity());
    FType = CGM.getContext().getConstantArrayType(
        CGM.getContext().CharTy, pad, nullptr, ArrayType::Normal, 0);
    EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
  }
}

FType = Type;
llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
FieldSize = CGM.getContext().getTypeSize(FType);
FieldAlign = CGM.getContext().toBits(Align);

*XOffset = FieldOffset;
llvm::DIType *FieldTy = DBuilder.createMemberType(
    Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
    llvm::DINode::FlagZero, WrappedTy);
EltTys.push_back(FieldTy);
FieldOffset += FieldSize;

llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
                                  llvm::DINode::FlagZero, nullptr, Elements),
        WrappedTy};
4261}

4263llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
                                              llvm::Value *Storage,
                                              llvm::Optional<unsigned> ArgNo,
                                              CGBuilderTy &Builder,
                                              const bool UsePointerValue) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!")(static_cast<void> (0));
if (VD->hasAttr<NoDebugAttr>())
  return nullptr;

bool Unwritten =
    VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
                         cast<Decl>(VD->getDeclContext())->isImplicit());
llvm::DIFile *Unit = nullptr;
if (!Unwritten)
  Unit = getOrCreateFile(VD->getLocation());
llvm::DIType *Ty;
uint64_t XOffset = 0;
if (VD->hasAttr<BlocksAttr>())
  Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
else
  Ty = getOrCreateType(VD->getType(), Unit);

// If there is no debug info for this type then do not emit debug info
// for this variable.
if (!Ty)
  return nullptr;

// Get location information.
unsigned Line = 0;
unsigned Column = 0;
if (!Unwritten) {
  Line = getLineNumber(VD->getLocation());
  Column = getColumnNumber(VD->getLocation());
}
SmallVector<int64_t, 13> Expr;
llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
if (VD->isImplicit())
  Flags |= llvm::DINode::FlagArtificial;

auto Align = getDeclAlignIfRequired(VD, CGM.getContext());

unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
AppendAddressSpaceXDeref(AddressSpace, Expr);

// If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
// object pointer flag.
if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
  if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
      IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
    Flags |= llvm::DINode::FlagObjectPointer;
}

// Note: Older versions of clang used to emit byval references with an extra
// DW_OP_deref, because they referenced the IR arg directly instead of
// referencing an alloca. Newer versions of LLVM don't treat allocas
// differently from other function arguments when used in a dbg.declare.
auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
StringRef Name = VD->getName();
if (!Name.empty()) {
  // __block vars are stored on the heap if they are captured by a block that
  // can escape the local scope.
  if (VD->isEscapingByref()) {
    // Here, we need an offset *into* the alloca.
    CharUnits offset = CharUnits::fromQuantity(32);
    Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
    // offset of __forwarding field
    offset = CGM.getContext().toCharUnitsFromBits(
        CGM.getTarget().getPointerWidth(0));
    Expr.push_back(offset.getQuantity());
    Expr.push_back(llvm::dwarf::DW_OP_deref);
    Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
    // offset of x field
    offset = CGM.getContext().toCharUnitsFromBits(XOffset);
    Expr.push_back(offset.getQuantity());
  }
} else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
  // If VD is an anonymous union then Storage represents value for
  // all union fields.
  const RecordDecl *RD = RT->getDecl();
  if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
    // GDB has trouble finding local variables in anonymous unions, so we emit
    // artificial local variables for each of the members.
    //
    // FIXME: Remove this code as soon as GDB supports this.
    // The debug info verifier in LLVM operates based on the assumption that a
    // variable has the same size as its storage and we had to disable the
    // check for artificial variables.
    for (const auto *Field : RD->fields()) {
      llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
      StringRef FieldName = Field->getName();

      // Ignore unnamed fields. Do not ignore unnamed records.
      if (FieldName.empty() && !isa<RecordType>(Field->getType()))
        continue;

      // Use VarDecl's Tag, Scope and Line number.
      auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
      auto *D = DBuilder.createAutoVariable(
          Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
          Flags | llvm::DINode::FlagArtificial, FieldAlign);

      // Insert an llvm.dbg.declare into the current block.
      DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
                             llvm::DILocation::get(CGM.getLLVMContext(), Line,
                                                   Column, Scope,
                                                   CurInlinedAt),
                             Builder.GetInsertBlock());
    }
  }
}

// Clang stores the sret pointer provided by the caller in a static alloca.
// Use DW_OP_deref to tell the debugger to load the pointer and treat it as
// the address of the variable.
if (UsePointerValue) {
  assert(std::find(Expr.begin(), Expr.end(), llvm::dwarf::DW_OP_deref) ==(static_cast<void> (0))
             Expr.end() &&(static_cast<void> (0))
         "Debug info already contains DW_OP_deref.")(static_cast<void> (0));
  Expr.push_back(llvm::dwarf::DW_OP_deref);
}

// Create the descriptor for the variable.
llvm::DILocalVariable *D = nullptr;
if (ArgNo) {
  llvm::DINodeArray Annotations = CollectBTFTagAnnotations(VD);
  D = DBuilder.createParameterVariable(Scope, Name, *ArgNo, Unit, Line, Ty,
                                       CGM.getLangOpts().Optimize, Flags,
                                       Annotations);
} else {
  // For normal local variable, we will try to find out whether 'VD' is the
  // copy parameter of coroutine.
  // If yes, we are going to use DIVariable of the origin parameter instead
  // of creating the new one.
  // If no, it might be a normal alloc, we just create a new one for it.

  // Check whether the VD is move parameters.
  auto RemapCoroArgToLocalVar = [&]() -> llvm::DILocalVariable * {
    // The scope of parameter and move-parameter should be distinct
    // DISubprogram.
    if (!isa<llvm::DISubprogram>(Scope) || !Scope->isDistinct())
      return nullptr;

    auto Iter = llvm::find_if(CoroutineParameterMappings, [&](auto &Pair) {
      Stmt *StmtPtr = const_cast<Stmt *>(Pair.second);
      if (DeclStmt *DeclStmtPtr = dyn_cast<DeclStmt>(StmtPtr)) {
        DeclGroupRef DeclGroup = DeclStmtPtr->getDeclGroup();
        Decl *Decl = DeclGroup.getSingleDecl();
        if (VD == dyn_cast_or_null<VarDecl>(Decl))
          return true;
      }
      return false;
    });

    if (Iter != CoroutineParameterMappings.end()) {
      ParmVarDecl *PD = const_cast<ParmVarDecl *>(Iter->first);
      auto Iter2 = llvm::find_if(ParamDbgMappings, [&](auto &DbgPair) {
        return DbgPair.first == PD && DbgPair.second->getScope() == Scope;
      });
      if (Iter2 != ParamDbgMappings.end())
        return const_cast<llvm::DILocalVariable *>(Iter2->second);
    }
    return nullptr;
  };

  // If we couldn't find a move param DIVariable, create a new one.
  D = RemapCoroArgToLocalVar();
  // Or we will create a new DIVariable for this Decl if D dose not exists.
  if (!D)
    D = DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
                                    CGM.getLangOpts().Optimize, Flags, Align);
}
// Insert an llvm.dbg.declare into the current block.
DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
                       llvm::DILocation::get(CGM.getLLVMContext(), Line,
                                             Column, Scope, CurInlinedAt),
                       Builder.GetInsertBlock());

return D;
4442}

4444llvm::DILocalVariable *
4445CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
                                     CGBuilderTy &Builder,
                                     const bool UsePointerValue) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
return EmitDeclare(VD, Storage, llvm::None, Builder, UsePointerValue);
4450}

4452void CGDebugInfo::EmitLabel(const LabelDecl *D, CGBuilderTy &Builder) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!")(static_cast<void> (0));

if (D->hasAttr<NoDebugAttr>())
  return;

auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
llvm::DIFile *Unit = getOrCreateFile(D->getLocation());

// Get location information.
unsigned Line = getLineNumber(D->getLocation());
unsigned Column = getColumnNumber(D->getLocation());

StringRef Name = D->getName();

// Create the descriptor for the label.
auto *L =
    DBuilder.createLabel(Scope, Name, Unit, Line, CGM.getLangOpts().Optimize);

// Insert an llvm.dbg.label into the current block.
DBuilder.insertLabel(L,
                     llvm::DILocation::get(CGM.getLLVMContext(), Line, Column,
                                           Scope, CurInlinedAt),
                     Builder.GetInsertBlock());
4477}

4479llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
                                        llvm::DIType *Ty) {
llvm::DIType *CachedTy = getTypeOrNull(QualTy);
if (CachedTy)
  Ty = CachedTy;
return DBuilder.createObjectPointerType(Ty);
4485}

4487void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
  const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
  const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!")(static_cast<void> (0));

if (Builder.GetInsertBlock() == nullptr)
  return;
if (VD->hasAttr<NoDebugAttr>())
  return;

bool isByRef = VD->hasAttr<BlocksAttr>();

uint64_t XOffset = 0;
llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
llvm::DIType *Ty;
if (isByRef)
  Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
else
  Ty = getOrCreateType(VD->getType(), Unit);

// Self is passed along as an implicit non-arg variable in a
// block. Mark it as the object pointer.
if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
  if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
    Ty = CreateSelfType(VD->getType(), Ty);

// Get location information.
const unsigned Line =
    getLineNumber(VD->getLocation().isValid() ? VD->getLocation() : CurLoc);
unsigned Column = getColumnNumber(VD->getLocation());

const llvm::DataLayout &target = CGM.getDataLayout();

CharUnits offset = CharUnits::fromQuantity(
    target.getStructLayout(blockInfo.StructureType)
        ->getElementOffset(blockInfo.getCapture(VD).getIndex()));

SmallVector<int64_t, 9> addr;
addr.push_back(llvm::dwarf::DW_OP_deref);
addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
addr.push_back(offset.getQuantity());
if (isByRef) {
  addr.push_back(llvm::dwarf::DW_OP_deref);
  addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
  // offset of __forwarding field
  offset =
      CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
  addr.push_back(offset.getQuantity());
  addr.push_back(llvm::dwarf::DW_OP_deref);
  addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
  // offset of x field
  offset = CGM.getContext().toCharUnitsFromBits(XOffset);
  addr.push_back(offset.getQuantity());
}

// Create the descriptor for the variable.
auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
auto *D = DBuilder.createAutoVariable(
    cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
    Line, Ty, false, llvm::DINode::FlagZero, Align);

// Insert an llvm.dbg.declare into the current block.
auto DL = llvm::DILocation::get(CGM.getLLVMContext(), Line, Column,
                                LexicalBlockStack.back(), CurInlinedAt);
auto *Expr = DBuilder.createExpression(addr);
if (InsertPoint)
  DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
else
  DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
4557}

4559llvm::DILocalVariable *
4560CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
                                    unsigned ArgNo, CGBuilderTy &Builder) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
return EmitDeclare(VD, AI, ArgNo, Builder);
4564}

4566namespace {
4567struct BlockLayoutChunk {
uint64_t OffsetInBits;
const BlockDecl::Capture *Capture;
4570};
4571bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
return l.OffsetInBits < r.OffsetInBits;
4573}
4574} // namespace

4576void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
  const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
  const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
  SmallVectorImpl<llvm::Metadata *> &Fields) {
// Blocks in OpenCL have unique constraints which make the standard fields
// redundant while requiring size and align fields for enqueue_kernel. See
// initializeForBlockHeader in CGBlocks.cpp
if (CGM.getLangOpts().OpenCL) {
  Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
                                   BlockLayout.getElementOffsetInBits(0),
                                   Unit, Unit));
  Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
                                   BlockLayout.getElementOffsetInBits(1),
                                   Unit, Unit));
} else {
  Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
                                   BlockLayout.getElementOffsetInBits(0),
                                   Unit, Unit));
  Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
                                   BlockLayout.getElementOffsetInBits(1),
                                   Unit, Unit));
  Fields.push_back(
      createFieldType("__reserved", Context.IntTy, Loc, AS_public,
                      BlockLayout.getElementOffsetInBits(2), Unit, Unit));
  auto *FnTy = Block.getBlockExpr()->getFunctionType();
  auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
  Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
                                   BlockLayout.getElementOffsetInBits(3),
                                   Unit, Unit));
  Fields.push_back(createFieldType(
      "__descriptor",
      Context.getPointerType(Block.NeedsCopyDispose
                                 ? Context.getBlockDescriptorExtendedType()
                                 : Context.getBlockDescriptorType()),
      Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
}
4612}

4614void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
                                                     StringRef Name,
                                                     unsigned ArgNo,
                                                     llvm::AllocaInst *Alloca,
                                                     CGBuilderTy &Builder) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
ASTContext &C = CGM.getContext();
const BlockDecl *blockDecl = block.getBlockDecl();

// Collect some general information about the block's location.
SourceLocation loc = blockDecl->getCaretLocation();
llvm::DIFile *tunit = getOrCreateFile(loc);
unsigned line = getLineNumber(loc);
unsigned column = getColumnNumber(loc);

// Build the debug-info type for the block literal.
getDeclContextDescriptor(blockDecl);

const llvm::StructLayout *blockLayout =
    CGM.getDataLayout().getStructLayout(block.StructureType);

SmallVector<llvm::Metadata *, 16> fields;
collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
                                           fields);

// We want to sort the captures by offset, not because DWARF
// requires this, but because we're paranoid about debuggers.
SmallVector<BlockLayoutChunk, 8> chunks;

// 'this' capture.
if (blockDecl->capturesCXXThis()) {
  BlockLayoutChunk chunk;
  chunk.OffsetInBits =
      blockLayout->getElementOffsetInBits(block.CXXThisIndex);
  chunk.Capture = nullptr;
  chunks.push_back(chunk);
}

// Variable captures.
for (const auto &capture : blockDecl->captures()) {
  const VarDecl *variable = capture.getVariable();
  const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);

  // Ignore constant captures.
  if (captureInfo.isConstant())
    continue;

  BlockLayoutChunk chunk;
  chunk.OffsetInBits =
      blockLayout->getElementOffsetInBits(captureInfo.getIndex());
  chunk.Capture = &capture;
  chunks.push_back(chunk);
}

// Sort by offset.
llvm::array_pod_sort(chunks.begin(), chunks.end());

for (const BlockLayoutChunk &Chunk : chunks) {
  uint64_t offsetInBits = Chunk.OffsetInBits;
  const BlockDecl::Capture *capture = Chunk.Capture;

  // If we have a null capture, this must be the C++ 'this' capture.
  if (!capture) {
    QualType type;
    if (auto *Method =
            cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
      type = Method->getThisType();
    else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
      type = QualType(RDecl->getTypeForDecl(), 0);
    else
      llvm_unreachable("unexpected block declcontext")__builtin_unreachable();

    fields.push_back(createFieldType("this", type, loc, AS_public,
                                     offsetInBits, tunit, tunit));
    continue;
  }

  const VarDecl *variable = capture->getVariable();
  StringRef name = variable->getName();

  llvm::DIType *fieldType;
  if (capture->isByRef()) {
    TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
    auto Align = PtrInfo.isAlignRequired() ? PtrInfo.Align : 0;
    // FIXME: This recomputes the layout of the BlockByRefWrapper.
    uint64_t xoffset;
    fieldType =
        EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
    fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
    fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
                                          PtrInfo.Width, Align, offsetInBits,
                                          llvm::DINode::FlagZero, fieldType);
  } else {
    auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
    fieldType = createFieldType(name, variable->getType(), loc, AS_public,
                                offsetInBits, Align, tunit, tunit);
  }
  fields.push_back(fieldType);
}

SmallString<36> typeName;
llvm::raw_svector_ostream(typeName)
    << "__block_literal_" << CGM.getUniqueBlockCount();

llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);

llvm::DIType *type =
    DBuilder.createStructType(tunit, typeName.str(), tunit, line,
                              CGM.getContext().toBits(block.BlockSize), 0,
                              llvm::DINode::FlagZero, nullptr, fieldsArray);
type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);

// Get overall information about the block.
llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());

// Create the descriptor for the parameter.
auto *debugVar = DBuilder.createParameterVariable(
    scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);

// Insert an llvm.dbg.declare into the current block.
DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
                       llvm::DILocation::get(CGM.getLLVMContext(), line,
                                             column, scope, CurInlinedAt),
                       Builder.GetInsertBlock());
4739}

4741llvm::DIDerivedType *
4742CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
if (!D || !D->isStaticDataMember())
  return nullptr;

auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
if (MI != StaticDataMemberCache.end()) {
  assert(MI->second && "Static data member declaration should still exist")(static_cast<void> (0));
  return MI->second;
}

// If the member wasn't found in the cache, lazily construct and add it to the
// type (used when a limited form of the type is emitted).
auto DC = D->getDeclContext();
auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
4757}

4759llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
  const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
  StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
llvm::DIGlobalVariableExpression *GVE = nullptr;

for (const auto *Field : RD->fields()) {
  llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
  StringRef FieldName = Field->getName();

  // Ignore unnamed fields, but recurse into anonymous records.
  if (FieldName.empty()) {
    if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
      GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
                                   Var, DContext);
    continue;
  }
  // Use VarDecl's Tag, Scope and Line number.
  GVE = DBuilder.createGlobalVariableExpression(
      DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
      Var->hasLocalLinkage());
  Var->addDebugInfo(GVE);
}
return GVE;
4782}

4784std::string CGDebugInfo::GetName(const Decl *D, bool Qualified) const {
std::string Name;
llvm::raw_string_ostream OS(Name);
if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) {
  PrintingPolicy PP = getPrintingPolicy();
  PP.PrintCanonicalTypes = true;
  PP.SuppressInlineNamespace = false;
  ND->getNameForDiagnostic(OS, PP, Qualified);
}
return Name;
4794}

4796void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
                                   const VarDecl *D) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
if (D->hasAttr<NoDebugAttr>())
  return;

llvm::TimeTraceScope TimeScope("DebugGlobalVariable", [&]() {
  return GetName(D, true);
});

// If we already created a DIGlobalVariable for this declaration, just attach
// it to the llvm::GlobalVariable.
auto Cached = DeclCache.find(D->getCanonicalDecl());
if (Cached != DeclCache.end())
  return Var->addDebugInfo(
      cast<llvm::DIGlobalVariableExpression>(Cached->second));

// Create global variable debug descriptor.
llvm::DIFile *Unit = nullptr;
llvm::DIScope *DContext = nullptr;
unsigned LineNo;
StringRef DeclName, LinkageName;
QualType T;
llvm::MDTuple *TemplateParameters = nullptr;
collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
                    TemplateParameters, DContext);

// Attempt to store one global variable for the declaration - even if we
// emit a lot of fields.
llvm::DIGlobalVariableExpression *GVE = nullptr;

// If this is an anonymous union then we'll want to emit a global
// variable for each member of the anonymous union so that it's possible
// to find the name of any field in the union.
if (T->isUnionType() && DeclName.empty()) {
  const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
  assert(RD->isAnonymousStructOrUnion() &&(static_cast<void> (0))
         "unnamed non-anonymous struct or union?")(static_cast<void> (0));
  GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
} else {
  auto Align = getDeclAlignIfRequired(D, CGM.getContext());

  SmallVector<int64_t, 4> Expr;
  unsigned AddressSpace =
      CGM.getContext().getTargetAddressSpace(D->getType());
  if (CGM.getLangOpts().CUDA && CGM.getLangOpts().CUDAIsDevice) {
    if (D->hasAttr<CUDASharedAttr>())
      AddressSpace =
          CGM.getContext().getTargetAddressSpace(LangAS::cuda_shared);
    else if (D->hasAttr<CUDAConstantAttr>())
      AddressSpace =
          CGM.getContext().getTargetAddressSpace(LangAS::cuda_constant);
  }
  AppendAddressSpaceXDeref(AddressSpace, Expr);

  llvm::DINodeArray Annotations = CollectBTFTagAnnotations(D);
  GVE = DBuilder.createGlobalVariableExpression(
      DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
      Var->hasLocalLinkage(), true,
      Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
      getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
      Align, Annotations);
  Var->addDebugInfo(GVE);
}
DeclCache[D->getCanonicalDecl()].reset(GVE);
4861}

4863void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
if (VD->hasAttr<NoDebugAttr>())
  return;
llvm::TimeTraceScope TimeScope("DebugConstGlobalVariable", [&]() {
  return GetName(VD, true);
});

auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
// Create the descriptor for the variable.
llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
StringRef Name = VD->getName();
llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);

if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
  const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
  assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?")(static_cast<void> (0));

  if (CGM.getCodeGenOpts().EmitCodeView) {
    // If CodeView, emit enums as global variables, unless they are defined
    // inside a class. We do this because MSVC doesn't emit S_CONSTANTs for
    // enums in classes, and because it is difficult to attach this scope
    // information to the global variable.
    if (isa<RecordDecl>(ED->getDeclContext()))
      return;
  } else {
    // If not CodeView, emit DW_TAG_enumeration_type if necessary. For
    // example: for "enum { ZERO };", a DW_TAG_enumeration_type is created the
    // first time `ZERO` is referenced in a function.
    llvm::DIType *EDTy =
        getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
    assert (EDTy->getTag() == llvm::dwarf::DW_TAG_enumeration_type)(static_cast<void> (0));
    (void)EDTy;
    return;
  }
}

// Do not emit separate definitions for function local consts.
if (isa<FunctionDecl>(VD->getDeclContext()))
  return;

VD = cast<ValueDecl>(VD->getCanonicalDecl());
auto *VarD = dyn_cast<VarDecl>(VD);
if (VarD && VarD->isStaticDataMember()) {
  auto *RD = cast<RecordDecl>(VarD->getDeclContext());
  getDeclContextDescriptor(VarD);
  // Ensure that the type is retained even though it's otherwise unreferenced.
  //
  // FIXME: This is probably unnecessary, since Ty should reference RD
  // through its scope.
  RetainedTypes.push_back(
      CGM.getContext().getRecordType(RD).getAsOpaquePtr());

  return;
}
llvm::DIScope *DContext = getDeclContextDescriptor(VD);

auto &GV = DeclCache[VD];
if (GV)
  return;
llvm::DIExpression *InitExpr = nullptr;
if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
  // FIXME: Add a representation for integer constants wider than 64 bits.
  if (Init.isInt())
    InitExpr =
        DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
  else if (Init.isFloat())
    InitExpr = DBuilder.createConstantValueExpression(
        Init.getFloat().bitcastToAPInt().getZExtValue());
}

llvm::MDTuple *TemplateParameters = nullptr;

if (isa<VarTemplateSpecializationDecl>(VD))
  if (VarD) {
    llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
    TemplateParameters = parameterNodes.get();
  }

GV.reset(DBuilder.createGlobalVariableExpression(
    DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
    true, true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
    TemplateParameters, Align));
4946}

4948void CGDebugInfo::EmitExternalVariable(llvm::GlobalVariable *Var,
                                     const VarDecl *D) {
assert(CGM.getCodeGenOpts().hasReducedDebugInfo())(static_cast<void> (0));
if (D->hasAttr<NoDebugAttr>())
  return;

auto Align = getDeclAlignIfRequired(D, CGM.getContext());
llvm::DIFile *Unit = getOrCreateFile(D->getLocation());
StringRef Name = D->getName();
llvm::DIType *Ty = getOrCreateType(D->getType(), Unit);

llvm::DIScope *DContext = getDeclContextDescriptor(D);
llvm::DIGlobalVariableExpression *GVE =
    DBuilder.createGlobalVariableExpression(
        DContext, Name, StringRef(), Unit, getLineNumber(D->getLocation()),
        Ty, false, false, nullptr, nullptr, nullptr, Align);
Var->addDebugInfo(GVE);
4965}

4967llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
if (!LexicalBlockStack.empty())
  return LexicalBlockStack.back();
llvm::DIScope *Mod = getParentModuleOrNull(D);
return getContextDescriptor(D, Mod ? Mod : TheCU);
4972}

4974void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
if (!CGM.getCodeGenOpts().hasReducedDebugInfo())
  return;
const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
if (!NSDecl->isAnonymousNamespace() ||
    CGM.getCodeGenOpts().DebugExplicitImport) {
  auto Loc = UD.getLocation();
  if (!Loc.isValid())
    Loc = CurLoc;
  DBuilder.createImportedModule(
      getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
      getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
}
4987}

4989void CGDebugInfo::EmitUsingShadowDecl(const UsingShadowDecl &USD) {
if (llvm::DINode *Target =
        getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
  auto Loc = USD.getLocation();
  DBuilder.createImportedDeclaration(
      getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
      getOrCreateFile(Loc), getLineNumber(Loc));
}
4997}

4999void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
if (!CGM.getCodeGenOpts().hasReducedDebugInfo())
  return;
assert(UD.shadow_size() &&(static_cast<void> (0))
       "We shouldn't be codegening an invalid UsingDecl containing no decls")(static_cast<void> (0));

for (const auto *USD : UD.shadows()) {
  // FIXME: Skip functions with undeduced auto return type for now since we
  // don't currently have the plumbing for separate declarations & definitions
  // of free functions and mismatched types (auto in the declaration, concrete
  // return type in the definition)
  if (const auto *FD = dyn_cast<FunctionDecl>(USD->getUnderlyingDecl()))
    if (const auto *AT = FD->getType()
                             ->castAs<FunctionProtoType>()
                             ->getContainedAutoType())
      if (AT->getDeducedType().isNull())
        continue;

  EmitUsingShadowDecl(*USD);
  // Emitting one decl is sufficient - debuggers can detect that this is an
  // overloaded name & provide lookup for all the overloads.
  break;
}
5022}

5024void CGDebugInfo::EmitUsingEnumDecl(const UsingEnumDecl &UD) {
if (!CGM.getCodeGenOpts().hasReducedDebugInfo())
  return;
assert(UD.shadow_size() &&(static_cast<void> (0))
       "We shouldn't be codegening an invalid UsingEnumDecl"(static_cast<void> (0))
       " containing no decls")(static_cast<void> (0));

for (const auto *USD : UD.shadows())
  EmitUsingShadowDecl(*USD);
5033}

5035void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
  return;
if (Module *M = ID.getImportedModule()) {
  auto Info = ASTSourceDescriptor(*M);
  auto Loc = ID.getLocation();
  DBuilder.createImportedDeclaration(
      getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
      getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
      getLineNumber(Loc));
}
5046}

5048llvm::DIImportedEntity *
5049CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
if (!CGM.getCodeGenOpts().hasReducedDebugInfo())
  return nullptr;
auto &VH = NamespaceAliasCache[&NA];
if (VH)
  return cast<llvm::DIImportedEntity>(VH);
llvm::DIImportedEntity *R;
auto Loc = NA.getLocation();
if (const auto *Underlying =
        dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
  // This could cache & dedup here rather than relying on metadata deduping.
  R = DBuilder.createImportedDeclaration(
      getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
      EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
      getLineNumber(Loc), NA.getName());
else
  R = DBuilder.createImportedDeclaration(
      getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
      getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
      getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
VH.reset(R);
return R;
5071}

5073llvm::DINamespace *
5074CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
// Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
// if necessary, and this way multiple declarations of the same namespace in
// different parent modules stay distinct.
auto I = NamespaceCache.find(NSDecl);
if (I != NamespaceCache.end())
  return cast<llvm::DINamespace>(I->second);

llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
// Don't trust the context if it is a DIModule (see comment above).
llvm::DINamespace *NS =
    DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
NamespaceCache[NSDecl].reset(NS);
return NS;
5088}

5090void CGDebugInfo::setDwoId(uint64_t Signature) {
assert(TheCU && "no main compile unit")(static_cast<void> (0));
TheCU->setDWOId(Signature);
5093}

5095void CGDebugInfo::finalize() {
// Creating types might create further types - invalidating the current
// element and the size(), so don't cache/reference them.
for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
  ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
  llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
                         ? CreateTypeDefinition(E.Type, E.Unit)
                         : E.Decl;
  DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
}

// Add methods to interface.
for (const auto &P : ObjCMethodCache) {
  if (P.second.empty())
    continue;

  QualType QTy(P.first->getTypeForDecl(), 0);
  auto It = TypeCache.find(QTy.getAsOpaquePtr());
  assert(It != TypeCache.end())(static_cast<void> (0));

  llvm::DICompositeType *InterfaceDecl =
      cast<llvm::DICompositeType>(It->second);

  auto CurElts = InterfaceDecl->getElements();
  SmallVector<llvm::Metadata *, 16> EltTys(CurElts.begin(), CurElts.end());

  // For DWARF v4 or earlier, only add objc_direct methods.
  for (auto &SubprogramDirect : P.second)
    if (CGM.getCodeGenOpts().DwarfVersion >= 5 || SubprogramDirect.getInt())
      EltTys.push_back(SubprogramDirect.getPointer());

  llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
  DBuilder.replaceArrays(InterfaceDecl, Elements);
}

for (const auto &P : ReplaceMap) {
  assert(P.second)(static_cast<void> (0));
  auto *Ty = cast<llvm::DIType>(P.second);
  assert(Ty->isForwardDecl())(static_cast<void> (0));

  auto It = TypeCache.find(P.first);
  assert(It != TypeCache.end())(static_cast<void> (0));
  assert(It->second)(static_cast<void> (0));

  DBuilder.replaceTemporary(llvm::TempDIType(Ty),
                            cast<llvm::DIType>(It->second));
}

for (const auto &P : FwdDeclReplaceMap) {
  assert(P.second)(static_cast<void> (0));
  llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
  llvm::Metadata *Repl;

  auto It = DeclCache.find(P.first);
  // If there has been no definition for the declaration, call RAUW
  // with ourselves, that will destroy the temporary MDNode and
  // replace it with a standard one, avoiding leaking memory.
  if (It == DeclCache.end())
    Repl = P.second;
  else
    Repl = It->second;

  if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
    Repl = GVE->getVariable();
  DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
}

// We keep our own list of retained types, because we need to look
// up the final type in the type cache.
for (auto &RT : RetainedTypes)
  if (auto MD = TypeCache[RT])
    DBuilder.retainType(cast<llvm::DIType>(MD));

DBuilder.finalize();
5169}

5171// Don't ignore in case of explicit cast where it is referenced indirectly.
5172void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
if (CGM.getCodeGenOpts().hasReducedDebugInfo())
  if (auto *DieTy = getOrCreateType(Ty, TheCU->getFile()))
    DBuilder.retainType(DieTy);
5176}

5178void CGDebugInfo::EmitAndRetainType(QualType Ty) {
if (CGM.getCodeGenOpts().hasMaybeUnusedDebugInfo())
1
Taking true branch→
  if (auto *DieTy = getOrCreateType(Ty, TheCU->getFile()))
2
←
Calling 'CGDebugInfo::getOrCreateType'→
    DBuilder.retainType(DieTy);
5182}

5184llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
if (LexicalBlockStack.empty())
  return llvm::DebugLoc();

llvm::MDNode *Scope = LexicalBlockStack.back();
return llvm::DILocation::get(CGM.getLLVMContext(), getLineNumber(Loc),
                             getColumnNumber(Loc), Scope);
5191}

5193llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
// Call site-related attributes are only useful in optimized programs, and
// when there's a possibility of debugging backtraces.
if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
    DebugKind == codegenoptions::LocTrackingOnly)
  return llvm::DINode::FlagZero;

// Call site-related attributes are available in DWARF v5. Some debuggers,
// while not fully DWARF v5-compliant, may accept these attributes as if they
// were part of DWARF v4.
bool SupportsDWARFv4Ext =
    CGM.getCodeGenOpts().DwarfVersion == 4 &&
    (CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB ||
     CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::GDB);

if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
  return llvm::DINode::FlagZero;

return llvm::DINode::FlagAllCallsDescribed;
5212}

←

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include/clang/AST/Type.h

1//===- Type.h - C Language Family Type Representation -----------*- 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/// \file
10/// C Language Family Type Representation
11///
12/// This file defines the clang::Type interface and subclasses, used to
13/// represent types for languages in the C family.
14//
15//===----------------------------------------------------------------------===//

17#ifndef LLVM_CLANG_AST_TYPE_H
18#define LLVM_CLANG_AST_TYPE_H

20#include "clang/AST/DependenceFlags.h"
21#include "clang/AST/NestedNameSpecifier.h"
22#include "clang/AST/TemplateName.h"
23#include "clang/Basic/AddressSpaces.h"
24#include "clang/Basic/AttrKinds.h"
25#include "clang/Basic/Diagnostic.h"
26#include "clang/Basic/ExceptionSpecificationType.h"
27#include "clang/Basic/LLVM.h"
28#include "clang/Basic/Linkage.h"
29#include "clang/Basic/PartialDiagnostic.h"
30#include "clang/Basic/SourceLocation.h"
31#include "clang/Basic/Specifiers.h"
32#include "clang/Basic/Visibility.h"
33#include "llvm/ADT/APInt.h"
34#include "llvm/ADT/APSInt.h"
35#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/FoldingSet.h"
37#include "llvm/ADT/None.h"
38#include "llvm/ADT/Optional.h"
39#include "llvm/ADT/PointerIntPair.h"
40#include "llvm/ADT/PointerUnion.h"
41#include "llvm/ADT/StringRef.h"
42#include "llvm/ADT/Twine.h"
43#include "llvm/ADT/iterator_range.h"
44#include "llvm/Support/Casting.h"
45#include "llvm/Support/Compiler.h"
46#include "llvm/Support/ErrorHandling.h"
47#include "llvm/Support/PointerLikeTypeTraits.h"
48#include "llvm/Support/TrailingObjects.h"
49#include "llvm/Support/type_traits.h"
50#include <cassert>
51#include <cstddef>
52#include <cstdint>
53#include <cstring>
54#include <string>
55#include <type_traits>
56#include <utility>

58namespace clang {

60class ExtQuals;
61class QualType;
62class ConceptDecl;
63class TagDecl;
64class TemplateParameterList;
65class Type;

67enum {
TypeAlignmentInBits = 4,
TypeAlignment = 1 << TypeAlignmentInBits
70};

72namespace serialization {
template <class T> class AbstractTypeReader;
template <class T> class AbstractTypeWriter;
75}

77} // namespace clang

79namespace llvm {

template <typename T>
struct PointerLikeTypeTraits;
template<>
struct PointerLikeTypeTraits< ::clang::Type*> {
  static inline void *getAsVoidPointer(::clang::Type *P) { return P; }

  static inline ::clang::Type *getFromVoidPointer(void *P) {
    return static_cast< ::clang::Type*>(P);
  }

  static constexpr int NumLowBitsAvailable = clang::TypeAlignmentInBits;
};

template<>
struct PointerLikeTypeTraits< ::clang::ExtQuals*> {
  static inline void *getAsVoidPointer(::clang::ExtQuals *P) { return P; }

  static inline ::clang::ExtQuals *getFromVoidPointer(void *P) {
    return static_cast< ::clang::ExtQuals*>(P);
  }

  static constexpr int NumLowBitsAvailable = clang::TypeAlignmentInBits;
};

105} // namespace llvm

107namespace clang {

109class ASTContext;
110template <typename> class CanQual;
111class CXXRecordDecl;
112class DeclContext;
113class EnumDecl;
114class Expr;
115class ExtQualsTypeCommonBase;
116class FunctionDecl;
117class IdentifierInfo;
118class NamedDecl;
119class ObjCInterfaceDecl;
120class ObjCProtocolDecl;
121class ObjCTypeParamDecl;
122struct PrintingPolicy;
123class RecordDecl;
124class Stmt;
125class TagDecl;
126class TemplateArgument;
127class TemplateArgumentListInfo;
128class TemplateArgumentLoc;
129class TemplateTypeParmDecl;
130class TypedefNameDecl;
131class UnresolvedUsingTypenameDecl;

133using CanQualType = CanQual<Type>;

135// Provide forward declarations for all of the *Type classes.
136#define TYPE(Class, Base) class Class##Type;
137#include "clang/AST/TypeNodes.inc"

139/// The collection of all-type qualifiers we support.
140/// Clang supports five independent qualifiers:
141/// * C99: const, volatile, and restrict
142/// * MS: __unaligned
143/// * Embedded C (TR18037): address spaces
144/// * Objective C: the GC attributes (none, weak, or strong)
145class Qualifiers {
146public:
enum TQ { // NOTE: These flags must be kept in sync with DeclSpec::TQ.
  Const    = 0x1,
  Restrict = 0x2,
  Volatile = 0x4,
  CVRMask = Const | Volatile | Restrict
};

enum GC {
  GCNone = 0,
  Weak,
  Strong
};

enum ObjCLifetime {
  /// There is no lifetime qualification on this type.
  OCL_None,

  /// This object can be modified without requiring retains or
  /// releases.
  OCL_ExplicitNone,

  /// Assigning into this object requires the old value to be
  /// released and the new value to be retained.  The timing of the
  /// release of the old value is inexact: it may be moved to
  /// immediately after the last known point where the value is
  /// live.
  OCL_Strong,

  /// Reading or writing from this object requires a barrier call.
  OCL_Weak,

  /// Assigning into this object requires a lifetime extension.
  OCL_Autoreleasing
};

enum {
  /// The maximum supported address space number.
  /// 23 bits should be enough for anyone.
  MaxAddressSpace = 0x7fffffu,

  /// The width of the "fast" qualifier mask.
  FastWidth = 3,

  /// The fast qualifier mask.
  FastMask = (1 << FastWidth) - 1
};

/// Returns the common set of qualifiers while removing them from
/// the given sets.
static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R) {
  // If both are only CVR-qualified, bit operations are sufficient.
  if (!(L.Mask & ~CVRMask) && !(R.Mask & ~CVRMask)) {
    Qualifiers Q;
    Q.Mask = L.Mask & R.Mask;
    L.Mask &= ~Q.Mask;
    R.Mask &= ~Q.Mask;
    return Q;
  }

  Qualifiers Q;
  unsigned CommonCRV = L.getCVRQualifiers() & R.getCVRQualifiers();
  Q.addCVRQualifiers(CommonCRV);
  L.removeCVRQualifiers(CommonCRV);
  R.removeCVRQualifiers(CommonCRV);

  if (L.getObjCGCAttr() == R.getObjCGCAttr()) {
    Q.setObjCGCAttr(L.getObjCGCAttr());
    L.removeObjCGCAttr();
    R.removeObjCGCAttr();
  }

  if (L.getObjCLifetime() == R.getObjCLifetime()) {
    Q.setObjCLifetime(L.getObjCLifetime());
    L.removeObjCLifetime();
    R.removeObjCLifetime();
  }

  if (L.getAddressSpace() == R.getAddressSpace()) {
    Q.setAddressSpace(L.getAddressSpace());
    L.removeAddressSpace();
    R.removeAddressSpace();
  }
  return Q;
}

static Qualifiers fromFastMask(unsigned Mask) {
  Qualifiers Qs;
  Qs.addFastQualifiers(Mask);
  return Qs;
}

static Qualifiers fromCVRMask(unsigned CVR) {
  Qualifiers Qs;
  Qs.addCVRQualifiers(CVR);
  return Qs;
}

static Qualifiers fromCVRUMask(unsigned CVRU) {
  Qualifiers Qs;
  Qs.addCVRUQualifiers(CVRU);
  return Qs;
}

// Deserialize qualifiers from an opaque representation.
static Qualifiers fromOpaqueValue(unsigned opaque) {
  Qualifiers Qs;
  Qs.Mask = opaque;
  return Qs;
}

// Serialize these qualifiers into an opaque representation.
unsigned getAsOpaqueValue() const {
  return Mask;
}

bool hasConst() const { return Mask & Const; }
bool hasOnlyConst() const { return Mask == Const; }
void removeConst() { Mask &= ~Const; }
void addConst() { Mask |= Const; }

bool hasVolatile() const { return Mask & Volatile; }
bool hasOnlyVolatile() const { return Mask == Volatile; }
void removeVolatile() { Mask &= ~Volatile; }
void addVolatile() { Mask |= Volatile; }

bool hasRestrict() const { return Mask & Restrict; }
bool hasOnlyRestrict() const { return Mask == Restrict; }
void removeRestrict() { Mask &= ~Restrict; }
void addRestrict() { Mask |= Restrict; }

bool hasCVRQualifiers() const { return getCVRQualifiers(); }
unsigned getCVRQualifiers() const { return Mask & CVRMask; }
unsigned getCVRUQualifiers() const { return Mask & (CVRMask | UMask); }

void setCVRQualifiers(unsigned mask) {
  assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")(static_cast<void> (0));
  Mask = (Mask & ~CVRMask) | mask;
}
void removeCVRQualifiers(unsigned mask) {
  assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")(static_cast<void> (0));
  Mask &= ~mask;
}
void removeCVRQualifiers() {
  removeCVRQualifiers(CVRMask);
}
void addCVRQualifiers(unsigned mask) {
  assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")(static_cast<void> (0));
  Mask |= mask;
}
void addCVRUQualifiers(unsigned mask) {
  assert(!(mask & ~CVRMask & ~UMask) && "bitmask contains non-CVRU bits")(static_cast<void> (0));
  Mask |= mask;
}

bool hasUnaligned() const { return Mask & UMask; }
void setUnaligned(bool flag) {
  Mask = (Mask & ~UMask) | (flag ? UMask : 0);
}
void removeUnaligned() { Mask &= ~UMask; }
void addUnaligned() { Mask |= UMask; }

bool hasObjCGCAttr() const { return Mask & GCAttrMask; }
GC getObjCGCAttr() const { return GC((Mask & GCAttrMask) >> GCAttrShift); }
void setObjCGCAttr(GC type) {
  Mask = (Mask & ~GCAttrMask) | (type << GCAttrShift);
}
void removeObjCGCAttr() { setObjCGCAttr(GCNone); }
void addObjCGCAttr(GC type) {
  assert(type)(static_cast<void> (0));
  setObjCGCAttr(type);
}
Qualifiers withoutObjCGCAttr() const {
  Qualifiers qs = *this;
  qs.removeObjCGCAttr();
  return qs;
}
Qualifiers withoutObjCLifetime() const {
  Qualifiers qs = *this;
  qs.removeObjCLifetime();
  return qs;
}
Qualifiers withoutAddressSpace() const {
  Qualifiers qs = *this;
  qs.removeAddressSpace();
  return qs;
}

bool hasObjCLifetime() const { return Mask & LifetimeMask; }
ObjCLifetime getObjCLifetime() const {
  return ObjCLifetime((Mask & LifetimeMask) >> LifetimeShift);
}
void setObjCLifetime(ObjCLifetime type) {
  Mask = (Mask & ~LifetimeMask) | (type << LifetimeShift);
}
void removeObjCLifetime() { setObjCLifetime(OCL_None); }
void addObjCLifetime(ObjCLifetime type) {
  assert(type)(static_cast<void> (0));
  assert(!hasObjCLifetime())(static_cast<void> (0));
  Mask |= (type << LifetimeShift);
}

/// True if the lifetime is neither None or ExplicitNone.
bool hasNonTrivialObjCLifetime() const {
  ObjCLifetime lifetime = getObjCLifetime();
  return (lifetime > OCL_ExplicitNone);
}

/// True if the lifetime is either strong or weak.
bool hasStrongOrWeakObjCLifetime() const {
  ObjCLifetime lifetime = getObjCLifetime();
  return (lifetime == OCL_Strong || lifetime == OCL_Weak);
}

bool hasAddressSpace() const { return Mask & AddressSpaceMask; }
LangAS getAddressSpace() const {
  return static_cast<LangAS>(Mask >> AddressSpaceShift);
}
bool hasTargetSpecificAddressSpace() const {
  return isTargetAddressSpace(getAddressSpace());
}
/// Get the address space attribute value to be printed by diagnostics.
unsigned getAddressSpaceAttributePrintValue() const {
  auto Addr = getAddressSpace();
  // This function is not supposed to be used with language specific
  // address spaces. If that happens, the diagnostic message should consider
  // printing the QualType instead of the address space value.
  assert(Addr == LangAS::Default || hasTargetSpecificAddressSpace())(static_cast<void> (0));
  if (Addr != LangAS::Default)
    return toTargetAddressSpace(Addr);
  // TODO: The diagnostic messages where Addr may be 0 should be fixed
  // since it cannot differentiate the situation where 0 denotes the default
  // address space or user specified __attribute__((address_space(0))).
  return 0;
}
void setAddressSpace(LangAS space) {
  assert((unsigned)space <= MaxAddressSpace)(static_cast<void> (0));
  Mask = (Mask & ~AddressSpaceMask)
       | (((uint32_t) space) << AddressSpaceShift);
}
void removeAddressSpace() { setAddressSpace(LangAS::Default); }
void addAddressSpace(LangAS space) {
  assert(space != LangAS::Default)(static_cast<void> (0));
  setAddressSpace(space);
}

// Fast qualifiers are those that can be allocated directly
// on a QualType object.
bool hasFastQualifiers() const { return getFastQualifiers(); }
unsigned getFastQualifiers() const { return Mask & FastMask; }
void setFastQualifiers(unsigned mask) {
  assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")(static_cast<void> (0));
  Mask = (Mask & ~FastMask) | mask;
}
void removeFastQualifiers(unsigned mask) {
  assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")(static_cast<void> (0));
  Mask &= ~mask;
}
void removeFastQualifiers() {
  removeFastQualifiers(FastMask);
}
void addFastQualifiers(unsigned mask) {
  assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")(static_cast<void> (0));
  Mask |= mask;
}

/// Return true if the set contains any qualifiers which require an ExtQuals
/// node to be allocated.
bool hasNonFastQualifiers() const { return Mask & ~FastMask; }
Qualifiers getNonFastQualifiers() const {
  Qualifiers Quals = *this;
  Quals.setFastQualifiers(0);
  return Quals;
}

/// Return true if the set contains any qualifiers.
bool hasQualifiers() const { return Mask; }
bool empty() const { return !Mask; }

/// Add the qualifiers from the given set to this set.
void addQualifiers(Qualifiers Q) {
  // If the other set doesn't have any non-boolean qualifiers, just
  // bit-or it in.
  if (!(Q.Mask & ~CVRMask))
    Mask |= Q.Mask;
  else {
    Mask |= (Q.Mask & CVRMask);
    if (Q.hasAddressSpace())
      addAddressSpace(Q.getAddressSpace());
    if (Q.hasObjCGCAttr())
      addObjCGCAttr(Q.getObjCGCAttr());
    if (Q.hasObjCLifetime())
      addObjCLifetime(Q.getObjCLifetime());
  }
}

/// Remove the qualifiers from the given set from this set.
void removeQualifiers(Qualifiers Q) {
  // If the other set doesn't have any non-boolean qualifiers, just
  // bit-and the inverse in.
  if (!(Q.Mask & ~CVRMask))
    Mask &= ~Q.Mask;
  else {
    Mask &= ~(Q.Mask & CVRMask);
    if (getObjCGCAttr() == Q.getObjCGCAttr())
      removeObjCGCAttr();
    if (getObjCLifetime() == Q.getObjCLifetime())
      removeObjCLifetime();
    if (getAddressSpace() == Q.getAddressSpace())
      removeAddressSpace();
  }
}

/// Add the qualifiers from the given set to this set, given that
/// they don't conflict.
void addConsistentQualifiers(Qualifiers qs) {
  assert(getAddressSpace() == qs.getAddressSpace() ||(static_cast<void> (0))
         !hasAddressSpace() || !qs.hasAddressSpace())(static_cast<void> (0));
  assert(getObjCGCAttr() == qs.getObjCGCAttr() ||(static_cast<void> (0))
         !hasObjCGCAttr() || !qs.hasObjCGCAttr())(static_cast<void> (0));
  assert(getObjCLifetime() == qs.getObjCLifetime() ||(static_cast<void> (0))
         !hasObjCLifetime() || !qs.hasObjCLifetime())(static_cast<void> (0));
  Mask |= qs.Mask;
}

/// Returns true if address space A is equal to or a superset of B.
/// OpenCL v2.0 defines conversion rules (OpenCLC v2.0 s6.5.5) and notion of
/// overlapping address spaces.
/// CL1.1 or CL1.2:
///   every address space is a superset of itself.
/// CL2.0 adds:
///   __generic is a superset of any address space except for __constant.
static bool isAddressSpaceSupersetOf(LangAS A, LangAS B) {
  // Address spaces must match exactly.
  return A == B ||
         // Otherwise in OpenCLC v2.0 s6.5.5: every address space except
         // for __constant can be used as __generic.
         (A == LangAS::opencl_generic && B != LangAS::opencl_constant) ||
         // We also define global_device and global_host address spaces,
         // to distinguish global pointers allocated on host from pointers
         // allocated on device, which are a subset of __global.
         (A == LangAS::opencl_global && (B == LangAS::opencl_global_device ||
                                         B == LangAS::opencl_global_host)) ||
         (A == LangAS::sycl_global && (B == LangAS::sycl_global_device ||
                                       B == LangAS::sycl_global_host)) ||
         // Consider pointer size address spaces to be equivalent to default.
         ((isPtrSizeAddressSpace(A) || A == LangAS::Default) &&
          (isPtrSizeAddressSpace(B) || B == LangAS::Default)) ||
         // Default is a superset of SYCL address spaces.
         (A == LangAS::Default &&
          (B == LangAS::sycl_private || B == LangAS::sycl_local ||
           B == LangAS::sycl_global || B == LangAS::sycl_global_device ||
           B == LangAS::sycl_global_host)) ||
         // In HIP device compilation, any cuda address space is allowed
         // to implicitly cast into the default address space.
         (A == LangAS::Default &&
          (B == LangAS::cuda_constant || B == LangAS::cuda_device ||
           B == LangAS::cuda_shared));
}

/// Returns true if the address space in these qualifiers is equal to or
/// a superset of the address space in the argument qualifiers.
bool isAddressSpaceSupersetOf(Qualifiers other) const {
  return isAddressSpaceSupersetOf(getAddressSpace(), other.getAddressSpace());
}

/// Determines if these qualifiers compatibly include another set.
/// Generally this answers the question of whether an object with the other
/// qualifiers can be safely used as an object with these qualifiers.
bool compatiblyIncludes(Qualifiers other) const {
  return isAddressSpaceSupersetOf(other) &&
         // ObjC GC qualifiers can match, be added, or be removed, but can't
         // be changed.
         (getObjCGCAttr() == other.getObjCGCAttr() || !hasObjCGCAttr() ||
          !other.hasObjCGCAttr()) &&
         // ObjC lifetime qualifiers must match exactly.
         getObjCLifetime() == other.getObjCLifetime() &&
         // CVR qualifiers may subset.
         (((Mask & CVRMask) | (other.Mask & CVRMask)) == (Mask & CVRMask)) &&
         // U qualifier may superset.
         (!other.hasUnaligned() || hasUnaligned());
}

/// Determines if these qualifiers compatibly include another set of
/// qualifiers from the narrow perspective of Objective-C ARC lifetime.
///
/// One set of Objective-C lifetime qualifiers compatibly includes the other
/// if the lifetime qualifiers match, or if both are non-__weak and the
/// including set also contains the 'const' qualifier, or both are non-__weak
/// and one is None (which can only happen in non-ARC modes).
bool compatiblyIncludesObjCLifetime(Qualifiers other) const {
  if (getObjCLifetime() == other.getObjCLifetime())
    return true;

  if (getObjCLifetime() == OCL_Weak || other.getObjCLifetime() == OCL_Weak)
    return false;

  if (getObjCLifetime() == OCL_None || other.getObjCLifetime() == OCL_None)
    return true;

  return hasConst();
}

/// Determine whether this set of qualifiers is a strict superset of
/// another set of qualifiers, not considering qualifier compatibility.
bool isStrictSupersetOf(Qualifiers Other) const;

bool operator==(Qualifiers Other) const { return Mask == Other.Mask; }
bool operator!=(Qualifiers Other) const { return Mask != Other.Mask; }

explicit operator bool() const { return hasQualifiers(); }

Qualifiers &operator+=(Qualifiers R) {
  addQualifiers(R);
  return *this;
}

// Union two qualifier sets.  If an enumerated qualifier appears
// in both sets, use the one from the right.
friend Qualifiers operator+(Qualifiers L, Qualifiers R) {
  L += R;
  return L;
}

Qualifiers &operator-=(Qualifiers R) {
  removeQualifiers(R);
  return *this;
}

/// Compute the difference between two qualifier sets.
friend Qualifiers operator-(Qualifiers L, Qualifiers R) {
  L -= R;
  return L;
}

std::string getAsString() const;
std::string getAsString(const PrintingPolicy &Policy) const;

static std::string getAddrSpaceAsString(LangAS AS);

bool isEmptyWhenPrinted(const PrintingPolicy &Policy) const;
void print(raw_ostream &OS, const PrintingPolicy &Policy,
           bool appendSpaceIfNonEmpty = false) const;

void Profile(llvm::FoldingSetNodeID &ID) const {
  ID.AddInteger(Mask);
}

594private:
// bits:     |0 1 2|3|4 .. 5|6  ..  8|9   ...   31|
//           |C R V|U|GCAttr|Lifetime|AddressSpace|
uint32_t Mask = 0;

static const uint32_t UMask = 0x8;
static const uint32_t UShift = 3;
static const uint32_t GCAttrMask = 0x30;
static const uint32_t GCAttrShift = 4;
static const uint32_t LifetimeMask = 0x1C0;
static const uint32_t LifetimeShift = 6;
static const uint32_t AddressSpaceMask =
    ~(CVRMask | UMask | GCAttrMask | LifetimeMask);
static const uint32_t AddressSpaceShift = 9;
608};

610/// A std::pair-like structure for storing a qualified type split
611/// into its local qualifiers and its locally-unqualified type.
612struct SplitQualType {
/// The locally-unqualified type.
const Type *Ty = nullptr;

/// The local qualifiers.
Qualifiers Quals;

SplitQualType() = default;
SplitQualType(const Type *ty, Qualifiers qs) : Ty(ty), Quals(qs) {}

SplitQualType getSingleStepDesugaredType() const; // end of this file

// Make std::tie work.
std::pair<const Type *,Qualifiers> asPair() const {
  return std::pair<const Type *, Qualifiers>(Ty, Quals);
}

friend bool operator==(SplitQualType a, SplitQualType b) {
  return a.Ty == b.Ty && a.Quals == b.Quals;
}
friend bool operator!=(SplitQualType a, SplitQualType b) {
  return a.Ty != b.Ty || a.Quals != b.Quals;
}
635};

637/// The kind of type we are substituting Objective-C type arguments into.
638///
639/// The kind of substitution affects the replacement of type parameters when
640/// no concrete type information is provided, e.g., when dealing with an
641/// unspecialized type.
642enum class ObjCSubstitutionContext {
/// An ordinary type.
Ordinary,

/// The result type of a method or function.
Result,

/// The parameter type of a method or function.
Parameter,

/// The type of a property.
Property,

/// The superclass of a type.
Superclass,
657};

659/// A (possibly-)qualified type.
660///
661/// For efficiency, we don't store CV-qualified types as nodes on their
662/// own: instead each reference to a type stores the qualifiers.  This
663/// greatly reduces the number of nodes we need to allocate for types (for
664/// example we only need one for 'int', 'const int', 'volatile int',
665/// 'const volatile int', etc).
666///
667/// As an added efficiency bonus, instead of making this a pair, we
668/// just store the two bits we care about in the low bits of the
669/// pointer.  To handle the packing/unpacking, we make QualType be a
670/// simple wrapper class that acts like a smart pointer.  A third bit
671/// indicates whether there are extended qualifiers present, in which
672/// case the pointer points to a special structure.
673class QualType {
friend class QualifierCollector;

// Thankfully, these are efficiently composable.
llvm::PointerIntPair<llvm::PointerUnion<const Type *, const ExtQuals *>,
                     Qualifiers::FastWidth> Value;

const ExtQuals *getExtQualsUnsafe() const {
  return Value.getPointer().get<const ExtQuals*>();
}

const Type *getTypePtrUnsafe() const {
  return Value.getPointer().get<const Type*>();
}

const ExtQualsTypeCommonBase *getCommonPtr() const {
  assert(!isNull() && "Cannot retrieve a NULL type pointer")(static_cast<void> (0));
  auto CommonPtrVal = reinterpret_cast<uintptr_t>(Value.getOpaqueValue());
  CommonPtrVal &= ~(uintptr_t)((1 << TypeAlignmentInBits) - 1);
  return reinterpret_cast<ExtQualsTypeCommonBase*>(CommonPtrVal);
}

695public:
QualType() = default;
QualType(const Type *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
QualType(const ExtQuals *Ptr, unsigned Quals) : Value(Ptr, Quals) {}

unsigned getLocalFastQualifiers() const { return Value.getInt(); }
void setLocalFastQualifiers(unsigned Quals) { Value.setInt(Quals); }

/// Retrieves a pointer to the underlying (unqualified) type.
///
/// This function requires that the type not be NULL. If the type might be
/// NULL, use the (slightly less efficient) \c getTypePtrOrNull().
const Type *getTypePtr() const;

const Type *getTypePtrOrNull() const;

/// Retrieves a pointer to the name of the base type.
const IdentifierInfo *getBaseTypeIdentifier() const;

/// Divides a QualType into its unqualified type and a set of local
/// qualifiers.
SplitQualType split() const;

void *getAsOpaquePtr() const { return Value.getOpaqueValue(); }

static QualType getFromOpaquePtr(const void *Ptr) {
  QualType T;
  T.Value.setFromOpaqueValue(const_cast<void*>(Ptr));
  return T;
}

const Type &operator*() const {
  return *getTypePtr();
}

const Type *operator->() const {
  return getTypePtr();
}

bool isCanonical() const;
bool isCanonicalAsParam() const;

/// Return true if this QualType doesn't point to a type yet.
bool isNull() const {
  return Value.getPointer().isNull();
}

/// Determine whether this particular QualType instance has the
/// "const" qualifier set, without looking through typedefs that may have
/// added "const" at a different level.
bool isLocalConstQualified() const {
  return (getLocalFastQualifiers() & Qualifiers::Const);
}

/// Determine whether this type is const-qualified.
bool isConstQualified() const;

/// Determine whether this particular QualType instance has the
/// "restrict" qualifier set, without looking through typedefs that may have
/// added "restrict" at a different level.
bool isLocalRestrictQualified() const {
  return (getLocalFastQualifiers() & Qualifiers::Restrict);
}

/// Determine whether this type is restrict-qualified.
bool isRestrictQualified() const;

/// Determine whether this particular QualType instance has the
/// "volatile" qualifier set, without looking through typedefs that may have
/// added "volatile" at a different level.
bool isLocalVolatileQualified() const {
  return (getLocalFastQualifiers() & Qualifiers::Volatile);
}

/// Determine whether this type is volatile-qualified.
bool isVolatileQualified() const;

/// Determine whether this particular QualType instance has any
/// qualifiers, without looking through any typedefs that might add
/// qualifiers at a different level.
bool hasLocalQualifiers() const {
  return getLocalFastQualifiers() || hasLocalNonFastQualifiers();
}

/// Determine whether this type has any qualifiers.
bool hasQualifiers() const;

/// Determine whether this particular QualType instance has any
/// "non-fast" qualifiers, e.g., those that are stored in an ExtQualType
/// instance.
bool hasLocalNonFastQualifiers() const {
  return Value.getPointer().is<const ExtQuals*>();
}

/// Retrieve the set of qualifiers local to this particular QualType
/// instance, not including any qualifiers acquired through typedefs or
/// other sugar.
Qualifiers getLocalQualifiers() const;

/// Retrieve the set of qualifiers applied to this type.
Qualifiers getQualifiers() const;

/// Retrieve the set of CVR (const-volatile-restrict) qualifiers
/// local to this particular QualType instance, not including any qualifiers
/// acquired through typedefs or other sugar.
unsigned getLocalCVRQualifiers() const {
  return getLocalFastQualifiers();
}

/// Retrieve the set of CVR (const-volatile-restrict) qualifiers
/// applied to this type.
unsigned getCVRQualifiers() const;

bool isConstant(const ASTContext& Ctx) const {
  return QualType::isConstant(*this, Ctx);
}

/// Determine whether this is a Plain Old Data (POD) type (C++ 3.9p10).
bool isPODType(const ASTContext &Context) const;

/// Return true if this is a POD type according to the rules of the C++98
/// standard, regardless of the current compilation's language.
bool isCXX98PODType(const ASTContext &Context) const;

/// Return true if this is a POD type according to the more relaxed rules
/// of the C++11 standard, regardless of the current compilation's language.
/// (C++0x [basic.types]p9). Note that, unlike
/// CXXRecordDecl::isCXX11StandardLayout, this takes DRs into account.
bool isCXX11PODType(const ASTContext &Context) const;

/// Return true if this is a trivial type per (C++0x [basic.types]p9)
bool isTrivialType(const ASTContext &Context) const;

/// Return true if this is a trivially copyable type (C++0x [basic.types]p9)
bool isTriviallyCopyableType(const ASTContext &Context) const;


/// Returns true if it is a class and it might be dynamic.
bool mayBeDynamicClass() const;

/// Returns true if it is not a class or if the class might not be dynamic.
bool mayBeNotDynamicClass() const;

// Don't promise in the API that anything besides 'const' can be
// easily added.

/// Add the `const` type qualifier to this QualType.
void addConst() {
  addFastQualifiers(Qualifiers::Const);
}
QualType withConst() const {
  return withFastQualifiers(Qualifiers::Const);
}

/// Add the `volatile` type qualifier to this QualType.
void addVolatile() {
  addFastQualifiers(Qualifiers::Volatile);
}
QualType withVolatile() const {
  return withFastQualifiers(Qualifiers::Volatile);
}

/// Add the `restrict` qualifier to this QualType.
void addRestrict() {
  addFastQualifiers(Qualifiers::Restrict);
}
QualType withRestrict() const {
  return withFastQualifiers(Qualifiers::Restrict);
}

QualType withCVRQualifiers(unsigned CVR) const {
  return withFastQualifiers(CVR);
}

void addFastQualifiers(unsigned TQs) {
  assert(!(TQs & ~Qualifiers::FastMask)(static_cast<void> (0))
         && "non-fast qualifier bits set in mask!")(static_cast<void> (0));
  Value.setInt(Value.getInt() | TQs);
}

void removeLocalConst();
void removeLocalVolatile();
void removeLocalRestrict();
void removeLocalCVRQualifiers(unsigned Mask);

void removeLocalFastQualifiers() { Value.setInt(0); }
void removeLocalFastQualifiers(unsigned Mask) {
  assert(!(Mask & ~Qualifiers::FastMask) && "mask has non-fast qualifiers")(static_cast<void> (0));
  Value.setInt(Value.getInt() & ~Mask);
}

// Creates a type with the given qualifiers in addition to any
// qualifiers already on this type.
QualType withFastQualifiers(unsigned TQs) const {
  QualType T = *this;
  T.addFastQualifiers(TQs);
  return T;
}

// Creates a type with exactly the given fast qualifiers, removing
// any existing fast qualifiers.
QualType withExactLocalFastQualifiers(unsigned TQs) const {
  return withoutLocalFastQualifiers().withFastQualifiers(TQs);
}

// Removes fast qualifiers, but leaves any extended qualifiers in place.
QualType withoutLocalFastQualifiers() const {
  QualType T = *this;
  T.removeLocalFastQualifiers();
  return T;
}

QualType getCanonicalType() const;

/// Return this type with all of the instance-specific qualifiers
/// removed, but without removing any qualifiers that may have been applied
/// through typedefs.
QualType getLocalUnqualifiedType() const { return QualType(getTypePtr(), 0); }

/// Retrieve the unqualified variant of the given type,
/// removing as little sugar as possible.
///
/// This routine looks through various kinds of sugar to find the
/// least-desugared type that is unqualified. For example, given:
///
/// \code
/// typedef int Integer;
/// typedef const Integer CInteger;
/// typedef CInteger DifferenceType;
/// \endcode
///
/// Executing \c getUnqualifiedType() on the type \c DifferenceType will
/// desugar until we hit the type \c Integer, which has no qualifiers on it.
///
/// The resulting type might still be qualified if it's sugar for an array
/// type.  To strip qualifiers even from within a sugared array type, use
/// ASTContext::getUnqualifiedArrayType.
inline QualType getUnqualifiedType() const;

/// Retrieve the unqualified variant of the given type, removing as little
/// sugar as possible.
///
/// Like getUnqualifiedType(), but also returns the set of
/// qualifiers that were built up.
///
/// The resulting type might still be qualified if it's sugar for an array
/// type.  To strip qualifiers even from within a sugared array type, use
/// ASTContext::getUnqualifiedArrayType.
inline SplitQualType getSplitUnqualifiedType() const;

/// Determine whether this type is more qualified than the other
/// given type, requiring exact equality for non-CVR qualifiers.
bool isMoreQualifiedThan(QualType Other) const;

/// Determine whether this type is at least as qualified as the other
/// given type, requiring exact equality for non-CVR qualifiers.
bool isAtLeastAsQualifiedAs(QualType Other) const;

QualType getNonReferenceType() const;

/// Determine the type of a (typically non-lvalue) expression with the
/// specified result type.
///
/// This routine should be used for expressions for which the return type is
/// explicitly specified (e.g., in a cast or call) and isn't necessarily
/// an lvalue. It removes a top-level reference (since there are no
/// expressions of reference type) and deletes top-level cvr-qualifiers
/// from non-class types (in C++) or all types (in C).
QualType getNonLValueExprType(const ASTContext &Context) const;

/// Remove an outer pack expansion type (if any) from this type. Used as part
/// of converting the type of a declaration to the type of an expression that
/// references that expression. It's meaningless for an expression to have a
/// pack expansion type.
QualType getNonPackExpansionType() const;

/// Return the specified type with any "sugar" removed from
/// the type.  This takes off typedefs, typeof's etc.  If the outer level of
/// the type is already concrete, it returns it unmodified.  This is similar
/// to getting the canonical type, but it doesn't remove *all* typedefs.  For
/// example, it returns "T*" as "T*", (not as "int*"), because the pointer is
/// concrete.
///
/// Qualifiers are left in place.
QualType getDesugaredType(const ASTContext &Context) const {
  return getDesugaredType(*this, Context);
}

SplitQualType getSplitDesugaredType() const {
  return getSplitDesugaredType(*this);
}

/// Return the specified type with one level of "sugar" removed from
/// the type.
///
/// This routine takes off the first typedef, typeof, etc. If the outer level
/// of the type is already concrete, it returns it unmodified.
QualType getSingleStepDesugaredType(const ASTContext &Context) const {
  return getSingleStepDesugaredTypeImpl(*this, Context);
}

/// Returns the specified type after dropping any
/// outer-level parentheses.
QualType IgnoreParens() const {
  if (isa<ParenType>(*this))
    return QualType::IgnoreParens(*this);
  return *this;
}

/// Indicate whether the specified types and qualifiers are identical.
friend bool operator==(const QualType &LHS, const QualType &RHS) {
  return LHS.Value == RHS.Value;
}
friend bool operator!=(const QualType &LHS, const QualType &RHS) {
  return LHS.Value != RHS.Value;
}
friend bool operator<(const QualType &LHS, const QualType &RHS) {
  return LHS.Value < RHS.Value;
}

static std::string getAsString(SplitQualType split,
                               const PrintingPolicy &Policy) {
  return getAsString(split.Ty, split.Quals, Policy);
}
static std::string getAsString(const Type *ty, Qualifiers qs,
                               const PrintingPolicy &Policy);

std::string getAsString() const;
std::string getAsString(const PrintingPolicy &Policy) const;

void print(raw_ostream &OS, const PrintingPolicy &Policy,
           const Twine &PlaceHolder = Twine(),
           unsigned Indentation = 0) const;

static void print(SplitQualType split, raw_ostream &OS,
                  const PrintingPolicy &policy, const Twine &PlaceHolder,
                  unsigned Indentation = 0) {
  return print(split.Ty, split.Quals, OS, policy, PlaceHolder, Indentation);
}

static void print(const Type *ty, Qualifiers qs,
                  raw_ostream &OS, const PrintingPolicy &policy,
                  const Twine &PlaceHolder,
                  unsigned Indentation = 0);

void getAsStringInternal(std::string &Str,
                         const PrintingPolicy &Policy) const;

static void getAsStringInternal(SplitQualType split, std::string &out,
                                const PrintingPolicy &policy) {
  return getAsStringInternal(split.Ty, split.Quals, out, policy);
}

static void getAsStringInternal(const Type *ty, Qualifiers qs,
                                std::string &out,
                                const PrintingPolicy &policy);

class StreamedQualTypeHelper {
  const QualType &T;
  const PrintingPolicy &Policy;
  const Twine &PlaceHolder;
  unsigned Indentation;

public:
  StreamedQualTypeHelper(const QualType &T, const PrintingPolicy &Policy,
                         const Twine &PlaceHolder, unsigned Indentation)
      : T(T), Policy(Policy), PlaceHolder(PlaceHolder),
        Indentation(Indentation) {}

  friend raw_ostream &operator<<(raw_ostream &OS,
                                 const StreamedQualTypeHelper &SQT) {
    SQT.T.print(OS, SQT.Policy, SQT.PlaceHolder, SQT.Indentation);
    return OS;
  }
};

StreamedQualTypeHelper stream(const PrintingPolicy &Policy,
                              const Twine &PlaceHolder = Twine(),
                              unsigned Indentation = 0) const {
  return StreamedQualTypeHelper(*this, Policy, PlaceHolder, Indentation);
}

void dump(const char *s) const;
void dump() const;
void dump(llvm::raw_ostream &OS, const ASTContext &Context) const;

void Profile(llvm::FoldingSetNodeID &ID) const {
  ID.AddPointer(getAsOpaquePtr());
}

/// Check if this type has any address space qualifier.
inline bool hasAddressSpace() const;

/// Return the address space of this type.
inline LangAS getAddressSpace() const;

/// Returns true if address space qualifiers overlap with T address space
/// qualifiers.
/// OpenCL C defines conversion rules for pointers to different address spaces
/// and notion of overlapping address spaces.
/// CL1.1 or CL1.2:
///   address spaces overlap iff they are they same.
/// OpenCL C v2.0 s6.5.5 adds:
///   __generic overlaps with any address space except for __constant.
bool isAddressSpaceOverlapping(QualType T) const {
  Qualifiers Q = getQualifiers();
  Qualifiers TQ = T.getQualifiers();
  // Address spaces overlap if at least one of them is a superset of another
  return Q.isAddressSpaceSupersetOf(TQ) || TQ.isAddressSpaceSupersetOf(Q);
}

/// Returns gc attribute of this type.
inline Qualifiers::GC getObjCGCAttr() const;

/// true when Type is objc's weak.
bool isObjCGCWeak() const {
  return getObjCGCAttr() == Qualifiers::Weak;
}

/// true when Type is objc's strong.
bool isObjCGCStrong() const {
  return getObjCGCAttr() == Qualifiers::Strong;
}

/// Returns lifetime attribute of this type.
Qualifiers::ObjCLifetime getObjCLifetime() const {
  return getQualifiers().getObjCLifetime();
}

bool hasNonTrivialObjCLifetime() const {
  return getQualifiers().hasNonTrivialObjCLifetime();
}

bool hasStrongOrWeakObjCLifetime() const {
  return getQualifiers().hasStrongOrWeakObjCLifetime();
}

// true when Type is objc's weak and weak is enabled but ARC isn't.
bool isNonWeakInMRRWithObjCWeak(const ASTContext &Context) const;

enum PrimitiveDefaultInitializeKind {
  /// The type does not fall into any of the following categories. Note that
  /// this case is zero-valued so that values of this enum can be used as a
  /// boolean condition for non-triviality.
  PDIK_Trivial,

  /// The type is an Objective-C retainable pointer type that is qualified
  /// with the ARC __strong qualifier.
  PDIK_ARCStrong,

  /// The type is an Objective-C retainable pointer type that is qualified
  /// with the ARC __weak qualifier.
  PDIK_ARCWeak,

  /// The type is a struct containing a field whose type is not PCK_Trivial.
  PDIK_Struct
};

/// Functions to query basic properties of non-trivial C struct types.

/// Check if this is a non-trivial type that would cause a C struct
/// transitively containing this type to be non-trivial to default initialize
/// and return the kind.
PrimitiveDefaultInitializeKind
isNonTrivialToPrimitiveDefaultInitialize() const;

enum PrimitiveCopyKind {
  /// The type does not fall into any of the following categories. Note that
  /// this case is zero-valued so that values of this enum can be used as a
  /// boolean condition for non-triviality.
  PCK_Trivial,

  /// The type would be trivial except that it is volatile-qualified. Types
  /// that fall into one of the other non-trivial cases may additionally be
  /// volatile-qualified.
  PCK_VolatileTrivial,

  /// The type is an Objective-C retainable pointer type that is qualified
  /// with the ARC __strong qualifier.
  PCK_ARCStrong,

  /// The type is an Objective-C retainable pointer type that is qualified
  /// with the ARC __weak qualifier.
  PCK_ARCWeak,

  /// The type is a struct containing a field whose type is neither
  /// PCK_Trivial nor PCK_VolatileTrivial.
  /// Note that a C++ struct type does not necessarily match this; C++ copying
  /// semantics are too complex to express here, in part because they depend
  /// on the exact constructor or assignment operator that is chosen by
  /// overload resolution to do the copy.
  PCK_Struct
};

/// Check if this is a non-trivial type that would cause a C struct
/// transitively containing this type to be non-trivial to copy and return the
/// kind.
PrimitiveCopyKind isNonTrivialToPrimitiveCopy() const;

/// Check if this is a non-trivial type that would cause a C struct
/// transitively containing this type to be non-trivial to destructively
/// move and return the kind. Destructive move in this context is a C++-style
/// move in which the source object is placed in a valid but unspecified state
/// after it is moved, as opposed to a truly destructive move in which the
/// source object is placed in an uninitialized state.
PrimitiveCopyKind isNonTrivialToPrimitiveDestructiveMove() const;

enum DestructionKind {
  DK_none,
  DK_cxx_destructor,
  DK_objc_strong_lifetime,
  DK_objc_weak_lifetime,
  DK_nontrivial_c_struct
};

/// Returns a nonzero value if objects of this type require
/// non-trivial work to clean up after.  Non-zero because it's
/// conceivable that qualifiers (objc_gc(weak)?) could make
/// something require destruction.
DestructionKind isDestructedType() const {
  return isDestructedTypeImpl(*this);
}

/// Check if this is or contains a C union that is non-trivial to
/// default-initialize, which is a union that has a member that is non-trivial
/// to default-initialize. If this returns true,
/// isNonTrivialToPrimitiveDefaultInitialize returns PDIK_Struct.
bool hasNonTrivialToPrimitiveDefaultInitializeCUnion() const;

/// Check if this is or contains a C union that is non-trivial to destruct,
/// which is a union that has a member that is non-trivial to destruct. If
/// this returns true, isDestructedType returns DK_nontrivial_c_struct.
bool hasNonTrivialToPrimitiveDestructCUnion() const;

/// Check if this is or contains a C union that is non-trivial to copy, which
/// is a union that has a member that is non-trivial to copy. If this returns
/// true, isNonTrivialToPrimitiveCopy returns PCK_Struct.
bool hasNonTrivialToPrimitiveCopyCUnion() const;

/// Determine whether expressions of the given type are forbidden
/// from being lvalues in C.
///
/// The expression types that are forbidden to be lvalues are:
///   - 'void', but not qualified void
///   - function types
///
/// The exact rule here is C99 6.3.2.1:
///   An lvalue is an expression with an object type or an incomplete
///   type other than void.
bool isCForbiddenLValueType() const;

/// Substitute type arguments for the Objective-C type parameters used in the
/// subject type.
///
/// \param ctx ASTContext in which the type exists.
///
/// \param typeArgs The type arguments that will be substituted for the
/// Objective-C type parameters in the subject type, which are generally
/// computed via \c Type::getObjCSubstitutions. If empty, the type
/// parameters will be replaced with their bounds or id/Class, as appropriate
/// for the context.
///
/// \param context The context in which the subject type was written.
///
/// \returns the resulting type.
QualType substObjCTypeArgs(ASTContext &ctx,
                           ArrayRef<QualType> typeArgs,
                           ObjCSubstitutionContext context) const;

/// Substitute type arguments from an object type for the Objective-C type
/// parameters used in the subject type.
///
/// This operation combines the computation of type arguments for
/// substitution (\c Type::getObjCSubstitutions) with the actual process of
/// substitution (\c QualType::substObjCTypeArgs) for the convenience of
/// callers that need to perform a single substitution in isolation.
///
/// \param objectType The type of the object whose member type we're
/// substituting into. For example, this might be the receiver of a message
/// or the base of a property access.
///
/// \param dc The declaration context from which the subject type was
/// retrieved, which indicates (for example) which type parameters should
/// be substituted.
///
/// \param context The context in which the subject type was written.
///
/// \returns the subject type after replacing all of the Objective-C type
/// parameters with their corresponding arguments.
QualType substObjCMemberType(QualType objectType,
                             const DeclContext *dc,
                             ObjCSubstitutionContext context) const;

/// Strip Objective-C "__kindof" types from the given type.
QualType stripObjCKindOfType(const ASTContext &ctx) const;

/// Remove all qualifiers including _Atomic.
QualType getAtomicUnqualifiedType() const;

1294private:
// These methods are implemented in a separate translation unit;
// "static"-ize them to avoid creating temporary QualTypes in the
// caller.
static bool isConstant(QualType T, const ASTContext& Ctx);
static QualType getDesugaredType(QualType T, const ASTContext &Context);
static SplitQualType getSplitDesugaredType(QualType T);
static SplitQualType getSplitUnqualifiedTypeImpl(QualType type);
static QualType getSingleStepDesugaredTypeImpl(QualType type,
                                               const ASTContext &C);
static QualType IgnoreParens(QualType T);
static DestructionKind isDestructedTypeImpl(QualType type);

/// Check if \param RD is or contains a non-trivial C union.
static bool hasNonTrivialToPrimitiveDefaultInitializeCUnion(const RecordDecl *RD);
static bool hasNonTrivialToPrimitiveDestructCUnion(const RecordDecl *RD);
static bool hasNonTrivialToPrimitiveCopyCUnion(const RecordDecl *RD);
1311};

1313} // namespace clang

1315namespace llvm {

1317/// Implement simplify_type for QualType, so that we can dyn_cast from QualType
1318/// to a specific Type class.
1319template<> struct simplify_type< ::clang::QualType> {
using SimpleType = const ::clang::Type *;

static SimpleType getSimplifiedValue(::clang::QualType Val) {
  return Val.getTypePtr();
}
1325};

1327// Teach SmallPtrSet that QualType is "basically a pointer".
1328template<>
1329struct PointerLikeTypeTraits<clang::QualType> {
static inline void *getAsVoidPointer(clang::QualType P) {
  return P.getAsOpaquePtr();
}

static inline clang::QualType getFromVoidPointer(void *P) {
  return clang::QualType::getFromOpaquePtr(P);
}

// Various qualifiers go in low bits.
static constexpr int NumLowBitsAvailable = 0;
1340};

1342} // namespace llvm

1344namespace clang {

1346/// Base class that is common to both the \c ExtQuals and \c Type
1347/// classes, which allows \c QualType to access the common fields between the
1348/// two.
1349class ExtQualsTypeCommonBase {
friend class ExtQuals;
friend class QualType;
friend class Type;

/// The "base" type of an extended qualifiers type (\c ExtQuals) or
/// a self-referential pointer (for \c Type).
///
/// This pointer allows an efficient mapping from a QualType to its
/// underlying type pointer.
const Type *const BaseType;

/// The canonical type of this type.  A QualType.
QualType CanonicalType;

ExtQualsTypeCommonBase(const Type *baseType, QualType canon)
    : BaseType(baseType), CanonicalType(canon) {}
1366};

1368/// We can encode up to four bits in the low bits of a
1369/// type pointer, but there are many more type qualifiers that we want
1370/// to be able to apply to an arbitrary type.  Therefore we have this
1371/// struct, intended to be heap-allocated and used by QualType to
1372/// store qualifiers.
1373///
1374/// The current design tags the 'const', 'restrict', and 'volatile' qualifiers
1375/// in three low bits on the QualType pointer; a fourth bit records whether
1376/// the pointer is an ExtQuals node. The extended qualifiers (address spaces,
1377/// Objective-C GC attributes) are much more rare.
1378class ExtQuals : public ExtQualsTypeCommonBase, public llvm::FoldingSetNode {
// NOTE: changing the fast qualifiers should be straightforward as
// long as you don't make 'const' non-fast.
// 1. Qualifiers:
//    a) Modify the bitmasks (Qualifiers::TQ and DeclSpec::TQ).
//       Fast qualifiers must occupy the low-order bits.
//    b) Update Qualifiers::FastWidth and FastMask.
// 2. QualType:
//    a) Update is{Volatile,Restrict}Qualified(), defined inline.
//    b) Update remove{Volatile,Restrict}, defined near the end of
//       this header.
// 3. ASTContext:
//    a) Update get{Volatile,Restrict}Type.

/// The immutable set of qualifiers applied by this node. Always contains
/// extended qualifiers.
Qualifiers Quals;

ExtQuals *this_() { return this; }

1398public:
ExtQuals(const Type *baseType, QualType canon, Qualifiers quals)
    : ExtQualsTypeCommonBase(baseType,
                             canon.isNull() ? QualType(this_(), 0) : canon),
      Quals(quals) {
  assert(Quals.hasNonFastQualifiers()(static_cast<void> (0))
         && "ExtQuals created with no fast qualifiers")(static_cast<void> (0));
  assert(!Quals.hasFastQualifiers()(static_cast<void> (0))
         && "ExtQuals created with fast qualifiers")(static_cast<void> (0));
}

Qualifiers getQualifiers() const { return Quals; }

bool hasObjCGCAttr() const { return Quals.hasObjCGCAttr(); }
Qualifiers::GC getObjCGCAttr() const { return Quals.getObjCGCAttr(); }

bool hasObjCLifetime() const { return Quals.hasObjCLifetime(); }
Qualifiers::ObjCLifetime getObjCLifetime() const {
  return Quals.getObjCLifetime();
}

bool hasAddressSpace() const { return Quals.hasAddressSpace(); }
LangAS getAddressSpace() const { return Quals.getAddressSpace(); }

const Type *getBaseType() const { return BaseType; }

1424public:
void Profile(llvm::FoldingSetNodeID &ID) const {
  Profile(ID, getBaseType(), Quals);
}

static void Profile(llvm::FoldingSetNodeID &ID,
                    const Type *BaseType,
                    Qualifiers Quals) {
  assert(!Quals.hasFastQualifiers() && "fast qualifiers in ExtQuals hash!")(static_cast<void> (0));
  ID.AddPointer(BaseType);
  Quals.Profile(ID);
}
1436};

1438/// The kind of C++11 ref-qualifier associated with a function type.
1439/// This determines whether a member function's "this" object can be an
1440/// lvalue, rvalue, or neither.
1441enum RefQualifierKind {
/// No ref-qualifier was provided.
RQ_None = 0,

/// An lvalue ref-qualifier was provided (\c &).
RQ_LValue,

/// An rvalue ref-qualifier was provided (\c &&).
RQ_RValue
1450};

1452/// Which keyword(s) were used to create an AutoType.
1453enum class AutoTypeKeyword {
/// auto
Auto,

/// decltype(auto)
DecltypeAuto,

/// __auto_type (GNU extension)
GNUAutoType
1462};

1464/// The base class of the type hierarchy.
1465///
1466/// A central concept with types is that each type always has a canonical
1467/// type.  A canonical type is the type with any typedef names stripped out
1468/// of it or the types it references.  For example, consider:
1469///
1470///  typedef int  foo;
1471///  typedef foo* bar;
1472///    'int *'    'foo *'    'bar'
1473///
1474/// There will be a Type object created for 'int'.  Since int is canonical, its
1475/// CanonicalType pointer points to itself.  There is also a Type for 'foo' (a
1476/// TypedefType).  Its CanonicalType pointer points to the 'int' Type.  Next
1477/// there is a PointerType that represents 'int*', which, like 'int', is
1478/// canonical.  Finally, there is a PointerType type for 'foo*' whose canonical
1479/// type is 'int*', and there is a TypedefType for 'bar', whose canonical type
1480/// is also 'int*'.
1481///
1482/// Non-canonical types are useful for emitting diagnostics, without losing
1483/// information about typedefs being used.  Canonical types are useful for type
1484/// comparisons (they allow by-pointer equality tests) and useful for reasoning
1485/// about whether something has a particular form (e.g. is a function type),
1486/// because they implicitly, recursively, strip all typedefs out of a type.
1487///
1488/// Types, once created, are immutable.
1489///
1490class alignas(8) Type : public ExtQualsTypeCommonBase {
1491public:
enum TypeClass {
1493#define TYPE(Class, Base) Class,
1494#define LAST_TYPE(Class) TypeLast = Class
1495#define ABSTRACT_TYPE(Class, Base)
1496#include "clang/AST/TypeNodes.inc"
};

1499private:
/// Bitfields required by the Type class.
class TypeBitfields {
  friend class Type;
  template <class T> friend class TypePropertyCache;

  /// TypeClass bitfield - Enum that specifies what subclass this belongs to.
  unsigned TC : 8;

  /// Store information on the type dependency.
  unsigned Dependence : llvm::BitWidth<TypeDependence>;

  /// True if the cache (i.e. the bitfields here starting with
  /// 'Cache') is valid.
  mutable unsigned CacheValid : 1;

  /// Linkage of this type.
  mutable unsigned CachedLinkage : 3;

  /// Whether this type involves and local or unnamed types.
  mutable unsigned CachedLocalOrUnnamed : 1;

  /// Whether this type comes from an AST file.
  mutable unsigned FromAST : 1;

  bool isCacheValid() const {
    return CacheValid;
  }

  Linkage getLinkage() const {
    assert(isCacheValid() && "getting linkage from invalid cache")(static_cast<void> (0));
    return static_cast<Linkage>(CachedLinkage);
  }

  bool hasLocalOrUnnamedType() const {
    assert(isCacheValid() && "getting linkage from invalid cache")(static_cast<void> (0));
    return CachedLocalOrUnnamed;
  }
};
enum { NumTypeBits = 8 + llvm::BitWidth<TypeDependence> + 6 };

1540protected:
// These classes allow subclasses to somewhat cleanly pack bitfields
// into Type.

class ArrayTypeBitfields {
  friend class ArrayType;

  unsigned : NumTypeBits;

  /// CVR qualifiers from declarations like
  /// 'int X[static restrict 4]'. For function parameters only.
  unsigned IndexTypeQuals : 3;

  /// Storage class qualifiers from declarations like
  /// 'int X[static restrict 4]'. For function parameters only.
  /// Actually an ArrayType::ArraySizeModifier.
  unsigned SizeModifier : 3;
};

class ConstantArrayTypeBitfields {
  friend class ConstantArrayType;

  unsigned : NumTypeBits + 3 + 3;

  /// Whether we have a stored size expression.
  unsigned HasStoredSizeExpr : 1;
};

class BuiltinTypeBitfields {
  friend class BuiltinType;

  unsigned : NumTypeBits;

  /// The kind (BuiltinType::Kind) of builtin type this is.
  unsigned Kind : 8;
};

/// FunctionTypeBitfields store various bits belonging to FunctionProtoType.
/// Only common bits are stored here. Additional uncommon bits are stored
/// in a trailing object after FunctionProtoType.
class FunctionTypeBitfields {
  friend class FunctionProtoType;
  friend class FunctionType;

  unsigned : NumTypeBits;

  /// Extra information which affects how the function is called, like
  /// regparm and the calling convention.
  unsigned ExtInfo : 13;

  /// The ref-qualifier associated with a \c FunctionProtoType.
  ///
  /// This is a value of type \c RefQualifierKind.
  unsigned RefQualifier : 2;

  /// Used only by FunctionProtoType, put here to pack with the
  /// other bitfields.
  /// The qualifiers are part of FunctionProtoType because...
  ///
  /// C++ 8.3.5p4: The return type, the parameter type list and the
  /// cv-qualifier-seq, [...], are part of the function type.
  unsigned FastTypeQuals : Qualifiers::FastWidth;
  /// Whether this function has extended Qualifiers.
  unsigned HasExtQuals : 1;

  /// The number of parameters this function has, not counting '...'.
  /// According to [implimits] 8 bits should be enough here but this is
  /// somewhat easy to exceed with metaprogramming and so we would like to
  /// keep NumParams as wide as reasonably possible.
  unsigned NumParams : 16;

  /// The type of exception specification this function has.
  unsigned ExceptionSpecType : 4;

  /// Whether this function has extended parameter information.
  unsigned HasExtParameterInfos : 1;

  /// Whether the function is variadic.
  unsigned Variadic : 1;

  /// Whether this function has a trailing return type.
  unsigned HasTrailingReturn : 1;
};

class ObjCObjectTypeBitfields {
  friend class ObjCObjectType;

  unsigned : NumTypeBits;

  /// The number of type arguments stored directly on this object type.
  unsigned NumTypeArgs : 7;

  /// The number of protocols stored directly on this object type.
  unsigned NumProtocols : 6;

  /// Whether this is a "kindof" type.
  unsigned IsKindOf : 1;
};

class ReferenceTypeBitfields {
  friend class ReferenceType;

  unsigned : NumTypeBits;

  /// True if the type was originally spelled with an lvalue sigil.
  /// This is never true of rvalue references but can also be false
  /// on lvalue references because of C++0x [dcl.typedef]p9,
  /// as follows:
  ///
  ///   typedef int &ref;    // lvalue, spelled lvalue
  ///   typedef int &&rvref; // rvalue
  ///   ref &a;              // lvalue, inner ref, spelled lvalue
  ///   ref &&a;             // lvalue, inner ref
  ///   rvref &a;            // lvalue, inner ref, spelled lvalue
  ///   rvref &&a;           // rvalue, inner ref
  unsigned SpelledAsLValue : 1;

  /// True if the inner type is a reference type.  This only happens
  /// in non-canonical forms.
  unsigned InnerRef : 1;
};

class TypeWithKeywordBitfields {
  friend class TypeWithKeyword;

  unsigned : NumTypeBits;

  /// An ElaboratedTypeKeyword.  8 bits for efficient access.
  unsigned Keyword : 8;
};

enum { NumTypeWithKeywordBits = 8 };

class ElaboratedTypeBitfields {
  friend class ElaboratedType;

  unsigned : NumTypeBits;
  unsigned : NumTypeWithKeywordBits;

  /// Whether the ElaboratedType has a trailing OwnedTagDecl.
  unsigned HasOwnedTagDecl : 1;
};

class VectorTypeBitfields {
  friend class VectorType;
  friend class DependentVectorType;

  unsigned : NumTypeBits;

  /// The kind of vector, either a generic vector type or some
  /// target-specific vector type such as for AltiVec or Neon.
  unsigned VecKind : 3;
  /// The number of elements in the vector.
  uint32_t NumElements;
};

class AttributedTypeBitfields {
  friend class AttributedType;

  unsigned : NumTypeBits;

  /// An AttributedType::Kind
  unsigned AttrKind : 32 - NumTypeBits;
};

class AutoTypeBitfields {
  friend class AutoType;

  unsigned : NumTypeBits;

  /// Was this placeholder type spelled as 'auto', 'decltype(auto)',
  /// or '__auto_type'?  AutoTypeKeyword value.
  unsigned Keyword : 2;

  /// The number of template arguments in the type-constraints, which is
  /// expected to be able to hold at least 1024 according to [implimits].
  /// However as this limit is somewhat easy to hit with template
  /// metaprogramming we'd prefer to keep it as large as possible.
  /// At the moment it has been left as a non-bitfield since this type
  /// safely fits in 64 bits as an unsigned, so there is no reason to
  /// introduce the performance impact of a bitfield.
  unsigned NumArgs;
};

class SubstTemplateTypeParmPackTypeBitfields {
  friend class SubstTemplateTypeParmPackType;

  unsigned : NumTypeBits;

  /// The number of template arguments in \c Arguments, which is
  /// expected to be able to hold at least 1024 according to [implimits].
  /// However as this limit is somewhat easy to hit with template
  /// metaprogramming we'd prefer to keep it as large as possible.
  /// At the moment it has been left as a non-bitfield since this type
  /// safely fits in 64 bits as an unsigned, so there is no reason to
  /// introduce the performance impact of a bitfield.
  unsigned NumArgs;
};

class TemplateSpecializationTypeBitfields {
  friend class TemplateSpecializationType;

  unsigned : NumTypeBits;

  /// Whether this template specialization type is a substituted type alias.
  unsigned TypeAlias : 1;

  /// The number of template arguments named in this class template
  /// specialization, which is expected to be able to hold at least 1024
  /// according to [implimits]. However, as this limit is somewhat easy to
  /// hit with template metaprogramming we'd prefer to keep it as large
  /// as possible. At the moment it has been left as a non-bitfield since
  /// this type safely fits in 64 bits as an unsigned, so there is no reason
  /// to introduce the performance impact of a bitfield.
  unsigned NumArgs;
};

class DependentTemplateSpecializationTypeBitfields {
  friend class DependentTemplateSpecializationType;

  unsigned : NumTypeBits;
  unsigned : NumTypeWithKeywordBits;

  /// The number of template arguments named in this class template
  /// specialization, which is expected to be able to hold at least 1024
  /// according to [implimits]. However, as this limit is somewhat easy to
  /// hit with template metaprogramming we'd prefer to keep it as large
  /// as possible. At the moment it has been left as a non-bitfield since
  /// this type safely fits in 64 bits as an unsigned, so there is no reason
  /// to introduce the performance impact of a bitfield.
  unsigned NumArgs;
};

class PackExpansionTypeBitfields {
  friend class PackExpansionType;

  unsigned : NumTypeBits;

  /// The number of expansions that this pack expansion will
  /// generate when substituted (+1), which is expected to be able to
  /// hold at least 1024 according to [implimits]. However, as this limit
  /// is somewhat easy to hit with template metaprogramming we'd prefer to
  /// keep it as large as possible. At the moment it has been left as a
  /// non-bitfield since this type safely fits in 64 bits as an unsigned, so
  /// there is no reason to introduce the performance impact of a bitfield.
  ///
  /// This field will only have a non-zero value when some of the parameter
  /// packs that occur within the pattern have been substituted but others
  /// have not.
  unsigned NumExpansions;
};

union {
  TypeBitfields TypeBits;
  ArrayTypeBitfields ArrayTypeBits;
  ConstantArrayTypeBitfields ConstantArrayTypeBits;
  AttributedTypeBitfields AttributedTypeBits;
  AutoTypeBitfields AutoTypeBits;
  BuiltinTypeBitfields BuiltinTypeBits;
  FunctionTypeBitfields FunctionTypeBits;
  ObjCObjectTypeBitfields ObjCObjectTypeBits;
  ReferenceTypeBitfields ReferenceTypeBits;
  TypeWithKeywordBitfields TypeWithKeywordBits;
  ElaboratedTypeBitfields ElaboratedTypeBits;
  VectorTypeBitfields VectorTypeBits;
  SubstTemplateTypeParmPackTypeBitfields SubstTemplateTypeParmPackTypeBits;
  TemplateSpecializationTypeBitfields TemplateSpecializationTypeBits;
  DependentTemplateSpecializationTypeBitfields
    DependentTemplateSpecializationTypeBits;
  PackExpansionTypeBitfields PackExpansionTypeBits;
};

1812private:
template <class T> friend class TypePropertyCache;

/// Set whether this type comes from an AST file.
void setFromAST(bool V = true) const {
  TypeBits.FromAST = V;
}

1820protected:
friend class ASTContext;

Type(TypeClass tc, QualType canon, TypeDependence Dependence)
    : ExtQualsTypeCommonBase(this,
                             canon.isNull() ? QualType(this_(), 0) : canon) {
  static_assert(sizeof(*this) <= 8 + sizeof(ExtQualsTypeCommonBase),
                "changing bitfields changed sizeof(Type)!");
  static_assert(alignof(decltype(*this)) % sizeof(void *) == 0,
                "Insufficient alignment!");
  TypeBits.TC = tc;
  TypeBits.Dependence = static_cast<unsigned>(Dependence);
  TypeBits.CacheValid = false;
  TypeBits.CachedLocalOrUnnamed = false;
  TypeBits.CachedLinkage = NoLinkage;
  TypeBits.FromAST = false;
}

// silence VC++ warning C4355: 'this' : used in base member initializer list
Type *this_() { return this; }

void setDependence(TypeDependence D) {
  TypeBits.Dependence = static_cast<unsigned>(D);
}

void addDependence(TypeDependence D) { setDependence(getDependence() | D); }

1847public:
friend class ASTReader;
friend class ASTWriter;
template <class T> friend class serialization::AbstractTypeReader;
template <class T> friend class serialization::AbstractTypeWriter;

Type(const Type &) = delete;
Type(Type &&) = delete;
Type &operator=(const Type &) = delete;
Type &operator=(Type &&) = delete;

TypeClass getTypeClass() const { return static_cast<TypeClass>(TypeBits.TC); }

/// Whether this type comes from an AST file.
bool isFromAST() const { return TypeBits.FromAST; }

/// Whether this type is or contains an unexpanded parameter
/// pack, used to support C++0x variadic templates.
///
/// A type that contains a parameter pack shall be expanded by the
/// ellipsis operator at some point. For example, the typedef in the
/// following example contains an unexpanded parameter pack 'T':
///
/// \code
/// template<typename ...T>
/// struct X {
///   typedef T* pointer_types; // ill-formed; T is a parameter pack.
/// };
/// \endcode
///
/// Note that this routine does not specify which
bool containsUnexpandedParameterPack() const {
  return getDependence() & TypeDependence::UnexpandedPack;
}

/// Determines if this type would be canonical if it had no further
/// qualification.
bool isCanonicalUnqualified() const {
  return CanonicalType == QualType(this, 0);
}

/// Pull a single level of sugar off of this locally-unqualified type.
/// Users should generally prefer SplitQualType::getSingleStepDesugaredType()
/// or QualType::getSingleStepDesugaredType(const ASTContext&).
QualType getLocallyUnqualifiedSingleStepDesugaredType() const;

/// As an extension, we classify types as one of "sized" or "sizeless";
/// every type is one or the other.  Standard types are all sized;
/// sizeless types are purely an extension.
///
/// Sizeless types contain data with no specified size, alignment,
/// or layout.
bool isSizelessType() const;
bool isSizelessBuiltinType() const;

/// Determines if this is a sizeless type supported by the
/// 'arm_sve_vector_bits' type attribute, which can be applied to a single
/// SVE vector or predicate, excluding tuple types such as svint32x4_t.
bool isVLSTBuiltinType() const;

/// Returns the representative type for the element of an SVE builtin type.
/// This is used to represent fixed-length SVE vectors created with the
/// 'arm_sve_vector_bits' type attribute as VectorType.
QualType getSveEltType(const ASTContext &Ctx) const;

/// Types are partitioned into 3 broad categories (C99 6.2.5p1):
/// object types, function types, and incomplete types.

/// Return true if this is an incomplete type.
/// A type that can describe objects, but which lacks information needed to
/// determine its size (e.g. void, or a fwd declared struct). Clients of this
/// routine will need to determine if the size is actually required.
///
/// Def If non-null, and the type refers to some kind of declaration
/// that can be completed (such as a C struct, C++ class, or Objective-C
/// class), will be set to the declaration.
bool isIncompleteType(NamedDecl **Def = nullptr) const;

/// Return true if this is an incomplete or object
/// type, in other words, not a function type.
bool isIncompleteOrObjectType() const {
  return !isFunctionType();
}

/// Determine whether this type is an object type.
bool isObjectType() const {
  // C++ [basic.types]p8:
  //   An object type is a (possibly cv-qualified) type that is not a
  //   function type, not a reference type, and not a void type.
  return !isReferenceType() && !isFunctionType() && !isVoidType();
}

/// Return true if this is a literal type
/// (C++11 [basic.types]p10)
bool isLiteralType(const ASTContext &Ctx) const;

/// Determine if this type is a structural type, per C++20 [temp.param]p7.
bool isStructuralType() const;

/// Test if this type is a standard-layout type.
/// (C++0x [basic.type]p9)
bool isStandardLayoutType() const;

/// Helper methods to distinguish type categories. All type predicates
/// operate on the canonical type, ignoring typedefs and qualifiers.

/// Returns true if the type is a builtin type.
bool isBuiltinType() const;

/// Test for a particular builtin type.
bool isSpecificBuiltinType(unsigned K) const;

/// Test for a type which does not represent an actual type-system type but
/// is instead used as a placeholder for various convenient purposes within
/// Clang.  All such types are BuiltinTypes.
bool isPlaceholderType() const;
const BuiltinType *getAsPlaceholderType() const;

/// Test for a specific placeholder type.
bool isSpecificPlaceholderType(unsigned K) const;

/// Test for a placeholder type other than Overload; see
/// BuiltinType::isNonOverloadPlaceholderType.
bool isNonOverloadPlaceholderType() const;

/// isIntegerType() does *not* include complex integers (a GCC extension).
/// isComplexIntegerType() can be used to test for complex integers.
bool isIntegerType() const;     // C99 6.2.5p17 (int, char, bool, enum)
bool isEnumeralType() const;

/// Determine whether this type is a scoped enumeration type.
bool isScopedEnumeralType() const;
bool isBooleanType() const;
bool isCharType() const;
bool isWideCharType() const;
bool isChar8Type() const;
bool isChar16Type() const;
bool isChar32Type() const;
bool isAnyCharacterType() const;
bool isIntegralType(const ASTContext &Ctx) const;

/// Determine whether this type is an integral or enumeration type.
bool isIntegralOrEnumerationType() const;

/// Determine whether this type is an integral or unscoped enumeration type.
bool isIntegralOrUnscopedEnumerationType() const;
bool isUnscopedEnumerationType() const;

/// Floating point categories.
bool isRealFloatingType() const; // C99 6.2.5p10 (float, double, long double)
/// isComplexType() does *not* include complex integers (a GCC extension).
/// isComplexIntegerType() can be used to test for complex integers.
bool isComplexType() const;      // C99 6.2.5p11 (complex)
bool isAnyComplexType() const;   // C99 6.2.5p11 (complex) + Complex Int.
bool isFloatingType() const;     // C99 6.2.5p11 (real floating + complex)
bool isHalfType() const;         // OpenCL 6.1.1.1, NEON (IEEE 754-2008 half)
bool isFloat16Type() const;      // C11 extension ISO/IEC TS 18661
bool isBFloat16Type() const;
bool isFloat128Type() const;
bool isRealType() const;         // C99 6.2.5p17 (real floating + integer)
bool isArithmeticType() const;   // C99 6.2.5p18 (integer + floating)
bool isVoidType() const;         // C99 6.2.5p19
bool isScalarType() const;       // C99 6.2.5p21 (arithmetic + pointers)
bool isAggregateType() const;
bool isFundamentalType() const;
bool isCompoundType() const;

// Type Predicates: Check to see if this type is structurally the specified
// type, ignoring typedefs and qualifiers.
bool isFunctionType() const;
bool isFunctionNoProtoType() const { return getAs<FunctionNoProtoType>(); }
bool isFunctionProtoType() const { return getAs<FunctionProtoType>(); }
bool isPointerType() const;
bool isAnyPointerType() const;   // Any C pointer or ObjC object pointer
bool isBlockPointerType() const;
bool isVoidPointerType() const;
bool isReferenceType() const;
bool isLValueReferenceType() const;
bool isRValueReferenceType() const;
bool isObjectPointerType() const;
bool isFunctionPointerType() const;
bool isFunctionReferenceType() const;
bool isMemberPointerType() const;
bool isMemberFunctionPointerType() const;
bool isMemberDataPointerType() const;
bool isArrayType() const;
bool isConstantArrayType() const;
bool isIncompleteArrayType() const;
bool isVariableArrayType() const;
bool isDependentSizedArrayType() const;
bool isRecordType() const;
bool isClassType() const;
bool isStructureType() const;
bool isObjCBoxableRecordType() const;
bool isInterfaceType() const;
bool isStructureOrClassType() const;
bool isUnionType() const;
bool isComplexIntegerType() const;            // GCC _Complex integer type.
bool isVectorType() const;                    // GCC vector type.
bool isExtVectorType() const;                 // Extended vector type.
bool isMatrixType() const;                    // Matrix type.
bool isConstantMatrixType() const;            // Constant matrix type.
bool isDependentAddressSpaceType() const;     // value-dependent address space qualifier
bool isObjCObjectPointerType() const;         // pointer to ObjC object
bool isObjCRetainableType() const;            // ObjC object or block pointer
bool isObjCLifetimeType() const;              // (array of)* retainable type
bool isObjCIndirectLifetimeType() const;      // (pointer to)* lifetime type
bool isObjCNSObjectType() const;              // __attribute__((NSObject))
bool isObjCIndependentClassType() const;      // __attribute__((objc_independent_class))
// FIXME: change this to 'raw' interface type, so we can used 'interface' type
// for the common case.
bool isObjCObjectType() const;                // NSString or typeof(*(id)0)
bool isObjCQualifiedInterfaceType() const;    // NSString<foo>
bool isObjCQualifiedIdType() const;           // id<foo>
bool isObjCQualifiedClassType() const;        // Class<foo>
bool isObjCObjectOrInterfaceType() const;
bool isObjCIdType() const;                    // id
bool isDecltypeType() const;
/// Was this type written with the special inert-in-ARC __unsafe_unretained
/// qualifier?
///
/// This approximates the answer to the following question: if this
/// translation unit were compiled in ARC, would this type be qualified
/// with __unsafe_unretained?
bool isObjCInertUnsafeUnretainedType() const {
  return hasAttr(attr::ObjCInertUnsafeUnretained);
}

/// Whether the type is Objective-C 'id' or a __kindof type of an
/// object type, e.g., __kindof NSView * or __kindof id
/// <NSCopying>.
///
/// \param bound Will be set to the bound on non-id subtype types,
/// which will be (possibly specialized) Objective-C class type, or
/// null for 'id.
bool isObjCIdOrObjectKindOfType(const ASTContext &ctx,
                                const ObjCObjectType *&bound) const;

bool isObjCClassType() const;                 // Class

/// Whether the type is Objective-C 'Class' or a __kindof type of an
/// Class type, e.g., __kindof Class <NSCopying>.
///
/// Unlike \c isObjCIdOrObjectKindOfType, there is no relevant bound
/// here because Objective-C's type system cannot express "a class
/// object for a subclass of NSFoo".
bool isObjCClassOrClassKindOfType() const;

bool isBlockCompatibleObjCPointerType(ASTContext &ctx) const;
bool isObjCSelType() const;                 // Class
bool isObjCBuiltinType() const;               // 'id' or 'Class'
bool isObjCARCBridgableType() const;
bool isCARCBridgableType() const;
bool isTemplateTypeParmType() const;          // C++ template type parameter
bool isNullPtrType() const;                   // C++11 std::nullptr_t
bool isNothrowT() const;                      // C++   std::nothrow_t
bool isAlignValT() const;                     // C++17 std::align_val_t
bool isStdByteType() const;                   // C++17 std::byte
bool isAtomicType() const;                    // C11 _Atomic()
bool isUndeducedAutoType() const;             // C++11 auto or
                                              // C++14 decltype(auto)
bool isTypedefNameType() const;               // typedef or alias template

2110#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
bool is##Id##Type() const;
2112#include "clang/Basic/OpenCLImageTypes.def"

bool isImageType() const;                     // Any OpenCL image type

bool isSamplerT() const;                      // OpenCL sampler_t
bool isEventT() const;                        // OpenCL event_t
bool isClkEventT() const;                     // OpenCL clk_event_t
bool isQueueT() const;                        // OpenCL queue_t
bool isReserveIDT() const;                    // OpenCL reserve_id_t

2122#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
bool is##Id##Type() const;
2124#include "clang/Basic/OpenCLExtensionTypes.def"
// Type defined in cl_intel_device_side_avc_motion_estimation OpenCL extension
bool isOCLIntelSubgroupAVCType() const;
bool isOCLExtOpaqueType() const;              // Any OpenCL extension type

bool isPipeType() const;                      // OpenCL pipe type
bool isExtIntType() const;                    // Extended Int Type
bool isOpenCLSpecificType() const;            // Any OpenCL specific type

/// Determines if this type, which must satisfy
/// isObjCLifetimeType(), is implicitly __unsafe_unretained rather
/// than implicitly __strong.
bool isObjCARCImplicitlyUnretainedType() const;

/// Check if the type is the CUDA device builtin surface type.
bool isCUDADeviceBuiltinSurfaceType() const;
/// Check if the type is the CUDA device builtin texture type.
bool isCUDADeviceBuiltinTextureType() const;

/// Return the implicit lifetime for this type, which must not be dependent.
Qualifiers::ObjCLifetime getObjCARCImplicitLifetime() const;

enum ScalarTypeKind {
  STK_CPointer,
  STK_BlockPointer,
  STK_ObjCObjectPointer,
  STK_MemberPointer,
  STK_Bool,
  STK_Integral,
  STK_Floating,
  STK_IntegralComplex,
  STK_FloatingComplex,
  STK_FixedPoint
};

/// Given that this is a scalar type, classify it.
ScalarTypeKind getScalarTypeKind() const;

TypeDependence getDependence() const {
  return static_cast<TypeDependence>(TypeBits.Dependence);
}

/// Whether this type is an error type.
bool containsErrors() const {
  return getDependence() & TypeDependence::Error;
}

/// Whether this type is a dependent type, meaning that its definition
/// somehow depends on a template parameter (C++ [temp.dep.type]).
bool isDependentType() const {
  return getDependence() & TypeDependence::Dependent;
}

/// Determine whether this type is an instantiation-dependent type,
/// meaning that the type involves a template parameter (even if the
/// definition does not actually depend on the type substituted for that
/// template parameter).
bool isInstantiationDependentType() const {
  return getDependence() & TypeDependence::Instantiation;
}

/// Determine whether this type is an undeduced type, meaning that
/// it somehow involves a C++11 'auto' type or similar which has not yet been
/// deduced.
bool isUndeducedType() const;

/// Whether this type is a variably-modified type (C99 6.7.5).
bool isVariablyModifiedType() const {
  return getDependence() & TypeDependence::VariablyModified;
}

/// Whether this type involves a variable-length array type
/// with a definite size.
bool hasSizedVLAType() const;

/// Whether this type is or contains a local or unnamed type.
bool hasUnnamedOrLocalType() const;

bool isOverloadableType() const;

/// Determine wither this type is a C++ elaborated-type-specifier.
bool isElaboratedTypeSpecifier() const;

bool canDecayToPointerType() const;

/// Whether this type is represented natively as a pointer.  This includes
/// pointers, references, block pointers, and Objective-C interface,
/// qualified id, and qualified interface types, as well as nullptr_t.
bool hasPointerRepresentation() const;

/// Whether this type can represent an objective pointer type for the
/// purpose of GC'ability
bool hasObjCPointerRepresentation() const;

/// Determine whether this type has an integer representation
/// of some sort, e.g., it is an integer type or a vector.
bool hasIntegerRepresentation() const;

/// Determine whether this type has an signed integer representation
/// of some sort, e.g., it is an signed integer type or a vector.
bool hasSignedIntegerRepresentation() const;

/// Determine whether this type has an unsigned integer representation
/// of some sort, e.g., it is an unsigned integer type or a vector.
bool hasUnsignedIntegerRepresentation() const;

/// Determine whether this type has a floating-point representation
/// of some sort, e.g., it is a floating-point type or a vector thereof.
bool hasFloatingRepresentation() const;

// Type Checking Functions: Check to see if this type is structurally the
// specified type, ignoring typedefs and qualifiers, and return a pointer to
// the best type we can.
const RecordType *getAsStructureType() const;
/// NOTE: getAs*ArrayType are methods on ASTContext.
const RecordType *getAsUnionType() const;
const ComplexType *getAsComplexIntegerType() const; // GCC complex int type.
const ObjCObjectType *getAsObjCInterfaceType() const;

// The following is a convenience method that returns an ObjCObjectPointerType
// for object declared using an interface.
const ObjCObjectPointerType *getAsObjCInterfacePointerType() const;
const ObjCObjectPointerType *getAsObjCQualifiedIdType() const;
const ObjCObjectPointerType *getAsObjCQualifiedClassType() const;
const ObjCObjectType *getAsObjCQualifiedInterfaceType() const;

/// Retrieves the CXXRecordDecl that this type refers to, either
/// because the type is a RecordType or because it is the injected-class-name
/// type of a class template or class template partial specialization.
CXXRecordDecl *getAsCXXRecordDecl() const;

/// Retrieves the RecordDecl this type refers to.
RecordDecl *getAsRecordDecl() const;

/// Retrieves the TagDecl that this type refers to, either
/// because the type is a TagType or because it is the injected-class-name
/// type of a class template or class template partial specialization.
TagDecl *getAsTagDecl() const;

/// If this is a pointer or reference to a RecordType, return the
/// CXXRecordDecl that the type refers to.
///
/// If this is not a pointer or reference, or the type being pointed to does
/// not refer to a CXXRecordDecl, returns NULL.
const CXXRecordDecl *getPointeeCXXRecordDecl() const;

/// Get the DeducedType whose type will be deduced for a variable with
/// an initializer of this type. This looks through declarators like pointer
/// types, but not through decltype or typedefs.
DeducedType *getContainedDeducedType() const;

/// Get the AutoType whose type will be deduced for a variable with
/// an initializer of this type. This looks through declarators like pointer
/// types, but not through decltype or typedefs.
AutoType *getContainedAutoType() const {
  return dyn_cast_or_null<AutoType>(getContainedDeducedType());
}

/// Determine whether this type was written with a leading 'auto'
/// corresponding to a trailing return type (possibly for a nested
/// function type within a pointer to function type or similar).
bool hasAutoForTrailingReturnType() const;

/// Member-template getAs<specific type>'.  Look through sugar for
/// an instance of \<specific type>.   This scheme will eventually
/// replace the specific getAsXXXX methods above.
///
/// There are some specializations of this member template listed
/// immediately following this class.
template <typename T> const T *getAs() const;

/// Member-template getAsAdjusted<specific type>. Look through specific kinds
/// of sugar (parens, attributes, etc) for an instance of \<specific type>.
/// This is used when you need to walk over sugar nodes that represent some
/// kind of type adjustment from a type that was written as a \<specific type>
/// to another type that is still canonically a \<specific type>.
template <typename T> const T *getAsAdjusted() const;

/// A variant of getAs<> for array types which silently discards
/// qualifiers from the outermost type.
const ArrayType *getAsArrayTypeUnsafe() const;

/// Member-template castAs<specific type>.  Look through sugar for
/// the underlying instance of \<specific type>.
///
/// This method has the same relationship to getAs<T> as cast<T> has
/// to dyn_cast<T>; which is to say, the underlying type *must*
/// have the intended type, and this method will never return null.
template <typename T> const T *castAs() const;

/// A variant of castAs<> for array type which silently discards
/// qualifiers from the outermost type.
const ArrayType *castAsArrayTypeUnsafe() const;

/// Determine whether this type had the specified attribute applied to it
/// (looking through top-level type sugar).
bool hasAttr(attr::Kind AK) const;

/// Get the base element type of this type, potentially discarding type
/// qualifiers.  This should never be used when type qualifiers
/// are meaningful.
const Type *getBaseElementTypeUnsafe() const;

/// If this is an array type, return the element type of the array,
/// potentially with type qualifiers missing.
/// This should never be used when type qualifiers are meaningful.
const Type *getArrayElementTypeNoTypeQual() const;

/// If this is a pointer type, return the pointee type.
/// If this is an array type, return the array element type.
/// This should never be used when type qualifiers are meaningful.
const Type *getPointeeOrArrayElementType() const;

/// If this is a pointer, ObjC object pointer, or block
/// pointer, this returns the respective pointee.
QualType getPointeeType() const;

/// Return the specified type with any "sugar" removed from the type,
/// removing any typedefs, typeofs, etc., as well as any qualifiers.
const Type *getUnqualifiedDesugaredType() const;

/// More type predicates useful for type checking/promotion
bool isPromotableIntegerType() const; // C99 6.3.1.1p2

/// Return true if this is an integer type that is
/// signed, according to C99 6.2.5p4 [char, signed char, short, int, long..],
/// or an enum decl which has a signed representation.
bool isSignedIntegerType() const;

/// Return true if this is an integer type that is
/// unsigned, according to C99 6.2.5p6 [which returns true for _Bool],
/// or an enum decl which has an unsigned representation.
bool isUnsignedIntegerType() const;

/// Determines whether this is an integer type that is signed or an
/// enumeration types whose underlying type is a signed integer type.
bool isSignedIntegerOrEnumerationType() const;

/// Determines whether this is an integer type that is unsigned or an
/// enumeration types whose underlying type is a unsigned integer type.
bool isUnsignedIntegerOrEnumerationType() const;

/// Return true if this is a fixed point type according to
/// ISO/IEC JTC1 SC22 WG14 N1169.
bool isFixedPointType() const;

/// Return true if this is a fixed point or integer type.
bool isFixedPointOrIntegerType() const;

/// Return true if this is a saturated fixed point type according to
/// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
bool isSaturatedFixedPointType() const;

/// Return true if this is a saturated fixed point type according to
/// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
bool isUnsaturatedFixedPointType() const;

/// Return true if this is a fixed point type that is signed according
/// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
bool isSignedFixedPointType() const;

/// Return true if this is a fixed point type that is unsigned according
/// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
bool isUnsignedFixedPointType() const;

/// Return true if this is not a variable sized type,
/// according to the rules of C99 6.7.5p3.  It is not legal to call this on
/// incomplete types.
bool isConstantSizeType() const;

/// Returns true if this type can be represented by some
/// set of type specifiers.
bool isSpecifierType() const;

/// Determine the linkage of this type.
Linkage getLinkage() const;

/// Determine the visibility of this type.
Visibility getVisibility() const {
  return getLinkageAndVisibility().getVisibility();
}

/// Return true if the visibility was explicitly set is the code.
bool isVisibilityExplicit() const {
  return getLinkageAndVisibility().isVisibilityExplicit();
}

/// Determine the linkage and visibility of this type.
LinkageInfo getLinkageAndVisibility() const;

/// True if the computed linkage is valid. Used for consistency
/// checking. Should always return true.
bool isLinkageValid() const;

/// Determine the nullability of the given type.
///
/// Note that nullability is only captured as sugar within the type
/// system, not as part of the canonical type, so nullability will
/// be lost by canonicalization and desugaring.
Optional<NullabilityKind> getNullability(const ASTContext &context) const;

/// Determine whether the given type can have a nullability
/// specifier applied to it, i.e., if it is any kind of pointer type.
///
/// \param ResultIfUnknown The value to return if we don't yet know whether
///        this type can have nullability because it is dependent.
bool canHaveNullability(bool ResultIfUnknown = true) const;

/// Retrieve the set of substitutions required when accessing a member
/// of the Objective-C receiver type that is declared in the given context.
///
/// \c *this is the type of the object we're operating on, e.g., the
/// receiver for a message send or the base of a property access, and is
/// expected to be of some object or object pointer type.
///
/// \param dc The declaration context for which we are building up a
/// substitution mapping, which should be an Objective-C class, extension,
/// category, or method within.
///
/// \returns an array of type arguments that can be substituted for
/// the type parameters of the given declaration context in any type described
/// within that context, or an empty optional to indicate that no
/// substitution is required.
Optional<ArrayRef<QualType>>
getObjCSubstitutions(const DeclContext *dc) const;

/// Determines if this is an ObjC interface type that may accept type
/// parameters.
bool acceptsObjCTypeParams() const;

const char *getTypeClassName() const;

QualType getCanonicalTypeInternal() const {
  return CanonicalType;
}

CanQualType getCanonicalTypeUnqualified() const; // in CanonicalType.h
void dump() const;
void dump(llvm::raw_ostream &OS, const ASTContext &Context) const;
2463};

2465/// This will check for a TypedefType by removing any existing sugar
2466/// until it reaches a TypedefType or a non-sugared type.
2467template <> const TypedefType *Type::getAs() const;

2469/// This will check for a TemplateSpecializationType by removing any
2470/// existing sugar until it reaches a TemplateSpecializationType or a
2471/// non-sugared type.
2472template <> const TemplateSpecializationType *Type::getAs() const;

2474/// This will check for an AttributedType by removing any existing sugar
2475/// until it reaches an AttributedType or a non-sugared type.
2476template <> const AttributedType *Type::getAs() const;

2478// We can do canonical leaf types faster, because we don't have to
2479// worry about preserving child type decoration.
2480#define TYPE(Class, Base)
2481#define LEAF_TYPE(Class) \
2482template <> inline const Class##Type *Type::getAs() const { \
return dyn_cast<Class##Type>(CanonicalType); \
2484} \
2485template <> inline const Class##Type *Type::castAs() const { \
return cast<Class##Type>(CanonicalType); \
2487}
2488#include "clang/AST/TypeNodes.inc"

2490/// This class is used for builtin types like 'int'.  Builtin
2491/// types are always canonical and have a literal name field.
2492class BuiltinType : public Type {
2493public:
enum Kind {
2495// OpenCL image types
2496#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) Id,
2497#include "clang/Basic/OpenCLImageTypes.def"
2498// OpenCL extension types
2499#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) Id,
2500#include "clang/Basic/OpenCLExtensionTypes.def"
2501// SVE Types
2502#define SVE_TYPE(Name, Id, SingletonId) Id,
2503#include "clang/Basic/AArch64SVEACLETypes.def"
2504// PPC MMA Types
2505#define PPC_VECTOR_TYPE(Name, Id, Size) Id,
2506#include "clang/Basic/PPCTypes.def"
2507// RVV Types
2508#define RVV_TYPE(Name, Id, SingletonId) Id,
2509#include "clang/Basic/RISCVVTypes.def"
2510// All other builtin types
2511#define BUILTIN_TYPE(Id, SingletonId) Id,
2512#define LAST_BUILTIN_TYPE(Id) LastKind = Id
2513#include "clang/AST/BuiltinTypes.def"
};

2516private:
friend class ASTContext; // ASTContext creates these.

BuiltinType(Kind K)
    : Type(Builtin, QualType(),
           K == Dependent ? TypeDependence::DependentInstantiation
                          : TypeDependence::None) {
  BuiltinTypeBits.Kind = K;
}

2526public:
Kind getKind() const { return static_cast<Kind>(BuiltinTypeBits.Kind); }
StringRef getName(const PrintingPolicy &Policy) const;

const char *getNameAsCString(const PrintingPolicy &Policy) const {
  // The StringRef is null-terminated.
  StringRef str = getName(Policy);
  assert(!str.empty() && str.data()[str.size()] == '\0')(static_cast<void> (0));
  return str.data();
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

bool isInteger() const {
  return getKind() >= Bool && getKind() <= Int128;
}

bool isSignedInteger() const {
  return getKind() >= Char_S && getKind() <= Int128;
}

bool isUnsignedInteger() const {
  return getKind() >= Bool && getKind() <= UInt128;
}

bool isFloatingPoint() const {
  return getKind() >= Half && getKind() <= Float128;
}

/// Determines whether the given kind corresponds to a placeholder type.
static bool isPlaceholderTypeKind(Kind K) {
  return K >= Overload;
}

/// Determines whether this type is a placeholder type, i.e. a type
/// which cannot appear in arbitrary positions in a fully-formed
/// expression.
bool isPlaceholderType() const {
  return isPlaceholderTypeKind(getKind());
}

/// Determines whether this type is a placeholder type other than
/// Overload.  Most placeholder types require only syntactic
/// information about their context in order to be resolved (e.g.
/// whether it is a call expression), which means they can (and
/// should) be resolved in an earlier "phase" of analysis.
/// Overload expressions sometimes pick up further information
/// from their context, like whether the context expects a
/// specific function-pointer type, and so frequently need
/// special treatment.
bool isNonOverloadPlaceholderType() const {
  return getKind() > Overload;
}

static bool classof(const Type *T) { return T->getTypeClass() == Builtin; }
2582};

2584/// Complex values, per C99 6.2.5p11.  This supports the C99 complex
2585/// types (_Complex float etc) as well as the GCC integer complex extensions.
2586class ComplexType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType ElementType;

ComplexType(QualType Element, QualType CanonicalPtr)
    : Type(Complex, CanonicalPtr, Element->getDependence()),
      ElementType(Element) {}

2595public:
QualType getElementType() const { return ElementType; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getElementType());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Element) {
  ID.AddPointer(Element.getAsOpaquePtr());
}

static bool classof(const Type *T) { return T->getTypeClass() == Complex; }
2610};

2612/// Sugar for parentheses used when specifying types.
2613class ParenType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType Inner;

ParenType(QualType InnerType, QualType CanonType)
    : Type(Paren, CanonType, InnerType->getDependence()), Inner(InnerType) {}

2621public:
QualType getInnerType() const { return Inner; }

bool isSugared() const { return true; }
QualType desugar() const { return getInnerType(); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getInnerType());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Inner) {
  Inner.Profile(ID);
}

static bool classof(const Type *T) { return T->getTypeClass() == Paren; }
2636};

2638/// PointerType - C99 6.7.5.1 - Pointer Declarators.
2639class PointerType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType PointeeType;

PointerType(QualType Pointee, QualType CanonicalPtr)
    : Type(Pointer, CanonicalPtr, Pointee->getDependence()),
      PointeeType(Pointee) {}

2648public:
QualType getPointeeType() const { return PointeeType; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getPointeeType());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
  ID.AddPointer(Pointee.getAsOpaquePtr());
}

static bool classof(const Type *T) { return T->getTypeClass() == Pointer; }
2663};

2665/// Represents a type which was implicitly adjusted by the semantic
2666/// engine for arbitrary reasons.  For example, array and function types can
2667/// decay, and function types can have their calling conventions adjusted.
2668class AdjustedType : public Type, public llvm::FoldingSetNode {
QualType OriginalTy;
QualType AdjustedTy;

2672protected:
friend class ASTContext; // ASTContext creates these.

AdjustedType(TypeClass TC, QualType OriginalTy, QualType AdjustedTy,
             QualType CanonicalPtr)
    : Type(TC, CanonicalPtr, OriginalTy->getDependence()),
      OriginalTy(OriginalTy), AdjustedTy(AdjustedTy) {}

2680public:
QualType getOriginalType() const { return OriginalTy; }
QualType getAdjustedType() const { return AdjustedTy; }

bool isSugared() const { return true; }
QualType desugar() const { return AdjustedTy; }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, OriginalTy, AdjustedTy);
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Orig, QualType New) {
  ID.AddPointer(Orig.getAsOpaquePtr());
  ID.AddPointer(New.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == Adjusted || T->getTypeClass() == Decayed;
}
2699};

2701/// Represents a pointer type decayed from an array or function type.
2702class DecayedType : public AdjustedType {
friend class ASTContext; // ASTContext creates these.

inline
DecayedType(QualType OriginalType, QualType Decayed, QualType Canonical);

2708public:
QualType getDecayedType() const { return getAdjustedType(); }

inline QualType getPointeeType() const;

static bool classof(const Type *T) { return T->getTypeClass() == Decayed; }
2714};

2716/// Pointer to a block type.
2717/// This type is to represent types syntactically represented as
2718/// "void (^)(int)", etc. Pointee is required to always be a function type.
2719class BlockPointerType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

// Block is some kind of pointer type
QualType PointeeType;

BlockPointerType(QualType Pointee, QualType CanonicalCls)
    : Type(BlockPointer, CanonicalCls, Pointee->getDependence()),
      PointeeType(Pointee) {}

2729public:
// Get the pointee type. Pointee is required to always be a function type.
QualType getPointeeType() const { return PointeeType; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
    Profile(ID, getPointeeType());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
    ID.AddPointer(Pointee.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == BlockPointer;
}
2747};

2749/// Base for LValueReferenceType and RValueReferenceType
2750class ReferenceType : public Type, public llvm::FoldingSetNode {
QualType PointeeType;

2753protected:
ReferenceType(TypeClass tc, QualType Referencee, QualType CanonicalRef,
              bool SpelledAsLValue)
    : Type(tc, CanonicalRef, Referencee->getDependence()),
      PointeeType(Referencee) {
  ReferenceTypeBits.SpelledAsLValue = SpelledAsLValue;
  ReferenceTypeBits.InnerRef = Referencee->isReferenceType();
}

2762public:
bool isSpelledAsLValue() const { return ReferenceTypeBits.SpelledAsLValue; }
bool isInnerRef() const { return ReferenceTypeBits.InnerRef; }

QualType getPointeeTypeAsWritten() const { return PointeeType; }

QualType getPointeeType() const {
  // FIXME: this might strip inner qualifiers; okay?
  const ReferenceType *T = this;
  while (T->isInnerRef())
    T = T->PointeeType->castAs<ReferenceType>();
  return T->PointeeType;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, PointeeType, isSpelledAsLValue());
}

static void Profile(llvm::FoldingSetNodeID &ID,
                    QualType Referencee,
                    bool SpelledAsLValue) {
  ID.AddPointer(Referencee.getAsOpaquePtr());
  ID.AddBoolean(SpelledAsLValue);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == LValueReference ||
         T->getTypeClass() == RValueReference;
}
2791};

2793/// An lvalue reference type, per C++11 [dcl.ref].
2794class LValueReferenceType : public ReferenceType {
friend class ASTContext; // ASTContext creates these

LValueReferenceType(QualType Referencee, QualType CanonicalRef,
                    bool SpelledAsLValue)
    : ReferenceType(LValueReference, Referencee, CanonicalRef,
                    SpelledAsLValue) {}

2802public:
bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == LValueReference;
}
2809};

2811/// An rvalue reference type, per C++11 [dcl.ref].
2812class RValueReferenceType : public ReferenceType {
friend class ASTContext; // ASTContext creates these

RValueReferenceType(QualType Referencee, QualType CanonicalRef)
     : ReferenceType(RValueReference, Referencee, CanonicalRef, false) {}

2818public:
bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == RValueReference;
}
2825};

2827/// A pointer to member type per C++ 8.3.3 - Pointers to members.
2828///
2829/// This includes both pointers to data members and pointer to member functions.
2830class MemberPointerType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType PointeeType;

/// The class of which the pointee is a member. Must ultimately be a
/// RecordType, but could be a typedef or a template parameter too.
const Type *Class;

MemberPointerType(QualType Pointee, const Type *Cls, QualType CanonicalPtr)
    : Type(MemberPointer, CanonicalPtr,
           (Cls->getDependence() & ~TypeDependence::VariablyModified) |
               Pointee->getDependence()),
      PointeeType(Pointee), Class(Cls) {}

2845public:
QualType getPointeeType() const { return PointeeType; }

/// Returns true if the member type (i.e. the pointee type) is a
/// function type rather than a data-member type.
bool isMemberFunctionPointer() const {
  return PointeeType->isFunctionProtoType();
}

/// Returns true if the member type (i.e. the pointee type) is a
/// data type rather than a function type.
bool isMemberDataPointer() const {
  return !PointeeType->isFunctionProtoType();
}

const Type *getClass() const { return Class; }
CXXRecordDecl *getMostRecentCXXRecordDecl() const;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getPointeeType(), getClass());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee,
                    const Type *Class) {
  ID.AddPointer(Pointee.getAsOpaquePtr());
  ID.AddPointer(Class);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == MemberPointer;
}
2879};

2881/// Represents an array type, per C99 6.7.5.2 - Array Declarators.
2882class ArrayType : public Type, public llvm::FoldingSetNode {
2883public:
/// Capture whether this is a normal array (e.g. int X[4])
/// an array with a static size (e.g. int X[static 4]), or an array
/// with a star size (e.g. int X[*]).
/// 'static' is only allowed on function parameters.
enum ArraySizeModifier {
  Normal, Static, Star
};

2892private:
/// The element type of the array.
QualType ElementType;

2896protected:
friend class ASTContext; // ASTContext creates these.

ArrayType(TypeClass tc, QualType et, QualType can, ArraySizeModifier sm,
          unsigned tq, const Expr *sz = nullptr);

2902public:
QualType getElementType() const { return ElementType; }

ArraySizeModifier getSizeModifier() const {
  return ArraySizeModifier(ArrayTypeBits.SizeModifier);
}

Qualifiers getIndexTypeQualifiers() const {
  return Qualifiers::fromCVRMask(getIndexTypeCVRQualifiers());
}

unsigned getIndexTypeCVRQualifiers() const {
  return ArrayTypeBits.IndexTypeQuals;
}

static bool classof(const Type *T) {
  return T->getTypeClass() == ConstantArray ||
         T->getTypeClass() == VariableArray ||
         T->getTypeClass() == IncompleteArray ||
         T->getTypeClass() == DependentSizedArray;
}
2923};

2925/// Represents the canonical version of C arrays with a specified constant size.
2926/// For example, the canonical type for 'int A[4 + 4*100]' is a
2927/// ConstantArrayType where the element type is 'int' and the size is 404.
2928class ConstantArrayType final
  : public ArrayType,
    private llvm::TrailingObjects<ConstantArrayType, const Expr *> {
friend class ASTContext; // ASTContext creates these.
friend TrailingObjects;

llvm::APInt Size; // Allows us to unique the type.

ConstantArrayType(QualType et, QualType can, const llvm::APInt &size,
                  const Expr *sz, ArraySizeModifier sm, unsigned tq)
    : ArrayType(ConstantArray, et, can, sm, tq, sz), Size(size) {
  ConstantArrayTypeBits.HasStoredSizeExpr = sz != nullptr;
  if (ConstantArrayTypeBits.HasStoredSizeExpr) {
    assert(!can.isNull() && "canonical constant array should not have size")(static_cast<void> (0));
    *getTrailingObjects<const Expr*>() = sz;
  }
}

unsigned numTrailingObjects(OverloadToken<const Expr*>) const {
  return ConstantArrayTypeBits.HasStoredSizeExpr;
}

2950public:
const llvm::APInt &getSize() const { return Size; }
const Expr *getSizeExpr() const {
  return ConstantArrayTypeBits.HasStoredSizeExpr
             ? *getTrailingObjects<const Expr *>()
             : nullptr;
}
bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

/// Determine the number of bits required to address a member of
// an array with the given element type and number of elements.
static unsigned getNumAddressingBits(const ASTContext &Context,
                                     QualType ElementType,
                                     const llvm::APInt &NumElements);

/// Determine the maximum number of active bits that an array's size
/// can require, which limits the maximum size of the array.
static unsigned getMaxSizeBits(const ASTContext &Context);

void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx) {
  Profile(ID, Ctx, getElementType(), getSize(), getSizeExpr(),
          getSizeModifier(), getIndexTypeCVRQualifiers());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx,
                    QualType ET, const llvm::APInt &ArraySize,
                    const Expr *SizeExpr, ArraySizeModifier SizeMod,
                    unsigned TypeQuals);

static bool classof(const Type *T) {
  return T->getTypeClass() == ConstantArray;
}
2983};

2985/// Represents a C array with an unspecified size.  For example 'int A[]' has
2986/// an IncompleteArrayType where the element type is 'int' and the size is
2987/// unspecified.
2988class IncompleteArrayType : public ArrayType {
friend class ASTContext; // ASTContext creates these.

IncompleteArrayType(QualType et, QualType can,
                    ArraySizeModifier sm, unsigned tq)
    : ArrayType(IncompleteArray, et, can, sm, tq) {}

2995public:
friend class StmtIteratorBase;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == IncompleteArray;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getElementType(), getSizeModifier(),
          getIndexTypeCVRQualifiers());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType ET,
                    ArraySizeModifier SizeMod, unsigned TypeQuals) {
  ID.AddPointer(ET.getAsOpaquePtr());
  ID.AddInteger(SizeMod);
  ID.AddInteger(TypeQuals);
}
3016};

3018/// Represents a C array with a specified size that is not an
3019/// integer-constant-expression.  For example, 'int s[x+foo()]'.
3020/// Since the size expression is an arbitrary expression, we store it as such.
3021///
3022/// Note: VariableArrayType's aren't uniqued (since the expressions aren't) and
3023/// should not be: two lexically equivalent variable array types could mean
3024/// different things, for example, these variables do not have the same type
3025/// dynamically:
3026///
3027/// void foo(int x) {
3028///   int Y[x];
3029///   ++x;
3030///   int Z[x];
3031/// }
3032class VariableArrayType : public ArrayType {
friend class ASTContext; // ASTContext creates these.

/// An assignment-expression. VLA's are only permitted within
/// a function block.
Stmt *SizeExpr;

/// The range spanned by the left and right array brackets.
SourceRange Brackets;

VariableArrayType(QualType et, QualType can, Expr *e,
                  ArraySizeModifier sm, unsigned tq,
                  SourceRange brackets)
    : ArrayType(VariableArray, et, can, sm, tq, e),
      SizeExpr((Stmt*) e), Brackets(brackets) {}

3048public:
friend class StmtIteratorBase;

Expr *getSizeExpr() const {
  // We use C-style casts instead of cast<> here because we do not wish
  // to have a dependency of Type.h on Stmt.h/Expr.h.
  return (Expr*) SizeExpr;
}

SourceRange getBracketsRange() const { return Brackets; }
SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == VariableArray;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  llvm_unreachable("Cannot unique VariableArrayTypes.")__builtin_unreachable();
}
3071};

3073/// Represents an array type in C++ whose size is a value-dependent expression.
3074///
3075/// For example:
3076/// \code
3077/// template<typename T, int Size>
3078/// class array {
3079///   T data[Size];
3080/// };
3081/// \endcode
3082///
3083/// For these types, we won't actually know what the array bound is
3084/// until template instantiation occurs, at which point this will
3085/// become either a ConstantArrayType or a VariableArrayType.
3086class DependentSizedArrayType : public ArrayType {
friend class ASTContext; // ASTContext creates these.

const ASTContext &Context;

/// An assignment expression that will instantiate to the
/// size of the array.
///
/// The expression itself might be null, in which case the array
/// type will have its size deduced from an initializer.
Stmt *SizeExpr;

/// The range spanned by the left and right array brackets.
SourceRange Brackets;

DependentSizedArrayType(const ASTContext &Context, QualType et, QualType can,
                        Expr *e, ArraySizeModifier sm, unsigned tq,
                        SourceRange brackets);

3105public:
friend class StmtIteratorBase;

Expr *getSizeExpr() const {
  // We use C-style casts instead of cast<> here because we do not wish
  // to have a dependency of Type.h on Stmt.h/Expr.h.
  return (Expr*) SizeExpr;
}

SourceRange getBracketsRange() const { return Brackets; }
SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentSizedArray;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getElementType(),
          getSizeModifier(), getIndexTypeCVRQualifiers(), getSizeExpr());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    QualType ET, ArraySizeModifier SizeMod,
                    unsigned TypeQuals, Expr *E);
3133};

3135/// Represents an extended address space qualifier where the input address space
3136/// value is dependent. Non-dependent address spaces are not represented with a
3137/// special Type subclass; they are stored on an ExtQuals node as part of a QualType.
3138///
3139/// For example:
3140/// \code
3141/// template<typename T, int AddrSpace>
3142/// class AddressSpace {
3143///   typedef T __attribute__((address_space(AddrSpace))) type;
3144/// }
3145/// \endcode
3146class DependentAddressSpaceType : public Type, public llvm::FoldingSetNode {
friend class ASTContext;

const ASTContext &Context;
Expr *AddrSpaceExpr;
QualType PointeeType;
SourceLocation loc;

DependentAddressSpaceType(const ASTContext &Context, QualType PointeeType,
                          QualType can, Expr *AddrSpaceExpr,
                          SourceLocation loc);

3158public:
Expr *getAddrSpaceExpr() const { return AddrSpaceExpr; }
QualType getPointeeType() const { return PointeeType; }
SourceLocation getAttributeLoc() const { return loc; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentAddressSpace;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getPointeeType(), getAddrSpaceExpr());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    QualType PointeeType, Expr *AddrSpaceExpr);
3176};

3178/// Represents an extended vector type where either the type or size is
3179/// dependent.
3180///
3181/// For example:
3182/// \code
3183/// template<typename T, int Size>
3184/// class vector {
3185///   typedef T __attribute__((ext_vector_type(Size))) type;
3186/// }
3187/// \endcode
3188class DependentSizedExtVectorType : public Type, public llvm::FoldingSetNode {
friend class ASTContext;

const ASTContext &Context;
Expr *SizeExpr;

/// The element type of the array.
QualType ElementType;

SourceLocation loc;

DependentSizedExtVectorType(const ASTContext &Context, QualType ElementType,
                            QualType can, Expr *SizeExpr, SourceLocation loc);

3202public:
Expr *getSizeExpr() const { return SizeExpr; }
QualType getElementType() const { return ElementType; }
SourceLocation getAttributeLoc() const { return loc; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentSizedExtVector;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getElementType(), getSizeExpr());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    QualType ElementType, Expr *SizeExpr);
3220};


3223/// Represents a GCC generic vector type. This type is created using
3224/// __attribute__((vector_size(n)), where "n" specifies the vector size in
3225/// bytes; or from an Altivec __vector or vector declaration.
3226/// Since the constructor takes the number of vector elements, the
3227/// client is responsible for converting the size into the number of elements.
3228class VectorType : public Type, public llvm::FoldingSetNode {
3229public:
enum VectorKind {
  /// not a target-specific vector type
  GenericVector,

  /// is AltiVec vector
  AltiVecVector,

  /// is AltiVec 'vector Pixel'
  AltiVecPixel,

  /// is AltiVec 'vector bool ...'
  AltiVecBool,

  /// is ARM Neon vector
  NeonVector,

  /// is ARM Neon polynomial vector
  NeonPolyVector,

  /// is AArch64 SVE fixed-length data vector
  SveFixedLengthDataVector,

  /// is AArch64 SVE fixed-length predicate vector
  SveFixedLengthPredicateVector
};

3256protected:
friend class ASTContext; // ASTContext creates these.

/// The element type of the vector.
QualType ElementType;

VectorType(QualType vecType, unsigned nElements, QualType canonType,
           VectorKind vecKind);

VectorType(TypeClass tc, QualType vecType, unsigned nElements,
           QualType canonType, VectorKind vecKind);

3268public:
QualType getElementType() const { return ElementType; }
unsigned getNumElements() const { return VectorTypeBits.NumElements; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

VectorKind getVectorKind() const {
  return VectorKind(VectorTypeBits.VecKind);
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getElementType(), getNumElements(),
          getTypeClass(), getVectorKind());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType ElementType,
                    unsigned NumElements, TypeClass TypeClass,
                    VectorKind VecKind) {
  ID.AddPointer(ElementType.getAsOpaquePtr());
  ID.AddInteger(NumElements);
  ID.AddInteger(TypeClass);
  ID.AddInteger(VecKind);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == Vector || T->getTypeClass() == ExtVector;
}
3296};

3298/// Represents a vector type where either the type or size is dependent.
3299////
3300/// For example:
3301/// \code
3302/// template<typename T, int Size>
3303/// class vector {
3304///   typedef T __attribute__((vector_size(Size))) type;
3305/// }
3306/// \endcode
3307class DependentVectorType : public Type, public llvm::FoldingSetNode {
friend class ASTContext;

const ASTContext &Context;
QualType ElementType;
Expr *SizeExpr;
SourceLocation Loc;

DependentVectorType(const ASTContext &Context, QualType ElementType,
                         QualType CanonType, Expr *SizeExpr,
                         SourceLocation Loc, VectorType::VectorKind vecKind);

3319public:
Expr *getSizeExpr() const { return SizeExpr; }
QualType getElementType() const { return ElementType; }
SourceLocation getAttributeLoc() const { return Loc; }
VectorType::VectorKind getVectorKind() const {
  return VectorType::VectorKind(VectorTypeBits.VecKind);
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentVector;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getElementType(), getSizeExpr(), getVectorKind());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    QualType ElementType, const Expr *SizeExpr,
                    VectorType::VectorKind VecKind);
3341};

3343/// ExtVectorType - Extended vector type. This type is created using
3344/// __attribute__((ext_vector_type(n)), where "n" is the number of elements.
3345/// Unlike vector_size, ext_vector_type is only allowed on typedef's. This
3346/// class enables syntactic extensions, like Vector Components for accessing
3347/// points (as .xyzw), colors (as .rgba), and textures (modeled after OpenGL
3348/// Shading Language).
3349class ExtVectorType : public VectorType {
friend class ASTContext; // ASTContext creates these.

ExtVectorType(QualType vecType, unsigned nElements, QualType canonType)
    : VectorType(ExtVector, vecType, nElements, canonType, GenericVector) {}

3355public:
static int getPointAccessorIdx(char c) {
  switch (c) {
  default: return -1;
  case 'x': case 'r': return 0;
  case 'y': case 'g': return 1;
  case 'z': case 'b': return 2;
  case 'w': case 'a': return 3;
  }
}

static int getNumericAccessorIdx(char c) {
  switch (c) {
    default: return -1;
    case '0': return 0;
    case '1': return 1;
    case '2': return 2;
    case '3': return 3;
    case '4': return 4;
    case '5': return 5;
    case '6': return 6;
    case '7': return 7;
    case '8': return 8;
    case '9': return 9;
    case 'A':
    case 'a': return 10;
    case 'B':
    case 'b': return 11;
    case 'C':
    case 'c': return 12;
    case 'D':
    case 'd': return 13;
    case 'E':
    case 'e': return 14;
    case 'F':
    case 'f': return 15;
  }
}

static int getAccessorIdx(char c, bool isNumericAccessor) {
  if (isNumericAccessor)
    return getNumericAccessorIdx(c);
  else
    return getPointAccessorIdx(c);
}

bool isAccessorWithinNumElements(char c, bool isNumericAccessor) const {
  if (int idx = getAccessorIdx(c, isNumericAccessor)+1)
    return unsigned(idx-1) < getNumElements();
  return false;
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == ExtVector;
}
3413};

3415/// Represents a matrix type, as defined in the Matrix Types clang extensions.
3416/// __attribute__((matrix_type(rows, columns))), where "rows" specifies
3417/// number of rows and "columns" specifies the number of columns.
3418class MatrixType : public Type, public llvm::FoldingSetNode {
3419protected:
friend class ASTContext;

/// The element type of the matrix.
QualType ElementType;

MatrixType(QualType ElementTy, QualType CanonElementTy);

MatrixType(TypeClass TypeClass, QualType ElementTy, QualType CanonElementTy,
           const Expr *RowExpr = nullptr, const Expr *ColumnExpr = nullptr);

3430public:
/// Returns type of the elements being stored in the matrix
QualType getElementType() const { return ElementType; }

/// Valid elements types are the following:
/// * an integer type (as in C2x 6.2.5p19), but excluding enumerated types
///   and _Bool
/// * the standard floating types float or double
/// * a half-precision floating point type, if one is supported on the target
static bool isValidElementType(QualType T) {
  return T->isDependentType() ||
         (T->isRealType() && !T->isBooleanType() && !T->isEnumeralType());
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == ConstantMatrix ||
         T->getTypeClass() == DependentSizedMatrix;
}
3451};

3453/// Represents a concrete matrix type with constant number of rows and columns
3454class ConstantMatrixType final : public MatrixType {
3455protected:
friend class ASTContext;

/// Number of rows and columns.
unsigned NumRows;
unsigned NumColumns;

static constexpr unsigned MaxElementsPerDimension = (1 << 20) - 1;

ConstantMatrixType(QualType MatrixElementType, unsigned NRows,
                   unsigned NColumns, QualType CanonElementType);

ConstantMatrixType(TypeClass typeClass, QualType MatrixType, unsigned NRows,
                   unsigned NColumns, QualType CanonElementType);

3470public:
/// Returns the number of rows in the matrix.
unsigned getNumRows() const { return NumRows; }

/// Returns the number of columns in the matrix.
unsigned getNumColumns() const { return NumColumns; }

/// Returns the number of elements required to embed the matrix into a vector.
unsigned getNumElementsFlattened() const {
  return getNumRows() * getNumColumns();
}

/// Returns true if \p NumElements is a valid matrix dimension.
static constexpr bool isDimensionValid(size_t NumElements) {
  return NumElements > 0 && NumElements <= MaxElementsPerDimension;
}

/// Returns the maximum number of elements per dimension.
static constexpr unsigned getMaxElementsPerDimension() {
  return MaxElementsPerDimension;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getElementType(), getNumRows(), getNumColumns(),
          getTypeClass());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType ElementType,
                    unsigned NumRows, unsigned NumColumns,
                    TypeClass TypeClass) {
  ID.AddPointer(ElementType.getAsOpaquePtr());
  ID.AddInteger(NumRows);
  ID.AddInteger(NumColumns);
  ID.AddInteger(TypeClass);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == ConstantMatrix;
}
3509};

3511/// Represents a matrix type where the type and the number of rows and columns
3512/// is dependent on a template.
3513class DependentSizedMatrixType final : public MatrixType {
friend class ASTContext;

const ASTContext &Context;
Expr *RowExpr;
Expr *ColumnExpr;

SourceLocation loc;

DependentSizedMatrixType(const ASTContext &Context, QualType ElementType,
                         QualType CanonicalType, Expr *RowExpr,
                         Expr *ColumnExpr, SourceLocation loc);

3526public:
Expr *getRowExpr() const { return RowExpr; }
Expr *getColumnExpr() const { return ColumnExpr; }
SourceLocation getAttributeLoc() const { return loc; }

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentSizedMatrix;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getElementType(), getRowExpr(), getColumnExpr());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    QualType ElementType, Expr *RowExpr, Expr *ColumnExpr);
3541};

3543/// FunctionType - C99 6.7.5.3 - Function Declarators.  This is the common base
3544/// class of FunctionNoProtoType and FunctionProtoType.
3545class FunctionType : public Type {
// The type returned by the function.
QualType ResultType;

3549public:
/// Interesting information about a specific parameter that can't simply
/// be reflected in parameter's type. This is only used by FunctionProtoType
/// but is in FunctionType to make this class available during the
/// specification of the bases of FunctionProtoType.
///
/// It makes sense to model language features this way when there's some
/// sort of parameter-specific override (such as an attribute) that
/// affects how the function is called.  For example, the ARC ns_consumed
/// attribute changes whether a parameter is passed at +0 (the default)
/// or +1 (ns_consumed).  This must be reflected in the function type,
/// but isn't really a change to the parameter type.
///
/// One serious disadvantage of modelling language features this way is
/// that they generally do not work with language features that attempt
/// to destructure types.  For example, template argument deduction will
/// not be able to match a parameter declared as
///   T (*)(U)
/// against an argument of type
///   void (*)(__attribute__((ns_consumed)) id)
/// because the substitution of T=void, U=id into the former will
/// not produce the latter.
class ExtParameterInfo {
  enum {
    ABIMask = 0x0F,
    IsConsumed = 0x10,
    HasPassObjSize = 0x20,
    IsNoEscape = 0x40,
  };
  unsigned char Data = 0;

public:
  ExtParameterInfo() = default;

  /// Return the ABI treatment of this parameter.
  ParameterABI getABI() const { return ParameterABI(Data & ABIMask); }
  ExtParameterInfo withABI(ParameterABI kind) const {
    ExtParameterInfo copy = *this;
    copy.Data = (copy.Data & ~ABIMask) | unsigned(kind);
    return copy;
  }

  /// Is this parameter considered "consumed" by Objective-C ARC?
  /// Consumed parameters must have retainable object type.
  bool isConsumed() const { return (Data & IsConsumed); }
  ExtParameterInfo withIsConsumed(bool consumed) const {
    ExtParameterInfo copy = *this;
    if (consumed)
      copy.Data |= IsConsumed;
    else
      copy.Data &= ~IsConsumed;
    return copy;
  }

  bool hasPassObjectSize() const { return Data & HasPassObjSize; }
  ExtParameterInfo withHasPassObjectSize() const {
    ExtParameterInfo Copy = *this;
    Copy.Data |= HasPassObjSize;
    return Copy;
  }

  bool isNoEscape() const { return Data & IsNoEscape; }
  ExtParameterInfo withIsNoEscape(bool NoEscape) const {
    ExtParameterInfo Copy = *this;
    if (NoEscape)
      Copy.Data |= IsNoEscape;
    else
      Copy.Data &= ~IsNoEscape;
    return Copy;
  }

  unsigned char getOpaqueValue() const { return Data; }
  static ExtParameterInfo getFromOpaqueValue(unsigned char data) {
    ExtParameterInfo result;
    result.Data = data;
    return result;
  }

  friend bool operator==(ExtParameterInfo lhs, ExtParameterInfo rhs) {
    return lhs.Data == rhs.Data;
  }

  friend bool operator!=(ExtParameterInfo lhs, ExtParameterInfo rhs) {
    return lhs.Data != rhs.Data;
  }
};

/// A class which abstracts out some details necessary for
/// making a call.
///
/// It is not actually used directly for storing this information in
/// a FunctionType, although FunctionType does currently use the
/// same bit-pattern.
///
// If you add a field (say Foo), other than the obvious places (both,
// constructors, compile failures), what you need to update is
// * Operator==
// * getFoo
// * withFoo
// * functionType. Add Foo, getFoo.
// * ASTContext::getFooType
// * ASTContext::mergeFunctionTypes
// * FunctionNoProtoType::Profile
// * FunctionProtoType::Profile
// * TypePrinter::PrintFunctionProto
// * AST read and write
// * Codegen
class ExtInfo {
  friend class FunctionType;

  // Feel free to rearrange or add bits, but if you go over 16, you'll need to
  // adjust the Bits field below, and if you add bits, you'll need to adjust
  // Type::FunctionTypeBitfields::ExtInfo as well.

  // |  CC  |noreturn|produces|nocallersavedregs|regparm|nocfcheck|cmsenscall|
  // |0 .. 4|   5    |    6   |       7         |8 .. 10|    11   |    12    |
  //
  // regparm is either 0 (no regparm attribute) or the regparm value+1.
  enum { CallConvMask = 0x1F };
  enum { NoReturnMask = 0x20 };
  enum { ProducesResultMask = 0x40 };
  enum { NoCallerSavedRegsMask = 0x80 };
  enum {
    RegParmMask =  0x700,
    RegParmOffset = 8
  };
  enum { NoCfCheckMask = 0x800 };
  enum { CmseNSCallMask = 0x1000 };
  uint16_t Bits = CC_C;

  ExtInfo(unsigned Bits) : Bits(static_cast<uint16_t>(Bits)) {}

public:
  // Constructor with no defaults. Use this when you know that you
  // have all the elements (when reading an AST file for example).
  ExtInfo(bool noReturn, bool hasRegParm, unsigned regParm, CallingConv cc,
          bool producesResult, bool noCallerSavedRegs, bool NoCfCheck,
          bool cmseNSCall) {
    assert((!hasRegParm || regParm < 7) && "Invalid regparm value")(static_cast<void> (0));
    Bits = ((unsigned)cc) | (noReturn ? NoReturnMask : 0) |
           (producesResult ? ProducesResultMask : 0) |
           (noCallerSavedRegs ? NoCallerSavedRegsMask : 0) |
           (hasRegParm ? ((regParm + 1) << RegParmOffset) : 0) |
           (NoCfCheck ? NoCfCheckMask : 0) |
           (cmseNSCall ? CmseNSCallMask : 0);
  }

  // Constructor with all defaults. Use when for example creating a
  // function known to use defaults.
  ExtInfo() = default;

  // Constructor with just the calling convention, which is an important part
  // of the canonical type.
  ExtInfo(CallingConv CC) : Bits(CC) {}

  bool getNoReturn() const { return Bits & NoReturnMask; }
  bool getProducesResult() const { return Bits & ProducesResultMask; }
  bool getCmseNSCall() const { return Bits & CmseNSCallMask; }
  bool getNoCallerSavedRegs() const { return Bits & NoCallerSavedRegsMask; }
  bool getNoCfCheck() const { return Bits & NoCfCheckMask; }
  bool getHasRegParm() const { return ((Bits & RegParmMask) >> RegParmOffset) != 0; }

  unsigned getRegParm() const {
    unsigned RegParm = (Bits & RegParmMask) >> RegParmOffset;
    if (RegParm > 0)
      --RegParm;
    return RegParm;
  }

  CallingConv getCC() const { return CallingConv(Bits & CallConvMask); }

  bool operator==(ExtInfo Other) const {
    return Bits == Other.Bits;
  }
  bool operator!=(ExtInfo Other) const {
    return Bits != Other.Bits;
  }

  // Note that we don't have setters. That is by design, use
  // the following with methods instead of mutating these objects.

  ExtInfo withNoReturn(bool noReturn) const {
    if (noReturn)
      return ExtInfo(Bits | NoReturnMask);
    else
      return ExtInfo(Bits & ~NoReturnMask);
  }

  ExtInfo withProducesResult(bool producesResult) const {
    if (producesResult)
      return ExtInfo(Bits | ProducesResultMask);
    else
      return ExtInfo(Bits & ~ProducesResultMask);
  }

  ExtInfo withCmseNSCall(bool cmseNSCall) const {
    if (cmseNSCall)
      return ExtInfo(Bits | CmseNSCallMask);
    else
      return ExtInfo(Bits & ~CmseNSCallMask);
  }

  ExtInfo withNoCallerSavedRegs(bool noCallerSavedRegs) const {
    if (noCallerSavedRegs)
      return ExtInfo(Bits | NoCallerSavedRegsMask);
    else
      return ExtInfo(Bits & ~NoCallerSavedRegsMask);
  }

  ExtInfo withNoCfCheck(bool noCfCheck) const {
    if (noCfCheck)
      return ExtInfo(Bits | NoCfCheckMask);
    else
      return ExtInfo(Bits & ~NoCfCheckMask);
  }

  ExtInfo withRegParm(unsigned RegParm) const {
    assert(RegParm < 7 && "Invalid regparm value")(static_cast<void> (0));
    return ExtInfo((Bits & ~RegParmMask) |
                   ((RegParm + 1) << RegParmOffset));
  }

  ExtInfo withCallingConv(CallingConv cc) const {
    return ExtInfo((Bits & ~CallConvMask) | (unsigned) cc);
  }

  void Profile(llvm::FoldingSetNodeID &ID) const {
    ID.AddInteger(Bits);
  }
};

/// A simple holder for a QualType representing a type in an
/// exception specification. Unfortunately needed by FunctionProtoType
/// because TrailingObjects cannot handle repeated types.
struct ExceptionType { QualType Type; };

/// A simple holder for various uncommon bits which do not fit in
/// FunctionTypeBitfields. Aligned to alignof(void *) to maintain the
/// alignment of subsequent objects in TrailingObjects. You must update
/// hasExtraBitfields in FunctionProtoType after adding extra data here.
struct alignas(void *) FunctionTypeExtraBitfields {
  /// The number of types in the exception specification.
  /// A whole unsigned is not needed here and according to
  /// [implimits] 8 bits would be enough here.
  unsigned NumExceptionType;
};

3796protected:
FunctionType(TypeClass tc, QualType res, QualType Canonical,
             TypeDependence Dependence, ExtInfo Info)
    : Type(tc, Canonical, Dependence), ResultType(res) {
  FunctionTypeBits.ExtInfo = Info.Bits;
}

Qualifiers getFastTypeQuals() const {
  return Qualifiers::fromFastMask(FunctionTypeBits.FastTypeQuals);
}

3807public:
QualType getReturnType() const { return ResultType; }

bool getHasRegParm() const { return getExtInfo().getHasRegParm(); }
unsigned getRegParmType() const { return getExtInfo().getRegParm(); }

/// Determine whether this function type includes the GNU noreturn
/// attribute. The C++11 [[noreturn]] attribute does not affect the function
/// type.
bool getNoReturnAttr() const { return getExtInfo().getNoReturn(); }

bool getCmseNSCallAttr() const { return getExtInfo().getCmseNSCall(); }
CallingConv getCallConv() const { return getExtInfo().getCC(); }
ExtInfo getExtInfo() const { return ExtInfo(FunctionTypeBits.ExtInfo); }

static_assert((~Qualifiers::FastMask & Qualifiers::CVRMask) == 0,
              "Const, volatile and restrict are assumed to be a subset of "
              "the fast qualifiers.");

bool isConst() const { return getFastTypeQuals().hasConst(); }
bool isVolatile() const { return getFastTypeQuals().hasVolatile(); }
bool isRestrict() const { return getFastTypeQuals().hasRestrict(); }

/// Determine the type of an expression that calls a function of
/// this type.
QualType getCallResultType(const ASTContext &Context) const {
  return getReturnType().getNonLValueExprType(Context);
}

static StringRef getNameForCallConv(CallingConv CC);

static bool classof(const Type *T) {
  return T->getTypeClass() == FunctionNoProto ||
         T->getTypeClass() == FunctionProto;
}
3842};

3844/// Represents a K&R-style 'int foo()' function, which has
3845/// no information available about its arguments.
3846class FunctionNoProtoType : public FunctionType, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

FunctionNoProtoType(QualType Result, QualType Canonical, ExtInfo Info)
    : FunctionType(FunctionNoProto, Result, Canonical,
                   Result->getDependence() &
                       ~(TypeDependence::DependentInstantiation |
                         TypeDependence::UnexpandedPack),
                   Info) {}

3856public:
// No additional state past what FunctionType provides.

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getReturnType(), getExtInfo());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType ResultType,
                    ExtInfo Info) {
  Info.Profile(ID);
  ID.AddPointer(ResultType.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == FunctionNoProto;
}
3875};

3877/// Represents a prototype with parameter type info, e.g.
3878/// 'int foo(int)' or 'int foo(void)'.  'void' is represented as having no
3879/// parameters, not as having a single void parameter. Such a type can have
3880/// an exception specification, but this specification is not part of the
3881/// canonical type. FunctionProtoType has several trailing objects, some of
3882/// which optional. For more information about the trailing objects see
3883/// the first comment inside FunctionProtoType.
3884class FunctionProtoType final
  : public FunctionType,
    public llvm::FoldingSetNode,
    private llvm::TrailingObjects<
        FunctionProtoType, QualType, SourceLocation,
        FunctionType::FunctionTypeExtraBitfields, FunctionType::ExceptionType,
        Expr *, FunctionDecl *, FunctionType::ExtParameterInfo, Qualifiers> {
friend class ASTContext; // ASTContext creates these.
friend TrailingObjects;

// FunctionProtoType is followed by several trailing objects, some of
// which optional. They are in order:
//
// * An array of getNumParams() QualType holding the parameter types.
//   Always present. Note that for the vast majority of FunctionProtoType,
//   these will be the only trailing objects.
//
// * Optionally if the function is variadic, the SourceLocation of the
//   ellipsis.
//
// * Optionally if some extra data is stored in FunctionTypeExtraBitfields
//   (see FunctionTypeExtraBitfields and FunctionTypeBitfields):
//   a single FunctionTypeExtraBitfields. Present if and only if
//   hasExtraBitfields() is true.
//
// * Optionally exactly one of:
//   * an array of getNumExceptions() ExceptionType,
//   * a single Expr *,
//   * a pair of FunctionDecl *,
//   * a single FunctionDecl *
//   used to store information about the various types of exception
//   specification. See getExceptionSpecSize for the details.
//
// * Optionally an array of getNumParams() ExtParameterInfo holding
//   an ExtParameterInfo for each of the parameters. Present if and
//   only if hasExtParameterInfos() is true.
//
// * Optionally a Qualifiers object to represent extra qualifiers that can't
//   be represented by FunctionTypeBitfields.FastTypeQuals. Present if and only
//   if hasExtQualifiers() is true.
//
// The optional FunctionTypeExtraBitfields has to be before the data
// related to the exception specification since it contains the number
// of exception types.
//
// We put the ExtParameterInfos last.  If all were equal, it would make
// more sense to put these before the exception specification, because
// it's much easier to skip past them compared to the elaborate switch
// required to skip the exception specification.  However, all is not
// equal; ExtParameterInfos are used to model very uncommon features,
// and it's better not to burden the more common paths.

3936public:
/// Holds information about the various types of exception specification.
/// ExceptionSpecInfo is not stored as such in FunctionProtoType but is
/// used to group together the various bits of information about the
/// exception specification.
struct ExceptionSpecInfo {
  /// The kind of exception specification this is.
  ExceptionSpecificationType Type = EST_None;

  /// Explicitly-specified list of exception types.
  ArrayRef<QualType> Exceptions;

  /// Noexcept expression, if this is a computed noexcept specification.
  Expr *NoexceptExpr = nullptr;

  /// The function whose exception specification this is, for
  /// EST_Unevaluated and EST_Uninstantiated.
  FunctionDecl *SourceDecl = nullptr;

  /// The function template whose exception specification this is instantiated
  /// from, for EST_Uninstantiated.
  FunctionDecl *SourceTemplate = nullptr;

  ExceptionSpecInfo() = default;

  ExceptionSpecInfo(ExceptionSpecificationType EST) : Type(EST) {}
};

/// Extra information about a function prototype. ExtProtoInfo is not
/// stored as such in FunctionProtoType but is used to group together
/// the various bits of extra information about a function prototype.
struct ExtProtoInfo {
  FunctionType::ExtInfo ExtInfo;
  bool Variadic : 1;
  bool HasTrailingReturn : 1;
  Qualifiers TypeQuals;
  RefQualifierKind RefQualifier = RQ_None;
  ExceptionSpecInfo ExceptionSpec;
  const ExtParameterInfo *ExtParameterInfos = nullptr;
  SourceLocation EllipsisLoc;

  ExtProtoInfo() : Variadic(false), HasTrailingReturn(false) {}

  ExtProtoInfo(CallingConv CC)
      : ExtInfo(CC), Variadic(false), HasTrailingReturn(false) {}

  ExtProtoInfo withExceptionSpec(const ExceptionSpecInfo &ESI) {
    ExtProtoInfo Result(*this);
    Result.ExceptionSpec = ESI;
    return Result;
  }
};

3989private:
unsigned numTrailingObjects(OverloadToken<QualType>) const {
  return getNumParams();
}

unsigned numTrailingObjects(OverloadToken<SourceLocation>) const {
  return isVariadic();
}

unsigned numTrailingObjects(OverloadToken<FunctionTypeExtraBitfields>) const {
  return hasExtraBitfields();
}

unsigned numTrailingObjects(OverloadToken<ExceptionType>) const {
  return getExceptionSpecSize().NumExceptionType;
}

unsigned numTrailingObjects(OverloadToken<Expr *>) const {
  return getExceptionSpecSize().NumExprPtr;
}

unsigned numTrailingObjects(OverloadToken<FunctionDecl *>) const {
  return getExceptionSpecSize().NumFunctionDeclPtr;
}

unsigned numTrailingObjects(OverloadToken<ExtParameterInfo>) const {
  return hasExtParameterInfos() ? getNumParams() : 0;
}

/// Determine whether there are any argument types that
/// contain an unexpanded parameter pack.
static bool containsAnyUnexpandedParameterPack(const QualType *ArgArray,
                                               unsigned numArgs) {
  for (unsigned Idx = 0; Idx < numArgs; ++Idx)
    if (ArgArray[Idx]->containsUnexpandedParameterPack())
      return true;

  return false;
}

FunctionProtoType(QualType result, ArrayRef<QualType> params,
                  QualType canonical, const ExtProtoInfo &epi);

/// This struct is returned by getExceptionSpecSize and is used to
/// translate an ExceptionSpecificationType to the number and kind
/// of trailing objects related to the exception specification.
struct ExceptionSpecSizeHolder {
  unsigned NumExceptionType;
  unsigned NumExprPtr;
  unsigned NumFunctionDeclPtr;
};

/// Return the number and kind of trailing objects
/// related to the exception specification.
static ExceptionSpecSizeHolder
getExceptionSpecSize(ExceptionSpecificationType EST, unsigned NumExceptions) {
  switch (EST) {
  case EST_None:
  case EST_DynamicNone:
  case EST_MSAny:
  case EST_BasicNoexcept:
  case EST_Unparsed:
  case EST_NoThrow:
    return {0, 0, 0};

  case EST_Dynamic:
    return {NumExceptions, 0, 0};

  case EST_DependentNoexcept:
  case EST_NoexceptFalse:
  case EST_NoexceptTrue:
    return {0, 1, 0};

  case EST_Uninstantiated:
    return {0, 0, 2};

  case EST_Unevaluated:
    return {0, 0, 1};
  }
  llvm_unreachable("bad exception specification kind")__builtin_unreachable();
}

/// Return the number and kind of trailing objects
/// related to the exception specification.
ExceptionSpecSizeHolder getExceptionSpecSize() const {
  return getExceptionSpecSize(getExceptionSpecType(), getNumExceptions());
}

/// Whether the trailing FunctionTypeExtraBitfields is present.
static bool hasExtraBitfields(ExceptionSpecificationType EST) {
  // If the exception spec type is EST_Dynamic then we have > 0 exception
  // types and the exact number is stored in FunctionTypeExtraBitfields.
  return EST == EST_Dynamic;
}

/// Whether the trailing FunctionTypeExtraBitfields is present.
bool hasExtraBitfields() const {
  return hasExtraBitfields(getExceptionSpecType());
}

bool hasExtQualifiers() const {
  return FunctionTypeBits.HasExtQuals;
}

4093public:
unsigned getNumParams() const { return FunctionTypeBits.NumParams; }

QualType getParamType(unsigned i) const {
  assert(i < getNumParams() && "invalid parameter index")(static_cast<void> (0));
  return param_type_begin()[i];
}

ArrayRef<QualType> getParamTypes() const {
  return llvm::makeArrayRef(param_type_begin(), param_type_end());
}

ExtProtoInfo getExtProtoInfo() const {
  ExtProtoInfo EPI;
  EPI.ExtInfo = getExtInfo();
  EPI.Variadic = isVariadic();
  EPI.EllipsisLoc = getEllipsisLoc();
  EPI.HasTrailingReturn = hasTrailingReturn();
  EPI.ExceptionSpec = getExceptionSpecInfo();
  EPI.TypeQuals = getMethodQuals();
  EPI.RefQualifier = getRefQualifier();
  EPI.ExtParameterInfos = getExtParameterInfosOrNull();
  return EPI;
}

/// Get the kind of exception specification on this function.
ExceptionSpecificationType getExceptionSpecType() const {
  return static_cast<ExceptionSpecificationType>(
      FunctionTypeBits.ExceptionSpecType);
}

/// Return whether this function has any kind of exception spec.
bool hasExceptionSpec() const { return getExceptionSpecType() != EST_None; }

/// Return whether this function has a dynamic (throw) exception spec.
bool hasDynamicExceptionSpec() const {
  return isDynamicExceptionSpec(getExceptionSpecType());
}

/// Return whether this function has a noexcept exception spec.
bool hasNoexceptExceptionSpec() const {
  return isNoexceptExceptionSpec(getExceptionSpecType());
}

/// Return whether this function has a dependent exception spec.
bool hasDependentExceptionSpec() const;

/// Return whether this function has an instantiation-dependent exception
/// spec.
bool hasInstantiationDependentExceptionSpec() const;

/// Return all the available information about this type's exception spec.
ExceptionSpecInfo getExceptionSpecInfo() const {
  ExceptionSpecInfo Result;
  Result.Type = getExceptionSpecType();
  if (Result.Type == EST_Dynamic) {
    Result.Exceptions = exceptions();
  } else if (isComputedNoexcept(Result.Type)) {
    Result.NoexceptExpr = getNoexceptExpr();
  } else if (Result.Type == EST_Uninstantiated) {
    Result.SourceDecl = getExceptionSpecDecl();
    Result.SourceTemplate = getExceptionSpecTemplate();
  } else if (Result.Type == EST_Unevaluated) {
    Result.SourceDecl = getExceptionSpecDecl();
  }
  return Result;
}

/// Return the number of types in the exception specification.
unsigned getNumExceptions() const {
  return getExceptionSpecType() == EST_Dynamic
             ? getTrailingObjects<FunctionTypeExtraBitfields>()
                   ->NumExceptionType
             : 0;
}

/// Return the ith exception type, where 0 <= i < getNumExceptions().
QualType getExceptionType(unsigned i) const {
  assert(i < getNumExceptions() && "Invalid exception number!")(static_cast<void> (0));
  return exception_begin()[i];
}

/// Return the expression inside noexcept(expression), or a null pointer
/// if there is none (because the exception spec is not of this form).
Expr *getNoexceptExpr() const {
  if (!isComputedNoexcept(getExceptionSpecType()))
    return nullptr;
  return *getTrailingObjects<Expr *>();
}

/// If this function type has an exception specification which hasn't
/// been determined yet (either because it has not been evaluated or because
/// it has not been instantiated), this is the function whose exception
/// specification is represented by this type.
FunctionDecl *getExceptionSpecDecl() const {
  if (getExceptionSpecType() != EST_Uninstantiated &&
      getExceptionSpecType() != EST_Unevaluated)
    return nullptr;
  return getTrailingObjects<FunctionDecl *>()[0];
}

/// If this function type has an uninstantiated exception
/// specification, this is the function whose exception specification
/// should be instantiated to find the exception specification for
/// this type.
FunctionDecl *getExceptionSpecTemplate() const {
  if (getExceptionSpecType() != EST_Uninstantiated)
    return nullptr;
  return getTrailingObjects<FunctionDecl *>()[1];
}

/// Determine whether this function type has a non-throwing exception
/// specification.
CanThrowResult canThrow() const;

/// Determine whether this function type has a non-throwing exception
/// specification. If this depends on template arguments, returns
/// \c ResultIfDependent.
bool isNothrow(bool ResultIfDependent = false) const {
  return ResultIfDependent ? canThrow() != CT_Can : canThrow() == CT_Cannot;
}

/// Whether this function prototype is variadic.
bool isVariadic() const { return FunctionTypeBits.Variadic; }

SourceLocation getEllipsisLoc() const {
  return isVariadic() ? *getTrailingObjects<SourceLocation>()
                      : SourceLocation();
}

/// Determines whether this function prototype contains a
/// parameter pack at the end.
///
/// A function template whose last parameter is a parameter pack can be
/// called with an arbitrary number of arguments, much like a variadic
/// function.
bool isTemplateVariadic() const;

/// Whether this function prototype has a trailing return type.
bool hasTrailingReturn() const { return FunctionTypeBits.HasTrailingReturn; }

Qualifiers getMethodQuals() const {
  if (hasExtQualifiers())
    return *getTrailingObjects<Qualifiers>();
  else
    return getFastTypeQuals();
}

/// Retrieve the ref-qualifier associated with this function type.
RefQualifierKind getRefQualifier() const {
  return static_cast<RefQualifierKind>(FunctionTypeBits.RefQualifier);
}

using param_type_iterator = const QualType *;
using param_type_range = llvm::iterator_range<param_type_iterator>;

param_type_range param_types() const {
  return param_type_range(param_type_begin(), param_type_end());
}

param_type_iterator param_type_begin() const {
  return getTrailingObjects<QualType>();
}

param_type_iterator param_type_end() const {
  return param_type_begin() + getNumParams();
}

using exception_iterator = const QualType *;

ArrayRef<QualType> exceptions() const {
  return llvm::makeArrayRef(exception_begin(), exception_end());
}

exception_iterator exception_begin() const {
  return reinterpret_cast<exception_iterator>(
      getTrailingObjects<ExceptionType>());
}

exception_iterator exception_end() const {
  return exception_begin() + getNumExceptions();
}

/// Is there any interesting extra information for any of the parameters
/// of this function type?
bool hasExtParameterInfos() const {
  return FunctionTypeBits.HasExtParameterInfos;
}

ArrayRef<ExtParameterInfo> getExtParameterInfos() const {
  assert(hasExtParameterInfos())(static_cast<void> (0));
  return ArrayRef<ExtParameterInfo>(getTrailingObjects<ExtParameterInfo>(),
                                    getNumParams());
}

/// Return a pointer to the beginning of the array of extra parameter
/// information, if present, or else null if none of the parameters
/// carry it.  This is equivalent to getExtProtoInfo().ExtParameterInfos.
const ExtParameterInfo *getExtParameterInfosOrNull() const {
  if (!hasExtParameterInfos())
    return nullptr;
  return getTrailingObjects<ExtParameterInfo>();
}

ExtParameterInfo getExtParameterInfo(unsigned I) const {
  assert(I < getNumParams() && "parameter index out of range")(static_cast<void> (0));
  if (hasExtParameterInfos())
    return getTrailingObjects<ExtParameterInfo>()[I];
  return ExtParameterInfo();
}

ParameterABI getParameterABI(unsigned I) const {
  assert(I < getNumParams() && "parameter index out of range")(static_cast<void> (0));
  if (hasExtParameterInfos())
    return getTrailingObjects<ExtParameterInfo>()[I].getABI();
  return ParameterABI::Ordinary;
}

bool isParamConsumed(unsigned I) const {
  assert(I < getNumParams() && "parameter index out of range")(static_cast<void> (0));
  if (hasExtParameterInfos())
    return getTrailingObjects<ExtParameterInfo>()[I].isConsumed();
  return false;
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void printExceptionSpecification(raw_ostream &OS,
                                 const PrintingPolicy &Policy) const;

static bool classof(const Type *T) {
  return T->getTypeClass() == FunctionProto;
}

void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx);
static void Profile(llvm::FoldingSetNodeID &ID, QualType Result,
                    param_type_iterator ArgTys, unsigned NumArgs,
                    const ExtProtoInfo &EPI, const ASTContext &Context,
                    bool Canonical);
4333};

4335/// Represents the dependent type named by a dependently-scoped
4336/// typename using declaration, e.g.
4337///   using typename Base<T>::foo;
4338///
4339/// Template instantiation turns these into the underlying type.
4340class UnresolvedUsingType : public Type {
friend class ASTContext; // ASTContext creates these.

UnresolvedUsingTypenameDecl *Decl;

UnresolvedUsingType(const UnresolvedUsingTypenameDecl *D)
    : Type(UnresolvedUsing, QualType(),
           TypeDependence::DependentInstantiation),
      Decl(const_cast<UnresolvedUsingTypenameDecl *>(D)) {}

4350public:
UnresolvedUsingTypenameDecl *getDecl() const { return Decl; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == UnresolvedUsing;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  return Profile(ID, Decl);
}

static void Profile(llvm::FoldingSetNodeID &ID,
                    UnresolvedUsingTypenameDecl *D) {
  ID.AddPointer(D);
}
4368};

4370class TypedefType : public Type {
TypedefNameDecl *Decl;

4373private:
friend class ASTContext; // ASTContext creates these.

TypedefType(TypeClass tc, const TypedefNameDecl *D, QualType underlying,
            QualType can);

4379public:
TypedefNameDecl *getDecl() const { return Decl; }

bool isSugared() const { return true; }
QualType desugar() const;

static bool classof(const Type *T) { return T->getTypeClass() == Typedef; }
4386};

4388/// Sugar type that represents a type that was qualified by a qualifier written
4389/// as a macro invocation.
4390class MacroQualifiedType : public Type {
friend class ASTContext; // ASTContext creates these.

QualType UnderlyingTy;
const IdentifierInfo *MacroII;

MacroQualifiedType(QualType UnderlyingTy, QualType CanonTy,
                   const IdentifierInfo *MacroII)
    : Type(MacroQualified, CanonTy, UnderlyingTy->getDependence()),
      UnderlyingTy(UnderlyingTy), MacroII(MacroII) {
  assert(isa<AttributedType>(UnderlyingTy) &&(static_cast<void> (0))
         "Expected a macro qualified type to only wrap attributed types.")(static_cast<void> (0));
}

4404public:
const IdentifierInfo *getMacroIdentifier() const { return MacroII; }
QualType getUnderlyingType() const { return UnderlyingTy; }

/// Return this attributed type's modified type with no qualifiers attached to
/// it.
QualType getModifiedType() const;

bool isSugared() const { return true; }
QualType desugar() const;

static bool classof(const Type *T) {
  return T->getTypeClass() == MacroQualified;
}
4418};

4420/// Represents a `typeof` (or __typeof__) expression (a GCC extension).
4421class TypeOfExprType : public Type {
Expr *TOExpr;

4424protected:
friend class ASTContext; // ASTContext creates these.

TypeOfExprType(Expr *E, QualType can = QualType());

4429public:
Expr *getUnderlyingExpr() const { return TOExpr; }

/// Remove a single level of sugar.
QualType desugar() const;

/// Returns whether this type directly provides sugar.
bool isSugared() const;

static bool classof(const Type *T) { return T->getTypeClass() == TypeOfExpr; }
4439};

4441/// Internal representation of canonical, dependent
4442/// `typeof(expr)` types.
4443///
4444/// This class is used internally by the ASTContext to manage
4445/// canonical, dependent types, only. Clients will only see instances
4446/// of this class via TypeOfExprType nodes.
4447class DependentTypeOfExprType
: public TypeOfExprType, public llvm::FoldingSetNode {
const ASTContext &Context;

4451public:
DependentTypeOfExprType(const ASTContext &Context, Expr *E)
    : TypeOfExprType(E), Context(Context) {}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getUnderlyingExpr());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    Expr *E);
4461};

4463/// Represents `typeof(type)`, a GCC extension.
4464class TypeOfType : public Type {
friend class ASTContext; // ASTContext creates these.

QualType TOType;

TypeOfType(QualType T, QualType can)
    : Type(TypeOf, can, T->getDependence()), TOType(T) {
  assert(!isa<TypedefType>(can) && "Invalid canonical type")(static_cast<void> (0));
}

4474public:
QualType getUnderlyingType() const { return TOType; }

/// Remove a single level of sugar.
QualType desugar() const { return getUnderlyingType(); }

/// Returns whether this type directly provides sugar.
bool isSugared() const { return true; }

static bool classof(const Type *T) { return T->getTypeClass() == TypeOf; }
4484};

4486/// Represents the type `decltype(expr)` (C++11).
4487class DecltypeType : public Type {
Expr *E;
QualType UnderlyingType;

4491protected:
friend class ASTContext; // ASTContext creates these.

DecltypeType(Expr *E, QualType underlyingType, QualType can = QualType());

4496public:
Expr *getUnderlyingExpr() const { return E; }
QualType getUnderlyingType() const { return UnderlyingType; }

/// Remove a single level of sugar.
QualType desugar() const;

/// Returns whether this type directly provides sugar.
bool isSugared() const;

static bool classof(const Type *T) { return T->getTypeClass() == Decltype; }
4507};

4509/// Internal representation of canonical, dependent
4510/// decltype(expr) types.
4511///
4512/// This class is used internally by the ASTContext to manage
4513/// canonical, dependent types, only. Clients will only see instances
4514/// of this class via DecltypeType nodes.
4515class DependentDecltypeType : public DecltypeType, public llvm::FoldingSetNode {
const ASTContext &Context;

4518public:
DependentDecltypeType(const ASTContext &Context, Expr *E);

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, getUnderlyingExpr());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    Expr *E);
4527};

4529/// A unary type transform, which is a type constructed from another.
4530class UnaryTransformType : public Type {
4531public:
enum UTTKind {
  EnumUnderlyingType
};

4536private:
/// The untransformed type.
QualType BaseType;

/// The transformed type if not dependent, otherwise the same as BaseType.
QualType UnderlyingType;

UTTKind UKind;

4545protected:
friend class ASTContext;

UnaryTransformType(QualType BaseTy, QualType UnderlyingTy, UTTKind UKind,
                   QualType CanonicalTy);

4551public:
bool isSugared() const { return !isDependentType(); }
QualType desugar() const { return UnderlyingType; }

QualType getUnderlyingType() const { return UnderlyingType; }
QualType getBaseType() const { return BaseType; }

UTTKind getUTTKind() const { return UKind; }

static bool classof(const Type *T) {
  return T->getTypeClass() == UnaryTransform;
}
4563};

4565/// Internal representation of canonical, dependent
4566/// __underlying_type(type) types.
4567///
4568/// This class is used internally by the ASTContext to manage
4569/// canonical, dependent types, only. Clients will only see instances
4570/// of this class via UnaryTransformType nodes.
4571class DependentUnaryTransformType : public UnaryTransformType,
                                  public llvm::FoldingSetNode {
4573public:
DependentUnaryTransformType(const ASTContext &C, QualType BaseType,
                            UTTKind UKind);

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getBaseType(), getUTTKind());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType BaseType,
                    UTTKind UKind) {
  ID.AddPointer(BaseType.getAsOpaquePtr());
  ID.AddInteger((unsigned)UKind);
}
4586};

4588class TagType : public Type {
friend class ASTReader;
template <class T> friend class serialization::AbstractTypeReader;

/// Stores the TagDecl associated with this type. The decl may point to any
/// TagDecl that declares the entity.
TagDecl *decl;

4596protected:
TagType(TypeClass TC, const TagDecl *D, QualType can);

4599public:
TagDecl *getDecl() const;

/// Determines whether this type is in the process of being defined.
bool isBeingDefined() const;

static bool classof(const Type *T) {
  return T->getTypeClass() == Enum || T->getTypeClass() == Record;
}
4608};

4610/// A helper class that allows the use of isa/cast/dyncast
4611/// to detect TagType objects of structs/unions/classes.
4612class RecordType : public TagType {
4613protected:
friend class ASTContext; // ASTContext creates these.

explicit RecordType(const RecordDecl *D)
    : TagType(Record, reinterpret_cast<const TagDecl*>(D), QualType()) {}
explicit RecordType(TypeClass TC, RecordDecl *D)
    : TagType(TC, reinterpret_cast<const TagDecl*>(D), QualType()) {}

4621public:
RecordDecl *getDecl() const {
  return reinterpret_cast<RecordDecl*>(TagType::getDecl());
}

/// Recursively check all fields in the record for const-ness. If any field
/// is declared const, return true. Otherwise, return false.
bool hasConstFields() const;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) { return T->getTypeClass() == Record; }
4634};

4636/// A helper class that allows the use of isa/cast/dyncast
4637/// to detect TagType objects of enums.
4638class EnumType : public TagType {
friend class ASTContext; // ASTContext creates these.

explicit EnumType(const EnumDecl *D)
    : TagType(Enum, reinterpret_cast<const TagDecl*>(D), QualType()) {}

4644public:
EnumDecl *getDecl() const {
  return reinterpret_cast<EnumDecl*>(TagType::getDecl());
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) { return T->getTypeClass() == Enum; }
4653};

4655/// An attributed type is a type to which a type attribute has been applied.
4656///
4657/// The "modified type" is the fully-sugared type to which the attributed
4658/// type was applied; generally it is not canonically equivalent to the
4659/// attributed type. The "equivalent type" is the minimally-desugared type
4660/// which the type is canonically equivalent to.
4661///
4662/// For example, in the following attributed type:
4663///     int32_t __attribute__((vector_size(16)))
4664///   - the modified type is the TypedefType for int32_t
4665///   - the equivalent type is VectorType(16, int32_t)
4666///   - the canonical type is VectorType(16, int)
4667class AttributedType : public Type, public llvm::FoldingSetNode {
4668public:
using Kind = attr::Kind;

4671private:
friend class ASTContext; // ASTContext creates these

QualType ModifiedType;
QualType EquivalentType;

AttributedType(QualType canon, attr::Kind attrKind, QualType modified,
               QualType equivalent)
    : Type(Attributed, canon, equivalent->getDependence()),
      ModifiedType(modified), EquivalentType(equivalent) {
  AttributedTypeBits.AttrKind = attrKind;
}

4684public:
Kind getAttrKind() const {
  return static_cast<Kind>(AttributedTypeBits.AttrKind);
}

QualType getModifiedType() const { return ModifiedType; }
QualType getEquivalentType() const { return EquivalentType; }

bool isSugared() const { return true; }
QualType desugar() const { return getEquivalentType(); }

/// Does this attribute behave like a type qualifier?
///
/// A type qualifier adjusts a type to provide specialized rules for
/// a specific object, like the standard const and volatile qualifiers.
/// This includes attributes controlling things like nullability,
/// address spaces, and ARC ownership.  The value of the object is still
/// largely described by the modified type.
///
/// In contrast, many type attributes "rewrite" their modified type to
/// produce a fundamentally different type, not necessarily related in any
/// formalizable way to the original type.  For example, calling convention
/// and vector attributes are not simple type qualifiers.
///
/// Type qualifiers are often, but not always, reflected in the canonical
/// type.
bool isQualifier() const;

bool isMSTypeSpec() const;

bool isCallingConv() const;

llvm::Optional<NullabilityKind> getImmediateNullability() const;

/// Retrieve the attribute kind corresponding to the given
/// nullability kind.
static Kind getNullabilityAttrKind(NullabilityKind kind) {
  switch (kind) {
  case NullabilityKind::NonNull:
    return attr::TypeNonNull;

  case NullabilityKind::Nullable:
    return attr::TypeNullable;

  case NullabilityKind::NullableResult:
    return attr::TypeNullableResult;

  case NullabilityKind::Unspecified:
    return attr::TypeNullUnspecified;
  }
  llvm_unreachable("Unknown nullability kind.")__builtin_unreachable();
}

/// Strip off the top-level nullability annotation on the given
/// type, if it's there.
///
/// \param T The type to strip. If the type is exactly an
/// AttributedType specifying nullability (without looking through
/// type sugar), the nullability is returned and this type changed
/// to the underlying modified type.
///
/// \returns the top-level nullability, if present.
static Optional<NullabilityKind> stripOuterNullability(QualType &T);

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getAttrKind(), ModifiedType, EquivalentType);
}

static void Profile(llvm::FoldingSetNodeID &ID, Kind attrKind,
                    QualType modified, QualType equivalent) {
  ID.AddInteger(attrKind);
  ID.AddPointer(modified.getAsOpaquePtr());
  ID.AddPointer(equivalent.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == Attributed;
}
4762};

4764class TemplateTypeParmType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

// Helper data collector for canonical types.
struct CanonicalTTPTInfo {
  unsigned Depth : 15;
  unsigned ParameterPack : 1;
  unsigned Index : 16;
};

union {
  // Info for the canonical type.
  CanonicalTTPTInfo CanTTPTInfo;

  // Info for the non-canonical type.
  TemplateTypeParmDecl *TTPDecl;
};

/// Build a non-canonical type.
TemplateTypeParmType(TemplateTypeParmDecl *TTPDecl, QualType Canon)
    : Type(TemplateTypeParm, Canon,
           TypeDependence::DependentInstantiation |
               (Canon->getDependence() & TypeDependence::UnexpandedPack)),
      TTPDecl(TTPDecl) {}

/// Build the canonical type.
TemplateTypeParmType(unsigned D, unsigned I, bool PP)
    : Type(TemplateTypeParm, QualType(this, 0),
           TypeDependence::DependentInstantiation |
               (PP ? TypeDependence::UnexpandedPack : TypeDependence::None)) {
  CanTTPTInfo.Depth = D;
  CanTTPTInfo.Index = I;
  CanTTPTInfo.ParameterPack = PP;
}

const CanonicalTTPTInfo& getCanTTPTInfo() const {
  QualType Can = getCanonicalTypeInternal();
  return Can->castAs<TemplateTypeParmType>()->CanTTPTInfo;
}

4804public:
unsigned getDepth() const { return getCanTTPTInfo().Depth; }
unsigned getIndex() const { return getCanTTPTInfo().Index; }
bool isParameterPack() const { return getCanTTPTInfo().ParameterPack; }

TemplateTypeParmDecl *getDecl() const {
  return isCanonicalUnqualified() ? nullptr : TTPDecl;
}

IdentifierInfo *getIdentifier() const;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getDepth(), getIndex(), isParameterPack(), getDecl());
}

static void Profile(llvm::FoldingSetNodeID &ID, unsigned Depth,
                    unsigned Index, bool ParameterPack,
                    TemplateTypeParmDecl *TTPDecl) {
  ID.AddInteger(Depth);
  ID.AddInteger(Index);
  ID.AddBoolean(ParameterPack);
  ID.AddPointer(TTPDecl);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == TemplateTypeParm;
}
4834};

4836/// Represents the result of substituting a type for a template
4837/// type parameter.
4838///
4839/// Within an instantiated template, all template type parameters have
4840/// been replaced with these.  They are used solely to record that a
4841/// type was originally written as a template type parameter;
4842/// therefore they are never canonical.
4843class SubstTemplateTypeParmType : public Type, public llvm::FoldingSetNode {
friend class ASTContext;

// The original type parameter.
const TemplateTypeParmType *Replaced;

SubstTemplateTypeParmType(const TemplateTypeParmType *Param, QualType Canon)
    : Type(SubstTemplateTypeParm, Canon, Canon->getDependence()),
      Replaced(Param) {}

4853public:
/// Gets the template parameter that was substituted for.
const TemplateTypeParmType *getReplacedParameter() const {
  return Replaced;
}

/// Gets the type that was substituted for the template
/// parameter.
QualType getReplacementType() const {
  return getCanonicalTypeInternal();
}

bool isSugared() const { return true; }
QualType desugar() const { return getReplacementType(); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getReplacedParameter(), getReplacementType());
}

static void Profile(llvm::FoldingSetNodeID &ID,
                    const TemplateTypeParmType *Replaced,
                    QualType Replacement) {
  ID.AddPointer(Replaced);
  ID.AddPointer(Replacement.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == SubstTemplateTypeParm;
}
4882};

4884/// Represents the result of substituting a set of types for a template
4885/// type parameter pack.
4886///
4887/// When a pack expansion in the source code contains multiple parameter packs
4888/// and those parameter packs correspond to different levels of template
4889/// parameter lists, this type node is used to represent a template type
4890/// parameter pack from an outer level, which has already had its argument pack
4891/// substituted but that still lives within a pack expansion that itself
4892/// could not be instantiated. When actually performing a substitution into
4893/// that pack expansion (e.g., when all template parameters have corresponding
4894/// arguments), this type will be replaced with the \c SubstTemplateTypeParmType
4895/// at the current pack substitution index.
4896class SubstTemplateTypeParmPackType : public Type, public llvm::FoldingSetNode {
friend class ASTContext;

/// The original type parameter.
const TemplateTypeParmType *Replaced;

/// A pointer to the set of template arguments that this
/// parameter pack is instantiated with.
const TemplateArgument *Arguments;

SubstTemplateTypeParmPackType(const TemplateTypeParmType *Param,
                              QualType Canon,
                              const TemplateArgument &ArgPack);

4910public:
IdentifierInfo *getIdentifier() const { return Replaced->getIdentifier(); }

/// Gets the template parameter that was substituted for.
const TemplateTypeParmType *getReplacedParameter() const {
  return Replaced;
}

unsigned getNumArgs() const {
  return SubstTemplateTypeParmPackTypeBits.NumArgs;
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

TemplateArgument getArgumentPack() const;

void Profile(llvm::FoldingSetNodeID &ID);
static void Profile(llvm::FoldingSetNodeID &ID,
                    const TemplateTypeParmType *Replaced,
                    const TemplateArgument &ArgPack);

static bool classof(const Type *T) {
  return T->getTypeClass() == SubstTemplateTypeParmPack;
}
4935};

4937/// Common base class for placeholders for types that get replaced by
4938/// placeholder type deduction: C++11 auto, C++14 decltype(auto), C++17 deduced
4939/// class template types, and constrained type names.
4940///
4941/// These types are usually a placeholder for a deduced type. However, before
4942/// the initializer is attached, or (usually) if the initializer is
4943/// type-dependent, there is no deduced type and the type is canonical. In
4944/// the latter case, it is also a dependent type.
4945class DeducedType : public Type {
4946protected:
DeducedType(TypeClass TC, QualType DeducedAsType,
            TypeDependence ExtraDependence)
    : Type(TC,
           // FIXME: Retain the sugared deduced type?
           DeducedAsType.isNull() ? QualType(this, 0)
                                  : DeducedAsType.getCanonicalType(),
           ExtraDependence | (DeducedAsType.isNull()
                                  ? TypeDependence::None
                                  : DeducedAsType->getDependence() &
                                        ~TypeDependence::VariablyModified)) {}

4958public:
bool isSugared() const { return !isCanonicalUnqualified(); }
QualType desugar() const { return getCanonicalTypeInternal(); }

/// Get the type deduced for this placeholder type, or null if it's
/// either not been deduced or was deduced to a dependent type.
QualType getDeducedType() const {
  return !isCanonicalUnqualified() ? getCanonicalTypeInternal() : QualType();
}
bool isDeduced() const {
  return !isCanonicalUnqualified() || isDependentType();
}

static bool classof(const Type *T) {
  return T->getTypeClass() == Auto ||
         T->getTypeClass() == DeducedTemplateSpecialization;
}
4975};

4977/// Represents a C++11 auto or C++14 decltype(auto) type, possibly constrained
4978/// by a type-constraint.
4979class alignas(8) AutoType : public DeducedType, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

ConceptDecl *TypeConstraintConcept;

AutoType(QualType DeducedAsType, AutoTypeKeyword Keyword,
         TypeDependence ExtraDependence, ConceptDecl *CD,
         ArrayRef<TemplateArgument> TypeConstraintArgs);

const TemplateArgument *getArgBuffer() const {
  return reinterpret_cast<const TemplateArgument*>(this+1);
}

TemplateArgument *getArgBuffer() {
  return reinterpret_cast<TemplateArgument*>(this+1);
}

4996public:
/// Retrieve the template arguments.
const TemplateArgument *getArgs() const {
  return getArgBuffer();
}

/// Retrieve the number of template arguments.
unsigned getNumArgs() const {
  return AutoTypeBits.NumArgs;
}

const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h

ArrayRef<TemplateArgument> getTypeConstraintArguments() const {
  return {getArgs(), getNumArgs()};
}

ConceptDecl *getTypeConstraintConcept() const {
  return TypeConstraintConcept;
}

bool isConstrained() const {
  return TypeConstraintConcept != nullptr;
}

bool isDecltypeAuto() const {
  return getKeyword() == AutoTypeKeyword::DecltypeAuto;
}

AutoTypeKeyword getKeyword() const {
  return (AutoTypeKeyword)AutoTypeBits.Keyword;
}

void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context) {
  Profile(ID, Context, getDeducedType(), getKeyword(), isDependentType(),
          getTypeConstraintConcept(), getTypeConstraintArguments());
}

static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    QualType Deduced, AutoTypeKeyword Keyword,
                    bool IsDependent, ConceptDecl *CD,
                    ArrayRef<TemplateArgument> Arguments);

static bool classof(const Type *T) {
  return T->getTypeClass() == Auto;
}
5042};

5044/// Represents a C++17 deduced template specialization type.
5045class DeducedTemplateSpecializationType : public DeducedType,
                                        public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

/// The name of the template whose arguments will be deduced.
TemplateName Template;

DeducedTemplateSpecializationType(TemplateName Template,
                                  QualType DeducedAsType,
                                  bool IsDeducedAsDependent)
    : DeducedType(DeducedTemplateSpecialization, DeducedAsType,
                  toTypeDependence(Template.getDependence()) |
                      (IsDeducedAsDependent
                           ? TypeDependence::DependentInstantiation
                           : TypeDependence::None)),
      Template(Template) {}

5062public:
/// Retrieve the name of the template that we are deducing.
TemplateName getTemplateName() const { return Template;}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getTemplateName(), getDeducedType(), isDependentType());
}

static void Profile(llvm::FoldingSetNodeID &ID, TemplateName Template,
                    QualType Deduced, bool IsDependent) {
  Template.Profile(ID);
  ID.AddPointer(Deduced.getAsOpaquePtr());
  ID.AddBoolean(IsDependent);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == DeducedTemplateSpecialization;
}
5080};

5082/// Represents a type template specialization; the template
5083/// must be a class template, a type alias template, or a template
5084/// template parameter.  A template which cannot be resolved to one of
5085/// these, e.g. because it is written with a dependent scope
5086/// specifier, is instead represented as a
5087/// @c DependentTemplateSpecializationType.
5088///
5089/// A non-dependent template specialization type is always "sugar",
5090/// typically for a \c RecordType.  For example, a class template
5091/// specialization type of \c vector<int> will refer to a tag type for
5092/// the instantiation \c std::vector<int, std::allocator<int>>
5093///
5094/// Template specializations are dependent if either the template or
5095/// any of the template arguments are dependent, in which case the
5096/// type may also be canonical.
5097///
5098/// Instances of this type are allocated with a trailing array of
5099/// TemplateArguments, followed by a QualType representing the
5100/// non-canonical aliased type when the template is a type alias
5101/// template.
5102class alignas(8) TemplateSpecializationType
  : public Type,
    public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

/// The name of the template being specialized.  This is
/// either a TemplateName::Template (in which case it is a
/// ClassTemplateDecl*, a TemplateTemplateParmDecl*, or a
/// TypeAliasTemplateDecl*), a
/// TemplateName::SubstTemplateTemplateParmPack, or a
/// TemplateName::SubstTemplateTemplateParm (in which case the
/// replacement must, recursively, be one of these).
TemplateName Template;

TemplateSpecializationType(TemplateName T,
                           ArrayRef<TemplateArgument> Args,
                           QualType Canon,
                           QualType Aliased);

5121public:
/// Determine whether any of the given template arguments are dependent.
///
/// The converted arguments should be supplied when known; whether an
/// argument is dependent can depend on the conversions performed on it
/// (for example, a 'const int' passed as a template argument might be
/// dependent if the parameter is a reference but non-dependent if the
/// parameter is an int).
///
/// Note that the \p Args parameter is unused: this is intentional, to remind
/// the caller that they need to pass in the converted arguments, not the
/// specified arguments.
static bool
anyDependentTemplateArguments(ArrayRef<TemplateArgumentLoc> Args,
                              ArrayRef<TemplateArgument> Converted);
static bool
anyDependentTemplateArguments(const TemplateArgumentListInfo &,
                              ArrayRef<TemplateArgument> Converted);
static bool anyInstantiationDependentTemplateArguments(
    ArrayRef<TemplateArgumentLoc> Args);

/// True if this template specialization type matches a current
/// instantiation in the context in which it is found.
bool isCurrentInstantiation() const {
  return isa<InjectedClassNameType>(getCanonicalTypeInternal());
}

/// Determine if this template specialization type is for a type alias
/// template that has been substituted.
///
/// Nearly every template specialization type whose template is an alias
/// template will be substituted. However, this is not the case when
/// the specialization contains a pack expansion but the template alias
/// does not have a corresponding parameter pack, e.g.,
///
/// \code
/// template<typename T, typename U, typename V> struct S;
/// template<typename T, typename U> using A = S<T, int, U>;
/// template<typename... Ts> struct X {
///   typedef A<Ts...> type; // not a type alias
/// };
/// \endcode
bool isTypeAlias() const { return TemplateSpecializationTypeBits.TypeAlias; }

/// Get the aliased type, if this is a specialization of a type alias
/// template.
QualType getAliasedType() const {
  assert(isTypeAlias() && "not a type alias template specialization")(static_cast<void> (0));
  return *reinterpret_cast<const QualType*>(end());
}

using iterator = const TemplateArgument *;

iterator begin() const { return getArgs(); }
iterator end() const; // defined inline in TemplateBase.h

/// Retrieve the name of the template that we are specializing.
TemplateName getTemplateName() const { return Template; }

/// Retrieve the template arguments.
const TemplateArgument *getArgs() const {
  return reinterpret_cast<const TemplateArgument *>(this + 1);
}

/// Retrieve the number of template arguments.
unsigned getNumArgs() const {
  return TemplateSpecializationTypeBits.NumArgs;
}

/// Retrieve a specific template argument as a type.
/// \pre \c isArgType(Arg)
const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h

ArrayRef<TemplateArgument> template_arguments() const {
  return {getArgs(), getNumArgs()};
}

bool isSugared() const {
  return !isDependentType() || isCurrentInstantiation() || isTypeAlias();
}

QualType desugar() const {
  return isTypeAlias() ? getAliasedType() : getCanonicalTypeInternal();
}

void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx) {
  Profile(ID, Template, template_arguments(), Ctx);
  if (isTypeAlias())
    getAliasedType().Profile(ID);
}

static void Profile(llvm::FoldingSetNodeID &ID, TemplateName T,
                    ArrayRef<TemplateArgument> Args,
                    const ASTContext &Context);

static bool classof(const Type *T) {
  return T->getTypeClass() == TemplateSpecialization;
}
5219};

5221/// Print a template argument list, including the '<' and '>'
5222/// enclosing the template arguments.
5223void printTemplateArgumentList(raw_ostream &OS,
                             ArrayRef<TemplateArgument> Args,
                             const PrintingPolicy &Policy,
                             const TemplateParameterList *TPL = nullptr);

5228void printTemplateArgumentList(raw_ostream &OS,
                             ArrayRef<TemplateArgumentLoc> Args,
                             const PrintingPolicy &Policy,
                             const TemplateParameterList *TPL = nullptr);

5233void printTemplateArgumentList(raw_ostream &OS,
                             const TemplateArgumentListInfo &Args,
                             const PrintingPolicy &Policy,
                             const TemplateParameterList *TPL = nullptr);

5238/// The injected class name of a C++ class template or class
5239/// template partial specialization.  Used to record that a type was
5240/// spelled with a bare identifier rather than as a template-id; the
5241/// equivalent for non-templated classes is just RecordType.
5242///
5243/// Injected class name types are always dependent.  Template
5244/// instantiation turns these into RecordTypes.
5245///
5246/// Injected class name types are always canonical.  This works
5247/// because it is impossible to compare an injected class name type
5248/// with the corresponding non-injected template type, for the same
5249/// reason that it is impossible to directly compare template
5250/// parameters from different dependent contexts: injected class name
5251/// types can only occur within the scope of a particular templated
5252/// declaration, and within that scope every template specialization
5253/// will canonicalize to the injected class name (when appropriate
5254/// according to the rules of the language).
5255class InjectedClassNameType : public Type {
friend class ASTContext; // ASTContext creates these.
friend class ASTNodeImporter;
friend class ASTReader; // FIXME: ASTContext::getInjectedClassNameType is not
                        // currently suitable for AST reading, too much
                        // interdependencies.
template <class T> friend class serialization::AbstractTypeReader;

CXXRecordDecl *Decl;

/// The template specialization which this type represents.
/// For example, in
///   template <class T> class A { ... };
/// this is A<T>, whereas in
///   template <class X, class Y> class A<B<X,Y> > { ... };
/// this is A<B<X,Y> >.
///
/// It is always unqualified, always a template specialization type,
/// and always dependent.
QualType InjectedType;

InjectedClassNameType(CXXRecordDecl *D, QualType TST)
    : Type(InjectedClassName, QualType(),
           TypeDependence::DependentInstantiation),
      Decl(D), InjectedType(TST) {
  assert(isa<TemplateSpecializationType>(TST))(static_cast<void> (0));
  assert(!TST.hasQualifiers())(static_cast<void> (0));
  assert(TST->isDependentType())(static_cast<void> (0));
}

5285public:
QualType getInjectedSpecializationType() const { return InjectedType; }

const TemplateSpecializationType *getInjectedTST() const {
  return cast<TemplateSpecializationType>(InjectedType.getTypePtr());
}

TemplateName getTemplateName() const {
  return getInjectedTST()->getTemplateName();
}

CXXRecordDecl *getDecl() const;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == InjectedClassName;
}
5304};

5306/// The kind of a tag type.
5307enum TagTypeKind {
/// The "struct" keyword.
TTK_Struct,

/// The "__interface" keyword.
TTK_Interface,

/// The "union" keyword.
TTK_Union,

/// The "class" keyword.
TTK_Class,

/// The "enum" keyword.
TTK_Enum
5322};

5324/// The elaboration keyword that precedes a qualified type name or
5325/// introduces an elaborated-type-specifier.
5326enum ElaboratedTypeKeyword {
/// The "struct" keyword introduces the elaborated-type-specifier.
ETK_Struct,

/// The "__interface" keyword introduces the elaborated-type-specifier.
ETK_Interface,

/// The "union" keyword introduces the elaborated-type-specifier.
ETK_Union,

/// The "class" keyword introduces the elaborated-type-specifier.
ETK_Class,

/// The "enum" keyword introduces the elaborated-type-specifier.
ETK_Enum,

/// The "typename" keyword precedes the qualified type name, e.g.,
/// \c typename T::type.
ETK_Typename,

/// No keyword precedes the qualified type name.
ETK_None
5348};

5350/// A helper class for Type nodes having an ElaboratedTypeKeyword.
5351/// The keyword in stored in the free bits of the base class.
5352/// Also provides a few static helpers for converting and printing
5353/// elaborated type keyword and tag type kind enumerations.
5354class TypeWithKeyword : public Type {
5355protected:
TypeWithKeyword(ElaboratedTypeKeyword Keyword, TypeClass tc,
                QualType Canonical, TypeDependence Dependence)
    : Type(tc, Canonical, Dependence) {
  TypeWithKeywordBits.Keyword = Keyword;
}

5362public:
ElaboratedTypeKeyword getKeyword() const {
  return static_cast<ElaboratedTypeKeyword>(TypeWithKeywordBits.Keyword);
}

/// Converts a type specifier (DeclSpec::TST) into an elaborated type keyword.
static ElaboratedTypeKeyword getKeywordForTypeSpec(unsigned TypeSpec);

/// Converts a type specifier (DeclSpec::TST) into a tag type kind.
/// It is an error to provide a type specifier which *isn't* a tag kind here.
static TagTypeKind getTagTypeKindForTypeSpec(unsigned TypeSpec);

/// Converts a TagTypeKind into an elaborated type keyword.
static ElaboratedTypeKeyword getKeywordForTagTypeKind(TagTypeKind Tag);

/// Converts an elaborated type keyword into a TagTypeKind.
/// It is an error to provide an elaborated type keyword
/// which *isn't* a tag kind here.
static TagTypeKind getTagTypeKindForKeyword(ElaboratedTypeKeyword Keyword);

static bool KeywordIsTagTypeKind(ElaboratedTypeKeyword Keyword);

static StringRef getKeywordName(ElaboratedTypeKeyword Keyword);

static StringRef getTagTypeKindName(TagTypeKind Kind) {
  return getKeywordName(getKeywordForTagTypeKind(Kind));
}

class CannotCastToThisType {};
static CannotCastToThisType classof(const Type *);
5392};

5394/// Represents a type that was referred to using an elaborated type
5395/// keyword, e.g., struct S, or via a qualified name, e.g., N::M::type,
5396/// or both.
5397///
5398/// This type is used to keep track of a type name as written in the
5399/// source code, including tag keywords and any nested-name-specifiers.
5400/// The type itself is always "sugar", used to express what was written
5401/// in the source code but containing no additional semantic information.
5402class ElaboratedType final
  : public TypeWithKeyword,
    public llvm::FoldingSetNode,
    private llvm::TrailingObjects<ElaboratedType, TagDecl *> {
friend class ASTContext; // ASTContext creates these
friend TrailingObjects;

/// The nested name specifier containing the qualifier.
NestedNameSpecifier *NNS;

/// The type that this qualified name refers to.
QualType NamedType;

/// The (re)declaration of this tag type owned by this occurrence is stored
/// as a trailing object if there is one. Use getOwnedTagDecl to obtain
/// it, or obtain a null pointer if there is none.

ElaboratedType(ElaboratedTypeKeyword Keyword, NestedNameSpecifier *NNS,
               QualType NamedType, QualType CanonType, TagDecl *OwnedTagDecl)
    : TypeWithKeyword(Keyword, Elaborated, CanonType,
                      // Any semantic dependence on the qualifier will have
                      // been incorporated into NamedType. We still need to
                      // track syntactic (instantiation / error / pack)
                      // dependence on the qualifier.
                      NamedType->getDependence() |
                          (NNS ? toSyntacticDependence(
                                     toTypeDependence(NNS->getDependence()))
                               : TypeDependence::None)),
      NNS(NNS), NamedType(NamedType) {
  ElaboratedTypeBits.HasOwnedTagDecl = false;
  if (OwnedTagDecl) {
    ElaboratedTypeBits.HasOwnedTagDecl = true;
    *getTrailingObjects<TagDecl *>() = OwnedTagDecl;
  }
  assert(!(Keyword == ETK_None && NNS == nullptr) &&(static_cast<void> (0))
         "ElaboratedType cannot have elaborated type keyword "(static_cast<void> (0))
         "and name qualifier both null.")(static_cast<void> (0));
}

5441public:
/// Retrieve the qualification on this type.
NestedNameSpecifier *getQualifier() const { return NNS; }

/// Retrieve the type named by the qualified-id.
QualType getNamedType() const { return NamedType; }

/// Remove a single level of sugar.
QualType desugar() const { return getNamedType(); }

/// Returns whether this type directly provides sugar.
bool isSugared() const { return true; }

/// Return the (re)declaration of this type owned by this occurrence of this
/// type, or nullptr if there is none.
TagDecl *getOwnedTagDecl() const {
  return ElaboratedTypeBits.HasOwnedTagDecl ? *getTrailingObjects<TagDecl *>()
                                            : nullptr;
}

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getKeyword(), NNS, NamedType, getOwnedTagDecl());
}

static void Profile(llvm::FoldingSetNodeID &ID, ElaboratedTypeKeyword Keyword,
                    NestedNameSpecifier *NNS, QualType NamedType,
                    TagDecl *OwnedTagDecl) {
  ID.AddInteger(Keyword);
  ID.AddPointer(NNS);
  NamedType.Profile(ID);
  ID.AddPointer(OwnedTagDecl);
}

static bool classof(const Type *T) { return T->getTypeClass() == Elaborated; }
5475};

5477/// Represents a qualified type name for which the type name is
5478/// dependent.
5479///
5480/// DependentNameType represents a class of dependent types that involve a
5481/// possibly dependent nested-name-specifier (e.g., "T::") followed by a
5482/// name of a type. The DependentNameType may start with a "typename" (for a
5483/// typename-specifier), "class", "struct", "union", or "enum" (for a
5484/// dependent elaborated-type-specifier), or nothing (in contexts where we
5485/// know that we must be referring to a type, e.g., in a base class specifier).
5486/// Typically the nested-name-specifier is dependent, but in MSVC compatibility
5487/// mode, this type is used with non-dependent names to delay name lookup until
5488/// instantiation.
5489class DependentNameType : public TypeWithKeyword, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

/// The nested name specifier containing the qualifier.
NestedNameSpecifier *NNS;

/// The type that this typename specifier refers to.
const IdentifierInfo *Name;

DependentNameType(ElaboratedTypeKeyword Keyword, NestedNameSpecifier *NNS,
                  const IdentifierInfo *Name, QualType CanonType)
    : TypeWithKeyword(Keyword, DependentName, CanonType,
                      TypeDependence::DependentInstantiation |
                          toTypeDependence(NNS->getDependence())),
      NNS(NNS), Name(Name) {}

5505public:
/// Retrieve the qualification on this type.
NestedNameSpecifier *getQualifier() const { return NNS; }

/// Retrieve the type named by the typename specifier as an identifier.
///
/// This routine will return a non-NULL identifier pointer when the
/// form of the original typename was terminated by an identifier,
/// e.g., "typename T::type".
const IdentifierInfo *getIdentifier() const {
  return Name;
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getKeyword(), NNS, Name);
}

static void Profile(llvm::FoldingSetNodeID &ID, ElaboratedTypeKeyword Keyword,
                    NestedNameSpecifier *NNS, const IdentifierInfo *Name) {
  ID.AddInteger(Keyword);
  ID.AddPointer(NNS);
  ID.AddPointer(Name);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentName;
}
5535};

5537/// Represents a template specialization type whose template cannot be
5538/// resolved, e.g.
5539///   A<T>::template B<T>
5540class alignas(8) DependentTemplateSpecializationType
  : public TypeWithKeyword,
    public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

/// The nested name specifier containing the qualifier.
NestedNameSpecifier *NNS;

/// The identifier of the template.
const IdentifierInfo *Name;

DependentTemplateSpecializationType(ElaboratedTypeKeyword Keyword,
                                    NestedNameSpecifier *NNS,
                                    const IdentifierInfo *Name,
                                    ArrayRef<TemplateArgument> Args,
                                    QualType Canon);

const TemplateArgument *getArgBuffer() const {
  return reinterpret_cast<const TemplateArgument*>(this+1);
}

TemplateArgument *getArgBuffer() {
  return reinterpret_cast<TemplateArgument*>(this+1);
}

5565public:
NestedNameSpecifier *getQualifier() const { return NNS; }
const IdentifierInfo *getIdentifier() const { return Name; }

/// Retrieve the template arguments.
const TemplateArgument *getArgs() const {
  return getArgBuffer();
}

/// Retrieve the number of template arguments.
unsigned getNumArgs() const {
  return DependentTemplateSpecializationTypeBits.NumArgs;
}

const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h

ArrayRef<TemplateArgument> template_arguments() const {
  return {getArgs(), getNumArgs()};
}

using iterator = const TemplateArgument *;

iterator begin() const { return getArgs(); }
iterator end() const; // inline in TemplateBase.h

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context) {
  Profile(ID, Context, getKeyword(), NNS, Name, {getArgs(), getNumArgs()});
}

static void Profile(llvm::FoldingSetNodeID &ID,
                    const ASTContext &Context,
                    ElaboratedTypeKeyword Keyword,
                    NestedNameSpecifier *Qualifier,
                    const IdentifierInfo *Name,
                    ArrayRef<TemplateArgument> Args);

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentTemplateSpecialization;
}
5607};

5609/// Represents a pack expansion of types.
5610///
5611/// Pack expansions are part of C++11 variadic templates. A pack
5612/// expansion contains a pattern, which itself contains one or more
5613/// "unexpanded" parameter packs. When instantiated, a pack expansion
5614/// produces a series of types, each instantiated from the pattern of
5615/// the expansion, where the Ith instantiation of the pattern uses the
5616/// Ith arguments bound to each of the unexpanded parameter packs. The
5617/// pack expansion is considered to "expand" these unexpanded
5618/// parameter packs.
5619///
5620/// \code
5621/// template<typename ...Types> struct tuple;
5622///
5623/// template<typename ...Types>
5624/// struct tuple_of_references {
5625///   typedef tuple<Types&...> type;
5626/// };
5627/// \endcode
5628///
5629/// Here, the pack expansion \c Types&... is represented via a
5630/// PackExpansionType whose pattern is Types&.
5631class PackExpansionType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these

/// The pattern of the pack expansion.
QualType Pattern;

PackExpansionType(QualType Pattern, QualType Canon,
                  Optional<unsigned> NumExpansions)
    : Type(PackExpansion, Canon,
           (Pattern->getDependence() | TypeDependence::Dependent |
            TypeDependence::Instantiation) &
               ~TypeDependence::UnexpandedPack),
      Pattern(Pattern) {
  PackExpansionTypeBits.NumExpansions =
      NumExpansions ? *NumExpansions + 1 : 0;
}

5648public:
/// Retrieve the pattern of this pack expansion, which is the
/// type that will be repeatedly instantiated when instantiating the
/// pack expansion itself.
QualType getPattern() const { return Pattern; }

/// Retrieve the number of expansions that this pack expansion will
/// generate, if known.
Optional<unsigned> getNumExpansions() const {
  if (PackExpansionTypeBits.NumExpansions)
    return PackExpansionTypeBits.NumExpansions - 1;
  return None;
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getPattern(), getNumExpansions());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType Pattern,
                    Optional<unsigned> NumExpansions) {
  ID.AddPointer(Pattern.getAsOpaquePtr());
  ID.AddBoolean(NumExpansions.hasValue());
  if (NumExpansions)
    ID.AddInteger(*NumExpansions);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == PackExpansion;
}
5680};

5682/// This class wraps the list of protocol qualifiers. For types that can
5683/// take ObjC protocol qualifers, they can subclass this class.
5684template <class T>
5685class ObjCProtocolQualifiers {
5686protected:
ObjCProtocolQualifiers() = default;

ObjCProtocolDecl * const *getProtocolStorage() const {
  return const_cast<ObjCProtocolQualifiers*>(this)->getProtocolStorage();
}

ObjCProtocolDecl **getProtocolStorage() {
  return static_cast<T*>(this)->getProtocolStorageImpl();
}

void setNumProtocols(unsigned N) {
  static_cast<T*>(this)->setNumProtocolsImpl(N);
}

void initialize(ArrayRef<ObjCProtocolDecl *> protocols) {
  setNumProtocols(protocols.size());
  assert(getNumProtocols() == protocols.size() &&(static_cast<void> (0))
         "bitfield overflow in protocol count")(static_cast<void> (0));
  if (!protocols.empty())
    memcpy(getProtocolStorage(), protocols.data(),
           protocols.size() * sizeof(ObjCProtocolDecl*));
}

5710public:
using qual_iterator = ObjCProtocolDecl * const *;
using qual_range = llvm::iterator_range<qual_iterator>;

qual_range quals() const { return qual_range(qual_begin(), qual_end()); }
qual_iterator qual_begin() const { return getProtocolStorage(); }
qual_iterator qual_end() const { return qual_begin() + getNumProtocols(); }

bool qual_empty() const { return getNumProtocols() == 0; }

/// Return the number of qualifying protocols in this type, or 0 if
/// there are none.
unsigned getNumProtocols() const {
  return static_cast<const T*>(this)->getNumProtocolsImpl();
}

/// Fetch a protocol by index.
ObjCProtocolDecl *getProtocol(unsigned I) const {
  assert(I < getNumProtocols() && "Out-of-range protocol access")(static_cast<void> (0));
  return qual_begin()[I];
}

/// Retrieve all of the protocol qualifiers.
ArrayRef<ObjCProtocolDecl *> getProtocols() const {
  return ArrayRef<ObjCProtocolDecl *>(qual_begin(), getNumProtocols());
}
5736};

5738/// Represents a type parameter type in Objective C. It can take
5739/// a list of protocols.
5740class ObjCTypeParamType : public Type,
                        public ObjCProtocolQualifiers<ObjCTypeParamType>,
                        public llvm::FoldingSetNode {
friend class ASTContext;
friend class ObjCProtocolQualifiers<ObjCTypeParamType>;

/// The number of protocols stored on this type.
unsigned NumProtocols : 6;

ObjCTypeParamDecl *OTPDecl;

/// The protocols are stored after the ObjCTypeParamType node. In the
/// canonical type, the list of protocols are sorted alphabetically
/// and uniqued.
ObjCProtocolDecl **getProtocolStorageImpl();

/// Return the number of qualifying protocols in this interface type,
/// or 0 if there are none.
unsigned getNumProtocolsImpl() const {
  return NumProtocols;
}

void setNumProtocolsImpl(unsigned N) {
  NumProtocols = N;
}

ObjCTypeParamType(const ObjCTypeParamDecl *D,
                  QualType can,
                  ArrayRef<ObjCProtocolDecl *> protocols);

5770public:
bool isSugared() const { return true; }
QualType desugar() const { return getCanonicalTypeInternal(); }

static bool classof(const Type *T) {
  return T->getTypeClass() == ObjCTypeParam;
}

void Profile(llvm::FoldingSetNodeID &ID);
static void Profile(llvm::FoldingSetNodeID &ID,
                    const ObjCTypeParamDecl *OTPDecl,
                    QualType CanonicalType,
                    ArrayRef<ObjCProtocolDecl *> protocols);

ObjCTypeParamDecl *getDecl() const { return OTPDecl; }
5785};

5787/// Represents a class type in Objective C.
5788///
5789/// Every Objective C type is a combination of a base type, a set of
5790/// type arguments (optional, for parameterized classes) and a list of
5791/// protocols.
5792///
5793/// Given the following declarations:
5794/// \code
5795///   \@class C<T>;
5796///   \@protocol P;
5797/// \endcode
5798///
5799/// 'C' is an ObjCInterfaceType C.  It is sugar for an ObjCObjectType
5800/// with base C and no protocols.
5801///
5802/// 'C<P>' is an unspecialized ObjCObjectType with base C and protocol list [P].
5803/// 'C<C*>' is a specialized ObjCObjectType with type arguments 'C*' and no
5804/// protocol list.
5805/// 'C<C*><P>' is a specialized ObjCObjectType with base C, type arguments 'C*',
5806/// and protocol list [P].
5807///
5808/// 'id' is a TypedefType which is sugar for an ObjCObjectPointerType whose
5809/// pointee is an ObjCObjectType with base BuiltinType::ObjCIdType
5810/// and no protocols.
5811///
5812/// 'id<P>' is an ObjCObjectPointerType whose pointee is an ObjCObjectType
5813/// with base BuiltinType::ObjCIdType and protocol list [P].  Eventually
5814/// this should get its own sugar class to better represent the source.
5815class ObjCObjectType : public Type,
                     public ObjCProtocolQualifiers<ObjCObjectType> {
friend class ObjCProtocolQualifiers<ObjCObjectType>;

// ObjCObjectType.NumTypeArgs - the number of type arguments stored
// after the ObjCObjectPointerType node.
// ObjCObjectType.NumProtocols - the number of protocols stored
// after the type arguments of ObjCObjectPointerType node.
//
// These protocols are those written directly on the type.  If
// protocol qualifiers ever become additive, the iterators will need
// to get kindof complicated.
//
// In the canonical object type, these are sorted alphabetically
// and uniqued.

/// Either a BuiltinType or an InterfaceType or sugar for either.
QualType BaseType;

/// Cached superclass type.
mutable llvm::PointerIntPair<const ObjCObjectType *, 1, bool>
  CachedSuperClassType;

QualType *getTypeArgStorage();
const QualType *getTypeArgStorage() const {
  return const_cast<ObjCObjectType *>(this)->getTypeArgStorage();
}

ObjCProtocolDecl **getProtocolStorageImpl();
/// Return the number of qualifying protocols in this interface type,
/// or 0 if there are none.
unsigned getNumProtocolsImpl() const {
  return ObjCObjectTypeBits.NumProtocols;
}
void setNumProtocolsImpl(unsigned N) {
  ObjCObjectTypeBits.NumProtocols = N;
}

5853protected:
enum Nonce_ObjCInterface { Nonce_ObjCInterface };

ObjCObjectType(QualType Canonical, QualType Base,
               ArrayRef<QualType> typeArgs,
               ArrayRef<ObjCProtocolDecl *> protocols,
               bool isKindOf);

ObjCObjectType(enum Nonce_ObjCInterface)
    : Type(ObjCInterface, QualType(), TypeDependence::None),
      BaseType(QualType(this_(), 0)) {
  ObjCObjectTypeBits.NumProtocols = 0;
  ObjCObjectTypeBits.NumTypeArgs = 0;
  ObjCObjectTypeBits.IsKindOf = 0;
}

void computeSuperClassTypeSlow() const;

5871public:
/// Gets the base type of this object type.  This is always (possibly
/// sugar for) one of:
///  - the 'id' builtin type (as opposed to the 'id' type visible to the
///    user, which is a typedef for an ObjCObjectPointerType)
///  - the 'Class' builtin type (same caveat)
///  - an ObjCObjectType (currently always an ObjCInterfaceType)
QualType getBaseType() const { return BaseType; }

bool isObjCId() const {
  return getBaseType()->isSpecificBuiltinType(BuiltinType::ObjCId);
}

bool isObjCClass() const {
  return getBaseType()->isSpecificBuiltinType(BuiltinType::ObjCClass);
}

bool isObjCUnqualifiedId() const { return qual_empty() && isObjCId(); }
bool isObjCUnqualifiedClass() const { return qual_empty() && isObjCClass(); }
bool isObjCUnqualifiedIdOrClass() const {
  if (!qual_empty()) return false;
  if (const BuiltinType *T = getBaseType()->getAs<BuiltinType>())
    return T->getKind() == BuiltinType::ObjCId ||
           T->getKind() == BuiltinType::ObjCClass;
  return false;
}
bool isObjCQualifiedId() const { return !qual_empty() && isObjCId(); }
bool isObjCQualifiedClass() const { return !qual_empty() && isObjCClass(); }

/// Gets the interface declaration for this object type, if the base type
/// really is an interface.
ObjCInterfaceDecl *getInterface() const;

/// Determine whether this object type is "specialized", meaning
/// that it has type arguments.
bool isSpecialized() const;

/// Determine whether this object type was written with type arguments.
bool isSpecializedAsWritten() const {
  return ObjCObjectTypeBits.NumTypeArgs > 0;
}

/// Determine whether this object type is "unspecialized", meaning
/// that it has no type arguments.
bool isUnspecialized() const { return !isSpecialized(); }

/// Determine whether this object type is "unspecialized" as
/// written, meaning that it has no type arguments.
bool isUnspecializedAsWritten() const { return !isSpecializedAsWritten(); }

/// Retrieve the type arguments of this object type (semantically).
ArrayRef<QualType> getTypeArgs() const;

/// Retrieve the type arguments of this object type as they were
/// written.
ArrayRef<QualType> getTypeArgsAsWritten() const {
  return llvm::makeArrayRef(getTypeArgStorage(),
                            ObjCObjectTypeBits.NumTypeArgs);
}

/// Whether this is a "__kindof" type as written.
bool isKindOfTypeAsWritten() const { return ObjCObjectTypeBits.IsKindOf; }

/// Whether this ia a "__kindof" type (semantically).
bool isKindOfType() const;

/// Retrieve the type of the superclass of this object type.
///
/// This operation substitutes any type arguments into the
/// superclass of the current class type, potentially producing a
/// specialization of the superclass type. Produces a null type if
/// there is no superclass.
QualType getSuperClassType() const {
  if (!CachedSuperClassType.getInt())
    computeSuperClassTypeSlow();

  assert(CachedSuperClassType.getInt() && "Superclass not set?")(static_cast<void> (0));
  return QualType(CachedSuperClassType.getPointer(), 0);
}

/// Strip off the Objective-C "kindof" type and (with it) any
/// protocol qualifiers.
QualType stripObjCKindOfTypeAndQuals(const ASTContext &ctx) const;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == ObjCObject ||
         T->getTypeClass() == ObjCInterface;
}
5962};

5964/// A class providing a concrete implementation
5965/// of ObjCObjectType, so as to not increase the footprint of
5966/// ObjCInterfaceType.  Code outside of ASTContext and the core type
5967/// system should not reference this type.
5968class ObjCObjectTypeImpl : public ObjCObjectType, public llvm::FoldingSetNode {
friend class ASTContext;

// If anyone adds fields here, ObjCObjectType::getProtocolStorage()
// will need to be modified.

ObjCObjectTypeImpl(QualType Canonical, QualType Base,
                   ArrayRef<QualType> typeArgs,
                   ArrayRef<ObjCProtocolDecl *> protocols,
                   bool isKindOf)
    : ObjCObjectType(Canonical, Base, typeArgs, protocols, isKindOf) {}

5980public:
void Profile(llvm::FoldingSetNodeID &ID);
static void Profile(llvm::FoldingSetNodeID &ID,
                    QualType Base,
                    ArrayRef<QualType> typeArgs,
                    ArrayRef<ObjCProtocolDecl *> protocols,
                    bool isKindOf);
5987};

5989inline QualType *ObjCObjectType::getTypeArgStorage() {
return reinterpret_cast<QualType *>(static_cast<ObjCObjectTypeImpl*>(this)+1);
5991}

5993inline ObjCProtocolDecl **ObjCObjectType::getProtocolStorageImpl() {
  return reinterpret_cast<ObjCProtocolDecl**>(
           getTypeArgStorage() + ObjCObjectTypeBits.NumTypeArgs);
5996}

5998inline ObjCProtocolDecl **ObjCTypeParamType::getProtocolStorageImpl() {
  return reinterpret_cast<ObjCProtocolDecl**>(
           static_cast<ObjCTypeParamType*>(this)+1);
6001}

6003/// Interfaces are the core concept in Objective-C for object oriented design.
6004/// They basically correspond to C++ classes.  There are two kinds of interface
6005/// types: normal interfaces like `NSString`, and qualified interfaces, which
6006/// are qualified with a protocol list like `NSString<NSCopyable, NSAmazing>`.
6007///
6008/// ObjCInterfaceType guarantees the following properties when considered
6009/// as a subtype of its superclass, ObjCObjectType:
6010///   - There are no protocol qualifiers.  To reinforce this, code which
6011///     tries to invoke the protocol methods via an ObjCInterfaceType will
6012///     fail to compile.
6013///   - It is its own base type.  That is, if T is an ObjCInterfaceType*,
6014///     T->getBaseType() == QualType(T, 0).
6015class ObjCInterfaceType : public ObjCObjectType {
friend class ASTContext; // ASTContext creates these.
friend class ASTReader;
friend class ObjCInterfaceDecl;
template <class T> friend class serialization::AbstractTypeReader;

mutable ObjCInterfaceDecl *Decl;

ObjCInterfaceType(const ObjCInterfaceDecl *D)
    : ObjCObjectType(Nonce_ObjCInterface),
      Decl(const_cast<ObjCInterfaceDecl*>(D)) {}

6027public:
/// Get the declaration of this interface.
ObjCInterfaceDecl *getDecl() const { return Decl; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

static bool classof(const Type *T) {
  return T->getTypeClass() == ObjCInterface;
}

// Nonsense to "hide" certain members of ObjCObjectType within this
// class.  People asking for protocols on an ObjCInterfaceType are
// not going to get what they want: ObjCInterfaceTypes are
// guaranteed to have no protocols.
enum {
  qual_iterator,
  qual_begin,
  qual_end,
  getNumProtocols,
  getProtocol
};
6049};

6051inline ObjCInterfaceDecl *ObjCObjectType::getInterface() const {
QualType baseType = getBaseType();
while (const auto *ObjT = baseType->getAs<ObjCObjectType>()) {
  if (const auto *T = dyn_cast<ObjCInterfaceType>(ObjT))
    return T->getDecl();

  baseType = ObjT->getBaseType();
}

return nullptr;
6061}

6063/// Represents a pointer to an Objective C object.
6064///
6065/// These are constructed from pointer declarators when the pointee type is
6066/// an ObjCObjectType (or sugar for one).  In addition, the 'id' and 'Class'
6067/// types are typedefs for these, and the protocol-qualified types 'id<P>'
6068/// and 'Class<P>' are translated into these.
6069///
6070/// Pointers to pointers to Objective C objects are still PointerTypes;
6071/// only the first level of pointer gets it own type implementation.
6072class ObjCObjectPointerType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType PointeeType;

ObjCObjectPointerType(QualType Canonical, QualType Pointee)
    : Type(ObjCObjectPointer, Canonical, Pointee->getDependence()),
      PointeeType(Pointee) {}

6081public:
/// Gets the type pointed to by this ObjC pointer.
/// The result will always be an ObjCObjectType or sugar thereof.
QualType getPointeeType() const { return PointeeType; }

/// Gets the type pointed to by this ObjC pointer.  Always returns non-null.
///
/// This method is equivalent to getPointeeType() except that
/// it discards any typedefs (or other sugar) between this
/// type and the "outermost" object type.  So for:
/// \code
///   \@class A; \@protocol P; \@protocol Q;
///   typedef A<P> AP;
///   typedef A A1;
///   typedef A1<P> A1P;
///   typedef A1P<Q> A1PQ;
/// \endcode
/// For 'A*', getObjectType() will return 'A'.
/// For 'A<P>*', getObjectType() will return 'A<P>'.
/// For 'AP*', getObjectType() will return 'A<P>'.
/// For 'A1*', getObjectType() will return 'A'.
/// For 'A1<P>*', getObjectType() will return 'A1<P>'.
/// For 'A1P*', getObjectType() will return 'A1<P>'.
/// For 'A1PQ*', getObjectType() will return 'A1<Q>', because
///   adding protocols to a protocol-qualified base discards the
///   old qualifiers (for now).  But if it didn't, getObjectType()
///   would return 'A1P<Q>' (and we'd have to make iterating over
///   qualifiers more complicated).
const ObjCObjectType *getObjectType() const {
  return PointeeType->castAs<ObjCObjectType>();
}

/// If this pointer points to an Objective C
/// \@interface type, gets the type for that interface.  Any protocol
/// qualifiers on the interface are ignored.
///
/// \return null if the base type for this pointer is 'id' or 'Class'
const ObjCInterfaceType *getInterfaceType() const;

/// If this pointer points to an Objective \@interface
/// type, gets the declaration for that interface.
///
/// \return null if the base type for this pointer is 'id' or 'Class'
ObjCInterfaceDecl *getInterfaceDecl() const {
  return getObjectType()->getInterface();
}

/// True if this is equivalent to the 'id' type, i.e. if
/// its object type is the primitive 'id' type with no protocols.
bool isObjCIdType() const {
  return getObjectType()->isObjCUnqualifiedId();
}

/// True if this is equivalent to the 'Class' type,
/// i.e. if its object tive is the primitive 'Class' type with no protocols.
bool isObjCClassType() const {
  return getObjectType()->isObjCUnqualifiedClass();
}

/// True if this is equivalent to the 'id' or 'Class' type,
bool isObjCIdOrClassType() const {
  return getObjectType()->isObjCUnqualifiedIdOrClass();
}

/// True if this is equivalent to 'id<P>' for some non-empty set of
/// protocols.
bool isObjCQualifiedIdType() const {
  return getObjectType()->isObjCQualifiedId();
}

/// True if this is equivalent to 'Class<P>' for some non-empty set of
/// protocols.
bool isObjCQualifiedClassType() const {
  return getObjectType()->isObjCQualifiedClass();
}

/// Whether this is a "__kindof" type.
bool isKindOfType() const { return getObjectType()->isKindOfType(); }

/// Whether this type is specialized, meaning that it has type arguments.
bool isSpecialized() const { return getObjectType()->isSpecialized(); }

/// Whether this type is specialized, meaning that it has type arguments.
bool isSpecializedAsWritten() const {
  return getObjectType()->isSpecializedAsWritten();
}

/// Whether this type is unspecialized, meaning that is has no type arguments.
bool isUnspecialized() const { return getObjectType()->isUnspecialized(); }

/// Determine whether this object type is "unspecialized" as
/// written, meaning that it has no type arguments.
bool isUnspecializedAsWritten() const { return !isSpecializedAsWritten(); }

/// Retrieve the type arguments for this type.
ArrayRef<QualType> getTypeArgs() const {
  return getObjectType()->getTypeArgs();
}

/// Retrieve the type arguments for this type.
ArrayRef<QualType> getTypeArgsAsWritten() const {
  return getObjectType()->getTypeArgsAsWritten();
}

/// An iterator over the qualifiers on the object type.  Provided
/// for convenience.  This will always iterate over the full set of
/// protocols on a type, not just those provided directly.
using qual_iterator = ObjCObjectType::qual_iterator;
using qual_range = llvm::iterator_range<qual_iterator>;

qual_range quals() const { return qual_range(qual_begin(), qual_end()); }

qual_iterator qual_begin() const {
  return getObjectType()->qual_begin();
}

qual_iterator qual_end() const {
  return getObjectType()->qual_end();
}

bool qual_empty() const { return getObjectType()->qual_empty(); }

/// Return the number of qualifying protocols on the object type.
unsigned getNumProtocols() const {
  return getObjectType()->getNumProtocols();
}

/// Retrieve a qualifying protocol by index on the object type.
ObjCProtocolDecl *getProtocol(unsigned I) const {
  return getObjectType()->getProtocol(I);
}

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

/// Retrieve the type of the superclass of this object pointer type.
///
/// This operation substitutes any type arguments into the
/// superclass of the current class type, potentially producing a
/// pointer to a specialization of the superclass type. Produces a
/// null type if there is no superclass.
QualType getSuperClassType() const;

/// Strip off the Objective-C "kindof" type and (with it) any
/// protocol qualifiers.
const ObjCObjectPointerType *stripObjCKindOfTypeAndQuals(
                               const ASTContext &ctx) const;

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getPointeeType());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType T) {
  ID.AddPointer(T.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == ObjCObjectPointer;
}
6240};

6242class AtomicType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType ValueType;

AtomicType(QualType ValTy, QualType Canonical)
    : Type(Atomic, Canonical, ValTy->getDependence()), ValueType(ValTy) {}

6250public:
/// Gets the type contained by this atomic type, i.e.
/// the type returned by performing an atomic load of this atomic type.
QualType getValueType() const { return ValueType; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getValueType());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType T) {
  ID.AddPointer(T.getAsOpaquePtr());
}

static bool classof(const Type *T) {
  return T->getTypeClass() == Atomic;
}
6269};

6271/// PipeType - OpenCL20.
6272class PipeType : public Type, public llvm::FoldingSetNode {
friend class ASTContext; // ASTContext creates these.

QualType ElementType;
bool isRead;

PipeType(QualType elemType, QualType CanonicalPtr, bool isRead)
    : Type(Pipe, CanonicalPtr, elemType->getDependence()),
      ElementType(elemType), isRead(isRead) {}

6282public:
QualType getElementType() const { return ElementType; }

bool isSugared() const { return false; }

QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, getElementType(), isReadOnly());
}

static void Profile(llvm::FoldingSetNodeID &ID, QualType T, bool isRead) {
  ID.AddPointer(T.getAsOpaquePtr());
  ID.AddBoolean(isRead);
}

static bool classof(const Type *T) {
  return T->getTypeClass() == Pipe;
}

bool isReadOnly() const { return isRead; }
6303};

6305/// A fixed int type of a specified bitwidth.
6306class ExtIntType final : public Type, public llvm::FoldingSetNode {
friend class ASTContext;
unsigned IsUnsigned : 1;
unsigned NumBits : 24;

6311protected:
ExtIntType(bool isUnsigned, unsigned NumBits);

6314public:
bool isUnsigned() const { return IsUnsigned; }
bool isSigned() const { return !IsUnsigned; }
unsigned getNumBits() const { return NumBits; }

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, isUnsigned(), getNumBits());
}

static void Profile(llvm::FoldingSetNodeID &ID, bool IsUnsigned,
                    unsigned NumBits) {
  ID.AddBoolean(IsUnsigned);
  ID.AddInteger(NumBits);
}

static bool classof(const Type *T) { return T->getTypeClass() == ExtInt; }
6333};

6335class DependentExtIntType final : public Type, public llvm::FoldingSetNode {
friend class ASTContext;
const ASTContext &Context;
llvm::PointerIntPair<Expr*, 1, bool> ExprAndUnsigned;

6340protected:
DependentExtIntType(const ASTContext &Context, bool IsUnsigned,
                    Expr *NumBits);

6344public:
bool isUnsigned() const;
bool isSigned() const { return !isUnsigned(); }
Expr *getNumBitsExpr() const;

bool isSugared() const { return false; }
QualType desugar() const { return QualType(this, 0); }

void Profile(llvm::FoldingSetNodeID &ID) {
  Profile(ID, Context, isUnsigned(), getNumBitsExpr());
}
static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
                    bool IsUnsigned, Expr *NumBitsExpr);

static bool classof(const Type *T) {
  return T->getTypeClass() == DependentExtInt;
}
6361};

6363/// A qualifier set is used to build a set of qualifiers.
6364class QualifierCollector : public Qualifiers {
6365public:
QualifierCollector(Qualifiers Qs = Qualifiers()) : Qualifiers(Qs) {}

/// Collect any qualifiers on the given type and return an
/// unqualified type.  The qualifiers are assumed to be consistent
/// with those already in the type.
const Type *strip(QualType type) {
  addFastQualifiers(type.getLocalFastQualifiers());
  if (!type.hasLocalNonFastQualifiers())
    return type.getTypePtrUnsafe();

  const ExtQuals *extQuals = type.getExtQualsUnsafe();
  addConsistentQualifiers(extQuals->getQualifiers());
  return extQuals->getBaseType();
}

/// Apply the collected qualifiers to the given type.
QualType apply(const ASTContext &Context, QualType QT) const;

/// Apply the collected qualifiers to the given type.
QualType apply(const ASTContext &Context, const Type* T) const;
6386};

6388/// A container of type source information.
6389///
6390/// A client can read the relevant info using TypeLoc wrappers, e.g:
6391/// @code
6392/// TypeLoc TL = TypeSourceInfo->getTypeLoc();
6393/// TL.getBeginLoc().print(OS, SrcMgr);
6394/// @endcode
6395class alignas(8) TypeSourceInfo {
// Contains a memory block after the class, used for type source information,
// allocated by ASTContext.
friend class ASTContext;

QualType Ty;

TypeSourceInfo(QualType ty) : Ty(ty) {}

6404public:
/// Return the type wrapped by this type source info.
QualType getType() const { return Ty; }

/// Return the TypeLoc wrapper for the type source info.
TypeLoc getTypeLoc() const; // implemented in TypeLoc.h

/// Override the type stored in this TypeSourceInfo. Use with caution!
void overrideType(QualType T) { Ty = T; }
6413};

6415// Inline function definitions.

6417inline SplitQualType SplitQualType::getSingleStepDesugaredType() const {
SplitQualType desugar =
  Ty->getLocallyUnqualifiedSingleStepDesugaredType().split();
desugar.Quals.addConsistentQualifiers(Quals);
return desugar;
6422}

6424inline const Type *QualType::getTypePtr() const {
return getCommonPtr()->BaseType;
6426}

6428inline const Type *QualType::getTypePtrOrNull() const {
return (isNull() ? nullptr : getCommonPtr()->BaseType);
6430}

6432inline SplitQualType QualType::split() const {
if (!hasLocalNonFastQualifiers())
  return SplitQualType(getTypePtrUnsafe(),
                       Qualifiers::fromFastMask(getLocalFastQualifiers()));

const ExtQuals *eq = getExtQualsUnsafe();
Qualifiers qs = eq->getQualifiers();
qs.addFastQualifiers(getLocalFastQualifiers());
return SplitQualType(eq->getBaseType(), qs);
6441}

6443inline Qualifiers QualType::getLocalQualifiers() const {
Qualifiers Quals;
if (hasLocalNonFastQualifiers())
  Quals = getExtQualsUnsafe()->getQualifiers();
Quals.addFastQualifiers(getLocalFastQualifiers());
return Quals;
6449}

6451inline Qualifiers QualType::getQualifiers() const {
Qualifiers quals = getCommonPtr()->CanonicalType.getLocalQualifiers();
quals.addFastQualifiers(getLocalFastQualifiers());
return quals;
6455}

6457inline unsigned QualType::getCVRQualifiers() const {
unsigned cvr = getCommonPtr()->CanonicalType.getLocalCVRQualifiers();
cvr |= getLocalCVRQualifiers();
return cvr;
6461}

6463inline QualType QualType::getCanonicalType() const {
QualType canon = getCommonPtr()->CanonicalType;
return canon.withFastQualifiers(getLocalFastQualifiers());
6466}

6468inline bool QualType::isCanonical() const {
return getTypePtr()->isCanonicalUnqualified();
6470}

6472inline bool QualType::isCanonicalAsParam() const {
if (!isCanonical()) return false;
if (hasLocalQualifiers()) return false;

const Type *T = getTypePtr();
if (T->isVariablyModifiedType() && T->hasSizedVLAType())
  return false;

return !isa<FunctionType>(T) && !isa<ArrayType>(T);
6481}

6483inline bool QualType::isConstQualified() const {
return isLocalConstQualified() ||
       getCommonPtr()->CanonicalType.isLocalConstQualified();
6486}

6488inline bool QualType::isRestrictQualified() const {
return isLocalRestrictQualified() ||
       getCommonPtr()->CanonicalType.isLocalRestrictQualified();
6491}


6494inline bool QualType::isVolatileQualified() const {
return isLocalVolatileQualified() ||
       getCommonPtr()->CanonicalType.isLocalVolatileQualified();
6497}

6499inline bool QualType::hasQualifiers() const {
return hasLocalQualifiers() ||
       getCommonPtr()->CanonicalType.hasLocalQualifiers();
6502}

6504inline QualType QualType::getUnqualifiedType() const {
if (!getTypePtr()->getCanonicalTypeInternal().hasLocalQualifiers())
  return QualType(getTypePtr(), 0);

return QualType(getSplitUnqualifiedTypeImpl(*this).Ty, 0);
6509}

6511inline SplitQualType QualType::getSplitUnqualifiedType() const {
if (!getTypePtr()->getCanonicalTypeInternal().hasLocalQualifiers())
  return split();

return getSplitUnqualifiedTypeImpl(*this);
6516}

6518inline void QualType::removeLocalConst() {
removeLocalFastQualifiers(Qualifiers::Const);
6520}

6522inline void QualType::removeLocalRestrict() {
removeLocalFastQualifiers(Qualifiers::Restrict);
6524}

6526inline void QualType::removeLocalVolatile() {
removeLocalFastQualifiers(Qualifiers::Volatile);
6528}

6530inline void QualType::removeLocalCVRQualifiers(unsigned Mask) {
assert(!(Mask & ~Qualifiers::CVRMask) && "mask has non-CVR bits")(static_cast<void> (0));
static_assert((int)Qualifiers::CVRMask == (int)Qualifiers::FastMask,
              "Fast bits differ from CVR bits!");

// Fast path: we don't need to touch the slow qualifiers.
removeLocalFastQualifiers(Mask);
6537}

6539/// Check if this type has any address space qualifier.
6540inline bool QualType::hasAddressSpace() const {
return getQualifiers().hasAddressSpace();
6542}

6544/// Return the address space of this type.
6545inline LangAS QualType::getAddressSpace() const {
return getQualifiers().getAddressSpace();
6547}

6549/// Return the gc attribute of this type.
6550inline Qualifiers::GC QualType::getObjCGCAttr() const {
return getQualifiers().getObjCGCAttr();
6552}

6554inline bool QualType::hasNonTrivialToPrimitiveDefaultInitializeCUnion() const {
if (auto *RD = getTypePtr()->getBaseElementTypeUnsafe()->getAsRecordDecl())
  return hasNonTrivialToPrimitiveDefaultInitializeCUnion(RD);
return false;
6558}

6560inline bool QualType::hasNonTrivialToPrimitiveDestructCUnion() const {
if (auto *RD = getTypePtr()->getBaseElementTypeUnsafe()->getAsRecordDecl())
  return hasNonTrivialToPrimitiveDestructCUnion(RD);
return false;
6564}

6566inline bool QualType::hasNonTrivialToPrimitiveCopyCUnion() const {
if (auto *RD = getTypePtr()->getBaseElementTypeUnsafe()->getAsRecordDecl())
  return hasNonTrivialToPrimitiveCopyCUnion(RD);
return false;
6570}

6572inline FunctionType::ExtInfo getFunctionExtInfo(const Type &t) {
if (const auto *PT = t.getAs<PointerType>()) {
  if (const auto *FT = PT->getPointeeType()->getAs<FunctionType>())
    return FT->getExtInfo();
} else if (const auto *FT = t.getAs<FunctionType>())
  return FT->getExtInfo();

return FunctionType::ExtInfo();
6580}

6582inline FunctionType::ExtInfo getFunctionExtInfo(QualType t) {
return getFunctionExtInfo(*t);
6584}

6586/// Determine whether this type is more
6587/// qualified than the Other type. For example, "const volatile int"
6588/// is more qualified than "const int", "volatile int", and
6589/// "int". However, it is not more qualified than "const volatile
6590/// int".
6591inline bool QualType::isMoreQualifiedThan(QualType other) const {
Qualifiers MyQuals = getQualifiers();
Qualifiers OtherQuals = other.getQualifiers();
return (MyQuals != OtherQuals && MyQuals.compatiblyIncludes(OtherQuals));
6595}

6597/// Determine whether this type is at last
6598/// as qualified as the Other type. For example, "const volatile
6599/// int" is at least as qualified as "const int", "volatile int",
6600/// "int", and "const volatile int".
6601inline bool QualType::isAtLeastAsQualifiedAs(QualType other) const {
Qualifiers OtherQuals = other.getQualifiers();

// Ignore __unaligned qualifier if this type is a void.
if (getUnqualifiedType()->isVoidType())
  OtherQuals.removeUnaligned();

return getQualifiers().compatiblyIncludes(OtherQuals);
6609}

6611/// If Type is a reference type (e.g., const
6612/// int&), returns the type that the reference refers to ("const
6613/// int"). Otherwise, returns the type itself. This routine is used
6614/// throughout Sema to implement C++ 5p6:
6615///
6616///   If an expression initially has the type "reference to T" (8.3.2,
6617///   8.5.3), the type is adjusted to "T" prior to any further
6618///   analysis, the expression designates the object or function
6619///   denoted by the reference, and the expression is an lvalue.
6620inline QualType QualType::getNonReferenceType() const {
if (const auto *RefType = (*this)->getAs<ReferenceType>())
  return RefType->getPointeeType();
else
  return *this;
6625}

6627inline bool QualType::isCForbiddenLValueType() const {
return ((getTypePtr()->isVoidType() && !hasQualifiers()) ||
        getTypePtr()->isFunctionType());
6630}

6632/// Tests whether the type is categorized as a fundamental type.
6633///
6634/// \returns True for types specified in C++0x [basic.fundamental].
6635inline bool Type::isFundamentalType() const {
return isVoidType() ||
       isNullPtrType() ||
       // FIXME: It's really annoying that we don't have an
       // 'isArithmeticType()' which agrees with the standard definition.
       (isArithmeticType() && !isEnumeralType());
6641}

6643/// Tests whether the type is categorized as a compound type.
6644///
6645/// \returns True for types specified in C++0x [basic.compound].
6646inline bool Type::isCompoundType() const {
// C++0x [basic.compound]p1:
//   Compound types can be constructed in the following ways:
//    -- arrays of objects of a given type [...];
return isArrayType() ||
//    -- functions, which have parameters of given types [...];
       isFunctionType() ||
//    -- pointers to void or objects or functions [...];
       isPointerType() ||
//    -- references to objects or functions of a given type. [...]
       isReferenceType() ||
//    -- classes containing a sequence of objects of various types, [...];
       isRecordType() ||
//    -- unions, which are classes capable of containing objects of different
//               types at different times;
       isUnionType() ||
//    -- enumerations, which comprise a set of named constant values. [...];
       isEnumeralType() ||
//    -- pointers to non-static class members, [...].
       isMemberPointerType();
6666}

6668inline bool Type::isFunctionType() const {
return isa<FunctionType>(CanonicalType);
6670}

6672inline bool Type::isPointerType() const {
return isa<PointerType>(CanonicalType);
6674}

6676inline bool Type::isAnyPointerType() const {
return isPointerType() || isObjCObjectPointerType();
6678}

6680inline bool Type::isBlockPointerType() const {
return isa<BlockPointerType>(CanonicalType);
6682}

6684inline bool Type::isReferenceType() const {
return isa<ReferenceType>(CanonicalType);
6686}

6688inline bool Type::isLValueReferenceType() const {
return isa<LValueReferenceType>(CanonicalType);
6690}

6692inline bool Type::isRValueReferenceType() const {
return isa<RValueReferenceType>(CanonicalType);
6694}

6696inline bool Type::isObjectPointerType() const {
// Note: an "object pointer type" is not the same thing as a pointer to an
// object type; rather, it is a pointer to an object type or a pointer to cv
// void.
if (const auto *T = getAs<PointerType>())
  return !T->getPointeeType()->isFunctionType();
else
  return false;
6704}

6706inline bool Type::isFunctionPointerType() const {
if (const auto *T = getAs<PointerType>())
  return T->getPointeeType()->isFunctionType();
else
  return false;
6711}

6713inline bool Type::isFunctionReferenceType() const {
if (const auto *T = getAs<ReferenceType>())
  return T->getPointeeType()->isFunctionType();
else
  return false;
6718}

6720inline bool Type::isMemberPointerType() const {
return isa<MemberPointerType>(CanonicalType);
6722}

6724inline bool Type::isMemberFunctionPointerType() const {
if (const auto *T = getAs<MemberPointerType>())
  return T->isMemberFunctionPointer();
else
  return false;
6729}

6731inline bool Type::isMemberDataPointerType() const {
if (const auto *T13.1
'T' is null
1
'T' is null
 = getAs<MemberPointerType>())
13
←
Assuming the object is not a 'MemberPointerType'→
14
←
Taking false branch→
  return T->isMemberDataPointer();
else
  return false;
15
←
Returning zero, which participates in a condition later→
6736}

6738inline bool Type::isArrayType() const {
return isa<ArrayType>(CanonicalType);
6740}

6742inline bool Type::isConstantArrayType() const {
return isa<ConstantArrayType>(CanonicalType);
6744}

6746inline bool Type::isIncompleteArrayType() const {
return isa<IncompleteArrayType>(CanonicalType);
6748}

6750inline bool Type::isVariableArrayType() const {
return isa<VariableArrayType>(CanonicalType);
6752}

6754inline bool Type::isDependentSizedArrayType() const {
return isa<DependentSizedArrayType>(CanonicalType);
6756}

6758inline bool Type::isBuiltinType() const {
return isa<BuiltinType>(CanonicalType);
6760}

6762inline bool Type::isRecordType() const {
return isa<RecordType>(CanonicalType);
6764}

6766inline bool Type::isEnumeralType() const {
return isa<EnumType>(CanonicalType);
6768}

6770inline bool Type::isAnyComplexType() const {
return isa<ComplexType>(CanonicalType);
6772}

6774inline bool Type::isVectorType() const {
return isa<VectorType>(CanonicalType);
6776}

6778inline bool Type::isExtVectorType() const {
return isa<ExtVectorType>(CanonicalType);
6780}

6782inline bool Type::isMatrixType() const {
return isa<MatrixType>(CanonicalType);
6784}

6786inline bool Type::isConstantMatrixType() const {
return isa<ConstantMatrixType>(CanonicalType);
6788}

6790inline bool Type::isDependentAddressSpaceType() const {
return isa<DependentAddressSpaceType>(CanonicalType);
6792}

6794inline bool Type::isObjCObjectPointerType() const {
return isa<ObjCObjectPointerType>(CanonicalType);
6796}

6798inline bool Type::isObjCObjectType() const {
return isa<ObjCObjectType>(CanonicalType);
6800}

6802inline bool Type::isObjCObjectOrInterfaceType() const {
return isa<ObjCInterfaceType>(CanonicalType) ||
  isa<ObjCObjectType>(CanonicalType);
6805}

6807inline bool Type::isAtomicType() const {
return isa<AtomicType>(CanonicalType);
6809}

6811inline bool Type::isUndeducedAutoType() const {
return isa<AutoType>(CanonicalType);
6813}

6815inline bool Type::isObjCQualifiedIdType() const {
if (const auto *OPT = getAs<ObjCObjectPointerType>())
  return OPT->isObjCQualifiedIdType();
return false;
6819}

6821inline bool Type::isObjCQualifiedClassType() const {
if (const auto *OPT = getAs<ObjCObjectPointerType>())
  return OPT->isObjCQualifiedClassType();
return false;
6825}

6827inline bool Type::isObjCIdType() const {
if (const auto *OPT = getAs<ObjCObjectPointerType>())
  return OPT->isObjCIdType();
return false;
6831}

6833inline bool Type::isObjCClassType() const {
if (const auto *OPT = getAs<ObjCObjectPointerType>())
  return OPT->isObjCClassType();
return false;
6837}

6839inline bool Type::isObjCSelType() const {
if (const auto *OPT = getAs<PointerType>())
  return OPT->getPointeeType()->isSpecificBuiltinType(BuiltinType::ObjCSel);
return false;
6843}

6845inline bool Type::isObjCBuiltinType() const {
return isObjCIdType() || isObjCClassType() || isObjCSelType();
6847}

6849inline bool Type::isDecltypeType() const {
return isa<DecltypeType>(this);
6851}

6853#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
inline bool Type::is##Id##Type() const { \
  return isSpecificBuiltinType(BuiltinType::Id); \
}
6857#include "clang/Basic/OpenCLImageTypes.def"

6859inline bool Type::isSamplerT() const {
return isSpecificBuiltinType(BuiltinType::OCLSampler);
6861}

6863inline bool Type::isEventT() const {
return isSpecificBuiltinType(BuiltinType::OCLEvent);
6865}

6867inline bool Type::isClkEventT() const {
return isSpecificBuiltinType(BuiltinType::OCLClkEvent);
6869}

6871inline bool Type::isQueueT() const {
return isSpecificBuiltinType(BuiltinType::OCLQueue);
6873}

6875inline bool Type::isReserveIDT() const {
return isSpecificBuiltinType(BuiltinType::OCLReserveID);
6877}

6879inline bool Type::isImageType() const {
6880#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) is##Id##Type() ||
return
6882#include "clang/Basic/OpenCLImageTypes.def"
    false; // end boolean or operation
6884}

6886inline bool Type::isPipeType() const {
return isa<PipeType>(CanonicalType);
6888}

6890inline bool Type::isExtIntType() const {
return isa<ExtIntType>(CanonicalType);
6892}

6894#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
inline bool Type::is##Id##Type() const { \
  return isSpecificBuiltinType(BuiltinType::Id); \
}
6898#include "clang/Basic/OpenCLExtensionTypes.def"

6900inline bool Type::isOCLIntelSubgroupAVCType() const {
6901#define INTEL_SUBGROUP_AVC_TYPE(ExtType, Id) \
isOCLIntelSubgroupAVC##Id##Type() ||
return
6904#include "clang/Basic/OpenCLExtensionTypes.def"
  false; // end of boolean or operation
6906}

6908inline bool Type::isOCLExtOpaqueType() const {
6909#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) is##Id##Type() ||
return
6911#include "clang/Basic/OpenCLExtensionTypes.def"
  false; // end of boolean or operation
6913}

6915inline bool Type::isOpenCLSpecificType() const {
return isSamplerT() || isEventT() || isImageType() || isClkEventT() ||
       isQueueT() || isReserveIDT() || isPipeType() || isOCLExtOpaqueType();
6918}

6920inline bool Type::isTemplateTypeParmType() const {
return isa<TemplateTypeParmType>(CanonicalType);
6922}

6924inline bool Type::isSpecificBuiltinType(unsigned K) const {
if (const BuiltinType *BT = getAs<BuiltinType>()) {
  return BT->getKind() == static_cast<BuiltinType::Kind>(K);
}
return false;
6929}

6931inline bool Type::isPlaceholderType() const {
if (const auto *BT = dyn_cast<BuiltinType>(this))
  return BT->isPlaceholderType();
return false;
6935}

6937inline const BuiltinType *Type::getAsPlaceholderType() const {
if (const auto *BT = dyn_cast<BuiltinType>(this))
  if (BT->isPlaceholderType())
    return BT;
return nullptr;
6942}

6944inline bool Type::isSpecificPlaceholderType(unsigned K) const {
assert(BuiltinType::isPlaceholderTypeKind((BuiltinType::Kind) K))(static_cast<void> (0));
return isSpecificBuiltinType(K);
6947}

6949inline bool Type::isNonOverloadPlaceholderType() const {
if (const auto *BT = dyn_cast<BuiltinType>(this))
  return BT->isNonOverloadPlaceholderType();
return false;
6953}

6955inline bool Type::isVoidType() const {
return isSpecificBuiltinType(BuiltinType::Void);
6957}

6959inline bool Type::isHalfType() const {
// FIXME: Should we allow complex __fp16? Probably not.
return isSpecificBuiltinType(BuiltinType::Half);
6962}

6964inline bool Type::isFloat16Type() const {
return isSpecificBuiltinType(BuiltinType::Float16);
6966}

6968inline bool Type::isBFloat16Type() const {
return isSpecificBuiltinType(BuiltinType::BFloat16);
6970}

6972inline bool Type::isFloat128Type() const {
return isSpecificBuiltinType(BuiltinType::Float128);
6974}

6976inline bool Type::isNullPtrType() const {
return isSpecificBuiltinType(BuiltinType::NullPtr);
6978}

6980bool IsEnumDeclComplete(EnumDecl *);
6981bool IsEnumDeclScoped(EnumDecl *);

6983inline bool Type::isIntegerType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
  return BT->getKind() >= BuiltinType::Bool &&
         BT->getKind() <= BuiltinType::Int128;
if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType)) {
  // Incomplete enum types are not treated as integer types.
  // FIXME: In C++, enum types are never integer types.
  return IsEnumDeclComplete(ET->getDecl()) &&
    !IsEnumDeclScoped(ET->getDecl());
}
return isExtIntType();
6994}

6996inline bool Type::isFixedPointType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType)) {
  return BT->getKind() >= BuiltinType::ShortAccum &&
         BT->getKind() <= BuiltinType::SatULongFract;
}
return false;
7002}

7004inline bool Type::isFixedPointOrIntegerType() const {
return isFixedPointType() || isIntegerType();
7006}

7008inline bool Type::isSaturatedFixedPointType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType)) {
  return BT->getKind() >= BuiltinType::SatShortAccum &&
         BT->getKind() <= BuiltinType::SatULongFract;
}
return false;
7014}

7016inline bool Type::isUnsaturatedFixedPointType() const {
return isFixedPointType() && !isSaturatedFixedPointType();
7018}

7020inline bool Type::isSignedFixedPointType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType)) {
  return ((BT->getKind() >= BuiltinType::ShortAccum &&
           BT->getKind() <= BuiltinType::LongAccum) ||
          (BT->getKind() >= BuiltinType::ShortFract &&
           BT->getKind() <= BuiltinType::LongFract) ||
          (BT->getKind() >= BuiltinType::SatShortAccum &&
           BT->getKind() <= BuiltinType::SatLongAccum) ||
          (BT->getKind() >= BuiltinType::SatShortFract &&
           BT->getKind() <= BuiltinType::SatLongFract));
}
return false;
7032}

7034inline bool Type::isUnsignedFixedPointType() const {
return isFixedPointType() && !isSignedFixedPointType();
7036}

7038inline bool Type::isScalarType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
  return BT->getKind() > BuiltinType::Void &&
         BT->getKind() <= BuiltinType::NullPtr;
if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType))
  // Enums are scalar types, but only if they are defined.  Incomplete enums
  // are not treated as scalar types.
  return IsEnumDeclComplete(ET->getDecl());
return isa<PointerType>(CanonicalType) ||
       isa<BlockPointerType>(CanonicalType) ||
       isa<MemberPointerType>(CanonicalType) ||
       isa<ComplexType>(CanonicalType) ||
       isa<ObjCObjectPointerType>(CanonicalType) ||
       isExtIntType();
7052}

7054inline bool Type::isIntegralOrEnumerationType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
  return BT->getKind() >= BuiltinType::Bool &&
         BT->getKind() <= BuiltinType::Int128;

// Check for a complete enum type; incomplete enum types are not properly an
// enumeration type in the sense required here.
if (const auto *ET = dyn_cast<EnumType>(CanonicalType))
  return IsEnumDeclComplete(ET->getDecl());

return isExtIntType();
7065}

7067inline bool Type::isBooleanType() const {
if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
  return BT->getKind() == BuiltinType::Bool;
return false;
7071}

7073inline bool Type::isUndeducedType() const {
auto *DT = getContainedDeducedType();
return DT && !DT->isDeduced();
7076}

7078/// Determines whether this is a type for which one can define
7079/// an overloaded operator.
7080inline bool Type::isOverloadableType() const {
return isDependentType() || isRecordType() || isEnumeralType();
7082}

7084/// Determines whether this type is written as a typedef-name.
7085inline bool Type::isTypedefNameType() const {
if (getAs<TypedefType>())
  return true;
if (auto *TST = getAs<TemplateSpecializationType>())
  return TST->isTypeAlias();
return false;
7091}

7093/// Determines whether this type can decay to a pointer type.
7094inline bool Type::canDecayToPointerType() const {
return isFunctionType() || isArrayType();
7096}

7098inline bool Type::hasPointerRepresentation() const {
return (isPointerType() || isReferenceType() || isBlockPointerType() ||
        isObjCObjectPointerType() || isNullPtrType());
7101}

7103inline bool Type::hasObjCPointerRepresentation() const {
return isObjCObjectPointerType();
7105}

7107inline const Type *Type::getBaseElementTypeUnsafe() const {
const Type *type = this;
while (const ArrayType *arrayType = type->getAsArrayTypeUnsafe())
  type = arrayType->getElementType().getTypePtr();
return type;
7112}

7114inline const Type *Type::getPointeeOrArrayElementType() const {
const Type *type = this;
if (type->isAnyPointerType())
  return type->getPointeeType().getTypePtr();
else if (type->isArrayType())
  return type->getBaseElementTypeUnsafe();
return type;
7121}
7122/// Insertion operator for partial diagnostics. This allows sending adress
7123/// spaces into a diagnostic with <<.
7124inline const StreamingDiagnostic &operator<<(const StreamingDiagnostic &PD,
                                           LangAS AS) {
PD.AddTaggedVal(static_cast<std::underlying_type_t<LangAS>>(AS),
                DiagnosticsEngine::ArgumentKind::ak_addrspace);
return PD;
7129}

7131/// Insertion operator for partial diagnostics. This allows sending Qualifiers
7132/// into a diagnostic with <<.
7133inline const StreamingDiagnostic &operator<<(const StreamingDiagnostic &PD,
                                           Qualifiers Q) {
PD.AddTaggedVal(Q.getAsOpaqueValue(),
                DiagnosticsEngine::ArgumentKind::ak_qual);
return PD;
7138}

7140/// Insertion operator for partial diagnostics.  This allows sending QualType's
7141/// into a diagnostic with <<.
7142inline const StreamingDiagnostic &operator<<(const StreamingDiagnostic &PD,
                                           QualType T) {
PD.AddTaggedVal(reinterpret_cast<intptr_t>(T.getAsOpaquePtr()),
                DiagnosticsEngine::ak_qualtype);
return PD;
7147}

7149// Helper class template that is used by Type::getAs to ensure that one does
7150// not try to look through a qualified type to get to an array type.
7151template <typename T>
7152using TypeIsArrayType =
  std::integral_constant<bool, std::is_same<T, ArrayType>::value ||
                                   std::is_base_of<ArrayType, T>::value>;

7156// Member-template getAs<specific type>'.
7157template <typename T> const T *Type::getAs() const {
static_assert(!TypeIsArrayType<T>::value,
              "ArrayType cannot be used with getAs!");

// If this is directly a T type, return it.
if (const auto *Ty = dyn_cast<T>(this))
  return Ty;

// If the canonical form of this type isn't the right kind, reject it.
if (!isa<T>(CanonicalType))
  return nullptr;

// If this is a typedef for the type, strip the typedef off without
// losing all typedef information.
return cast<T>(getUnqualifiedDesugaredType());
7172}

7174template <typename T> const T *Type::getAsAdjusted() const {
static_assert(!TypeIsArrayType<T>::value, "ArrayType cannot be used with getAsAdjusted!");

// If this is directly a T type, return it.
if (const auto *Ty = dyn_cast<T>(this))
  return Ty;

// If the canonical form of this type isn't the right kind, reject it.
if (!isa<T>(CanonicalType))
  return nullptr;

// Strip off type adjustments that do not modify the underlying nature of the
// type.
const Type *Ty = this;
while (Ty) {
  if (const auto *A = dyn_cast<AttributedType>(Ty))
    Ty = A->getModifiedType().getTypePtr();
  else if (const auto *E = dyn_cast<ElaboratedType>(Ty))
    Ty = E->desugar().getTypePtr();
  else if (const auto *P = dyn_cast<ParenType>(Ty))
    Ty = P->desugar().getTypePtr();
  else if (const auto *A = dyn_cast<AdjustedType>(Ty))
    Ty = A->desugar().getTypePtr();
  else if (const auto *M = dyn_cast<MacroQualifiedType>(Ty))
    Ty = M->desugar().getTypePtr();
  else
    break;
}

// Just because the canonical type is correct does not mean we can use cast<>,
// since we may not have stripped off all the sugar down to the base type.
return dyn_cast<T>(Ty);
7206}

7208inline const ArrayType *Type::getAsArrayTypeUnsafe() const {
// If this is directly an array type, return it.
if (const auto *arr = dyn_cast<ArrayType>(this))
  return arr;

// If the canonical form of this type isn't the right kind, reject it.
if (!isa<ArrayType>(CanonicalType))
  return nullptr;

// If this is a typedef for the type, strip the typedef off without
// losing all typedef information.
return cast<ArrayType>(getUnqualifiedDesugaredType());
7220}

7222template <typename T> const T *Type::castAs() const {
static_assert(!TypeIsArrayType<T>::value,
              "ArrayType cannot be used with castAs!");

if (const auto *ty = dyn_cast<T>(this)) return ty;
assert(isa<T>(CanonicalType))(static_cast<void> (0));
return cast<T>(getUnqualifiedDesugaredType());
7229}

7231inline const ArrayType *Type::castAsArrayTypeUnsafe() const {
assert(isa<ArrayType>(CanonicalType))(static_cast<void> (0));
if (const auto *arr = dyn_cast<ArrayType>(this)) return arr;
return cast<ArrayType>(getUnqualifiedDesugaredType());
7235}

7237DecayedType::DecayedType(QualType OriginalType, QualType DecayedPtr,
                       QualType CanonicalPtr)
  : AdjustedType(Decayed, OriginalType, DecayedPtr, CanonicalPtr) {
7240#ifndef NDEBUG1
QualType Adjusted = getAdjustedType();
(void)AttributedType::stripOuterNullability(Adjusted);
assert(isa<PointerType>(Adjusted))(static_cast<void> (0));
7244#endif
7245}

7247QualType DecayedType::getPointeeType() const {
QualType Decayed = getDecayedType();
(void)AttributedType::stripOuterNullability(Decayed);
return cast<PointerType>(Decayed)->getPointeeType();
7251}

7253// Get the decimal string representation of a fixed point type, represented
7254// as a scaled integer.
7255// TODO: At some point, we should change the arguments to instead just accept an
7256// APFixedPoint instead of APSInt and scale.
7257void FixedPointValueToString(SmallVectorImpl<char> &Str, llvm::APSInt Val,
                           unsigned Scale);

7260} // namespace clang

7262#endif // LLVM_CLANG_AST_TYPE_H