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