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