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