CGDebugInfo.cpp revision aa6eccce0cd6e15229cdee52177477371890d3c4
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.ObjCRuntime.isNonFragile() ? 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 *FPT = dyn_cast<FunctionProtoType>(Ty)) {
688    for (unsigned i = 0, e = FPT->getNumArgs(); i != e; ++i)
689      EltTys.push_back(getOrCreateType(FPT->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 Field 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      // Only emit debug information for user provided functions, we're
996      // unlikely to want info for artificial functions.
997      if (Method->isUserProvided())
998        EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
999    }
1000    else if (FunctionTemplateDecl *FTD = dyn_cast<FunctionTemplateDecl>(D))
1001      for (FunctionTemplateDecl::spec_iterator SI = FTD->spec_begin(),
1002            SE = FTD->spec_end(); SI != SE; ++SI) {
1003        FunctionDecl *FD = *SI;
1004        if (CXXMethodDecl *M = dyn_cast<CXXMethodDecl>(FD))
1005          EltTys.push_back(CreateCXXMemberFunction(M, Unit, RecordTy));
1006      }
1007  }
1008}
1009
1010/// CollectCXXFriends - A helper function to collect debug info for
1011/// C++ base classes. This is used while creating debug info entry for
1012/// a Record.
1013void CGDebugInfo::
1014CollectCXXFriends(const CXXRecordDecl *RD, llvm::DIFile Unit,
1015                SmallVectorImpl<llvm::Value *> &EltTys,
1016                llvm::DIType RecordTy) {
1017  for (CXXRecordDecl::friend_iterator BI = RD->friend_begin(),
1018         BE = RD->friend_end(); BI != BE; ++BI) {
1019    if ((*BI)->isUnsupportedFriend())
1020      continue;
1021    if (TypeSourceInfo *TInfo = (*BI)->getFriendType())
1022      EltTys.push_back(DBuilder.createFriend(RecordTy,
1023                                             getOrCreateType(TInfo->getType(),
1024                                                             Unit)));
1025  }
1026}
1027
1028/// CollectCXXBases - A helper function to collect debug info for
1029/// C++ base classes. This is used while creating debug info entry for
1030/// a Record.
1031void CGDebugInfo::
1032CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1033                SmallVectorImpl<llvm::Value *> &EltTys,
1034                llvm::DIType RecordTy) {
1035
1036  const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1037  for (CXXRecordDecl::base_class_const_iterator BI = RD->bases_begin(),
1038         BE = RD->bases_end(); BI != BE; ++BI) {
1039    unsigned BFlags = 0;
1040    uint64_t BaseOffset;
1041
1042    const CXXRecordDecl *Base =
1043      cast<CXXRecordDecl>(BI->getType()->getAs<RecordType>()->getDecl());
1044
1045    if (BI->isVirtual()) {
1046      // virtual base offset offset is -ve. The code generator emits dwarf
1047      // expression where it expects +ve number.
1048      BaseOffset =
1049        0 - CGM.getVTableContext()
1050               .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1051      BFlags = llvm::DIDescriptor::FlagVirtual;
1052    } else
1053      BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1054    // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1055    // BI->isVirtual() and bits when not.
1056
1057    AccessSpecifier Access = BI->getAccessSpecifier();
1058    if (Access == clang::AS_private)
1059      BFlags |= llvm::DIDescriptor::FlagPrivate;
1060    else if (Access == clang::AS_protected)
1061      BFlags |= llvm::DIDescriptor::FlagProtected;
1062
1063    llvm::DIType DTy =
1064      DBuilder.createInheritance(RecordTy,
1065                                 getOrCreateType(BI->getType(), Unit),
1066                                 BaseOffset, BFlags);
1067    EltTys.push_back(DTy);
1068  }
1069}
1070
1071/// CollectTemplateParams - A helper function to collect template parameters.
1072llvm::DIArray CGDebugInfo::
1073CollectTemplateParams(const TemplateParameterList *TPList,
1074                      const TemplateArgumentList &TAList,
1075                      llvm::DIFile Unit) {
1076  SmallVector<llvm::Value *, 16> TemplateParams;
1077  for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1078    const TemplateArgument &TA = TAList[i];
1079    const NamedDecl *ND = TPList->getParam(i);
1080    if (TA.getKind() == TemplateArgument::Type) {
1081      llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1082      llvm::DITemplateTypeParameter TTP =
1083        DBuilder.createTemplateTypeParameter(TheCU, ND->getName(), TTy);
1084      TemplateParams.push_back(TTP);
1085    } else if (TA.getKind() == TemplateArgument::Integral) {
1086      llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1087      llvm::DITemplateValueParameter TVP =
1088        DBuilder.createTemplateValueParameter(TheCU, ND->getName(), TTy,
1089                                             TA.getAsIntegral().getZExtValue());
1090      TemplateParams.push_back(TVP);
1091    }
1092  }
1093  return DBuilder.getOrCreateArray(TemplateParams);
1094}
1095
1096/// CollectFunctionTemplateParams - A helper function to collect debug
1097/// info for function template parameters.
1098llvm::DIArray CGDebugInfo::
1099CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1100  if (FD->getTemplatedKind() ==
1101      FunctionDecl::TK_FunctionTemplateSpecialization) {
1102    const TemplateParameterList *TList =
1103      FD->getTemplateSpecializationInfo()->getTemplate()
1104      ->getTemplateParameters();
1105    return
1106      CollectTemplateParams(TList, *FD->getTemplateSpecializationArgs(), Unit);
1107  }
1108  return llvm::DIArray();
1109}
1110
1111/// CollectCXXTemplateParams - A helper function to collect debug info for
1112/// template parameters.
1113llvm::DIArray CGDebugInfo::
1114CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1115                         llvm::DIFile Unit) {
1116  llvm::PointerUnion<ClassTemplateDecl *,
1117                     ClassTemplatePartialSpecializationDecl *>
1118    PU = TSpecial->getSpecializedTemplateOrPartial();
1119
1120  TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1121    PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1122    PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1123  const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
1124  return CollectTemplateParams(TPList, TAList, Unit);
1125}
1126
1127/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1128llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1129  if (VTablePtrType.isValid())
1130    return VTablePtrType;
1131
1132  ASTContext &Context = CGM.getContext();
1133
1134  /* Function type */
1135  llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1136  llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1137  llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1138  unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1139  llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1140                                                          "__vtbl_ptr_type");
1141  VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1142  return VTablePtrType;
1143}
1144
1145/// getVTableName - Get vtable name for the given Class.
1146StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1147  // Construct gdb compatible name name.
1148  std::string Name = "_vptr$" + RD->getNameAsString();
1149
1150  // Copy this name on the side and use its reference.
1151  char *StrPtr = DebugInfoNames.Allocate<char>(Name.length());
1152  memcpy(StrPtr, Name.data(), Name.length());
1153  return StringRef(StrPtr, Name.length());
1154}
1155
1156
1157/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1158/// debug info entry in EltTys vector.
1159void CGDebugInfo::
1160CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1161                  SmallVectorImpl<llvm::Value *> &EltTys) {
1162  const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1163
1164  // If there is a primary base then it will hold vtable info.
1165  if (RL.getPrimaryBase())
1166    return;
1167
1168  // If this class is not dynamic then there is not any vtable info to collect.
1169  if (!RD->isDynamicClass())
1170    return;
1171
1172  unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1173  llvm::DIType VPTR
1174    = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
1175                                0, Size, 0, 0, 0,
1176                                getOrCreateVTablePtrType(Unit));
1177  EltTys.push_back(VPTR);
1178}
1179
1180/// getOrCreateRecordType - Emit record type's standalone debug info.
1181llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
1182                                                SourceLocation Loc) {
1183  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
1184  llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1185  return T;
1186}
1187
1188/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1189/// debug info.
1190llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
1191						   SourceLocation Loc) {
1192  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
1193  llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
1194  DBuilder.retainType(T);
1195  return T;
1196}
1197
1198/// CreateType - get structure or union type.
1199llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
1200  RecordDecl *RD = Ty->getDecl();
1201
1202  // Get overall information about the record type for the debug info.
1203  llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1204
1205  // Records and classes and unions can all be recursive.  To handle them, we
1206  // first generate a debug descriptor for the struct as a forward declaration.
1207  // Then (if it is a definition) we go through and get debug info for all of
1208  // its members.  Finally, we create a descriptor for the complete type (which
1209  // may refer to the forward decl if the struct is recursive) and replace all
1210  // uses of the forward declaration with the final definition.
1211
1212  llvm::DIType FwdDecl = getOrCreateLimitedType(QualType(Ty, 0), DefUnit);
1213
1214  if (FwdDecl.isForwardDecl())
1215    return FwdDecl;
1216
1217  llvm::TrackingVH<llvm::MDNode> FwdDeclNode(FwdDecl);
1218
1219  // Push the struct on region stack.
1220  LexicalBlockStack.push_back(FwdDeclNode);
1221  RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1222
1223  // Add this to the completed types cache since we're completing it.
1224  CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1225
1226  // Convert all the elements.
1227  SmallVector<llvm::Value *, 16> EltTys;
1228
1229  // Note: The split of CXXDecl information here is intentional, the
1230  // gdb tests will depend on a certain ordering at printout. The debug
1231  // information offsets are still correct if we merge them all together
1232  // though.
1233  const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1234  if (CXXDecl) {
1235    CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1236    CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1237  }
1238
1239  // Collect static variables with initializers and other fields.
1240  CollectRecordStaticVars(RD, FwdDecl);
1241  CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
1242  llvm::DIArray TParamsArray;
1243  if (CXXDecl) {
1244    CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
1245    CollectCXXFriends(CXXDecl, DefUnit, EltTys, FwdDecl);
1246    if (const ClassTemplateSpecializationDecl *TSpecial
1247        = dyn_cast<ClassTemplateSpecializationDecl>(RD))
1248      TParamsArray = CollectCXXTemplateParams(TSpecial, DefUnit);
1249  }
1250
1251  LexicalBlockStack.pop_back();
1252  RegionMap.erase(Ty->getDecl());
1253
1254  llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
1255  // FIXME: Magic numbers ahoy! These should be changed when we
1256  // get some enums in llvm/Analysis/DebugInfo.h to refer to
1257  // them.
1258  if (RD->isUnion())
1259    FwdDeclNode->replaceOperandWith(10, Elements);
1260  else if (CXXDecl) {
1261    FwdDeclNode->replaceOperandWith(10, Elements);
1262    FwdDeclNode->replaceOperandWith(13, TParamsArray);
1263  } else
1264    FwdDeclNode->replaceOperandWith(10, Elements);
1265
1266  RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDeclNode);
1267  return llvm::DIType(FwdDeclNode);
1268}
1269
1270/// CreateType - get objective-c object type.
1271llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1272                                     llvm::DIFile Unit) {
1273  // Ignore protocols.
1274  return getOrCreateType(Ty->getBaseType(), Unit);
1275}
1276
1277/// CreateType - get objective-c interface type.
1278llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1279                                     llvm::DIFile Unit) {
1280  ObjCInterfaceDecl *ID = Ty->getDecl();
1281  if (!ID)
1282    return llvm::DIType();
1283
1284  // Get overall information about the record type for the debug info.
1285  llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1286  unsigned Line = getLineNumber(ID->getLocation());
1287  unsigned RuntimeLang = TheCU.getLanguage();
1288
1289  // If this is just a forward declaration return a special forward-declaration
1290  // debug type since we won't be able to lay out the entire type.
1291  ObjCInterfaceDecl *Def = ID->getDefinition();
1292  if (!Def) {
1293    llvm::DIType FwdDecl =
1294      DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1295				 ID->getName(), TheCU, DefUnit, Line,
1296				 RuntimeLang);
1297    return FwdDecl;
1298  }
1299
1300  ID = Def;
1301
1302  // Bit size, align and offset of the type.
1303  uint64_t Size = CGM.getContext().getTypeSize(Ty);
1304  uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1305
1306  unsigned Flags = 0;
1307  if (ID->getImplementation())
1308    Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1309
1310  llvm::DIType RealDecl =
1311    DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1312                              Line, Size, Align, Flags,
1313                              llvm::DIArray(), RuntimeLang);
1314
1315  // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1316  // will find it and we're emitting the complete type.
1317  CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
1318  // Push the struct on region stack.
1319  llvm::TrackingVH<llvm::MDNode> FwdDeclNode(RealDecl);
1320
1321  LexicalBlockStack.push_back(FwdDeclNode);
1322  RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1323
1324  // Convert all the elements.
1325  SmallVector<llvm::Value *, 16> EltTys;
1326
1327  ObjCInterfaceDecl *SClass = ID->getSuperClass();
1328  if (SClass) {
1329    llvm::DIType SClassTy =
1330      getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1331    if (!SClassTy.isValid())
1332      return llvm::DIType();
1333
1334    llvm::DIType InhTag =
1335      DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1336    EltTys.push_back(InhTag);
1337  }
1338
1339  for (ObjCContainerDecl::prop_iterator I = ID->prop_begin(),
1340         E = ID->prop_end(); I != E; ++I) {
1341    const ObjCPropertyDecl *PD = *I;
1342    SourceLocation Loc = PD->getLocation();
1343    llvm::DIFile PUnit = getOrCreateFile(Loc);
1344    unsigned PLine = getLineNumber(Loc);
1345    ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1346    ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1347    llvm::MDNode *PropertyNode =
1348      DBuilder.createObjCProperty(PD->getName(),
1349				  PUnit, PLine,
1350                                  (Getter && Getter->isImplicit()) ? "" :
1351                                  getSelectorName(PD->getGetterName()),
1352                                  (Setter && Setter->isImplicit()) ? "" :
1353                                  getSelectorName(PD->getSetterName()),
1354                                  PD->getPropertyAttributes(),
1355				  getOrCreateType(PD->getType(), PUnit));
1356    EltTys.push_back(PropertyNode);
1357  }
1358
1359  const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1360  unsigned FieldNo = 0;
1361  for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1362       Field = Field->getNextIvar(), ++FieldNo) {
1363    llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1364    if (!FieldTy.isValid())
1365      return llvm::DIType();
1366
1367    StringRef FieldName = Field->getName();
1368
1369    // Ignore unnamed fields.
1370    if (FieldName.empty())
1371      continue;
1372
1373    // Get the location for the field.
1374    llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1375    unsigned FieldLine = getLineNumber(Field->getLocation());
1376    QualType FType = Field->getType();
1377    uint64_t FieldSize = 0;
1378    unsigned FieldAlign = 0;
1379
1380    if (!FType->isIncompleteArrayType()) {
1381
1382      // Bit size, align and offset of the type.
1383      FieldSize = Field->isBitField()
1384        ? Field->getBitWidthValue(CGM.getContext())
1385        : CGM.getContext().getTypeSize(FType);
1386      FieldAlign = CGM.getContext().getTypeAlign(FType);
1387    }
1388
1389    // We can't know the offset of our ivar in the structure if we're using
1390    // the non-fragile abi and the debugger should ignore the value anyways.
1391    // Call it the FieldNo+1 due to how debuggers use the information,
1392    // e.g. negating the value when it needs a lookup in the dynamic table.
1393    uint64_t FieldOffset = CGM.getLangOpts().ObjCRuntime.isNonFragile()
1394                             ? FieldNo+1 : RL.getFieldOffset(FieldNo);
1395
1396    unsigned Flags = 0;
1397    if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1398      Flags = llvm::DIDescriptor::FlagProtected;
1399    else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1400      Flags = llvm::DIDescriptor::FlagPrivate;
1401
1402    llvm::MDNode *PropertyNode = NULL;
1403    if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
1404      if (ObjCPropertyImplDecl *PImpD =
1405          ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1406        if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
1407	  SourceLocation Loc = PD->getLocation();
1408	  llvm::DIFile PUnit = getOrCreateFile(Loc);
1409	  unsigned PLine = getLineNumber(Loc);
1410          ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1411          ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1412          PropertyNode =
1413            DBuilder.createObjCProperty(PD->getName(),
1414                                        PUnit, PLine,
1415                                        (Getter && Getter->isImplicit()) ? "" :
1416                                        getSelectorName(PD->getGetterName()),
1417                                        (Setter && Setter->isImplicit()) ? "" :
1418                                        getSelectorName(PD->getSetterName()),
1419                                        PD->getPropertyAttributes(),
1420                                        getOrCreateType(PD->getType(), PUnit));
1421        }
1422      }
1423    }
1424    FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1425                                      FieldLine, FieldSize, FieldAlign,
1426                                      FieldOffset, Flags, FieldTy,
1427                                      PropertyNode);
1428    EltTys.push_back(FieldTy);
1429  }
1430
1431  llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
1432  FwdDeclNode->replaceOperandWith(10, Elements);
1433
1434  LexicalBlockStack.pop_back();
1435  return llvm::DIType(FwdDeclNode);
1436}
1437
1438llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1439  llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1440  int64_t NumElems = Ty->getNumElements();
1441  int64_t LowerBound = 0;
1442  if (NumElems == 0)
1443    // If number of elements are not known then this is an unbounded array.
1444    // Use Low = 1, Hi = 0 to express such arrays.
1445    LowerBound = 1;
1446  else
1447    --NumElems;
1448
1449  llvm::Value *Subscript = DBuilder.getOrCreateSubrange(LowerBound, NumElems);
1450  llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1451
1452  uint64_t Size = CGM.getContext().getTypeSize(Ty);
1453  uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1454
1455  return
1456    DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1457}
1458
1459llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1460                                     llvm::DIFile Unit) {
1461  uint64_t Size;
1462  uint64_t Align;
1463
1464  // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1465  if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1466    Size = 0;
1467    Align =
1468      CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1469  } else if (Ty->isIncompleteArrayType()) {
1470    Size = 0;
1471    Align = CGM.getContext().getTypeAlign(Ty->getElementType());
1472  } else if (Ty->isDependentSizedArrayType() || Ty->isIncompleteType()) {
1473    Size = 0;
1474    Align = 0;
1475  } else {
1476    // Size and align of the whole array, not the element type.
1477    Size = CGM.getContext().getTypeSize(Ty);
1478    Align = CGM.getContext().getTypeAlign(Ty);
1479  }
1480
1481  // Add the dimensions of the array.  FIXME: This loses CV qualifiers from
1482  // interior arrays, do we care?  Why aren't nested arrays represented the
1483  // obvious/recursive way?
1484  SmallVector<llvm::Value *, 8> Subscripts;
1485  QualType EltTy(Ty, 0);
1486  while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1487    int64_t UpperBound = 0;
1488    int64_t LowerBound = 0;
1489    if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty)) {
1490      if (CAT->getSize().getZExtValue())
1491        UpperBound = CAT->getSize().getZExtValue() - 1;
1492    } else
1493      // This is an unbounded array. Use Low = 1, Hi = 0 to express such
1494      // arrays.
1495      LowerBound = 1;
1496
1497    // FIXME: Verify this is right for VLAs.
1498    Subscripts.push_back(DBuilder.getOrCreateSubrange(LowerBound,
1499                                                      UpperBound));
1500    EltTy = Ty->getElementType();
1501  }
1502
1503  llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1504
1505  llvm::DIType DbgTy =
1506    DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1507                             SubscriptArray);
1508  return DbgTy;
1509}
1510
1511llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
1512                                     llvm::DIFile Unit) {
1513  return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
1514                               Ty, Ty->getPointeeType(), Unit);
1515}
1516
1517llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
1518                                     llvm::DIFile Unit) {
1519  return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
1520                               Ty, Ty->getPointeeType(), Unit);
1521}
1522
1523llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
1524                                     llvm::DIFile U) {
1525  QualType PointerDiffTy = CGM.getContext().getPointerDiffType();
1526  llvm::DIType PointerDiffDITy = getOrCreateType(PointerDiffTy, U);
1527
1528  if (!Ty->getPointeeType()->isFunctionType()) {
1529    // We have a data member pointer type.
1530    return PointerDiffDITy;
1531  }
1532
1533  // We have a member function pointer type. Treat it as a struct with two
1534  // ptrdiff_t members.
1535  std::pair<uint64_t, unsigned> Info = CGM.getContext().getTypeInfo(Ty);
1536
1537  uint64_t FieldOffset = 0;
1538  llvm::Value *ElementTypes[2];
1539
1540  // FIXME: This should be a DW_TAG_pointer_to_member type.
1541  ElementTypes[0] =
1542    DBuilder.createMemberType(U, "ptr", U, 0,
1543                              Info.first, Info.second, FieldOffset, 0,
1544                              PointerDiffDITy);
1545  FieldOffset += Info.first;
1546
1547  ElementTypes[1] =
1548    DBuilder.createMemberType(U, "ptr", U, 0,
1549                              Info.first, Info.second, FieldOffset, 0,
1550                              PointerDiffDITy);
1551
1552  llvm::DIArray Elements = DBuilder.getOrCreateArray(ElementTypes);
1553
1554  return DBuilder.createStructType(U, StringRef("test"),
1555                                   U, 0, FieldOffset,
1556                                   0, 0, Elements);
1557}
1558
1559llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
1560                                     llvm::DIFile U) {
1561  // Ignore the atomic wrapping
1562  // FIXME: What is the correct representation?
1563  return getOrCreateType(Ty->getValueType(), U);
1564}
1565
1566/// CreateEnumType - get enumeration type.
1567llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
1568  SmallVector<llvm::Value *, 16> Enumerators;
1569
1570  // Create DIEnumerator elements for each enumerator.
1571  for (EnumDecl::enumerator_iterator
1572         Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1573       Enum != EnumEnd; ++Enum) {
1574    Enumerators.push_back(
1575      DBuilder.createEnumerator(Enum->getName(),
1576                                Enum->getInitVal().getZExtValue()));
1577  }
1578
1579  // Return a CompositeType for the enum itself.
1580  llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1581
1582  llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1583  unsigned Line = getLineNumber(ED->getLocation());
1584  uint64_t Size = 0;
1585  uint64_t Align = 0;
1586  if (!ED->getTypeForDecl()->isIncompleteType()) {
1587    Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1588    Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1589  }
1590  llvm::DIDescriptor EnumContext =
1591    getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1592  llvm::DIType ClassTy = ED->isScopedUsingClassTag() ?
1593    getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
1594  unsigned Flags = !ED->isCompleteDefinition() ? llvm::DIDescriptor::FlagFwdDecl : 0;
1595  llvm::DIType DbgTy =
1596    DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1597                                   Size, Align, EltArray,
1598                                   ClassTy, Flags);
1599  return DbgTy;
1600}
1601
1602static QualType UnwrapTypeForDebugInfo(QualType T) {
1603  do {
1604    QualType LastT = T;
1605    switch (T->getTypeClass()) {
1606    default:
1607      return T;
1608    case Type::TemplateSpecialization:
1609      T = cast<TemplateSpecializationType>(T)->desugar();
1610      break;
1611    case Type::TypeOfExpr:
1612      T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1613      break;
1614    case Type::TypeOf:
1615      T = cast<TypeOfType>(T)->getUnderlyingType();
1616      break;
1617    case Type::Decltype:
1618      T = cast<DecltypeType>(T)->getUnderlyingType();
1619      break;
1620    case Type::UnaryTransform:
1621      T = cast<UnaryTransformType>(T)->getUnderlyingType();
1622      break;
1623    case Type::Attributed:
1624      T = cast<AttributedType>(T)->getEquivalentType();
1625      break;
1626    case Type::Elaborated:
1627      T = cast<ElaboratedType>(T)->getNamedType();
1628      break;
1629    case Type::Paren:
1630      T = cast<ParenType>(T)->getInnerType();
1631      break;
1632    case Type::SubstTemplateTypeParm:
1633      T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
1634      break;
1635    case Type::Auto:
1636      T = cast<AutoType>(T)->getDeducedType();
1637      break;
1638    }
1639
1640    assert(T != LastT && "Type unwrapping failed to unwrap!");
1641    if (T == LastT)
1642      return T;
1643  } while (true);
1644}
1645
1646/// getType - Get the type from the cache or return null type if it doesn't exist.
1647llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
1648
1649  // Unwrap the type as needed for debug information.
1650  Ty = UnwrapTypeForDebugInfo(Ty);
1651
1652  // Check for existing entry.
1653  llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1654    TypeCache.find(Ty.getAsOpaquePtr());
1655  if (it != TypeCache.end()) {
1656    // Verify that the debug info still exists.
1657    if (&*it->second)
1658      return llvm::DIType(cast<llvm::MDNode>(it->second));
1659  }
1660
1661  return llvm::DIType();
1662}
1663
1664/// getCompletedTypeOrNull - Get the type from the cache or return null if it
1665/// doesn't exist.
1666llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
1667
1668  // Unwrap the type as needed for debug information.
1669  Ty = UnwrapTypeForDebugInfo(Ty);
1670
1671  // Check for existing entry.
1672  llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1673    CompletedTypeCache.find(Ty.getAsOpaquePtr());
1674  if (it != CompletedTypeCache.end()) {
1675    // Verify that the debug info still exists.
1676    if (&*it->second)
1677      return llvm::DIType(cast<llvm::MDNode>(it->second));
1678  }
1679
1680  return llvm::DIType();
1681}
1682
1683
1684/// getOrCreateType - Get the type from the cache or create a new
1685/// one if necessary.
1686llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
1687  if (Ty.isNull())
1688    return llvm::DIType();
1689
1690  // Unwrap the type as needed for debug information.
1691  Ty = UnwrapTypeForDebugInfo(Ty);
1692
1693  llvm::DIType T = getCompletedTypeOrNull(Ty);
1694
1695  if (T.Verify()) return T;
1696
1697  // Otherwise create the type.
1698  llvm::DIType Res = CreateTypeNode(Ty, Unit);
1699
1700  llvm::DIType TC = getTypeOrNull(Ty);
1701  if (TC.Verify() && TC.isForwardDecl())
1702    ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(),
1703                                        static_cast<llvm::Value*>(TC)));
1704
1705  // And update the type cache.
1706  TypeCache[Ty.getAsOpaquePtr()] = Res;
1707
1708  if (!Res.isForwardDecl())
1709    CompletedTypeCache[Ty.getAsOpaquePtr()] = Res;
1710  return Res;
1711}
1712
1713/// CreateTypeNode - Create a new debug type node.
1714llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
1715  // Handle qualifiers, which recursively handles what they refer to.
1716  if (Ty.hasLocalQualifiers())
1717    return CreateQualifiedType(Ty, Unit);
1718
1719  const char *Diag = 0;
1720
1721  // Work out details of type.
1722  switch (Ty->getTypeClass()) {
1723#define TYPE(Class, Base)
1724#define ABSTRACT_TYPE(Class, Base)
1725#define NON_CANONICAL_TYPE(Class, Base)
1726#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1727#include "clang/AST/TypeNodes.def"
1728    llvm_unreachable("Dependent types cannot show up in debug information");
1729
1730  case Type::ExtVector:
1731  case Type::Vector:
1732    return CreateType(cast<VectorType>(Ty), Unit);
1733  case Type::ObjCObjectPointer:
1734    return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
1735  case Type::ObjCObject:
1736    return CreateType(cast<ObjCObjectType>(Ty), Unit);
1737  case Type::ObjCInterface:
1738    return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
1739  case Type::Builtin:
1740    return CreateType(cast<BuiltinType>(Ty));
1741  case Type::Complex:
1742    return CreateType(cast<ComplexType>(Ty));
1743  case Type::Pointer:
1744    return CreateType(cast<PointerType>(Ty), Unit);
1745  case Type::BlockPointer:
1746    return CreateType(cast<BlockPointerType>(Ty), Unit);
1747  case Type::Typedef:
1748    return CreateType(cast<TypedefType>(Ty), Unit);
1749  case Type::Record:
1750    return CreateType(cast<RecordType>(Ty));
1751  case Type::Enum:
1752    return CreateEnumType(cast<EnumType>(Ty)->getDecl());
1753  case Type::FunctionProto:
1754  case Type::FunctionNoProto:
1755    return CreateType(cast<FunctionType>(Ty), Unit);
1756  case Type::ConstantArray:
1757  case Type::VariableArray:
1758  case Type::IncompleteArray:
1759    return CreateType(cast<ArrayType>(Ty), Unit);
1760
1761  case Type::LValueReference:
1762    return CreateType(cast<LValueReferenceType>(Ty), Unit);
1763  case Type::RValueReference:
1764    return CreateType(cast<RValueReferenceType>(Ty), Unit);
1765
1766  case Type::MemberPointer:
1767    return CreateType(cast<MemberPointerType>(Ty), Unit);
1768
1769  case Type::Atomic:
1770    return CreateType(cast<AtomicType>(Ty), Unit);
1771
1772  case Type::Attributed:
1773  case Type::TemplateSpecialization:
1774  case Type::Elaborated:
1775  case Type::Paren:
1776  case Type::SubstTemplateTypeParm:
1777  case Type::TypeOfExpr:
1778  case Type::TypeOf:
1779  case Type::Decltype:
1780  case Type::UnaryTransform:
1781  case Type::Auto:
1782    llvm_unreachable("type should have been unwrapped!");
1783  }
1784
1785  assert(Diag && "Fall through without a diagnostic?");
1786  unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
1787                               "debug information for %0 is not yet supported");
1788  CGM.getDiags().Report(DiagID)
1789    << Diag;
1790  return llvm::DIType();
1791}
1792
1793/// getOrCreateLimitedType - Get the type from the cache or create a new
1794/// limited type if necessary.
1795llvm::DIType CGDebugInfo::getOrCreateLimitedType(QualType Ty,
1796						 llvm::DIFile Unit) {
1797  if (Ty.isNull())
1798    return llvm::DIType();
1799
1800  // Unwrap the type as needed for debug information.
1801  Ty = UnwrapTypeForDebugInfo(Ty);
1802
1803  llvm::DIType T = getTypeOrNull(Ty);
1804
1805  // We may have cached a forward decl when we could have created
1806  // a non-forward decl. Go ahead and create a non-forward decl
1807  // now.
1808  if (T.Verify() && !T.isForwardDecl()) return T;
1809
1810  // Otherwise create the type.
1811  llvm::DIType Res = CreateLimitedTypeNode(Ty, Unit);
1812
1813  if (T.Verify() && T.isForwardDecl())
1814    ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(),
1815                                        static_cast<llvm::Value*>(T)));
1816
1817  // And update the type cache.
1818  TypeCache[Ty.getAsOpaquePtr()] = Res;
1819  return Res;
1820}
1821
1822// TODO: Currently used for context chains when limiting debug info.
1823llvm::DIType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
1824  RecordDecl *RD = Ty->getDecl();
1825
1826  // Get overall information about the record type for the debug info.
1827  llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1828  unsigned Line = getLineNumber(RD->getLocation());
1829  StringRef RDName = RD->getName();
1830
1831  llvm::DIDescriptor RDContext;
1832  if (CGM.getCodeGenOpts().DebugInfo == CodeGenOptions::LimitedDebugInfo)
1833    RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
1834  else
1835    RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
1836
1837  // If this is just a forward declaration, construct an appropriately
1838  // marked node and just return it.
1839  if (!RD->getDefinition())
1840    return createRecordFwdDecl(RD, RDContext);
1841
1842  uint64_t Size = CGM.getContext().getTypeSize(Ty);
1843  uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1844  const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1845  llvm::TrackingVH<llvm::MDNode> RealDecl;
1846
1847  if (RD->isUnion())
1848    RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
1849					Size, Align, 0, llvm::DIArray());
1850  else if (CXXDecl) {
1851    RDName = getClassName(RD);
1852
1853    // FIXME: This could be a struct type giving a default visibility different
1854    // than C++ class type, but needs llvm metadata changes first.
1855    RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
1856					Size, Align, 0, 0, llvm::DIType(),
1857					llvm::DIArray(), llvm::DIType(),
1858					llvm::DIArray());
1859  } else
1860    RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
1861					 Size, Align, 0, llvm::DIArray());
1862
1863  RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1864  TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = llvm::DIType(RealDecl);
1865
1866  if (CXXDecl) {
1867    // A class's primary base or the class itself contains the vtable.
1868    llvm::MDNode *ContainingType = NULL;
1869    const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1870    if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
1871      // Seek non virtual primary base root.
1872      while (1) {
1873	const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
1874	const CXXRecordDecl *PBT = BRL.getPrimaryBase();
1875	if (PBT && !BRL.isPrimaryBaseVirtual())
1876	  PBase = PBT;
1877	else
1878	  break;
1879      }
1880      ContainingType =
1881	getOrCreateType(QualType(PBase->getTypeForDecl(), 0), DefUnit);
1882    }
1883    else if (CXXDecl->isDynamicClass())
1884      ContainingType = RealDecl;
1885
1886    RealDecl->replaceOperandWith(12, ContainingType);
1887  }
1888  return llvm::DIType(RealDecl);
1889}
1890
1891/// CreateLimitedTypeNode - Create a new debug type node, but only forward
1892/// declare composite types that haven't been processed yet.
1893llvm::DIType CGDebugInfo::CreateLimitedTypeNode(QualType Ty,llvm::DIFile Unit) {
1894
1895  // Work out details of type.
1896  switch (Ty->getTypeClass()) {
1897#define TYPE(Class, Base)
1898#define ABSTRACT_TYPE(Class, Base)
1899#define NON_CANONICAL_TYPE(Class, Base)
1900#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1901        #include "clang/AST/TypeNodes.def"
1902    llvm_unreachable("Dependent types cannot show up in debug information");
1903
1904  case Type::Record:
1905    return CreateLimitedType(cast<RecordType>(Ty));
1906  default:
1907    return CreateTypeNode(Ty, Unit);
1908  }
1909}
1910
1911/// CreateMemberType - Create new member and increase Offset by FType's size.
1912llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
1913                                           StringRef Name,
1914                                           uint64_t *Offset) {
1915  llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
1916  uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
1917  unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
1918  llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
1919                                              FieldSize, FieldAlign,
1920                                              *Offset, 0, FieldTy);
1921  *Offset += FieldSize;
1922  return Ty;
1923}
1924
1925/// getFunctionDeclaration - Return debug info descriptor to describe method
1926/// declaration for the given method definition.
1927llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
1928  const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
1929  if (!FD) return llvm::DISubprogram();
1930
1931  // Setup context.
1932  getContextDescriptor(cast<Decl>(D->getDeclContext()));
1933
1934  llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
1935    MI = SPCache.find(FD->getCanonicalDecl());
1936  if (MI != SPCache.end()) {
1937    llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1938    if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1939      return SP;
1940  }
1941
1942  for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
1943         E = FD->redecls_end(); I != E; ++I) {
1944    const FunctionDecl *NextFD = *I;
1945    llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
1946      MI = SPCache.find(NextFD->getCanonicalDecl());
1947    if (MI != SPCache.end()) {
1948      llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1949      if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1950        return SP;
1951    }
1952  }
1953  return llvm::DISubprogram();
1954}
1955
1956// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
1957// implicit parameter "this".
1958llvm::DIType CGDebugInfo::getOrCreateFunctionType(const Decl * D,
1959                                                  QualType FnType,
1960                                                  llvm::DIFile F) {
1961  if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
1962    return getOrCreateMethodType(Method, F);
1963  if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
1964    // Add "self" and "_cmd"
1965    SmallVector<llvm::Value *, 16> Elts;
1966
1967    // First element is always return type. For 'void' functions it is NULL.
1968    Elts.push_back(getOrCreateType(OMethod->getResultType(), F));
1969    // "self" pointer is always first argument.
1970    Elts.push_back(getOrCreateType(OMethod->getSelfDecl()->getType(), F));
1971    // "cmd" pointer is always second argument.
1972    Elts.push_back(getOrCreateType(OMethod->getCmdDecl()->getType(), F));
1973    // Get rest of the arguments.
1974    for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
1975           PE = OMethod->param_end(); PI != PE; ++PI)
1976      Elts.push_back(getOrCreateType((*PI)->getType(), F));
1977
1978    llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1979    return DBuilder.createSubroutineType(F, EltTypeArray);
1980  }
1981  return getOrCreateType(FnType, F);
1982}
1983
1984/// EmitFunctionStart - Constructs the debug code for entering a function.
1985void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
1986                                    llvm::Function *Fn,
1987                                    CGBuilderTy &Builder) {
1988
1989  StringRef Name;
1990  StringRef LinkageName;
1991
1992  FnBeginRegionCount.push_back(LexicalBlockStack.size());
1993
1994  const Decl *D = GD.getDecl();
1995  // Use the location of the declaration.
1996  SourceLocation Loc = D->getLocation();
1997
1998  unsigned Flags = 0;
1999  llvm::DIFile Unit = getOrCreateFile(Loc);
2000  llvm::DIDescriptor FDContext(Unit);
2001  llvm::DIArray TParamsArray;
2002  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2003    // If there is a DISubprogram for this function available then use it.
2004    llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2005      FI = SPCache.find(FD->getCanonicalDecl());
2006    if (FI != SPCache.end()) {
2007      llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(&*FI->second));
2008      if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2009        llvm::MDNode *SPN = SP;
2010        LexicalBlockStack.push_back(SPN);
2011        RegionMap[D] = llvm::WeakVH(SP);
2012        return;
2013      }
2014    }
2015    Name = getFunctionName(FD);
2016    // Use mangled name as linkage name for c/c++ functions.
2017    if (FD->hasPrototype()) {
2018      LinkageName = CGM.getMangledName(GD);
2019      Flags |= llvm::DIDescriptor::FlagPrototyped;
2020    }
2021    if (LinkageName == Name ||
2022        CGM.getCodeGenOpts().DebugInfo <= CodeGenOptions::DebugLineTablesOnly)
2023      LinkageName = StringRef();
2024
2025    if (CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo) {
2026      if (const NamespaceDecl *NSDecl =
2027          dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2028        FDContext = getOrCreateNameSpace(NSDecl);
2029      else if (const RecordDecl *RDecl =
2030               dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2031        FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
2032
2033      // Collect template parameters.
2034      TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2035    }
2036  } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2037    Name = getObjCMethodName(OMD);
2038    Flags |= llvm::DIDescriptor::FlagPrototyped;
2039  } else {
2040    // Use llvm function name.
2041    Name = Fn->getName();
2042    Flags |= llvm::DIDescriptor::FlagPrototyped;
2043  }
2044  if (!Name.empty() && Name[0] == '\01')
2045    Name = Name.substr(1);
2046
2047  unsigned LineNo = getLineNumber(Loc);
2048  if (D->isImplicit())
2049    Flags |= llvm::DIDescriptor::FlagArtificial;
2050
2051  llvm::DIType DIFnType;
2052  llvm::DISubprogram SPDecl;
2053  if (CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo) {
2054    DIFnType = getOrCreateFunctionType(D, FnType, Unit);
2055    SPDecl = getFunctionDeclaration(D);
2056  } else {
2057    // Create fake but valid subroutine type. Otherwise
2058    // llvm::DISubprogram::Verify() would return false, and
2059    // subprogram DIE will miss DW_AT_decl_file and
2060    // DW_AT_decl_line fields.
2061    SmallVector<llvm::Value*, 16> Elts;
2062    llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2063    DIFnType = DBuilder.createSubroutineType(Unit, EltTypeArray);
2064  }
2065  llvm::DISubprogram SP;
2066  SP = DBuilder.createFunction(FDContext, Name, LinkageName, Unit,
2067                               LineNo, DIFnType,
2068                               Fn->hasInternalLinkage(), true/*definition*/,
2069                               getLineNumber(CurLoc), Flags,
2070                               CGM.getLangOpts().Optimize,
2071                               Fn, TParamsArray, SPDecl);
2072
2073  // Push function on region stack.
2074  llvm::MDNode *SPN = SP;
2075  LexicalBlockStack.push_back(SPN);
2076  RegionMap[D] = llvm::WeakVH(SP);
2077}
2078
2079/// EmitLocation - Emit metadata to indicate a change in line/column
2080/// information in the source file.
2081void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
2082
2083  // Update our current location
2084  setLocation(Loc);
2085
2086  if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2087
2088  // Don't bother if things are the same as last time.
2089  SourceManager &SM = CGM.getContext().getSourceManager();
2090  if (CurLoc == PrevLoc ||
2091      SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2092    // New Builder may not be in sync with CGDebugInfo.
2093    if (!Builder.getCurrentDebugLocation().isUnknown())
2094      return;
2095
2096  // Update last state.
2097  PrevLoc = CurLoc;
2098
2099  llvm::MDNode *Scope = LexicalBlockStack.back();
2100  Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(CurLoc),
2101                                                      getColumnNumber(CurLoc),
2102                                                      Scope));
2103}
2104
2105/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2106/// the stack.
2107void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2108  llvm::DIDescriptor D =
2109    DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2110                                llvm::DIDescriptor() :
2111                                llvm::DIDescriptor(LexicalBlockStack.back()),
2112                                getOrCreateFile(CurLoc),
2113                                getLineNumber(CurLoc),
2114                                getColumnNumber(CurLoc));
2115  llvm::MDNode *DN = D;
2116  LexicalBlockStack.push_back(DN);
2117}
2118
2119/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2120/// region - beginning of a DW_TAG_lexical_block.
2121void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc) {
2122  // Set our current location.
2123  setLocation(Loc);
2124
2125  // Create a new lexical block and push it on the stack.
2126  CreateLexicalBlock(Loc);
2127
2128  // Emit a line table change for the current location inside the new scope.
2129  Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2130                                  getColumnNumber(Loc),
2131                                  LexicalBlockStack.back()));
2132}
2133
2134/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2135/// region - end of a DW_TAG_lexical_block.
2136void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc) {
2137  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2138
2139  // Provide an entry in the line table for the end of the block.
2140  EmitLocation(Builder, Loc);
2141
2142  LexicalBlockStack.pop_back();
2143}
2144
2145/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2146void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2147  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2148  unsigned RCount = FnBeginRegionCount.back();
2149  assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2150
2151  // Pop all regions for this function.
2152  while (LexicalBlockStack.size() != RCount)
2153    EmitLexicalBlockEnd(Builder, CurLoc);
2154  FnBeginRegionCount.pop_back();
2155}
2156
2157// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
2158// See BuildByRefType.
2159llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const ValueDecl *VD,
2160                                                       uint64_t *XOffset) {
2161
2162  SmallVector<llvm::Value *, 5> EltTys;
2163  QualType FType;
2164  uint64_t FieldSize, FieldOffset;
2165  unsigned FieldAlign;
2166
2167  llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2168  QualType Type = VD->getType();
2169
2170  FieldOffset = 0;
2171  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2172  EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2173  EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2174  FType = CGM.getContext().IntTy;
2175  EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2176  EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2177
2178  bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type);
2179  if (HasCopyAndDispose) {
2180    FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2181    EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2182                                      &FieldOffset));
2183    EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2184                                      &FieldOffset));
2185  }
2186
2187  CharUnits Align = CGM.getContext().getDeclAlign(VD);
2188  if (Align > CGM.getContext().toCharUnitsFromBits(
2189        CGM.getContext().getTargetInfo().getPointerAlign(0))) {
2190    CharUnits FieldOffsetInBytes
2191      = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2192    CharUnits AlignedOffsetInBytes
2193      = FieldOffsetInBytes.RoundUpToAlignment(Align);
2194    CharUnits NumPaddingBytes
2195      = AlignedOffsetInBytes - FieldOffsetInBytes;
2196
2197    if (NumPaddingBytes.isPositive()) {
2198      llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2199      FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2200                                                    pad, ArrayType::Normal, 0);
2201      EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2202    }
2203  }
2204
2205  FType = Type;
2206  llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2207  FieldSize = CGM.getContext().getTypeSize(FType);
2208  FieldAlign = CGM.getContext().toBits(Align);
2209
2210  *XOffset = FieldOffset;
2211  FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2212                                      0, FieldSize, FieldAlign,
2213                                      FieldOffset, 0, FieldTy);
2214  EltTys.push_back(FieldTy);
2215  FieldOffset += FieldSize;
2216
2217  llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
2218
2219  unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
2220
2221  return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
2222                                   Elements);
2223}
2224
2225/// EmitDeclare - Emit local variable declaration debug info.
2226void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
2227                              llvm::Value *Storage,
2228                              unsigned ArgNo, CGBuilderTy &Builder) {
2229  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2230  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2231
2232  llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2233  llvm::DIType Ty;
2234  uint64_t XOffset = 0;
2235  if (VD->hasAttr<BlocksAttr>())
2236    Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2237  else
2238    Ty = getOrCreateType(VD->getType(), Unit);
2239
2240  // If there is not any debug info for type then do not emit debug info
2241  // for this variable.
2242  if (!Ty)
2243    return;
2244
2245  if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage)) {
2246    // If Storage is an aggregate returned as 'sret' then let debugger know
2247    // about this.
2248    if (Arg->hasStructRetAttr())
2249      Ty = DBuilder.createReferenceType(llvm::dwarf::DW_TAG_reference_type, Ty);
2250    else if (CXXRecordDecl *Record = VD->getType()->getAsCXXRecordDecl()) {
2251      // If an aggregate variable has non trivial destructor or non trivial copy
2252      // constructor than it is pass indirectly. Let debug info know about this
2253      // by using reference of the aggregate type as a argument type.
2254      if (!Record->hasTrivialCopyConstructor() ||
2255          !Record->hasTrivialDestructor())
2256        Ty = DBuilder.createReferenceType(llvm::dwarf::DW_TAG_reference_type, Ty);
2257    }
2258  }
2259
2260  // Get location information.
2261  unsigned Line = getLineNumber(VD->getLocation());
2262  unsigned Column = getColumnNumber(VD->getLocation());
2263  unsigned Flags = 0;
2264  if (VD->isImplicit())
2265    Flags |= llvm::DIDescriptor::FlagArtificial;
2266  llvm::MDNode *Scope = LexicalBlockStack.back();
2267
2268  StringRef Name = VD->getName();
2269  if (!Name.empty()) {
2270    if (VD->hasAttr<BlocksAttr>()) {
2271      CharUnits offset = CharUnits::fromQuantity(32);
2272      SmallVector<llvm::Value *, 9> addr;
2273      llvm::Type *Int64Ty = CGM.Int64Ty;
2274      addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2275      // offset of __forwarding field
2276      offset = CGM.getContext().toCharUnitsFromBits(
2277        CGM.getContext().getTargetInfo().getPointerWidth(0));
2278      addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2279      addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2280      addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2281      // offset of x field
2282      offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2283      addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2284
2285      // Create the descriptor for the variable.
2286      llvm::DIVariable D =
2287        DBuilder.createComplexVariable(Tag,
2288                                       llvm::DIDescriptor(Scope),
2289                                       VD->getName(), Unit, Line, Ty,
2290                                       addr, ArgNo);
2291
2292      // Insert an llvm.dbg.declare into the current block.
2293      llvm::Instruction *Call =
2294        DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2295      Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2296      return;
2297    } else if (isa<VariableArrayType>(VD->getType())) {
2298      // These are "complex" variables in that they need an op_deref.
2299      // Create the descriptor for the variable.
2300      llvm::Value *Addr = llvm::ConstantInt::get(CGM.Int64Ty,
2301                                                 llvm::DIBuilder::OpDeref);
2302      llvm::DIVariable D =
2303        DBuilder.createComplexVariable(Tag,
2304                                       llvm::DIDescriptor(Scope),
2305                                       Name, Unit, Line, Ty,
2306                                       Addr, ArgNo);
2307
2308      // Insert an llvm.dbg.declare into the current block.
2309      llvm::Instruction *Call =
2310        DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2311      Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2312      return;
2313    }
2314
2315    // Create the descriptor for the variable.
2316    llvm::DIVariable D =
2317      DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2318                                   Name, Unit, Line, Ty,
2319                                   CGM.getLangOpts().Optimize, Flags, ArgNo);
2320
2321    // Insert an llvm.dbg.declare into the current block.
2322    llvm::Instruction *Call =
2323      DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2324    Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2325    return;
2326  }
2327
2328  // If VD is an anonymous union then Storage represents value for
2329  // all union fields.
2330  if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2331    const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2332    if (RD->isUnion()) {
2333      for (RecordDecl::field_iterator I = RD->field_begin(),
2334             E = RD->field_end();
2335           I != E; ++I) {
2336        FieldDecl *Field = *I;
2337        llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2338        StringRef FieldName = Field->getName();
2339
2340        // Ignore unnamed fields. Do not ignore unnamed records.
2341        if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2342          continue;
2343
2344        // Use VarDecl's Tag, Scope and Line number.
2345        llvm::DIVariable D =
2346          DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2347                                       FieldName, Unit, Line, FieldTy,
2348                                       CGM.getLangOpts().Optimize, Flags,
2349                                       ArgNo);
2350
2351        // Insert an llvm.dbg.declare into the current block.
2352        llvm::Instruction *Call =
2353          DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2354        Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2355      }
2356    }
2357  }
2358}
2359
2360void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2361                                            llvm::Value *Storage,
2362                                            CGBuilderTy &Builder) {
2363  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2364  EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2365}
2366
2367void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
2368  const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
2369  const CGBlockInfo &blockInfo) {
2370  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2371  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2372
2373  if (Builder.GetInsertBlock() == 0)
2374    return;
2375
2376  bool isByRef = VD->hasAttr<BlocksAttr>();
2377
2378  uint64_t XOffset = 0;
2379  llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2380  llvm::DIType Ty;
2381  if (isByRef)
2382    Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2383  else
2384    Ty = getOrCreateType(VD->getType(), Unit);
2385
2386  // Get location information.
2387  unsigned Line = getLineNumber(VD->getLocation());
2388  unsigned Column = getColumnNumber(VD->getLocation());
2389
2390  const llvm::TargetData &target = CGM.getTargetData();
2391
2392  CharUnits offset = CharUnits::fromQuantity(
2393    target.getStructLayout(blockInfo.StructureType)
2394          ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2395
2396  SmallVector<llvm::Value *, 9> addr;
2397  llvm::Type *Int64Ty = CGM.Int64Ty;
2398  addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2399  addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2400  if (isByRef) {
2401    addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2402    addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2403    // offset of __forwarding field
2404    offset = CGM.getContext()
2405                .toCharUnitsFromBits(target.getPointerSizeInBits());
2406    addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2407    addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2408    addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2409    // offset of x field
2410    offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2411    addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2412  }
2413
2414  // Create the descriptor for the variable.
2415  llvm::DIVariable D =
2416    DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
2417                                   llvm::DIDescriptor(LexicalBlockStack.back()),
2418                                   VD->getName(), Unit, Line, Ty, addr);
2419  // Insert an llvm.dbg.declare into the current block.
2420  llvm::Instruction *Call =
2421    DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2422  Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2423                                        LexicalBlockStack.back()));
2424}
2425
2426/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2427/// variable declaration.
2428void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2429                                           unsigned ArgNo,
2430                                           CGBuilderTy &Builder) {
2431  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2432  EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2433}
2434
2435namespace {
2436  struct BlockLayoutChunk {
2437    uint64_t OffsetInBits;
2438    const BlockDecl::Capture *Capture;
2439  };
2440  bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2441    return l.OffsetInBits < r.OffsetInBits;
2442  }
2443}
2444
2445void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
2446                                                       llvm::Value *addr,
2447                                                       CGBuilderTy &Builder) {
2448  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2449  ASTContext &C = CGM.getContext();
2450  const BlockDecl *blockDecl = block.getBlockDecl();
2451
2452  // Collect some general information about the block's location.
2453  SourceLocation loc = blockDecl->getCaretLocation();
2454  llvm::DIFile tunit = getOrCreateFile(loc);
2455  unsigned line = getLineNumber(loc);
2456  unsigned column = getColumnNumber(loc);
2457
2458  // Build the debug-info type for the block literal.
2459  getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2460
2461  const llvm::StructLayout *blockLayout =
2462    CGM.getTargetData().getStructLayout(block.StructureType);
2463
2464  SmallVector<llvm::Value*, 16> fields;
2465  fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2466                                   blockLayout->getElementOffsetInBits(0),
2467                                   tunit, tunit));
2468  fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2469                                   blockLayout->getElementOffsetInBits(1),
2470                                   tunit, tunit));
2471  fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2472                                   blockLayout->getElementOffsetInBits(2),
2473                                   tunit, tunit));
2474  fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2475                                   blockLayout->getElementOffsetInBits(3),
2476                                   tunit, tunit));
2477  fields.push_back(createFieldType("__descriptor",
2478                                   C.getPointerType(block.NeedsCopyDispose ?
2479                                        C.getBlockDescriptorExtendedType() :
2480                                        C.getBlockDescriptorType()),
2481                                   0, loc, AS_public,
2482                                   blockLayout->getElementOffsetInBits(4),
2483                                   tunit, tunit));
2484
2485  // We want to sort the captures by offset, not because DWARF
2486  // requires this, but because we're paranoid about debuggers.
2487  SmallVector<BlockLayoutChunk, 8> chunks;
2488
2489  // 'this' capture.
2490  if (blockDecl->capturesCXXThis()) {
2491    BlockLayoutChunk chunk;
2492    chunk.OffsetInBits =
2493      blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2494    chunk.Capture = 0;
2495    chunks.push_back(chunk);
2496  }
2497
2498  // Variable captures.
2499  for (BlockDecl::capture_const_iterator
2500         i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2501       i != e; ++i) {
2502    const BlockDecl::Capture &capture = *i;
2503    const VarDecl *variable = capture.getVariable();
2504    const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2505
2506    // Ignore constant captures.
2507    if (captureInfo.isConstant())
2508      continue;
2509
2510    BlockLayoutChunk chunk;
2511    chunk.OffsetInBits =
2512      blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2513    chunk.Capture = &capture;
2514    chunks.push_back(chunk);
2515  }
2516
2517  // Sort by offset.
2518  llvm::array_pod_sort(chunks.begin(), chunks.end());
2519
2520  for (SmallVectorImpl<BlockLayoutChunk>::iterator
2521         i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2522    uint64_t offsetInBits = i->OffsetInBits;
2523    const BlockDecl::Capture *capture = i->Capture;
2524
2525    // If we have a null capture, this must be the C++ 'this' capture.
2526    if (!capture) {
2527      const CXXMethodDecl *method =
2528        cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2529      QualType type = method->getThisType(C);
2530
2531      fields.push_back(createFieldType("this", type, 0, loc, AS_public,
2532                                       offsetInBits, tunit, tunit));
2533      continue;
2534    }
2535
2536    const VarDecl *variable = capture->getVariable();
2537    StringRef name = variable->getName();
2538
2539    llvm::DIType fieldType;
2540    if (capture->isByRef()) {
2541      std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
2542
2543      // FIXME: this creates a second copy of this type!
2544      uint64_t xoffset;
2545      fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
2546      fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
2547      fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
2548                                            ptrInfo.first, ptrInfo.second,
2549                                            offsetInBits, 0, fieldType);
2550    } else {
2551      fieldType = createFieldType(name, variable->getType(), 0,
2552                                  loc, AS_public, offsetInBits, tunit, tunit);
2553    }
2554    fields.push_back(fieldType);
2555  }
2556
2557  SmallString<36> typeName;
2558  llvm::raw_svector_ostream(typeName)
2559    << "__block_literal_" << CGM.getUniqueBlockCount();
2560
2561  llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
2562
2563  llvm::DIType type =
2564    DBuilder.createStructType(tunit, typeName.str(), tunit, line,
2565                              CGM.getContext().toBits(block.BlockSize),
2566                              CGM.getContext().toBits(block.BlockAlign),
2567                              0, fieldsArray);
2568  type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
2569
2570  // Get overall information about the block.
2571  unsigned flags = llvm::DIDescriptor::FlagArtificial;
2572  llvm::MDNode *scope = LexicalBlockStack.back();
2573  StringRef name = ".block_descriptor";
2574
2575  // Create the descriptor for the parameter.
2576  llvm::DIVariable debugVar =
2577    DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
2578                                 llvm::DIDescriptor(scope),
2579                                 name, tunit, line, type,
2580                                 CGM.getLangOpts().Optimize, flags,
2581                                 cast<llvm::Argument>(addr)->getArgNo() + 1);
2582
2583  // Insert an llvm.dbg.value into the current block.
2584  llvm::Instruction *declare =
2585    DBuilder.insertDbgValueIntrinsic(addr, 0, debugVar,
2586                                     Builder.GetInsertBlock());
2587  declare->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
2588}
2589
2590/// EmitGlobalVariable - Emit information about a global variable.
2591void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2592                                     const VarDecl *D) {
2593  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2594  // Create global variable debug descriptor.
2595  llvm::DIFile Unit = getOrCreateFile(D->getLocation());
2596  unsigned LineNo = getLineNumber(D->getLocation());
2597
2598  setLocation(D->getLocation());
2599
2600  QualType T = D->getType();
2601  if (T->isIncompleteArrayType()) {
2602
2603    // CodeGen turns int[] into int[1] so we'll do the same here.
2604    llvm::APSInt ConstVal(32);
2605
2606    ConstVal = 1;
2607    QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2608
2609    T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2610                                              ArrayType::Normal, 0);
2611  }
2612  StringRef DeclName = D->getName();
2613  StringRef LinkageName;
2614  if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
2615      && !isa<ObjCMethodDecl>(D->getDeclContext()))
2616    LinkageName = Var->getName();
2617  if (LinkageName == DeclName)
2618    LinkageName = StringRef();
2619  llvm::DIDescriptor DContext =
2620    getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
2621  DBuilder.createStaticVariable(DContext, DeclName, LinkageName,
2622                                Unit, LineNo, getOrCreateType(T, Unit),
2623                                Var->hasInternalLinkage(), Var);
2624}
2625
2626/// EmitGlobalVariable - Emit information about an objective-c interface.
2627void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2628                                     ObjCInterfaceDecl *ID) {
2629  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2630  // Create global variable debug descriptor.
2631  llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
2632  unsigned LineNo = getLineNumber(ID->getLocation());
2633
2634  StringRef Name = ID->getName();
2635
2636  QualType T = CGM.getContext().getObjCInterfaceType(ID);
2637  if (T->isIncompleteArrayType()) {
2638
2639    // CodeGen turns int[] into int[1] so we'll do the same here.
2640    llvm::APSInt ConstVal(32);
2641
2642    ConstVal = 1;
2643    QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2644
2645    T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2646                                           ArrayType::Normal, 0);
2647  }
2648
2649  DBuilder.createGlobalVariable(Name, Unit, LineNo,
2650                                getOrCreateType(T, Unit),
2651                                Var->hasInternalLinkage(), Var);
2652}
2653
2654/// EmitGlobalVariable - Emit global variable's debug info.
2655void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
2656                                     llvm::Constant *Init) {
2657  assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
2658  // Create the descriptor for the variable.
2659  llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2660  StringRef Name = VD->getName();
2661  llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
2662  if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
2663    const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
2664    assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
2665    Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
2666  }
2667  // Do not use DIGlobalVariable for enums.
2668  if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
2669    return;
2670  DBuilder.createStaticVariable(Unit, Name, Name, Unit,
2671                                getLineNumber(VD->getLocation()),
2672                                Ty, true, Init);
2673}
2674
2675/// getOrCreateNamesSpace - Return namespace descriptor for the given
2676/// namespace decl.
2677llvm::DINameSpace
2678CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
2679  llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
2680    NameSpaceCache.find(NSDecl);
2681  if (I != NameSpaceCache.end())
2682    return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
2683
2684  unsigned LineNo = getLineNumber(NSDecl->getLocation());
2685  llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
2686  llvm::DIDescriptor Context =
2687    getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
2688  llvm::DINameSpace NS =
2689    DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
2690  NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
2691  return NS;
2692}
2693
2694void CGDebugInfo::finalize(void) {
2695  for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
2696         = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
2697    llvm::DIType Ty, RepTy;
2698    // Verify that the debug info still exists.
2699    if (&*VI->second)
2700      Ty = llvm::DIType(cast<llvm::MDNode>(VI->second));
2701
2702    llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2703      TypeCache.find(VI->first);
2704    if (it != TypeCache.end()) {
2705      // Verify that the debug info still exists.
2706      if (&*it->second)
2707        RepTy = llvm::DIType(cast<llvm::MDNode>(it->second));
2708    }
2709
2710    if (Ty.Verify() && Ty.isForwardDecl() && RepTy.Verify()) {
2711      Ty.replaceAllUsesWith(RepTy);
2712    }
2713  }
2714  DBuilder.finalize();
2715}
2716