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