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