blob: f9570abef745e84df84c9bb28f4c8ef2709464bd [file] [log] [blame]
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001//===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This coordinates the debug information generation while generating code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGDebugInfo.h"
15#include "CGBlocks.h"
David Blaikie9dfd2432013-05-10 21:53:14 +000016#include "CGCXXABI.h"
Guy Benyei7f92f2d2012-12-18 14:30:41 +000017#include "CGObjCRuntime.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
20#include "clang/AST/ASTContext.h"
21#include "clang/AST/DeclFriend.h"
22#include "clang/AST/DeclObjC.h"
23#include "clang/AST/DeclTemplate.h"
24#include "clang/AST/Expr.h"
25#include "clang/AST/RecordLayout.h"
26#include "clang/Basic/FileManager.h"
27#include "clang/Basic/SourceManager.h"
28#include "clang/Basic/Version.h"
29#include "clang/Frontend/CodeGenOptions.h"
30#include "llvm/ADT/SmallVector.h"
31#include "llvm/ADT/StringExtras.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000032#include "llvm/IR/Constants.h"
33#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/DerivedTypes.h"
35#include "llvm/IR/Instructions.h"
36#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/Module.h"
Guy Benyei7f92f2d2012-12-18 14:30:41 +000038#include "llvm/Support/Dwarf.h"
39#include "llvm/Support/FileSystem.h"
40using namespace clang;
41using namespace clang::CodeGen;
42
43CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher688cf5b2013-07-14 21:12:44 +000044 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
45 DBuilder(CGM.getModule()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +000046 CreateCompileUnit();
47}
48
49CGDebugInfo::~CGDebugInfo() {
50 assert(LexicalBlockStack.empty() &&
51 "Region stack mismatch, stack not empty!");
52}
53
Adrian Prantled6bbe42013-07-18 00:28:02 +000054
55NoLocation::NoLocation(CodeGenFunction &CGF, CGBuilderTy &B)
56 : DI(CGF.getDebugInfo()), Builder(B) {
57 if (DI) {
58 SavedLoc = DI->getLocation();
59 DI->CurLoc = SourceLocation();
60 Builder.SetCurrentDebugLocation(llvm::DebugLoc());
61 }
62}
63
64NoLocation::~NoLocation() {
65 if (DI) {
66 assert(Builder.getCurrentDebugLocation().isUnknown());
67 DI->CurLoc = SavedLoc;
68 }
69}
70
Adrian Prantlb061ce22013-07-18 01:36:04 +000071ArtificialLocation::ArtificialLocation(CodeGenFunction &CGF, CGBuilderTy &B)
Adrian Prantled6bbe42013-07-18 00:28:02 +000072 : DI(CGF.getDebugInfo()), Builder(B) {
73 if (DI) {
74 SavedLoc = DI->getLocation();
Adrian Prantlb6cdc962013-07-24 20:34:39 +000075 DI->CurLoc = SourceLocation();
76 Builder.SetCurrentDebugLocation(llvm::DebugLoc());
77 }
78}
79
80void ArtificialLocation::Emit() {
81 if (DI) {
Adrian Prantled6bbe42013-07-18 00:28:02 +000082 // Sync the Builder.
83 DI->EmitLocation(Builder, SavedLoc);
84 DI->CurLoc = SourceLocation();
85 // Construct a location that has a valid scope, but no line info.
Adrian Prantlb6cdc962013-07-24 20:34:39 +000086 assert(!DI->LexicalBlockStack.empty());
87 llvm::DIDescriptor Scope(DI->LexicalBlockStack.back());
Adrian Prantled6bbe42013-07-18 00:28:02 +000088 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(0, 0, Scope));
89 }
90}
91
Adrian Prantlb061ce22013-07-18 01:36:04 +000092ArtificialLocation::~ArtificialLocation() {
Adrian Prantled6bbe42013-07-18 00:28:02 +000093 if (DI) {
94 assert(Builder.getCurrentDebugLocation().getLine() == 0);
95 DI->CurLoc = SavedLoc;
96 }
97}
98
Guy Benyei7f92f2d2012-12-18 14:30:41 +000099void CGDebugInfo::setLocation(SourceLocation Loc) {
100 // If the new location isn't valid return.
Adrian Prantl5f4554f2013-07-18 00:27:56 +0000101 if (Loc.isInvalid()) return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000102
103 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
104
105 // If we've changed files in the middle of a lexical scope go ahead
106 // and create a new lexical scope with file node if it's different
107 // from the one in the scope.
108 if (LexicalBlockStack.empty()) return;
109
110 SourceManager &SM = CGM.getContext().getSourceManager();
111 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
112 PresumedLoc PPLoc = SM.getPresumedLoc(PrevLoc);
113
114 if (PCLoc.isInvalid() || PPLoc.isInvalid() ||
115 !strcmp(PPLoc.getFilename(), PCLoc.getFilename()))
116 return;
117
118 llvm::MDNode *LB = LexicalBlockStack.back();
119 llvm::DIScope Scope = llvm::DIScope(LB);
120 if (Scope.isLexicalBlockFile()) {
121 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(LB);
122 llvm::DIDescriptor D
123 = DBuilder.createLexicalBlockFile(LBF.getScope(),
124 getOrCreateFile(CurLoc));
125 llvm::MDNode *N = D;
126 LexicalBlockStack.pop_back();
127 LexicalBlockStack.push_back(N);
David Blaikiea6504852013-01-26 22:16:26 +0000128 } else if (Scope.isLexicalBlock() || Scope.isSubprogram()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000129 llvm::DIDescriptor D
130 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
131 llvm::MDNode *N = D;
132 LexicalBlockStack.pop_back();
133 LexicalBlockStack.push_back(N);
134 }
135}
136
137/// getContextDescriptor - Get context info for the decl.
David Blaikiebb000792013-04-19 06:56:38 +0000138llvm::DIScope CGDebugInfo::getContextDescriptor(const Decl *Context) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000139 if (!Context)
140 return TheCU;
141
142 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
143 I = RegionMap.find(Context);
144 if (I != RegionMap.end()) {
145 llvm::Value *V = I->second;
David Blaikiebb000792013-04-19 06:56:38 +0000146 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000147 }
148
149 // Check namespace.
150 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebb000792013-04-19 06:56:38 +0000151 return getOrCreateNameSpace(NSDecl);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000152
David Blaikiebb000792013-04-19 06:56:38 +0000153 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
154 if (!RDecl->isDependentType())
155 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000156 getOrCreateMainFile());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000157 return TheCU;
158}
159
160/// getFunctionName - Get function name for the given FunctionDecl. If the
161/// name is constructred on demand (e.g. C++ destructor) then the name
162/// is stored on the side.
163StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
164 assert (FD && "Invalid FunctionDecl!");
165 IdentifierInfo *FII = FD->getIdentifier();
166 FunctionTemplateSpecializationInfo *Info
167 = FD->getTemplateSpecializationInfo();
168 if (!Info && FII)
169 return FII->getName();
170
171 // Otherwise construct human readable name for debug info.
Benjamin Kramer5eada842013-02-22 15:46:01 +0000172 SmallString<128> NS;
173 llvm::raw_svector_ostream OS(NS);
174 FD->printName(OS);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000175
176 // Add any template specialization args.
177 if (Info) {
178 const TemplateArgumentList *TArgs = Info->TemplateArguments;
179 const TemplateArgument *Args = TArgs->data();
180 unsigned NumArgs = TArgs->size();
181 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer5eada842013-02-22 15:46:01 +0000182 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
183 Policy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000184 }
185
186 // Copy this name on the side and use its reference.
Benjamin Kramer5eada842013-02-22 15:46:01 +0000187 OS.flush();
188 char *StrPtr = DebugInfoNames.Allocate<char>(NS.size());
189 memcpy(StrPtr, NS.data(), NS.size());
190 return StringRef(StrPtr, NS.size());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000191}
192
193StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
194 SmallString<256> MethodName;
195 llvm::raw_svector_ostream OS(MethodName);
196 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
197 const DeclContext *DC = OMD->getDeclContext();
Eric Christopher6537f082013-05-16 00:45:12 +0000198 if (const ObjCImplementationDecl *OID =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000199 dyn_cast<const ObjCImplementationDecl>(DC)) {
200 OS << OID->getName();
Eric Christopher6537f082013-05-16 00:45:12 +0000201 } else if (const ObjCInterfaceDecl *OID =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000202 dyn_cast<const ObjCInterfaceDecl>(DC)) {
203 OS << OID->getName();
Eric Christopher6537f082013-05-16 00:45:12 +0000204 } else if (const ObjCCategoryImplDecl *OCD =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000205 dyn_cast<const ObjCCategoryImplDecl>(DC)){
206 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
207 OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb5092242013-05-17 23:58:45 +0000208 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl687ecae2013-05-17 23:49:10 +0000209 // We can extract the type of the class from the self pointer.
210 if (ImplicitParamDecl* SelfDecl = OMD->getSelfDecl()) {
211 QualType ClassTy =
212 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
213 ClassTy.print(OS, PrintingPolicy(LangOptions()));
214 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000215 }
216 OS << ' ' << OMD->getSelector().getAsString() << ']';
217
218 char *StrPtr = DebugInfoNames.Allocate<char>(OS.tell());
219 memcpy(StrPtr, MethodName.begin(), OS.tell());
220 return StringRef(StrPtr, OS.tell());
221}
222
223/// getSelectorName - Return selector name. This is used for debugging
224/// info.
225StringRef CGDebugInfo::getSelectorName(Selector S) {
226 const std::string &SName = S.getAsString();
227 char *StrPtr = DebugInfoNames.Allocate<char>(SName.size());
228 memcpy(StrPtr, SName.data(), SName.size());
229 return StringRef(StrPtr, SName.size());
230}
231
232/// getClassName - Get class name including template argument list.
Eric Christopher6537f082013-05-16 00:45:12 +0000233StringRef
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000234CGDebugInfo::getClassName(const RecordDecl *RD) {
235 const ClassTemplateSpecializationDecl *Spec
236 = dyn_cast<ClassTemplateSpecializationDecl>(RD);
237 if (!Spec)
238 return RD->getName();
239
240 const TemplateArgument *Args;
241 unsigned NumArgs;
242 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
243 const TemplateSpecializationType *TST =
244 cast<TemplateSpecializationType>(TAW->getType());
245 Args = TST->getArgs();
246 NumArgs = TST->getNumArgs();
247 } else {
248 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
249 Args = TemplateArgs.data();
250 NumArgs = TemplateArgs.size();
251 }
252 StringRef Name = RD->getIdentifier()->getName();
253 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer5eada842013-02-22 15:46:01 +0000254 SmallString<128> TemplateArgList;
255 {
256 llvm::raw_svector_ostream OS(TemplateArgList);
257 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
258 Policy);
259 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000260
261 // Copy this name on the side and use its reference.
262 size_t Length = Name.size() + TemplateArgList.size();
263 char *StrPtr = DebugInfoNames.Allocate<char>(Length);
264 memcpy(StrPtr, Name.data(), Name.size());
265 memcpy(StrPtr + Name.size(), TemplateArgList.data(), TemplateArgList.size());
266 return StringRef(StrPtr, Length);
267}
268
269/// getOrCreateFile - Get the file debug info descriptor for the input location.
270llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
271 if (!Loc.isValid())
272 // If Location is not valid then use main input file.
273 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
274
275 SourceManager &SM = CGM.getContext().getSourceManager();
276 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
277
278 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
279 // If the location is not valid then use main input file.
280 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
281
282 // Cache the results.
283 const char *fname = PLoc.getFilename();
284 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
285 DIFileCache.find(fname);
286
287 if (it != DIFileCache.end()) {
288 // Verify that the information still exists.
289 if (llvm::Value *V = it->second)
290 return llvm::DIFile(cast<llvm::MDNode>(V));
291 }
292
293 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
294
295 DIFileCache[fname] = F;
296 return F;
297}
298
299/// getOrCreateMainFile - Get the file info for main compile unit.
300llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
301 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
302}
303
304/// getLineNumber - Get line number for the location. If location is invalid
305/// then use current location.
306unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
307 if (Loc.isInvalid() && CurLoc.isInvalid())
308 return 0;
309 SourceManager &SM = CGM.getContext().getSourceManager();
310 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
311 return PLoc.isValid()? PLoc.getLine() : 0;
312}
313
314/// getColumnNumber - Get column number for the location.
Adrian Prantl00df5ea2013-03-12 20:43:25 +0000315unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000316 // We may not want column information at all.
Adrian Prantl00df5ea2013-03-12 20:43:25 +0000317 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000318 return 0;
319
320 // If the location is invalid then use the current column.
321 if (Loc.isInvalid() && CurLoc.isInvalid())
322 return 0;
323 SourceManager &SM = CGM.getContext().getSourceManager();
324 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
325 return PLoc.isValid()? PLoc.getColumn() : 0;
326}
327
328StringRef CGDebugInfo::getCurrentDirname() {
329 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
330 return CGM.getCodeGenOpts().DebugCompilationDir;
331
332 if (!CWDName.empty())
333 return CWDName;
334 SmallString<256> CWD;
335 llvm::sys::fs::current_path(CWD);
336 char *CompDirnamePtr = DebugInfoNames.Allocate<char>(CWD.size());
337 memcpy(CompDirnamePtr, CWD.data(), CWD.size());
338 return CWDName = StringRef(CompDirnamePtr, CWD.size());
339}
340
341/// CreateCompileUnit - Create new compile unit.
342void CGDebugInfo::CreateCompileUnit() {
343
344 // Get absolute path name.
345 SourceManager &SM = CGM.getContext().getSourceManager();
346 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
347 if (MainFileName.empty())
348 MainFileName = "<unknown>";
349
350 // The main file name provided via the "-main-file-name" option contains just
351 // the file name itself with no path information. This file name may have had
352 // a relative path, so we look into the actual file entry for the main
353 // file to determine the real absolute path for the file.
354 std::string MainFileDir;
355 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
356 MainFileDir = MainFile->getDir()->getName();
357 if (MainFileDir != ".")
358 MainFileName = MainFileDir + "/" + MainFileName;
359 }
360
361 // Save filename string.
362 char *FilenamePtr = DebugInfoNames.Allocate<char>(MainFileName.length());
363 memcpy(FilenamePtr, MainFileName.c_str(), MainFileName.length());
364 StringRef Filename(FilenamePtr, MainFileName.length());
Eric Christopherff971d72013-02-22 23:50:16 +0000365
366 // Save split dwarf file string.
367 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
368 char *SplitDwarfPtr = DebugInfoNames.Allocate<char>(SplitDwarfFile.length());
369 memcpy(SplitDwarfPtr, SplitDwarfFile.c_str(), SplitDwarfFile.length());
370 StringRef SplitDwarfFilename(SplitDwarfPtr, SplitDwarfFile.length());
Eric Christopher6537f082013-05-16 00:45:12 +0000371
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000372 unsigned LangTag;
373 const LangOptions &LO = CGM.getLangOpts();
374 if (LO.CPlusPlus) {
375 if (LO.ObjC1)
376 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
377 else
378 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
379 } else if (LO.ObjC1) {
380 LangTag = llvm::dwarf::DW_LANG_ObjC;
381 } else if (LO.C99) {
382 LangTag = llvm::dwarf::DW_LANG_C99;
383 } else {
384 LangTag = llvm::dwarf::DW_LANG_C89;
385 }
386
387 std::string Producer = getClangFullVersion();
388
389 // Figure out which version of the ObjC runtime we have.
390 unsigned RuntimeVers = 0;
391 if (LO.ObjC1)
392 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
393
394 // Create new compile unit.
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000395 // FIXME - Eliminate TheCU.
Eric Christopher8fed3f42013-07-19 00:51:58 +0000396 TheCU = DBuilder.createCompileUnit(LangTag, Filename, getCurrentDirname(),
397 Producer, LO.Optimize,
398 CGM.getCodeGenOpts().DwarfDebugFlags,
399 RuntimeVers, SplitDwarfFilename);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000400}
401
402/// CreateType - Get the Basic type from the cache or create a new
403/// one if necessary.
404llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
405 unsigned Encoding = 0;
406 StringRef BTName;
407 switch (BT->getKind()) {
408#define BUILTIN_TYPE(Id, SingletonId)
409#define PLACEHOLDER_TYPE(Id, SingletonId) \
410 case BuiltinType::Id:
411#include "clang/AST/BuiltinTypes.def"
412 case BuiltinType::Dependent:
413 llvm_unreachable("Unexpected builtin type");
414 case BuiltinType::NullPtr:
Peter Collingbourne24118f52013-06-27 22:51:01 +0000415 return DBuilder.createNullPtrType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000416 case BuiltinType::Void:
417 return llvm::DIType();
418 case BuiltinType::ObjCClass:
Eric Christopherb2d13922013-07-18 00:52:50 +0000419 if (ClassTy)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000420 return ClassTy;
421 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
422 "objc_class", TheCU,
423 getOrCreateMainFile(), 0);
424 return ClassTy;
425 case BuiltinType::ObjCId: {
426 // typedef struct objc_class *Class;
427 // typedef struct objc_object {
428 // Class isa;
429 // } *id;
430
Eric Christopherb2d13922013-07-18 00:52:50 +0000431 if (ObjTy)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000432 return ObjTy;
433
Eric Christopherb2d13922013-07-18 00:52:50 +0000434 if (!ClassTy)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000435 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
436 "objc_class", TheCU,
437 getOrCreateMainFile(), 0);
438
439 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopher6537f082013-05-16 00:45:12 +0000440
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000441 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
442
Eric Christopherf068c922013-04-02 22:59:11 +0000443 ObjTy =
David Blaikiec1d0af12013-02-25 01:07:08 +0000444 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
445 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000446
Eric Christopherf068c922013-04-02 22:59:11 +0000447 ObjTy.setTypeArray(DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
448 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000449 return ObjTy;
450 }
451 case BuiltinType::ObjCSel: {
Eric Christopherb2d13922013-07-18 00:52:50 +0000452 if (SelTy)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000453 return SelTy;
454 SelTy =
455 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
456 "objc_selector", TheCU, getOrCreateMainFile(),
457 0);
458 return SelTy;
459 }
Guy Benyeib13621d2012-12-18 14:38:23 +0000460
461 case BuiltinType::OCLImage1d:
462 return getOrCreateStructPtrType("opencl_image1d_t",
463 OCLImage1dDITy);
464 case BuiltinType::OCLImage1dArray:
Eric Christopher6537f082013-05-16 00:45:12 +0000465 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeib13621d2012-12-18 14:38:23 +0000466 OCLImage1dArrayDITy);
467 case BuiltinType::OCLImage1dBuffer:
468 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
469 OCLImage1dBufferDITy);
470 case BuiltinType::OCLImage2d:
471 return getOrCreateStructPtrType("opencl_image2d_t",
472 OCLImage2dDITy);
473 case BuiltinType::OCLImage2dArray:
474 return getOrCreateStructPtrType("opencl_image2d_array_t",
475 OCLImage2dArrayDITy);
476 case BuiltinType::OCLImage3d:
477 return getOrCreateStructPtrType("opencl_image3d_t",
478 OCLImage3dDITy);
Guy Benyei21f18c42013-02-07 10:55:47 +0000479 case BuiltinType::OCLSampler:
480 return DBuilder.createBasicType("opencl_sampler_t",
481 CGM.getContext().getTypeSize(BT),
482 CGM.getContext().getTypeAlign(BT),
483 llvm::dwarf::DW_ATE_unsigned);
Guy Benyeie6b9d802013-01-20 12:31:11 +0000484 case BuiltinType::OCLEvent:
485 return getOrCreateStructPtrType("opencl_event_t",
486 OCLEventDITy);
Guy Benyeib13621d2012-12-18 14:38:23 +0000487
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000488 case BuiltinType::UChar:
489 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
490 case BuiltinType::Char_S:
491 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
492 case BuiltinType::Char16:
493 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
494 case BuiltinType::UShort:
495 case BuiltinType::UInt:
496 case BuiltinType::UInt128:
497 case BuiltinType::ULong:
498 case BuiltinType::WChar_U:
499 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
500 case BuiltinType::Short:
501 case BuiltinType::Int:
502 case BuiltinType::Int128:
503 case BuiltinType::Long:
504 case BuiltinType::WChar_S:
505 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
506 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
507 case BuiltinType::Half:
508 case BuiltinType::Float:
509 case BuiltinType::LongDouble:
510 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
511 }
512
513 switch (BT->getKind()) {
514 case BuiltinType::Long: BTName = "long int"; break;
515 case BuiltinType::LongLong: BTName = "long long int"; break;
516 case BuiltinType::ULong: BTName = "long unsigned int"; break;
517 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
518 default:
519 BTName = BT->getName(CGM.getLangOpts());
520 break;
521 }
522 // Bit size, align and offset of the type.
523 uint64_t Size = CGM.getContext().getTypeSize(BT);
524 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christopher6537f082013-05-16 00:45:12 +0000525 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000526 DBuilder.createBasicType(BTName, Size, Align, Encoding);
527 return DbgTy;
528}
529
530llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
531 // Bit size, align and offset of the type.
532 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
533 if (Ty->isComplexIntegerType())
534 Encoding = llvm::dwarf::DW_ATE_lo_user;
535
536 uint64_t Size = CGM.getContext().getTypeSize(Ty);
537 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopher6537f082013-05-16 00:45:12 +0000538 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000539 DBuilder.createBasicType("complex", Size, Align, Encoding);
540
541 return DbgTy;
542}
543
544/// CreateCVRType - Get the qualified type from the cache or create
545/// a new one if necessary.
David Blaikie47251962013-08-22 13:36:01 +0000546llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000547 QualifierCollector Qc;
548 const Type *T = Qc.strip(Ty);
549
550 // Ignore these qualifiers for now.
551 Qc.removeObjCGCAttr();
552 Qc.removeAddressSpace();
553 Qc.removeObjCLifetime();
554
555 // We will create one Derived type for one qualifier and recurse to handle any
556 // additional ones.
557 unsigned Tag;
558 if (Qc.hasConst()) {
559 Tag = llvm::dwarf::DW_TAG_const_type;
560 Qc.removeConst();
561 } else if (Qc.hasVolatile()) {
562 Tag = llvm::dwarf::DW_TAG_volatile_type;
563 Qc.removeVolatile();
564 } else if (Qc.hasRestrict()) {
565 Tag = llvm::dwarf::DW_TAG_restrict_type;
566 Qc.removeRestrict();
567 } else {
568 assert(Qc.empty() && "Unknown type qualifier for debug info");
569 return getOrCreateType(QualType(T, 0), Unit);
570 }
571
David Blaikie47251962013-08-22 13:36:01 +0000572 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000573
574 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
575 // CVR derived types.
576 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopher6537f082013-05-16 00:45:12 +0000577
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000578 return DbgTy;
579}
580
581llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
582 llvm::DIFile Unit) {
Fariborz Jahanian05f8ff12013-02-21 20:42:11 +0000583
584 // The frontend treats 'id' as a typedef to an ObjCObjectType,
585 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
586 // debug info, we want to emit 'id' in both cases.
587 if (Ty->isObjCQualifiedIdType())
588 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
589
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000590 llvm::DIType DbgTy =
Eric Christopher6537f082013-05-16 00:45:12 +0000591 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000592 Ty->getPointeeType(), Unit);
593 return DbgTy;
594}
595
596llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
597 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +0000598 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000599 Ty->getPointeeType(), Unit);
600}
601
602// Creates a forward declaration for a RecordDecl in the given context.
David Blaikieeaacc882013-08-20 21:03:29 +0000603llvm::DICompositeType
604CGDebugInfo::getOrCreateRecordFwdDecl(const RecordDecl *RD,
605 llvm::DIDescriptor Ctx) {
David Blaikiec5cd1a72013-08-15 20:17:25 +0000606 if (llvm::DIType T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
David Blaikieeaacc882013-08-20 21:03:29 +0000607 return llvm::DICompositeType(T);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000608 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
609 unsigned Line = getLineNumber(RD->getLocation());
610 StringRef RDName = getClassName(RD);
611
612 unsigned Tag = 0;
613 if (RD->isStruct() || RD->isInterface())
614 Tag = llvm::dwarf::DW_TAG_structure_type;
615 else if (RD->isUnion())
616 Tag = llvm::dwarf::DW_TAG_union_type;
617 else {
618 assert(RD->isClass());
619 Tag = llvm::dwarf::DW_TAG_class_type;
620 }
621
622 // Create the type.
623 return DBuilder.createForwardDecl(Tag, RDName, Ctx, DefUnit, Line);
624}
625
626// Walk up the context chain and create forward decls for record decls,
627// and normal descriptors for namespaces.
628llvm::DIDescriptor CGDebugInfo::createContextChain(const Decl *Context) {
629 if (!Context)
630 return TheCU;
631
632 // See if we already have the parent.
633 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
634 I = RegionMap.find(Context);
635 if (I != RegionMap.end()) {
636 llvm::Value *V = I->second;
637 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(V));
638 }
Eric Christopher6537f082013-05-16 00:45:12 +0000639
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000640 // Check namespace.
641 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
642 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
643
David Blaikieeaacc882013-08-20 21:03:29 +0000644 if (const RecordDecl *RD = dyn_cast<RecordDecl>(Context))
645 if (!RD->isDependentType())
646 return getOrCreateLimitedType(
David Blaikie5434fc22013-08-20 01:28:15 +0000647 CGM.getContext().getRecordType(RD)->castAs<RecordType>(),
David Blaikieeaacc882013-08-20 21:03:29 +0000648 getOrCreateMainFile());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000649 return TheCU;
650}
651
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000652llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
Eric Christopher6537f082013-05-16 00:45:12 +0000653 const Type *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000654 QualType PointeeTy,
655 llvm::DIFile Unit) {
656 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
657 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikie47251962013-08-22 13:36:01 +0000658 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit));
Fariborz Jahanian05f8ff12013-02-21 20:42:11 +0000659
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000660 // Bit size, align and offset of the type.
661 // Size is always the size of a pointer. We can't use getTypeSize here
662 // because that does not return the correct value for references.
663 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCall64aa4b32013-04-16 22:48:15 +0000664 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000665 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
666
David Blaikie47251962013-08-22 13:36:01 +0000667 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
668 Align);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000669}
670
Eric Christopherf0890c42013-05-16 00:52:20 +0000671llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
672 llvm::DIType &Cache) {
Eric Christopherb2d13922013-07-18 00:52:50 +0000673 if (Cache)
Guy Benyeib13621d2012-12-18 14:38:23 +0000674 return Cache;
David Blaikie1e97c1e2013-05-21 17:58:54 +0000675 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
676 TheCU, getOrCreateMainFile(), 0);
677 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
678 Cache = DBuilder.createPointerType(Cache, Size);
679 return Cache;
Guy Benyeib13621d2012-12-18 14:38:23 +0000680}
681
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000682llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
683 llvm::DIFile Unit) {
Eric Christopherb2d13922013-07-18 00:52:50 +0000684 if (BlockLiteralGeneric)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000685 return BlockLiteralGeneric;
686
687 SmallVector<llvm::Value *, 8> EltTys;
688 llvm::DIType FieldTy;
689 QualType FType;
690 uint64_t FieldSize, FieldOffset;
691 unsigned FieldAlign;
692 llvm::DIArray Elements;
693 llvm::DIType EltTy, DescTy;
694
695 FieldOffset = 0;
696 FType = CGM.getContext().UnsignedLongTy;
697 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
698 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
699
700 Elements = DBuilder.getOrCreateArray(EltTys);
701 EltTys.clear();
702
703 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
704 unsigned LineNo = getLineNumber(CurLoc);
705
706 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
707 Unit, LineNo, FieldOffset, 0,
David Blaikiec1d0af12013-02-25 01:07:08 +0000708 Flags, llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000709
710 // Bit size, align and offset of the type.
711 uint64_t Size = CGM.getContext().getTypeSize(Ty);
712
713 DescTy = DBuilder.createPointerType(EltTy, Size);
714
715 FieldOffset = 0;
716 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
717 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
718 FType = CGM.getContext().IntTy;
719 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
720 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
721 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
722 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
723
724 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
725 FieldTy = DescTy;
726 FieldSize = CGM.getContext().getTypeSize(Ty);
727 FieldAlign = CGM.getContext().getTypeAlign(Ty);
728 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
729 LineNo, FieldSize, FieldAlign,
730 FieldOffset, 0, FieldTy);
731 EltTys.push_back(FieldTy);
732
733 FieldOffset += FieldSize;
734 Elements = DBuilder.getOrCreateArray(EltTys);
735
736 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
737 Unit, LineNo, FieldOffset, 0,
David Blaikiec1d0af12013-02-25 01:07:08 +0000738 Flags, llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000739
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000740 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
741 return BlockLiteralGeneric;
742}
743
David Blaikie47251962013-08-22 13:36:01 +0000744llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000745 // Typedefs are derived from some other type. If we have a typedef of a
746 // typedef, make sure to emit the whole chain.
David Blaikie47251962013-08-22 13:36:01 +0000747 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Eric Christopherb2d13922013-07-18 00:52:50 +0000748 if (!Src)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000749 return llvm::DIType();
750 // We don't set size information, but do specify where the typedef was
751 // declared.
752 unsigned Line = getLineNumber(Ty->getDecl()->getLocation());
753 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopher6537f082013-05-16 00:45:12 +0000754
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000755 llvm::DIDescriptor TypedefContext =
756 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopher6537f082013-05-16 00:45:12 +0000757
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000758 return
759 DBuilder.createTypedef(Src, TyDecl->getName(), Unit, Line, TypedefContext);
760}
761
762llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
763 llvm::DIFile Unit) {
764 SmallVector<llvm::Value *, 16> EltTys;
765
766 // Add the result type at least.
David Blaikie47251962013-08-22 13:36:01 +0000767 EltTys.push_back(getOrCreateType(Ty->getResultType(), Unit));
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000768
769 // Set up remainder of arguments if there is a prototype.
770 // FIXME: IF NOT, HOW IS THIS REPRESENTED? llvm-gcc doesn't represent '...'!
771 if (isa<FunctionNoProtoType>(Ty))
772 EltTys.push_back(DBuilder.createUnspecifiedParameter());
773 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
774 for (unsigned i = 0, e = FPT->getNumArgs(); i != e; ++i)
David Blaikie47251962013-08-22 13:36:01 +0000775 EltTys.push_back(getOrCreateType(FPT->getArgType(i), Unit));
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000776 }
777
778 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
779 return DBuilder.createSubroutineType(Unit, EltTypeArray);
780}
781
782
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000783llvm::DIType CGDebugInfo::createFieldType(StringRef name,
784 QualType type,
785 uint64_t sizeInBitsOverride,
786 SourceLocation loc,
787 AccessSpecifier AS,
788 uint64_t offsetInBits,
789 llvm::DIFile tunit,
790 llvm::DIDescriptor scope) {
791 llvm::DIType debugType = getOrCreateType(type, tunit);
792
793 // Get the location for the field.
794 llvm::DIFile file = getOrCreateFile(loc);
795 unsigned line = getLineNumber(loc);
796
797 uint64_t sizeInBits = 0;
798 unsigned alignInBits = 0;
799 if (!type->isIncompleteArrayType()) {
800 llvm::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
801
802 if (sizeInBitsOverride)
803 sizeInBits = sizeInBitsOverride;
804 }
805
806 unsigned flags = 0;
807 if (AS == clang::AS_private)
808 flags |= llvm::DIDescriptor::FlagPrivate;
809 else if (AS == clang::AS_protected)
810 flags |= llvm::DIDescriptor::FlagProtected;
811
812 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
813 alignInBits, offsetInBits, flags, debugType);
814}
815
Eric Christopher0395de32013-01-16 01:22:32 +0000816/// CollectRecordLambdaFields - Helper for CollectRecordFields.
817void CGDebugInfo::
818CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
819 SmallVectorImpl<llvm::Value *> &elements,
820 llvm::DIType RecordTy) {
821 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
822 // has the name and the location of the variable so we should iterate over
823 // both concurrently.
824 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
825 RecordDecl::field_iterator Field = CXXDecl->field_begin();
826 unsigned fieldno = 0;
827 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
828 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
829 const LambdaExpr::Capture C = *I;
830 if (C.capturesVariable()) {
831 VarDecl *V = C.getCapturedVar();
832 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
833 StringRef VName = V->getName();
834 uint64_t SizeInBitsOverride = 0;
835 if (Field->isBitField()) {
836 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
837 assert(SizeInBitsOverride && "found named 0-width bitfield");
838 }
839 llvm::DIType fieldType
840 = createFieldType(VName, Field->getType(), SizeInBitsOverride,
841 C.getLocation(), Field->getAccess(),
842 layout.getFieldOffset(fieldno), VUnit, RecordTy);
843 elements.push_back(fieldType);
844 } else {
845 // TODO: Need to handle 'this' in some way by probably renaming the
846 // this of the lambda class and having a field member of 'this' or
847 // by using AT_object_pointer for the function and having that be
848 // used as 'this' for semantic references.
849 assert(C.capturesThis() && "Field that isn't captured and isn't this?");
850 FieldDecl *f = *Field;
851 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
852 QualType type = f->getType();
853 llvm::DIType fieldType
854 = createFieldType("this", type, 0, f->getLocation(), f->getAccess(),
855 layout.getFieldOffset(fieldno), VUnit, RecordTy);
856
857 elements.push_back(fieldType);
858 }
859 }
860}
861
David Blaikie5434fc22013-08-20 01:28:15 +0000862/// Helper for CollectRecordFields.
David Blaikiecbcb0302013-08-15 22:50:29 +0000863llvm::DIDerivedType
864CGDebugInfo::CreateRecordStaticField(const VarDecl *Var,
865 llvm::DIType RecordTy) {
Eric Christopher0395de32013-01-16 01:22:32 +0000866 // Create the descriptor for the static variable, with or without
867 // constant initializers.
868 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
869 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
870
Eric Christopher0395de32013-01-16 01:22:32 +0000871 unsigned LineNumber = getLineNumber(Var->getLocation());
872 StringRef VName = Var->getName();
David Blaikiea89701b2013-01-20 01:19:17 +0000873 llvm::Constant *C = NULL;
Eric Christopher0395de32013-01-16 01:22:32 +0000874 if (Var->getInit()) {
875 const APValue *Value = Var->evaluateValue();
David Blaikiea89701b2013-01-20 01:19:17 +0000876 if (Value) {
877 if (Value->isInt())
878 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
879 if (Value->isFloat())
880 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
881 }
Eric Christopher0395de32013-01-16 01:22:32 +0000882 }
883
884 unsigned Flags = 0;
885 AccessSpecifier Access = Var->getAccess();
886 if (Access == clang::AS_private)
887 Flags |= llvm::DIDescriptor::FlagPrivate;
888 else if (Access == clang::AS_protected)
889 Flags |= llvm::DIDescriptor::FlagProtected;
890
David Blaikiecbcb0302013-08-15 22:50:29 +0000891 llvm::DIDerivedType GV = DBuilder.createStaticMemberType(
892 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Eric Christopher0395de32013-01-16 01:22:32 +0000893 StaticDataMemberCache[Var->getCanonicalDecl()] = llvm::WeakVH(GV);
David Blaikiecbcb0302013-08-15 22:50:29 +0000894 return GV;
Eric Christopher0395de32013-01-16 01:22:32 +0000895}
896
897/// CollectRecordNormalField - Helper for CollectRecordFields.
898void CGDebugInfo::
899CollectRecordNormalField(const FieldDecl *field, uint64_t OffsetInBits,
900 llvm::DIFile tunit,
901 SmallVectorImpl<llvm::Value *> &elements,
902 llvm::DIType RecordTy) {
903 StringRef name = field->getName();
904 QualType type = field->getType();
905
906 // Ignore unnamed fields unless they're anonymous structs/unions.
907 if (name.empty() && !type->isRecordType())
908 return;
909
910 uint64_t SizeInBitsOverride = 0;
911 if (field->isBitField()) {
912 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
913 assert(SizeInBitsOverride && "found named 0-width bitfield");
914 }
915
916 llvm::DIType fieldType
917 = createFieldType(name, type, SizeInBitsOverride,
918 field->getLocation(), field->getAccess(),
919 OffsetInBits, tunit, RecordTy);
920
921 elements.push_back(fieldType);
922}
923
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000924/// CollectRecordFields - A helper function to collect debug info for
925/// record fields. This is used while creating debug info entry for a Record.
David Blaikie841fd112013-08-16 20:40:25 +0000926void CGDebugInfo::CollectRecordFields(const RecordDecl *record,
927 llvm::DIFile tunit,
928 SmallVectorImpl<llvm::Value *> &elements,
929 llvm::DICompositeType RecordTy) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000930 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
931
Eric Christopher0395de32013-01-16 01:22:32 +0000932 if (CXXDecl && CXXDecl->isLambda())
933 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
934 else {
935 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000936
Eric Christopher0395de32013-01-16 01:22:32 +0000937 // Field number for non-static fields.
Eric Christopherfd5ac0d2013-01-04 17:59:07 +0000938 unsigned fieldNo = 0;
Eric Christopher0395de32013-01-16 01:22:32 +0000939
Eric Christopher0395de32013-01-16 01:22:32 +0000940 // Static and non-static members should appear in the same order as
941 // the corresponding declarations in the source program.
942 for (RecordDecl::decl_iterator I = record->decls_begin(),
943 E = record->decls_end(); I != E; ++I)
David Blaikie5e6937b2013-08-20 21:49:21 +0000944 if (const VarDecl *V = dyn_cast<VarDecl>(*I)) {
945 // Reuse the existing static member declaration if one exists
946 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
947 StaticDataMemberCache.find(V->getCanonicalDecl());
948 if (MI != StaticDataMemberCache.end()) {
949 assert(MI->second &&
950 "Static data member declaration should still exist");
951 elements.push_back(
952 llvm::DIDerivedType(cast<llvm::MDNode>(MI->second)));
953 } else
954 elements.push_back(CreateRecordStaticField(V, RecordTy));
955 } else if (FieldDecl *field = dyn_cast<FieldDecl>(*I)) {
Eric Christopher0395de32013-01-16 01:22:32 +0000956 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo),
957 tunit, elements, RecordTy);
958
959 // Bump field number for next field.
960 ++fieldNo;
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000961 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000962 }
963}
964
965/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
966/// function type is not updated to include implicit "this" pointer. Use this
967/// routine to get a method type which includes "this" pointer.
David Blaikie9a845292013-05-22 23:22:42 +0000968llvm::DICompositeType
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000969CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
970 llvm::DIFile Unit) {
David Blaikie9c78f9b2013-01-07 23:06:35 +0000971 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie67f8b5e2013-01-07 22:24:59 +0000972 if (Method->isStatic())
David Blaikie9a845292013-05-22 23:22:42 +0000973 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie9c78f9b2013-01-07 23:06:35 +0000974 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
975 Func, Unit);
976}
David Blaikie67f8b5e2013-01-07 22:24:59 +0000977
David Blaikie9a845292013-05-22 23:22:42 +0000978llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie9c78f9b2013-01-07 23:06:35 +0000979 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000980 // Add "this" pointer.
David Blaikie9c78f9b2013-01-07 23:06:35 +0000981 llvm::DIArray Args = llvm::DICompositeType(
982 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000983 assert (Args.getNumElements() && "Invalid number of arguments!");
984
985 SmallVector<llvm::Value *, 16> Elts;
986
987 // First element is always return type. For 'void' functions it is NULL.
988 Elts.push_back(Args.getElement(0));
989
David Blaikie67f8b5e2013-01-07 22:24:59 +0000990 // "this" pointer is always first argument.
David Blaikie9c78f9b2013-01-07 23:06:35 +0000991 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie67f8b5e2013-01-07 22:24:59 +0000992 if (isa<ClassTemplateSpecializationDecl>(RD)) {
993 // Create pointer type directly in this case.
994 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
995 QualType PointeeTy = ThisPtrTy->getPointeeType();
996 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCall64aa4b32013-04-16 22:48:15 +0000997 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie67f8b5e2013-01-07 22:24:59 +0000998 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
999 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopherf0890c42013-05-16 00:52:20 +00001000 llvm::DIType ThisPtrType =
1001 DBuilder.createPointerType(PointeeType, Size, Align);
David Blaikie67f8b5e2013-01-07 22:24:59 +00001002 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1003 // TODO: This and the artificial type below are misleading, the
1004 // types aren't artificial the argument is, but the current
1005 // metadata doesn't represent that.
1006 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1007 Elts.push_back(ThisPtrType);
1008 } else {
1009 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
1010 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1011 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1012 Elts.push_back(ThisPtrType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001013 }
1014
1015 // Copy rest of the arguments.
1016 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
1017 Elts.push_back(Args.getElement(i));
1018
1019 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1020
1021 return DBuilder.createSubroutineType(Unit, EltTypeArray);
1022}
1023
Eric Christopher6537f082013-05-16 00:45:12 +00001024/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001025/// inside a function.
1026static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1027 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1028 return isFunctionLocalClass(NRD);
1029 if (isa<FunctionDecl>(RD->getDeclContext()))
1030 return true;
1031 return false;
1032}
1033
1034/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1035/// a single member function GlobalDecl.
1036llvm::DISubprogram
1037CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
1038 llvm::DIFile Unit,
1039 llvm::DIType RecordTy) {
Eric Christopher6537f082013-05-16 00:45:12 +00001040 bool IsCtorOrDtor =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001041 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopher6537f082013-05-16 00:45:12 +00001042
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001043 StringRef MethodName = getFunctionName(Method);
David Blaikie9a845292013-05-22 23:22:42 +00001044 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001045
1046 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1047 // make sense to give a single ctor/dtor a linkage name.
1048 StringRef MethodLinkageName;
1049 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1050 MethodLinkageName = CGM.getMangledName(Method);
1051
1052 // Get the location for the method.
David Blaikiefc946272013-08-19 03:37:48 +00001053 llvm::DIFile MethodDefUnit;
1054 unsigned MethodLine = 0;
1055 if (!Method->isImplicit()) {
1056 MethodDefUnit = getOrCreateFile(Method->getLocation());
1057 MethodLine = getLineNumber(Method->getLocation());
1058 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001059
1060 // Collect virtual method info.
1061 llvm::DIType ContainingType;
Eric Christopher6537f082013-05-16 00:45:12 +00001062 unsigned Virtuality = 0;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001063 unsigned VIndex = 0;
Eric Christopher6537f082013-05-16 00:45:12 +00001064
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001065 if (Method->isVirtual()) {
1066 if (Method->isPure())
1067 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1068 else
1069 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopher6537f082013-05-16 00:45:12 +00001070
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001071 // It doesn't make sense to give a virtual destructor a vtable index,
1072 // since a single destructor has two entries in the vtable.
1073 if (!isa<CXXDestructorDecl>(Method))
1074 VIndex = CGM.getVTableContext().getMethodVTableIndex(Method);
1075 ContainingType = RecordTy;
1076 }
1077
1078 unsigned Flags = 0;
1079 if (Method->isImplicit())
1080 Flags |= llvm::DIDescriptor::FlagArtificial;
1081 AccessSpecifier Access = Method->getAccess();
1082 if (Access == clang::AS_private)
1083 Flags |= llvm::DIDescriptor::FlagPrivate;
1084 else if (Access == clang::AS_protected)
1085 Flags |= llvm::DIDescriptor::FlagProtected;
1086 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1087 if (CXXC->isExplicit())
1088 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopher6537f082013-05-16 00:45:12 +00001089 } else if (const CXXConversionDecl *CXXC =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001090 dyn_cast<CXXConversionDecl>(Method)) {
1091 if (CXXC->isExplicit())
1092 Flags |= llvm::DIDescriptor::FlagExplicit;
1093 }
1094 if (Method->hasPrototype())
1095 Flags |= llvm::DIDescriptor::FlagPrototyped;
1096
1097 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1098 llvm::DISubprogram SP =
Eric Christopher6537f082013-05-16 00:45:12 +00001099 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001100 MethodDefUnit, MethodLine,
Eric Christopher6537f082013-05-16 00:45:12 +00001101 MethodTy, /*isLocalToUnit=*/false,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001102 /* isDefinition=*/ false,
1103 Virtuality, VIndex, ContainingType,
1104 Flags, CGM.getLangOpts().Optimize, NULL,
1105 TParamsArray);
Eric Christopher6537f082013-05-16 00:45:12 +00001106
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001107 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
1108
1109 return SP;
1110}
1111
1112/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopher6537f082013-05-16 00:45:12 +00001113/// C++ member functions. This is used while creating debug info entry for
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001114/// a Record.
1115void CGDebugInfo::
1116CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
1117 SmallVectorImpl<llvm::Value *> &EltTys,
1118 llvm::DIType RecordTy) {
1119
1120 // Since we want more than just the individual member decls if we
1121 // have templated functions iterate over every declaration to gather
1122 // the functions.
1123 for(DeclContext::decl_iterator I = RD->decls_begin(),
1124 E = RD->decls_end(); I != E; ++I) {
David Blaikiec5761272013-08-28 17:27:13 +00001125 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(*I)) {
David Blaikie5e6937b2013-08-20 21:49:21 +00001126 // Reuse the existing member function declaration if it exists
David Blaikie4a684912013-08-28 20:24:55 +00001127 // It may be associated with the declaration of the type & should be
1128 // reused as we're building the definition.
David Blaikie5434fc22013-08-20 01:28:15 +00001129 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
1130 SPCache.find(Method->getCanonicalDecl());
David Blaikiec5761272013-08-28 17:27:13 +00001131 if (MI == SPCache.end()) {
David Blaikie4a684912013-08-28 20:24:55 +00001132 // If the member is implicit, lazily create it when we see the
1133 // definition, not before. (an ODR-used implicit default ctor that's
1134 // never actually code generated should not produce debug info)
David Blaikiec5761272013-08-28 17:27:13 +00001135 if (!Method->isImplicit())
1136 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
1137 } else
David Blaikie5434fc22013-08-20 01:28:15 +00001138 EltTys.push_back(MI->second);
1139 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001140 }
Eric Christopher6537f082013-05-16 00:45:12 +00001141}
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001142
1143/// CollectCXXFriends - A helper function to collect debug info for
1144/// C++ base classes. This is used while creating debug info entry for
1145/// a Record.
1146void CGDebugInfo::
1147CollectCXXFriends(const CXXRecordDecl *RD, llvm::DIFile Unit,
1148 SmallVectorImpl<llvm::Value *> &EltTys,
1149 llvm::DIType RecordTy) {
1150 for (CXXRecordDecl::friend_iterator BI = RD->friend_begin(),
1151 BE = RD->friend_end(); BI != BE; ++BI) {
1152 if ((*BI)->isUnsupportedFriend())
1153 continue;
1154 if (TypeSourceInfo *TInfo = (*BI)->getFriendType())
David Blaikie3de73f02013-08-18 04:50:23 +00001155 EltTys.push_back(DBuilder.createFriend(
David Blaikie47251962013-08-22 13:36:01 +00001156 RecordTy, getOrCreateType(TInfo->getType(), Unit)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001157 }
1158}
1159
1160/// CollectCXXBases - A helper function to collect debug info for
Eric Christopher6537f082013-05-16 00:45:12 +00001161/// C++ base classes. This is used while creating debug info entry for
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001162/// a Record.
1163void CGDebugInfo::
1164CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1165 SmallVectorImpl<llvm::Value *> &EltTys,
1166 llvm::DIType RecordTy) {
1167
1168 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1169 for (CXXRecordDecl::base_class_const_iterator BI = RD->bases_begin(),
1170 BE = RD->bases_end(); BI != BE; ++BI) {
1171 unsigned BFlags = 0;
1172 uint64_t BaseOffset;
Eric Christopher6537f082013-05-16 00:45:12 +00001173
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001174 const CXXRecordDecl *Base =
1175 cast<CXXRecordDecl>(BI->getType()->getAs<RecordType>()->getDecl());
Eric Christopher6537f082013-05-16 00:45:12 +00001176
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001177 if (BI->isVirtual()) {
1178 // virtual base offset offset is -ve. The code generator emits dwarf
1179 // expression where it expects +ve number.
Eric Christopher6537f082013-05-16 00:45:12 +00001180 BaseOffset =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001181 0 - CGM.getVTableContext()
1182 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1183 BFlags = llvm::DIDescriptor::FlagVirtual;
1184 } else
1185 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1186 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1187 // BI->isVirtual() and bits when not.
Eric Christopher6537f082013-05-16 00:45:12 +00001188
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001189 AccessSpecifier Access = BI->getAccessSpecifier();
1190 if (Access == clang::AS_private)
1191 BFlags |= llvm::DIDescriptor::FlagPrivate;
1192 else if (Access == clang::AS_protected)
1193 BFlags |= llvm::DIDescriptor::FlagProtected;
Eric Christopher6537f082013-05-16 00:45:12 +00001194
1195 llvm::DIType DTy =
1196 DBuilder.createInheritance(RecordTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001197 getOrCreateType(BI->getType(), Unit),
1198 BaseOffset, BFlags);
1199 EltTys.push_back(DTy);
1200 }
1201}
1202
1203/// CollectTemplateParams - A helper function to collect template parameters.
1204llvm::DIArray CGDebugInfo::
1205CollectTemplateParams(const TemplateParameterList *TPList,
David Blaikie35178dc2013-06-22 18:59:18 +00001206 ArrayRef<TemplateArgument> TAList,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001207 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001208 SmallVector<llvm::Value *, 16> TemplateParams;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001209 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1210 const TemplateArgument &TA = TAList[i];
David Blaikie35178dc2013-06-22 18:59:18 +00001211 StringRef Name;
1212 if (TPList)
1213 Name = TPList->getParam(i)->getName();
David Blaikie9dfd2432013-05-10 21:53:14 +00001214 switch (TA.getKind()) {
1215 case TemplateArgument::Type: {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001216 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1217 llvm::DITemplateTypeParameter TTP =
David Blaikie35178dc2013-06-22 18:59:18 +00001218 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001219 TemplateParams.push_back(TTP);
David Blaikie9dfd2432013-05-10 21:53:14 +00001220 } break;
1221 case TemplateArgument::Integral: {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001222 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1223 llvm::DITemplateValueParameter TVP =
David Blaikie9dfd2432013-05-10 21:53:14 +00001224 DBuilder.createTemplateValueParameter(
David Blaikie35178dc2013-06-22 18:59:18 +00001225 TheCU, Name, TTy,
David Blaikie9dfd2432013-05-10 21:53:14 +00001226 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1227 TemplateParams.push_back(TVP);
1228 } break;
1229 case TemplateArgument::Declaration: {
1230 const ValueDecl *D = TA.getAsDecl();
1231 bool InstanceMember = D->isCXXInstanceMember();
1232 QualType T = InstanceMember
1233 ? CGM.getContext().getMemberPointerType(
1234 D->getType(), cast<RecordDecl>(D->getDeclContext())
1235 ->getTypeForDecl())
1236 : CGM.getContext().getPointerType(D->getType());
1237 llvm::DIType TTy = getOrCreateType(T, Unit);
1238 llvm::Value *V = 0;
1239 // Variable pointer template parameters have a value that is the address
1240 // of the variable.
1241 if (const VarDecl *VD = dyn_cast<VarDecl>(D))
1242 V = CGM.GetAddrOfGlobalVar(VD);
1243 // Member function pointers have special support for building them, though
1244 // this is currently unsupported in LLVM CodeGen.
David Blaikief8aa1552013-05-13 06:57:50 +00001245 if (InstanceMember) {
David Blaikie9dfd2432013-05-10 21:53:14 +00001246 if (const CXXMethodDecl *method = dyn_cast<CXXMethodDecl>(D))
1247 V = CGM.getCXXABI().EmitMemberPointer(method);
David Blaikief8aa1552013-05-13 06:57:50 +00001248 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1249 V = CGM.GetAddrOfFunction(FD);
David Blaikie9dfd2432013-05-10 21:53:14 +00001250 // Member data pointers have special handling too to compute the fixed
1251 // offset within the object.
1252 if (isa<FieldDecl>(D)) {
1253 // These five lines (& possibly the above member function pointer
1254 // handling) might be able to be refactored to use similar code in
1255 // CodeGenModule::getMemberPointerConstant
1256 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1257 CharUnits chars =
1258 CGM.getContext().toCharUnitsFromBits((int64_t) fieldOffset);
1259 V = CGM.getCXXABI().EmitMemberDataPointer(
1260 cast<MemberPointerType>(T.getTypePtr()), chars);
1261 }
1262 llvm::DITemplateValueParameter TVP =
David Majnemer5db8b312013-08-25 22:13:27 +00001263 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1264 V->stripPointerCasts());
David Blaikie9dfd2432013-05-10 21:53:14 +00001265 TemplateParams.push_back(TVP);
1266 } break;
1267 case TemplateArgument::NullPtr: {
1268 QualType T = TA.getNullPtrType();
1269 llvm::DIType TTy = getOrCreateType(T, Unit);
1270 llvm::Value *V = 0;
1271 // Special case member data pointer null values since they're actually -1
1272 // instead of zero.
1273 if (const MemberPointerType *MPT =
1274 dyn_cast<MemberPointerType>(T.getTypePtr()))
1275 // But treat member function pointers as simple zero integers because
1276 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1277 // CodeGen grows handling for values of non-null member function
1278 // pointers then perhaps we could remove this special case and rely on
1279 // EmitNullMemberPointer for member function pointers.
1280 if (MPT->isMemberDataPointer())
1281 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1282 if (!V)
1283 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1284 llvm::DITemplateValueParameter TVP =
David Blaikie35178dc2013-06-22 18:59:18 +00001285 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V);
David Blaikie9dfd2432013-05-10 21:53:14 +00001286 TemplateParams.push_back(TVP);
1287 } break;
David Blaikie35178dc2013-06-22 18:59:18 +00001288 case TemplateArgument::Template: {
1289 llvm::DITemplateValueParameter TVP =
1290 DBuilder.createTemplateTemplateParameter(
1291 TheCU, Name, llvm::DIType(),
1292 TA.getAsTemplate().getAsTemplateDecl()
1293 ->getQualifiedNameAsString());
1294 TemplateParams.push_back(TVP);
1295 } break;
1296 case TemplateArgument::Pack: {
1297 llvm::DITemplateValueParameter TVP =
1298 DBuilder.createTemplateParameterPack(
1299 TheCU, Name, llvm::DIType(),
1300 CollectTemplateParams(NULL, TA.getPackAsArray(), Unit));
1301 TemplateParams.push_back(TVP);
1302 } break;
David Majnemer87b1f6d2013-08-24 08:21:10 +00001303 case TemplateArgument::Expression: {
1304 const Expr *E = TA.getAsExpr();
1305 QualType T = E->getType();
1306 llvm::Value *V = CGM.EmitConstantExpr(E, T);
1307 assert(V && "Expression in template argument isn't constant");
1308 llvm::DIType TTy = getOrCreateType(T, Unit);
1309 llvm::DITemplateValueParameter TVP =
1310 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1311 V->stripPointerCasts());
1312 TemplateParams.push_back(TVP);
1313 } break;
David Blaikiee8065122013-05-10 23:36:06 +00001314 // And the following should never occur:
David Blaikie9dfd2432013-05-10 21:53:14 +00001315 case TemplateArgument::TemplateExpansion:
David Blaikie9dfd2432013-05-10 21:53:14 +00001316 case TemplateArgument::Null:
1317 llvm_unreachable(
1318 "These argument types shouldn't exist in concrete types");
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001319 }
1320 }
1321 return DBuilder.getOrCreateArray(TemplateParams);
1322}
1323
1324/// CollectFunctionTemplateParams - A helper function to collect debug
1325/// info for function template parameters.
1326llvm::DIArray CGDebugInfo::
1327CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1328 if (FD->getTemplatedKind() ==
1329 FunctionDecl::TK_FunctionTemplateSpecialization) {
1330 const TemplateParameterList *TList =
1331 FD->getTemplateSpecializationInfo()->getTemplate()
1332 ->getTemplateParameters();
David Blaikie35178dc2013-06-22 18:59:18 +00001333 return CollectTemplateParams(
1334 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001335 }
1336 return llvm::DIArray();
1337}
1338
1339/// CollectCXXTemplateParams - A helper function to collect debug info for
1340/// template parameters.
1341llvm::DIArray CGDebugInfo::
1342CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1343 llvm::DIFile Unit) {
1344 llvm::PointerUnion<ClassTemplateDecl *,
1345 ClassTemplatePartialSpecializationDecl *>
1346 PU = TSpecial->getSpecializedTemplateOrPartial();
Eric Christopher6537f082013-05-16 00:45:12 +00001347
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001348 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1349 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1350 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1351 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
David Blaikie35178dc2013-06-22 18:59:18 +00001352 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001353}
1354
1355/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1356llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1357 if (VTablePtrType.isValid())
1358 return VTablePtrType;
1359
1360 ASTContext &Context = CGM.getContext();
1361
1362 /* Function type */
1363 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1364 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1365 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1366 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1367 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1368 "__vtbl_ptr_type");
1369 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1370 return VTablePtrType;
1371}
1372
1373/// getVTableName - Get vtable name for the given Class.
1374StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1375 // Construct gdb compatible name name.
1376 std::string Name = "_vptr$" + RD->getNameAsString();
1377
1378 // Copy this name on the side and use its reference.
1379 char *StrPtr = DebugInfoNames.Allocate<char>(Name.length());
1380 memcpy(StrPtr, Name.data(), Name.length());
1381 return StringRef(StrPtr, Name.length());
1382}
1383
1384
1385/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1386/// debug info entry in EltTys vector.
1387void CGDebugInfo::
1388CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1389 SmallVectorImpl<llvm::Value *> &EltTys) {
1390 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1391
1392 // If there is a primary base then it will hold vtable info.
1393 if (RL.getPrimaryBase())
1394 return;
1395
1396 // If this class is not dynamic then there is not any vtable info to collect.
1397 if (!RD->isDynamicClass())
1398 return;
1399
1400 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1401 llvm::DIType VPTR
1402 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Eric Christopherf0890c42013-05-16 00:52:20 +00001403 0, Size, 0, 0,
1404 llvm::DIDescriptor::FlagArtificial,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001405 getOrCreateVTablePtrType(Unit));
1406 EltTys.push_back(VPTR);
1407}
1408
Eric Christopher6537f082013-05-16 00:45:12 +00001409/// getOrCreateRecordType - Emit record type's standalone debug info.
1410llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001411 SourceLocation Loc) {
Eric Christopher13c97672013-05-16 00:45:23 +00001412 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001413 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1414 return T;
1415}
1416
1417/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1418/// debug info.
1419llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001420 SourceLocation Loc) {
Eric Christopher13c97672013-05-16 00:45:23 +00001421 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001422 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001423 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001424 return T;
1425}
1426
David Blaikie27804892013-08-15 20:49:17 +00001427void CGDebugInfo::completeType(const RecordDecl *RD) {
1428 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1429 !CGM.getLangOpts().CPlusPlus)
1430 completeRequiredType(RD);
1431}
1432
1433void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie5434fc22013-08-20 01:28:15 +00001434 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1435 if (CXXDecl->isDynamicClass())
1436 return;
1437
David Blaikie27804892013-08-15 20:49:17 +00001438 QualType Ty = CGM.getContext().getRecordType(RD);
1439 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie5434fc22013-08-20 01:28:15 +00001440 if (T && T.isForwardDecl())
1441 completeClassData(RD);
1442}
1443
1444void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1445 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman90e55232013-08-19 18:46:16 +00001446 return;
David Blaikie5434fc22013-08-20 01:28:15 +00001447 QualType Ty = CGM.getContext().getRecordType(RD);
David Blaikie27804892013-08-15 20:49:17 +00001448 void* TyPtr = Ty.getAsOpaquePtr();
1449 if (CompletedTypeCache.count(TyPtr))
1450 return;
1451 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1452 assert(!Res.isForwardDecl());
1453 CompletedTypeCache[TyPtr] = Res;
1454 TypeCache[TyPtr] = Res;
1455}
1456
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001457/// CreateType - get structure or union type.
David Blaikie47251962013-08-22 13:36:01 +00001458llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001459 RecordDecl *RD = Ty->getDecl();
David Blaikie5434fc22013-08-20 01:28:15 +00001460 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie47251962013-08-22 13:36:01 +00001461 // Always emit declarations for types that aren't required to be complete when
1462 // in limit-debug-info mode. If the type is later found to be required to be
1463 // complete this declaration will be upgraded to a definition by
1464 // `completeRequiredType`.
1465 // If the type is dynamic, only emit the definition in TUs that require class
1466 // data. This is handled by `completeClassData`.
1467 if ((DebugKind <= CodeGenOptions::LimitedDebugInfo &&
David Blaikie5434fc22013-08-20 01:28:15 +00001468 !RD->isCompleteDefinitionRequired() && CGM.getLangOpts().CPlusPlus) ||
1469 (CXXDecl && CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())) {
David Blaikie5f6e2f42013-06-05 05:32:23 +00001470 llvm::DIDescriptor FDContext =
1471 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
David Blaikie951094b2013-08-15 18:59:40 +00001472 llvm::DIType RetTy = getOrCreateRecordFwdDecl(RD, FDContext);
David Blaikie5434fc22013-08-20 01:28:15 +00001473 // FIXME: This is conservatively correct. If we return a non-forward decl
1474 // that's not a full definition (such as those created by
1475 // createContextChain) then getOrCreateType will record is as a complete
1476 // type and we'll never record all its members. But this means we're
1477 // emitting full debug info in TUs where GCC successfully emits a partial
1478 // definition of the type.
1479 if (RetTy.isForwardDecl())
1480 return RetTy;
David Blaikie5f6e2f42013-06-05 05:32:23 +00001481 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001482
David Blaikie27804892013-08-15 20:49:17 +00001483 return CreateTypeDefinition(Ty);
1484}
1485
1486llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1487 RecordDecl *RD = Ty->getDecl();
1488
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001489 // Get overall information about the record type for the debug info.
1490 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1491
1492 // Records and classes and unions can all be recursive. To handle them, we
1493 // first generate a debug descriptor for the struct as a forward declaration.
1494 // Then (if it is a definition) we go through and get debug info for all of
1495 // its members. Finally, we create a descriptor for the complete type (which
1496 // may refer to the forward decl if the struct is recursive) and replace all
1497 // uses of the forward declaration with the final definition.
1498
David Blaikie4a077162013-08-12 22:24:20 +00001499 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Renb6b0a712013-07-02 19:01:53 +00001500 assert(FwdDecl.isCompositeType() &&
David Blaikie9a845292013-05-22 23:22:42 +00001501 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001502
1503 if (FwdDecl.isForwardDecl())
1504 return FwdDecl;
1505
David Blaikie498298d2013-08-18 16:55:33 +00001506 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1507 CollectContainingType(CXXDecl, FwdDecl);
1508
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001509 // Push the struct on region stack.
Eric Christopherf068c922013-04-02 22:59:11 +00001510 LexicalBlockStack.push_back(&*FwdDecl);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001511 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1512
Adrian Prantl4919de62013-03-06 22:03:30 +00001513 // Add this to the completed-type cache while we're completing it recursively.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001514 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1515
1516 // Convert all the elements.
1517 SmallVector<llvm::Value *, 16> EltTys;
David Blaikie5434fc22013-08-20 01:28:15 +00001518 // what about nested types?
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001519
1520 // Note: The split of CXXDecl information here is intentional, the
1521 // gdb tests will depend on a certain ordering at printout. The debug
1522 // information offsets are still correct if we merge them all together
1523 // though.
1524 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1525 if (CXXDecl) {
1526 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1527 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1528 }
1529
Eric Christopher0395de32013-01-16 01:22:32 +00001530 // Collect data fields (including static variables and any initializers).
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001531 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001532 if (CXXDecl) {
1533 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
1534 CollectCXXFriends(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001535 }
1536
1537 LexicalBlockStack.pop_back();
1538 RegionMap.erase(Ty->getDecl());
1539
1540 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
David Blaikie80588332013-08-01 20:31:40 +00001541 FwdDecl.setTypeArray(Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001542
Eric Christopherf068c922013-04-02 22:59:11 +00001543 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1544 return FwdDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001545}
1546
1547/// CreateType - get objective-c object type.
1548llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1549 llvm::DIFile Unit) {
1550 // Ignore protocols.
1551 return getOrCreateType(Ty->getBaseType(), Unit);
1552}
1553
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001554
1555/// \return true if Getter has the default name for the property PD.
1556static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1557 const ObjCMethodDecl *Getter) {
1558 assert(PD);
1559 if (!Getter)
1560 return true;
1561
1562 assert(Getter->getDeclName().isObjCZeroArgSelector());
1563 return PD->getName() ==
1564 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
1565}
1566
1567/// \return true if Setter has the default name for the property PD.
1568static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1569 const ObjCMethodDecl *Setter) {
1570 assert(PD);
1571 if (!Setter)
1572 return true;
1573
1574 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantl80e8ea92013-06-07 22:29:12 +00001575 return SelectorTable::constructSetterName(PD->getName()) ==
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001576 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
1577}
1578
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001579/// CreateType - get objective-c interface type.
1580llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1581 llvm::DIFile Unit) {
1582 ObjCInterfaceDecl *ID = Ty->getDecl();
1583 if (!ID)
1584 return llvm::DIType();
1585
1586 // Get overall information about the record type for the debug info.
1587 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1588 unsigned Line = getLineNumber(ID->getLocation());
1589 unsigned RuntimeLang = TheCU.getLanguage();
1590
1591 // If this is just a forward declaration return a special forward-declaration
1592 // debug type since we won't be able to lay out the entire type.
1593 ObjCInterfaceDecl *Def = ID->getDefinition();
1594 if (!Def) {
1595 llvm::DIType FwdDecl =
1596 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001597 ID->getName(), TheCU, DefUnit, Line,
1598 RuntimeLang);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001599 return FwdDecl;
1600 }
1601
1602 ID = Def;
1603
1604 // Bit size, align and offset of the type.
1605 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1606 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1607
1608 unsigned Flags = 0;
1609 if (ID->getImplementation())
1610 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1611
Eric Christopherf068c922013-04-02 22:59:11 +00001612 llvm::DICompositeType RealDecl =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001613 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1614 Line, Size, Align, Flags,
David Blaikiec1d0af12013-02-25 01:07:08 +00001615 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001616
1617 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1618 // will find it and we're emitting the complete type.
Adrian Prantl4919de62013-03-06 22:03:30 +00001619 QualType QualTy = QualType(Ty, 0);
1620 CompletedTypeCache[QualTy.getAsOpaquePtr()] = RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001621
Eric Christopherd3003dc2013-07-14 21:00:07 +00001622 // Push the struct on region stack.
Eric Christopherf068c922013-04-02 22:59:11 +00001623 LexicalBlockStack.push_back(static_cast<llvm::MDNode*>(RealDecl));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001624 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1625
1626 // Convert all the elements.
1627 SmallVector<llvm::Value *, 16> EltTys;
1628
1629 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1630 if (SClass) {
1631 llvm::DIType SClassTy =
1632 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1633 if (!SClassTy.isValid())
1634 return llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001635
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001636 llvm::DIType InhTag =
1637 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1638 EltTys.push_back(InhTag);
1639 }
1640
Eric Christopherd3003dc2013-07-14 21:00:07 +00001641 // Create entries for all of the properties.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001642 for (ObjCContainerDecl::prop_iterator I = ID->prop_begin(),
1643 E = ID->prop_end(); I != E; ++I) {
1644 const ObjCPropertyDecl *PD = *I;
1645 SourceLocation Loc = PD->getLocation();
1646 llvm::DIFile PUnit = getOrCreateFile(Loc);
1647 unsigned PLine = getLineNumber(Loc);
1648 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1649 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1650 llvm::MDNode *PropertyNode =
1651 DBuilder.createObjCProperty(PD->getName(),
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001652 PUnit, PLine,
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001653 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001654 getSelectorName(PD->getGetterName()),
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001655 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001656 getSelectorName(PD->getSetterName()),
1657 PD->getPropertyAttributes(),
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001658 getOrCreateType(PD->getType(), PUnit));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001659 EltTys.push_back(PropertyNode);
1660 }
1661
1662 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1663 unsigned FieldNo = 0;
1664 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1665 Field = Field->getNextIvar(), ++FieldNo) {
1666 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1667 if (!FieldTy.isValid())
1668 return llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001669
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001670 StringRef FieldName = Field->getName();
1671
1672 // Ignore unnamed fields.
1673 if (FieldName.empty())
1674 continue;
1675
1676 // Get the location for the field.
1677 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1678 unsigned FieldLine = getLineNumber(Field->getLocation());
1679 QualType FType = Field->getType();
1680 uint64_t FieldSize = 0;
1681 unsigned FieldAlign = 0;
1682
1683 if (!FType->isIncompleteArrayType()) {
1684
1685 // Bit size, align and offset of the type.
1686 FieldSize = Field->isBitField()
Eric Christopherd3003dc2013-07-14 21:00:07 +00001687 ? Field->getBitWidthValue(CGM.getContext())
1688 : CGM.getContext().getTypeSize(FType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001689 FieldAlign = CGM.getContext().getTypeAlign(FType);
1690 }
1691
1692 uint64_t FieldOffset;
1693 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1694 // We don't know the runtime offset of an ivar if we're using the
1695 // non-fragile ABI. For bitfields, use the bit offset into the first
1696 // byte of storage of the bitfield. For other fields, use zero.
1697 if (Field->isBitField()) {
1698 FieldOffset = CGM.getObjCRuntime().ComputeBitfieldBitOffset(
1699 CGM, ID, Field);
1700 FieldOffset %= CGM.getContext().getCharWidth();
1701 } else {
1702 FieldOffset = 0;
1703 }
1704 } else {
1705 FieldOffset = RL.getFieldOffset(FieldNo);
1706 }
1707
1708 unsigned Flags = 0;
1709 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1710 Flags = llvm::DIDescriptor::FlagProtected;
1711 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1712 Flags = llvm::DIDescriptor::FlagPrivate;
1713
1714 llvm::MDNode *PropertyNode = NULL;
1715 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopher6537f082013-05-16 00:45:12 +00001716 if (ObjCPropertyImplDecl *PImpD =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001717 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1718 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001719 SourceLocation Loc = PD->getLocation();
1720 llvm::DIFile PUnit = getOrCreateFile(Loc);
1721 unsigned PLine = getLineNumber(Loc);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001722 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1723 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1724 PropertyNode =
1725 DBuilder.createObjCProperty(PD->getName(),
1726 PUnit, PLine,
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001727 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001728 getSelectorName(PD->getGetterName()),
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001729 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001730 getSelectorName(PD->getSetterName()),
1731 PD->getPropertyAttributes(),
1732 getOrCreateType(PD->getType(), PUnit));
1733 }
1734 }
1735 }
1736 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1737 FieldLine, FieldSize, FieldAlign,
1738 FieldOffset, Flags, FieldTy,
1739 PropertyNode);
1740 EltTys.push_back(FieldTy);
1741 }
1742
1743 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherf068c922013-04-02 22:59:11 +00001744 RealDecl.setTypeArray(Elements);
Adrian Prantl4919de62013-03-06 22:03:30 +00001745
1746 // If the implementation is not yet set, we do not want to mark it
1747 // as complete. An implementation may declare additional
1748 // private ivars that we would miss otherwise.
1749 if (ID->getImplementation() == 0)
1750 CompletedTypeCache.erase(QualTy.getAsOpaquePtr());
Eric Christopher6537f082013-05-16 00:45:12 +00001751
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001752 LexicalBlockStack.pop_back();
Eric Christopherf068c922013-04-02 22:59:11 +00001753 return RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001754}
1755
1756llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1757 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1758 int64_t Count = Ty->getNumElements();
1759 if (Count == 0)
1760 // If number of elements are not known then this is an unbounded array.
1761 // Use Count == -1 to express such arrays.
1762 Count = -1;
1763
1764 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1765 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1766
1767 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1768 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1769
1770 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1771}
1772
1773llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1774 llvm::DIFile Unit) {
1775 uint64_t Size;
1776 uint64_t Align;
1777
1778 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1779 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1780 Size = 0;
1781 Align =
1782 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1783 } else if (Ty->isIncompleteArrayType()) {
1784 Size = 0;
1785 if (Ty->getElementType()->isIncompleteType())
1786 Align = 0;
1787 else
1788 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikie089db2e2013-05-09 20:48:12 +00001789 } else if (Ty->isIncompleteType()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001790 Size = 0;
1791 Align = 0;
1792 } else {
1793 // Size and align of the whole array, not the element type.
1794 Size = CGM.getContext().getTypeSize(Ty);
1795 Align = CGM.getContext().getTypeAlign(Ty);
1796 }
1797
1798 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1799 // interior arrays, do we care? Why aren't nested arrays represented the
1800 // obvious/recursive way?
1801 SmallVector<llvm::Value *, 8> Subscripts;
1802 QualType EltTy(Ty, 0);
1803 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1804 // If the number of elements is known, then count is that number. Otherwise,
1805 // it's -1. This allows us to represent a subrange with an array of 0
1806 // elements, like this:
1807 //
1808 // struct foo {
1809 // int x[0];
1810 // };
1811 int64_t Count = -1; // Count == -1 is an unbounded array.
1812 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1813 Count = CAT->getSize().getZExtValue();
Eric Christopher6537f082013-05-16 00:45:12 +00001814
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001815 // FIXME: Verify this is right for VLAs.
1816 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1817 EltTy = Ty->getElementType();
1818 }
1819
1820 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1821
Eric Christopher6537f082013-05-16 00:45:12 +00001822 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001823 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1824 SubscriptArray);
1825 return DbgTy;
1826}
1827
Eric Christopher6537f082013-05-16 00:45:12 +00001828llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001829 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001830 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001831 Ty, Ty->getPointeeType(), Unit);
1832}
1833
Eric Christopher6537f082013-05-16 00:45:12 +00001834llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001835 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001836 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001837 Ty, Ty->getPointeeType(), Unit);
1838}
1839
Eric Christopher6537f082013-05-16 00:45:12 +00001840llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001841 llvm::DIFile U) {
David Blaikiee8d75142013-01-19 19:20:56 +00001842 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1843 if (!Ty->getPointeeType()->isFunctionType())
1844 return DBuilder.createMemberPointerType(
David Blaikie47251962013-08-22 13:36:01 +00001845 getOrCreateType(Ty->getPointeeType(), U), ClassType);
David Blaikiee8d75142013-01-19 19:20:56 +00001846 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
1847 CGM.getContext().getPointerType(
1848 QualType(Ty->getClass(), Ty->getPointeeType().getCVRQualifiers())),
1849 Ty->getPointeeType()->getAs<FunctionProtoType>(), U),
1850 ClassType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001851}
1852
Eric Christopher6537f082013-05-16 00:45:12 +00001853llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001854 llvm::DIFile U) {
1855 // Ignore the atomic wrapping
1856 // FIXME: What is the correct representation?
1857 return getOrCreateType(Ty->getValueType(), U);
1858}
1859
1860/// CreateEnumType - get enumeration type.
1861llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
1862 uint64_t Size = 0;
1863 uint64_t Align = 0;
1864 if (!ED->getTypeForDecl()->isIncompleteType()) {
1865 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1866 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1867 }
1868
1869 // If this is just a forward declaration, construct an appropriately
1870 // marked node and just return it.
1871 if (!ED->getDefinition()) {
1872 llvm::DIDescriptor EDContext;
1873 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1874 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1875 unsigned Line = getLineNumber(ED->getLocation());
1876 StringRef EDName = ED->getName();
1877 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_enumeration_type,
1878 EDName, EDContext, DefUnit, Line, 0,
1879 Size, Align);
1880 }
1881
1882 // Create DIEnumerator elements for each enumerator.
1883 SmallVector<llvm::Value *, 16> Enumerators;
1884 ED = ED->getDefinition();
1885 for (EnumDecl::enumerator_iterator
1886 Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1887 Enum != EnumEnd; ++Enum) {
1888 Enumerators.push_back(
1889 DBuilder.createEnumerator(Enum->getName(),
David Blaikieac8f43c2013-06-24 07:13:13 +00001890 Enum->getInitVal().getSExtValue()));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001891 }
1892
1893 // Return a CompositeType for the enum itself.
1894 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1895
1896 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1897 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00001898 llvm::DIDescriptor EnumContext =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001899 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantl59d6a712013-04-19 19:56:39 +00001900 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001901 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001902 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001903 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1904 Size, Align, EltArray,
1905 ClassTy);
1906 return DbgTy;
1907}
1908
David Blaikie4b12be62013-01-21 04:37:12 +00001909static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1910 Qualifiers Quals;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001911 do {
David Blaikie4b12be62013-01-21 04:37:12 +00001912 Quals += T.getLocalQualifiers();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001913 QualType LastT = T;
1914 switch (T->getTypeClass()) {
1915 default:
David Blaikie4b12be62013-01-21 04:37:12 +00001916 return C.getQualifiedType(T.getTypePtr(), Quals);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001917 case Type::TemplateSpecialization:
1918 T = cast<TemplateSpecializationType>(T)->desugar();
1919 break;
1920 case Type::TypeOfExpr:
1921 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1922 break;
1923 case Type::TypeOf:
1924 T = cast<TypeOfType>(T)->getUnderlyingType();
1925 break;
1926 case Type::Decltype:
1927 T = cast<DecltypeType>(T)->getUnderlyingType();
1928 break;
1929 case Type::UnaryTransform:
1930 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1931 break;
1932 case Type::Attributed:
1933 T = cast<AttributedType>(T)->getEquivalentType();
1934 break;
1935 case Type::Elaborated:
1936 T = cast<ElaboratedType>(T)->getNamedType();
1937 break;
1938 case Type::Paren:
1939 T = cast<ParenType>(T)->getInnerType();
1940 break;
David Blaikie4b12be62013-01-21 04:37:12 +00001941 case Type::SubstTemplateTypeParm:
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001942 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001943 break;
1944 case Type::Auto:
David Blaikie91296482013-05-24 21:24:35 +00001945 QualType DT = cast<AutoType>(T)->getDeducedType();
1946 if (DT.isNull())
1947 return T;
1948 T = DT;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001949 break;
1950 }
Eric Christopher6537f082013-05-16 00:45:12 +00001951
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001952 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumid24c9ab2013-01-21 10:51:28 +00001953 (void)LastT;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001954 } while (true);
1955}
1956
Eric Christopherf0890c42013-05-16 00:52:20 +00001957/// getType - Get the type from the cache or return null type if it doesn't
1958/// exist.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001959llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
1960
1961 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001962 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopher6537f082013-05-16 00:45:12 +00001963
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001964 // Check for existing entry.
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001965 if (Ty->getTypeClass() == Type::ObjCInterface) {
1966 llvm::Value *V = getCachedInterfaceTypeOrNull(Ty);
1967 if (V)
1968 return llvm::DIType(cast<llvm::MDNode>(V));
1969 else return llvm::DIType();
1970 }
1971
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001972 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1973 TypeCache.find(Ty.getAsOpaquePtr());
1974 if (it != TypeCache.end()) {
1975 // Verify that the debug info still exists.
1976 if (llvm::Value *V = it->second)
1977 return llvm::DIType(cast<llvm::MDNode>(V));
1978 }
1979
1980 return llvm::DIType();
1981}
1982
1983/// getCompletedTypeOrNull - Get the type from the cache or return null if it
1984/// doesn't exist.
1985llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
1986
1987 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001988 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001989
1990 // Check for existing entry.
Adrian Prantl4919de62013-03-06 22:03:30 +00001991 llvm::Value *V = 0;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001992 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1993 CompletedTypeCache.find(Ty.getAsOpaquePtr());
Adrian Prantl4919de62013-03-06 22:03:30 +00001994 if (it != CompletedTypeCache.end())
1995 V = it->second;
1996 else {
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001997 V = getCachedInterfaceTypeOrNull(Ty);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001998 }
1999
Adrian Prantl4919de62013-03-06 22:03:30 +00002000 // Verify that any cached debug info still exists.
David Blaikie00383082013-08-13 04:21:38 +00002001 return llvm::DIType(cast_or_null<llvm::MDNode>(V));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002002}
2003
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002004/// getCachedInterfaceTypeOrNull - Get the type from the interface
2005/// cache, unless it needs to regenerated. Otherwise return null.
2006llvm::Value *CGDebugInfo::getCachedInterfaceTypeOrNull(QualType Ty) {
2007 // Is there a cached interface that hasn't changed?
2008 llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned > >
2009 ::iterator it1 = ObjCInterfaceCache.find(Ty.getAsOpaquePtr());
2010
2011 if (it1 != ObjCInterfaceCache.end())
2012 if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty))
2013 if (Checksum(Decl) == it1->second.second)
2014 // Return cached forward declaration.
2015 return it1->second.first;
2016
2017 return 0;
2018}
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002019
2020/// getOrCreateType - Get the type from the cache or create a new
2021/// one if necessary.
David Blaikie47251962013-08-22 13:36:01 +00002022llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002023 if (Ty.isNull())
2024 return llvm::DIType();
2025
2026 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00002027 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002028
David Blaikie47251962013-08-22 13:36:01 +00002029 if (llvm::DIType T = getCompletedTypeOrNull(Ty))
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002030 return T;
2031
2032 // Otherwise create the type.
David Blaikie47251962013-08-22 13:36:01 +00002033 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002034 void* TyPtr = Ty.getAsOpaquePtr();
2035
2036 // And update the type cache.
2037 TypeCache[TyPtr] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002038
David Blaikie492b1022013-08-15 21:21:19 +00002039 // FIXME: this getTypeOrNull call seems silly when we just inserted the type
2040 // into the cache - but getTypeOrNull has a special case for cached interface
2041 // types. We should probably just pull that out as a special case for the
2042 // "else" block below & skip the otherwise needless lookup.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002043 llvm::DIType TC = getTypeOrNull(Ty);
Eric Christopherb2d13922013-07-18 00:52:50 +00002044 if (TC && TC.isForwardDecl())
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002045 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
2046 else if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty)) {
2047 // Interface types may have elements added to them by a
2048 // subsequent implementation or extension, so we keep them in
2049 // the ObjCInterfaceCache together with a checksum. Instead of
Adrian Prantlf06989b2013-05-08 23:37:22 +00002050 // the (possibly) incomplete interface type, we return a forward
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002051 // declaration that gets RAUW'd in CGDebugInfo::finalize().
David Blaikiee2eb89a2013-05-21 18:29:40 +00002052 std::pair<llvm::WeakVH, unsigned> &V = ObjCInterfaceCache[TyPtr];
2053 if (V.first)
2054 return llvm::DIType(cast<llvm::MDNode>(V.first));
2055 TC = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2056 Decl->getName(), TheCU, Unit,
2057 getLineNumber(Decl->getLocation()),
2058 TheCU.getLanguage());
2059 // Store the forward declaration in the cache.
2060 V.first = TC;
2061 V.second = Checksum(Decl);
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002062
David Blaikiee2eb89a2013-05-21 18:29:40 +00002063 // Register the type for replacement in finalize().
2064 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
2065
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002066 return TC;
Adrian Prantl4919de62013-03-06 22:03:30 +00002067 }
2068
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002069 if (!Res.isForwardDecl())
Adrian Prantlebbd7e02013-03-11 18:33:46 +00002070 CompletedTypeCache[TyPtr] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002071
2072 return Res;
2073}
2074
Adrian Prantlb5a50072013-06-07 01:10:41 +00002075/// Currently the checksum of an interface includes the number of
2076/// ivars and property accessors.
Eric Christopher56b108a2013-06-07 22:54:39 +00002077unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl4f97f852013-06-07 01:10:48 +00002078 // The assumption is that the number of ivars can only increase
2079 // monotonically, so it is safe to just use their current number as
2080 // a checksum.
Adrian Prantlb5a50072013-06-07 01:10:41 +00002081 unsigned Sum = 0;
2082 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
2083 Ivar != 0; Ivar = Ivar->getNextIvar())
2084 ++Sum;
2085
2086 return Sum;
Adrian Prantl4919de62013-03-06 22:03:30 +00002087}
2088
2089ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2090 switch (Ty->getTypeClass()) {
2091 case Type::ObjCObjectPointer:
Eric Christopherf0890c42013-05-16 00:52:20 +00002092 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
2093 ->getPointeeType());
Adrian Prantl4919de62013-03-06 22:03:30 +00002094 case Type::ObjCInterface:
2095 return cast<ObjCInterfaceType>(Ty)->getDecl();
2096 default:
2097 return 0;
2098 }
2099}
2100
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002101/// CreateTypeNode - Create a new debug type node.
David Blaikie47251962013-08-22 13:36:01 +00002102llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002103 // Handle qualifiers, which recursively handles what they refer to.
2104 if (Ty.hasLocalQualifiers())
David Blaikie47251962013-08-22 13:36:01 +00002105 return CreateQualifiedType(Ty, Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002106
2107 const char *Diag = 0;
Eric Christopher6537f082013-05-16 00:45:12 +00002108
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002109 // Work out details of type.
2110 switch (Ty->getTypeClass()) {
2111#define TYPE(Class, Base)
2112#define ABSTRACT_TYPE(Class, Base)
2113#define NON_CANONICAL_TYPE(Class, Base)
2114#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2115#include "clang/AST/TypeNodes.def"
2116 llvm_unreachable("Dependent types cannot show up in debug information");
2117
2118 case Type::ExtVector:
2119 case Type::Vector:
2120 return CreateType(cast<VectorType>(Ty), Unit);
2121 case Type::ObjCObjectPointer:
2122 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2123 case Type::ObjCObject:
2124 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2125 case Type::ObjCInterface:
2126 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2127 case Type::Builtin:
2128 return CreateType(cast<BuiltinType>(Ty));
2129 case Type::Complex:
2130 return CreateType(cast<ComplexType>(Ty));
2131 case Type::Pointer:
2132 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner12df2462013-06-24 17:51:48 +00002133 case Type::Decayed:
2134 // Decayed types are just pointers in LLVM and DWARF.
2135 return CreateType(
2136 cast<PointerType>(cast<DecayedType>(Ty)->getDecayedType()), Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002137 case Type::BlockPointer:
2138 return CreateType(cast<BlockPointerType>(Ty), Unit);
2139 case Type::Typedef:
David Blaikie47251962013-08-22 13:36:01 +00002140 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002141 case Type::Record:
David Blaikie47251962013-08-22 13:36:01 +00002142 return CreateType(cast<RecordType>(Ty));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002143 case Type::Enum:
2144 return CreateEnumType(cast<EnumType>(Ty)->getDecl());
2145 case Type::FunctionProto:
2146 case Type::FunctionNoProto:
2147 return CreateType(cast<FunctionType>(Ty), Unit);
2148 case Type::ConstantArray:
2149 case Type::VariableArray:
2150 case Type::IncompleteArray:
2151 return CreateType(cast<ArrayType>(Ty), Unit);
2152
2153 case Type::LValueReference:
2154 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2155 case Type::RValueReference:
2156 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2157
2158 case Type::MemberPointer:
2159 return CreateType(cast<MemberPointerType>(Ty), Unit);
2160
2161 case Type::Atomic:
2162 return CreateType(cast<AtomicType>(Ty), Unit);
2163
2164 case Type::Attributed:
2165 case Type::TemplateSpecialization:
2166 case Type::Elaborated:
2167 case Type::Paren:
2168 case Type::SubstTemplateTypeParm:
2169 case Type::TypeOfExpr:
2170 case Type::TypeOf:
2171 case Type::Decltype:
2172 case Type::UnaryTransform:
David Blaikie226399c2013-07-13 21:08:08 +00002173 case Type::PackExpansion:
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002174 llvm_unreachable("type should have been unwrapped!");
David Blaikie91296482013-05-24 21:24:35 +00002175 case Type::Auto:
2176 Diag = "auto";
2177 break;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002178 }
Eric Christopher6537f082013-05-16 00:45:12 +00002179
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002180 assert(Diag && "Fall through without a diagnostic?");
2181 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2182 "debug information for %0 is not yet supported");
2183 CGM.getDiags().Report(DiagID)
2184 << Diag;
2185 return llvm::DIType();
2186}
2187
2188/// getOrCreateLimitedType - Get the type from the cache or create a new
2189/// limited type if necessary.
David Blaikie4a077162013-08-12 22:24:20 +00002190llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002191 llvm::DIFile Unit) {
David Blaikie4a077162013-08-12 22:24:20 +00002192 QualType QTy(Ty, 0);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002193
David Blaikieeaacc882013-08-20 21:03:29 +00002194 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002195
2196 // We may have cached a forward decl when we could have created
2197 // a non-forward decl. Go ahead and create a non-forward decl
2198 // now.
Eric Christopherb2d13922013-07-18 00:52:50 +00002199 if (T && !T.isForwardDecl()) return T;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002200
2201 // Otherwise create the type.
David Blaikieeaacc882013-08-20 21:03:29 +00002202 llvm::DICompositeType Res = CreateLimitedType(Ty);
2203
2204 // Propagate members from the declaration to the definition
2205 // CreateType(const RecordType*) will overwrite this with the members in the
2206 // correct order if the full type is needed.
2207 Res.setTypeArray(T.getTypeArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002208
Eric Christopherb2d13922013-07-18 00:52:50 +00002209 if (T && T.isForwardDecl())
David Blaikie4a077162013-08-12 22:24:20 +00002210 ReplaceMap.push_back(
2211 std::make_pair(QTy.getAsOpaquePtr(), static_cast<llvm::Value *>(T)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002212
2213 // And update the type cache.
David Blaikie4a077162013-08-12 22:24:20 +00002214 TypeCache[QTy.getAsOpaquePtr()] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002215 return Res;
2216}
2217
2218// TODO: Currently used for context chains when limiting debug info.
David Blaikieeaacc882013-08-20 21:03:29 +00002219llvm::DICompositeType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002220 RecordDecl *RD = Ty->getDecl();
Eric Christopher6537f082013-05-16 00:45:12 +00002221
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002222 // Get overall information about the record type for the debug info.
2223 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2224 unsigned Line = getLineNumber(RD->getLocation());
2225 StringRef RDName = getClassName(RD);
2226
2227 llvm::DIDescriptor RDContext;
Eric Christopher13c97672013-05-16 00:45:23 +00002228 if (DebugKind == CodeGenOptions::LimitedDebugInfo)
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002229 RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
2230 else
2231 RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
2232
David Blaikiec138ff52013-08-18 17:36:19 +00002233 // If we ended up creating the type during the context chain construction,
2234 // just return that.
2235 // FIXME: this could be dealt with better if the type was recorded as
2236 // completed before we started this (see the CompletedTypeCache usage in
2237 // CGDebugInfo::CreateTypeDefinition(const RecordType*) - that would need to
2238 // be pushed to before context creation, but after it was known to be
2239 // destined for completion (might still have an issue if this caller only
2240 // required a declaration but the context construction ended up creating a
2241 // definition)
David Blaikieeaacc882013-08-20 21:03:29 +00002242 llvm::DICompositeType T(getTypeOrNull(CGM.getContext().getRecordType(RD)));
2243 if (T && (!T.isForwardDecl() || !RD->getDefinition()))
David Blaikiec138ff52013-08-18 17:36:19 +00002244 return T;
2245
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002246 // If this is just a forward declaration, construct an appropriately
2247 // marked node and just return it.
2248 if (!RD->getDefinition())
David Blaikie951094b2013-08-15 18:59:40 +00002249 return getOrCreateRecordFwdDecl(RD, RDContext);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002250
2251 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2252 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
David Blaikie2fcadbe2013-03-26 23:47:35 +00002253 llvm::DICompositeType RealDecl;
Eric Christopher6537f082013-05-16 00:45:12 +00002254
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002255 if (RD->isUnion())
2256 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002257 Size, Align, 0, llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002258 else if (RD->isClass()) {
2259 // FIXME: This could be a struct type giving a default visibility different
2260 // than C++ class type, but needs llvm metadata changes first.
2261 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002262 Size, Align, 0, 0, llvm::DIType(),
2263 llvm::DIArray(), llvm::DIType(),
2264 llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002265 } else
2266 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopherf0890c42013-05-16 00:52:20 +00002267 Size, Align, 0, llvm::DIType(),
2268 llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002269
2270 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie2fcadbe2013-03-26 23:47:35 +00002271 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002272
David Blaikie498298d2013-08-18 16:55:33 +00002273 if (const ClassTemplateSpecializationDecl *TSpecial =
2274 dyn_cast<ClassTemplateSpecializationDecl>(RD))
2275 RealDecl.setTypeArray(llvm::DIArray(),
2276 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikiefab829d2013-08-15 22:42:12 +00002277 return RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002278}
2279
David Blaikie498298d2013-08-18 16:55:33 +00002280void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2281 llvm::DICompositeType RealDecl) {
2282 // A class's primary base or the class itself contains the vtable.
2283 llvm::DICompositeType ContainingType;
2284 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2285 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
2286 // Seek non virtual primary base root.
2287 while (1) {
2288 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2289 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2290 if (PBT && !BRL.isPrimaryBaseVirtual())
2291 PBase = PBT;
2292 else
2293 break;
2294 }
2295 ContainingType = llvm::DICompositeType(
2296 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2297 getOrCreateFile(RD->getLocation())));
2298 } else if (RD->isDynamicClass())
2299 ContainingType = RealDecl;
2300
2301 RealDecl.setContainingType(ContainingType);
2302}
2303
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002304/// CreateMemberType - Create new member and increase Offset by FType's size.
2305llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2306 StringRef Name,
2307 uint64_t *Offset) {
2308 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2309 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2310 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2311 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2312 FieldSize, FieldAlign,
2313 *Offset, 0, FieldTy);
2314 *Offset += FieldSize;
2315 return Ty;
2316}
2317
David Blaikie9faebd22013-05-20 04:58:53 +00002318llvm::DIDescriptor CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
2319 // We only need a declaration (not a definition) of the type - so use whatever
2320 // we would otherwise do to get a type for a pointee. (forward declarations in
2321 // limited debug info, full definitions (if the type definition is available)
2322 // in unlimited debug info)
David Blaikieb3c23772013-08-12 23:14:36 +00002323 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2324 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie47251962013-08-22 13:36:01 +00002325 getOrCreateFile(TD->getLocation()));
David Blaikie9faebd22013-05-20 04:58:53 +00002326 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2327 // This doesn't handle providing declarations (for functions or variables) for
2328 // entities without definitions in this TU, nor when the definition proceeds
2329 // the call to this function.
2330 // FIXME: This should be split out into more specific maps with support for
2331 // emitting forward declarations and merging definitions with declarations,
2332 // the same way as we do for types.
2333 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2334 DeclCache.find(D->getCanonicalDecl());
2335 if (I == DeclCache.end())
2336 return llvm::DIDescriptor();
2337 llvm::Value *V = I->second;
2338 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(V));
2339}
2340
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002341/// getFunctionDeclaration - Return debug info descriptor to describe method
2342/// declaration for the given method definition.
2343llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
David Blaikie23e66db2013-06-22 00:09:36 +00002344 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2345 return llvm::DISubprogram();
2346
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002347 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2348 if (!FD) return llvm::DISubprogram();
2349
2350 // Setup context.
David Blaikied6d5d692013-08-09 17:20:05 +00002351 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002352
2353 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2354 MI = SPCache.find(FD->getCanonicalDecl());
David Blaikied6d5d692013-08-09 17:20:05 +00002355 if (MI == SPCache.end()) {
David Blaikie5434fc22013-08-20 01:28:15 +00002356 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikied6d5d692013-08-09 17:20:05 +00002357 llvm::DICompositeType T(S);
2358 llvm::DISubprogram SP = CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
2359 T.addMember(SP);
2360 return SP;
2361 }
2362 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002363 if (MI != SPCache.end()) {
2364 llvm::Value *V = MI->second;
2365 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie23e66db2013-06-22 00:09:36 +00002366 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002367 return SP;
2368 }
2369
2370 for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
2371 E = FD->redecls_end(); I != E; ++I) {
2372 const FunctionDecl *NextFD = *I;
2373 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2374 MI = SPCache.find(NextFD->getCanonicalDecl());
2375 if (MI != SPCache.end()) {
2376 llvm::Value *V = MI->second;
2377 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie23e66db2013-06-22 00:09:36 +00002378 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002379 return SP;
2380 }
2381 }
2382 return llvm::DISubprogram();
2383}
2384
2385// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2386// implicit parameter "this".
David Blaikie9a845292013-05-22 23:22:42 +00002387llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2388 QualType FnType,
2389 llvm::DIFile F) {
David Blaikie23e66db2013-06-22 00:09:36 +00002390 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2391 // Create fake but valid subroutine type. Otherwise
2392 // llvm::DISubprogram::Verify() would return false, and
2393 // subprogram DIE will miss DW_AT_decl_file and
2394 // DW_AT_decl_line fields.
2395 return DBuilder.createSubroutineType(F, DBuilder.getOrCreateArray(None));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002396
2397 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2398 return getOrCreateMethodType(Method, F);
2399 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2400 // Add "self" and "_cmd"
2401 SmallVector<llvm::Value *, 16> Elts;
2402
2403 // First element is always return type. For 'void' functions it is NULL.
Adrian Prantl0cb00022013-05-22 21:37:49 +00002404 QualType ResultTy = OMethod->getResultType();
2405
2406 // Replace the instancetype keyword with the actual type.
2407 if (ResultTy == CGM.getContext().getObjCInstanceType())
2408 ResultTy = CGM.getContext().getPointerType(
2409 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2410
Adrian Prantl566a9c32013-05-10 21:08:31 +00002411 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002412 // "self" pointer is always first argument.
Adrian Prantle86fcc42013-03-29 19:20:29 +00002413 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2414 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2415 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002416 // "_cmd" pointer is always second argument.
2417 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2418 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2419 // Get rest of the arguments.
Eric Christopher6537f082013-05-16 00:45:12 +00002420 for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002421 PE = OMethod->param_end(); PI != PE; ++PI)
2422 Elts.push_back(getOrCreateType((*PI)->getType(), F));
2423
2424 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2425 return DBuilder.createSubroutineType(F, EltTypeArray);
2426 }
David Blaikie9a845292013-05-22 23:22:42 +00002427 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002428}
2429
2430/// EmitFunctionStart - Constructs the debug code for entering a function.
2431void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
2432 llvm::Function *Fn,
2433 CGBuilderTy &Builder) {
2434
2435 StringRef Name;
2436 StringRef LinkageName;
2437
2438 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2439
2440 const Decl *D = GD.getDecl();
2441 // Function may lack declaration in source code if it is created by Clang
2442 // CodeGen (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
2443 bool HasDecl = (D != 0);
2444 // Use the location of the declaration.
2445 SourceLocation Loc;
2446 if (HasDecl)
2447 Loc = D->getLocation();
2448
2449 unsigned Flags = 0;
2450 llvm::DIFile Unit = getOrCreateFile(Loc);
2451 llvm::DIDescriptor FDContext(Unit);
2452 llvm::DIArray TParamsArray;
2453 if (!HasDecl) {
2454 // Use llvm function name.
David Blaikiec7971a92013-08-27 23:57:18 +00002455 LinkageName = Fn->getName();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002456 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2457 // If there is a DISubprogram for this function available then use it.
2458 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2459 FI = SPCache.find(FD->getCanonicalDecl());
2460 if (FI != SPCache.end()) {
2461 llvm::Value *V = FI->second;
2462 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2463 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2464 llvm::MDNode *SPN = SP;
2465 LexicalBlockStack.push_back(SPN);
2466 RegionMap[D] = llvm::WeakVH(SP);
2467 return;
2468 }
2469 }
2470 Name = getFunctionName(FD);
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002471 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002472 if (FD->hasPrototype()) {
2473 LinkageName = CGM.getMangledName(GD);
2474 Flags |= llvm::DIDescriptor::FlagPrototyped;
2475 }
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002476 // No need to replicate the linkage name if it isn't different from the
2477 // subprogram name, no need to have it at all unless coverage is enabled or
2478 // debug is set to more than just line tables.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002479 if (LinkageName == Name ||
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002480 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2481 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher13c97672013-05-16 00:45:23 +00002482 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002483 LinkageName = StringRef();
2484
Eric Christopher13c97672013-05-16 00:45:23 +00002485 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002486 if (const NamespaceDecl *NSDecl =
2487 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2488 FDContext = getOrCreateNameSpace(NSDecl);
2489 else if (const RecordDecl *RDecl =
2490 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2491 FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
2492
2493 // Collect template parameters.
2494 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2495 }
2496 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2497 Name = getObjCMethodName(OMD);
2498 Flags |= llvm::DIDescriptor::FlagPrototyped;
2499 } else {
2500 // Use llvm function name.
2501 Name = Fn->getName();
2502 Flags |= llvm::DIDescriptor::FlagPrototyped;
2503 }
2504 if (!Name.empty() && Name[0] == '\01')
2505 Name = Name.substr(1);
2506
2507 unsigned LineNo = getLineNumber(Loc);
2508 if (!HasDecl || D->isImplicit())
2509 Flags |= llvm::DIDescriptor::FlagArtificial;
2510
David Blaikie23e66db2013-06-22 00:09:36 +00002511 llvm::DISubprogram SP = DBuilder.createFunction(
2512 FDContext, Name, LinkageName, Unit, LineNo,
2513 getOrCreateFunctionType(D, FnType, Unit), Fn->hasInternalLinkage(),
2514 true /*definition*/, getLineNumber(CurLoc), Flags,
2515 CGM.getLangOpts().Optimize, Fn, TParamsArray, getFunctionDeclaration(D));
David Blaikie9faebd22013-05-20 04:58:53 +00002516 if (HasDecl)
2517 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002518
2519 // Push function on region stack.
2520 llvm::MDNode *SPN = SP;
2521 LexicalBlockStack.push_back(SPN);
2522 if (HasDecl)
2523 RegionMap[D] = llvm::WeakVH(SP);
2524}
2525
2526/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl18a0cd52013-07-18 00:27:59 +00002527/// information in the source file. If the location is invalid, the
2528/// previous location will be reused.
Adrian Prantl00df5ea2013-03-12 20:43:25 +00002529void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
2530 bool ForceColumnInfo) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002531 // Update our current location
2532 setLocation(Loc);
2533
2534 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2535
2536 // Don't bother if things are the same as last time.
2537 SourceManager &SM = CGM.getContext().getSourceManager();
2538 if (CurLoc == PrevLoc ||
2539 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2540 // New Builder may not be in sync with CGDebugInfo.
David Blaikie0a0f93c2013-02-01 19:09:49 +00002541 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2542 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2543 LexicalBlockStack.back())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002544 return;
Eric Christopher6537f082013-05-16 00:45:12 +00002545
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002546 // Update last state.
2547 PrevLoc = CurLoc;
2548
2549 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantl00df5ea2013-03-12 20:43:25 +00002550 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2551 (getLineNumber(CurLoc),
2552 getColumnNumber(CurLoc, ForceColumnInfo),
2553 Scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002554}
2555
2556/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2557/// the stack.
2558void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2559 llvm::DIDescriptor D =
2560 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2561 llvm::DIDescriptor() :
2562 llvm::DIDescriptor(LexicalBlockStack.back()),
2563 getOrCreateFile(CurLoc),
2564 getLineNumber(CurLoc),
2565 getColumnNumber(CurLoc));
2566 llvm::MDNode *DN = D;
2567 LexicalBlockStack.push_back(DN);
2568}
2569
2570/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2571/// region - beginning of a DW_TAG_lexical_block.
Eric Christopherf0890c42013-05-16 00:52:20 +00002572void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2573 SourceLocation Loc) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002574 // Set our current location.
2575 setLocation(Loc);
2576
2577 // Create a new lexical block and push it on the stack.
2578 CreateLexicalBlock(Loc);
2579
2580 // Emit a line table change for the current location inside the new scope.
2581 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2582 getColumnNumber(Loc),
2583 LexicalBlockStack.back()));
2584}
2585
2586/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2587/// region - end of a DW_TAG_lexical_block.
Eric Christopherf0890c42013-05-16 00:52:20 +00002588void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2589 SourceLocation Loc) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002590 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2591
2592 // Provide an entry in the line table for the end of the block.
2593 EmitLocation(Builder, Loc);
2594
2595 LexicalBlockStack.pop_back();
2596}
2597
2598/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2599void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2600 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2601 unsigned RCount = FnBeginRegionCount.back();
2602 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2603
2604 // Pop all regions for this function.
2605 while (LexicalBlockStack.size() != RCount)
2606 EmitLexicalBlockEnd(Builder, CurLoc);
2607 FnBeginRegionCount.pop_back();
2608}
2609
Eric Christopher6537f082013-05-16 00:45:12 +00002610// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002611// See BuildByRefType.
2612llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2613 uint64_t *XOffset) {
2614
2615 SmallVector<llvm::Value *, 5> EltTys;
2616 QualType FType;
2617 uint64_t FieldSize, FieldOffset;
2618 unsigned FieldAlign;
Eric Christopher6537f082013-05-16 00:45:12 +00002619
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002620 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00002621 QualType Type = VD->getType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002622
2623 FieldOffset = 0;
2624 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2625 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2626 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2627 FType = CGM.getContext().IntTy;
2628 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2629 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2630
2631 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2632 if (HasCopyAndDispose) {
2633 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2634 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2635 &FieldOffset));
2636 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2637 &FieldOffset));
2638 }
2639 bool HasByrefExtendedLayout;
2640 Qualifiers::ObjCLifetime Lifetime;
2641 if (CGM.getContext().getByrefLifetime(Type,
2642 Lifetime, HasByrefExtendedLayout)
Adrian Prantl1f437912013-07-23 00:12:14 +00002643 && HasByrefExtendedLayout) {
2644 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002645 EltTys.push_back(CreateMemberType(Unit, FType,
2646 "__byref_variable_layout",
2647 &FieldOffset));
Adrian Prantl1f437912013-07-23 00:12:14 +00002648 }
Eric Christopher6537f082013-05-16 00:45:12 +00002649
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002650 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2651 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCall64aa4b32013-04-16 22:48:15 +00002652 CGM.getTarget().getPointerAlign(0))) {
Eric Christopher6537f082013-05-16 00:45:12 +00002653 CharUnits FieldOffsetInBytes
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002654 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2655 CharUnits AlignedOffsetInBytes
2656 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2657 CharUnits NumPaddingBytes
2658 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopher6537f082013-05-16 00:45:12 +00002659
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002660 if (NumPaddingBytes.isPositive()) {
2661 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2662 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2663 pad, ArrayType::Normal, 0);
2664 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2665 }
2666 }
Eric Christopher6537f082013-05-16 00:45:12 +00002667
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002668 FType = Type;
2669 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2670 FieldSize = CGM.getContext().getTypeSize(FType);
2671 FieldAlign = CGM.getContext().toBits(Align);
2672
Eric Christopher6537f082013-05-16 00:45:12 +00002673 *XOffset = FieldOffset;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002674 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2675 0, FieldSize, FieldAlign,
2676 FieldOffset, 0, FieldTy);
2677 EltTys.push_back(FieldTy);
2678 FieldOffset += FieldSize;
Eric Christopher6537f082013-05-16 00:45:12 +00002679
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002680 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher6537f082013-05-16 00:45:12 +00002681
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002682 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopher6537f082013-05-16 00:45:12 +00002683
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002684 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikiec1d0af12013-02-25 01:07:08 +00002685 llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002686}
2687
2688/// EmitDeclare - Emit local variable declaration debug info.
2689void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Eric Christopher6537f082013-05-16 00:45:12 +00002690 llvm::Value *Storage,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002691 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002692 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002693 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2694
David Blaikiefc946272013-08-19 03:37:48 +00002695 bool Unwritten =
2696 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2697 cast<Decl>(VD->getDeclContext())->isImplicit());
2698 llvm::DIFile Unit;
2699 if (!Unwritten)
2700 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002701 llvm::DIType Ty;
2702 uint64_t XOffset = 0;
2703 if (VD->hasAttr<BlocksAttr>())
2704 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopher6537f082013-05-16 00:45:12 +00002705 else
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002706 Ty = getOrCreateType(VD->getType(), Unit);
2707
2708 // If there is no debug info for this type then do not emit debug info
2709 // for this variable.
2710 if (!Ty)
2711 return;
2712
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002713 // Get location information.
David Blaikiefc946272013-08-19 03:37:48 +00002714 unsigned Line = 0;
2715 unsigned Column = 0;
2716 if (!Unwritten) {
2717 Line = getLineNumber(VD->getLocation());
2718 Column = getColumnNumber(VD->getLocation());
2719 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002720 unsigned Flags = 0;
2721 if (VD->isImplicit())
2722 Flags |= llvm::DIDescriptor::FlagArtificial;
2723 // If this is the first argument and it is implicit then
2724 // give it an object pointer flag.
2725 // FIXME: There has to be a better way to do this, but for static
2726 // functions there won't be an implicit param at arg1 and
2727 // otherwise it is 'self' or 'this'.
2728 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2729 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikie41c9bae2013-06-19 21:53:53 +00002730 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopher7dab97b2013-07-17 22:52:53 +00002731 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2732 !VD->getType()->isPointerType())
David Blaikie41c9bae2013-06-19 21:53:53 +00002733 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002734
2735 llvm::MDNode *Scope = LexicalBlockStack.back();
2736
2737 StringRef Name = VD->getName();
2738 if (!Name.empty()) {
2739 if (VD->hasAttr<BlocksAttr>()) {
2740 CharUnits offset = CharUnits::fromQuantity(32);
2741 SmallVector<llvm::Value *, 9> addr;
2742 llvm::Type *Int64Ty = CGM.Int64Ty;
2743 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2744 // offset of __forwarding field
2745 offset = CGM.getContext().toCharUnitsFromBits(
John McCall64aa4b32013-04-16 22:48:15 +00002746 CGM.getTarget().getPointerWidth(0));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002747 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2748 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2749 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2750 // offset of x field
2751 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2752 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2753
2754 // Create the descriptor for the variable.
2755 llvm::DIVariable D =
Eric Christopher6537f082013-05-16 00:45:12 +00002756 DBuilder.createComplexVariable(Tag,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002757 llvm::DIDescriptor(Scope),
2758 VD->getName(), Unit, Line, Ty,
2759 addr, ArgNo);
Eric Christopher6537f082013-05-16 00:45:12 +00002760
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002761 // Insert an llvm.dbg.declare into the current block.
2762 llvm::Instruction *Call =
2763 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2764 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2765 return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002766 }
David Blaikie436653b2013-01-05 05:58:35 +00002767 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2768 // If VD is an anonymous union then Storage represents value for
2769 // all union fields.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002770 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikied8180cf2013-01-05 20:03:07 +00002771 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002772 for (RecordDecl::field_iterator I = RD->field_begin(),
2773 E = RD->field_end();
2774 I != E; ++I) {
2775 FieldDecl *Field = *I;
2776 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2777 StringRef FieldName = Field->getName();
Eric Christopher6537f082013-05-16 00:45:12 +00002778
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002779 // Ignore unnamed fields. Do not ignore unnamed records.
2780 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2781 continue;
Eric Christopher6537f082013-05-16 00:45:12 +00002782
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002783 // Use VarDecl's Tag, Scope and Line number.
2784 llvm::DIVariable D =
2785 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopher6537f082013-05-16 00:45:12 +00002786 FieldName, Unit, Line, FieldTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002787 CGM.getLangOpts().Optimize, Flags,
2788 ArgNo);
Eric Christopher6537f082013-05-16 00:45:12 +00002789
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002790 // Insert an llvm.dbg.declare into the current block.
2791 llvm::Instruction *Call =
2792 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2793 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2794 }
David Blaikied8180cf2013-01-05 20:03:07 +00002795 return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002796 }
2797 }
David Blaikie436653b2013-01-05 05:58:35 +00002798
2799 // Create the descriptor for the variable.
2800 llvm::DIVariable D =
2801 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2802 Name, Unit, Line, Ty,
2803 CGM.getLangOpts().Optimize, Flags, ArgNo);
2804
2805 // Insert an llvm.dbg.declare into the current block.
2806 llvm::Instruction *Call =
2807 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2808 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002809}
2810
2811void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2812 llvm::Value *Storage,
2813 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002814 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002815 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2816}
2817
Adrian Prantle86fcc42013-03-29 19:20:29 +00002818/// Look up the completed type for a self pointer in the TypeCache and
2819/// create a copy of it with the ObjectPointer and Artificial flags
2820/// set. If the type is not cached, a new one is created. This should
2821/// never happen though, since creating a type for the implicit self
2822/// argument implies that we already parsed the interface definition
2823/// and the ivar declarations in the implementation.
Eric Christopherf0890c42013-05-16 00:52:20 +00002824llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2825 llvm::DIType Ty) {
Adrian Prantle86fcc42013-03-29 19:20:29 +00002826 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christopherb2d13922013-07-18 00:52:50 +00002827 if (CachedTy) Ty = CachedTy;
Adrian Prantle86fcc42013-03-29 19:20:29 +00002828 else DEBUG(llvm::dbgs() << "No cached type for self.");
2829 return DBuilder.createObjectPointerType(Ty);
2830}
2831
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002832void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2833 llvm::Value *Storage,
2834 CGBuilderTy &Builder,
2835 const CGBlockInfo &blockInfo) {
Eric Christopher13c97672013-05-16 00:45:23 +00002836 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002837 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopher6537f082013-05-16 00:45:12 +00002838
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002839 if (Builder.GetInsertBlock() == 0)
2840 return;
Eric Christopher6537f082013-05-16 00:45:12 +00002841
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002842 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopher6537f082013-05-16 00:45:12 +00002843
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002844 uint64_t XOffset = 0;
2845 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2846 llvm::DIType Ty;
2847 if (isByRef)
2848 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopher6537f082013-05-16 00:45:12 +00002849 else
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002850 Ty = getOrCreateType(VD->getType(), Unit);
2851
2852 // Self is passed along as an implicit non-arg variable in a
2853 // block. Mark it as the object pointer.
2854 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantle86fcc42013-03-29 19:20:29 +00002855 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002856
2857 // Get location information.
2858 unsigned Line = getLineNumber(VD->getLocation());
2859 unsigned Column = getColumnNumber(VD->getLocation());
2860
2861 const llvm::DataLayout &target = CGM.getDataLayout();
2862
2863 CharUnits offset = CharUnits::fromQuantity(
2864 target.getStructLayout(blockInfo.StructureType)
2865 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2866
2867 SmallVector<llvm::Value *, 9> addr;
2868 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl9b97adf2013-03-29 19:20:35 +00002869 if (isa<llvm::AllocaInst>(Storage))
2870 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002871 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2872 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2873 if (isByRef) {
2874 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2875 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2876 // offset of __forwarding field
2877 offset = CGM.getContext()
2878 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2879 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2880 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2881 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2882 // offset of x field
2883 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2884 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2885 }
2886
2887 // Create the descriptor for the variable.
2888 llvm::DIVariable D =
Eric Christopher6537f082013-05-16 00:45:12 +00002889 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002890 llvm::DIDescriptor(LexicalBlockStack.back()),
2891 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl9b97adf2013-03-29 19:20:35 +00002892
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002893 // Insert an llvm.dbg.declare into the current block.
2894 llvm::Instruction *Call =
2895 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2896 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2897 LexicalBlockStack.back()));
2898}
2899
2900/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2901/// variable declaration.
2902void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2903 unsigned ArgNo,
2904 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002905 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002906 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2907}
2908
2909namespace {
2910 struct BlockLayoutChunk {
2911 uint64_t OffsetInBits;
2912 const BlockDecl::Capture *Capture;
2913 };
2914 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2915 return l.OffsetInBits < r.OffsetInBits;
2916 }
2917}
2918
2919void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl836e7c92013-03-14 17:53:33 +00002920 llvm::Value *Arg,
2921 llvm::Value *LocalAddr,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002922 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002923 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002924 ASTContext &C = CGM.getContext();
2925 const BlockDecl *blockDecl = block.getBlockDecl();
2926
2927 // Collect some general information about the block's location.
2928 SourceLocation loc = blockDecl->getCaretLocation();
2929 llvm::DIFile tunit = getOrCreateFile(loc);
2930 unsigned line = getLineNumber(loc);
2931 unsigned column = getColumnNumber(loc);
Eric Christopher6537f082013-05-16 00:45:12 +00002932
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002933 // Build the debug-info type for the block literal.
2934 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2935
2936 const llvm::StructLayout *blockLayout =
2937 CGM.getDataLayout().getStructLayout(block.StructureType);
2938
2939 SmallVector<llvm::Value*, 16> fields;
2940 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2941 blockLayout->getElementOffsetInBits(0),
2942 tunit, tunit));
2943 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2944 blockLayout->getElementOffsetInBits(1),
2945 tunit, tunit));
2946 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2947 blockLayout->getElementOffsetInBits(2),
2948 tunit, tunit));
2949 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2950 blockLayout->getElementOffsetInBits(3),
2951 tunit, tunit));
2952 fields.push_back(createFieldType("__descriptor",
2953 C.getPointerType(block.NeedsCopyDispose ?
2954 C.getBlockDescriptorExtendedType() :
2955 C.getBlockDescriptorType()),
2956 0, loc, AS_public,
2957 blockLayout->getElementOffsetInBits(4),
2958 tunit, tunit));
2959
2960 // We want to sort the captures by offset, not because DWARF
2961 // requires this, but because we're paranoid about debuggers.
2962 SmallVector<BlockLayoutChunk, 8> chunks;
2963
2964 // 'this' capture.
2965 if (blockDecl->capturesCXXThis()) {
2966 BlockLayoutChunk chunk;
2967 chunk.OffsetInBits =
2968 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2969 chunk.Capture = 0;
2970 chunks.push_back(chunk);
2971 }
2972
2973 // Variable captures.
2974 for (BlockDecl::capture_const_iterator
2975 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2976 i != e; ++i) {
2977 const BlockDecl::Capture &capture = *i;
2978 const VarDecl *variable = capture.getVariable();
2979 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2980
2981 // Ignore constant captures.
2982 if (captureInfo.isConstant())
2983 continue;
2984
2985 BlockLayoutChunk chunk;
2986 chunk.OffsetInBits =
2987 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2988 chunk.Capture = &capture;
2989 chunks.push_back(chunk);
2990 }
2991
2992 // Sort by offset.
2993 llvm::array_pod_sort(chunks.begin(), chunks.end());
2994
2995 for (SmallVectorImpl<BlockLayoutChunk>::iterator
2996 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2997 uint64_t offsetInBits = i->OffsetInBits;
2998 const BlockDecl::Capture *capture = i->Capture;
2999
3000 // If we have a null capture, this must be the C++ 'this' capture.
3001 if (!capture) {
3002 const CXXMethodDecl *method =
3003 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
3004 QualType type = method->getThisType(C);
3005
3006 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3007 offsetInBits, tunit, tunit));
3008 continue;
3009 }
3010
3011 const VarDecl *variable = capture->getVariable();
3012 StringRef name = variable->getName();
3013
3014 llvm::DIType fieldType;
3015 if (capture->isByRef()) {
3016 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
3017
3018 // FIXME: this creates a second copy of this type!
3019 uint64_t xoffset;
3020 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
3021 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
3022 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3023 ptrInfo.first, ptrInfo.second,
3024 offsetInBits, 0, fieldType);
3025 } else {
3026 fieldType = createFieldType(name, variable->getType(), 0,
3027 loc, AS_public, offsetInBits, tunit, tunit);
3028 }
3029 fields.push_back(fieldType);
3030 }
3031
3032 SmallString<36> typeName;
3033 llvm::raw_svector_ostream(typeName)
3034 << "__block_literal_" << CGM.getUniqueBlockCount();
3035
3036 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3037
3038 llvm::DIType type =
3039 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3040 CGM.getContext().toBits(block.BlockSize),
3041 CGM.getContext().toBits(block.BlockAlign),
David Blaikiec1d0af12013-02-25 01:07:08 +00003042 0, llvm::DIType(), fieldsArray);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003043 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3044
3045 // Get overall information about the block.
3046 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3047 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003048
3049 // Create the descriptor for the parameter.
3050 llvm::DIVariable debugVar =
3051 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopher6537f082013-05-16 00:45:12 +00003052 llvm::DIDescriptor(scope),
Adrian Prantl836e7c92013-03-14 17:53:33 +00003053 Arg->getName(), tunit, line, type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003054 CGM.getLangOpts().Optimize, flags,
Adrian Prantl836e7c92013-03-14 17:53:33 +00003055 cast<llvm::Argument>(Arg)->getArgNo() + 1);
3056
Adrian Prantlbea407c2013-03-14 21:52:59 +00003057 if (LocalAddr) {
Adrian Prantl836e7c92013-03-14 17:53:33 +00003058 // Insert an llvm.dbg.value into the current block.
Adrian Prantlbea407c2013-03-14 21:52:59 +00003059 llvm::Instruction *DbgVal =
3060 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopherf068c922013-04-02 22:59:11 +00003061 Builder.GetInsertBlock());
Adrian Prantlbea407c2013-03-14 21:52:59 +00003062 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3063 }
Adrian Prantl836e7c92013-03-14 17:53:33 +00003064
Adrian Prantlbea407c2013-03-14 21:52:59 +00003065 // Insert an llvm.dbg.declare into the current block.
3066 llvm::Instruction *DbgDecl =
3067 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
3068 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003069}
3070
David Blaikie5434fc22013-08-20 01:28:15 +00003071/// If D is an out-of-class definition of a static data member of a class, find
3072/// its corresponding in-class declaration.
3073llvm::DIDerivedType
3074CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3075 if (!D->isStaticDataMember())
3076 return llvm::DIDerivedType();
3077 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
3078 StaticDataMemberCache.find(D->getCanonicalDecl());
3079 if (MI != StaticDataMemberCache.end()) {
3080 assert(MI->second && "Static data member declaration should still exist");
3081 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov045a9f62013-08-16 10:35:31 +00003082 }
David Blaikie5e6937b2013-08-20 21:49:21 +00003083
3084 // If the member wasn't found in the cache, lazily construct and add it to the
3085 // type (used when a limited form of the type is emitted).
David Blaikie5434fc22013-08-20 01:28:15 +00003086 llvm::DICompositeType Ctxt(
3087 getContextDescriptor(cast<Decl>(D->getDeclContext())));
3088 llvm::DIDerivedType T = CreateRecordStaticField(D, Ctxt);
3089 Ctxt.addMember(T);
3090 return T;
3091}
3092
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003093/// EmitGlobalVariable - Emit information about a global variable.
3094void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3095 const VarDecl *D) {
Eric Christopher13c97672013-05-16 00:45:23 +00003096 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003097 // Create global variable debug descriptor.
3098 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
3099 unsigned LineNo = getLineNumber(D->getLocation());
3100
3101 setLocation(D->getLocation());
3102
3103 QualType T = D->getType();
3104 if (T->isIncompleteArrayType()) {
3105
3106 // CodeGen turns int[] into int[1] so we'll do the same here.
3107 llvm::APInt ConstVal(32, 1);
3108 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3109
3110 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3111 ArrayType::Normal, 0);
3112 }
3113 StringRef DeclName = D->getName();
3114 StringRef LinkageName;
3115 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
3116 && !isa<ObjCMethodDecl>(D->getDeclContext()))
3117 LinkageName = Var->getName();
3118 if (LinkageName == DeclName)
3119 LinkageName = StringRef();
Eric Christopher6537f082013-05-16 00:45:12 +00003120 llvm::DIDescriptor DContext =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003121 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
David Blaikie5434fc22013-08-20 01:28:15 +00003122 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
3123 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3124 Var->hasInternalLinkage(), Var,
3125 getOrCreateStaticDataMemberDeclarationOrNull(D));
David Blaikie9faebd22013-05-20 04:58:53 +00003126 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003127}
3128
3129/// EmitGlobalVariable - Emit information about an objective-c interface.
3130void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3131 ObjCInterfaceDecl *ID) {
Eric Christopher13c97672013-05-16 00:45:23 +00003132 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003133 // Create global variable debug descriptor.
3134 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
3135 unsigned LineNo = getLineNumber(ID->getLocation());
3136
3137 StringRef Name = ID->getName();
3138
3139 QualType T = CGM.getContext().getObjCInterfaceType(ID);
3140 if (T->isIncompleteArrayType()) {
3141
3142 // CodeGen turns int[] into int[1] so we'll do the same here.
3143 llvm::APInt ConstVal(32, 1);
3144 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3145
3146 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3147 ArrayType::Normal, 0);
3148 }
3149
3150 DBuilder.createGlobalVariable(Name, Unit, LineNo,
3151 getOrCreateType(T, Unit),
3152 Var->hasInternalLinkage(), Var);
3153}
3154
3155/// EmitGlobalVariable - Emit global variable's debug info.
Eric Christopher6537f082013-05-16 00:45:12 +00003156void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003157 llvm::Constant *Init) {
Eric Christopher13c97672013-05-16 00:45:23 +00003158 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003159 // Create the descriptor for the variable.
3160 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3161 StringRef Name = VD->getName();
3162 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3163 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3164 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3165 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3166 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3167 }
3168 // Do not use DIGlobalVariable for enums.
3169 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3170 return;
David Blaikie27ab0362013-08-15 21:42:43 +00003171 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
3172 Unit, Name, Name, Unit, getLineNumber(VD->getLocation()), Ty, true, Init,
David Blaikie5434fc22013-08-20 01:28:15 +00003173 getOrCreateStaticDataMemberDeclarationOrNull(cast<VarDecl>(VD)));
David Blaikie9faebd22013-05-20 04:58:53 +00003174 DeclCache.insert(std::make_pair(VD->getCanonicalDecl(), llvm::WeakVH(GV)));
3175}
3176
3177llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3178 if (!LexicalBlockStack.empty())
3179 return llvm::DIScope(LexicalBlockStack.back());
3180 return getContextDescriptor(D);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003181}
3182
David Blaikie957dac52013-04-22 06:13:21 +00003183void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikie9faebd22013-05-20 04:58:53 +00003184 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3185 return;
David Blaikie957dac52013-04-22 06:13:21 +00003186 DBuilder.createImportedModule(
David Blaikie9faebd22013-05-20 04:58:53 +00003187 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3188 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie957dac52013-04-22 06:13:21 +00003189 getLineNumber(UD.getLocation()));
3190}
3191
David Blaikie9faebd22013-05-20 04:58:53 +00003192void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3193 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3194 return;
3195 assert(UD.shadow_size() &&
3196 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3197 // Emitting one decl is sufficient - debuggers can detect that this is an
3198 // overloaded name & provide lookup for all the overloads.
3199 const UsingShadowDecl &USD = **UD.shadow_begin();
Eric Christopher56b108a2013-06-07 22:54:39 +00003200 if (llvm::DIDescriptor Target =
3201 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikie9faebd22013-05-20 04:58:53 +00003202 DBuilder.createImportedDeclaration(
3203 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3204 getLineNumber(USD.getLocation()));
3205}
3206
David Blaikiefc46ebc2013-05-20 22:50:41 +00003207llvm::DIImportedEntity
3208CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3209 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3210 return llvm::DIImportedEntity(0);
3211 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3212 if (VH)
3213 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
3214 llvm::DIImportedEntity R(0);
3215 if (const NamespaceAliasDecl *Underlying =
3216 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3217 // This could cache & dedup here rather than relying on metadata deduping.
3218 R = DBuilder.createImportedModule(
3219 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3220 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3221 NA.getName());
3222 else
3223 R = DBuilder.createImportedModule(
3224 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3225 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3226 getLineNumber(NA.getLocation()), NA.getName());
3227 VH = R;
3228 return R;
3229}
3230
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003231/// getOrCreateNamesSpace - Return namespace descriptor for the given
3232/// namespace decl.
Eric Christopher6537f082013-05-16 00:45:12 +00003233llvm::DINameSpace
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003234CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie8863e6b2013-08-16 22:52:07 +00003235 NSDecl = NSDecl->getCanonicalDecl();
Eric Christopher6537f082013-05-16 00:45:12 +00003236 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003237 NameSpaceCache.find(NSDecl);
3238 if (I != NameSpaceCache.end())
3239 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopher6537f082013-05-16 00:45:12 +00003240
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003241 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3242 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00003243 llvm::DIDescriptor Context =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003244 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3245 llvm::DINameSpace NS =
3246 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3247 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3248 return NS;
3249}
3250
3251void CGDebugInfo::finalize() {
3252 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
3253 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
3254 llvm::DIType Ty, RepTy;
3255 // Verify that the debug info still exists.
3256 if (llvm::Value *V = VI->second)
3257 Ty = llvm::DIType(cast<llvm::MDNode>(V));
Eric Christopher6537f082013-05-16 00:45:12 +00003258
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003259 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
3260 TypeCache.find(VI->first);
3261 if (it != TypeCache.end()) {
3262 // Verify that the debug info still exists.
3263 if (llvm::Value *V = it->second)
3264 RepTy = llvm::DIType(cast<llvm::MDNode>(V));
3265 }
Adrian Prantlebbd7e02013-03-11 18:33:46 +00003266
Eric Christopherb2d13922013-07-18 00:52:50 +00003267 if (Ty && Ty.isForwardDecl() && RepTy)
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003268 Ty.replaceAllUsesWith(RepTy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003269 }
Adrian Prantlebbd7e02013-03-11 18:33:46 +00003270
3271 // We keep our own list of retained types, because we need to look
3272 // up the final type in the type cache.
3273 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3274 RE = RetainedTypes.end(); RI != RE; ++RI)
3275 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
3276
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003277 DBuilder.finalize();
3278}