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 //===----------------------------------------------------------------------===//
12 
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/DeclFriend.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/Expr.h"
26 #include "clang/AST/RecordLayout.h"
27 #include "clang/Basic/CodeGenOptions.h"
28 #include "clang/Basic/FileManager.h"
29 #include "clang/Basic/SourceManager.h"
30 #include "clang/Basic/Version.h"
31 #include "clang/Frontend/FrontendOptions.h"
32 #include "clang/Lex/HeaderSearchOptions.h"
33 #include "clang/Lex/ModuleMap.h"
34 #include "clang/Lex/PreprocessorOptions.h"
35 #include "llvm/ADT/DenseSet.h"
36 #include "llvm/ADT/SmallVector.h"
37 #include "llvm/ADT/StringExtras.h"
38 #include "llvm/IR/Constants.h"
39 #include "llvm/IR/DataLayout.h"
40 #include "llvm/IR/DerivedTypes.h"
41 #include "llvm/IR/Instructions.h"
42 #include "llvm/IR/Intrinsics.h"
43 #include "llvm/IR/Metadata.h"
44 #include "llvm/IR/Module.h"
45 #include "llvm/Support/FileSystem.h"
46 #include "llvm/Support/MD5.h"
47 #include "llvm/Support/Path.h"
48 using namespace clang;
49 using namespace clang::CodeGen;
50 
51 static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
52   auto TI = Ctx.getTypeInfo(Ty);
53   return TI.AlignIsRequired ? TI.Align : 0;
54 }
55 
56 static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
57   return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
58 }
59 
60 static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
61   return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
62 }
63 
64 CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
65     : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
66       DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
67       DBuilder(CGM.getModule()) {
68   for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
69     DebugPrefixMap[KV.first] = KV.second;
70   CreateCompileUnit();
71 }
72 
73 CGDebugInfo::~CGDebugInfo() {
74   assert(LexicalBlockStack.empty() &&
75          "Region stack mismatch, stack not empty!");
76 }
77 
78 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
79                                        SourceLocation TemporaryLocation)
80     : CGF(&CGF) {
81   init(TemporaryLocation);
82 }
83 
84 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
85                                        bool DefaultToEmpty,
86                                        SourceLocation TemporaryLocation)
87     : CGF(&CGF) {
88   init(TemporaryLocation, DefaultToEmpty);
89 }
90 
91 void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
92                               bool DefaultToEmpty) {
93   auto *DI = CGF->getDebugInfo();
94   if (!DI) {
95     CGF = nullptr;
96     return;
97   }
98 
99   OriginalLocation = CGF->Builder.getCurrentDebugLocation();
100 
101   if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
102     return;
103 
104   if (TemporaryLocation.isValid()) {
105     DI->EmitLocation(CGF->Builder, TemporaryLocation);
106     return;
107   }
108 
109   if (DefaultToEmpty) {
110     CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
111     return;
112   }
113 
114   // Construct a location that has a valid scope, but no line info.
115   assert(!DI->LexicalBlockStack.empty());
116   CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
117       0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
118 }
119 
120 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
121     : CGF(&CGF) {
122   init(E->getExprLoc());
123 }
124 
125 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
126     : CGF(&CGF) {
127   if (!CGF.getDebugInfo()) {
128     this->CGF = nullptr;
129     return;
130   }
131   OriginalLocation = CGF.Builder.getCurrentDebugLocation();
132   if (Loc)
133     CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
134 }
135 
136 ApplyDebugLocation::~ApplyDebugLocation() {
137   // Query CGF so the location isn't overwritten when location updates are
138   // temporarily disabled (for C++ default function arguments)
139   if (CGF)
140     CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
141 }
142 
143 ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
144                                                    GlobalDecl InlinedFn)
145     : CGF(&CGF) {
146   if (!CGF.getDebugInfo()) {
147     this->CGF = nullptr;
148     return;
149   }
150   auto &DI = *CGF.getDebugInfo();
151   SavedLocation = DI.getLocation();
152   assert((DI.getInlinedAt() ==
153           CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
154          "CGDebugInfo and IRBuilder are out of sync");
155 
156   DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
157 }
158 
159 ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
160   if (!CGF)
161     return;
162   auto &DI = *CGF->getDebugInfo();
163   DI.EmitInlineFunctionEnd(CGF->Builder);
164   DI.EmitLocation(CGF->Builder, SavedLocation);
165 }
166 
167 void CGDebugInfo::setLocation(SourceLocation Loc) {
168   // If the new location isn't valid return.
169   if (Loc.isInvalid())
170     return;
171 
172   CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
173 
174   // If we've changed files in the middle of a lexical scope go ahead
175   // and create a new lexical scope with file node if it's different
176   // from the one in the scope.
177   if (LexicalBlockStack.empty())
178     return;
179 
180   SourceManager &SM = CGM.getContext().getSourceManager();
181   auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
182   PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
183   if (PCLoc.isInvalid() || Scope->getFile() == getOrCreateFile(CurLoc))
184     return;
185 
186   if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
187     LexicalBlockStack.pop_back();
188     LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
189         LBF->getScope(), getOrCreateFile(CurLoc)));
190   } else if (isa<llvm::DILexicalBlock>(Scope) ||
191              isa<llvm::DISubprogram>(Scope)) {
192     LexicalBlockStack.pop_back();
193     LexicalBlockStack.emplace_back(
194         DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
195   }
196 }
197 
198 llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
199   llvm::DIScope *Mod = getParentModuleOrNull(D);
200   return getContextDescriptor(cast<Decl>(D->getDeclContext()),
201                               Mod ? Mod : TheCU);
202 }
203 
204 llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
205                                                  llvm::DIScope *Default) {
206   if (!Context)
207     return Default;
208 
209   auto I = RegionMap.find(Context);
210   if (I != RegionMap.end()) {
211     llvm::Metadata *V = I->second;
212     return dyn_cast_or_null<llvm::DIScope>(V);
213   }
214 
215   // Check namespace.
216   if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
217     return getOrCreateNamespace(NSDecl);
218 
219   if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
220     if (!RDecl->isDependentType())
221       return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
222                              TheCU->getFile());
223   return Default;
224 }
225 
226 PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
227   PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
228 
229   // If we're emitting codeview, it's important to try to match MSVC's naming so
230   // that visualizers written for MSVC will trigger for our class names. In
231   // particular, we can't have spaces between arguments of standard templates
232   // like basic_string and vector.
233   if (CGM.getCodeGenOpts().EmitCodeView)
234     PP.MSVCFormatting = true;
235 
236   // Apply -fdebug-prefix-map.
237   PP.RemapFilePaths = true;
238   PP.remapPath = [this](StringRef Path) { return remapDIPath(Path); };
239   return PP;
240 }
241 
242 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
243   assert(FD && "Invalid FunctionDecl!");
244   IdentifierInfo *FII = FD->getIdentifier();
245   FunctionTemplateSpecializationInfo *Info =
246       FD->getTemplateSpecializationInfo();
247 
248   // Emit the unqualified name in normal operation. LLVM and the debugger can
249   // compute the fully qualified name from the scope chain. If we're only
250   // emitting line table info, there won't be any scope chains, so emit the
251   // fully qualified name here so that stack traces are more accurate.
252   // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
253   // evaluating the size impact.
254   bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
255                           CGM.getCodeGenOpts().EmitCodeView;
256 
257   if (!Info && FII && !UseQualifiedName)
258     return FII->getName();
259 
260   SmallString<128> NS;
261   llvm::raw_svector_ostream OS(NS);
262   if (!UseQualifiedName)
263     FD->printName(OS);
264   else
265     FD->printQualifiedName(OS, getPrintingPolicy());
266 
267   // Add any template specialization args.
268   if (Info) {
269     const TemplateArgumentList *TArgs = Info->TemplateArguments;
270     printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
271   }
272 
273   // Copy this name on the side and use its reference.
274   return internString(OS.str());
275 }
276 
277 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
278   SmallString<256> MethodName;
279   llvm::raw_svector_ostream OS(MethodName);
280   OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
281   const DeclContext *DC = OMD->getDeclContext();
282   if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
283     OS << OID->getName();
284   } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
285     OS << OID->getName();
286   } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
287     if (OC->IsClassExtension()) {
288       OS << OC->getClassInterface()->getName();
289     } else {
290       OS << OC->getIdentifier()->getNameStart() << '('
291          << OC->getIdentifier()->getNameStart() << ')';
292     }
293   } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
294     OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
295   } else if (isa<ObjCProtocolDecl>(DC)) {
296     // We can extract the type of the class from the self pointer.
297     if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
298       QualType ClassTy =
299           cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
300       ClassTy.print(OS, PrintingPolicy(LangOptions()));
301     }
302   }
303   OS << ' ' << OMD->getSelector().getAsString() << ']';
304 
305   return internString(OS.str());
306 }
307 
308 StringRef CGDebugInfo::getSelectorName(Selector S) {
309   return internString(S.getAsString());
310 }
311 
312 StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
313   if (isa<ClassTemplateSpecializationDecl>(RD)) {
314     SmallString<128> Name;
315     llvm::raw_svector_ostream OS(Name);
316     RD->getNameForDiagnostic(OS, getPrintingPolicy(),
317                              /*Qualified*/ false);
318 
319     // Copy this name on the side and use its reference.
320     return internString(Name);
321   }
322 
323   // quick optimization to avoid having to intern strings that are already
324   // stored reliably elsewhere
325   if (const IdentifierInfo *II = RD->getIdentifier())
326     return II->getName();
327 
328   // The CodeView printer in LLVM wants to see the names of unnamed types: it is
329   // used to reconstruct the fully qualified type names.
330   if (CGM.getCodeGenOpts().EmitCodeView) {
331     if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
332       assert(RD->getDeclContext() == D->getDeclContext() &&
333              "Typedef should not be in another decl context!");
334       assert(D->getDeclName().getAsIdentifierInfo() &&
335              "Typedef was not named!");
336       return D->getDeclName().getAsIdentifierInfo()->getName();
337     }
338 
339     if (CGM.getLangOpts().CPlusPlus) {
340       StringRef Name;
341 
342       ASTContext &Context = CGM.getContext();
343       if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
344         // Anonymous types without a name for linkage purposes have their
345         // declarator mangled in if they have one.
346         Name = DD->getName();
347       else if (const TypedefNameDecl *TND =
348                    Context.getTypedefNameForUnnamedTagDecl(RD))
349         // Anonymous types without a name for linkage purposes have their
350         // associate typedef mangled in if they have one.
351         Name = TND->getName();
352 
353       if (!Name.empty()) {
354         SmallString<256> UnnamedType("<unnamed-type-");
355         UnnamedType += Name;
356         UnnamedType += '>';
357         return internString(UnnamedType);
358       }
359     }
360   }
361 
362   return StringRef();
363 }
364 
365 Optional<llvm::DIFile::ChecksumKind>
366 CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
367   Checksum.clear();
368 
369   if (!CGM.getCodeGenOpts().EmitCodeView &&
370       CGM.getCodeGenOpts().DwarfVersion < 5)
371     return None;
372 
373   SourceManager &SM = CGM.getContext().getSourceManager();
374   bool Invalid;
375   const llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
376   if (Invalid)
377     return None;
378 
379   llvm::MD5 Hash;
380   llvm::MD5::MD5Result Result;
381 
382   Hash.update(MemBuffer->getBuffer());
383   Hash.final(Result);
384 
385   Hash.stringifyResult(Result, Checksum);
386   return llvm::DIFile::CSK_MD5;
387 }
388 
389 Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
390                                            FileID FID) {
391   if (!CGM.getCodeGenOpts().EmbedSource)
392     return None;
393 
394   bool SourceInvalid = false;
395   StringRef Source = SM.getBufferData(FID, &SourceInvalid);
396 
397   if (SourceInvalid)
398     return None;
399 
400   return Source;
401 }
402 
403 llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
404   if (!Loc.isValid())
405     // If Location is not valid then use main input file.
406     return TheCU->getFile();
407 
408   SourceManager &SM = CGM.getContext().getSourceManager();
409   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
410 
411   StringRef FileName = PLoc.getFilename();
412   if (PLoc.isInvalid() || FileName.empty())
413     // If the location is not valid then use main input file.
414     return TheCU->getFile();
415 
416   // Cache the results.
417   auto It = DIFileCache.find(FileName.data());
418   if (It != DIFileCache.end()) {
419     // Verify that the information still exists.
420     if (llvm::Metadata *V = It->second)
421       return cast<llvm::DIFile>(V);
422   }
423 
424   SmallString<32> Checksum;
425   Optional<llvm::DIFile::ChecksumKind> CSKind =
426       computeChecksum(SM.getFileID(Loc), Checksum);
427   Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
428   if (CSKind)
429     CSInfo.emplace(*CSKind, Checksum);
430   return createFile(FileName, CSInfo, getSource(SM, SM.getFileID(Loc)));
431 }
432 
433 llvm::DIFile *
434 CGDebugInfo::createFile(StringRef FileName,
435                         Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
436                         Optional<StringRef> Source) {
437   StringRef Dir;
438   StringRef File;
439   std::string RemappedFile = remapDIPath(FileName);
440   std::string CurDir = remapDIPath(getCurrentDirname());
441   SmallString<128> DirBuf;
442   SmallString<128> FileBuf;
443   if (llvm::sys::path::is_absolute(RemappedFile)) {
444     // Strip the common prefix (if it is more than just "/") from current
445     // directory and FileName for a more space-efficient encoding.
446     auto FileIt = llvm::sys::path::begin(RemappedFile);
447     auto FileE = llvm::sys::path::end(RemappedFile);
448     auto CurDirIt = llvm::sys::path::begin(CurDir);
449     auto CurDirE = llvm::sys::path::end(CurDir);
450     for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
451       llvm::sys::path::append(DirBuf, *CurDirIt);
452     if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
453       // Don't strip the common prefix if it is only the root "/"
454       // since that would make LLVM diagnostic locations confusing.
455       Dir = {};
456       File = RemappedFile;
457     } else {
458       for (; FileIt != FileE; ++FileIt)
459         llvm::sys::path::append(FileBuf, *FileIt);
460       Dir = DirBuf;
461       File = FileBuf;
462     }
463   } else {
464     Dir = CurDir;
465     File = RemappedFile;
466   }
467   llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
468   DIFileCache[FileName.data()].reset(F);
469   return F;
470 }
471 
472 std::string CGDebugInfo::remapDIPath(StringRef Path) const {
473   for (const auto &Entry : DebugPrefixMap)
474     if (Path.startswith(Entry.first))
475       return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
476   return Path.str();
477 }
478 
479 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
480   if (Loc.isInvalid() && CurLoc.isInvalid())
481     return 0;
482   SourceManager &SM = CGM.getContext().getSourceManager();
483   PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
484   return PLoc.isValid() ? PLoc.getLine() : 0;
485 }
486 
487 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
488   // We may not want column information at all.
489   if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
490     return 0;
491 
492   // If the location is invalid then use the current column.
493   if (Loc.isInvalid() && CurLoc.isInvalid())
494     return 0;
495   SourceManager &SM = CGM.getContext().getSourceManager();
496   PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
497   return PLoc.isValid() ? PLoc.getColumn() : 0;
498 }
499 
500 StringRef CGDebugInfo::getCurrentDirname() {
501   if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
502     return CGM.getCodeGenOpts().DebugCompilationDir;
503 
504   if (!CWDName.empty())
505     return CWDName;
506   SmallString<256> CWD;
507   llvm::sys::fs::current_path(CWD);
508   return CWDName = internString(CWD);
509 }
510 
511 void CGDebugInfo::CreateCompileUnit() {
512   SmallString<32> Checksum;
513   Optional<llvm::DIFile::ChecksumKind> CSKind;
514   Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
515 
516   // Should we be asking the SourceManager for the main file name, instead of
517   // accepting it as an argument? This just causes the main file name to
518   // mismatch with source locations and create extra lexical scopes or
519   // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
520   // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
521   // because that's what the SourceManager says)
522 
523   // Get absolute path name.
524   SourceManager &SM = CGM.getContext().getSourceManager();
525   std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
526   if (MainFileName.empty())
527     MainFileName = "<stdin>";
528 
529   // The main file name provided via the "-main-file-name" option contains just
530   // the file name itself with no path information. This file name may have had
531   // a relative path, so we look into the actual file entry for the main
532   // file to determine the real absolute path for the file.
533   std::string MainFileDir;
534   if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
535     MainFileDir = remapDIPath(MainFile->getDir()->getName());
536     if (MainFileDir != ".") {
537       llvm::SmallString<1024> MainFileDirSS(MainFileDir);
538       llvm::sys::path::append(MainFileDirSS, MainFileName);
539       MainFileName = MainFileDirSS.str();
540     }
541     // If the main file name provided is identical to the input file name, and
542     // if the input file is a preprocessed source, use the module name for
543     // debug info. The module name comes from the name specified in the first
544     // linemarker if the input is a preprocessed source.
545     if (MainFile->getName() == MainFileName &&
546         FrontendOptions::getInputKindForExtension(
547             MainFile->getName().rsplit('.').second)
548             .isPreprocessed())
549       MainFileName = CGM.getModule().getName().str();
550 
551     CSKind = computeChecksum(SM.getMainFileID(), Checksum);
552   }
553 
554   llvm::dwarf::SourceLanguage LangTag;
555   const LangOptions &LO = CGM.getLangOpts();
556   if (LO.CPlusPlus) {
557     if (LO.ObjC)
558       LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
559     else
560       LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
561   } else if (LO.ObjC) {
562     LangTag = llvm::dwarf::DW_LANG_ObjC;
563   } else if (LO.RenderScript) {
564     LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
565   } else if (LO.C99) {
566     LangTag = llvm::dwarf::DW_LANG_C99;
567   } else {
568     LangTag = llvm::dwarf::DW_LANG_C89;
569   }
570 
571   std::string Producer = getClangFullVersion();
572 
573   // Figure out which version of the ObjC runtime we have.
574   unsigned RuntimeVers = 0;
575   if (LO.ObjC)
576     RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
577 
578   llvm::DICompileUnit::DebugEmissionKind EmissionKind;
579   switch (DebugKind) {
580   case codegenoptions::NoDebugInfo:
581   case codegenoptions::LocTrackingOnly:
582     EmissionKind = llvm::DICompileUnit::NoDebug;
583     break;
584   case codegenoptions::DebugLineTablesOnly:
585     EmissionKind = llvm::DICompileUnit::LineTablesOnly;
586     break;
587   case codegenoptions::DebugDirectivesOnly:
588     EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
589     break;
590   case codegenoptions::LimitedDebugInfo:
591   case codegenoptions::FullDebugInfo:
592     EmissionKind = llvm::DICompileUnit::FullDebug;
593     break;
594   }
595 
596   uint64_t DwoId = 0;
597   auto &CGOpts = CGM.getCodeGenOpts();
598   // The DIFile used by the CU is distinct from the main source
599   // file. Its directory part specifies what becomes the
600   // DW_AT_comp_dir (the compilation directory), even if the source
601   // file was specified with an absolute path.
602   if (CSKind)
603     CSInfo.emplace(*CSKind, Checksum);
604   llvm::DIFile *CUFile = DBuilder.createFile(
605       remapDIPath(MainFileName), remapDIPath(getCurrentDirname()), CSInfo,
606       getSource(SM, SM.getMainFileID()));
607 
608   // Create new compile unit.
609   TheCU = DBuilder.createCompileUnit(
610       LangTag, CUFile, CGOpts.EmitVersionIdentMetadata ? Producer : "",
611       LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
612       CGOpts.DwarfDebugFlags, RuntimeVers,
613       (CGOpts.getSplitDwarfMode() != CodeGenOptions::NoFission)
614           ? ""
615           : CGOpts.SplitDwarfFile,
616       EmissionKind, DwoId, CGOpts.SplitDwarfInlining,
617       CGOpts.DebugInfoForProfiling,
618       CGM.getTarget().getTriple().isNVPTX()
619           ? llvm::DICompileUnit::DebugNameTableKind::None
620           : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
621                 CGOpts.DebugNameTable),
622       CGOpts.DebugRangesBaseAddress);
623 }
624 
625 llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
626   llvm::dwarf::TypeKind Encoding;
627   StringRef BTName;
628   switch (BT->getKind()) {
629 #define BUILTIN_TYPE(Id, SingletonId)
630 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
631 #include "clang/AST/BuiltinTypes.def"
632   case BuiltinType::Dependent:
633     llvm_unreachable("Unexpected builtin type");
634   case BuiltinType::NullPtr:
635     return DBuilder.createNullPtrType();
636   case BuiltinType::Void:
637     return nullptr;
638   case BuiltinType::ObjCClass:
639     if (!ClassTy)
640       ClassTy =
641           DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
642                                      "objc_class", TheCU, TheCU->getFile(), 0);
643     return ClassTy;
644   case BuiltinType::ObjCId: {
645     // typedef struct objc_class *Class;
646     // typedef struct objc_object {
647     //  Class isa;
648     // } *id;
649 
650     if (ObjTy)
651       return ObjTy;
652 
653     if (!ClassTy)
654       ClassTy =
655           DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
656                                      "objc_class", TheCU, TheCU->getFile(), 0);
657 
658     unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
659 
660     auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
661 
662     ObjTy = DBuilder.createStructType(TheCU, "objc_object", TheCU->getFile(), 0,
663                                       0, 0, llvm::DINode::FlagZero, nullptr,
664                                       llvm::DINodeArray());
665 
666     DBuilder.replaceArrays(
667         ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
668                    ObjTy, "isa", TheCU->getFile(), 0, Size, 0, 0,
669                    llvm::DINode::FlagZero, ISATy)));
670     return ObjTy;
671   }
672   case BuiltinType::ObjCSel: {
673     if (!SelTy)
674       SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
675                                          "objc_selector", TheCU,
676                                          TheCU->getFile(), 0);
677     return SelTy;
678   }
679 
680 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
681   case BuiltinType::Id:                                                        \
682     return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t",       \
683                                     SingletonId);
684 #include "clang/Basic/OpenCLImageTypes.def"
685   case BuiltinType::OCLSampler:
686     return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
687   case BuiltinType::OCLEvent:
688     return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
689   case BuiltinType::OCLClkEvent:
690     return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
691   case BuiltinType::OCLQueue:
692     return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
693   case BuiltinType::OCLReserveID:
694     return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
695 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
696   case BuiltinType::Id: \
697     return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
698 #include "clang/Basic/OpenCLExtensionTypes.def"
699 
700   case BuiltinType::UChar:
701   case BuiltinType::Char_U:
702     Encoding = llvm::dwarf::DW_ATE_unsigned_char;
703     break;
704   case BuiltinType::Char_S:
705   case BuiltinType::SChar:
706     Encoding = llvm::dwarf::DW_ATE_signed_char;
707     break;
708   case BuiltinType::Char8:
709   case BuiltinType::Char16:
710   case BuiltinType::Char32:
711     Encoding = llvm::dwarf::DW_ATE_UTF;
712     break;
713   case BuiltinType::UShort:
714   case BuiltinType::UInt:
715   case BuiltinType::UInt128:
716   case BuiltinType::ULong:
717   case BuiltinType::WChar_U:
718   case BuiltinType::ULongLong:
719     Encoding = llvm::dwarf::DW_ATE_unsigned;
720     break;
721   case BuiltinType::Short:
722   case BuiltinType::Int:
723   case BuiltinType::Int128:
724   case BuiltinType::Long:
725   case BuiltinType::WChar_S:
726   case BuiltinType::LongLong:
727     Encoding = llvm::dwarf::DW_ATE_signed;
728     break;
729   case BuiltinType::Bool:
730     Encoding = llvm::dwarf::DW_ATE_boolean;
731     break;
732   case BuiltinType::Half:
733   case BuiltinType::Float:
734   case BuiltinType::LongDouble:
735   case BuiltinType::Float16:
736   case BuiltinType::Float128:
737   case BuiltinType::Double:
738     // FIXME: For targets where long double and __float128 have the same size,
739     // they are currently indistinguishable in the debugger without some
740     // special treatment. However, there is currently no consensus on encoding
741     // and this should be updated once a DWARF encoding exists for distinct
742     // floating point types of the same size.
743     Encoding = llvm::dwarf::DW_ATE_float;
744     break;
745   case BuiltinType::ShortAccum:
746   case BuiltinType::Accum:
747   case BuiltinType::LongAccum:
748   case BuiltinType::ShortFract:
749   case BuiltinType::Fract:
750   case BuiltinType::LongFract:
751   case BuiltinType::SatShortFract:
752   case BuiltinType::SatFract:
753   case BuiltinType::SatLongFract:
754   case BuiltinType::SatShortAccum:
755   case BuiltinType::SatAccum:
756   case BuiltinType::SatLongAccum:
757     Encoding = llvm::dwarf::DW_ATE_signed_fixed;
758     break;
759   case BuiltinType::UShortAccum:
760   case BuiltinType::UAccum:
761   case BuiltinType::ULongAccum:
762   case BuiltinType::UShortFract:
763   case BuiltinType::UFract:
764   case BuiltinType::ULongFract:
765   case BuiltinType::SatUShortAccum:
766   case BuiltinType::SatUAccum:
767   case BuiltinType::SatULongAccum:
768   case BuiltinType::SatUShortFract:
769   case BuiltinType::SatUFract:
770   case BuiltinType::SatULongFract:
771     Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
772     break;
773   }
774 
775   switch (BT->getKind()) {
776   case BuiltinType::Long:
777     BTName = "long int";
778     break;
779   case BuiltinType::LongLong:
780     BTName = "long long int";
781     break;
782   case BuiltinType::ULong:
783     BTName = "long unsigned int";
784     break;
785   case BuiltinType::ULongLong:
786     BTName = "long long unsigned int";
787     break;
788   default:
789     BTName = BT->getName(CGM.getLangOpts());
790     break;
791   }
792   // Bit size and offset of the type.
793   uint64_t Size = CGM.getContext().getTypeSize(BT);
794   return DBuilder.createBasicType(BTName, Size, Encoding);
795 }
796 
797 llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
798   // Bit size and offset of the type.
799   llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
800   if (Ty->isComplexIntegerType())
801     Encoding = llvm::dwarf::DW_ATE_lo_user;
802 
803   uint64_t Size = CGM.getContext().getTypeSize(Ty);
804   return DBuilder.createBasicType("complex", Size, Encoding);
805 }
806 
807 llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
808                                                llvm::DIFile *Unit) {
809   QualifierCollector Qc;
810   const Type *T = Qc.strip(Ty);
811 
812   // Ignore these qualifiers for now.
813   Qc.removeObjCGCAttr();
814   Qc.removeAddressSpace();
815   Qc.removeObjCLifetime();
816 
817   // We will create one Derived type for one qualifier and recurse to handle any
818   // additional ones.
819   llvm::dwarf::Tag Tag;
820   if (Qc.hasConst()) {
821     Tag = llvm::dwarf::DW_TAG_const_type;
822     Qc.removeConst();
823   } else if (Qc.hasVolatile()) {
824     Tag = llvm::dwarf::DW_TAG_volatile_type;
825     Qc.removeVolatile();
826   } else if (Qc.hasRestrict()) {
827     Tag = llvm::dwarf::DW_TAG_restrict_type;
828     Qc.removeRestrict();
829   } else {
830     assert(Qc.empty() && "Unknown type qualifier for debug info");
831     return getOrCreateType(QualType(T, 0), Unit);
832   }
833 
834   auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
835 
836   // No need to fill in the Name, Line, Size, Alignment, Offset in case of
837   // CVR derived types.
838   return DBuilder.createQualifiedType(Tag, FromTy);
839 }
840 
841 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
842                                       llvm::DIFile *Unit) {
843 
844   // The frontend treats 'id' as a typedef to an ObjCObjectType,
845   // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
846   // debug info, we want to emit 'id' in both cases.
847   if (Ty->isObjCQualifiedIdType())
848     return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
849 
850   return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
851                                Ty->getPointeeType(), Unit);
852 }
853 
854 llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
855                                       llvm::DIFile *Unit) {
856   return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
857                                Ty->getPointeeType(), Unit);
858 }
859 
860 /// \return whether a C++ mangling exists for the type defined by TD.
861 static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
862   switch (TheCU->getSourceLanguage()) {
863   case llvm::dwarf::DW_LANG_C_plus_plus:
864     return true;
865   case llvm::dwarf::DW_LANG_ObjC_plus_plus:
866     return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
867   default:
868     return false;
869   }
870 }
871 
872 // Determines if the debug info for this tag declaration needs a type
873 // identifier. The purpose of the unique identifier is to deduplicate type
874 // information for identical types across TUs. Because of the C++ one definition
875 // rule (ODR), it is valid to assume that the type is defined the same way in
876 // every TU and its debug info is equivalent.
877 //
878 // C does not have the ODR, and it is common for codebases to contain multiple
879 // different definitions of a struct with the same name in different TUs.
880 // Therefore, if the type doesn't have a C++ mangling, don't give it an
881 // identifer. Type information in C is smaller and simpler than C++ type
882 // information, so the increase in debug info size is negligible.
883 //
884 // If the type is not externally visible, it should be unique to the current TU,
885 // and should not need an identifier to participate in type deduplication.
886 // However, when emitting CodeView, the format internally uses these
887 // unique type name identifers for references between debug info. For example,
888 // the method of a class in an anonymous namespace uses the identifer to refer
889 // to its parent class. The Microsoft C++ ABI attempts to provide unique names
890 // for such types, so when emitting CodeView, always use identifiers for C++
891 // types. This may create problems when attempting to emit CodeView when the MS
892 // C++ ABI is not in use.
893 static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
894                                 llvm::DICompileUnit *TheCU) {
895   // We only add a type identifier for types with C++ name mangling.
896   if (!hasCXXMangling(TD, TheCU))
897     return false;
898 
899   // Externally visible types with C++ mangling need a type identifier.
900   if (TD->isExternallyVisible())
901     return true;
902 
903   // CodeView types with C++ mangling need a type identifier.
904   if (CGM.getCodeGenOpts().EmitCodeView)
905     return true;
906 
907   return false;
908 }
909 
910 // Returns a unique type identifier string if one exists, or an empty string.
911 static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
912                                           llvm::DICompileUnit *TheCU) {
913   SmallString<256> Identifier;
914   const TagDecl *TD = Ty->getDecl();
915 
916   if (!needsTypeIdentifier(TD, CGM, TheCU))
917     return Identifier;
918   if (const auto *RD = dyn_cast<CXXRecordDecl>(TD))
919     if (RD->getDefinition())
920       if (RD->isDynamicClass() &&
921           CGM.getVTableLinkage(RD) == llvm::GlobalValue::ExternalLinkage)
922         return Identifier;
923 
924   // TODO: This is using the RTTI name. Is there a better way to get
925   // a unique string for a type?
926   llvm::raw_svector_ostream Out(Identifier);
927   CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
928   return Identifier;
929 }
930 
931 /// \return the appropriate DWARF tag for a composite type.
932 static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
933   llvm::dwarf::Tag Tag;
934   if (RD->isStruct() || RD->isInterface())
935     Tag = llvm::dwarf::DW_TAG_structure_type;
936   else if (RD->isUnion())
937     Tag = llvm::dwarf::DW_TAG_union_type;
938   else {
939     // FIXME: This could be a struct type giving a default visibility different
940     // than C++ class type, but needs llvm metadata changes first.
941     assert(RD->isClass());
942     Tag = llvm::dwarf::DW_TAG_class_type;
943   }
944   return Tag;
945 }
946 
947 llvm::DICompositeType *
948 CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
949                                       llvm::DIScope *Ctx) {
950   const RecordDecl *RD = Ty->getDecl();
951   if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
952     return cast<llvm::DICompositeType>(T);
953   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
954   unsigned Line = getLineNumber(RD->getLocation());
955   StringRef RDName = getClassName(RD);
956 
957   uint64_t Size = 0;
958   uint32_t Align = 0;
959 
960   // Create the type.
961   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
962   llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
963       getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
964       llvm::DINode::FlagFwdDecl, Identifier);
965   if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
966     if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
967       DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
968                              CollectCXXTemplateParams(TSpecial, DefUnit));
969   ReplaceMap.emplace_back(
970       std::piecewise_construct, std::make_tuple(Ty),
971       std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
972   return RetTy;
973 }
974 
975 llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
976                                                  const Type *Ty,
977                                                  QualType PointeeTy,
978                                                  llvm::DIFile *Unit) {
979   // Bit size, align and offset of the type.
980   // Size is always the size of a pointer. We can't use getTypeSize here
981   // because that does not return the correct value for references.
982   unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
983   uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
984   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
985   Optional<unsigned> DWARFAddressSpace =
986       CGM.getTarget().getDWARFAddressSpace(AddressSpace);
987 
988   if (Tag == llvm::dwarf::DW_TAG_reference_type ||
989       Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
990     return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
991                                         Size, Align, DWARFAddressSpace);
992   else
993     return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
994                                       Align, DWARFAddressSpace);
995 }
996 
997 llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
998                                                     llvm::DIType *&Cache) {
999   if (Cache)
1000     return Cache;
1001   Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
1002                                      TheCU, TheCU->getFile(), 0);
1003   unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1004   Cache = DBuilder.createPointerType(Cache, Size);
1005   return Cache;
1006 }
1007 
1008 uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
1009     const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
1010     unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
1011   QualType FType;
1012 
1013   // Advanced by calls to CreateMemberType in increments of FType, then
1014   // returned as the overall size of the default elements.
1015   uint64_t FieldOffset = 0;
1016 
1017   // Blocks in OpenCL have unique constraints which make the standard fields
1018   // redundant while requiring size and align fields for enqueue_kernel. See
1019   // initializeForBlockHeader in CGBlocks.cpp
1020   if (CGM.getLangOpts().OpenCL) {
1021     FType = CGM.getContext().IntTy;
1022     EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
1023     EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
1024   } else {
1025     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1026     EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
1027     FType = CGM.getContext().IntTy;
1028     EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
1029     EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
1030     FType = CGM.getContext().getPointerType(Ty->getPointeeType());
1031     EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
1032     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1033     uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
1034     uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
1035     EltTys.push_back(DBuilder.createMemberType(
1036         Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
1037         FieldOffset, llvm::DINode::FlagZero, DescTy));
1038     FieldOffset += FieldSize;
1039   }
1040 
1041   return FieldOffset;
1042 }
1043 
1044 llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1045                                       llvm::DIFile *Unit) {
1046   SmallVector<llvm::Metadata *, 8> EltTys;
1047   QualType FType;
1048   uint64_t FieldOffset;
1049   llvm::DINodeArray Elements;
1050 
1051   FieldOffset = 0;
1052   FType = CGM.getContext().UnsignedLongTy;
1053   EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1054   EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1055 
1056   Elements = DBuilder.getOrCreateArray(EltTys);
1057   EltTys.clear();
1058 
1059   llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1060 
1061   auto *EltTy =
1062       DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1063                                 FieldOffset, 0, Flags, nullptr, Elements);
1064 
1065   // Bit size, align and offset of the type.
1066   uint64_t Size = CGM.getContext().getTypeSize(Ty);
1067 
1068   auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1069 
1070   FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1071                                                           0, EltTys);
1072 
1073   Elements = DBuilder.getOrCreateArray(EltTys);
1074 
1075   // The __block_literal_generic structs are marked with a special
1076   // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1077   // the debugger needs to know about. To allow type uniquing, emit
1078   // them without a name or a location.
1079   EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
1080                                     Flags, nullptr, Elements);
1081 
1082   return DBuilder.createPointerType(EltTy, Size);
1083 }
1084 
1085 llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1086                                       llvm::DIFile *Unit) {
1087   assert(Ty->isTypeAlias());
1088   llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
1089 
1090   SmallString<128> NS;
1091   llvm::raw_svector_ostream OS(NS);
1092   Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1093   printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
1094 
1095   auto *AliasDecl =
1096       cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1097           ->getTemplatedDecl();
1098 
1099   SourceLocation Loc = AliasDecl->getLocation();
1100   return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1101                                 getLineNumber(Loc),
1102                                 getDeclContextDescriptor(AliasDecl));
1103 }
1104 
1105 llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1106                                       llvm::DIFile *Unit) {
1107   // We don't set size information, but do specify where the typedef was
1108   // declared.
1109   SourceLocation Loc = Ty->getDecl()->getLocation();
1110 
1111   // Typedefs are derived from some other type.
1112   return DBuilder.createTypedef(
1113       getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1114       Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
1115       getDeclContextDescriptor(Ty->getDecl()));
1116 }
1117 
1118 static unsigned getDwarfCC(CallingConv CC) {
1119   switch (CC) {
1120   case CC_C:
1121     // Avoid emitting DW_AT_calling_convention if the C convention was used.
1122     return 0;
1123 
1124   case CC_X86StdCall:
1125     return llvm::dwarf::DW_CC_BORLAND_stdcall;
1126   case CC_X86FastCall:
1127     return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1128   case CC_X86ThisCall:
1129     return llvm::dwarf::DW_CC_BORLAND_thiscall;
1130   case CC_X86VectorCall:
1131     return llvm::dwarf::DW_CC_LLVM_vectorcall;
1132   case CC_X86Pascal:
1133     return llvm::dwarf::DW_CC_BORLAND_pascal;
1134   case CC_Win64:
1135     return llvm::dwarf::DW_CC_LLVM_Win64;
1136   case CC_X86_64SysV:
1137     return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
1138   case CC_AAPCS:
1139   case CC_AArch64VectorCall:
1140     return llvm::dwarf::DW_CC_LLVM_AAPCS;
1141   case CC_AAPCS_VFP:
1142     return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
1143   case CC_IntelOclBicc:
1144     return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
1145   case CC_SpirFunction:
1146     return llvm::dwarf::DW_CC_LLVM_SpirFunction;
1147   case CC_OpenCLKernel:
1148     return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
1149   case CC_Swift:
1150     return llvm::dwarf::DW_CC_LLVM_Swift;
1151   case CC_PreserveMost:
1152     return llvm::dwarf::DW_CC_LLVM_PreserveMost;
1153   case CC_PreserveAll:
1154     return llvm::dwarf::DW_CC_LLVM_PreserveAll;
1155   case CC_X86RegCall:
1156     return llvm::dwarf::DW_CC_LLVM_X86RegCall;
1157   }
1158   return 0;
1159 }
1160 
1161 llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1162                                       llvm::DIFile *Unit) {
1163   SmallVector<llvm::Metadata *, 16> EltTys;
1164 
1165   // Add the result type at least.
1166   EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
1167 
1168   // Set up remainder of arguments if there is a prototype.
1169   // otherwise emit it as a variadic function.
1170   if (isa<FunctionNoProtoType>(Ty))
1171     EltTys.push_back(DBuilder.createUnspecifiedParameter());
1172   else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1173     for (const QualType &ParamType : FPT->param_types())
1174       EltTys.push_back(getOrCreateType(ParamType, Unit));
1175     if (FPT->isVariadic())
1176       EltTys.push_back(DBuilder.createUnspecifiedParameter());
1177   }
1178 
1179   llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
1180   return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
1181                                        getDwarfCC(Ty->getCallConv()));
1182 }
1183 
1184 /// Convert an AccessSpecifier into the corresponding DINode flag.
1185 /// As an optimization, return 0 if the access specifier equals the
1186 /// default for the containing type.
1187 static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1188                                            const RecordDecl *RD) {
1189   AccessSpecifier Default = clang::AS_none;
1190   if (RD && RD->isClass())
1191     Default = clang::AS_private;
1192   else if (RD && (RD->isStruct() || RD->isUnion()))
1193     Default = clang::AS_public;
1194 
1195   if (Access == Default)
1196     return llvm::DINode::FlagZero;
1197 
1198   switch (Access) {
1199   case clang::AS_private:
1200     return llvm::DINode::FlagPrivate;
1201   case clang::AS_protected:
1202     return llvm::DINode::FlagProtected;
1203   case clang::AS_public:
1204     return llvm::DINode::FlagPublic;
1205   case clang::AS_none:
1206     return llvm::DINode::FlagZero;
1207   }
1208   llvm_unreachable("unexpected access enumerator");
1209 }
1210 
1211 llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1212                                               llvm::DIScope *RecordTy,
1213                                               const RecordDecl *RD) {
1214   StringRef Name = BitFieldDecl->getName();
1215   QualType Ty = BitFieldDecl->getType();
1216   SourceLocation Loc = BitFieldDecl->getLocation();
1217   llvm::DIFile *VUnit = getOrCreateFile(Loc);
1218   llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1219 
1220   // Get the location for the field.
1221   llvm::DIFile *File = getOrCreateFile(Loc);
1222   unsigned Line = getLineNumber(Loc);
1223 
1224   const CGBitFieldInfo &BitFieldInfo =
1225       CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1226   uint64_t SizeInBits = BitFieldInfo.Size;
1227   assert(SizeInBits > 0 && "found named 0-width bitfield");
1228   uint64_t StorageOffsetInBits =
1229       CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1230   uint64_t Offset = BitFieldInfo.Offset;
1231   // The bit offsets for big endian machines are reversed for big
1232   // endian target, compensate for that as the DIDerivedType requires
1233   // un-reversed offsets.
1234   if (CGM.getDataLayout().isBigEndian())
1235     Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1236   uint64_t OffsetInBits = StorageOffsetInBits + Offset;
1237   llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
1238   return DBuilder.createBitFieldMemberType(
1239       RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1240       Flags, DebugType);
1241 }
1242 
1243 llvm::DIType *
1244 CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1245                              AccessSpecifier AS, uint64_t offsetInBits,
1246                              uint32_t AlignInBits, llvm::DIFile *tunit,
1247                              llvm::DIScope *scope, const RecordDecl *RD) {
1248   llvm::DIType *debugType = getOrCreateType(type, tunit);
1249 
1250   // Get the location for the field.
1251   llvm::DIFile *file = getOrCreateFile(loc);
1252   unsigned line = getLineNumber(loc);
1253 
1254   uint64_t SizeInBits = 0;
1255   auto Align = AlignInBits;
1256   if (!type->isIncompleteArrayType()) {
1257     TypeInfo TI = CGM.getContext().getTypeInfo(type);
1258     SizeInBits = TI.Width;
1259     if (!Align)
1260       Align = getTypeAlignIfRequired(type, CGM.getContext());
1261   }
1262 
1263   llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
1264   return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1265                                    offsetInBits, flags, debugType);
1266 }
1267 
1268 void CGDebugInfo::CollectRecordLambdaFields(
1269     const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
1270     llvm::DIType *RecordTy) {
1271   // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1272   // has the name and the location of the variable so we should iterate over
1273   // both concurrently.
1274   const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1275   RecordDecl::field_iterator Field = CXXDecl->field_begin();
1276   unsigned fieldno = 0;
1277   for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
1278                                              E = CXXDecl->captures_end();
1279        I != E; ++I, ++Field, ++fieldno) {
1280     const LambdaCapture &C = *I;
1281     if (C.capturesVariable()) {
1282       SourceLocation Loc = C.getLocation();
1283       assert(!Field->isBitField() && "lambdas don't have bitfield members!");
1284       VarDecl *V = C.getCapturedVar();
1285       StringRef VName = V->getName();
1286       llvm::DIFile *VUnit = getOrCreateFile(Loc);
1287       auto Align = getDeclAlignIfRequired(V, CGM.getContext());
1288       llvm::DIType *FieldType = createFieldType(
1289           VName, Field->getType(), Loc, Field->getAccess(),
1290           layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
1291       elements.push_back(FieldType);
1292     } else if (C.capturesThis()) {
1293       // TODO: Need to handle 'this' in some way by probably renaming the
1294       // this of the lambda class and having a field member of 'this' or
1295       // by using AT_object_pointer for the function and having that be
1296       // used as 'this' for semantic references.
1297       FieldDecl *f = *Field;
1298       llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
1299       QualType type = f->getType();
1300       llvm::DIType *fieldType = createFieldType(
1301           "this", type, f->getLocation(), f->getAccess(),
1302           layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1303 
1304       elements.push_back(fieldType);
1305     }
1306   }
1307 }
1308 
1309 llvm::DIDerivedType *
1310 CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
1311                                      const RecordDecl *RD) {
1312   // Create the descriptor for the static variable, with or without
1313   // constant initializers.
1314   Var = Var->getCanonicalDecl();
1315   llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1316   llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
1317 
1318   unsigned LineNumber = getLineNumber(Var->getLocation());
1319   StringRef VName = Var->getName();
1320   llvm::Constant *C = nullptr;
1321   if (Var->getInit()) {
1322     const APValue *Value = Var->evaluateValue();
1323     if (Value) {
1324       if (Value->isInt())
1325         C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1326       if (Value->isFloat())
1327         C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1328     }
1329   }
1330 
1331   llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
1332   auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
1333   llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
1334       RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
1335   StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
1336   return GV;
1337 }
1338 
1339 void CGDebugInfo::CollectRecordNormalField(
1340     const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1341     SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
1342     const RecordDecl *RD) {
1343   StringRef name = field->getName();
1344   QualType type = field->getType();
1345 
1346   // Ignore unnamed fields unless they're anonymous structs/unions.
1347   if (name.empty() && !type->isRecordType())
1348     return;
1349 
1350   llvm::DIType *FieldType;
1351   if (field->isBitField()) {
1352     FieldType = createBitFieldType(field, RecordTy, RD);
1353   } else {
1354     auto Align = getDeclAlignIfRequired(field, CGM.getContext());
1355     FieldType =
1356         createFieldType(name, type, field->getLocation(), field->getAccess(),
1357                         OffsetInBits, Align, tunit, RecordTy, RD);
1358   }
1359 
1360   elements.push_back(FieldType);
1361 }
1362 
1363 void CGDebugInfo::CollectRecordNestedType(
1364     const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1365   QualType Ty = CGM.getContext().getTypeDeclType(TD);
1366   // Injected class names are not considered nested records.
1367   if (isa<InjectedClassNameType>(Ty))
1368     return;
1369   SourceLocation Loc = TD->getLocation();
1370   llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1371   elements.push_back(nestedType);
1372 }
1373 
1374 void CGDebugInfo::CollectRecordFields(
1375     const RecordDecl *record, llvm::DIFile *tunit,
1376     SmallVectorImpl<llvm::Metadata *> &elements,
1377     llvm::DICompositeType *RecordTy) {
1378   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1379 
1380   if (CXXDecl && CXXDecl->isLambda())
1381     CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1382   else {
1383     const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
1384 
1385     // Field number for non-static fields.
1386     unsigned fieldNo = 0;
1387 
1388     // Static and non-static members should appear in the same order as
1389     // the corresponding declarations in the source program.
1390     for (const auto *I : record->decls())
1391       if (const auto *V = dyn_cast<VarDecl>(I)) {
1392         if (V->hasAttr<NoDebugAttr>())
1393           continue;
1394 
1395         // Skip variable template specializations when emitting CodeView. MSVC
1396         // doesn't emit them.
1397         if (CGM.getCodeGenOpts().EmitCodeView &&
1398             isa<VarTemplateSpecializationDecl>(V))
1399           continue;
1400 
1401         // Reuse the existing static member declaration if one exists
1402         auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
1403         if (MI != StaticDataMemberCache.end()) {
1404           assert(MI->second &&
1405                  "Static data member declaration should still exist");
1406           elements.push_back(MI->second);
1407         } else {
1408           auto Field = CreateRecordStaticField(V, RecordTy, record);
1409           elements.push_back(Field);
1410         }
1411       } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
1412         CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1413                                  elements, RecordTy, record);
1414 
1415         // Bump field number for next field.
1416         ++fieldNo;
1417       } else if (CGM.getCodeGenOpts().EmitCodeView) {
1418         // Debug info for nested types is included in the member list only for
1419         // CodeView.
1420         if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1421           if (!nestedType->isImplicit() &&
1422               nestedType->getDeclContext() == record)
1423             CollectRecordNestedType(nestedType, elements);
1424       }
1425   }
1426 }
1427 
1428 llvm::DISubroutineType *
1429 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1430                                    llvm::DIFile *Unit) {
1431   const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
1432   if (Method->isStatic())
1433     return cast_or_null<llvm::DISubroutineType>(
1434         getOrCreateType(QualType(Func, 0), Unit));
1435   return getOrCreateInstanceMethodType(Method->getThisType(), Func, Unit);
1436 }
1437 
1438 llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1439     QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
1440   // Add "this" pointer.
1441   llvm::DITypeRefArray Args(
1442       cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
1443           ->getTypeArray());
1444   assert(Args.size() && "Invalid number of arguments!");
1445 
1446   SmallVector<llvm::Metadata *, 16> Elts;
1447 
1448   // First element is always return type. For 'void' functions it is NULL.
1449   Elts.push_back(Args[0]);
1450 
1451   // "this" pointer is always first argument.
1452   const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
1453   if (isa<ClassTemplateSpecializationDecl>(RD)) {
1454     // Create pointer type directly in this case.
1455     const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1456     QualType PointeeTy = ThisPtrTy->getPointeeType();
1457     unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
1458     uint64_t Size = CGM.getTarget().getPointerWidth(AS);
1459     auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
1460     llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1461     llvm::DIType *ThisPtrType =
1462         DBuilder.createPointerType(PointeeType, Size, Align);
1463     TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1464     // TODO: This and the artificial type below are misleading, the
1465     // types aren't artificial the argument is, but the current
1466     // metadata doesn't represent that.
1467     ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1468     Elts.push_back(ThisPtrType);
1469   } else {
1470     llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
1471     TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1472     ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1473     Elts.push_back(ThisPtrType);
1474   }
1475 
1476   // Copy rest of the arguments.
1477   for (unsigned i = 1, e = Args.size(); i != e; ++i)
1478     Elts.push_back(Args[i]);
1479 
1480   llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
1481 
1482   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1483   if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1484     Flags |= llvm::DINode::FlagLValueReference;
1485   if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1486     Flags |= llvm::DINode::FlagRValueReference;
1487 
1488   return DBuilder.createSubroutineType(EltTypeArray, Flags,
1489                                        getDwarfCC(Func->getCallConv()));
1490 }
1491 
1492 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1493 /// inside a function.
1494 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1495   if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1496     return isFunctionLocalClass(NRD);
1497   if (isa<FunctionDecl>(RD->getDeclContext()))
1498     return true;
1499   return false;
1500 }
1501 
1502 llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1503     const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
1504   bool IsCtorOrDtor =
1505       isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
1506 
1507   StringRef MethodName = getFunctionName(Method);
1508   llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
1509 
1510   // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1511   // make sense to give a single ctor/dtor a linkage name.
1512   StringRef MethodLinkageName;
1513   // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1514   // property to use here. It may've been intended to model "is non-external
1515   // type" but misses cases of non-function-local but non-external classes such
1516   // as those in anonymous namespaces as well as the reverse - external types
1517   // that are function local, such as those in (non-local) inline functions.
1518   if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1519     MethodLinkageName = CGM.getMangledName(Method);
1520 
1521   // Get the location for the method.
1522   llvm::DIFile *MethodDefUnit = nullptr;
1523   unsigned MethodLine = 0;
1524   if (!Method->isImplicit()) {
1525     MethodDefUnit = getOrCreateFile(Method->getLocation());
1526     MethodLine = getLineNumber(Method->getLocation());
1527   }
1528 
1529   // Collect virtual method info.
1530   llvm::DIType *ContainingType = nullptr;
1531   unsigned VIndex = 0;
1532   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1533   llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
1534   int ThisAdjustment = 0;
1535 
1536   if (Method->isVirtual()) {
1537     if (Method->isPure())
1538       SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
1539     else
1540       SPFlags |= llvm::DISubprogram::SPFlagVirtual;
1541 
1542     if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1543       // It doesn't make sense to give a virtual destructor a vtable index,
1544       // since a single destructor has two entries in the vtable.
1545       if (!isa<CXXDestructorDecl>(Method))
1546         VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1547     } else {
1548       // Emit MS ABI vftable information.  There is only one entry for the
1549       // deleting dtor.
1550       const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1551       GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1552       MethodVFTableLocation ML =
1553           CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1554       VIndex = ML.Index;
1555 
1556       // CodeView only records the vftable offset in the class that introduces
1557       // the virtual method. This is possible because, unlike Itanium, the MS
1558       // C++ ABI does not include all virtual methods from non-primary bases in
1559       // the vtable for the most derived class. For example, if C inherits from
1560       // A and B, C's primary vftable will not include B's virtual methods.
1561       if (Method->size_overridden_methods() == 0)
1562         Flags |= llvm::DINode::FlagIntroducedVirtual;
1563 
1564       // The 'this' adjustment accounts for both the virtual and non-virtual
1565       // portions of the adjustment. Presumably the debugger only uses it when
1566       // it knows the dynamic type of an object.
1567       ThisAdjustment = CGM.getCXXABI()
1568                            .getVirtualFunctionPrologueThisAdjustment(GD)
1569                            .getQuantity();
1570     }
1571     ContainingType = RecordTy;
1572   }
1573 
1574   if (Method->isStatic())
1575     Flags |= llvm::DINode::FlagStaticMember;
1576   if (Method->isImplicit())
1577     Flags |= llvm::DINode::FlagArtificial;
1578   Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
1579   if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1580     if (CXXC->isExplicit())
1581       Flags |= llvm::DINode::FlagExplicit;
1582   } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
1583     if (CXXC->isExplicit())
1584       Flags |= llvm::DINode::FlagExplicit;
1585   }
1586   if (Method->hasPrototype())
1587     Flags |= llvm::DINode::FlagPrototyped;
1588   if (Method->getRefQualifier() == RQ_LValue)
1589     Flags |= llvm::DINode::FlagLValueReference;
1590   if (Method->getRefQualifier() == RQ_RValue)
1591     Flags |= llvm::DINode::FlagRValueReference;
1592   if (CGM.getLangOpts().Optimize)
1593     SPFlags |= llvm::DISubprogram::SPFlagOptimized;
1594 
1595   llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1596   llvm::DISubprogram *SP = DBuilder.createMethod(
1597       RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1598       MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
1599       TParamsArray.get());
1600 
1601   SPCache[Method->getCanonicalDecl()].reset(SP);
1602 
1603   return SP;
1604 }
1605 
1606 void CGDebugInfo::CollectCXXMemberFunctions(
1607     const CXXRecordDecl *RD, llvm::DIFile *Unit,
1608     SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
1609 
1610   // Since we want more than just the individual member decls if we
1611   // have templated functions iterate over every declaration to gather
1612   // the functions.
1613   for (const auto *I : RD->decls()) {
1614     const auto *Method = dyn_cast<CXXMethodDecl>(I);
1615     // If the member is implicit, don't add it to the member list. This avoids
1616     // the member being added to type units by LLVM, while still allowing it
1617     // to be emitted into the type declaration/reference inside the compile
1618     // unit.
1619     // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
1620     // FIXME: Handle Using(Shadow?)Decls here to create
1621     // DW_TAG_imported_declarations inside the class for base decls brought into
1622     // derived classes. GDB doesn't seem to notice/leverage these when I tried
1623     // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1624     // referenced)
1625     if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
1626       continue;
1627 
1628     if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1629       continue;
1630 
1631     // Reuse the existing member function declaration if it exists.
1632     // It may be associated with the declaration of the type & should be
1633     // reused as we're building the definition.
1634     //
1635     // This situation can arise in the vtable-based debug info reduction where
1636     // implicit members are emitted in a non-vtable TU.
1637     auto MI = SPCache.find(Method->getCanonicalDecl());
1638     EltTys.push_back(MI == SPCache.end()
1639                          ? CreateCXXMemberFunction(Method, Unit, RecordTy)
1640                          : static_cast<llvm::Metadata *>(MI->second));
1641   }
1642 }
1643 
1644 void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1645                                   SmallVectorImpl<llvm::Metadata *> &EltTys,
1646                                   llvm::DIType *RecordTy) {
1647   llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1648   CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1649                      llvm::DINode::FlagZero);
1650 
1651   // If we are generating CodeView debug info, we also need to emit records for
1652   // indirect virtual base classes.
1653   if (CGM.getCodeGenOpts().EmitCodeView) {
1654     CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1655                        llvm::DINode::FlagIndirectVirtualBase);
1656   }
1657 }
1658 
1659 void CGDebugInfo::CollectCXXBasesAux(
1660     const CXXRecordDecl *RD, llvm::DIFile *Unit,
1661     SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1662     const CXXRecordDecl::base_class_const_range &Bases,
1663     llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1664     llvm::DINode::DIFlags StartingFlags) {
1665   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1666   for (const auto &BI : Bases) {
1667     const auto *Base =
1668         cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
1669     if (!SeenTypes.insert(Base).second)
1670       continue;
1671     auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1672     llvm::DINode::DIFlags BFlags = StartingFlags;
1673     uint64_t BaseOffset;
1674     uint32_t VBPtrOffset = 0;
1675 
1676     if (BI.isVirtual()) {
1677       if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1678         // virtual base offset offset is -ve. The code generator emits dwarf
1679         // expression where it expects +ve number.
1680         BaseOffset = 0 - CGM.getItaniumVTableContext()
1681                              .getVirtualBaseOffsetOffset(RD, Base)
1682                              .getQuantity();
1683       } else {
1684         // In the MS ABI, store the vbtable offset, which is analogous to the
1685         // vbase offset offset in Itanium.
1686         BaseOffset =
1687             4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1688         VBPtrOffset = CGM.getContext()
1689                           .getASTRecordLayout(RD)
1690                           .getVBPtrOffset()
1691                           .getQuantity();
1692       }
1693       BFlags |= llvm::DINode::FlagVirtual;
1694     } else
1695       BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1696     // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1697     // BI->isVirtual() and bits when not.
1698 
1699     BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
1700     llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1701                                                    VBPtrOffset, BFlags);
1702     EltTys.push_back(DTy);
1703   }
1704 }
1705 
1706 llvm::DINodeArray
1707 CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1708                                    ArrayRef<TemplateArgument> TAList,
1709                                    llvm::DIFile *Unit) {
1710   SmallVector<llvm::Metadata *, 16> TemplateParams;
1711   for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1712     const TemplateArgument &TA = TAList[i];
1713     StringRef Name;
1714     if (TPList)
1715       Name = TPList->getParam(i)->getName();
1716     switch (TA.getKind()) {
1717     case TemplateArgument::Type: {
1718       llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
1719       TemplateParams.push_back(
1720           DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
1721     } break;
1722     case TemplateArgument::Integral: {
1723       llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
1724       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1725           TheCU, Name, TTy,
1726           llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
1727     } break;
1728     case TemplateArgument::Declaration: {
1729       const ValueDecl *D = TA.getAsDecl();
1730       QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
1731       llvm::DIType *TTy = getOrCreateType(T, Unit);
1732       llvm::Constant *V = nullptr;
1733       // Skip retrieve the value if that template parameter has cuda device
1734       // attribute, i.e. that value is not available at the host side.
1735       if (!CGM.getLangOpts().CUDA || CGM.getLangOpts().CUDAIsDevice ||
1736           !D->hasAttr<CUDADeviceAttr>()) {
1737         const CXXMethodDecl *MD;
1738         // Variable pointer template parameters have a value that is the address
1739         // of the variable.
1740         if (const auto *VD = dyn_cast<VarDecl>(D))
1741           V = CGM.GetAddrOfGlobalVar(VD);
1742         // Member function pointers have special support for building them,
1743         // though this is currently unsupported in LLVM CodeGen.
1744         else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1745           V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1746         else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1747           V = CGM.GetAddrOfFunction(FD);
1748         // Member data pointers have special handling too to compute the fixed
1749         // offset within the object.
1750         else if (const auto *MPT =
1751                      dyn_cast<MemberPointerType>(T.getTypePtr())) {
1752           // These five lines (& possibly the above member function pointer
1753           // handling) might be able to be refactored to use similar code in
1754           // CodeGenModule::getMemberPointerConstant
1755           uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1756           CharUnits chars =
1757               CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1758           V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1759         }
1760         V = V->stripPointerCasts();
1761       }
1762       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1763           TheCU, Name, TTy, cast_or_null<llvm::Constant>(V)));
1764     } break;
1765     case TemplateArgument::NullPtr: {
1766       QualType T = TA.getNullPtrType();
1767       llvm::DIType *TTy = getOrCreateType(T, Unit);
1768       llvm::Constant *V = nullptr;
1769       // Special case member data pointer null values since they're actually -1
1770       // instead of zero.
1771       if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
1772         // But treat member function pointers as simple zero integers because
1773         // it's easier than having a special case in LLVM's CodeGen. If LLVM
1774         // CodeGen grows handling for values of non-null member function
1775         // pointers then perhaps we could remove this special case and rely on
1776         // EmitNullMemberPointer for member function pointers.
1777         if (MPT->isMemberDataPointer())
1778           V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1779       if (!V)
1780         V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1781       TemplateParams.push_back(
1782           DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
1783     } break;
1784     case TemplateArgument::Template:
1785       TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
1786           TheCU, Name, nullptr,
1787           TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1788       break;
1789     case TemplateArgument::Pack:
1790       TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1791           TheCU, Name, nullptr,
1792           CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1793       break;
1794     case TemplateArgument::Expression: {
1795       const Expr *E = TA.getAsExpr();
1796       QualType T = E->getType();
1797       if (E->isGLValue())
1798         T = CGM.getContext().getLValueReferenceType(T);
1799       llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
1800       assert(V && "Expression in template argument isn't constant");
1801       llvm::DIType *TTy = getOrCreateType(T, Unit);
1802       TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1803           TheCU, Name, TTy, V->stripPointerCasts()));
1804     } break;
1805     // And the following should never occur:
1806     case TemplateArgument::TemplateExpansion:
1807     case TemplateArgument::Null:
1808       llvm_unreachable(
1809           "These argument types shouldn't exist in concrete types");
1810     }
1811   }
1812   return DBuilder.getOrCreateArray(TemplateParams);
1813 }
1814 
1815 llvm::DINodeArray
1816 CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1817                                            llvm::DIFile *Unit) {
1818   if (FD->getTemplatedKind() ==
1819       FunctionDecl::TK_FunctionTemplateSpecialization) {
1820     const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1821                                              ->getTemplate()
1822                                              ->getTemplateParameters();
1823     return CollectTemplateParams(
1824         TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
1825   }
1826   return llvm::DINodeArray();
1827 }
1828 
1829 llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1830                                                         llvm::DIFile *Unit) {
1831   // Always get the full list of parameters, not just the ones from the
1832   // specialization. A partial specialization may have fewer parameters than
1833   // there are arguments.
1834   auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL);
1835   if (!TS)
1836     return llvm::DINodeArray();
1837   VarTemplateDecl *T = TS->getSpecializedTemplate();
1838   const TemplateParameterList *TList = T->getTemplateParameters();
1839   auto TA = TS->getTemplateArgs().asArray();
1840   return CollectTemplateParams(TList, TA, Unit);
1841 }
1842 
1843 llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1844     const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
1845   // Always get the full list of parameters, not just the ones from the
1846   // specialization. A partial specialization may have fewer parameters than
1847   // there are arguments.
1848   TemplateParameterList *TPList =
1849       TSpecial->getSpecializedTemplate()->getTemplateParameters();
1850   const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
1851   return CollectTemplateParams(TPList, TAList.asArray(), Unit);
1852 }
1853 
1854 llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
1855   if (VTablePtrType)
1856     return VTablePtrType;
1857 
1858   ASTContext &Context = CGM.getContext();
1859 
1860   /* Function type */
1861   llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
1862   llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
1863   llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
1864   unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1865   unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1866   Optional<unsigned> DWARFAddressSpace =
1867       CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1868 
1869   llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1870       SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1871   VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1872   return VTablePtrType;
1873 }
1874 
1875 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1876   // Copy the gdb compatible name on the side and use its reference.
1877   return internString("_vptr$", RD->getNameAsString());
1878 }
1879 
1880 StringRef CGDebugInfo::getDynamicInitializerName(const VarDecl *VD,
1881                                                  DynamicInitKind StubKind,
1882                                                  llvm::Function *InitFn) {
1883   // If we're not emitting codeview, use the mangled name. For Itanium, this is
1884   // arbitrary.
1885   if (!CGM.getCodeGenOpts().EmitCodeView)
1886     return InitFn->getName();
1887 
1888   // Print the normal qualified name for the variable, then break off the last
1889   // NNS, and add the appropriate other text. Clang always prints the global
1890   // variable name without template arguments, so we can use rsplit("::") and
1891   // then recombine the pieces.
1892   SmallString<128> QualifiedGV;
1893   StringRef Quals;
1894   StringRef GVName;
1895   {
1896     llvm::raw_svector_ostream OS(QualifiedGV);
1897     VD->printQualifiedName(OS, getPrintingPolicy());
1898     std::tie(Quals, GVName) = OS.str().rsplit("::");
1899     if (GVName.empty())
1900       std::swap(Quals, GVName);
1901   }
1902 
1903   SmallString<128> InitName;
1904   llvm::raw_svector_ostream OS(InitName);
1905   if (!Quals.empty())
1906     OS << Quals << "::";
1907 
1908   switch (StubKind) {
1909   case DynamicInitKind::NoStub:
1910     llvm_unreachable("not an initializer");
1911   case DynamicInitKind::Initializer:
1912     OS << "`dynamic initializer for '";
1913     break;
1914   case DynamicInitKind::AtExit:
1915     OS << "`dynamic atexit destructor for '";
1916     break;
1917   }
1918 
1919   OS << GVName;
1920 
1921   // Add any template specialization args.
1922   if (const auto *VTpl = dyn_cast<VarTemplateSpecializationDecl>(VD)) {
1923     printTemplateArgumentList(OS, VTpl->getTemplateArgs().asArray(),
1924                               getPrintingPolicy());
1925   }
1926 
1927   OS << '\'';
1928 
1929   return internString(OS.str());
1930 }
1931 
1932 void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1933                                     SmallVectorImpl<llvm::Metadata *> &EltTys,
1934                                     llvm::DICompositeType *RecordTy) {
1935   // If this class is not dynamic then there is not any vtable info to collect.
1936   if (!RD->isDynamicClass())
1937     return;
1938 
1939   // Don't emit any vtable shape or vptr info if this class doesn't have an
1940   // extendable vfptr. This can happen if the class doesn't have virtual
1941   // methods, or in the MS ABI if those virtual methods only come from virtually
1942   // inherited bases.
1943   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1944   if (!RL.hasExtendableVFPtr())
1945     return;
1946 
1947   // CodeView needs to know how large the vtable of every dynamic class is, so
1948   // emit a special named pointer type into the element list. The vptr type
1949   // points to this type as well.
1950   llvm::DIType *VPtrTy = nullptr;
1951   bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1952                          CGM.getTarget().getCXXABI().isMicrosoft();
1953   if (NeedVTableShape) {
1954     uint64_t PtrWidth =
1955         CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1956     const VTableLayout &VFTLayout =
1957         CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1958     unsigned VSlotCount =
1959         VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
1960     unsigned VTableWidth = PtrWidth * VSlotCount;
1961     unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1962     Optional<unsigned> DWARFAddressSpace =
1963         CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1964 
1965     // Create a very wide void* type and insert it directly in the element list.
1966     llvm::DIType *VTableType = DBuilder.createPointerType(
1967         nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1968     EltTys.push_back(VTableType);
1969 
1970     // The vptr is a pointer to this special vtable type.
1971     VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1972   }
1973 
1974   // If there is a primary base then the artificial vptr member lives there.
1975   if (RL.getPrimaryBase())
1976     return;
1977 
1978   if (!VPtrTy)
1979     VPtrTy = getOrCreateVTablePtrType(Unit);
1980 
1981   unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1982   llvm::DIType *VPtrMember =
1983       DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1984                                 llvm::DINode::FlagArtificial, VPtrTy);
1985   EltTys.push_back(VPtrMember);
1986 }
1987 
1988 llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
1989                                                  SourceLocation Loc) {
1990   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1991   llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
1992   return T;
1993 }
1994 
1995 llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
1996                                                     SourceLocation Loc) {
1997   return getOrCreateStandaloneType(D, Loc);
1998 }
1999 
2000 llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
2001                                                      SourceLocation Loc) {
2002   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
2003   assert(!D.isNull() && "null type");
2004   llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
2005   assert(T && "could not create debug info for type");
2006 
2007   RetainedTypes.push_back(D.getAsOpaquePtr());
2008   return T;
2009 }
2010 
2011 void CGDebugInfo::addHeapAllocSiteMetadata(llvm::Instruction *CI,
2012                                            QualType D,
2013                                            SourceLocation Loc) {
2014   llvm::MDNode *node;
2015   if (D.getTypePtr()->isVoidPointerType()) {
2016     node = llvm::MDNode::get(CGM.getLLVMContext(), None);
2017   } else {
2018     QualType PointeeTy = D.getTypePtr()->getPointeeType();
2019     node = getOrCreateType(PointeeTy, getOrCreateFile(Loc));
2020   }
2021 
2022   CI->setMetadata("heapallocsite", node);
2023 }
2024 
2025 void CGDebugInfo::completeType(const EnumDecl *ED) {
2026   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2027     return;
2028   QualType Ty = CGM.getContext().getEnumType(ED);
2029   void *TyPtr = Ty.getAsOpaquePtr();
2030   auto I = TypeCache.find(TyPtr);
2031   if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
2032     return;
2033   llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
2034   assert(!Res->isForwardDecl());
2035   TypeCache[TyPtr].reset(Res);
2036 }
2037 
2038 void CGDebugInfo::completeType(const RecordDecl *RD) {
2039   if (DebugKind > codegenoptions::LimitedDebugInfo ||
2040       !CGM.getLangOpts().CPlusPlus)
2041     completeRequiredType(RD);
2042 }
2043 
2044 /// Return true if the class or any of its methods are marked dllimport.
2045 static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
2046   if (RD->hasAttr<DLLImportAttr>())
2047     return true;
2048   for (const CXXMethodDecl *MD : RD->methods())
2049     if (MD->hasAttr<DLLImportAttr>())
2050       return true;
2051   return false;
2052 }
2053 
2054 /// Does a type definition exist in an imported clang module?
2055 static bool isDefinedInClangModule(const RecordDecl *RD) {
2056   // Only definitions that where imported from an AST file come from a module.
2057   if (!RD || !RD->isFromASTFile())
2058     return false;
2059   // Anonymous entities cannot be addressed. Treat them as not from module.
2060   if (!RD->isExternallyVisible() && RD->getName().empty())
2061     return false;
2062   if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
2063     if (!CXXDecl->isCompleteDefinition())
2064       return false;
2065     // Check wether RD is a template.
2066     auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
2067     if (TemplateKind != TSK_Undeclared) {
2068       // Unfortunately getOwningModule() isn't accurate enough to find the
2069       // owning module of a ClassTemplateSpecializationDecl that is inside a
2070       // namespace spanning multiple modules.
2071       bool Explicit = false;
2072       if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
2073         Explicit = TD->isExplicitInstantiationOrSpecialization();
2074       if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
2075         return false;
2076       // This is a template, check the origin of the first member.
2077       if (CXXDecl->field_begin() == CXXDecl->field_end())
2078         return TemplateKind == TSK_ExplicitInstantiationDeclaration;
2079       if (!CXXDecl->field_begin()->isFromASTFile())
2080         return false;
2081     }
2082   }
2083   return true;
2084 }
2085 
2086 void CGDebugInfo::completeClassData(const RecordDecl *RD) {
2087   if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
2088     if (CXXRD->isDynamicClass() &&
2089         CGM.getVTableLinkage(CXXRD) ==
2090             llvm::GlobalValue::AvailableExternallyLinkage &&
2091         !isClassOrMethodDLLImport(CXXRD))
2092       return;
2093 
2094   if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2095     return;
2096 
2097   completeClass(RD);
2098 }
2099 
2100 void CGDebugInfo::completeClass(const RecordDecl *RD) {
2101   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2102     return;
2103   QualType Ty = CGM.getContext().getRecordType(RD);
2104   void *TyPtr = Ty.getAsOpaquePtr();
2105   auto I = TypeCache.find(TyPtr);
2106   if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
2107     return;
2108   llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
2109   assert(!Res->isForwardDecl());
2110   TypeCache[TyPtr].reset(Res);
2111 }
2112 
2113 static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
2114                                         CXXRecordDecl::method_iterator End) {
2115   for (CXXMethodDecl *MD : llvm::make_range(I, End))
2116     if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
2117       if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
2118           !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
2119         return true;
2120   return false;
2121 }
2122 
2123 static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2124                                  bool DebugTypeExtRefs, const RecordDecl *RD,
2125                                  const LangOptions &LangOpts) {
2126   if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2127     return true;
2128 
2129   if (auto *ES = RD->getASTContext().getExternalSource())
2130     if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2131       return true;
2132 
2133   if (DebugKind > codegenoptions::LimitedDebugInfo)
2134     return false;
2135 
2136   if (!LangOpts.CPlusPlus)
2137     return false;
2138 
2139   if (!RD->isCompleteDefinitionRequired())
2140     return true;
2141 
2142   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2143 
2144   if (!CXXDecl)
2145     return false;
2146 
2147   // Only emit complete debug info for a dynamic class when its vtable is
2148   // emitted.  However, Microsoft debuggers don't resolve type information
2149   // across DLL boundaries, so skip this optimization if the class or any of its
2150   // methods are marked dllimport. This isn't a complete solution, since objects
2151   // without any dllimport methods can be used in one DLL and constructed in
2152   // another, but it is the current behavior of LimitedDebugInfo.
2153   if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
2154       !isClassOrMethodDLLImport(CXXDecl))
2155     return true;
2156 
2157   TemplateSpecializationKind Spec = TSK_Undeclared;
2158   if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
2159     Spec = SD->getSpecializationKind();
2160 
2161   if (Spec == TSK_ExplicitInstantiationDeclaration &&
2162       hasExplicitMemberDefinition(CXXDecl->method_begin(),
2163                                   CXXDecl->method_end()))
2164     return true;
2165 
2166   return false;
2167 }
2168 
2169 void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2170   if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2171     return;
2172 
2173   QualType Ty = CGM.getContext().getRecordType(RD);
2174   llvm::DIType *T = getTypeOrNull(Ty);
2175   if (T && T->isForwardDecl())
2176     completeClassData(RD);
2177 }
2178 
2179 llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
2180   RecordDecl *RD = Ty->getDecl();
2181   llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
2182   if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2183                                 CGM.getLangOpts())) {
2184     if (!T)
2185       T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
2186     return T;
2187   }
2188 
2189   return CreateTypeDefinition(Ty);
2190 }
2191 
2192 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
2193   RecordDecl *RD = Ty->getDecl();
2194 
2195   // Get overall information about the record type for the debug info.
2196   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2197 
2198   // Records and classes and unions can all be recursive.  To handle them, we
2199   // first generate a debug descriptor for the struct as a forward declaration.
2200   // Then (if it is a definition) we go through and get debug info for all of
2201   // its members.  Finally, we create a descriptor for the complete type (which
2202   // may refer to the forward decl if the struct is recursive) and replace all
2203   // uses of the forward declaration with the final definition.
2204   llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
2205 
2206   const RecordDecl *D = RD->getDefinition();
2207   if (!D || !D->isCompleteDefinition())
2208     return FwdDecl;
2209 
2210   if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
2211     CollectContainingType(CXXDecl, FwdDecl);
2212 
2213   // Push the struct on region stack.
2214   LexicalBlockStack.emplace_back(&*FwdDecl);
2215   RegionMap[Ty->getDecl()].reset(FwdDecl);
2216 
2217   // Convert all the elements.
2218   SmallVector<llvm::Metadata *, 16> EltTys;
2219   // what about nested types?
2220 
2221   // Note: The split of CXXDecl information here is intentional, the
2222   // gdb tests will depend on a certain ordering at printout. The debug
2223   // information offsets are still correct if we merge them all together
2224   // though.
2225   const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2226   if (CXXDecl) {
2227     CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
2228     CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
2229   }
2230 
2231   // Collect data fields (including static variables and any initializers).
2232   CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
2233   if (CXXDecl)
2234     CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
2235 
2236   LexicalBlockStack.pop_back();
2237   RegionMap.erase(Ty->getDecl());
2238 
2239   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2240   DBuilder.replaceArrays(FwdDecl, Elements);
2241 
2242   if (FwdDecl->isTemporary())
2243     FwdDecl =
2244         llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
2245 
2246   RegionMap[Ty->getDecl()].reset(FwdDecl);
2247   return FwdDecl;
2248 }
2249 
2250 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2251                                       llvm::DIFile *Unit) {
2252   // Ignore protocols.
2253   return getOrCreateType(Ty->getBaseType(), Unit);
2254 }
2255 
2256 llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2257                                       llvm::DIFile *Unit) {
2258   // Ignore protocols.
2259   SourceLocation Loc = Ty->getDecl()->getLocation();
2260 
2261   // Use Typedefs to represent ObjCTypeParamType.
2262   return DBuilder.createTypedef(
2263       getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2264       Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2265       getDeclContextDescriptor(Ty->getDecl()));
2266 }
2267 
2268 /// \return true if Getter has the default name for the property PD.
2269 static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2270                                  const ObjCMethodDecl *Getter) {
2271   assert(PD);
2272   if (!Getter)
2273     return true;
2274 
2275   assert(Getter->getDeclName().isObjCZeroArgSelector());
2276   return PD->getName() ==
2277          Getter->getDeclName().getObjCSelector().getNameForSlot(0);
2278 }
2279 
2280 /// \return true if Setter has the default name for the property PD.
2281 static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2282                                  const ObjCMethodDecl *Setter) {
2283   assert(PD);
2284   if (!Setter)
2285     return true;
2286 
2287   assert(Setter->getDeclName().isObjCOneArgSelector());
2288   return SelectorTable::constructSetterName(PD->getName()) ==
2289          Setter->getDeclName().getObjCSelector().getNameForSlot(0);
2290 }
2291 
2292 llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2293                                       llvm::DIFile *Unit) {
2294   ObjCInterfaceDecl *ID = Ty->getDecl();
2295   if (!ID)
2296     return nullptr;
2297 
2298   // Return a forward declaration if this type was imported from a clang module,
2299   // and this is not the compile unit with the implementation of the type (which
2300   // may contain hidden ivars).
2301   if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2302       !ID->getImplementation())
2303     return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2304                                       ID->getName(),
2305                                       getDeclContextDescriptor(ID), Unit, 0);
2306 
2307   // Get overall information about the record type for the debug info.
2308   llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2309   unsigned Line = getLineNumber(ID->getLocation());
2310   auto RuntimeLang =
2311       static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
2312 
2313   // If this is just a forward declaration return a special forward-declaration
2314   // debug type since we won't be able to lay out the entire type.
2315   ObjCInterfaceDecl *Def = ID->getDefinition();
2316   if (!Def || !Def->getImplementation()) {
2317     llvm::DIScope *Mod = getParentModuleOrNull(ID);
2318     llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
2319         llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2320         DefUnit, Line, RuntimeLang);
2321     ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
2322     return FwdDecl;
2323   }
2324 
2325   return CreateTypeDefinition(Ty, Unit);
2326 }
2327 
2328 llvm::DIModule *
2329 CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2330                                   bool CreateSkeletonCU) {
2331   // Use the Module pointer as the key into the cache. This is a
2332   // nullptr if the "Module" is a PCH, which is safe because we don't
2333   // support chained PCH debug info, so there can only be a single PCH.
2334   const Module *M = Mod.getModuleOrNull();
2335   auto ModRef = ModuleCache.find(M);
2336   if (ModRef != ModuleCache.end())
2337     return cast<llvm::DIModule>(ModRef->second);
2338 
2339   // Macro definitions that were defined with "-D" on the command line.
2340   SmallString<128> ConfigMacros;
2341   {
2342     llvm::raw_svector_ostream OS(ConfigMacros);
2343     const auto &PPOpts = CGM.getPreprocessorOpts();
2344     unsigned I = 0;
2345     // Translate the macro definitions back into a command line.
2346     for (auto &M : PPOpts.Macros) {
2347       if (++I > 1)
2348         OS << " ";
2349       const std::string &Macro = M.first;
2350       bool Undef = M.second;
2351       OS << "\"-" << (Undef ? 'U' : 'D');
2352       for (char c : Macro)
2353         switch (c) {
2354         case '\\':
2355           OS << "\\\\";
2356           break;
2357         case '"':
2358           OS << "\\\"";
2359           break;
2360         default:
2361           OS << c;
2362         }
2363       OS << '\"';
2364     }
2365   }
2366 
2367   bool IsRootModule = M ? !M->Parent : true;
2368   // When a module name is specified as -fmodule-name, that module gets a
2369   // clang::Module object, but it won't actually be built or imported; it will
2370   // be textual.
2371   if (CreateSkeletonCU && IsRootModule && Mod.getASTFile().empty() && M)
2372     assert(StringRef(M->Name).startswith(CGM.getLangOpts().ModuleName) &&
2373            "clang module without ASTFile must be specified by -fmodule-name");
2374 
2375   if (CreateSkeletonCU && IsRootModule && !Mod.getASTFile().empty()) {
2376     // PCH files don't have a signature field in the control block,
2377     // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
2378     // We use the lower 64 bits for debug info.
2379     uint64_t Signature =
2380         Mod.getSignature()
2381             ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2382             : ~1ULL;
2383     llvm::DIBuilder DIB(CGM.getModule());
2384     DIB.createCompileUnit(TheCU->getSourceLanguage(),
2385                           // TODO: Support "Source" from external AST providers?
2386                           DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2387                           TheCU->getProducer(), true, StringRef(), 0,
2388                           Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2389                           Signature);
2390     DIB.finalize();
2391   }
2392 
2393   llvm::DIModule *Parent =
2394       IsRootModule ? nullptr
2395                    : getOrCreateModuleRef(
2396                          ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2397                          CreateSkeletonCU);
2398   llvm::DIModule *DIMod =
2399       DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2400                             Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
2401   ModuleCache[M].reset(DIMod);
2402   return DIMod;
2403 }
2404 
2405 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2406                                                 llvm::DIFile *Unit) {
2407   ObjCInterfaceDecl *ID = Ty->getDecl();
2408   llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2409   unsigned Line = getLineNumber(ID->getLocation());
2410   unsigned RuntimeLang = TheCU->getSourceLanguage();
2411 
2412   // Bit size, align and offset of the type.
2413   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2414   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2415 
2416   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2417   if (ID->getImplementation())
2418     Flags |= llvm::DINode::FlagObjcClassComplete;
2419 
2420   llvm::DIScope *Mod = getParentModuleOrNull(ID);
2421   llvm::DICompositeType *RealDecl = DBuilder.createStructType(
2422       Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2423       nullptr, llvm::DINodeArray(), RuntimeLang);
2424 
2425   QualType QTy(Ty, 0);
2426   TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
2427 
2428   // Push the struct on region stack.
2429   LexicalBlockStack.emplace_back(RealDecl);
2430   RegionMap[Ty->getDecl()].reset(RealDecl);
2431 
2432   // Convert all the elements.
2433   SmallVector<llvm::Metadata *, 16> EltTys;
2434 
2435   ObjCInterfaceDecl *SClass = ID->getSuperClass();
2436   if (SClass) {
2437     llvm::DIType *SClassTy =
2438         getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
2439     if (!SClassTy)
2440       return nullptr;
2441 
2442     llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
2443                                                       llvm::DINode::FlagZero);
2444     EltTys.push_back(InhTag);
2445   }
2446 
2447   // Create entries for all of the properties.
2448   auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2449     SourceLocation Loc = PD->getLocation();
2450     llvm::DIFile *PUnit = getOrCreateFile(Loc);
2451     unsigned PLine = getLineNumber(Loc);
2452     ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2453     ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2454     llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2455         PD->getName(), PUnit, PLine,
2456         hasDefaultGetterName(PD, Getter) ? ""
2457                                          : getSelectorName(PD->getGetterName()),
2458         hasDefaultSetterName(PD, Setter) ? ""
2459                                          : getSelectorName(PD->getSetterName()),
2460         PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
2461     EltTys.push_back(PropertyNode);
2462   };
2463   {
2464     llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
2465     for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
2466       for (auto *PD : ClassExt->properties()) {
2467         PropertySet.insert(PD->getIdentifier());
2468         AddProperty(PD);
2469       }
2470     for (const auto *PD : ID->properties()) {
2471       // Don't emit duplicate metadata for properties that were already in a
2472       // class extension.
2473       if (!PropertySet.insert(PD->getIdentifier()).second)
2474         continue;
2475       AddProperty(PD);
2476     }
2477   }
2478 
2479   const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2480   unsigned FieldNo = 0;
2481   for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2482        Field = Field->getNextIvar(), ++FieldNo) {
2483     llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
2484     if (!FieldTy)
2485       return nullptr;
2486 
2487     StringRef FieldName = Field->getName();
2488 
2489     // Ignore unnamed fields.
2490     if (FieldName.empty())
2491       continue;
2492 
2493     // Get the location for the field.
2494     llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
2495     unsigned FieldLine = getLineNumber(Field->getLocation());
2496     QualType FType = Field->getType();
2497     uint64_t FieldSize = 0;
2498     uint32_t FieldAlign = 0;
2499 
2500     if (!FType->isIncompleteArrayType()) {
2501 
2502       // Bit size, align and offset of the type.
2503       FieldSize = Field->isBitField()
2504                       ? Field->getBitWidthValue(CGM.getContext())
2505                       : CGM.getContext().getTypeSize(FType);
2506       FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2507     }
2508 
2509     uint64_t FieldOffset;
2510     if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2511       // We don't know the runtime offset of an ivar if we're using the
2512       // non-fragile ABI.  For bitfields, use the bit offset into the first
2513       // byte of storage of the bitfield.  For other fields, use zero.
2514       if (Field->isBitField()) {
2515         FieldOffset =
2516             CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
2517         FieldOffset %= CGM.getContext().getCharWidth();
2518       } else {
2519         FieldOffset = 0;
2520       }
2521     } else {
2522       FieldOffset = RL.getFieldOffset(FieldNo);
2523     }
2524 
2525     llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2526     if (Field->getAccessControl() == ObjCIvarDecl::Protected)
2527       Flags = llvm::DINode::FlagProtected;
2528     else if (Field->getAccessControl() == ObjCIvarDecl::Private)
2529       Flags = llvm::DINode::FlagPrivate;
2530     else if (Field->getAccessControl() == ObjCIvarDecl::Public)
2531       Flags = llvm::DINode::FlagPublic;
2532 
2533     llvm::MDNode *PropertyNode = nullptr;
2534     if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
2535       if (ObjCPropertyImplDecl *PImpD =
2536               ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
2537         if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
2538           SourceLocation Loc = PD->getLocation();
2539           llvm::DIFile *PUnit = getOrCreateFile(Loc);
2540           unsigned PLine = getLineNumber(Loc);
2541           ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2542           ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2543           PropertyNode = DBuilder.createObjCProperty(
2544               PD->getName(), PUnit, PLine,
2545               hasDefaultGetterName(PD, Getter)
2546                   ? ""
2547                   : getSelectorName(PD->getGetterName()),
2548               hasDefaultSetterName(PD, Setter)
2549                   ? ""
2550                   : getSelectorName(PD->getSetterName()),
2551               PD->getPropertyAttributes(),
2552               getOrCreateType(PD->getType(), PUnit));
2553         }
2554       }
2555     }
2556     FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2557                                       FieldSize, FieldAlign, FieldOffset, Flags,
2558                                       FieldTy, PropertyNode);
2559     EltTys.push_back(FieldTy);
2560   }
2561 
2562   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2563   DBuilder.replaceArrays(RealDecl, Elements);
2564 
2565   LexicalBlockStack.pop_back();
2566   return RealDecl;
2567 }
2568 
2569 llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2570                                       llvm::DIFile *Unit) {
2571   llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2572   int64_t Count = Ty->getNumElements();
2573 
2574   llvm::Metadata *Subscript;
2575   QualType QTy(Ty, 0);
2576   auto SizeExpr = SizeExprCache.find(QTy);
2577   if (SizeExpr != SizeExprCache.end())
2578     Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2579   else
2580     Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
2581   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
2582 
2583   uint64_t Size = CGM.getContext().getTypeSize(Ty);
2584   auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2585 
2586   return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2587 }
2588 
2589 llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
2590   uint64_t Size;
2591   uint32_t Align;
2592 
2593   // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2594   if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2595     Size = 0;
2596     Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2597                                    CGM.getContext());
2598   } else if (Ty->isIncompleteArrayType()) {
2599     Size = 0;
2600     if (Ty->getElementType()->isIncompleteType())
2601       Align = 0;
2602     else
2603       Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
2604   } else if (Ty->isIncompleteType()) {
2605     Size = 0;
2606     Align = 0;
2607   } else {
2608     // Size and align of the whole array, not the element type.
2609     Size = CGM.getContext().getTypeSize(Ty);
2610     Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2611   }
2612 
2613   // Add the dimensions of the array.  FIXME: This loses CV qualifiers from
2614   // interior arrays, do we care?  Why aren't nested arrays represented the
2615   // obvious/recursive way?
2616   SmallVector<llvm::Metadata *, 8> Subscripts;
2617   QualType EltTy(Ty, 0);
2618   while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2619     // If the number of elements is known, then count is that number. Otherwise,
2620     // it's -1. This allows us to represent a subrange with an array of 0
2621     // elements, like this:
2622     //
2623     //   struct foo {
2624     //     int x[0];
2625     //   };
2626     int64_t Count = -1; // Count == -1 is an unbounded array.
2627     if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
2628       Count = CAT->getSize().getZExtValue();
2629     else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2630       if (Expr *Size = VAT->getSizeExpr()) {
2631         Expr::EvalResult Result;
2632         if (Size->EvaluateAsInt(Result, CGM.getContext()))
2633           Count = Result.Val.getInt().getExtValue();
2634       }
2635     }
2636 
2637     auto SizeNode = SizeExprCache.find(EltTy);
2638     if (SizeNode != SizeExprCache.end())
2639       Subscripts.push_back(
2640           DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2641     else
2642       Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2643     EltTy = Ty->getElementType();
2644   }
2645 
2646   llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2647 
2648   return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2649                                   SubscriptArray);
2650 }
2651 
2652 llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2653                                       llvm::DIFile *Unit) {
2654   return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2655                                Ty->getPointeeType(), Unit);
2656 }
2657 
2658 llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2659                                       llvm::DIFile *Unit) {
2660   return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2661                                Ty->getPointeeType(), Unit);
2662 }
2663 
2664 llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2665                                       llvm::DIFile *U) {
2666   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2667   uint64_t Size = 0;
2668 
2669   if (!Ty->isIncompleteType()) {
2670     Size = CGM.getContext().getTypeSize(Ty);
2671 
2672     // Set the MS inheritance model. There is no flag for the unspecified model.
2673     if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2674       switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2675       case MSInheritanceAttr::Keyword_single_inheritance:
2676         Flags |= llvm::DINode::FlagSingleInheritance;
2677         break;
2678       case MSInheritanceAttr::Keyword_multiple_inheritance:
2679         Flags |= llvm::DINode::FlagMultipleInheritance;
2680         break;
2681       case MSInheritanceAttr::Keyword_virtual_inheritance:
2682         Flags |= llvm::DINode::FlagVirtualInheritance;
2683         break;
2684       case MSInheritanceAttr::Keyword_unspecified_inheritance:
2685         break;
2686       }
2687     }
2688   }
2689 
2690   llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
2691   if (Ty->isMemberDataPointerType())
2692     return DBuilder.createMemberPointerType(
2693         getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2694         Flags);
2695 
2696   const FunctionProtoType *FPT =
2697       Ty->getPointeeType()->getAs<FunctionProtoType>();
2698   return DBuilder.createMemberPointerType(
2699       getOrCreateInstanceMethodType(
2700           CXXMethodDecl::getThisType(FPT, Ty->getMostRecentCXXRecordDecl()),
2701           FPT, U),
2702       ClassType, Size, /*Align=*/0, Flags);
2703 }
2704 
2705 llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
2706   auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2707   return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
2708 }
2709 
2710 llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
2711   return getOrCreateType(Ty->getElementType(), U);
2712 }
2713 
2714 llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
2715   const EnumDecl *ED = Ty->getDecl();
2716 
2717   uint64_t Size = 0;
2718   uint32_t Align = 0;
2719   if (!ED->getTypeForDecl()->isIncompleteType()) {
2720     Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2721     Align = getDeclAlignIfRequired(ED, CGM.getContext());
2722   }
2723 
2724   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2725 
2726   bool isImportedFromModule =
2727       DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2728 
2729   // If this is just a forward declaration, construct an appropriately
2730   // marked node and just return it.
2731   if (isImportedFromModule || !ED->getDefinition()) {
2732     // Note that it is possible for enums to be created as part of
2733     // their own declcontext. In this case a FwdDecl will be created
2734     // twice. This doesn't cause a problem because both FwdDecls are
2735     // entered into the ReplaceMap: finalize() will replace the first
2736     // FwdDecl with the second and then replace the second with
2737     // complete type.
2738     llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
2739     llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2740     llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2741         llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
2742 
2743     unsigned Line = getLineNumber(ED->getLocation());
2744     StringRef EDName = ED->getName();
2745     llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
2746         llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2747         0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
2748 
2749     ReplaceMap.emplace_back(
2750         std::piecewise_construct, std::make_tuple(Ty),
2751         std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
2752     return RetTy;
2753   }
2754 
2755   return CreateTypeDefinition(Ty);
2756 }
2757 
2758 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
2759   const EnumDecl *ED = Ty->getDecl();
2760   uint64_t Size = 0;
2761   uint32_t Align = 0;
2762   if (!ED->getTypeForDecl()->isIncompleteType()) {
2763     Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2764     Align = getDeclAlignIfRequired(ED, CGM.getContext());
2765   }
2766 
2767   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2768 
2769   // Create elements for each enumerator.
2770   SmallVector<llvm::Metadata *, 16> Enumerators;
2771   ED = ED->getDefinition();
2772   bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
2773   for (const auto *Enum : ED->enumerators()) {
2774     const auto &InitVal = Enum->getInitVal();
2775     auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2776     Enumerators.push_back(
2777         DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
2778   }
2779 
2780   // Return a CompositeType for the enum itself.
2781   llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
2782 
2783   llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2784   unsigned Line = getLineNumber(ED->getLocation());
2785   llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
2786   llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
2787   return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2788                                         Line, Size, Align, EltArray, ClassTy,
2789                                         Identifier, ED->isScoped());
2790 }
2791 
2792 llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2793                                         unsigned MType, SourceLocation LineLoc,
2794                                         StringRef Name, StringRef Value) {
2795   unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2796   return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2797 }
2798 
2799 llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2800                                                     SourceLocation LineLoc,
2801                                                     SourceLocation FileLoc) {
2802   llvm::DIFile *FName = getOrCreateFile(FileLoc);
2803   unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2804   return DBuilder.createTempMacroFile(Parent, Line, FName);
2805 }
2806 
2807 static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2808   Qualifiers Quals;
2809   do {
2810     Qualifiers InnerQuals = T.getLocalQualifiers();
2811     // Qualifiers::operator+() doesn't like it if you add a Qualifier
2812     // that is already there.
2813     Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2814     Quals += InnerQuals;
2815     QualType LastT = T;
2816     switch (T->getTypeClass()) {
2817     default:
2818       return C.getQualifiedType(T.getTypePtr(), Quals);
2819     case Type::TemplateSpecialization: {
2820       const auto *Spec = cast<TemplateSpecializationType>(T);
2821       if (Spec->isTypeAlias())
2822         return C.getQualifiedType(T.getTypePtr(), Quals);
2823       T = Spec->desugar();
2824       break;
2825     }
2826     case Type::TypeOfExpr:
2827       T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2828       break;
2829     case Type::TypeOf:
2830       T = cast<TypeOfType>(T)->getUnderlyingType();
2831       break;
2832     case Type::Decltype:
2833       T = cast<DecltypeType>(T)->getUnderlyingType();
2834       break;
2835     case Type::UnaryTransform:
2836       T = cast<UnaryTransformType>(T)->getUnderlyingType();
2837       break;
2838     case Type::Attributed:
2839       T = cast<AttributedType>(T)->getEquivalentType();
2840       break;
2841     case Type::Elaborated:
2842       T = cast<ElaboratedType>(T)->getNamedType();
2843       break;
2844     case Type::Paren:
2845       T = cast<ParenType>(T)->getInnerType();
2846       break;
2847     case Type::MacroQualified:
2848       T = cast<MacroQualifiedType>(T)->getUnderlyingType();
2849       break;
2850     case Type::SubstTemplateTypeParm:
2851       T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
2852       break;
2853     case Type::Auto:
2854     case Type::DeducedTemplateSpecialization: {
2855       QualType DT = cast<DeducedType>(T)->getDeducedType();
2856       assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
2857       T = DT;
2858       break;
2859     }
2860     case Type::Adjusted:
2861     case Type::Decayed:
2862       // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2863       T = cast<AdjustedType>(T)->getAdjustedType();
2864       break;
2865     }
2866 
2867     assert(T != LastT && "Type unwrapping failed to unwrap!");
2868     (void)LastT;
2869   } while (true);
2870 }
2871 
2872 llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
2873 
2874   // Unwrap the type as needed for debug information.
2875   Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2876 
2877   auto It = TypeCache.find(Ty.getAsOpaquePtr());
2878   if (It != TypeCache.end()) {
2879     // Verify that the debug info still exists.
2880     if (llvm::Metadata *V = It->second)
2881       return cast<llvm::DIType>(V);
2882   }
2883 
2884   return nullptr;
2885 }
2886 
2887 void CGDebugInfo::completeTemplateDefinition(
2888     const ClassTemplateSpecializationDecl &SD) {
2889   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2890     return;
2891   completeUnusedClass(SD);
2892 }
2893 
2894 void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2895   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2896     return;
2897 
2898   completeClassData(&D);
2899   // In case this type has no member function definitions being emitted, ensure
2900   // it is retained
2901   RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
2902 }
2903 
2904 llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
2905   if (Ty.isNull())
2906     return nullptr;
2907 
2908   // Unwrap the type as needed for debug information.
2909   Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2910 
2911   if (auto *T = getTypeOrNull(Ty))
2912     return T;
2913 
2914   llvm::DIType *Res = CreateTypeNode(Ty, Unit);
2915   void *TyPtr = Ty.getAsOpaquePtr();
2916 
2917   // And update the type cache.
2918   TypeCache[TyPtr].reset(Res);
2919 
2920   return Res;
2921 }
2922 
2923 llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
2924   // A forward declaration inside a module header does not belong to the module.
2925   if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2926     return nullptr;
2927   if (DebugTypeExtRefs && D->isFromASTFile()) {
2928     // Record a reference to an imported clang module or precompiled header.
2929     auto *Reader = CGM.getContext().getExternalSource();
2930     auto Idx = D->getOwningModuleID();
2931     auto Info = Reader->getSourceDescriptor(Idx);
2932     if (Info)
2933       return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2934   } else if (ClangModuleMap) {
2935     // We are building a clang module or a precompiled header.
2936     //
2937     // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2938     // and it wouldn't be necessary to specify the parent scope
2939     // because the type is already unique by definition (it would look
2940     // like the output of -fno-standalone-debug). On the other hand,
2941     // the parent scope helps a consumer to quickly locate the object
2942     // file where the type's definition is located, so it might be
2943     // best to make this behavior a command line or debugger tuning
2944     // option.
2945     if (Module *M = D->getOwningModule()) {
2946       // This is a (sub-)module.
2947       auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2948       return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
2949     } else {
2950       // This the precompiled header being built.
2951       return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
2952     }
2953   }
2954 
2955   return nullptr;
2956 }
2957 
2958 llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
2959   // Handle qualifiers, which recursively handles what they refer to.
2960   if (Ty.hasLocalQualifiers())
2961     return CreateQualifiedType(Ty, Unit);
2962 
2963   // Work out details of type.
2964   switch (Ty->getTypeClass()) {
2965 #define TYPE(Class, Base)
2966 #define ABSTRACT_TYPE(Class, Base)
2967 #define NON_CANONICAL_TYPE(Class, Base)
2968 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
2969 #include "clang/AST/TypeNodes.def"
2970     llvm_unreachable("Dependent types cannot show up in debug information");
2971 
2972   case Type::ExtVector:
2973   case Type::Vector:
2974     return CreateType(cast<VectorType>(Ty), Unit);
2975   case Type::ObjCObjectPointer:
2976     return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2977   case Type::ObjCObject:
2978     return CreateType(cast<ObjCObjectType>(Ty), Unit);
2979   case Type::ObjCTypeParam:
2980     return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
2981   case Type::ObjCInterface:
2982     return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2983   case Type::Builtin:
2984     return CreateType(cast<BuiltinType>(Ty));
2985   case Type::Complex:
2986     return CreateType(cast<ComplexType>(Ty));
2987   case Type::Pointer:
2988     return CreateType(cast<PointerType>(Ty), Unit);
2989   case Type::BlockPointer:
2990     return CreateType(cast<BlockPointerType>(Ty), Unit);
2991   case Type::Typedef:
2992     return CreateType(cast<TypedefType>(Ty), Unit);
2993   case Type::Record:
2994     return CreateType(cast<RecordType>(Ty));
2995   case Type::Enum:
2996     return CreateEnumType(cast<EnumType>(Ty));
2997   case Type::FunctionProto:
2998   case Type::FunctionNoProto:
2999     return CreateType(cast<FunctionType>(Ty), Unit);
3000   case Type::ConstantArray:
3001   case Type::VariableArray:
3002   case Type::IncompleteArray:
3003     return CreateType(cast<ArrayType>(Ty), Unit);
3004 
3005   case Type::LValueReference:
3006     return CreateType(cast<LValueReferenceType>(Ty), Unit);
3007   case Type::RValueReference:
3008     return CreateType(cast<RValueReferenceType>(Ty), Unit);
3009 
3010   case Type::MemberPointer:
3011     return CreateType(cast<MemberPointerType>(Ty), Unit);
3012 
3013   case Type::Atomic:
3014     return CreateType(cast<AtomicType>(Ty), Unit);
3015 
3016   case Type::Pipe:
3017     return CreateType(cast<PipeType>(Ty), Unit);
3018 
3019   case Type::TemplateSpecialization:
3020     return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
3021 
3022   case Type::Auto:
3023   case Type::Attributed:
3024   case Type::Adjusted:
3025   case Type::Decayed:
3026   case Type::DeducedTemplateSpecialization:
3027   case Type::Elaborated:
3028   case Type::Paren:
3029   case Type::MacroQualified:
3030   case Type::SubstTemplateTypeParm:
3031   case Type::TypeOfExpr:
3032   case Type::TypeOf:
3033   case Type::Decltype:
3034   case Type::UnaryTransform:
3035   case Type::PackExpansion:
3036     break;
3037   }
3038 
3039   llvm_unreachable("type should have been unwrapped!");
3040 }
3041 
3042 llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
3043                                                            llvm::DIFile *Unit) {
3044   QualType QTy(Ty, 0);
3045 
3046   auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
3047 
3048   // We may have cached a forward decl when we could have created
3049   // a non-forward decl. Go ahead and create a non-forward decl
3050   // now.
3051   if (T && !T->isForwardDecl())
3052     return T;
3053 
3054   // Otherwise create the type.
3055   llvm::DICompositeType *Res = CreateLimitedType(Ty);
3056 
3057   // Propagate members from the declaration to the definition
3058   // CreateType(const RecordType*) will overwrite this with the members in the
3059   // correct order if the full type is needed.
3060   DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
3061 
3062   // And update the type cache.
3063   TypeCache[QTy.getAsOpaquePtr()].reset(Res);
3064   return Res;
3065 }
3066 
3067 // TODO: Currently used for context chains when limiting debug info.
3068 llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
3069   RecordDecl *RD = Ty->getDecl();
3070 
3071   // Get overall information about the record type for the debug info.
3072   llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
3073   unsigned Line = getLineNumber(RD->getLocation());
3074   StringRef RDName = getClassName(RD);
3075 
3076   llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
3077 
3078   // If we ended up creating the type during the context chain construction,
3079   // just return that.
3080   auto *T = cast_or_null<llvm::DICompositeType>(
3081       getTypeOrNull(CGM.getContext().getRecordType(RD)));
3082   if (T && (!T->isForwardDecl() || !RD->getDefinition()))
3083     return T;
3084 
3085   // If this is just a forward or incomplete declaration, construct an
3086   // appropriately marked node and just return it.
3087   const RecordDecl *D = RD->getDefinition();
3088   if (!D || !D->isCompleteDefinition())
3089     return getOrCreateRecordFwdDecl(Ty, RDContext);
3090 
3091   uint64_t Size = CGM.getContext().getTypeSize(Ty);
3092   auto Align = getDeclAlignIfRequired(D, CGM.getContext());
3093 
3094   SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
3095 
3096   // Explicitly record the calling convention for C++ records.
3097   auto Flags = llvm::DINode::FlagZero;
3098   if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
3099     if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
3100       Flags |= llvm::DINode::FlagTypePassByReference;
3101     else
3102       Flags |= llvm::DINode::FlagTypePassByValue;
3103 
3104     // Record if a C++ record is non-trivial type.
3105     if (!CXXRD->isTrivial())
3106       Flags |= llvm::DINode::FlagNonTrivial;
3107   }
3108 
3109   llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
3110       getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
3111       Flags, Identifier);
3112 
3113   // Elements of composite types usually have back to the type, creating
3114   // uniquing cycles.  Distinct nodes are more efficient.
3115   switch (RealDecl->getTag()) {
3116   default:
3117     llvm_unreachable("invalid composite type tag");
3118 
3119   case llvm::dwarf::DW_TAG_array_type:
3120   case llvm::dwarf::DW_TAG_enumeration_type:
3121     // Array elements and most enumeration elements don't have back references,
3122     // so they don't tend to be involved in uniquing cycles and there is some
3123     // chance of merging them when linking together two modules.  Only make
3124     // them distinct if they are ODR-uniqued.
3125     if (Identifier.empty())
3126       break;
3127     LLVM_FALLTHROUGH;
3128 
3129   case llvm::dwarf::DW_TAG_structure_type:
3130   case llvm::dwarf::DW_TAG_union_type:
3131   case llvm::dwarf::DW_TAG_class_type:
3132     // Immediately resolve to a distinct node.
3133     RealDecl =
3134         llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3135     break;
3136   }
3137 
3138   RegionMap[Ty->getDecl()].reset(RealDecl);
3139   TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
3140 
3141   if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
3142     DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
3143                            CollectCXXTemplateParams(TSpecial, DefUnit));
3144   return RealDecl;
3145 }
3146 
3147 void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
3148                                         llvm::DICompositeType *RealDecl) {
3149   // A class's primary base or the class itself contains the vtable.
3150   llvm::DICompositeType *ContainingType = nullptr;
3151   const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3152   if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
3153     // Seek non-virtual primary base root.
3154     while (1) {
3155       const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3156       const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3157       if (PBT && !BRL.isPrimaryBaseVirtual())
3158         PBase = PBT;
3159       else
3160         break;
3161     }
3162     ContainingType = cast<llvm::DICompositeType>(
3163         getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3164                         getOrCreateFile(RD->getLocation())));
3165   } else if (RD->isDynamicClass())
3166     ContainingType = RealDecl;
3167 
3168   DBuilder.replaceVTableHolder(RealDecl, ContainingType);
3169 }
3170 
3171 llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
3172                                             StringRef Name, uint64_t *Offset) {
3173   llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
3174   uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
3175   auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
3176   llvm::DIType *Ty =
3177       DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3178                                 *Offset, llvm::DINode::FlagZero, FieldTy);
3179   *Offset += FieldSize;
3180   return Ty;
3181 }
3182 
3183 void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
3184                                            StringRef &Name,
3185                                            StringRef &LinkageName,
3186                                            llvm::DIScope *&FDContext,
3187                                            llvm::DINodeArray &TParamsArray,
3188                                            llvm::DINode::DIFlags &Flags) {
3189   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3190   Name = getFunctionName(FD);
3191   // Use mangled name as linkage name for C/C++ functions.
3192   if (FD->hasPrototype()) {
3193     LinkageName = CGM.getMangledName(GD);
3194     Flags |= llvm::DINode::FlagPrototyped;
3195   }
3196   // No need to replicate the linkage name if it isn't different from the
3197   // subprogram name, no need to have it at all unless coverage is enabled or
3198   // debug is set to more than just line tables or extra debug info is needed.
3199   if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3200                               !CGM.getCodeGenOpts().EmitGcovNotes &&
3201                               !CGM.getCodeGenOpts().DebugInfoForProfiling &&
3202                               DebugKind <= codegenoptions::DebugLineTablesOnly))
3203     LinkageName = StringRef();
3204 
3205   if (DebugKind >= codegenoptions::LimitedDebugInfo) {
3206     if (const NamespaceDecl *NSDecl =
3207             dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
3208       FDContext = getOrCreateNamespace(NSDecl);
3209     else if (const RecordDecl *RDecl =
3210                  dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
3211       llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3212       FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3213     }
3214     // Check if it is a noreturn-marked function
3215     if (FD->isNoReturn())
3216       Flags |= llvm::DINode::FlagNoReturn;
3217     // Collect template parameters.
3218     TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3219   }
3220 }
3221 
3222 void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
3223                                       unsigned &LineNo, QualType &T,
3224                                       StringRef &Name, StringRef &LinkageName,
3225                                       llvm::MDTuple *&TemplateParameters,
3226                                       llvm::DIScope *&VDContext) {
3227   Unit = getOrCreateFile(VD->getLocation());
3228   LineNo = getLineNumber(VD->getLocation());
3229 
3230   setLocation(VD->getLocation());
3231 
3232   T = VD->getType();
3233   if (T->isIncompleteArrayType()) {
3234     // CodeGen turns int[] into int[1] so we'll do the same here.
3235     llvm::APInt ConstVal(32, 1);
3236     QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3237 
3238     T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3239                                               0);
3240   }
3241 
3242   Name = VD->getName();
3243   if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3244       !isa<ObjCMethodDecl>(VD->getDeclContext()))
3245     LinkageName = CGM.getMangledName(VD);
3246   if (LinkageName == Name)
3247     LinkageName = StringRef();
3248 
3249   if (isa<VarTemplateSpecializationDecl>(VD)) {
3250     llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3251     TemplateParameters = parameterNodes.get();
3252   } else {
3253     TemplateParameters = nullptr;
3254   }
3255 
3256   // Since we emit declarations (DW_AT_members) for static members, place the
3257   // definition of those static members in the namespace they were declared in
3258   // in the source code (the lexical decl context).
3259   // FIXME: Generalize this for even non-member global variables where the
3260   // declaration and definition may have different lexical decl contexts, once
3261   // we have support for emitting declarations of (non-member) global variables.
3262   const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3263                                                    : VD->getDeclContext();
3264   // When a record type contains an in-line initialization of a static data
3265   // member, and the record type is marked as __declspec(dllexport), an implicit
3266   // definition of the member will be created in the record context.  DWARF
3267   // doesn't seem to have a nice way to describe this in a form that consumers
3268   // are likely to understand, so fake the "normal" situation of a definition
3269   // outside the class by putting it in the global scope.
3270   if (DC->isRecord())
3271     DC = CGM.getContext().getTranslationUnitDecl();
3272 
3273   llvm::DIScope *Mod = getParentModuleOrNull(VD);
3274   VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
3275 }
3276 
3277 llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3278                                                           bool Stub) {
3279   llvm::DINodeArray TParamsArray;
3280   StringRef Name, LinkageName;
3281   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3282   llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3283   SourceLocation Loc = GD.getDecl()->getLocation();
3284   llvm::DIFile *Unit = getOrCreateFile(Loc);
3285   llvm::DIScope *DContext = Unit;
3286   unsigned Line = getLineNumber(Loc);
3287   collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3288                            Flags);
3289   auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3290 
3291   // Build function type.
3292   SmallVector<QualType, 16> ArgTypes;
3293   if (FD)
3294     for (const ParmVarDecl *Parm : FD->parameters())
3295       ArgTypes.push_back(Parm->getType());
3296   CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3297   QualType FnType = CGM.getContext().getFunctionType(
3298       FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
3299   if (!FD->isExternallyVisible())
3300     SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3301   if (CGM.getLangOpts().Optimize)
3302     SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3303 
3304   if (Stub) {
3305     Flags |= getCallSiteRelatedAttrs();
3306     SPFlags |= llvm::DISubprogram::SPFlagDefinition;
3307     return DBuilder.createFunction(
3308         DContext, Name, LinkageName, Unit, Line,
3309         getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3310         TParamsArray.get(), getFunctionDeclaration(FD));
3311   }
3312 
3313   llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
3314       DContext, Name, LinkageName, Unit, Line,
3315       getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3316       TParamsArray.get(), getFunctionDeclaration(FD));
3317   const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
3318   FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3319                                  std::make_tuple(CanonDecl),
3320                                  std::make_tuple(SP));
3321   return SP;
3322 }
3323 
3324 llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3325   return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3326 }
3327 
3328 llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3329   return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3330 }
3331 
3332 llvm::DIGlobalVariable *
3333 CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3334   QualType T;
3335   StringRef Name, LinkageName;
3336   SourceLocation Loc = VD->getLocation();
3337   llvm::DIFile *Unit = getOrCreateFile(Loc);
3338   llvm::DIScope *DContext = Unit;
3339   unsigned Line = getLineNumber(Loc);
3340   llvm::MDTuple *TemplateParameters = nullptr;
3341 
3342   collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3343                       DContext);
3344   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3345   auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3346       DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
3347       !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
3348   FwdDeclReplaceMap.emplace_back(
3349       std::piecewise_construct,
3350       std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3351       std::make_tuple(static_cast<llvm::Metadata *>(GV)));
3352   return GV;
3353 }
3354 
3355 llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
3356   // We only need a declaration (not a definition) of the type - so use whatever
3357   // we would otherwise do to get a type for a pointee. (forward declarations in
3358   // limited debug info, full definitions (if the type definition is available)
3359   // in unlimited debug info)
3360   if (const auto *TD = dyn_cast<TypeDecl>(D))
3361     return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
3362                            getOrCreateFile(TD->getLocation()));
3363   auto I = DeclCache.find(D->getCanonicalDecl());
3364 
3365   if (I != DeclCache.end()) {
3366     auto N = I->second;
3367     if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3368       return GVE->getVariable();
3369     return dyn_cast_or_null<llvm::DINode>(N);
3370   }
3371 
3372   // No definition for now. Emit a forward definition that might be
3373   // merged with a potential upcoming definition.
3374   if (const auto *FD = dyn_cast<FunctionDecl>(D))
3375     return getFunctionForwardDeclaration(FD);
3376   else if (const auto *VD = dyn_cast<VarDecl>(D))
3377     return getGlobalVariableForwardDeclaration(VD);
3378 
3379   return nullptr;
3380 }
3381 
3382 llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
3383   if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3384     return nullptr;
3385 
3386   const auto *FD = dyn_cast<FunctionDecl>(D);
3387   if (!FD)
3388     return nullptr;
3389 
3390   // Setup context.
3391   auto *S = getDeclContextDescriptor(D);
3392 
3393   auto MI = SPCache.find(FD->getCanonicalDecl());
3394   if (MI == SPCache.end()) {
3395     if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
3396       return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
3397                                      cast<llvm::DICompositeType>(S));
3398     }
3399   }
3400   if (MI != SPCache.end()) {
3401     auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3402     if (SP && !SP->isDefinition())
3403       return SP;
3404   }
3405 
3406   for (auto NextFD : FD->redecls()) {
3407     auto MI = SPCache.find(NextFD->getCanonicalDecl());
3408     if (MI != SPCache.end()) {
3409       auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3410       if (SP && !SP->isDefinition())
3411         return SP;
3412     }
3413   }
3414   return nullptr;
3415 }
3416 
3417 // getOrCreateFunctionType - Construct type. If it is a c++ method, include
3418 // implicit parameter "this".
3419 llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
3420                                                              QualType FnType,
3421                                                              llvm::DIFile *F) {
3422   if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3423     // Create fake but valid subroutine type. Otherwise -verify would fail, and
3424     // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
3425     return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
3426 
3427   if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
3428     return getOrCreateMethodType(Method, F);
3429 
3430   const auto *FTy = FnType->getAs<FunctionType>();
3431   CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3432 
3433   if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
3434     // Add "self" and "_cmd"
3435     SmallVector<llvm::Metadata *, 16> Elts;
3436 
3437     // First element is always return type. For 'void' functions it is NULL.
3438     QualType ResultTy = OMethod->getReturnType();
3439 
3440     // Replace the instancetype keyword with the actual type.
3441     if (ResultTy == CGM.getContext().getObjCInstanceType())
3442       ResultTy = CGM.getContext().getPointerType(
3443           QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
3444 
3445     Elts.push_back(getOrCreateType(ResultTy, F));
3446     // "self" pointer is always first argument.
3447     QualType SelfDeclTy;
3448     if (auto *SelfDecl = OMethod->getSelfDecl())
3449       SelfDeclTy = SelfDecl->getType();
3450     else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3451       if (FPT->getNumParams() > 1)
3452         SelfDeclTy = FPT->getParamType(0);
3453     if (!SelfDeclTy.isNull())
3454       Elts.push_back(
3455           CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
3456     // "_cmd" pointer is always second argument.
3457     Elts.push_back(DBuilder.createArtificialType(
3458         getOrCreateType(CGM.getContext().getObjCSelType(), F)));
3459     // Get rest of the arguments.
3460     for (const auto *PI : OMethod->parameters())
3461       Elts.push_back(getOrCreateType(PI->getType(), F));
3462     // Variadic methods need a special marker at the end of the type list.
3463     if (OMethod->isVariadic())
3464       Elts.push_back(DBuilder.createUnspecifiedParameter());
3465 
3466     llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
3467     return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3468                                          getDwarfCC(CC));
3469   }
3470 
3471   // Handle variadic function types; they need an additional
3472   // unspecified parameter.
3473   if (const auto *FD = dyn_cast<FunctionDecl>(D))
3474     if (FD->isVariadic()) {
3475       SmallVector<llvm::Metadata *, 16> EltTys;
3476       EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
3477       if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3478         for (QualType ParamType : FPT->param_types())
3479           EltTys.push_back(getOrCreateType(ParamType, F));
3480       EltTys.push_back(DBuilder.createUnspecifiedParameter());
3481       llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
3482       return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3483                                            getDwarfCC(CC));
3484     }
3485 
3486   return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
3487 }
3488 
3489 void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3490                                     SourceLocation ScopeLoc, QualType FnType,
3491                                     llvm::Function *Fn, bool CurFuncIsThunk,
3492                                     CGBuilderTy &Builder) {
3493 
3494   StringRef Name;
3495   StringRef LinkageName;
3496 
3497   FnBeginRegionCount.push_back(LexicalBlockStack.size());
3498 
3499   const Decl *D = GD.getDecl();
3500   bool HasDecl = (D != nullptr);
3501 
3502   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3503   llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3504   llvm::DIFile *Unit = getOrCreateFile(Loc);
3505   llvm::DIScope *FDContext = Unit;
3506   llvm::DINodeArray TParamsArray;
3507   if (!HasDecl) {
3508     // Use llvm function name.
3509     LinkageName = Fn->getName();
3510   } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
3511     // If there is a subprogram for this function available then use it.
3512     auto FI = SPCache.find(FD->getCanonicalDecl());
3513     if (FI != SPCache.end()) {
3514       auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3515       if (SP && SP->isDefinition()) {
3516         LexicalBlockStack.emplace_back(SP);
3517         RegionMap[D].reset(SP);
3518         return;
3519       }
3520     }
3521     collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3522                              TParamsArray, Flags);
3523   } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3524     Name = getObjCMethodName(OMD);
3525     Flags |= llvm::DINode::FlagPrototyped;
3526   } else if (isa<VarDecl>(D) &&
3527              GD.getDynamicInitKind() != DynamicInitKind::NoStub) {
3528     // This is a global initializer or atexit destructor for a global variable.
3529     Name = getDynamicInitializerName(cast<VarDecl>(D), GD.getDynamicInitKind(),
3530                                      Fn);
3531   } else {
3532     // Use llvm function name.
3533     Name = Fn->getName();
3534     Flags |= llvm::DINode::FlagPrototyped;
3535   }
3536   if (Name.startswith("\01"))
3537     Name = Name.substr(1);
3538 
3539   if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
3540     Flags |= llvm::DINode::FlagArtificial;
3541     // Artificial functions should not silently reuse CurLoc.
3542     CurLoc = SourceLocation();
3543   }
3544 
3545   if (CurFuncIsThunk)
3546     Flags |= llvm::DINode::FlagThunk;
3547 
3548   if (Fn->hasLocalLinkage())
3549     SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3550   if (CGM.getLangOpts().Optimize)
3551     SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3552 
3553   llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
3554   llvm::DISubprogram::DISPFlags SPFlagsForDef =
3555       SPFlags | llvm::DISubprogram::SPFlagDefinition;
3556 
3557   unsigned LineNo = getLineNumber(Loc);
3558   unsigned ScopeLine = getLineNumber(ScopeLoc);
3559 
3560   // FIXME: The function declaration we're constructing here is mostly reusing
3561   // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3562   // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3563   // all subprograms instead of the actual context since subprogram definitions
3564   // are emitted as CU level entities by the backend.
3565   llvm::DISubprogram *SP = DBuilder.createFunction(
3566       FDContext, Name, LinkageName, Unit, LineNo,
3567       getOrCreateFunctionType(D, FnType, Unit), ScopeLine, FlagsForDef,
3568       SPFlagsForDef, TParamsArray.get(), getFunctionDeclaration(D));
3569   Fn->setSubprogram(SP);
3570   // We might get here with a VarDecl in the case we're generating
3571   // code for the initialization of globals. Do not record these decls
3572   // as they will overwrite the actual VarDecl Decl in the cache.
3573   if (HasDecl && isa<FunctionDecl>(D))
3574     DeclCache[D->getCanonicalDecl()].reset(SP);
3575 
3576   if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3577     // Starting with DWARF V5 method declarations are emitted as children of
3578     // the interface type.
3579     if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3580       const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3581       QualType QTy(ID->getTypeForDecl(), 0);
3582       auto It = TypeCache.find(QTy.getAsOpaquePtr());
3583       if (It != TypeCache.end()) {
3584         llvm::DICompositeType *InterfaceDecl =
3585             cast<llvm::DICompositeType>(It->second);
3586         llvm::DISubprogram *FD = DBuilder.createFunction(
3587             InterfaceDecl, Name, LinkageName, Unit, LineNo,
3588             getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
3589             TParamsArray.get());
3590         DBuilder.finalizeSubprogram(FD);
3591         ObjCMethodCache[ID].push_back(FD);
3592       }
3593     }
3594   }
3595 
3596   // Push the function onto the lexical block stack.
3597   LexicalBlockStack.emplace_back(SP);
3598 
3599   if (HasDecl)
3600     RegionMap[D].reset(SP);
3601 }
3602 
3603 void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3604                                    QualType FnType) {
3605   StringRef Name;
3606   StringRef LinkageName;
3607 
3608   const Decl *D = GD.getDecl();
3609   if (!D)
3610     return;
3611 
3612   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3613   llvm::DIFile *Unit = getOrCreateFile(Loc);
3614   llvm::DIScope *FDContext = getDeclContextDescriptor(D);
3615   llvm::DINodeArray TParamsArray;
3616   if (isa<FunctionDecl>(D)) {
3617     // If there is a DISubprogram for this function available then use it.
3618     collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3619                              TParamsArray, Flags);
3620   } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3621     Name = getObjCMethodName(OMD);
3622     Flags |= llvm::DINode::FlagPrototyped;
3623   } else {
3624     llvm_unreachable("not a function or ObjC method");
3625   }
3626   if (!Name.empty() && Name[0] == '\01')
3627     Name = Name.substr(1);
3628 
3629   if (D->isImplicit()) {
3630     Flags |= llvm::DINode::FlagArtificial;
3631     // Artificial functions without a location should not silently reuse CurLoc.
3632     if (Loc.isInvalid())
3633       CurLoc = SourceLocation();
3634   }
3635   unsigned LineNo = getLineNumber(Loc);
3636   unsigned ScopeLine = 0;
3637   llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3638   if (CGM.getLangOpts().Optimize)
3639     SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3640 
3641   DBuilder.retainType(DBuilder.createFunction(
3642       FDContext, Name, LinkageName, Unit, LineNo,
3643       getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
3644       TParamsArray.get(), getFunctionDeclaration(D)));
3645 }
3646 
3647 void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3648   const auto *FD = cast<FunctionDecl>(GD.getDecl());
3649   // If there is a subprogram for this function available then use it.
3650   auto FI = SPCache.find(FD->getCanonicalDecl());
3651   llvm::DISubprogram *SP = nullptr;
3652   if (FI != SPCache.end())
3653     SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3654   if (!SP || !SP->isDefinition())
3655     SP = getFunctionStub(GD);
3656   FnBeginRegionCount.push_back(LexicalBlockStack.size());
3657   LexicalBlockStack.emplace_back(SP);
3658   setInlinedAt(Builder.getCurrentDebugLocation());
3659   EmitLocation(Builder, FD->getLocation());
3660 }
3661 
3662 void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3663   assert(CurInlinedAt && "unbalanced inline scope stack");
3664   EmitFunctionEnd(Builder, nullptr);
3665   setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3666 }
3667 
3668 void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
3669   // Update our current location
3670   setLocation(Loc);
3671 
3672   if (CurLoc.isInvalid() || CurLoc.isMacroID() || LexicalBlockStack.empty())
3673     return;
3674 
3675   llvm::MDNode *Scope = LexicalBlockStack.back();
3676   Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3677       getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
3678 }
3679 
3680 void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
3681   llvm::MDNode *Back = nullptr;
3682   if (!LexicalBlockStack.empty())
3683     Back = LexicalBlockStack.back().get();
3684   LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
3685       cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
3686       getColumnNumber(CurLoc)));
3687 }
3688 
3689 void CGDebugInfo::AppendAddressSpaceXDeref(
3690     unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
3691   Optional<unsigned> DWARFAddressSpace =
3692       CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3693   if (!DWARFAddressSpace)
3694     return;
3695 
3696   Expr.push_back(llvm::dwarf::DW_OP_constu);
3697   Expr.push_back(DWARFAddressSpace.getValue());
3698   Expr.push_back(llvm::dwarf::DW_OP_swap);
3699   Expr.push_back(llvm::dwarf::DW_OP_xderef);
3700 }
3701 
3702 void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3703                                         SourceLocation Loc) {
3704   // Set our current location.
3705   setLocation(Loc);
3706 
3707   // Emit a line table change for the current location inside the new scope.
3708   Builder.SetCurrentDebugLocation(
3709       llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3710                           LexicalBlockStack.back(), CurInlinedAt));
3711 
3712   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3713     return;
3714 
3715   // Create a new lexical block and push it on the stack.
3716   CreateLexicalBlock(Loc);
3717 }
3718 
3719 void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3720                                       SourceLocation Loc) {
3721   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3722 
3723   // Provide an entry in the line table for the end of the block.
3724   EmitLocation(Builder, Loc);
3725 
3726   if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3727     return;
3728 
3729   LexicalBlockStack.pop_back();
3730 }
3731 
3732 void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
3733   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3734   unsigned RCount = FnBeginRegionCount.back();
3735   assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3736 
3737   // Pop all regions for this function.
3738   while (LexicalBlockStack.size() != RCount) {
3739     // Provide an entry in the line table for the end of the block.
3740     EmitLocation(Builder, CurLoc);
3741     LexicalBlockStack.pop_back();
3742   }
3743   FnBeginRegionCount.pop_back();
3744 
3745   if (Fn && Fn->getSubprogram())
3746     DBuilder.finalizeSubprogram(Fn->getSubprogram());
3747 }
3748 
3749 CGDebugInfo::BlockByRefType
3750 CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3751                                           uint64_t *XOffset) {
3752   SmallVector<llvm::Metadata *, 5> EltTys;
3753   QualType FType;
3754   uint64_t FieldSize, FieldOffset;
3755   uint32_t FieldAlign;
3756 
3757   llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3758   QualType Type = VD->getType();
3759 
3760   FieldOffset = 0;
3761   FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3762   EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3763   EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3764   FType = CGM.getContext().IntTy;
3765   EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3766   EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3767 
3768   bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3769   if (HasCopyAndDispose) {
3770     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3771     EltTys.push_back(
3772         CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3773     EltTys.push_back(
3774         CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
3775   }
3776   bool HasByrefExtendedLayout;
3777   Qualifiers::ObjCLifetime Lifetime;
3778   if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3779                                         HasByrefExtendedLayout) &&
3780       HasByrefExtendedLayout) {
3781     FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3782     EltTys.push_back(
3783         CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
3784   }
3785 
3786   CharUnits Align = CGM.getContext().getDeclAlign(VD);
3787   if (Align > CGM.getContext().toCharUnitsFromBits(
3788                   CGM.getTarget().getPointerAlign(0))) {
3789     CharUnits FieldOffsetInBytes =
3790         CGM.getContext().toCharUnitsFromBits(FieldOffset);
3791     CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
3792     CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
3793 
3794     if (NumPaddingBytes.isPositive()) {
3795       llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3796       FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3797                                                     pad, ArrayType::Normal, 0);
3798       EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3799     }
3800   }
3801 
3802   FType = Type;
3803   llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
3804   FieldSize = CGM.getContext().getTypeSize(FType);
3805   FieldAlign = CGM.getContext().toBits(Align);
3806 
3807   *XOffset = FieldOffset;
3808   llvm::DIType *FieldTy = DBuilder.createMemberType(
3809       Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3810       llvm::DINode::FlagZero, WrappedTy);
3811   EltTys.push_back(FieldTy);
3812   FieldOffset += FieldSize;
3813 
3814   llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
3815   return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3816                                     llvm::DINode::FlagZero, nullptr, Elements),
3817           WrappedTy};
3818 }
3819 
3820 llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3821                                                 llvm::Value *Storage,
3822                                                 llvm::Optional<unsigned> ArgNo,
3823                                                 CGBuilderTy &Builder) {
3824   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3825   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3826   if (VD->hasAttr<NoDebugAttr>())
3827     return nullptr;
3828 
3829   bool Unwritten =
3830       VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3831                            cast<Decl>(VD->getDeclContext())->isImplicit());
3832   llvm::DIFile *Unit = nullptr;
3833   if (!Unwritten)
3834     Unit = getOrCreateFile(VD->getLocation());
3835   llvm::DIType *Ty;
3836   uint64_t XOffset = 0;
3837   if (VD->hasAttr<BlocksAttr>())
3838     Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
3839   else
3840     Ty = getOrCreateType(VD->getType(), Unit);
3841 
3842   // If there is no debug info for this type then do not emit debug info
3843   // for this variable.
3844   if (!Ty)
3845     return nullptr;
3846 
3847   // Get location information.
3848   unsigned Line = 0;
3849   unsigned Column = 0;
3850   if (!Unwritten) {
3851     Line = getLineNumber(VD->getLocation());
3852     Column = getColumnNumber(VD->getLocation());
3853   }
3854   SmallVector<int64_t, 13> Expr;
3855   llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3856   if (VD->isImplicit())
3857     Flags |= llvm::DINode::FlagArtificial;
3858 
3859   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3860 
3861   unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3862   AppendAddressSpaceXDeref(AddressSpace, Expr);
3863 
3864   // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3865   // object pointer flag.
3866   if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3867     if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3868         IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3869       Flags |= llvm::DINode::FlagObjectPointer;
3870   }
3871 
3872   // Note: Older versions of clang used to emit byval references with an extra
3873   // DW_OP_deref, because they referenced the IR arg directly instead of
3874   // referencing an alloca. Newer versions of LLVM don't treat allocas
3875   // differently from other function arguments when used in a dbg.declare.
3876   auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3877   StringRef Name = VD->getName();
3878   if (!Name.empty()) {
3879     if (VD->hasAttr<BlocksAttr>()) {
3880       // Here, we need an offset *into* the alloca.
3881       CharUnits offset = CharUnits::fromQuantity(32);
3882       Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3883       // offset of __forwarding field
3884       offset = CGM.getContext().toCharUnitsFromBits(
3885           CGM.getTarget().getPointerWidth(0));
3886       Expr.push_back(offset.getQuantity());
3887       Expr.push_back(llvm::dwarf::DW_OP_deref);
3888       Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3889       // offset of x field
3890       offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3891       Expr.push_back(offset.getQuantity());
3892     }
3893   } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
3894     // If VD is an anonymous union then Storage represents value for
3895     // all union fields.
3896     const RecordDecl *RD = RT->getDecl();
3897     if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
3898       // GDB has trouble finding local variables in anonymous unions, so we emit
3899       // artificial local variables for each of the members.
3900       //
3901       // FIXME: Remove this code as soon as GDB supports this.
3902       // The debug info verifier in LLVM operates based on the assumption that a
3903       // variable has the same size as its storage and we had to disable the
3904       // check for artificial variables.
3905       for (const auto *Field : RD->fields()) {
3906         llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
3907         StringRef FieldName = Field->getName();
3908 
3909         // Ignore unnamed fields. Do not ignore unnamed records.
3910         if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3911           continue;
3912 
3913         // Use VarDecl's Tag, Scope and Line number.
3914         auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
3915         auto *D = DBuilder.createAutoVariable(
3916             Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3917             Flags | llvm::DINode::FlagArtificial, FieldAlign);
3918 
3919         // Insert an llvm.dbg.declare into the current block.
3920         DBuilder.insertDeclare(
3921             Storage, D, DBuilder.createExpression(Expr),
3922             llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3923             Builder.GetInsertBlock());
3924       }
3925     }
3926   }
3927 
3928   // Create the descriptor for the variable.
3929   auto *D = ArgNo ? DBuilder.createParameterVariable(
3930                         Scope, Name, *ArgNo, Unit, Line, Ty,
3931                         CGM.getLangOpts().Optimize, Flags)
3932                   : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3933                                                 CGM.getLangOpts().Optimize,
3934                                                 Flags, Align);
3935 
3936   // Insert an llvm.dbg.declare into the current block.
3937   DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3938                          llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3939                          Builder.GetInsertBlock());
3940 
3941   return D;
3942 }
3943 
3944 llvm::DILocalVariable *
3945 CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
3946                                        CGBuilderTy &Builder) {
3947   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3948   return EmitDeclare(VD, Storage, llvm::None, Builder);
3949 }
3950 
3951 void CGDebugInfo::EmitLabel(const LabelDecl *D, CGBuilderTy &Builder) {
3952   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3953   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3954 
3955   if (D->hasAttr<NoDebugAttr>())
3956     return;
3957 
3958   auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3959   llvm::DIFile *Unit = getOrCreateFile(D->getLocation());
3960 
3961   // Get location information.
3962   unsigned Line = getLineNumber(D->getLocation());
3963   unsigned Column = getColumnNumber(D->getLocation());
3964 
3965   StringRef Name = D->getName();
3966 
3967   // Create the descriptor for the label.
3968   auto *L =
3969       DBuilder.createLabel(Scope, Name, Unit, Line, CGM.getLangOpts().Optimize);
3970 
3971   // Insert an llvm.dbg.label into the current block.
3972   DBuilder.insertLabel(L,
3973                        llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3974                        Builder.GetInsertBlock());
3975 }
3976 
3977 llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3978                                           llvm::DIType *Ty) {
3979   llvm::DIType *CachedTy = getTypeOrNull(QualTy);
3980   if (CachedTy)
3981     Ty = CachedTy;
3982   return DBuilder.createObjectPointerType(Ty);
3983 }
3984 
3985 void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3986     const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
3987     const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
3988   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3989   assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3990 
3991   if (Builder.GetInsertBlock() == nullptr)
3992     return;
3993   if (VD->hasAttr<NoDebugAttr>())
3994     return;
3995 
3996   bool isByRef = VD->hasAttr<BlocksAttr>();
3997 
3998   uint64_t XOffset = 0;
3999   llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4000   llvm::DIType *Ty;
4001   if (isByRef)
4002     Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
4003   else
4004     Ty = getOrCreateType(VD->getType(), Unit);
4005 
4006   // Self is passed along as an implicit non-arg variable in a
4007   // block. Mark it as the object pointer.
4008   if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
4009     if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
4010       Ty = CreateSelfType(VD->getType(), Ty);
4011 
4012   // Get location information.
4013   unsigned Line = getLineNumber(VD->getLocation());
4014   unsigned Column = getColumnNumber(VD->getLocation());
4015 
4016   const llvm::DataLayout &target = CGM.getDataLayout();
4017 
4018   CharUnits offset = CharUnits::fromQuantity(
4019       target.getStructLayout(blockInfo.StructureType)
4020           ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
4021 
4022   SmallVector<int64_t, 9> addr;
4023   addr.push_back(llvm::dwarf::DW_OP_deref);
4024   addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
4025   addr.push_back(offset.getQuantity());
4026   if (isByRef) {
4027     addr.push_back(llvm::dwarf::DW_OP_deref);
4028     addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
4029     // offset of __forwarding field
4030     offset =
4031         CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
4032     addr.push_back(offset.getQuantity());
4033     addr.push_back(llvm::dwarf::DW_OP_deref);
4034     addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
4035     // offset of x field
4036     offset = CGM.getContext().toCharUnitsFromBits(XOffset);
4037     addr.push_back(offset.getQuantity());
4038   }
4039 
4040   // Create the descriptor for the variable.
4041   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
4042   auto *D = DBuilder.createAutoVariable(
4043       cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
4044       Line, Ty, false, llvm::DINode::FlagZero, Align);
4045 
4046   // Insert an llvm.dbg.declare into the current block.
4047   auto DL =
4048       llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
4049   auto *Expr = DBuilder.createExpression(addr);
4050   if (InsertPoint)
4051     DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
4052   else
4053     DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
4054 }
4055 
4056 void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
4057                                            unsigned ArgNo,
4058                                            CGBuilderTy &Builder) {
4059   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4060   EmitDeclare(VD, AI, ArgNo, Builder);
4061 }
4062 
4063 namespace {
4064 struct BlockLayoutChunk {
4065   uint64_t OffsetInBits;
4066   const BlockDecl::Capture *Capture;
4067 };
4068 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
4069   return l.OffsetInBits < r.OffsetInBits;
4070 }
4071 } // namespace
4072 
4073 void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
4074     const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
4075     const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
4076     SmallVectorImpl<llvm::Metadata *> &Fields) {
4077   // Blocks in OpenCL have unique constraints which make the standard fields
4078   // redundant while requiring size and align fields for enqueue_kernel. See
4079   // initializeForBlockHeader in CGBlocks.cpp
4080   if (CGM.getLangOpts().OpenCL) {
4081     Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
4082                                      BlockLayout.getElementOffsetInBits(0),
4083                                      Unit, Unit));
4084     Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
4085                                      BlockLayout.getElementOffsetInBits(1),
4086                                      Unit, Unit));
4087   } else {
4088     Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
4089                                      BlockLayout.getElementOffsetInBits(0),
4090                                      Unit, Unit));
4091     Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
4092                                      BlockLayout.getElementOffsetInBits(1),
4093                                      Unit, Unit));
4094     Fields.push_back(
4095         createFieldType("__reserved", Context.IntTy, Loc, AS_public,
4096                         BlockLayout.getElementOffsetInBits(2), Unit, Unit));
4097     auto *FnTy = Block.getBlockExpr()->getFunctionType();
4098     auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
4099     Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
4100                                      BlockLayout.getElementOffsetInBits(3),
4101                                      Unit, Unit));
4102     Fields.push_back(createFieldType(
4103         "__descriptor",
4104         Context.getPointerType(Block.NeedsCopyDispose
4105                                    ? Context.getBlockDescriptorExtendedType()
4106                                    : Context.getBlockDescriptorType()),
4107         Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
4108   }
4109 }
4110 
4111 void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
4112                                                        StringRef Name,
4113                                                        unsigned ArgNo,
4114                                                        llvm::AllocaInst *Alloca,
4115                                                        CGBuilderTy &Builder) {
4116   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4117   ASTContext &C = CGM.getContext();
4118   const BlockDecl *blockDecl = block.getBlockDecl();
4119 
4120   // Collect some general information about the block's location.
4121   SourceLocation loc = blockDecl->getCaretLocation();
4122   llvm::DIFile *tunit = getOrCreateFile(loc);
4123   unsigned line = getLineNumber(loc);
4124   unsigned column = getColumnNumber(loc);
4125 
4126   // Build the debug-info type for the block literal.
4127   getDeclContextDescriptor(blockDecl);
4128 
4129   const llvm::StructLayout *blockLayout =
4130       CGM.getDataLayout().getStructLayout(block.StructureType);
4131 
4132   SmallVector<llvm::Metadata *, 16> fields;
4133   collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
4134                                              fields);
4135 
4136   // We want to sort the captures by offset, not because DWARF
4137   // requires this, but because we're paranoid about debuggers.
4138   SmallVector<BlockLayoutChunk, 8> chunks;
4139 
4140   // 'this' capture.
4141   if (blockDecl->capturesCXXThis()) {
4142     BlockLayoutChunk chunk;
4143     chunk.OffsetInBits =
4144         blockLayout->getElementOffsetInBits(block.CXXThisIndex);
4145     chunk.Capture = nullptr;
4146     chunks.push_back(chunk);
4147   }
4148 
4149   // Variable captures.
4150   for (const auto &capture : blockDecl->captures()) {
4151     const VarDecl *variable = capture.getVariable();
4152     const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
4153 
4154     // Ignore constant captures.
4155     if (captureInfo.isConstant())
4156       continue;
4157 
4158     BlockLayoutChunk chunk;
4159     chunk.OffsetInBits =
4160         blockLayout->getElementOffsetInBits(captureInfo.getIndex());
4161     chunk.Capture = &capture;
4162     chunks.push_back(chunk);
4163   }
4164 
4165   // Sort by offset.
4166   llvm::array_pod_sort(chunks.begin(), chunks.end());
4167 
4168   for (const BlockLayoutChunk &Chunk : chunks) {
4169     uint64_t offsetInBits = Chunk.OffsetInBits;
4170     const BlockDecl::Capture *capture = Chunk.Capture;
4171 
4172     // If we have a null capture, this must be the C++ 'this' capture.
4173     if (!capture) {
4174       QualType type;
4175       if (auto *Method =
4176               cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
4177         type = Method->getThisType();
4178       else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4179         type = QualType(RDecl->getTypeForDecl(), 0);
4180       else
4181         llvm_unreachable("unexpected block declcontext");
4182 
4183       fields.push_back(createFieldType("this", type, loc, AS_public,
4184                                        offsetInBits, tunit, tunit));
4185       continue;
4186     }
4187 
4188     const VarDecl *variable = capture->getVariable();
4189     StringRef name = variable->getName();
4190 
4191     llvm::DIType *fieldType;
4192     if (capture->isByRef()) {
4193       TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
4194       auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
4195       // FIXME: This recomputes the layout of the BlockByRefWrapper.
4196       uint64_t xoffset;
4197       fieldType =
4198           EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
4199       fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
4200       fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4201                                             PtrInfo.Width, Align, offsetInBits,
4202                                             llvm::DINode::FlagZero, fieldType);
4203     } else {
4204       auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
4205       fieldType = createFieldType(name, variable->getType(), loc, AS_public,
4206                                   offsetInBits, Align, tunit, tunit);
4207     }
4208     fields.push_back(fieldType);
4209   }
4210 
4211   SmallString<36> typeName;
4212   llvm::raw_svector_ostream(typeName)
4213       << "__block_literal_" << CGM.getUniqueBlockCount();
4214 
4215   llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
4216 
4217   llvm::DIType *type =
4218       DBuilder.createStructType(tunit, typeName.str(), tunit, line,
4219                                 CGM.getContext().toBits(block.BlockSize), 0,
4220                                 llvm::DINode::FlagZero, nullptr, fieldsArray);
4221   type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4222 
4223   // Get overall information about the block.
4224   llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
4225   auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
4226 
4227   // Create the descriptor for the parameter.
4228   auto *debugVar = DBuilder.createParameterVariable(
4229       scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
4230 
4231   // Insert an llvm.dbg.declare into the current block.
4232   DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
4233                          llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
4234                          Builder.GetInsertBlock());
4235 }
4236 
4237 llvm::DIDerivedType *
4238 CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4239   if (!D->isStaticDataMember())
4240     return nullptr;
4241 
4242   auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
4243   if (MI != StaticDataMemberCache.end()) {
4244     assert(MI->second && "Static data member declaration should still exist");
4245     return MI->second;
4246   }
4247 
4248   // If the member wasn't found in the cache, lazily construct and add it to the
4249   // type (used when a limited form of the type is emitted).
4250   auto DC = D->getDeclContext();
4251   auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
4252   return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
4253 }
4254 
4255 llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
4256     const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4257     StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
4258   llvm::DIGlobalVariableExpression *GVE = nullptr;
4259 
4260   for (const auto *Field : RD->fields()) {
4261     llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
4262     StringRef FieldName = Field->getName();
4263 
4264     // Ignore unnamed fields, but recurse into anonymous records.
4265     if (FieldName.empty()) {
4266       if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
4267         GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
4268                                      Var, DContext);
4269       continue;
4270     }
4271     // Use VarDecl's Tag, Scope and Line number.
4272     GVE = DBuilder.createGlobalVariableExpression(
4273         DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4274         Var->hasLocalLinkage());
4275     Var->addDebugInfo(GVE);
4276   }
4277   return GVE;
4278 }
4279 
4280 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
4281                                      const VarDecl *D) {
4282   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4283   if (D->hasAttr<NoDebugAttr>())
4284     return;
4285 
4286   // If we already created a DIGlobalVariable for this declaration, just attach
4287   // it to the llvm::GlobalVariable.
4288   auto Cached = DeclCache.find(D->getCanonicalDecl());
4289   if (Cached != DeclCache.end())
4290     return Var->addDebugInfo(
4291         cast<llvm::DIGlobalVariableExpression>(Cached->second));
4292 
4293   // Create global variable debug descriptor.
4294   llvm::DIFile *Unit = nullptr;
4295   llvm::DIScope *DContext = nullptr;
4296   unsigned LineNo;
4297   StringRef DeclName, LinkageName;
4298   QualType T;
4299   llvm::MDTuple *TemplateParameters = nullptr;
4300   collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4301                       TemplateParameters, DContext);
4302 
4303   // Attempt to store one global variable for the declaration - even if we
4304   // emit a lot of fields.
4305   llvm::DIGlobalVariableExpression *GVE = nullptr;
4306 
4307   // If this is an anonymous union then we'll want to emit a global
4308   // variable for each member of the anonymous union so that it's possible
4309   // to find the name of any field in the union.
4310   if (T->isUnionType() && DeclName.empty()) {
4311     const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
4312     assert(RD->isAnonymousStructOrUnion() &&
4313            "unnamed non-anonymous struct or union?");
4314     GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
4315   } else {
4316     auto Align = getDeclAlignIfRequired(D, CGM.getContext());
4317 
4318     SmallVector<int64_t, 4> Expr;
4319     unsigned AddressSpace =
4320         CGM.getContext().getTargetAddressSpace(D->getType());
4321     if (CGM.getLangOpts().CUDA && CGM.getLangOpts().CUDAIsDevice) {
4322       if (D->hasAttr<CUDASharedAttr>())
4323         AddressSpace =
4324             CGM.getContext().getTargetAddressSpace(LangAS::cuda_shared);
4325       else if (D->hasAttr<CUDAConstantAttr>())
4326         AddressSpace =
4327             CGM.getContext().getTargetAddressSpace(LangAS::cuda_constant);
4328     }
4329     AppendAddressSpaceXDeref(AddressSpace, Expr);
4330 
4331     GVE = DBuilder.createGlobalVariableExpression(
4332         DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
4333         Var->hasLocalLinkage(),
4334         Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
4335         getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4336         Align);
4337     Var->addDebugInfo(GVE);
4338   }
4339   DeclCache[D->getCanonicalDecl()].reset(GVE);
4340 }
4341 
4342 void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
4343   assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4344   if (VD->hasAttr<NoDebugAttr>())
4345     return;
4346   auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
4347   // Create the descriptor for the variable.
4348   llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4349   StringRef Name = VD->getName();
4350   llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
4351   if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4352     const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
4353     assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4354     Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
4355   }
4356   // Do not use global variables for enums.
4357   //
4358   // FIXME: why not?
4359   if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
4360     return;
4361   // Do not emit separate definitions for function local const/statics.
4362   if (isa<FunctionDecl>(VD->getDeclContext()))
4363     return;
4364   VD = cast<ValueDecl>(VD->getCanonicalDecl());
4365   auto *VarD = cast<VarDecl>(VD);
4366   if (VarD->isStaticDataMember()) {
4367     auto *RD = cast<RecordDecl>(VarD->getDeclContext());
4368     getDeclContextDescriptor(VarD);
4369     // Ensure that the type is retained even though it's otherwise unreferenced.
4370     //
4371     // FIXME: This is probably unnecessary, since Ty should reference RD
4372     // through its scope.
4373     RetainedTypes.push_back(
4374         CGM.getContext().getRecordType(RD).getAsOpaquePtr());
4375     return;
4376   }
4377 
4378   llvm::DIScope *DContext = getDeclContextDescriptor(VD);
4379 
4380   auto &GV = DeclCache[VD];
4381   if (GV)
4382     return;
4383   llvm::DIExpression *InitExpr = nullptr;
4384   if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4385     // FIXME: Add a representation for integer constants wider than 64 bits.
4386     if (Init.isInt())
4387       InitExpr =
4388           DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4389     else if (Init.isFloat())
4390       InitExpr = DBuilder.createConstantValueExpression(
4391           Init.getFloat().bitcastToAPInt().getZExtValue());
4392   }
4393 
4394   llvm::MDTuple *TemplateParameters = nullptr;
4395 
4396   if (isa<VarTemplateSpecializationDecl>(VD))
4397     if (VarD) {
4398       llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4399       TemplateParameters = parameterNodes.get();
4400     }
4401 
4402   GV.reset(DBuilder.createGlobalVariableExpression(
4403       DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
4404       true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
4405       TemplateParameters, Align));
4406 }
4407 
4408 llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
4409   if (!LexicalBlockStack.empty())
4410     return LexicalBlockStack.back();
4411   llvm::DIScope *Mod = getParentModuleOrNull(D);
4412   return getContextDescriptor(D, Mod ? Mod : TheCU);
4413 }
4414 
4415 void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
4416   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4417     return;
4418   const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
4419   if (!NSDecl->isAnonymousNamespace() ||
4420       CGM.getCodeGenOpts().DebugExplicitImport) {
4421     auto Loc = UD.getLocation();
4422     DBuilder.createImportedModule(
4423         getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
4424         getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
4425   }
4426 }
4427 
4428 void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
4429   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4430     return;
4431   assert(UD.shadow_size() &&
4432          "We shouldn't be codegening an invalid UsingDecl containing no decls");
4433   // Emitting one decl is sufficient - debuggers can detect that this is an
4434   // overloaded name & provide lookup for all the overloads.
4435   const UsingShadowDecl &USD = **UD.shadow_begin();
4436 
4437   // FIXME: Skip functions with undeduced auto return type for now since we
4438   // don't currently have the plumbing for separate declarations & definitions
4439   // of free functions and mismatched types (auto in the declaration, concrete
4440   // return type in the definition)
4441   if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4442     if (const auto *AT =
4443             FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4444       if (AT->getDeducedType().isNull())
4445         return;
4446   if (llvm::DINode *Target =
4447           getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4448     auto Loc = USD.getLocation();
4449     DBuilder.createImportedDeclaration(
4450         getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
4451         getOrCreateFile(Loc), getLineNumber(Loc));
4452   }
4453 }
4454 
4455 void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
4456   if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4457     return;
4458   if (Module *M = ID.getImportedModule()) {
4459     auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
4460     auto Loc = ID.getLocation();
4461     DBuilder.createImportedDeclaration(
4462         getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
4463         getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4464         getLineNumber(Loc));
4465   }
4466 }
4467 
4468 llvm::DIImportedEntity *
4469 CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
4470   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4471     return nullptr;
4472   auto &VH = NamespaceAliasCache[&NA];
4473   if (VH)
4474     return cast<llvm::DIImportedEntity>(VH);
4475   llvm::DIImportedEntity *R;
4476   auto Loc = NA.getLocation();
4477   if (const auto *Underlying =
4478           dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4479     // This could cache & dedup here rather than relying on metadata deduping.
4480     R = DBuilder.createImportedDeclaration(
4481         getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4482         EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4483         getLineNumber(Loc), NA.getName());
4484   else
4485     R = DBuilder.createImportedDeclaration(
4486         getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4487         getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
4488         getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
4489   VH.reset(R);
4490   return R;
4491 }
4492 
4493 llvm::DINamespace *
4494 CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4495   // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4496   // if necessary, and this way multiple declarations of the same namespace in
4497   // different parent modules stay distinct.
4498   auto I = NamespaceCache.find(NSDecl);
4499   if (I != NamespaceCache.end())
4500     return cast<llvm::DINamespace>(I->second);
4501 
4502   llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
4503   // Don't trust the context if it is a DIModule (see comment above).
4504   llvm::DINamespace *NS =
4505       DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4506   NamespaceCache[NSDecl].reset(NS);
4507   return NS;
4508 }
4509 
4510 void CGDebugInfo::setDwoId(uint64_t Signature) {
4511   assert(TheCU && "no main compile unit");
4512   TheCU->setDWOId(Signature);
4513 }
4514 
4515 void CGDebugInfo::finalize() {
4516   // Creating types might create further types - invalidating the current
4517   // element and the size(), so don't cache/reference them.
4518   for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4519     ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
4520     llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
4521                            ? CreateTypeDefinition(E.Type, E.Unit)
4522                            : E.Decl;
4523     DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
4524   }
4525 
4526   if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4527     // Add methods to interface.
4528     for (const auto &P : ObjCMethodCache) {
4529       if (P.second.empty())
4530         continue;
4531 
4532       QualType QTy(P.first->getTypeForDecl(), 0);
4533       auto It = TypeCache.find(QTy.getAsOpaquePtr());
4534       assert(It != TypeCache.end());
4535 
4536       llvm::DICompositeType *InterfaceDecl =
4537           cast<llvm::DICompositeType>(It->second);
4538 
4539       SmallVector<llvm::Metadata *, 16> EltTys;
4540       auto CurrenetElts = InterfaceDecl->getElements();
4541       EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4542       for (auto &MD : P.second)
4543         EltTys.push_back(MD);
4544       llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4545       DBuilder.replaceArrays(InterfaceDecl, Elements);
4546     }
4547   }
4548 
4549   for (const auto &P : ReplaceMap) {
4550     assert(P.second);
4551     auto *Ty = cast<llvm::DIType>(P.second);
4552     assert(Ty->isForwardDecl());
4553 
4554     auto It = TypeCache.find(P.first);
4555     assert(It != TypeCache.end());
4556     assert(It->second);
4557 
4558     DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4559                               cast<llvm::DIType>(It->second));
4560   }
4561 
4562   for (const auto &P : FwdDeclReplaceMap) {
4563     assert(P.second);
4564     llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
4565     llvm::Metadata *Repl;
4566 
4567     auto It = DeclCache.find(P.first);
4568     // If there has been no definition for the declaration, call RAUW
4569     // with ourselves, that will destroy the temporary MDNode and
4570     // replace it with a standard one, avoiding leaking memory.
4571     if (It == DeclCache.end())
4572       Repl = P.second;
4573     else
4574       Repl = It->second;
4575 
4576     if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4577       Repl = GVE->getVariable();
4578     DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
4579   }
4580 
4581   // We keep our own list of retained types, because we need to look
4582   // up the final type in the type cache.
4583   for (auto &RT : RetainedTypes)
4584     if (auto MD = TypeCache[RT])
4585       DBuilder.retainType(cast<llvm::DIType>(MD));
4586 
4587   DBuilder.finalize();
4588 }
4589 
4590 void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
4591   if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4592     return;
4593 
4594   if (auto *DieTy = getOrCreateType(Ty, TheCU->getFile()))
4595     // Don't ignore in case of explicit cast where it is referenced indirectly.
4596     DBuilder.retainType(DieTy);
4597 }
4598 
4599 llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4600   if (LexicalBlockStack.empty())
4601     return llvm::DebugLoc();
4602 
4603   llvm::MDNode *Scope = LexicalBlockStack.back();
4604   return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
4605 }
4606 
4607 llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4608   // Call site-related attributes are only useful in optimized programs, and
4609   // when there's a possibility of debugging backtraces.
4610   if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4611       DebugKind == codegenoptions::LocTrackingOnly)
4612     return llvm::DINode::FlagZero;
4613 
4614   // Call site-related attributes are available in DWARF v5. Some debuggers,
4615   // while not fully DWARF v5-compliant, may accept these attributes as if they
4616   // were part of DWARF v4.
4617   bool SupportsDWARFv4Ext =
4618       CGM.getCodeGenOpts().DwarfVersion == 4 &&
4619       CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB;
4620   if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4621     return llvm::DINode::FlagZero;
4622 
4623   return llvm::DINode::FlagAllCallsDescribed;
4624 }
4625