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