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