1 //===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This coordinates the debug information generation while generating code.
12 //===----------------------------------------------------------------------===//
14 #include "CGDebugInfo.h"
15 #include "CodeGenFunction.h"
16 #include "CodeGenModule.h"
18 #include "clang/AST/ASTContext.h"
19 #include "clang/AST/DeclFriend.h"
20 #include "clang/AST/DeclObjC.h"
21 #include "clang/AST/DeclTemplate.h"
22 #include "clang/AST/Expr.h"
23 #include "clang/AST/RecordLayout.h"
24 #include "clang/Basic/SourceManager.h"
25 #include "clang/Basic/FileManager.h"
26 #include "clang/Basic/Version.h"
27 #include "clang/Frontend/CodeGenOptions.h"
28 #include "llvm/Constants.h"
29 #include "llvm/DerivedTypes.h"
30 #include "llvm/Instructions.h"
31 #include "llvm/Intrinsics.h"
32 #include "llvm/Module.h"
33 #include "llvm/ADT/StringExtras.h"
34 #include "llvm/ADT/SmallVector.h"
35 #include "llvm/Support/Dwarf.h"
36 #include "llvm/Support/FileSystem.h"
37 #include "llvm/Target/TargetData.h"
38 using namespace clang;
39 using namespace clang::CodeGen;
41 CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
42 : CGM(CGM), DBuilder(CGM.getModule()),
43 BlockLiteralGenericSet(false) {
47 CGDebugInfo::~CGDebugInfo() {
48 assert(LexicalBlockStack.empty() &&
49 "Region stack mismatch, stack not empty!");
52 void CGDebugInfo::setLocation(SourceLocation Loc) {
53 // If the new location isn't valid return.
54 if (!Loc.isValid()) return;
56 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
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;
63 SourceManager &SM = CGM.getContext().getSourceManager();
64 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
65 PresumedLoc PPLoc = SM.getPresumedLoc(PrevLoc);
67 if (PCLoc.isInvalid() || PPLoc.isInvalid() ||
68 !strcmp(PPLoc.getFilename(), PCLoc.getFilename()))
71 llvm::MDNode *LB = LexicalBlockStack.back();
72 llvm::DIScope Scope = llvm::DIScope(LB);
73 if (Scope.isLexicalBlockFile()) {
74 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(LB);
76 = DBuilder.createLexicalBlockFile(LBF.getScope(),
77 getOrCreateFile(CurLoc));
79 LexicalBlockStack.pop_back();
80 LexicalBlockStack.push_back(N);
81 } else if (Scope.isLexicalBlock()) {
83 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
85 LexicalBlockStack.pop_back();
86 LexicalBlockStack.push_back(N);
90 /// getContextDescriptor - Get context info for the decl.
91 llvm::DIDescriptor CGDebugInfo::getContextDescriptor(const Decl *Context) {
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));
101 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
102 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
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);
114 /// getFunctionName - Get function name for the given FunctionDecl. If the
115 /// name is constructred on demand (e.g. C++ destructor) then the name
116 /// is stored on the side.
117 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
118 assert (FD && "Invalid FunctionDecl!");
119 IdentifierInfo *FII = FD->getIdentifier();
120 FunctionTemplateSpecializationInfo *Info
121 = FD->getTemplateSpecializationInfo();
123 return FII->getName();
125 // Otherwise construct human readable name for debug info.
126 std::string NS = FD->getNameAsString();
128 // Add any template specialization args.
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,
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());
145 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
146 SmallString<256> MethodName;
147 llvm::raw_svector_ostream OS(MethodName);
148 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
149 const DeclContext *DC = OMD->getDeclContext();
150 if (const ObjCImplementationDecl *OID =
151 dyn_cast<const ObjCImplementationDecl>(DC)) {
152 OS << OID->getName();
153 } else if (const ObjCInterfaceDecl *OID =
154 dyn_cast<const ObjCInterfaceDecl>(DC)) {
155 OS << OID->getName();
156 } else if (const ObjCCategoryImplDecl *OCD =
157 dyn_cast<const ObjCCategoryImplDecl>(DC)){
158 OS << ((NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
159 OCD->getIdentifier()->getNameStart() << ')';
161 OS << ' ' << OMD->getSelector().getAsString() << ']';
163 char *StrPtr = DebugInfoNames.Allocate<char>(OS.tell());
164 memcpy(StrPtr, MethodName.begin(), OS.tell());
165 return StringRef(StrPtr, OS.tell());
168 /// getSelectorName - Return selector name. This is used for debugging
170 StringRef CGDebugInfo::getSelectorName(Selector S) {
171 const std::string &SName = S.getAsString();
172 char *StrPtr = DebugInfoNames.Allocate<char>(SName.size());
173 memcpy(StrPtr, SName.data(), SName.size());
174 return StringRef(StrPtr, SName.size());
177 /// getClassName - Get class name including template argument list.
179 CGDebugInfo::getClassName(const RecordDecl *RD) {
180 const ClassTemplateSpecializationDecl *Spec
181 = dyn_cast<ClassTemplateSpecializationDecl>(RD);
183 return RD->getName();
185 const TemplateArgument *Args;
187 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
188 const TemplateSpecializationType *TST =
189 cast<TemplateSpecializationType>(TAW->getType());
190 Args = TST->getArgs();
191 NumArgs = TST->getNumArgs();
193 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
194 Args = TemplateArgs.data();
195 NumArgs = TemplateArgs.size();
197 StringRef Name = RD->getIdentifier()->getName();
198 PrintingPolicy Policy(CGM.getLangOpts());
199 std::string TemplateArgList =
200 TemplateSpecializationType::PrintTemplateArgumentList(Args, NumArgs, Policy);
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);
210 /// getOrCreateFile - Get the file debug info descriptor for the input location.
211 llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
213 // If Location is not valid then use main input file.
214 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
216 SourceManager &SM = CGM.getContext().getSourceManager();
217 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
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());
223 // Cache the results.
224 const char *fname = PLoc.getFilename();
225 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
226 DIFileCache.find(fname);
228 if (it != DIFileCache.end()) {
229 // Verify that the information still exists.
231 return llvm::DIFile(cast<llvm::MDNode>(it->second));
234 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
236 DIFileCache[fname] = F;
240 /// getOrCreateMainFile - Get the file info for main compile unit.
241 llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
242 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
245 /// getLineNumber - Get line number for the location. If location is invalid
246 /// then use current location.
247 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
248 if (Loc.isInvalid() && CurLoc.isInvalid())
250 SourceManager &SM = CGM.getContext().getSourceManager();
251 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
252 return PLoc.isValid()? PLoc.getLine() : 0;
255 /// getColumnNumber - Get column number for the location. If location is
256 /// invalid then use current location.
257 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc) {
258 if (Loc.isInvalid() && CurLoc.isInvalid())
260 SourceManager &SM = CGM.getContext().getSourceManager();
261 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
262 return PLoc.isValid()? PLoc.getColumn() : 0;
265 StringRef CGDebugInfo::getCurrentDirname() {
266 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
267 return CGM.getCodeGenOpts().DebugCompilationDir;
269 if (!CWDName.empty())
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());
278 /// CreateCompileUnit - Create new compile unit.
279 void CGDebugInfo::CreateCompileUnit() {
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>";
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;
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());
304 const LangOptions &LO = CGM.getLangOpts();
307 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
309 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
310 } else if (LO.ObjC1) {
311 LangTag = llvm::dwarf::DW_LANG_ObjC;
313 LangTag = llvm::dwarf::DW_LANG_C99;
315 LangTag = llvm::dwarf::DW_LANG_C89;
318 std::string Producer = getClangFullVersion();
320 // Figure out which version of the ObjC runtime we have.
321 unsigned RuntimeVers = 0;
323 RuntimeVers = LO.ObjCNonFragileABI ? 2 : 1;
325 // Create new compile unit.
326 DBuilder.createCompileUnit(
327 LangTag, Filename, getCurrentDirname(),
329 LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers);
330 // FIXME - Eliminate TheCU.
331 TheCU = llvm::DICompileUnit(DBuilder.getCU());
334 /// CreateType - Get the Basic type from the cache or create a new
335 /// one if necessary.
336 llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
337 unsigned Encoding = 0;
338 const char *BTName = NULL;
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:
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", getOrCreateMainFile(),
355 case BuiltinType::ObjCId: {
356 // typedef struct objc_class *Class;
357 // typedef struct objc_object {
361 // TODO: Cache these two types to avoid duplicates.
363 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
364 "objc_class", getOrCreateMainFile(),
366 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
368 llvm::DIType ISATy = DBuilder.createPointerType(OCTy, Size);
370 SmallVector<llvm::Value *, 16> EltTys;
371 llvm::DIType FieldTy =
372 DBuilder.createMemberType(getOrCreateMainFile(), "isa",
373 getOrCreateMainFile(), 0, Size,
375 EltTys.push_back(FieldTy);
376 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
378 return DBuilder.createStructType(TheCU, "objc_object",
379 getOrCreateMainFile(),
380 0, 0, 0, 0, Elements);
382 case BuiltinType::ObjCSel: {
384 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
385 "objc_selector", getOrCreateMainFile(),
388 case BuiltinType::UChar:
389 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
390 case BuiltinType::Char_S:
391 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
392 case BuiltinType::Char16:
393 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
394 case BuiltinType::UShort:
395 case BuiltinType::UInt:
396 case BuiltinType::UInt128:
397 case BuiltinType::ULong:
398 case BuiltinType::WChar_U:
399 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
400 case BuiltinType::Short:
401 case BuiltinType::Int:
402 case BuiltinType::Int128:
403 case BuiltinType::Long:
404 case BuiltinType::WChar_S:
405 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
406 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
407 case BuiltinType::Half:
408 case BuiltinType::Float:
409 case BuiltinType::LongDouble:
410 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
413 switch (BT->getKind()) {
414 case BuiltinType::Long: BTName = "long int"; break;
415 case BuiltinType::LongLong: BTName = "long long int"; break;
416 case BuiltinType::ULong: BTName = "long unsigned int"; break;
417 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
419 BTName = BT->getName(CGM.getContext().getLangOpts());
422 // Bit size, align and offset of the type.
423 uint64_t Size = CGM.getContext().getTypeSize(BT);
424 uint64_t Align = CGM.getContext().getTypeAlign(BT);
426 DBuilder.createBasicType(BTName, Size, Align, Encoding);
430 llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
431 // Bit size, align and offset of the type.
432 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
433 if (Ty->isComplexIntegerType())
434 Encoding = llvm::dwarf::DW_ATE_lo_user;
436 uint64_t Size = CGM.getContext().getTypeSize(Ty);
437 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
439 DBuilder.createBasicType("complex", Size, Align, Encoding);
444 /// CreateCVRType - Get the qualified type from the cache or create
445 /// a new one if necessary.
446 llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
447 QualifierCollector Qc;
448 const Type *T = Qc.strip(Ty);
450 // Ignore these qualifiers for now.
451 Qc.removeObjCGCAttr();
452 Qc.removeAddressSpace();
453 Qc.removeObjCLifetime();
455 // We will create one Derived type for one qualifier and recurse to handle any
459 Tag = llvm::dwarf::DW_TAG_const_type;
461 } else if (Qc.hasVolatile()) {
462 Tag = llvm::dwarf::DW_TAG_volatile_type;
464 } else if (Qc.hasRestrict()) {
465 Tag = llvm::dwarf::DW_TAG_restrict_type;
468 assert(Qc.empty() && "Unknown type qualifier for debug info");
469 return getOrCreateType(QualType(T, 0), Unit);
472 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
474 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
475 // CVR derived types.
476 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
481 llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
484 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
485 Ty->getPointeeType(), Unit);
489 llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
491 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
492 Ty->getPointeeType(), Unit);
495 // Creates a forward declaration for a RecordDecl in the given context.
496 llvm::DIType CGDebugInfo::createRecordFwdDecl(const RecordDecl *RD,
497 llvm::DIDescriptor Ctx) {
498 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
499 unsigned Line = getLineNumber(RD->getLocation());
500 StringRef RDName = RD->getName();
503 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
506 RDName = getClassName(RD);
507 Tag = llvm::dwarf::DW_TAG_class_type;
509 else if (RD->isStruct())
510 Tag = llvm::dwarf::DW_TAG_structure_type;
511 else if (RD->isUnion())
512 Tag = llvm::dwarf::DW_TAG_union_type;
514 llvm_unreachable("Unknown RecordDecl type!");
517 return DBuilder.createForwardDecl(Tag, RDName, DefUnit, Line);
520 // Walk up the context chain and create forward decls for record decls,
521 // and normal descriptors for namespaces.
522 llvm::DIDescriptor CGDebugInfo::createContextChain(const Decl *Context) {
526 // See if we already have the parent.
527 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
528 I = RegionMap.find(Context);
529 if (I != RegionMap.end())
530 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(&*I->second));
533 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
534 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
536 if (const RecordDecl *RD = dyn_cast<RecordDecl>(Context)) {
537 if (!RD->isDependentType()) {
538 llvm::DIType Ty = getOrCreateLimitedType(CGM.getContext().getTypeDeclType(RD),
539 getOrCreateMainFile());
540 return llvm::DIDescriptor(Ty);
546 /// CreatePointeeType - Create Pointee type. If Pointee is a record
547 /// then emit record's fwd if debug info size reduction is enabled.
548 llvm::DIType CGDebugInfo::CreatePointeeType(QualType PointeeTy,
550 if (!CGM.getCodeGenOpts().LimitDebugInfo)
551 return getOrCreateType(PointeeTy, Unit);
553 // Limit debug info for the pointee type.
555 // If we have an existing type, use that, it's still smaller than creating
557 llvm::DIType Ty = getTypeOrNull(PointeeTy);
558 if (Ty.Verify()) return Ty;
560 // Handle qualifiers.
561 if (PointeeTy.hasLocalQualifiers())
562 return CreateQualifiedType(PointeeTy, Unit);
564 if (const RecordType *RTy = dyn_cast<RecordType>(PointeeTy)) {
565 RecordDecl *RD = RTy->getDecl();
566 llvm::DIDescriptor FDContext =
567 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
568 llvm::DIType RetTy = createRecordFwdDecl(RD, FDContext);
569 TypeCache[QualType(RTy, 0).getAsOpaquePtr()] = RetTy;
572 return getOrCreateType(PointeeTy, Unit);
576 llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
580 if (Tag == llvm::dwarf::DW_TAG_reference_type)
581 return DBuilder.createReferenceType(CreatePointeeType(PointeeTy, Unit));
583 // Bit size, align and offset of the type.
584 // Size is always the size of a pointer. We can't use getTypeSize here
585 // because that does not return the correct value for references.
586 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
587 uint64_t Size = CGM.getContext().getTargetInfo().getPointerWidth(AS);
588 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
590 return DBuilder.createPointerType(CreatePointeeType(PointeeTy, Unit),
594 llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
596 if (BlockLiteralGenericSet)
597 return BlockLiteralGeneric;
599 SmallVector<llvm::Value *, 8> EltTys;
600 llvm::DIType FieldTy;
602 uint64_t FieldSize, FieldOffset;
604 llvm::DIArray Elements;
605 llvm::DIType EltTy, DescTy;
608 FType = CGM.getContext().UnsignedLongTy;
609 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
610 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
612 Elements = DBuilder.getOrCreateArray(EltTys);
615 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
616 unsigned LineNo = getLineNumber(CurLoc);
618 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
619 Unit, LineNo, FieldOffset, 0,
622 // Bit size, align and offset of the type.
623 uint64_t Size = CGM.getContext().getTypeSize(Ty);
625 DescTy = DBuilder.createPointerType(EltTy, Size);
628 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
629 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
630 FType = CGM.getContext().IntTy;
631 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
632 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
633 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
634 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
636 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
638 FieldSize = CGM.getContext().getTypeSize(Ty);
639 FieldAlign = CGM.getContext().getTypeAlign(Ty);
640 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
641 LineNo, FieldSize, FieldAlign,
642 FieldOffset, 0, FieldTy);
643 EltTys.push_back(FieldTy);
645 FieldOffset += FieldSize;
646 Elements = DBuilder.getOrCreateArray(EltTys);
648 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
649 Unit, LineNo, FieldOffset, 0,
652 BlockLiteralGenericSet = true;
653 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
654 return BlockLiteralGeneric;
657 llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
658 // Typedefs are derived from some other type. If we have a typedef of a
659 // typedef, make sure to emit the whole chain.
660 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
662 return llvm::DIType();
663 // We don't set size information, but do specify where the typedef was
665 unsigned Line = getLineNumber(Ty->getDecl()->getLocation());
666 const TypedefNameDecl *TyDecl = Ty->getDecl();
668 llvm::DIDescriptor TypedefContext =
669 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
672 DBuilder.createTypedef(Src, TyDecl->getName(), Unit, Line, TypedefContext);
675 llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
677 SmallVector<llvm::Value *, 16> EltTys;
679 // Add the result type at least.
680 EltTys.push_back(getOrCreateType(Ty->getResultType(), Unit));
682 // Set up remainder of arguments if there is a prototype.
683 // FIXME: IF NOT, HOW IS THIS REPRESENTED? llvm-gcc doesn't represent '...'!
684 if (isa<FunctionNoProtoType>(Ty))
685 EltTys.push_back(DBuilder.createUnspecifiedParameter());
686 else if (const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(Ty)) {
687 for (unsigned i = 0, e = FTP->getNumArgs(); i != e; ++i)
688 EltTys.push_back(getOrCreateType(FTP->getArgType(i), Unit));
691 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
693 llvm::DIType DbgTy = DBuilder.createSubroutineType(Unit, EltTypeArray);
699 CollectRecordStaticVars(const RecordDecl *RD, llvm::DIType FwdDecl) {
701 for (RecordDecl::decl_iterator I = RD->decls_begin(), E = RD->decls_end();
703 if (const VarDecl *V = dyn_cast<VarDecl>(*I)) {
705 const APValue *Value = V->evaluateValue();
706 if (Value && Value->isInt()) {
707 llvm::ConstantInt *CI
708 = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
710 // Create the descriptor for static variable.
711 llvm::DIFile VUnit = getOrCreateFile(V->getLocation());
712 StringRef VName = V->getName();
713 llvm::DIType VTy = getOrCreateType(V->getType(), VUnit);
714 // Do not use DIGlobalVariable for enums.
715 if (VTy.getTag() != llvm::dwarf::DW_TAG_enumeration_type) {
716 DBuilder.createStaticVariable(FwdDecl, VName, VName, VUnit,
717 getLineNumber(V->getLocation()),
725 llvm::DIType CGDebugInfo::createFieldType(StringRef name,
727 uint64_t sizeInBitsOverride,
730 uint64_t offsetInBits,
732 llvm::DIDescriptor scope) {
733 llvm::DIType debugType = getOrCreateType(type, tunit);
735 // Get the location for the field.
736 llvm::DIFile file = getOrCreateFile(loc);
737 unsigned line = getLineNumber(loc);
739 uint64_t sizeInBits = 0;
740 unsigned alignInBits = 0;
741 if (!type->isIncompleteArrayType()) {
742 llvm::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
744 if (sizeInBitsOverride)
745 sizeInBits = sizeInBitsOverride;
749 if (AS == clang::AS_private)
750 flags |= llvm::DIDescriptor::FlagPrivate;
751 else if (AS == clang::AS_protected)
752 flags |= llvm::DIDescriptor::FlagProtected;
754 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
755 alignInBits, offsetInBits, flags, debugType);
758 /// CollectRecordFields - A helper function to collect debug info for
759 /// record fields. This is used while creating debug info entry for a Record.
761 CollectRecordFields(const RecordDecl *record, llvm::DIFile tunit,
762 SmallVectorImpl<llvm::Value *> &elements,
763 llvm::DIType RecordTy) {
764 unsigned fieldNo = 0;
765 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
766 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
768 // For C++11 Lambdas a Fields will be the same as a Capture, but the Capture
769 // has the name and the location of the variable so we should iterate over
770 // both concurrently.
771 if (CXXDecl && CXXDecl->isLambda()) {
772 RecordDecl::field_iterator Field = CXXDecl->field_begin();
773 unsigned fieldno = 0;
774 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
775 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
776 const LambdaExpr::Capture C = *I;
777 // TODO: Need to handle 'this' in some way by probably renaming the
778 // this of the lambda class and having a field member of 'this'.
779 if (C.capturesVariable()) {
780 VarDecl *V = C.getCapturedVar();
781 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
782 StringRef VName = V->getName();
783 uint64_t SizeInBitsOverride = 0;
784 if (Field->isBitField()) {
785 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
786 assert(SizeInBitsOverride && "found named 0-width bitfield");
788 llvm::DIType fieldType
789 = createFieldType(VName, Field->getType(), SizeInBitsOverride, C.getLocation(),
790 Field->getAccess(), layout.getFieldOffset(fieldno),
792 elements.push_back(fieldType);
796 bool IsMsStruct = record->hasAttr<MsStructAttr>();
797 const FieldDecl *LastFD = 0;
798 for (RecordDecl::field_iterator I = record->field_begin(),
799 E = record->field_end();
800 I != E; ++I, ++fieldNo) {
801 FieldDecl *field = *I;
804 // Zero-length bitfields following non-bitfield members are ignored
805 if (CGM.getContext().ZeroBitfieldFollowsNonBitfield((field), LastFD)) {
812 StringRef name = field->getName();
813 QualType type = field->getType();
815 // Ignore unnamed fields unless they're anonymous structs/unions.
816 if (name.empty() && !type->isRecordType()) {
821 uint64_t SizeInBitsOverride = 0;
822 if (field->isBitField()) {
823 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
824 assert(SizeInBitsOverride && "found named 0-width bitfield");
827 llvm::DIType fieldType
828 = createFieldType(name, type, SizeInBitsOverride,
829 field->getLocation(), field->getAccess(),
830 layout.getFieldOffset(fieldNo), tunit, RecordTy);
832 elements.push_back(fieldType);
837 /// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
838 /// function type is not updated to include implicit "this" pointer. Use this
839 /// routine to get a method type which includes "this" pointer.
841 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
844 = getOrCreateType(QualType(Method->getType()->getAs<FunctionProtoType>(),
848 // Add "this" pointer.
849 llvm::DIArray Args = llvm::DICompositeType(FnTy).getTypeArray();
850 assert (Args.getNumElements() && "Invalid number of arguments!");
852 SmallVector<llvm::Value *, 16> Elts;
854 // First element is always return type. For 'void' functions it is NULL.
855 Elts.push_back(Args.getElement(0));
857 if (!Method->isStatic()) {
858 // "this" pointer is always first argument.
859 QualType ThisPtr = Method->getThisType(CGM.getContext());
861 const CXXRecordDecl *RD = Method->getParent();
862 if (isa<ClassTemplateSpecializationDecl>(RD)) {
863 // Create pointer type directly in this case.
864 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
865 QualType PointeeTy = ThisPtrTy->getPointeeType();
866 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
867 uint64_t Size = CGM.getContext().getTargetInfo().getPointerWidth(AS);
868 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
869 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
870 llvm::DIType ThisPtrType = DBuilder.createPointerType(PointeeType, Size, Align);
871 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
872 // TODO: This and the artificial type below are misleading, the
873 // types aren't artificial the argument is, but the current
874 // metadata doesn't represent that.
875 ThisPtrType = DBuilder.createArtificialType(ThisPtrType);
876 Elts.push_back(ThisPtrType);
878 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
879 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
880 ThisPtrType = DBuilder.createArtificialType(ThisPtrType);
881 Elts.push_back(ThisPtrType);
885 // Copy rest of the arguments.
886 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
887 Elts.push_back(Args.getElement(i));
889 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
891 return DBuilder.createSubroutineType(Unit, EltTypeArray);
894 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
895 /// inside a function.
896 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
897 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
898 return isFunctionLocalClass(NRD);
899 if (isa<FunctionDecl>(RD->getDeclContext()))
904 /// CreateCXXMemberFunction - A helper function to create a DISubprogram for
905 /// a single member function GlobalDecl.
907 CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
909 llvm::DIType RecordTy) {
911 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
913 StringRef MethodName = getFunctionName(Method);
914 llvm::DIType MethodTy = getOrCreateMethodType(Method, Unit);
916 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
917 // make sense to give a single ctor/dtor a linkage name.
918 StringRef MethodLinkageName;
919 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
920 MethodLinkageName = CGM.getMangledName(Method);
922 // Get the location for the method.
923 llvm::DIFile MethodDefUnit = getOrCreateFile(Method->getLocation());
924 unsigned MethodLine = getLineNumber(Method->getLocation());
926 // Collect virtual method info.
927 llvm::DIType ContainingType;
928 unsigned Virtuality = 0;
931 if (Method->isVirtual()) {
932 if (Method->isPure())
933 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
935 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
937 // It doesn't make sense to give a virtual destructor a vtable index,
938 // since a single destructor has two entries in the vtable.
939 if (!isa<CXXDestructorDecl>(Method))
940 VIndex = CGM.getVTableContext().getMethodVTableIndex(Method);
941 ContainingType = RecordTy;
945 if (Method->isImplicit())
946 Flags |= llvm::DIDescriptor::FlagArtificial;
947 AccessSpecifier Access = Method->getAccess();
948 if (Access == clang::AS_private)
949 Flags |= llvm::DIDescriptor::FlagPrivate;
950 else if (Access == clang::AS_protected)
951 Flags |= llvm::DIDescriptor::FlagProtected;
952 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
953 if (CXXC->isExplicit())
954 Flags |= llvm::DIDescriptor::FlagExplicit;
955 } else if (const CXXConversionDecl *CXXC =
956 dyn_cast<CXXConversionDecl>(Method)) {
957 if (CXXC->isExplicit())
958 Flags |= llvm::DIDescriptor::FlagExplicit;
960 if (Method->hasPrototype())
961 Flags |= llvm::DIDescriptor::FlagPrototyped;
963 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
964 llvm::DISubprogram SP =
965 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
966 MethodDefUnit, MethodLine,
967 MethodTy, /*isLocalToUnit=*/false,
968 /* isDefinition=*/ false,
969 Virtuality, VIndex, ContainingType,
970 Flags, CGM.getLangOpts().Optimize, NULL,
973 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
978 /// CollectCXXMemberFunctions - A helper function to collect debug info for
979 /// C++ member functions. This is used while creating debug info entry for
982 CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
983 SmallVectorImpl<llvm::Value *> &EltTys,
984 llvm::DIType RecordTy) {
986 // Since we want more than just the individual member decls if we
987 // have templated functions iterate over every declaration to gather
989 for(DeclContext::decl_iterator I = RD->decls_begin(),
990 E = RD->decls_end(); I != E; ++I) {
992 if (D->isImplicit() && !D->isUsed())
995 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
996 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
997 else if (FunctionTemplateDecl *FTD = dyn_cast<FunctionTemplateDecl>(D))
998 for (FunctionTemplateDecl::spec_iterator SI = FTD->spec_begin(),
999 SE = FTD->spec_end(); SI != SE; ++SI) {
1000 FunctionDecl *FD = *SI;
1001 if (CXXMethodDecl *M = dyn_cast<CXXMethodDecl>(FD))
1002 EltTys.push_back(CreateCXXMemberFunction(M, Unit, RecordTy));
1007 /// CollectCXXFriends - A helper function to collect debug info for
1008 /// C++ base classes. This is used while creating debug info entry for
1011 CollectCXXFriends(const CXXRecordDecl *RD, llvm::DIFile Unit,
1012 SmallVectorImpl<llvm::Value *> &EltTys,
1013 llvm::DIType RecordTy) {
1014 for (CXXRecordDecl::friend_iterator BI = RD->friend_begin(),
1015 BE = RD->friend_end(); BI != BE; ++BI) {
1016 if ((*BI)->isUnsupportedFriend())
1018 if (TypeSourceInfo *TInfo = (*BI)->getFriendType())
1019 EltTys.push_back(DBuilder.createFriend(RecordTy,
1020 getOrCreateType(TInfo->getType(),
1025 /// CollectCXXBases - A helper function to collect debug info for
1026 /// C++ base classes. This is used while creating debug info entry for
1029 CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1030 SmallVectorImpl<llvm::Value *> &EltTys,
1031 llvm::DIType RecordTy) {
1033 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1034 for (CXXRecordDecl::base_class_const_iterator BI = RD->bases_begin(),
1035 BE = RD->bases_end(); BI != BE; ++BI) {
1036 unsigned BFlags = 0;
1037 uint64_t BaseOffset;
1039 const CXXRecordDecl *Base =
1040 cast<CXXRecordDecl>(BI->getType()->getAs<RecordType>()->getDecl());
1042 if (BI->isVirtual()) {
1043 // virtual base offset offset is -ve. The code generator emits dwarf
1044 // expression where it expects +ve number.
1046 0 - CGM.getVTableContext()
1047 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1048 BFlags = llvm::DIDescriptor::FlagVirtual;
1050 BaseOffset = RL.getBaseClassOffsetInBits(Base);
1051 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1052 // BI->isVirtual() and bits when not.
1054 AccessSpecifier Access = BI->getAccessSpecifier();
1055 if (Access == clang::AS_private)
1056 BFlags |= llvm::DIDescriptor::FlagPrivate;
1057 else if (Access == clang::AS_protected)
1058 BFlags |= llvm::DIDescriptor::FlagProtected;
1061 DBuilder.createInheritance(RecordTy,
1062 getOrCreateType(BI->getType(), Unit),
1063 BaseOffset, BFlags);
1064 EltTys.push_back(DTy);
1068 /// CollectTemplateParams - A helper function to collect template parameters.
1069 llvm::DIArray CGDebugInfo::
1070 CollectTemplateParams(const TemplateParameterList *TPList,
1071 const TemplateArgumentList &TAList,
1072 llvm::DIFile Unit) {
1073 SmallVector<llvm::Value *, 16> TemplateParams;
1074 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1075 const TemplateArgument &TA = TAList[i];
1076 const NamedDecl *ND = TPList->getParam(i);
1077 if (TA.getKind() == TemplateArgument::Type) {
1078 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1079 llvm::DITemplateTypeParameter TTP =
1080 DBuilder.createTemplateTypeParameter(TheCU, ND->getName(), TTy);
1081 TemplateParams.push_back(TTP);
1082 } else if (TA.getKind() == TemplateArgument::Integral) {
1083 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1084 llvm::DITemplateValueParameter TVP =
1085 DBuilder.createTemplateValueParameter(TheCU, ND->getName(), TTy,
1086 TA.getAsIntegral()->getZExtValue());
1087 TemplateParams.push_back(TVP);
1090 return DBuilder.getOrCreateArray(TemplateParams);
1093 /// CollectFunctionTemplateParams - A helper function to collect debug
1094 /// info for function template parameters.
1095 llvm::DIArray CGDebugInfo::
1096 CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1097 if (FD->getTemplatedKind() ==
1098 FunctionDecl::TK_FunctionTemplateSpecialization) {
1099 const TemplateParameterList *TList =
1100 FD->getTemplateSpecializationInfo()->getTemplate()
1101 ->getTemplateParameters();
1103 CollectTemplateParams(TList, *FD->getTemplateSpecializationArgs(), Unit);
1105 return llvm::DIArray();
1108 /// CollectCXXTemplateParams - A helper function to collect debug info for
1109 /// template parameters.
1110 llvm::DIArray CGDebugInfo::
1111 CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1112 llvm::DIFile Unit) {
1113 llvm::PointerUnion<ClassTemplateDecl *,
1114 ClassTemplatePartialSpecializationDecl *>
1115 PU = TSpecial->getSpecializedTemplateOrPartial();
1117 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1118 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1119 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1120 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
1121 return CollectTemplateParams(TPList, TAList, Unit);
1124 /// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1125 llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1126 if (VTablePtrType.isValid())
1127 return VTablePtrType;
1129 ASTContext &Context = CGM.getContext();
1132 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1133 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1134 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1135 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1136 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1138 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1139 return VTablePtrType;
1142 /// getVTableName - Get vtable name for the given Class.
1143 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1144 // Construct gdb compatible name name.
1145 std::string Name = "_vptr$" + RD->getNameAsString();
1147 // Copy this name on the side and use its reference.
1148 char *StrPtr = DebugInfoNames.Allocate<char>(Name.length());
1149 memcpy(StrPtr, Name.data(), Name.length());
1150 return StringRef(StrPtr, Name.length());
1154 /// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1155 /// debug info entry in EltTys vector.
1157 CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1158 SmallVectorImpl<llvm::Value *> &EltTys) {
1159 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1161 // If there is a primary base then it will hold vtable info.
1162 if (RL.getPrimaryBase())
1165 // If this class is not dynamic then there is not any vtable info to collect.
1166 if (!RD->isDynamicClass())
1169 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1171 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
1173 getOrCreateVTablePtrType(Unit));
1174 EltTys.push_back(VPTR);
1177 /// getOrCreateRecordType - Emit record type's standalone debug info.
1178 llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
1179 SourceLocation Loc) {
1180 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1184 /// getOrCreateInterfaceType - Emit an objective c interface type standalone
1186 llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
1187 SourceLocation Loc) {
1188 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
1189 DBuilder.retainType(T);
1193 /// CreateType - get structure or union type.
1194 llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
1195 RecordDecl *RD = Ty->getDecl();
1197 // Get overall information about the record type for the debug info.
1198 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1200 // Records and classes and unions can all be recursive. To handle them, we
1201 // first generate a debug descriptor for the struct as a forward declaration.
1202 // Then (if it is a definition) we go through and get debug info for all of
1203 // its members. Finally, we create a descriptor for the complete type (which
1204 // may refer to the forward decl if the struct is recursive) and replace all
1205 // uses of the forward declaration with the final definition.
1207 llvm::DIType FwdDecl = getOrCreateLimitedType(QualType(Ty, 0), DefUnit);
1209 if (FwdDecl.isForwardDecl())
1212 llvm::TrackingVH<llvm::MDNode> FwdDeclNode(FwdDecl);
1214 // Push the struct on region stack.
1215 LexicalBlockStack.push_back(FwdDeclNode);
1216 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1218 // Add this to the completed types cache since we're completing it.
1219 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1221 // Convert all the elements.
1222 SmallVector<llvm::Value *, 16> EltTys;
1224 // Note: The split of CXXDecl information here is intentional, the
1225 // gdb tests will depend on a certain ordering at printout. The debug
1226 // information offsets are still correct if we merge them all together
1228 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1230 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1231 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1234 // Collect static variables with initializers and other fields.
1235 CollectRecordStaticVars(RD, FwdDecl);
1236 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
1237 llvm::DIArray TParamsArray;
1239 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
1240 CollectCXXFriends(CXXDecl, DefUnit, EltTys, FwdDecl);
1241 if (const ClassTemplateSpecializationDecl *TSpecial
1242 = dyn_cast<ClassTemplateSpecializationDecl>(RD))
1243 TParamsArray = CollectCXXTemplateParams(TSpecial, DefUnit);
1246 LexicalBlockStack.pop_back();
1247 RegionMap.erase(Ty->getDecl());
1249 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
1250 // FIXME: Magic numbers ahoy! These should be changed when we
1251 // get some enums in llvm/Analysis/DebugInfo.h to refer to
1254 FwdDeclNode->replaceOperandWith(10, Elements);
1256 FwdDeclNode->replaceOperandWith(10, Elements);
1257 FwdDeclNode->replaceOperandWith(13, TParamsArray);
1259 FwdDeclNode->replaceOperandWith(10, Elements);
1261 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDeclNode);
1262 return llvm::DIType(FwdDeclNode);
1265 /// CreateType - get objective-c object type.
1266 llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1267 llvm::DIFile Unit) {
1268 // Ignore protocols.
1269 return getOrCreateType(Ty->getBaseType(), Unit);
1272 /// CreateType - get objective-c interface type.
1273 llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1274 llvm::DIFile Unit) {
1275 ObjCInterfaceDecl *ID = Ty->getDecl();
1277 return llvm::DIType();
1279 // Get overall information about the record type for the debug info.
1280 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1281 unsigned Line = getLineNumber(ID->getLocation());
1282 unsigned RuntimeLang = TheCU.getLanguage();
1284 // If this is just a forward declaration return a special forward-declaration
1285 // debug type since we won't be able to lay out the entire type.
1286 ObjCInterfaceDecl *Def = ID->getDefinition();
1288 llvm::DIType FwdDecl =
1289 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1290 ID->getName(), DefUnit, Line,
1297 // Bit size, align and offset of the type.
1298 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1299 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1302 if (ID->getImplementation())
1303 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1305 llvm::DIType RealDecl =
1306 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1307 Line, Size, Align, Flags,
1308 llvm::DIArray(), RuntimeLang);
1310 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1311 // will find it and we're emitting the complete type.
1312 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
1313 // Push the struct on region stack.
1314 llvm::TrackingVH<llvm::MDNode> FwdDeclNode(RealDecl);
1316 LexicalBlockStack.push_back(FwdDeclNode);
1317 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1319 // Convert all the elements.
1320 SmallVector<llvm::Value *, 16> EltTys;
1322 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1324 llvm::DIType SClassTy =
1325 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1326 if (!SClassTy.isValid())
1327 return llvm::DIType();
1329 llvm::DIType InhTag =
1330 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1331 EltTys.push_back(InhTag);
1334 for (ObjCContainerDecl::prop_iterator I = ID->prop_begin(),
1335 E = ID->prop_end(); I != E; ++I) {
1336 const ObjCPropertyDecl *PD = *I;
1337 SourceLocation Loc = PD->getLocation();
1338 llvm::DIFile PUnit = getOrCreateFile(Loc);
1339 unsigned PLine = getLineNumber(Loc);
1340 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1341 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1342 llvm::MDNode *PropertyNode =
1343 DBuilder.createObjCProperty(PD->getName(),
1345 (Getter && Getter->isImplicit()) ? "" :
1346 getSelectorName(PD->getGetterName()),
1347 (Setter && Setter->isImplicit()) ? "" :
1348 getSelectorName(PD->getSetterName()),
1349 PD->getPropertyAttributes(),
1350 getOrCreateType(PD->getType(), PUnit));
1351 EltTys.push_back(PropertyNode);
1354 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1355 unsigned FieldNo = 0;
1356 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1357 Field = Field->getNextIvar(), ++FieldNo) {
1358 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1359 if (!FieldTy.isValid())
1360 return llvm::DIType();
1362 StringRef FieldName = Field->getName();
1364 // Ignore unnamed fields.
1365 if (FieldName.empty())
1368 // Get the location for the field.
1369 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1370 unsigned FieldLine = getLineNumber(Field->getLocation());
1371 QualType FType = Field->getType();
1372 uint64_t FieldSize = 0;
1373 unsigned FieldAlign = 0;
1375 if (!FType->isIncompleteArrayType()) {
1377 // Bit size, align and offset of the type.
1378 FieldSize = Field->isBitField()
1379 ? Field->getBitWidthValue(CGM.getContext())
1380 : CGM.getContext().getTypeSize(FType);
1381 FieldAlign = CGM.getContext().getTypeAlign(FType);
1384 // We can't know the offset of our ivar in the structure if we're using
1385 // the non-fragile abi and the debugger should ignore the value anyways.
1386 // Call it the FieldNo+1 due to how debuggers use the information,
1387 // e.g. negating the value when it needs a lookup in the dynamic table.
1388 uint64_t FieldOffset = CGM.getLangOpts().ObjCNonFragileABI ? FieldNo+1
1389 : RL.getFieldOffset(FieldNo);
1392 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1393 Flags = llvm::DIDescriptor::FlagProtected;
1394 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1395 Flags = llvm::DIDescriptor::FlagPrivate;
1397 llvm::MDNode *PropertyNode = NULL;
1398 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
1399 if (ObjCPropertyImplDecl *PImpD =
1400 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1401 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
1402 SourceLocation Loc = PD->getLocation();
1403 llvm::DIFile PUnit = getOrCreateFile(Loc);
1404 unsigned PLine = getLineNumber(Loc);
1405 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1406 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1408 DBuilder.createObjCProperty(PD->getName(),
1410 (Getter && Getter->isImplicit()) ? "" :
1411 getSelectorName(PD->getGetterName()),
1412 (Setter && Setter->isImplicit()) ? "" :
1413 getSelectorName(PD->getSetterName()),
1414 PD->getPropertyAttributes(),
1415 getOrCreateType(PD->getType(), PUnit));
1419 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1420 FieldLine, FieldSize, FieldAlign,
1421 FieldOffset, Flags, FieldTy,
1423 EltTys.push_back(FieldTy);
1426 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
1427 FwdDeclNode->replaceOperandWith(10, Elements);
1429 LexicalBlockStack.pop_back();
1430 return llvm::DIType(FwdDeclNode);
1433 llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1434 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1435 int64_t NumElems = Ty->getNumElements();
1436 int64_t LowerBound = 0;
1438 // If number of elements are not known then this is an unbounded array.
1439 // Use Low = 1, Hi = 0 to express such arrays.
1444 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(LowerBound, NumElems);
1445 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1447 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1448 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1451 DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1454 llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1455 llvm::DIFile Unit) {
1460 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1461 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1464 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1465 } else if (Ty->isIncompleteArrayType()) {
1467 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
1468 } else if (Ty->isDependentSizedArrayType() || Ty->isIncompleteType()) {
1472 // Size and align of the whole array, not the element type.
1473 Size = CGM.getContext().getTypeSize(Ty);
1474 Align = CGM.getContext().getTypeAlign(Ty);
1477 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1478 // interior arrays, do we care? Why aren't nested arrays represented the
1479 // obvious/recursive way?
1480 SmallVector<llvm::Value *, 8> Subscripts;
1481 QualType EltTy(Ty, 0);
1482 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1483 int64_t UpperBound = 0;
1484 int64_t LowerBound = 0;
1485 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty)) {
1486 if (CAT->getSize().getZExtValue())
1487 UpperBound = CAT->getSize().getZExtValue() - 1;
1489 // This is an unbounded array. Use Low = 1, Hi = 0 to express such
1493 // FIXME: Verify this is right for VLAs.
1494 Subscripts.push_back(DBuilder.getOrCreateSubrange(LowerBound,
1496 EltTy = Ty->getElementType();
1499 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1501 llvm::DIType DbgTy =
1502 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1507 llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
1508 llvm::DIFile Unit) {
1509 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
1510 Ty, Ty->getPointeeType(), Unit);
1513 llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
1514 llvm::DIFile Unit) {
1515 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
1516 Ty, Ty->getPointeeType(), Unit);
1519 llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
1521 QualType PointerDiffTy = CGM.getContext().getPointerDiffType();
1522 llvm::DIType PointerDiffDITy = getOrCreateType(PointerDiffTy, U);
1524 if (!Ty->getPointeeType()->isFunctionType()) {
1525 // We have a data member pointer type.
1526 return PointerDiffDITy;
1529 // We have a member function pointer type. Treat it as a struct with two
1530 // ptrdiff_t members.
1531 std::pair<uint64_t, unsigned> Info = CGM.getContext().getTypeInfo(Ty);
1533 uint64_t FieldOffset = 0;
1534 llvm::Value *ElementTypes[2];
1536 // FIXME: This should probably be a function type instead.
1538 DBuilder.createMemberType(U, "ptr", U, 0,
1539 Info.first, Info.second, FieldOffset, 0,
1541 FieldOffset += Info.first;
1544 DBuilder.createMemberType(U, "ptr", U, 0,
1545 Info.first, Info.second, FieldOffset, 0,
1548 llvm::DIArray Elements = DBuilder.getOrCreateArray(ElementTypes);
1550 return DBuilder.createStructType(U, StringRef("test"),
1555 llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
1557 // Ignore the atomic wrapping
1558 // FIXME: What is the correct representation?
1559 return getOrCreateType(Ty->getValueType(), U);
1562 /// CreateEnumType - get enumeration type.
1563 llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
1564 llvm::DIFile Unit = getOrCreateFile(ED->getLocation());
1565 SmallVector<llvm::Value *, 16> Enumerators;
1567 // Create DIEnumerator elements for each enumerator.
1568 for (EnumDecl::enumerator_iterator
1569 Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1570 Enum != EnumEnd; ++Enum) {
1571 Enumerators.push_back(
1572 DBuilder.createEnumerator(Enum->getName(),
1573 Enum->getInitVal().getZExtValue()));
1576 // Return a CompositeType for the enum itself.
1577 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1579 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1580 unsigned Line = getLineNumber(ED->getLocation());
1583 if (!ED->getTypeForDecl()->isIncompleteType()) {
1584 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1585 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1587 llvm::DIDescriptor EnumContext =
1588 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1589 llvm::DIType DbgTy =
1590 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1591 Size, Align, EltArray);
1595 static QualType UnwrapTypeForDebugInfo(QualType T) {
1598 switch (T->getTypeClass()) {
1601 case Type::TemplateSpecialization:
1602 T = cast<TemplateSpecializationType>(T)->desugar();
1604 case Type::TypeOfExpr:
1605 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1608 T = cast<TypeOfType>(T)->getUnderlyingType();
1610 case Type::Decltype:
1611 T = cast<DecltypeType>(T)->getUnderlyingType();
1613 case Type::UnaryTransform:
1614 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1616 case Type::Attributed:
1617 T = cast<AttributedType>(T)->getEquivalentType();
1619 case Type::Elaborated:
1620 T = cast<ElaboratedType>(T)->getNamedType();
1623 T = cast<ParenType>(T)->getInnerType();
1625 case Type::SubstTemplateTypeParm:
1626 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
1629 T = cast<AutoType>(T)->getDeducedType();
1633 assert(T != LastT && "Type unwrapping failed to unwrap!");
1639 /// getType - Get the type from the cache or return null type if it doesn't exist.
1640 llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
1642 // Unwrap the type as needed for debug information.
1643 Ty = UnwrapTypeForDebugInfo(Ty);
1645 // Check for existing entry.
1646 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1647 TypeCache.find(Ty.getAsOpaquePtr());
1648 if (it != TypeCache.end()) {
1649 // Verify that the debug info still exists.
1651 return llvm::DIType(cast<llvm::MDNode>(it->second));
1654 return llvm::DIType();
1657 /// getCompletedTypeOrNull - Get the type from the cache or return null if it
1659 llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
1661 // Unwrap the type as needed for debug information.
1662 Ty = UnwrapTypeForDebugInfo(Ty);
1664 // Check for existing entry.
1665 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1666 CompletedTypeCache.find(Ty.getAsOpaquePtr());
1667 if (it != CompletedTypeCache.end()) {
1668 // Verify that the debug info still exists.
1670 return llvm::DIType(cast<llvm::MDNode>(it->second));
1673 return llvm::DIType();
1677 /// getOrCreateType - Get the type from the cache or create a new
1678 /// one if necessary.
1679 llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
1681 return llvm::DIType();
1683 // Unwrap the type as needed for debug information.
1684 Ty = UnwrapTypeForDebugInfo(Ty);
1686 llvm::DIType T = getCompletedTypeOrNull(Ty);
1688 if (T.Verify()) return T;
1690 // Otherwise create the type.
1691 llvm::DIType Res = CreateTypeNode(Ty, Unit);
1693 llvm::DIType TC = getTypeOrNull(Ty);
1694 if (TC.Verify() && TC.isForwardDecl())
1695 ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(), TC));
1697 // And update the type cache.
1698 TypeCache[Ty.getAsOpaquePtr()] = Res;
1700 if (!Res.isForwardDecl())
1701 CompletedTypeCache[Ty.getAsOpaquePtr()] = Res;
1705 /// CreateTypeNode - Create a new debug type node.
1706 llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
1707 // Handle qualifiers, which recursively handles what they refer to.
1708 if (Ty.hasLocalQualifiers())
1709 return CreateQualifiedType(Ty, Unit);
1711 const char *Diag = 0;
1713 // Work out details of type.
1714 switch (Ty->getTypeClass()) {
1715 #define TYPE(Class, Base)
1716 #define ABSTRACT_TYPE(Class, Base)
1717 #define NON_CANONICAL_TYPE(Class, Base)
1718 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
1719 #include "clang/AST/TypeNodes.def"
1720 llvm_unreachable("Dependent types cannot show up in debug information");
1722 case Type::ExtVector:
1724 return CreateType(cast<VectorType>(Ty), Unit);
1725 case Type::ObjCObjectPointer:
1726 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
1727 case Type::ObjCObject:
1728 return CreateType(cast<ObjCObjectType>(Ty), Unit);
1729 case Type::ObjCInterface:
1730 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
1732 return CreateType(cast<BuiltinType>(Ty));
1734 return CreateType(cast<ComplexType>(Ty));
1736 return CreateType(cast<PointerType>(Ty), Unit);
1737 case Type::BlockPointer:
1738 return CreateType(cast<BlockPointerType>(Ty), Unit);
1740 return CreateType(cast<TypedefType>(Ty), Unit);
1742 return CreateType(cast<RecordType>(Ty));
1744 return CreateEnumType(cast<EnumType>(Ty)->getDecl());
1745 case Type::FunctionProto:
1746 case Type::FunctionNoProto:
1747 return CreateType(cast<FunctionType>(Ty), Unit);
1748 case Type::ConstantArray:
1749 case Type::VariableArray:
1750 case Type::IncompleteArray:
1751 return CreateType(cast<ArrayType>(Ty), Unit);
1753 case Type::LValueReference:
1754 return CreateType(cast<LValueReferenceType>(Ty), Unit);
1755 case Type::RValueReference:
1756 return CreateType(cast<RValueReferenceType>(Ty), Unit);
1758 case Type::MemberPointer:
1759 return CreateType(cast<MemberPointerType>(Ty), Unit);
1762 return CreateType(cast<AtomicType>(Ty), Unit);
1764 case Type::Attributed:
1765 case Type::TemplateSpecialization:
1766 case Type::Elaborated:
1768 case Type::SubstTemplateTypeParm:
1769 case Type::TypeOfExpr:
1771 case Type::Decltype:
1772 case Type::UnaryTransform:
1774 llvm_unreachable("type should have been unwrapped!");
1777 assert(Diag && "Fall through without a diagnostic?");
1778 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
1779 "debug information for %0 is not yet supported");
1780 CGM.getDiags().Report(DiagID)
1782 return llvm::DIType();
1785 /// getOrCreateLimitedType - Get the type from the cache or create a new
1786 /// limited type if necessary.
1787 llvm::DIType CGDebugInfo::getOrCreateLimitedType(QualType Ty,
1788 llvm::DIFile Unit) {
1790 return llvm::DIType();
1792 // Unwrap the type as needed for debug information.
1793 Ty = UnwrapTypeForDebugInfo(Ty);
1795 llvm::DIType T = getTypeOrNull(Ty);
1797 // We may have cached a forward decl when we could have created
1798 // a non-forward decl. Go ahead and create a non-forward decl
1800 if (T.Verify() && !T.isForwardDecl()) return T;
1802 // Otherwise create the type.
1803 llvm::DIType Res = CreateLimitedTypeNode(Ty, Unit);
1805 if (T.Verify() && T.isForwardDecl())
1806 ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(), T));
1808 // And update the type cache.
1809 TypeCache[Ty.getAsOpaquePtr()] = Res;
1813 // TODO: Currently used for context chains when limiting debug info.
1814 llvm::DIType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
1815 RecordDecl *RD = Ty->getDecl();
1817 // Get overall information about the record type for the debug info.
1818 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1819 unsigned Line = getLineNumber(RD->getLocation());
1820 StringRef RDName = RD->getName();
1822 llvm::DIDescriptor RDContext;
1823 if (CGM.getCodeGenOpts().LimitDebugInfo)
1824 RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
1826 RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
1828 // If this is just a forward declaration, construct an appropriately
1829 // marked node and just return it.
1830 if (!RD->getDefinition())
1831 return createRecordFwdDecl(RD, RDContext);
1833 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1834 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1835 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1836 llvm::TrackingVH<llvm::MDNode> RealDecl;
1839 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
1840 Size, Align, 0, llvm::DIArray());
1842 RDName = getClassName(RD);
1844 // FIXME: This could be a struct type giving a default visibility different
1845 // than C++ class type, but needs llvm metadata changes first.
1846 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
1847 Size, Align, 0, 0, llvm::DIType(),
1848 llvm::DIArray(), llvm::DIType(),
1851 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
1852 Size, Align, 0, llvm::DIArray());
1854 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1855 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = llvm::DIType(RealDecl);
1858 // A class's primary base or the class itself contains the vtable.
1859 llvm::MDNode *ContainingType = NULL;
1860 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1861 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
1862 // Seek non virtual primary base root.
1864 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
1865 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
1866 if (PBT && !BRL.isPrimaryBaseVirtual())
1872 getOrCreateType(QualType(PBase->getTypeForDecl(), 0), DefUnit);
1874 else if (CXXDecl->isDynamicClass())
1875 ContainingType = RealDecl;
1877 RealDecl->replaceOperandWith(12, ContainingType);
1879 return llvm::DIType(RealDecl);
1882 /// CreateLimitedTypeNode - Create a new debug type node, but only forward
1883 /// declare composite types that haven't been processed yet.
1884 llvm::DIType CGDebugInfo::CreateLimitedTypeNode(QualType Ty,llvm::DIFile Unit) {
1886 // Work out details of type.
1887 switch (Ty->getTypeClass()) {
1888 #define TYPE(Class, Base)
1889 #define ABSTRACT_TYPE(Class, Base)
1890 #define NON_CANONICAL_TYPE(Class, Base)
1891 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
1892 #include "clang/AST/TypeNodes.def"
1893 llvm_unreachable("Dependent types cannot show up in debug information");
1896 return CreateLimitedType(cast<RecordType>(Ty));
1898 return CreateTypeNode(Ty, Unit);
1902 /// CreateMemberType - Create new member and increase Offset by FType's size.
1903 llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
1906 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
1907 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
1908 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
1909 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
1910 FieldSize, FieldAlign,
1911 *Offset, 0, FieldTy);
1912 *Offset += FieldSize;
1916 /// getFunctionDeclaration - Return debug info descriptor to describe method
1917 /// declaration for the given method definition.
1918 llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
1919 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
1920 if (!FD) return llvm::DISubprogram();
1923 getContextDescriptor(cast<Decl>(D->getDeclContext()));
1925 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
1926 MI = SPCache.find(FD->getCanonicalDecl());
1927 if (MI != SPCache.end()) {
1928 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1929 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1933 for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
1934 E = FD->redecls_end(); I != E; ++I) {
1935 const FunctionDecl *NextFD = *I;
1936 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
1937 MI = SPCache.find(NextFD->getCanonicalDecl());
1938 if (MI != SPCache.end()) {
1939 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1940 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1944 return llvm::DISubprogram();
1947 // getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
1948 // implicit parameter "this".
1949 llvm::DIType CGDebugInfo::getOrCreateFunctionType(const Decl * D,
1952 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
1953 return getOrCreateMethodType(Method, F);
1954 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
1955 // Add "self" and "_cmd"
1956 SmallVector<llvm::Value *, 16> Elts;
1958 // First element is always return type. For 'void' functions it is NULL.
1959 Elts.push_back(getOrCreateType(OMethod->getResultType(), F));
1960 // "self" pointer is always first argument.
1961 Elts.push_back(getOrCreateType(OMethod->getSelfDecl()->getType(), F));
1962 // "cmd" pointer is always second argument.
1963 Elts.push_back(getOrCreateType(OMethod->getCmdDecl()->getType(), F));
1964 // Get rest of the arguments.
1965 for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
1966 PE = OMethod->param_end(); PI != PE; ++PI)
1967 Elts.push_back(getOrCreateType((*PI)->getType(), F));
1969 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1970 return DBuilder.createSubroutineType(F, EltTypeArray);
1972 return getOrCreateType(FnType, F);
1975 /// EmitFunctionStart - Constructs the debug code for entering a function.
1976 void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
1978 CGBuilderTy &Builder) {
1981 StringRef LinkageName;
1983 FnBeginRegionCount.push_back(LexicalBlockStack.size());
1985 const Decl *D = GD.getDecl();
1986 // Use the location of the declaration.
1987 SourceLocation Loc = D->getLocation();
1990 llvm::DIFile Unit = getOrCreateFile(Loc);
1991 llvm::DIDescriptor FDContext(Unit);
1992 llvm::DIArray TParamsArray;
1993 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
1994 // If there is a DISubprogram for this function available then use it.
1995 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
1996 FI = SPCache.find(FD->getCanonicalDecl());
1997 if (FI != SPCache.end()) {
1998 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(&*FI->second));
1999 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2000 llvm::MDNode *SPN = SP;
2001 LexicalBlockStack.push_back(SPN);
2002 RegionMap[D] = llvm::WeakVH(SP);
2006 Name = getFunctionName(FD);
2007 // Use mangled name as linkage name for c/c++ functions.
2008 if (FD->hasPrototype()) {
2009 LinkageName = CGM.getMangledName(GD);
2010 Flags |= llvm::DIDescriptor::FlagPrototyped;
2012 if (LinkageName == Name)
2013 LinkageName = StringRef();
2015 if (const NamespaceDecl *NSDecl =
2016 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2017 FDContext = getOrCreateNameSpace(NSDecl);
2018 else if (const RecordDecl *RDecl =
2019 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2020 FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
2022 // Collect template parameters.
2023 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2024 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2025 Name = getObjCMethodName(OMD);
2026 Flags |= llvm::DIDescriptor::FlagPrototyped;
2028 // Use llvm function name.
2029 Name = Fn->getName();
2030 Flags |= llvm::DIDescriptor::FlagPrototyped;
2032 if (!Name.empty() && Name[0] == '\01')
2033 Name = Name.substr(1);
2035 unsigned LineNo = getLineNumber(Loc);
2036 if (D->isImplicit())
2037 Flags |= llvm::DIDescriptor::FlagArtificial;
2039 llvm::DISubprogram SPDecl = getFunctionDeclaration(D);
2040 llvm::DISubprogram SP =
2041 DBuilder.createFunction(FDContext, Name, LinkageName, Unit,
2042 LineNo, getOrCreateFunctionType(D, FnType, Unit),
2043 Fn->hasInternalLinkage(), true/*definition*/,
2044 getLineNumber(CurLoc),
2045 Flags, CGM.getLangOpts().Optimize, Fn,
2046 TParamsArray, SPDecl);
2048 // Push function on region stack.
2049 llvm::MDNode *SPN = SP;
2050 LexicalBlockStack.push_back(SPN);
2051 RegionMap[D] = llvm::WeakVH(SP);
2054 /// EmitLocation - Emit metadata to indicate a change in line/column
2055 /// information in the source file.
2056 void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
2058 // Update our current location
2061 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2063 // Don't bother if things are the same as last time.
2064 SourceManager &SM = CGM.getContext().getSourceManager();
2065 if (CurLoc == PrevLoc ||
2066 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2067 // New Builder may not be in sync with CGDebugInfo.
2068 if (!Builder.getCurrentDebugLocation().isUnknown())
2071 // Update last state.
2074 llvm::MDNode *Scope = LexicalBlockStack.back();
2075 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(CurLoc),
2076 getColumnNumber(CurLoc),
2080 /// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2082 void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2083 llvm::DIDescriptor D =
2084 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2085 llvm::DIDescriptor() :
2086 llvm::DIDescriptor(LexicalBlockStack.back()),
2087 getOrCreateFile(CurLoc),
2088 getLineNumber(CurLoc),
2089 getColumnNumber(CurLoc));
2090 llvm::MDNode *DN = D;
2091 LexicalBlockStack.push_back(DN);
2094 /// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2095 /// region - beginning of a DW_TAG_lexical_block.
2096 void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc) {
2097 // Set our current location.
2100 // Create a new lexical block and push it on the stack.
2101 CreateLexicalBlock(Loc);
2103 // Emit a line table change for the current location inside the new scope.
2104 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2105 getColumnNumber(Loc),
2106 LexicalBlockStack.back()));
2109 /// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2110 /// region - end of a DW_TAG_lexical_block.
2111 void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc) {
2112 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2114 // Provide an entry in the line table for the end of the block.
2115 EmitLocation(Builder, Loc);
2117 LexicalBlockStack.pop_back();
2120 /// EmitFunctionEnd - Constructs the debug code for exiting a function.
2121 void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2122 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2123 unsigned RCount = FnBeginRegionCount.back();
2124 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2126 // Pop all regions for this function.
2127 while (LexicalBlockStack.size() != RCount)
2128 EmitLexicalBlockEnd(Builder, CurLoc);
2129 FnBeginRegionCount.pop_back();
2132 // EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
2133 // See BuildByRefType.
2134 llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const ValueDecl *VD,
2135 uint64_t *XOffset) {
2137 SmallVector<llvm::Value *, 5> EltTys;
2139 uint64_t FieldSize, FieldOffset;
2140 unsigned FieldAlign;
2142 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2143 QualType Type = VD->getType();
2146 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2147 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2148 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2149 FType = CGM.getContext().IntTy;
2150 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2151 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2153 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type);
2154 if (HasCopyAndDispose) {
2155 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2156 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2158 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2162 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2163 if (Align > CGM.getContext().toCharUnitsFromBits(
2164 CGM.getContext().getTargetInfo().getPointerAlign(0))) {
2165 CharUnits FieldOffsetInBytes
2166 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2167 CharUnits AlignedOffsetInBytes
2168 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2169 CharUnits NumPaddingBytes
2170 = AlignedOffsetInBytes - FieldOffsetInBytes;
2172 if (NumPaddingBytes.isPositive()) {
2173 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2174 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2175 pad, ArrayType::Normal, 0);
2176 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2181 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2182 FieldSize = CGM.getContext().getTypeSize(FType);
2183 FieldAlign = CGM.getContext().toBits(Align);
2185 *XOffset = FieldOffset;
2186 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2187 0, FieldSize, FieldAlign,
2188 FieldOffset, 0, FieldTy);
2189 EltTys.push_back(FieldTy);
2190 FieldOffset += FieldSize;
2192 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
2194 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
2196 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
2200 /// EmitDeclare - Emit local variable declaration debug info.
2201 void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
2202 llvm::Value *Storage,
2203 unsigned ArgNo, CGBuilderTy &Builder) {
2204 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2206 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2208 uint64_t XOffset = 0;
2209 if (VD->hasAttr<BlocksAttr>())
2210 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2212 Ty = getOrCreateType(VD->getType(), Unit);
2214 // If there is not any debug info for type then do not emit debug info
2215 // for this variable.
2219 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage)) {
2220 // If Storage is an aggregate returned as 'sret' then let debugger know
2222 if (Arg->hasStructRetAttr())
2223 Ty = DBuilder.createReferenceType(Ty);
2224 else if (CXXRecordDecl *Record = VD->getType()->getAsCXXRecordDecl()) {
2225 // If an aggregate variable has non trivial destructor or non trivial copy
2226 // constructor than it is pass indirectly. Let debug info know about this
2227 // by using reference of the aggregate type as a argument type.
2228 if (!Record->hasTrivialCopyConstructor() ||
2229 !Record->hasTrivialDestructor())
2230 Ty = DBuilder.createReferenceType(Ty);
2234 // Get location information.
2235 unsigned Line = getLineNumber(VD->getLocation());
2236 unsigned Column = getColumnNumber(VD->getLocation());
2238 if (VD->isImplicit())
2239 Flags |= llvm::DIDescriptor::FlagArtificial;
2240 llvm::MDNode *Scope = LexicalBlockStack.back();
2242 StringRef Name = VD->getName();
2243 if (!Name.empty()) {
2244 if (VD->hasAttr<BlocksAttr>()) {
2245 CharUnits offset = CharUnits::fromQuantity(32);
2246 SmallVector<llvm::Value *, 9> addr;
2247 llvm::Type *Int64Ty = CGM.Int64Ty;
2248 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2249 // offset of __forwarding field
2250 offset = CGM.getContext().toCharUnitsFromBits(
2251 CGM.getContext().getTargetInfo().getPointerWidth(0));
2252 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2253 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2254 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2255 // offset of x field
2256 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2257 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2259 // Create the descriptor for the variable.
2260 llvm::DIVariable D =
2261 DBuilder.createComplexVariable(Tag,
2262 llvm::DIDescriptor(Scope),
2263 VD->getName(), Unit, Line, Ty,
2266 // Insert an llvm.dbg.declare into the current block.
2267 llvm::Instruction *Call =
2268 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2269 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2272 // Create the descriptor for the variable.
2273 llvm::DIVariable D =
2274 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2275 Name, Unit, Line, Ty,
2276 CGM.getLangOpts().Optimize, Flags, ArgNo);
2278 // Insert an llvm.dbg.declare into the current block.
2279 llvm::Instruction *Call =
2280 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2281 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2285 // If VD is an anonymous union then Storage represents value for
2286 // all union fields.
2287 if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2288 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2289 if (RD->isUnion()) {
2290 for (RecordDecl::field_iterator I = RD->field_begin(),
2291 E = RD->field_end();
2293 FieldDecl *Field = *I;
2294 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2295 StringRef FieldName = Field->getName();
2297 // Ignore unnamed fields. Do not ignore unnamed records.
2298 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2301 // Use VarDecl's Tag, Scope and Line number.
2302 llvm::DIVariable D =
2303 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2304 FieldName, Unit, Line, FieldTy,
2305 CGM.getLangOpts().Optimize, Flags,
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));
2317 void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2318 llvm::Value *Storage,
2319 CGBuilderTy &Builder) {
2320 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2323 void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
2324 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
2325 const CGBlockInfo &blockInfo) {
2326 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2328 if (Builder.GetInsertBlock() == 0)
2331 bool isByRef = VD->hasAttr<BlocksAttr>();
2333 uint64_t XOffset = 0;
2334 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2337 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2339 Ty = getOrCreateType(VD->getType(), Unit);
2341 // Get location information.
2342 unsigned Line = getLineNumber(VD->getLocation());
2343 unsigned Column = getColumnNumber(VD->getLocation());
2345 const llvm::TargetData &target = CGM.getTargetData();
2347 CharUnits offset = CharUnits::fromQuantity(
2348 target.getStructLayout(blockInfo.StructureType)
2349 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2351 SmallVector<llvm::Value *, 9> addr;
2352 llvm::Type *Int64Ty = CGM.Int64Ty;
2353 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2354 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2356 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2357 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2358 // offset of __forwarding field
2359 offset = CGM.getContext()
2360 .toCharUnitsFromBits(target.getPointerSizeInBits());
2361 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2362 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2363 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2364 // offset of x field
2365 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2366 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2369 // Create the descriptor for the variable.
2370 llvm::DIVariable D =
2371 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
2372 llvm::DIDescriptor(LexicalBlockStack.back()),
2373 VD->getName(), Unit, Line, Ty, addr);
2374 // Insert an llvm.dbg.declare into the current block.
2375 llvm::Instruction *Call =
2376 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2377 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2378 LexicalBlockStack.back()));
2381 /// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2382 /// variable declaration.
2383 void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2385 CGBuilderTy &Builder) {
2386 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2390 struct BlockLayoutChunk {
2391 uint64_t OffsetInBits;
2392 const BlockDecl::Capture *Capture;
2394 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2395 return l.OffsetInBits < r.OffsetInBits;
2399 void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
2401 CGBuilderTy &Builder) {
2402 ASTContext &C = CGM.getContext();
2403 const BlockDecl *blockDecl = block.getBlockDecl();
2405 // Collect some general information about the block's location.
2406 SourceLocation loc = blockDecl->getCaretLocation();
2407 llvm::DIFile tunit = getOrCreateFile(loc);
2408 unsigned line = getLineNumber(loc);
2409 unsigned column = getColumnNumber(loc);
2411 // Build the debug-info type for the block literal.
2412 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2414 const llvm::StructLayout *blockLayout =
2415 CGM.getTargetData().getStructLayout(block.StructureType);
2417 SmallVector<llvm::Value*, 16> fields;
2418 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2419 blockLayout->getElementOffsetInBits(0),
2421 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2422 blockLayout->getElementOffsetInBits(1),
2424 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2425 blockLayout->getElementOffsetInBits(2),
2427 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2428 blockLayout->getElementOffsetInBits(3),
2430 fields.push_back(createFieldType("__descriptor",
2431 C.getPointerType(block.NeedsCopyDispose ?
2432 C.getBlockDescriptorExtendedType() :
2433 C.getBlockDescriptorType()),
2435 blockLayout->getElementOffsetInBits(4),
2438 // We want to sort the captures by offset, not because DWARF
2439 // requires this, but because we're paranoid about debuggers.
2440 SmallVector<BlockLayoutChunk, 8> chunks;
2443 if (blockDecl->capturesCXXThis()) {
2444 BlockLayoutChunk chunk;
2445 chunk.OffsetInBits =
2446 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2448 chunks.push_back(chunk);
2451 // Variable captures.
2452 for (BlockDecl::capture_const_iterator
2453 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2455 const BlockDecl::Capture &capture = *i;
2456 const VarDecl *variable = capture.getVariable();
2457 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2459 // Ignore constant captures.
2460 if (captureInfo.isConstant())
2463 BlockLayoutChunk chunk;
2464 chunk.OffsetInBits =
2465 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2466 chunk.Capture = &capture;
2467 chunks.push_back(chunk);
2471 llvm::array_pod_sort(chunks.begin(), chunks.end());
2473 for (SmallVectorImpl<BlockLayoutChunk>::iterator
2474 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2475 uint64_t offsetInBits = i->OffsetInBits;
2476 const BlockDecl::Capture *capture = i->Capture;
2478 // If we have a null capture, this must be the C++ 'this' capture.
2480 const CXXMethodDecl *method =
2481 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2482 QualType type = method->getThisType(C);
2484 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
2485 offsetInBits, tunit, tunit));
2489 const VarDecl *variable = capture->getVariable();
2490 StringRef name = variable->getName();
2492 llvm::DIType fieldType;
2493 if (capture->isByRef()) {
2494 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
2496 // FIXME: this creates a second copy of this type!
2498 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
2499 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
2500 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
2501 ptrInfo.first, ptrInfo.second,
2502 offsetInBits, 0, fieldType);
2504 fieldType = createFieldType(name, variable->getType(), 0,
2505 loc, AS_public, offsetInBits, tunit, tunit);
2507 fields.push_back(fieldType);
2510 SmallString<36> typeName;
2511 llvm::raw_svector_ostream(typeName)
2512 << "__block_literal_" << CGM.getUniqueBlockCount();
2514 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
2517 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
2518 CGM.getContext().toBits(block.BlockSize),
2519 CGM.getContext().toBits(block.BlockAlign),
2521 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
2523 // Get overall information about the block.
2524 unsigned flags = llvm::DIDescriptor::FlagArtificial;
2525 llvm::MDNode *scope = LexicalBlockStack.back();
2526 StringRef name = ".block_descriptor";
2528 // Create the descriptor for the parameter.
2529 llvm::DIVariable debugVar =
2530 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
2531 llvm::DIDescriptor(scope),
2532 name, tunit, line, type,
2533 CGM.getLangOpts().Optimize, flags,
2534 cast<llvm::Argument>(addr)->getArgNo() + 1);
2536 // Insert an llvm.dbg.value into the current block.
2537 llvm::Instruction *declare =
2538 DBuilder.insertDbgValueIntrinsic(addr, 0, debugVar,
2539 Builder.GetInsertBlock());
2540 declare->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
2543 /// EmitGlobalVariable - Emit information about a global variable.
2544 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2546 // Create global variable debug descriptor.
2547 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
2548 unsigned LineNo = getLineNumber(D->getLocation());
2550 setLocation(D->getLocation());
2552 QualType T = D->getType();
2553 if (T->isIncompleteArrayType()) {
2555 // CodeGen turns int[] into int[1] so we'll do the same here.
2556 llvm::APSInt ConstVal(32);
2559 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2561 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2562 ArrayType::Normal, 0);
2564 StringRef DeclName = D->getName();
2565 StringRef LinkageName;
2566 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
2567 && !isa<ObjCMethodDecl>(D->getDeclContext()))
2568 LinkageName = Var->getName();
2569 if (LinkageName == DeclName)
2570 LinkageName = StringRef();
2571 llvm::DIDescriptor DContext =
2572 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
2573 DBuilder.createStaticVariable(DContext, DeclName, LinkageName,
2574 Unit, LineNo, getOrCreateType(T, Unit),
2575 Var->hasInternalLinkage(), Var);
2578 /// EmitGlobalVariable - Emit information about an objective-c interface.
2579 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2580 ObjCInterfaceDecl *ID) {
2581 // Create global variable debug descriptor.
2582 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
2583 unsigned LineNo = getLineNumber(ID->getLocation());
2585 StringRef Name = ID->getName();
2587 QualType T = CGM.getContext().getObjCInterfaceType(ID);
2588 if (T->isIncompleteArrayType()) {
2590 // CodeGen turns int[] into int[1] so we'll do the same here.
2591 llvm::APSInt ConstVal(32);
2594 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2596 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2597 ArrayType::Normal, 0);
2600 DBuilder.createGlobalVariable(Name, Unit, LineNo,
2601 getOrCreateType(T, Unit),
2602 Var->hasInternalLinkage(), Var);
2605 /// EmitGlobalVariable - Emit global variable's debug info.
2606 void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
2607 llvm::Constant *Init) {
2608 // Create the descriptor for the variable.
2609 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2610 StringRef Name = VD->getName();
2611 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
2612 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
2613 if (const EnumDecl *ED = dyn_cast<EnumDecl>(ECD->getDeclContext()))
2614 Ty = CreateEnumType(ED);
2616 // Do not use DIGlobalVariable for enums.
2617 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
2619 DBuilder.createStaticVariable(Unit, Name, Name, Unit,
2620 getLineNumber(VD->getLocation()),
2624 /// getOrCreateNamesSpace - Return namespace descriptor for the given
2627 CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
2628 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
2629 NameSpaceCache.find(NSDecl);
2630 if (I != NameSpaceCache.end())
2631 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
2633 unsigned LineNo = getLineNumber(NSDecl->getLocation());
2634 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
2635 llvm::DIDescriptor Context =
2636 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
2637 llvm::DINameSpace NS =
2638 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
2639 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
2643 void CGDebugInfo::finalize(void) {
2644 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
2645 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
2646 llvm::DIType Ty, RepTy;
2647 // Verify that the debug info still exists.
2649 Ty = llvm::DIType(cast<llvm::MDNode>(VI->second));
2651 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2652 TypeCache.find(VI->first);
2653 if (it != TypeCache.end()) {
2654 // Verify that the debug info still exists.
2656 RepTy = llvm::DIType(cast<llvm::MDNode>(it->second));
2659 if (Ty.Verify() && Ty.isForwardDecl() && RepTy.Verify()) {
2660 Ty.replaceAllUsesWith(RepTy);
2663 DBuilder.finalize();