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