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