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