blob: 45001fc36e74c80eb923ee8a9c2493decc7e85a0 [file] [log] [blame]
Guy Benyei11169dd2012-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 Blaikie38079fd2013-05-10 21:53:14 +000016#include "CGCXXABI.h"
Guy Benyei11169dd2012-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 Carruthffd55512013-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 Benyei11169dd2012-12-18 14:30:41 +000038#include "llvm/Support/Dwarf.h"
39#include "llvm/Support/FileSystem.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000040#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000041using namespace clang;
42using namespace clang::CodeGen;
43
44CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000045 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
46 DBuilder(CGM.getModule()) {
Guy Benyei11169dd2012-12-18 14:30:41 +000047 CreateCompileUnit();
48}
49
50CGDebugInfo::~CGDebugInfo() {
51 assert(LexicalBlockStack.empty() &&
52 "Region stack mismatch, stack not empty!");
53}
54
Eric Christopher0a1301f2014-02-26 02:49:36 +000055SaveAndRestoreLocation::SaveAndRestoreLocation(CodeGenFunction &CGF,
56 CGBuilderTy &B)
57 : DI(CGF.getDebugInfo()), Builder(B) {
Adrian Prantl2e0637f2013-07-18 00:28:02 +000058 if (DI) {
59 SavedLoc = DI->getLocation();
60 DI->CurLoc = SourceLocation();
Adrian Prantl2e0637f2013-07-18 00:28:02 +000061 }
62}
63
Adrian Prantld1b151e2014-01-17 00:15:10 +000064SaveAndRestoreLocation::~SaveAndRestoreLocation() {
65 if (DI)
66 DI->EmitLocation(Builder, SavedLoc);
67}
68
69NoLocation::NoLocation(CodeGenFunction &CGF, CGBuilderTy &B)
70 : SaveAndRestoreLocation(CGF, B) {
71 if (DI)
72 Builder.SetCurrentDebugLocation(llvm::DebugLoc());
73}
74
Adrian Prantl2e0637f2013-07-18 00:28:02 +000075NoLocation::~NoLocation() {
Adrian Prantld1b151e2014-01-17 00:15:10 +000076 if (DI)
Adrian Prantl2e0637f2013-07-18 00:28:02 +000077 assert(Builder.getCurrentDebugLocation().isUnknown());
Adrian Prantl2e0637f2013-07-18 00:28:02 +000078}
79
Adrian Prantlb75016d2013-07-18 01:36:04 +000080ArtificialLocation::ArtificialLocation(CodeGenFunction &CGF, CGBuilderTy &B)
Adrian Prantld1b151e2014-01-17 00:15:10 +000081 : SaveAndRestoreLocation(CGF, B) {
82 if (DI)
Adrian Prantl49a78562013-07-24 20:34:39 +000083 Builder.SetCurrentDebugLocation(llvm::DebugLoc());
Adrian Prantl49a78562013-07-24 20:34:39 +000084}
85
86void ArtificialLocation::Emit() {
87 if (DI) {
Adrian Prantl2e0637f2013-07-18 00:28:02 +000088 // Sync the Builder.
89 DI->EmitLocation(Builder, SavedLoc);
90 DI->CurLoc = SourceLocation();
91 // Construct a location that has a valid scope, but no line info.
Adrian Prantl49a78562013-07-24 20:34:39 +000092 assert(!DI->LexicalBlockStack.empty());
93 llvm::DIDescriptor Scope(DI->LexicalBlockStack.back());
Adrian Prantl2e0637f2013-07-18 00:28:02 +000094 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(0, 0, Scope));
95 }
96}
97
Adrian Prantlb75016d2013-07-18 01:36:04 +000098ArtificialLocation::~ArtificialLocation() {
Adrian Prantld1b151e2014-01-17 00:15:10 +000099 if (DI)
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000100 assert(Builder.getCurrentDebugLocation().getLine() == 0);
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000101}
102
Guy Benyei11169dd2012-12-18 14:30:41 +0000103void CGDebugInfo::setLocation(SourceLocation Loc) {
104 // If the new location isn't valid return.
Adrian Prantlb1b3bfc2013-07-18 00:27:56 +0000105 if (Loc.isInvalid()) return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000106
107 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
108
109 // If we've changed files in the middle of a lexical scope go ahead
110 // and create a new lexical scope with file node if it's different
111 // from the one in the scope.
112 if (LexicalBlockStack.empty()) return;
113
114 SourceManager &SM = CGM.getContext().getSourceManager();
115 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
116 PresumedLoc PPLoc = SM.getPresumedLoc(PrevLoc);
117
118 if (PCLoc.isInvalid() || PPLoc.isInvalid() ||
119 !strcmp(PPLoc.getFilename(), PCLoc.getFilename()))
120 return;
121
122 llvm::MDNode *LB = LexicalBlockStack.back();
123 llvm::DIScope Scope = llvm::DIScope(LB);
124 if (Scope.isLexicalBlockFile()) {
125 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(LB);
126 llvm::DIDescriptor D
127 = DBuilder.createLexicalBlockFile(LBF.getScope(),
128 getOrCreateFile(CurLoc));
129 llvm::MDNode *N = D;
130 LexicalBlockStack.pop_back();
131 LexicalBlockStack.push_back(N);
David Blaikie0a21d0d2013-01-26 22:16:26 +0000132 } else if (Scope.isLexicalBlock() || Scope.isSubprogram()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000133 llvm::DIDescriptor D
134 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
135 llvm::MDNode *N = D;
136 LexicalBlockStack.pop_back();
137 LexicalBlockStack.push_back(N);
138 }
139}
140
141/// getContextDescriptor - Get context info for the decl.
David Blaikiebfa52742013-04-19 06:56:38 +0000142llvm::DIScope CGDebugInfo::getContextDescriptor(const Decl *Context) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000143 if (!Context)
144 return TheCU;
145
146 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
147 I = RegionMap.find(Context);
148 if (I != RegionMap.end()) {
149 llvm::Value *V = I->second;
David Blaikiebfa52742013-04-19 06:56:38 +0000150 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
Guy Benyei11169dd2012-12-18 14:30:41 +0000151 }
152
153 // Check namespace.
154 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000155 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000156
David Blaikiebfa52742013-04-19 06:56:38 +0000157 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
158 if (!RDecl->isDependentType())
159 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Guy Benyei11169dd2012-12-18 14:30:41 +0000160 getOrCreateMainFile());
Guy Benyei11169dd2012-12-18 14:30:41 +0000161 return TheCU;
162}
163
164/// getFunctionName - Get function name for the given FunctionDecl. If the
Benjamin Kramer60509af2013-09-09 14:48:42 +0000165/// name is constructed on demand (e.g. C++ destructor) then the name
Guy Benyei11169dd2012-12-18 14:30:41 +0000166/// is stored on the side.
167StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
168 assert (FD && "Invalid FunctionDecl!");
169 IdentifierInfo *FII = FD->getIdentifier();
170 FunctionTemplateSpecializationInfo *Info
171 = FD->getTemplateSpecializationInfo();
172 if (!Info && FII)
173 return FII->getName();
174
175 // Otherwise construct human readable name for debug info.
Benjamin Kramer9170e912013-02-22 15:46:01 +0000176 SmallString<128> NS;
177 llvm::raw_svector_ostream OS(NS);
178 FD->printName(OS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000179
180 // Add any template specialization args.
181 if (Info) {
182 const TemplateArgumentList *TArgs = Info->TemplateArguments;
183 const TemplateArgument *Args = TArgs->data();
184 unsigned NumArgs = TArgs->size();
185 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer9170e912013-02-22 15:46:01 +0000186 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
187 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000188 }
189
190 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000191 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000192}
193
194StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
195 SmallString<256> MethodName;
196 llvm::raw_svector_ostream OS(MethodName);
197 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
198 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000199 if (const ObjCImplementationDecl *OID =
Guy Benyei11169dd2012-12-18 14:30:41 +0000200 dyn_cast<const ObjCImplementationDecl>(DC)) {
201 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000202 } else if (const ObjCInterfaceDecl *OID =
Guy Benyei11169dd2012-12-18 14:30:41 +0000203 dyn_cast<const ObjCInterfaceDecl>(DC)) {
204 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000205 } else if (const ObjCCategoryImplDecl *OCD =
Guy Benyei11169dd2012-12-18 14:30:41 +0000206 dyn_cast<const ObjCCategoryImplDecl>(DC)){
207 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
208 OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000209 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000210 // We can extract the type of the class from the self pointer.
211 if (ImplicitParamDecl* SelfDecl = OMD->getSelfDecl()) {
212 QualType ClassTy =
213 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
214 ClassTy.print(OS, PrintingPolicy(LangOptions()));
215 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000216 }
217 OS << ' ' << OMD->getSelector().getAsString() << ']';
218
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000219 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000220}
221
222/// getSelectorName - Return selector name. This is used for debugging
223/// info.
224StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000225 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000226}
227
228/// getClassName - Get class name including template argument list.
Eric Christopherb2a008c2013-05-16 00:45:12 +0000229StringRef
Guy Benyei11169dd2012-12-18 14:30:41 +0000230CGDebugInfo::getClassName(const RecordDecl *RD) {
231 const ClassTemplateSpecializationDecl *Spec
232 = dyn_cast<ClassTemplateSpecializationDecl>(RD);
233 if (!Spec)
234 return RD->getName();
235
236 const TemplateArgument *Args;
237 unsigned NumArgs;
238 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
239 const TemplateSpecializationType *TST =
240 cast<TemplateSpecializationType>(TAW->getType());
241 Args = TST->getArgs();
242 NumArgs = TST->getNumArgs();
243 } else {
244 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
245 Args = TemplateArgs.data();
246 NumArgs = TemplateArgs.size();
247 }
248 StringRef Name = RD->getIdentifier()->getName();
249 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer9170e912013-02-22 15:46:01 +0000250 SmallString<128> TemplateArgList;
251 {
252 llvm::raw_svector_ostream OS(TemplateArgList);
253 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
254 Policy);
255 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000256
257 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000258 return internString(Name, TemplateArgList);
Guy Benyei11169dd2012-12-18 14:30:41 +0000259}
260
261/// getOrCreateFile - Get the file debug info descriptor for the input location.
262llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
263 if (!Loc.isValid())
264 // If Location is not valid then use main input file.
265 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
266
267 SourceManager &SM = CGM.getContext().getSourceManager();
268 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
269
270 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
271 // If the location is not valid then use main input file.
272 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
273
274 // Cache the results.
275 const char *fname = PLoc.getFilename();
276 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
277 DIFileCache.find(fname);
278
279 if (it != DIFileCache.end()) {
280 // Verify that the information still exists.
281 if (llvm::Value *V = it->second)
282 return llvm::DIFile(cast<llvm::MDNode>(V));
283 }
284
285 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
286
287 DIFileCache[fname] = F;
288 return F;
289}
290
291/// getOrCreateMainFile - Get the file info for main compile unit.
292llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
293 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
294}
295
296/// getLineNumber - Get line number for the location. If location is invalid
297/// then use current location.
298unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
299 if (Loc.isInvalid() && CurLoc.isInvalid())
300 return 0;
301 SourceManager &SM = CGM.getContext().getSourceManager();
302 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
303 return PLoc.isValid()? PLoc.getLine() : 0;
304}
305
306/// getColumnNumber - Get column number for the location.
Adrian Prantlc7822422013-03-12 20:43:25 +0000307unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000308 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000309 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000310 return 0;
311
312 // If the location is invalid then use the current column.
313 if (Loc.isInvalid() && CurLoc.isInvalid())
314 return 0;
315 SourceManager &SM = CGM.getContext().getSourceManager();
316 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
317 return PLoc.isValid()? PLoc.getColumn() : 0;
318}
319
320StringRef CGDebugInfo::getCurrentDirname() {
321 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
322 return CGM.getCodeGenOpts().DebugCompilationDir;
323
324 if (!CWDName.empty())
325 return CWDName;
326 SmallString<256> CWD;
327 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000328 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000329}
330
331/// CreateCompileUnit - Create new compile unit.
332void CGDebugInfo::CreateCompileUnit() {
333
334 // Get absolute path name.
335 SourceManager &SM = CGM.getContext().getSourceManager();
336 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
337 if (MainFileName.empty())
338 MainFileName = "<unknown>";
339
340 // The main file name provided via the "-main-file-name" option contains just
341 // the file name itself with no path information. This file name may have had
342 // a relative path, so we look into the actual file entry for the main
343 // file to determine the real absolute path for the file.
344 std::string MainFileDir;
345 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
346 MainFileDir = MainFile->getDir()->getName();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000347 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000348 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
349 llvm::sys::path::append(MainFileDirSS, MainFileName);
350 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000351 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000352 }
353
354 // Save filename string.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000355 StringRef Filename = internString(MainFileName);
Eric Christopherf1545832013-02-22 23:50:16 +0000356
357 // Save split dwarf file string.
358 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000359 StringRef SplitDwarfFilename = internString(SplitDwarfFile);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000360
Guy Benyei11169dd2012-12-18 14:30:41 +0000361 unsigned LangTag;
362 const LangOptions &LO = CGM.getLangOpts();
363 if (LO.CPlusPlus) {
364 if (LO.ObjC1)
365 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
366 else
367 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
368 } else if (LO.ObjC1) {
369 LangTag = llvm::dwarf::DW_LANG_ObjC;
370 } else if (LO.C99) {
371 LangTag = llvm::dwarf::DW_LANG_C99;
372 } else {
373 LangTag = llvm::dwarf::DW_LANG_C89;
374 }
375
376 std::string Producer = getClangFullVersion();
377
378 // Figure out which version of the ObjC runtime we have.
379 unsigned RuntimeVers = 0;
380 if (LO.ObjC1)
381 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
382
383 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000384 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000385 TheCU = DBuilder.createCompileUnit(
386 LangTag, Filename, getCurrentDirname(), Producer, LO.Optimize,
387 CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers, SplitDwarfFilename,
388 DebugKind == CodeGenOptions::DebugLineTablesOnly
389 ? llvm::DIBuilder::LineTablesOnly
390 : llvm::DIBuilder::FullDebug);
Guy Benyei11169dd2012-12-18 14:30:41 +0000391}
392
393/// CreateType - Get the Basic type from the cache or create a new
394/// one if necessary.
395llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
396 unsigned Encoding = 0;
397 StringRef BTName;
398 switch (BT->getKind()) {
399#define BUILTIN_TYPE(Id, SingletonId)
400#define PLACEHOLDER_TYPE(Id, SingletonId) \
401 case BuiltinType::Id:
402#include "clang/AST/BuiltinTypes.def"
403 case BuiltinType::Dependent:
404 llvm_unreachable("Unexpected builtin type");
405 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000406 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000407 case BuiltinType::Void:
408 return llvm::DIType();
409 case BuiltinType::ObjCClass:
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000410 if (ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000411 return ClassTy;
412 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
413 "objc_class", TheCU,
414 getOrCreateMainFile(), 0);
415 return ClassTy;
416 case BuiltinType::ObjCId: {
417 // typedef struct objc_class *Class;
418 // typedef struct objc_object {
419 // Class isa;
420 // } *id;
421
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000422 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000423 return ObjTy;
424
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000425 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000426 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
427 "objc_class", TheCU,
428 getOrCreateMainFile(), 0);
429
430 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000431
Guy Benyei11169dd2012-12-18 14:30:41 +0000432 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
433
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000434 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000435 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
436 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000437
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000438 ObjTy.setTypeArray(DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
439 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000440 return ObjTy;
441 }
442 case BuiltinType::ObjCSel: {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000443 if (SelTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000444 return SelTy;
445 SelTy =
446 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
447 "objc_selector", TheCU, getOrCreateMainFile(),
448 0);
449 return SelTy;
450 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000451
452 case BuiltinType::OCLImage1d:
453 return getOrCreateStructPtrType("opencl_image1d_t",
454 OCLImage1dDITy);
455 case BuiltinType::OCLImage1dArray:
Eric Christopherb2a008c2013-05-16 00:45:12 +0000456 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000457 OCLImage1dArrayDITy);
458 case BuiltinType::OCLImage1dBuffer:
459 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
460 OCLImage1dBufferDITy);
461 case BuiltinType::OCLImage2d:
462 return getOrCreateStructPtrType("opencl_image2d_t",
463 OCLImage2dDITy);
464 case BuiltinType::OCLImage2dArray:
465 return getOrCreateStructPtrType("opencl_image2d_array_t",
466 OCLImage2dArrayDITy);
467 case BuiltinType::OCLImage3d:
468 return getOrCreateStructPtrType("opencl_image3d_t",
469 OCLImage3dDITy);
Guy Benyei61054192013-02-07 10:55:47 +0000470 case BuiltinType::OCLSampler:
471 return DBuilder.createBasicType("opencl_sampler_t",
472 CGM.getContext().getTypeSize(BT),
473 CGM.getContext().getTypeAlign(BT),
474 llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000475 case BuiltinType::OCLEvent:
476 return getOrCreateStructPtrType("opencl_event_t",
477 OCLEventDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000478
Guy Benyei11169dd2012-12-18 14:30:41 +0000479 case BuiltinType::UChar:
480 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
481 case BuiltinType::Char_S:
482 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
483 case BuiltinType::Char16:
484 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
485 case BuiltinType::UShort:
486 case BuiltinType::UInt:
487 case BuiltinType::UInt128:
488 case BuiltinType::ULong:
489 case BuiltinType::WChar_U:
490 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
491 case BuiltinType::Short:
492 case BuiltinType::Int:
493 case BuiltinType::Int128:
494 case BuiltinType::Long:
495 case BuiltinType::WChar_S:
496 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
497 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
498 case BuiltinType::Half:
499 case BuiltinType::Float:
500 case BuiltinType::LongDouble:
501 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
502 }
503
504 switch (BT->getKind()) {
505 case BuiltinType::Long: BTName = "long int"; break;
506 case BuiltinType::LongLong: BTName = "long long int"; break;
507 case BuiltinType::ULong: BTName = "long unsigned int"; break;
508 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
509 default:
510 BTName = BT->getName(CGM.getLangOpts());
511 break;
512 }
513 // Bit size, align and offset of the type.
514 uint64_t Size = CGM.getContext().getTypeSize(BT);
515 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000516 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +0000517 DBuilder.createBasicType(BTName, Size, Align, Encoding);
518 return DbgTy;
519}
520
521llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
522 // Bit size, align and offset of the type.
523 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
524 if (Ty->isComplexIntegerType())
525 Encoding = llvm::dwarf::DW_ATE_lo_user;
526
527 uint64_t Size = CGM.getContext().getTypeSize(Ty);
528 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000529 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +0000530 DBuilder.createBasicType("complex", Size, Align, Encoding);
531
532 return DbgTy;
533}
534
535/// CreateCVRType - Get the qualified type from the cache or create
536/// a new one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +0000537llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000538 QualifierCollector Qc;
539 const Type *T = Qc.strip(Ty);
540
541 // Ignore these qualifiers for now.
542 Qc.removeObjCGCAttr();
543 Qc.removeAddressSpace();
544 Qc.removeObjCLifetime();
545
546 // We will create one Derived type for one qualifier and recurse to handle any
547 // additional ones.
548 unsigned Tag;
549 if (Qc.hasConst()) {
550 Tag = llvm::dwarf::DW_TAG_const_type;
551 Qc.removeConst();
552 } else if (Qc.hasVolatile()) {
553 Tag = llvm::dwarf::DW_TAG_volatile_type;
554 Qc.removeVolatile();
555 } else if (Qc.hasRestrict()) {
556 Tag = llvm::dwarf::DW_TAG_restrict_type;
557 Qc.removeRestrict();
558 } else {
559 assert(Qc.empty() && "Unknown type qualifier for debug info");
560 return getOrCreateType(QualType(T, 0), Unit);
561 }
562
David Blaikie99dab3b2013-09-04 22:03:57 +0000563 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000564
565 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
566 // CVR derived types.
567 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000568
Guy Benyei11169dd2012-12-18 14:30:41 +0000569 return DbgTy;
570}
571
572llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
573 llvm::DIFile Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000574
575 // The frontend treats 'id' as a typedef to an ObjCObjectType,
576 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
577 // debug info, we want to emit 'id' in both cases.
578 if (Ty->isObjCQualifiedIdType())
579 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
580
Guy Benyei11169dd2012-12-18 14:30:41 +0000581 llvm::DIType DbgTy =
Eric Christopherb2a008c2013-05-16 00:45:12 +0000582 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000583 Ty->getPointeeType(), Unit);
584 return DbgTy;
585}
586
587llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
588 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000589 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000590 Ty->getPointeeType(), Unit);
591}
592
Manman Rene0064d82013-08-29 23:19:58 +0000593/// In C++ mode, types have linkage, so we can rely on the ODR and
594/// on their mangled names, if they're external.
595static SmallString<256>
596getUniqueTagTypeName(const TagType *Ty, CodeGenModule &CGM,
597 llvm::DICompileUnit TheCU) {
598 SmallString<256> FullName;
599 // FIXME: ODR should apply to ObjC++ exactly the same wasy it does to C++.
600 // For now, only apply ODR with C++.
601 const TagDecl *TD = Ty->getDecl();
602 if (TheCU.getLanguage() != llvm::dwarf::DW_LANG_C_plus_plus ||
603 !TD->isExternallyVisible())
604 return FullName;
605 // Microsoft Mangler does not have support for mangleCXXRTTIName yet.
606 if (CGM.getTarget().getCXXABI().isMicrosoft())
607 return FullName;
608
609 // TODO: This is using the RTTI name. Is there a better way to get
610 // a unique string for a type?
611 llvm::raw_svector_ostream Out(FullName);
612 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
613 Out.flush();
614 return FullName;
615}
616
Guy Benyei11169dd2012-12-18 14:30:41 +0000617// Creates a forward declaration for a RecordDecl in the given context.
David Blaikie8d5e1282013-08-20 21:03:29 +0000618llvm::DICompositeType
Manman Ren1b457022013-08-28 21:20:28 +0000619CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
David Blaikie8d5e1282013-08-20 21:03:29 +0000620 llvm::DIDescriptor Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000621 const RecordDecl *RD = Ty->getDecl();
David Blaikie4e7ef802013-08-15 20:17:25 +0000622 if (llvm::DIType T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
David Blaikie8d5e1282013-08-20 21:03:29 +0000623 return llvm::DICompositeType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000624 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
625 unsigned Line = getLineNumber(RD->getLocation());
626 StringRef RDName = getClassName(RD);
627
628 unsigned Tag = 0;
629 if (RD->isStruct() || RD->isInterface())
630 Tag = llvm::dwarf::DW_TAG_structure_type;
631 else if (RD->isUnion())
632 Tag = llvm::dwarf::DW_TAG_union_type;
633 else {
634 assert(RD->isClass());
635 Tag = llvm::dwarf::DW_TAG_class_type;
636 }
637
638 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000639 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
640 return DBuilder.createForwardDecl(Tag, RDName, Ctx, DefUnit, Line, 0, 0, 0,
641 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +0000642}
643
Guy Benyei11169dd2012-12-18 14:30:41 +0000644llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +0000645 const Type *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000646 QualType PointeeTy,
647 llvm::DIFile Unit) {
648 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
649 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikie99dab3b2013-09-04 22:03:57 +0000650 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit));
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000651
Guy Benyei11169dd2012-12-18 14:30:41 +0000652 // Bit size, align and offset of the type.
653 // Size is always the size of a pointer. We can't use getTypeSize here
654 // because that does not return the correct value for references.
655 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000656 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000657 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
658
David Blaikie99dab3b2013-09-04 22:03:57 +0000659 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
660 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000661}
662
Eric Christopher0fdcb312013-05-16 00:52:20 +0000663llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
664 llvm::DIType &Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000665 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000666 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000667 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
668 TheCU, getOrCreateMainFile(), 0);
669 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
670 Cache = DBuilder.createPointerType(Cache, Size);
671 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000672}
673
Guy Benyei11169dd2012-12-18 14:30:41 +0000674llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
675 llvm::DIFile Unit) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000676 if (BlockLiteralGeneric)
Guy Benyei11169dd2012-12-18 14:30:41 +0000677 return BlockLiteralGeneric;
678
679 SmallVector<llvm::Value *, 8> EltTys;
680 llvm::DIType FieldTy;
681 QualType FType;
682 uint64_t FieldSize, FieldOffset;
683 unsigned FieldAlign;
684 llvm::DIArray Elements;
685 llvm::DIType EltTy, DescTy;
686
687 FieldOffset = 0;
688 FType = CGM.getContext().UnsignedLongTy;
689 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
690 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
691
692 Elements = DBuilder.getOrCreateArray(EltTys);
693 EltTys.clear();
694
695 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
696 unsigned LineNo = getLineNumber(CurLoc);
697
698 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
699 Unit, LineNo, FieldOffset, 0,
David Blaikie6d4fe152013-02-25 01:07:08 +0000700 Flags, llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000701
702 // Bit size, align and offset of the type.
703 uint64_t Size = CGM.getContext().getTypeSize(Ty);
704
705 DescTy = DBuilder.createPointerType(EltTy, Size);
706
707 FieldOffset = 0;
708 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
709 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
710 FType = CGM.getContext().IntTy;
711 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
712 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
713 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
714 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
715
716 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
717 FieldTy = DescTy;
718 FieldSize = CGM.getContext().getTypeSize(Ty);
719 FieldAlign = CGM.getContext().getTypeAlign(Ty);
720 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
721 LineNo, FieldSize, FieldAlign,
722 FieldOffset, 0, FieldTy);
723 EltTys.push_back(FieldTy);
724
725 FieldOffset += FieldSize;
726 Elements = DBuilder.getOrCreateArray(EltTys);
727
728 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
729 Unit, LineNo, FieldOffset, 0,
David Blaikie6d4fe152013-02-25 01:07:08 +0000730 Flags, llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000731
Guy Benyei11169dd2012-12-18 14:30:41 +0000732 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
733 return BlockLiteralGeneric;
734}
735
David Blaikie99dab3b2013-09-04 22:03:57 +0000736llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000737 // Typedefs are derived from some other type. If we have a typedef of a
738 // typedef, make sure to emit the whole chain.
David Blaikie99dab3b2013-09-04 22:03:57 +0000739 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000740 if (!Src)
Guy Benyei11169dd2012-12-18 14:30:41 +0000741 return llvm::DIType();
742 // We don't set size information, but do specify where the typedef was
743 // declared.
Adrian Prantl3eff2252014-01-21 18:42:27 +0000744 SourceLocation Loc = Ty->getDecl()->getLocation();
745 llvm::DIFile File = getOrCreateFile(Loc);
746 unsigned Line = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000747 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000748
Guy Benyei11169dd2012-12-18 14:30:41 +0000749 llvm::DIDescriptor TypedefContext =
750 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopherb2a008c2013-05-16 00:45:12 +0000751
Guy Benyei11169dd2012-12-18 14:30:41 +0000752 return
Adrian Prantl3eff2252014-01-21 18:42:27 +0000753 DBuilder.createTypedef(Src, TyDecl->getName(), File, Line, TypedefContext);
Guy Benyei11169dd2012-12-18 14:30:41 +0000754}
755
756llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
757 llvm::DIFile Unit) {
758 SmallVector<llvm::Value *, 16> EltTys;
759
760 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000761 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000762
763 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000764 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000765 if (isa<FunctionNoProtoType>(Ty))
766 EltTys.push_back(DBuilder.createUnspecifiedParameter());
767 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000768 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
769 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000770 if (FPT->isVariadic())
771 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000772 }
773
774 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
775 return DBuilder.createSubroutineType(Unit, EltTypeArray);
776}
777
778
Guy Benyei11169dd2012-12-18 14:30:41 +0000779llvm::DIType CGDebugInfo::createFieldType(StringRef name,
780 QualType type,
781 uint64_t sizeInBitsOverride,
782 SourceLocation loc,
783 AccessSpecifier AS,
784 uint64_t offsetInBits,
785 llvm::DIFile tunit,
Manman Ren2c826dc2013-09-08 03:45:05 +0000786 llvm::DIScope scope) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000787 llvm::DIType debugType = getOrCreateType(type, tunit);
788
789 // Get the location for the field.
790 llvm::DIFile file = getOrCreateFile(loc);
791 unsigned line = getLineNumber(loc);
792
793 uint64_t sizeInBits = 0;
794 unsigned alignInBits = 0;
795 if (!type->isIncompleteArrayType()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000796 std::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
Guy Benyei11169dd2012-12-18 14:30:41 +0000797
798 if (sizeInBitsOverride)
799 sizeInBits = sizeInBitsOverride;
800 }
801
802 unsigned flags = 0;
803 if (AS == clang::AS_private)
804 flags |= llvm::DIDescriptor::FlagPrivate;
805 else if (AS == clang::AS_protected)
806 flags |= llvm::DIDescriptor::FlagProtected;
807
808 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
809 alignInBits, offsetInBits, flags, debugType);
810}
811
Eric Christopher91a31902013-01-16 01:22:32 +0000812/// CollectRecordLambdaFields - Helper for CollectRecordFields.
813void CGDebugInfo::
814CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
815 SmallVectorImpl<llvm::Value *> &elements,
816 llvm::DIType RecordTy) {
817 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
818 // has the name and the location of the variable so we should iterate over
819 // both concurrently.
820 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
821 RecordDecl::field_iterator Field = CXXDecl->field_begin();
822 unsigned fieldno = 0;
823 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
824 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
825 const LambdaExpr::Capture C = *I;
826 if (C.capturesVariable()) {
827 VarDecl *V = C.getCapturedVar();
828 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
829 StringRef VName = V->getName();
830 uint64_t SizeInBitsOverride = 0;
831 if (Field->isBitField()) {
832 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
833 assert(SizeInBitsOverride && "found named 0-width bitfield");
834 }
835 llvm::DIType fieldType
836 = createFieldType(VName, Field->getType(), SizeInBitsOverride,
837 C.getLocation(), Field->getAccess(),
838 layout.getFieldOffset(fieldno), VUnit, RecordTy);
839 elements.push_back(fieldType);
840 } else {
841 // TODO: Need to handle 'this' in some way by probably renaming the
842 // this of the lambda class and having a field member of 'this' or
843 // by using AT_object_pointer for the function and having that be
844 // used as 'this' for semantic references.
845 assert(C.capturesThis() && "Field that isn't captured and isn't this?");
846 FieldDecl *f = *Field;
847 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
848 QualType type = f->getType();
849 llvm::DIType fieldType
850 = createFieldType("this", type, 0, f->getLocation(), f->getAccess(),
851 layout.getFieldOffset(fieldno), VUnit, RecordTy);
852
853 elements.push_back(fieldType);
854 }
855 }
856}
857
David Blaikie6943dea2013-08-20 01:28:15 +0000858/// Helper for CollectRecordFields.
David Blaikieae019462013-08-15 22:50:29 +0000859llvm::DIDerivedType
860CGDebugInfo::CreateRecordStaticField(const VarDecl *Var,
861 llvm::DIType RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000862 // Create the descriptor for the static variable, with or without
863 // constant initializers.
864 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
865 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
866
Eric Christopher91a31902013-01-16 01:22:32 +0000867 unsigned LineNumber = getLineNumber(Var->getLocation());
868 StringRef VName = Var->getName();
David Blaikied42917f2013-01-20 01:19:17 +0000869 llvm::Constant *C = NULL;
Eric Christopher91a31902013-01-16 01:22:32 +0000870 if (Var->getInit()) {
871 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000872 if (Value) {
873 if (Value->isInt())
874 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
875 if (Value->isFloat())
876 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
877 }
Eric Christopher91a31902013-01-16 01:22:32 +0000878 }
879
880 unsigned Flags = 0;
881 AccessSpecifier Access = Var->getAccess();
882 if (Access == clang::AS_private)
883 Flags |= llvm::DIDescriptor::FlagPrivate;
884 else if (Access == clang::AS_protected)
885 Flags |= llvm::DIDescriptor::FlagProtected;
886
David Blaikieae019462013-08-15 22:50:29 +0000887 llvm::DIDerivedType GV = DBuilder.createStaticMemberType(
888 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Eric Christopher91a31902013-01-16 01:22:32 +0000889 StaticDataMemberCache[Var->getCanonicalDecl()] = llvm::WeakVH(GV);
David Blaikieae019462013-08-15 22:50:29 +0000890 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +0000891}
892
893/// CollectRecordNormalField - Helper for CollectRecordFields.
894void CGDebugInfo::
895CollectRecordNormalField(const FieldDecl *field, uint64_t OffsetInBits,
896 llvm::DIFile tunit,
897 SmallVectorImpl<llvm::Value *> &elements,
898 llvm::DIType RecordTy) {
899 StringRef name = field->getName();
900 QualType type = field->getType();
901
902 // Ignore unnamed fields unless they're anonymous structs/unions.
903 if (name.empty() && !type->isRecordType())
904 return;
905
906 uint64_t SizeInBitsOverride = 0;
907 if (field->isBitField()) {
908 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
909 assert(SizeInBitsOverride && "found named 0-width bitfield");
910 }
911
912 llvm::DIType fieldType
913 = createFieldType(name, type, SizeInBitsOverride,
914 field->getLocation(), field->getAccess(),
915 OffsetInBits, tunit, RecordTy);
916
917 elements.push_back(fieldType);
918}
919
Guy Benyei11169dd2012-12-18 14:30:41 +0000920/// CollectRecordFields - A helper function to collect debug info for
921/// record fields. This is used while creating debug info entry for a Record.
David Blaikieab255bb2013-08-16 20:40:25 +0000922void CGDebugInfo::CollectRecordFields(const RecordDecl *record,
923 llvm::DIFile tunit,
924 SmallVectorImpl<llvm::Value *> &elements,
925 llvm::DICompositeType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000926 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
927
Eric Christopher91a31902013-01-16 01:22:32 +0000928 if (CXXDecl && CXXDecl->isLambda())
929 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
930 else {
931 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +0000932
Eric Christopher91a31902013-01-16 01:22:32 +0000933 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +0000934 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +0000935
Eric Christopher91a31902013-01-16 01:22:32 +0000936 // Static and non-static members should appear in the same order as
937 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +0000938 for (const auto *I : record->decls())
939 if (const auto *V = dyn_cast<VarDecl>(I)) {
David Blaikiece763042013-08-20 21:49:21 +0000940 // Reuse the existing static member declaration if one exists
941 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
942 StaticDataMemberCache.find(V->getCanonicalDecl());
943 if (MI != StaticDataMemberCache.end()) {
944 assert(MI->second &&
945 "Static data member declaration should still exist");
946 elements.push_back(
947 llvm::DIDerivedType(cast<llvm::MDNode>(MI->second)));
948 } else
949 elements.push_back(CreateRecordStaticField(V, RecordTy));
Aaron Ballman629afae2014-03-07 19:56:05 +0000950 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christopher91a31902013-01-16 01:22:32 +0000951 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo),
952 tunit, elements, RecordTy);
953
954 // Bump field number for next field.
955 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +0000956 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000957 }
958}
959
960/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
961/// function type is not updated to include implicit "this" pointer. Use this
962/// routine to get a method type which includes "this" pointer.
David Blaikie469f0792013-05-22 23:22:42 +0000963llvm::DICompositeType
Guy Benyei11169dd2012-12-18 14:30:41 +0000964CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
965 llvm::DIFile Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +0000966 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +0000967 if (Method->isStatic())
David Blaikie469f0792013-05-22 23:22:42 +0000968 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +0000969 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
970 Func, Unit);
971}
David Blaikie2aaf0652013-01-07 22:24:59 +0000972
David Blaikie469f0792013-05-22 23:22:42 +0000973llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie7eb06852013-01-07 23:06:35 +0000974 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000975 // Add "this" pointer.
David Blaikie7eb06852013-01-07 23:06:35 +0000976 llvm::DIArray Args = llvm::DICompositeType(
977 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +0000978 assert (Args.getNumElements() && "Invalid number of arguments!");
979
980 SmallVector<llvm::Value *, 16> Elts;
981
982 // First element is always return type. For 'void' functions it is NULL.
983 Elts.push_back(Args.getElement(0));
984
David Blaikie2aaf0652013-01-07 22:24:59 +0000985 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +0000986 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +0000987 if (isa<ClassTemplateSpecializationDecl>(RD)) {
988 // Create pointer type directly in this case.
989 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
990 QualType PointeeTy = ThisPtrTy->getPointeeType();
991 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000992 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +0000993 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
994 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopher0fdcb312013-05-16 00:52:20 +0000995 llvm::DIType ThisPtrType =
996 DBuilder.createPointerType(PointeeType, Size, Align);
David Blaikie2aaf0652013-01-07 22:24:59 +0000997 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
998 // TODO: This and the artificial type below are misleading, the
999 // types aren't artificial the argument is, but the current
1000 // metadata doesn't represent that.
1001 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1002 Elts.push_back(ThisPtrType);
1003 } else {
1004 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
1005 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1006 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1007 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001008 }
1009
1010 // Copy rest of the arguments.
1011 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
1012 Elts.push_back(Args.getElement(i));
1013
1014 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1015
Adrian Prantl0630eb72013-12-18 21:48:18 +00001016 unsigned Flags = 0;
1017 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1018 Flags |= llvm::DIDescriptor::FlagLValueReference;
1019 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1020 Flags |= llvm::DIDescriptor::FlagRValueReference;
1021
1022 return DBuilder.createSubroutineType(Unit, EltTypeArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001023}
1024
Eric Christopherb2a008c2013-05-16 00:45:12 +00001025/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001026/// inside a function.
1027static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1028 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1029 return isFunctionLocalClass(NRD);
1030 if (isa<FunctionDecl>(RD->getDeclContext()))
1031 return true;
1032 return false;
1033}
1034
1035/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1036/// a single member function GlobalDecl.
1037llvm::DISubprogram
1038CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
1039 llvm::DIFile Unit,
1040 llvm::DIType RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001041 bool IsCtorOrDtor =
Guy Benyei11169dd2012-12-18 14:30:41 +00001042 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001043
Guy Benyei11169dd2012-12-18 14:30:41 +00001044 StringRef MethodName = getFunctionName(Method);
David Blaikie469f0792013-05-22 23:22:42 +00001045 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001046
1047 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1048 // make sense to give a single ctor/dtor a linkage name.
1049 StringRef MethodLinkageName;
1050 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1051 MethodLinkageName = CGM.getMangledName(Method);
1052
1053 // Get the location for the method.
David Blaikie7fceebf2013-08-19 03:37:48 +00001054 llvm::DIFile MethodDefUnit;
1055 unsigned MethodLine = 0;
1056 if (!Method->isImplicit()) {
1057 MethodDefUnit = getOrCreateFile(Method->getLocation());
1058 MethodLine = getLineNumber(Method->getLocation());
1059 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001060
1061 // Collect virtual method info.
1062 llvm::DIType ContainingType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001063 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001064 unsigned VIndex = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001065
Guy Benyei11169dd2012-12-18 14:30:41 +00001066 if (Method->isVirtual()) {
1067 if (Method->isPure())
1068 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1069 else
1070 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001071
Guy Benyei11169dd2012-12-18 14:30:41 +00001072 // It doesn't make sense to give a virtual destructor a vtable index,
1073 // since a single destructor has two entries in the vtable.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001074 // FIXME: Add proper support for debug info for virtual calls in
1075 // the Microsoft ABI, where we may use multiple vptrs to make a vftable
1076 // lookup if we have multiple or virtual inheritance.
1077 if (!isa<CXXDestructorDecl>(Method) &&
1078 !CGM.getTarget().getCXXABI().isMicrosoft())
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001079 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
Guy Benyei11169dd2012-12-18 14:30:41 +00001080 ContainingType = RecordTy;
1081 }
1082
1083 unsigned Flags = 0;
1084 if (Method->isImplicit())
1085 Flags |= llvm::DIDescriptor::FlagArtificial;
1086 AccessSpecifier Access = Method->getAccess();
1087 if (Access == clang::AS_private)
1088 Flags |= llvm::DIDescriptor::FlagPrivate;
1089 else if (Access == clang::AS_protected)
1090 Flags |= llvm::DIDescriptor::FlagProtected;
1091 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1092 if (CXXC->isExplicit())
1093 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001094 } else if (const CXXConversionDecl *CXXC =
Guy Benyei11169dd2012-12-18 14:30:41 +00001095 dyn_cast<CXXConversionDecl>(Method)) {
1096 if (CXXC->isExplicit())
1097 Flags |= llvm::DIDescriptor::FlagExplicit;
1098 }
1099 if (Method->hasPrototype())
1100 Flags |= llvm::DIDescriptor::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001101 if (Method->getRefQualifier() == RQ_LValue)
1102 Flags |= llvm::DIDescriptor::FlagLValueReference;
1103 if (Method->getRefQualifier() == RQ_RValue)
1104 Flags |= llvm::DIDescriptor::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001105
1106 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1107 llvm::DISubprogram SP =
Eric Christopherb2a008c2013-05-16 00:45:12 +00001108 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Guy Benyei11169dd2012-12-18 14:30:41 +00001109 MethodDefUnit, MethodLine,
Eric Christopherb2a008c2013-05-16 00:45:12 +00001110 MethodTy, /*isLocalToUnit=*/false,
Guy Benyei11169dd2012-12-18 14:30:41 +00001111 /* isDefinition=*/ false,
1112 Virtuality, VIndex, ContainingType,
1113 Flags, CGM.getLangOpts().Optimize, NULL,
1114 TParamsArray);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001115
Guy Benyei11169dd2012-12-18 14:30:41 +00001116 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
1117
1118 return SP;
1119}
1120
1121/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001122/// C++ member functions. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001123/// a Record.
1124void CGDebugInfo::
1125CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
1126 SmallVectorImpl<llvm::Value *> &EltTys,
1127 llvm::DIType RecordTy) {
1128
1129 // Since we want more than just the individual member decls if we
1130 // have templated functions iterate over every declaration to gather
1131 // the functions.
Aaron Ballman629afae2014-03-07 19:56:05 +00001132 for(const auto *I : RD->decls()) {
1133 if (const auto *Method = dyn_cast<CXXMethodDecl>(I)) {
David Blaikiea6cc8212013-08-28 20:58:00 +00001134 // Reuse the existing member function declaration if it exists.
David Blaikie8c8e8e22013-08-28 20:24:55 +00001135 // It may be associated with the declaration of the type & should be
1136 // reused as we're building the definition.
David Blaikiea6cc8212013-08-28 20:58:00 +00001137 //
1138 // This situation can arise in the vtable-based debug info reduction where
1139 // implicit members are emitted in a non-vtable TU.
David Blaikie6943dea2013-08-20 01:28:15 +00001140 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
1141 SPCache.find(Method->getCanonicalDecl());
David Blaikiefae219a2013-08-28 17:27:13 +00001142 if (MI == SPCache.end()) {
David Blaikie8c8e8e22013-08-28 20:24:55 +00001143 // If the member is implicit, lazily create it when we see the
1144 // definition, not before. (an ODR-used implicit default ctor that's
1145 // never actually code generated should not produce debug info)
David Blaikiefae219a2013-08-28 17:27:13 +00001146 if (!Method->isImplicit())
1147 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
1148 } else
David Blaikie6943dea2013-08-20 01:28:15 +00001149 EltTys.push_back(MI->second);
Aaron Ballman629afae2014-03-07 19:56:05 +00001150 } else if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(I)) {
David Blaikief2053af2013-08-28 23:06:52 +00001151 // Add any template specializations that have already been seen. Like
1152 // implicit member functions, these may have been added to a declaration
1153 // in the case of vtable-based debug info reduction.
Eric Christopherf86c4052013-08-28 23:12:10 +00001154 for (FunctionTemplateDecl::spec_iterator SI = FTD->spec_begin(),
1155 SE = FTD->spec_end();
1156 SI != SE; ++SI) {
David Blaikief2053af2013-08-28 23:06:52 +00001157 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
1158 SPCache.find(cast<CXXMethodDecl>(*SI)->getCanonicalDecl());
1159 if (MI != SPCache.end())
1160 EltTys.push_back(MI->second);
1161 }
David Blaikie6943dea2013-08-20 01:28:15 +00001162 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001163 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001164}
Guy Benyei11169dd2012-12-18 14:30:41 +00001165
Guy Benyei11169dd2012-12-18 14:30:41 +00001166/// CollectCXXBases - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001167/// C++ base classes. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001168/// a Record.
1169void CGDebugInfo::
1170CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1171 SmallVectorImpl<llvm::Value *> &EltTys,
1172 llvm::DIType RecordTy) {
1173
1174 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001175 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001176 unsigned BFlags = 0;
1177 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001178
Guy Benyei11169dd2012-12-18 14:30:41 +00001179 const CXXRecordDecl *Base =
Aaron Ballman574705e2014-03-13 15:41:46 +00001180 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001181
Aaron Ballman574705e2014-03-13 15:41:46 +00001182 if (BI.isVirtual()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001183 // virtual base offset offset is -ve. The code generator emits dwarf
1184 // expression where it expects +ve number.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001185 BaseOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001186 0 - CGM.getItaniumVTableContext()
Guy Benyei11169dd2012-12-18 14:30:41 +00001187 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1188 BFlags = llvm::DIDescriptor::FlagVirtual;
1189 } else
1190 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1191 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1192 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001193
Aaron Ballman574705e2014-03-13 15:41:46 +00001194 AccessSpecifier Access = BI.getAccessSpecifier();
Guy Benyei11169dd2012-12-18 14:30:41 +00001195 if (Access == clang::AS_private)
1196 BFlags |= llvm::DIDescriptor::FlagPrivate;
1197 else if (Access == clang::AS_protected)
1198 BFlags |= llvm::DIDescriptor::FlagProtected;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001199
1200 llvm::DIType DTy =
1201 DBuilder.createInheritance(RecordTy,
Aaron Ballman574705e2014-03-13 15:41:46 +00001202 getOrCreateType(BI.getType(), Unit),
Guy Benyei11169dd2012-12-18 14:30:41 +00001203 BaseOffset, BFlags);
1204 EltTys.push_back(DTy);
1205 }
1206}
1207
1208/// CollectTemplateParams - A helper function to collect template parameters.
1209llvm::DIArray CGDebugInfo::
1210CollectTemplateParams(const TemplateParameterList *TPList,
David Blaikie47c11502013-06-22 18:59:18 +00001211 ArrayRef<TemplateArgument> TAList,
Guy Benyei11169dd2012-12-18 14:30:41 +00001212 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001213 SmallVector<llvm::Value *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001214 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1215 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001216 StringRef Name;
1217 if (TPList)
1218 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001219 switch (TA.getKind()) {
1220 case TemplateArgument::Type: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001221 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1222 llvm::DITemplateTypeParameter TTP =
David Blaikie47c11502013-06-22 18:59:18 +00001223 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001224 TemplateParams.push_back(TTP);
David Blaikie38079fd2013-05-10 21:53:14 +00001225 } break;
1226 case TemplateArgument::Integral: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001227 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1228 llvm::DITemplateValueParameter TVP =
David Blaikie38079fd2013-05-10 21:53:14 +00001229 DBuilder.createTemplateValueParameter(
David Blaikie47c11502013-06-22 18:59:18 +00001230 TheCU, Name, TTy,
David Blaikie38079fd2013-05-10 21:53:14 +00001231 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1232 TemplateParams.push_back(TVP);
1233 } break;
1234 case TemplateArgument::Declaration: {
1235 const ValueDecl *D = TA.getAsDecl();
1236 bool InstanceMember = D->isCXXInstanceMember();
1237 QualType T = InstanceMember
1238 ? CGM.getContext().getMemberPointerType(
1239 D->getType(), cast<RecordDecl>(D->getDeclContext())
1240 ->getTypeForDecl())
1241 : CGM.getContext().getPointerType(D->getType());
1242 llvm::DIType TTy = getOrCreateType(T, Unit);
1243 llvm::Value *V = 0;
1244 // Variable pointer template parameters have a value that is the address
1245 // of the variable.
1246 if (const VarDecl *VD = dyn_cast<VarDecl>(D))
1247 V = CGM.GetAddrOfGlobalVar(VD);
1248 // Member function pointers have special support for building them, though
1249 // this is currently unsupported in LLVM CodeGen.
David Blaikied900f982013-05-13 06:57:50 +00001250 if (InstanceMember) {
David Blaikie38079fd2013-05-10 21:53:14 +00001251 if (const CXXMethodDecl *method = dyn_cast<CXXMethodDecl>(D))
1252 V = CGM.getCXXABI().EmitMemberPointer(method);
David Blaikied900f982013-05-13 06:57:50 +00001253 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1254 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001255 // Member data pointers have special handling too to compute the fixed
1256 // offset within the object.
1257 if (isa<FieldDecl>(D)) {
1258 // These five lines (& possibly the above member function pointer
1259 // handling) might be able to be refactored to use similar code in
1260 // CodeGenModule::getMemberPointerConstant
1261 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1262 CharUnits chars =
1263 CGM.getContext().toCharUnitsFromBits((int64_t) fieldOffset);
1264 V = CGM.getCXXABI().EmitMemberDataPointer(
1265 cast<MemberPointerType>(T.getTypePtr()), chars);
1266 }
1267 llvm::DITemplateValueParameter TVP =
David Majnemera3644d62013-08-25 22:13:27 +00001268 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1269 V->stripPointerCasts());
David Blaikie38079fd2013-05-10 21:53:14 +00001270 TemplateParams.push_back(TVP);
1271 } break;
1272 case TemplateArgument::NullPtr: {
1273 QualType T = TA.getNullPtrType();
1274 llvm::DIType TTy = getOrCreateType(T, Unit);
1275 llvm::Value *V = 0;
1276 // Special case member data pointer null values since they're actually -1
1277 // instead of zero.
1278 if (const MemberPointerType *MPT =
1279 dyn_cast<MemberPointerType>(T.getTypePtr()))
1280 // But treat member function pointers as simple zero integers because
1281 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1282 // CodeGen grows handling for values of non-null member function
1283 // pointers then perhaps we could remove this special case and rely on
1284 // EmitNullMemberPointer for member function pointers.
1285 if (MPT->isMemberDataPointer())
1286 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1287 if (!V)
1288 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1289 llvm::DITemplateValueParameter TVP =
David Blaikie47c11502013-06-22 18:59:18 +00001290 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V);
David Blaikie38079fd2013-05-10 21:53:14 +00001291 TemplateParams.push_back(TVP);
1292 } break;
David Blaikie47c11502013-06-22 18:59:18 +00001293 case TemplateArgument::Template: {
1294 llvm::DITemplateValueParameter TVP =
1295 DBuilder.createTemplateTemplateParameter(
1296 TheCU, Name, llvm::DIType(),
1297 TA.getAsTemplate().getAsTemplateDecl()
1298 ->getQualifiedNameAsString());
1299 TemplateParams.push_back(TVP);
1300 } break;
1301 case TemplateArgument::Pack: {
1302 llvm::DITemplateValueParameter TVP =
1303 DBuilder.createTemplateParameterPack(
1304 TheCU, Name, llvm::DIType(),
1305 CollectTemplateParams(NULL, TA.getPackAsArray(), Unit));
1306 TemplateParams.push_back(TVP);
1307 } break;
David Majnemer5559d472013-08-24 08:21:10 +00001308 case TemplateArgument::Expression: {
1309 const Expr *E = TA.getAsExpr();
1310 QualType T = E->getType();
1311 llvm::Value *V = CGM.EmitConstantExpr(E, T);
1312 assert(V && "Expression in template argument isn't constant");
1313 llvm::DIType TTy = getOrCreateType(T, Unit);
1314 llvm::DITemplateValueParameter TVP =
1315 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1316 V->stripPointerCasts());
1317 TemplateParams.push_back(TVP);
1318 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001319 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001320 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001321 case TemplateArgument::Null:
1322 llvm_unreachable(
1323 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001324 }
1325 }
1326 return DBuilder.getOrCreateArray(TemplateParams);
1327}
1328
1329/// CollectFunctionTemplateParams - A helper function to collect debug
1330/// info for function template parameters.
1331llvm::DIArray CGDebugInfo::
1332CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1333 if (FD->getTemplatedKind() ==
1334 FunctionDecl::TK_FunctionTemplateSpecialization) {
1335 const TemplateParameterList *TList =
1336 FD->getTemplateSpecializationInfo()->getTemplate()
1337 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001338 return CollectTemplateParams(
1339 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001340 }
1341 return llvm::DIArray();
1342}
1343
1344/// CollectCXXTemplateParams - A helper function to collect debug info for
1345/// template parameters.
1346llvm::DIArray CGDebugInfo::
1347CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1348 llvm::DIFile Unit) {
1349 llvm::PointerUnion<ClassTemplateDecl *,
1350 ClassTemplatePartialSpecializationDecl *>
1351 PU = TSpecial->getSpecializedTemplateOrPartial();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001352
Guy Benyei11169dd2012-12-18 14:30:41 +00001353 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1354 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1355 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1356 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001357 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001358}
1359
1360/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1361llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1362 if (VTablePtrType.isValid())
1363 return VTablePtrType;
1364
1365 ASTContext &Context = CGM.getContext();
1366
1367 /* Function type */
1368 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1369 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1370 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1371 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1372 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1373 "__vtbl_ptr_type");
1374 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1375 return VTablePtrType;
1376}
1377
1378/// getVTableName - Get vtable name for the given Class.
1379StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001380 // Copy the gdb compatible name on the side and use its reference.
1381 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001382}
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 Christopher0fdcb312013-05-16 00:52:20 +00001403 0, Size, 0, 0,
1404 llvm::DIDescriptor::FlagArtificial,
Guy Benyei11169dd2012-12-18 14:30:41 +00001405 getOrCreateVTablePtrType(Unit));
1406 EltTys.push_back(VPTR);
1407}
1408
Eric Christopherb2a008c2013-05-16 00:45:12 +00001409/// getOrCreateRecordType - Emit record type's standalone debug info.
1410llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00001411 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001412 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-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 Christopherc0c5d462013-02-21 22:35:08 +00001420 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001421 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001422 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantl73409ce2013-03-11 18:33:46 +00001423 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001424 return T;
1425}
1426
David Blaikieb2e86eb2013-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 Blaikie0856f662014-03-04 22:01:08 +00001434 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1435 return;
1436
David Blaikie6943dea2013-08-20 01:28:15 +00001437 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1438 if (CXXDecl->isDynamicClass())
1439 return;
1440
David Blaikieb2e86eb2013-08-15 20:49:17 +00001441 QualType Ty = CGM.getContext().getRecordType(RD);
1442 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie6943dea2013-08-20 01:28:15 +00001443 if (T && T.isForwardDecl())
1444 completeClassData(RD);
1445}
1446
1447void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1448 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001449 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001450 QualType Ty = CGM.getContext().getRecordType(RD);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001451 void* TyPtr = Ty.getAsOpaquePtr();
1452 if (CompletedTypeCache.count(TyPtr))
1453 return;
1454 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1455 assert(!Res.isForwardDecl());
1456 CompletedTypeCache[TyPtr] = Res;
1457 TypeCache[TyPtr] = Res;
1458}
1459
David Blaikie0e716b42014-03-03 23:48:23 +00001460static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1461 CXXRecordDecl::method_iterator End) {
1462 for (; I != End; ++I)
1463 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001464 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1465 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001466 return true;
1467 return false;
1468}
1469
1470static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
1471 const RecordDecl *RD,
1472 const LangOptions &LangOpts) {
1473 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1474 return false;
1475
1476 if (!LangOpts.CPlusPlus)
1477 return false;
1478
1479 if (!RD->isCompleteDefinitionRequired())
1480 return true;
1481
1482 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1483
1484 if (!CXXDecl)
1485 return false;
1486
1487 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1488 return true;
1489
1490 TemplateSpecializationKind Spec = TSK_Undeclared;
1491 if (const ClassTemplateSpecializationDecl *SD =
1492 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1493 Spec = SD->getSpecializationKind();
1494
1495 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1496 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1497 CXXDecl->method_end()))
1498 return true;
1499
1500 return false;
1501}
1502
Guy Benyei11169dd2012-12-18 14:30:41 +00001503/// CreateType - get structure or union type.
David Blaikie99dab3b2013-09-04 22:03:57 +00001504llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001505 RecordDecl *RD = Ty->getDecl();
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001506 llvm::DICompositeType T(getTypeOrNull(QualType(Ty, 0)));
David Blaikie0e716b42014-03-03 23:48:23 +00001507 if (T || shouldOmitDefinition(DebugKind, RD, CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001508 if (!T)
David Blaikie65ec94e2014-02-18 20:52:05 +00001509 T = getOrCreateRecordFwdDecl(
1510 Ty, getContextDescriptor(cast<Decl>(RD->getDeclContext())));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001511 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001512 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001513
David Blaikieb2e86eb2013-08-15 20:49:17 +00001514 return CreateTypeDefinition(Ty);
1515}
1516
1517llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1518 RecordDecl *RD = Ty->getDecl();
1519
Guy Benyei11169dd2012-12-18 14:30:41 +00001520 // Get overall information about the record type for the debug info.
1521 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1522
1523 // Records and classes and unions can all be recursive. To handle them, we
1524 // first generate a debug descriptor for the struct as a forward declaration.
1525 // Then (if it is a definition) we go through and get debug info for all of
1526 // its members. Finally, we create a descriptor for the complete type (which
1527 // may refer to the forward decl if the struct is recursive) and replace all
1528 // uses of the forward declaration with the final definition.
1529
David Blaikie4a2b5ef2013-08-12 22:24:20 +00001530 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Ren0d441f12013-07-02 19:01:53 +00001531 assert(FwdDecl.isCompositeType() &&
David Blaikie469f0792013-05-22 23:22:42 +00001532 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei11169dd2012-12-18 14:30:41 +00001533
1534 if (FwdDecl.isForwardDecl())
1535 return FwdDecl;
1536
David Blaikieadfbf992013-08-18 16:55:33 +00001537 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1538 CollectContainingType(CXXDecl, FwdDecl);
1539
Guy Benyei11169dd2012-12-18 14:30:41 +00001540 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001541 LexicalBlockStack.push_back(&*FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001542 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1543
Adrian Prantla03a85a2013-03-06 22:03:30 +00001544 // Add this to the completed-type cache while we're completing it recursively.
Guy Benyei11169dd2012-12-18 14:30:41 +00001545 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1546
1547 // Convert all the elements.
1548 SmallVector<llvm::Value *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001549 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001550
1551 // Note: The split of CXXDecl information here is intentional, the
1552 // gdb tests will depend on a certain ordering at printout. The debug
1553 // information offsets are still correct if we merge them all together
1554 // though.
1555 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1556 if (CXXDecl) {
1557 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1558 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1559 }
1560
Eric Christopher91a31902013-01-16 01:22:32 +00001561 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001562 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001563 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001564 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001565
1566 LexicalBlockStack.pop_back();
1567 RegionMap.erase(Ty->getDecl());
1568
1569 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
David Blaikie4a5b8952013-08-01 20:31:40 +00001570 FwdDecl.setTypeArray(Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001571
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001572 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1573 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001574}
1575
1576/// CreateType - get objective-c object type.
1577llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1578 llvm::DIFile Unit) {
1579 // Ignore protocols.
1580 return getOrCreateType(Ty->getBaseType(), Unit);
1581}
1582
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001583
1584/// \return true if Getter has the default name for the property PD.
1585static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1586 const ObjCMethodDecl *Getter) {
1587 assert(PD);
1588 if (!Getter)
1589 return true;
1590
1591 assert(Getter->getDeclName().isObjCZeroArgSelector());
1592 return PD->getName() ==
1593 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
1594}
1595
1596/// \return true if Setter has the default name for the property PD.
1597static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1598 const ObjCMethodDecl *Setter) {
1599 assert(PD);
1600 if (!Setter)
1601 return true;
1602
1603 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001604 return SelectorTable::constructSetterName(PD->getName()) ==
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001605 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
1606}
1607
Guy Benyei11169dd2012-12-18 14:30:41 +00001608/// CreateType - get objective-c interface type.
1609llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1610 llvm::DIFile Unit) {
1611 ObjCInterfaceDecl *ID = Ty->getDecl();
1612 if (!ID)
1613 return llvm::DIType();
1614
1615 // Get overall information about the record type for the debug info.
1616 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1617 unsigned Line = getLineNumber(ID->getLocation());
1618 unsigned RuntimeLang = TheCU.getLanguage();
1619
1620 // If this is just a forward declaration return a special forward-declaration
1621 // debug type since we won't be able to lay out the entire type.
1622 ObjCInterfaceDecl *Def = ID->getDefinition();
1623 if (!Def) {
1624 llvm::DIType FwdDecl =
1625 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001626 ID->getName(), TheCU, DefUnit, Line,
1627 RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001628 return FwdDecl;
1629 }
1630
1631 ID = Def;
1632
1633 // Bit size, align and offset of the type.
1634 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1635 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1636
1637 unsigned Flags = 0;
1638 if (ID->getImplementation())
1639 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1640
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001641 llvm::DICompositeType RealDecl =
Guy Benyei11169dd2012-12-18 14:30:41 +00001642 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1643 Line, Size, Align, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00001644 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001645
1646 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1647 // will find it and we're emitting the complete type.
Adrian Prantla03a85a2013-03-06 22:03:30 +00001648 QualType QualTy = QualType(Ty, 0);
1649 CompletedTypeCache[QualTy.getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001650
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001651 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001652 LexicalBlockStack.push_back(static_cast<llvm::MDNode*>(RealDecl));
Guy Benyei11169dd2012-12-18 14:30:41 +00001653 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1654
1655 // Convert all the elements.
1656 SmallVector<llvm::Value *, 16> EltTys;
1657
1658 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1659 if (SClass) {
1660 llvm::DIType SClassTy =
1661 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1662 if (!SClassTy.isValid())
1663 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001664
Guy Benyei11169dd2012-12-18 14:30:41 +00001665 llvm::DIType InhTag =
1666 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1667 EltTys.push_back(InhTag);
1668 }
1669
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001670 // Create entries for all of the properties.
Aaron Ballmand174edf2014-03-13 19:11:50 +00001671 for (const auto *PD : ID->properties()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001672 SourceLocation Loc = PD->getLocation();
1673 llvm::DIFile PUnit = getOrCreateFile(Loc);
1674 unsigned PLine = getLineNumber(Loc);
1675 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1676 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1677 llvm::MDNode *PropertyNode =
1678 DBuilder.createObjCProperty(PD->getName(),
Eric Christopherc0c5d462013-02-21 22:35:08 +00001679 PUnit, PLine,
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001680 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001681 getSelectorName(PD->getGetterName()),
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001682 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001683 getSelectorName(PD->getSetterName()),
1684 PD->getPropertyAttributes(),
Eric Christopherc0c5d462013-02-21 22:35:08 +00001685 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001686 EltTys.push_back(PropertyNode);
1687 }
1688
1689 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1690 unsigned FieldNo = 0;
1691 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1692 Field = Field->getNextIvar(), ++FieldNo) {
1693 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1694 if (!FieldTy.isValid())
1695 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001696
Guy Benyei11169dd2012-12-18 14:30:41 +00001697 StringRef FieldName = Field->getName();
1698
1699 // Ignore unnamed fields.
1700 if (FieldName.empty())
1701 continue;
1702
1703 // Get the location for the field.
1704 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1705 unsigned FieldLine = getLineNumber(Field->getLocation());
1706 QualType FType = Field->getType();
1707 uint64_t FieldSize = 0;
1708 unsigned FieldAlign = 0;
1709
1710 if (!FType->isIncompleteArrayType()) {
1711
1712 // Bit size, align and offset of the type.
1713 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001714 ? Field->getBitWidthValue(CGM.getContext())
1715 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001716 FieldAlign = CGM.getContext().getTypeAlign(FType);
1717 }
1718
1719 uint64_t FieldOffset;
1720 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1721 // We don't know the runtime offset of an ivar if we're using the
1722 // non-fragile ABI. For bitfields, use the bit offset into the first
1723 // byte of storage of the bitfield. For other fields, use zero.
1724 if (Field->isBitField()) {
1725 FieldOffset = CGM.getObjCRuntime().ComputeBitfieldBitOffset(
1726 CGM, ID, Field);
1727 FieldOffset %= CGM.getContext().getCharWidth();
1728 } else {
1729 FieldOffset = 0;
1730 }
1731 } else {
1732 FieldOffset = RL.getFieldOffset(FieldNo);
1733 }
1734
1735 unsigned Flags = 0;
1736 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1737 Flags = llvm::DIDescriptor::FlagProtected;
1738 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1739 Flags = llvm::DIDescriptor::FlagPrivate;
1740
1741 llvm::MDNode *PropertyNode = NULL;
1742 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001743 if (ObjCPropertyImplDecl *PImpD =
Guy Benyei11169dd2012-12-18 14:30:41 +00001744 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1745 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001746 SourceLocation Loc = PD->getLocation();
1747 llvm::DIFile PUnit = getOrCreateFile(Loc);
1748 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001749 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1750 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1751 PropertyNode =
1752 DBuilder.createObjCProperty(PD->getName(),
1753 PUnit, PLine,
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001754 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001755 getSelectorName(PD->getGetterName()),
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001756 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001757 getSelectorName(PD->getSetterName()),
1758 PD->getPropertyAttributes(),
1759 getOrCreateType(PD->getType(), PUnit));
1760 }
1761 }
1762 }
1763 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1764 FieldLine, FieldSize, FieldAlign,
1765 FieldOffset, Flags, FieldTy,
1766 PropertyNode);
1767 EltTys.push_back(FieldTy);
1768 }
1769
1770 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001771 RealDecl.setTypeArray(Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001772
1773 // If the implementation is not yet set, we do not want to mark it
1774 // as complete. An implementation may declare additional
1775 // private ivars that we would miss otherwise.
1776 if (ID->getImplementation() == 0)
1777 CompletedTypeCache.erase(QualTy.getAsOpaquePtr());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001778
Guy Benyei11169dd2012-12-18 14:30:41 +00001779 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001780 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001781}
1782
1783llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1784 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1785 int64_t Count = Ty->getNumElements();
1786 if (Count == 0)
1787 // If number of elements are not known then this is an unbounded array.
1788 // Use Count == -1 to express such arrays.
1789 Count = -1;
1790
1791 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1792 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1793
1794 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1795 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1796
1797 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1798}
1799
1800llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1801 llvm::DIFile Unit) {
1802 uint64_t Size;
1803 uint64_t Align;
1804
1805 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1806 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1807 Size = 0;
1808 Align =
1809 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1810 } else if (Ty->isIncompleteArrayType()) {
1811 Size = 0;
1812 if (Ty->getElementType()->isIncompleteType())
1813 Align = 0;
1814 else
1815 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001816 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001817 Size = 0;
1818 Align = 0;
1819 } else {
1820 // Size and align of the whole array, not the element type.
1821 Size = CGM.getContext().getTypeSize(Ty);
1822 Align = CGM.getContext().getTypeAlign(Ty);
1823 }
1824
1825 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1826 // interior arrays, do we care? Why aren't nested arrays represented the
1827 // obvious/recursive way?
1828 SmallVector<llvm::Value *, 8> Subscripts;
1829 QualType EltTy(Ty, 0);
1830 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1831 // If the number of elements is known, then count is that number. Otherwise,
1832 // it's -1. This allows us to represent a subrange with an array of 0
1833 // elements, like this:
1834 //
1835 // struct foo {
1836 // int x[0];
1837 // };
1838 int64_t Count = -1; // Count == -1 is an unbounded array.
1839 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1840 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001841
Guy Benyei11169dd2012-12-18 14:30:41 +00001842 // FIXME: Verify this is right for VLAs.
1843 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1844 EltTy = Ty->getElementType();
1845 }
1846
1847 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1848
Eric Christopherb2a008c2013-05-16 00:45:12 +00001849 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001850 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1851 SubscriptArray);
1852 return DbgTy;
1853}
1854
Eric Christopherb2a008c2013-05-16 00:45:12 +00001855llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001856 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001857 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001858 Ty, Ty->getPointeeType(), Unit);
1859}
1860
Eric Christopherb2a008c2013-05-16 00:45:12 +00001861llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001862 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001863 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001864 Ty, Ty->getPointeeType(), Unit);
1865}
1866
Eric Christopherb2a008c2013-05-16 00:45:12 +00001867llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001868 llvm::DIFile U) {
David Blaikie2c705ca2013-01-19 19:20:56 +00001869 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1870 if (!Ty->getPointeeType()->isFunctionType())
1871 return DBuilder.createMemberPointerType(
David Blaikie99dab3b2013-09-04 22:03:57 +00001872 getOrCreateType(Ty->getPointeeType(), U), ClassType);
Adrian Prantl0866acd2013-12-19 01:38:47 +00001873
1874 const FunctionProtoType *FPT =
1875 Ty->getPointeeType()->getAs<FunctionProtoType>();
David Blaikie2c705ca2013-01-19 19:20:56 +00001876 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
Adrian Prantl0866acd2013-12-19 01:38:47 +00001877 CGM.getContext().getPointerType(QualType(Ty->getClass(),
1878 FPT->getTypeQuals())),
1879 FPT, U), ClassType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001880}
1881
Eric Christopherb2a008c2013-05-16 00:45:12 +00001882llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001883 llvm::DIFile U) {
1884 // Ignore the atomic wrapping
1885 // FIXME: What is the correct representation?
1886 return getOrCreateType(Ty->getValueType(), U);
1887}
1888
1889/// CreateEnumType - get enumeration type.
Manman Ren501ecf92013-08-28 21:46:36 +00001890llvm::DIType CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00001891 const EnumDecl *ED = Ty->getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00001892 uint64_t Size = 0;
1893 uint64_t Align = 0;
1894 if (!ED->getTypeForDecl()->isIncompleteType()) {
1895 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1896 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1897 }
1898
Manman Rene0064d82013-08-29 23:19:58 +00001899 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1900
Guy Benyei11169dd2012-12-18 14:30:41 +00001901 // If this is just a forward declaration, construct an appropriately
1902 // marked node and just return it.
1903 if (!ED->getDefinition()) {
1904 llvm::DIDescriptor EDContext;
1905 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1906 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1907 unsigned Line = getLineNumber(ED->getLocation());
1908 StringRef EDName = ED->getName();
1909 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_enumeration_type,
1910 EDName, EDContext, DefUnit, Line, 0,
Manman Rene0064d82013-08-29 23:19:58 +00001911 Size, Align, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001912 }
1913
1914 // Create DIEnumerator elements for each enumerator.
1915 SmallVector<llvm::Value *, 16> Enumerators;
1916 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00001917 for (const auto *Enum : ED->enumerators()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001918 Enumerators.push_back(
1919 DBuilder.createEnumerator(Enum->getName(),
David Blaikiece1ae382013-06-24 07:13:13 +00001920 Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001921 }
1922
1923 // Return a CompositeType for the enum itself.
1924 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1925
1926 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1927 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001928 llvm::DIDescriptor EnumContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00001929 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantlc60dc712013-04-19 19:56:39 +00001930 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei11169dd2012-12-18 14:30:41 +00001931 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001932 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001933 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1934 Size, Align, EltArray,
Manman Rene0064d82013-08-29 23:19:58 +00001935 ClassTy, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001936 return DbgTy;
1937}
1938
David Blaikie05491062013-01-21 04:37:12 +00001939static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1940 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001941 do {
Adrian Prantl179af902013-09-26 21:35:50 +00001942 Qualifiers InnerQuals = T.getLocalQualifiers();
1943 // Qualifiers::operator+() doesn't like it if you add a Qualifier
1944 // that is already there.
1945 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
1946 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001947 QualType LastT = T;
1948 switch (T->getTypeClass()) {
1949 default:
David Blaikie05491062013-01-21 04:37:12 +00001950 return C.getQualifiedType(T.getTypePtr(), Quals);
Guy Benyei11169dd2012-12-18 14:30:41 +00001951 case Type::TemplateSpecialization:
1952 T = cast<TemplateSpecializationType>(T)->desugar();
1953 break;
1954 case Type::TypeOfExpr:
1955 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1956 break;
1957 case Type::TypeOf:
1958 T = cast<TypeOfType>(T)->getUnderlyingType();
1959 break;
1960 case Type::Decltype:
1961 T = cast<DecltypeType>(T)->getUnderlyingType();
1962 break;
1963 case Type::UnaryTransform:
1964 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1965 break;
1966 case Type::Attributed:
1967 T = cast<AttributedType>(T)->getEquivalentType();
1968 break;
1969 case Type::Elaborated:
1970 T = cast<ElaboratedType>(T)->getNamedType();
1971 break;
1972 case Type::Paren:
1973 T = cast<ParenType>(T)->getInnerType();
1974 break;
David Blaikie05491062013-01-21 04:37:12 +00001975 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00001976 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00001977 break;
1978 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00001979 QualType DT = cast<AutoType>(T)->getDeducedType();
1980 if (DT.isNull())
1981 return T;
1982 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00001983 break;
1984 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001985
Guy Benyei11169dd2012-12-18 14:30:41 +00001986 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00001987 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00001988 } while (true);
1989}
1990
Eric Christopher0fdcb312013-05-16 00:52:20 +00001991/// getType - Get the type from the cache or return null type if it doesn't
1992/// exist.
Guy Benyei11169dd2012-12-18 14:30:41 +00001993llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
1994
1995 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00001996 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001997
Guy Benyei11169dd2012-12-18 14:30:41 +00001998 // Check for existing entry.
Adrian Prantl73409ce2013-03-11 18:33:46 +00001999 if (Ty->getTypeClass() == Type::ObjCInterface) {
2000 llvm::Value *V = getCachedInterfaceTypeOrNull(Ty);
2001 if (V)
2002 return llvm::DIType(cast<llvm::MDNode>(V));
2003 else return llvm::DIType();
2004 }
2005
Guy Benyei11169dd2012-12-18 14:30:41 +00002006 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2007 TypeCache.find(Ty.getAsOpaquePtr());
2008 if (it != TypeCache.end()) {
2009 // Verify that the debug info still exists.
2010 if (llvm::Value *V = it->second)
2011 return llvm::DIType(cast<llvm::MDNode>(V));
2012 }
2013
2014 return llvm::DIType();
2015}
2016
2017/// getCompletedTypeOrNull - Get the type from the cache or return null if it
2018/// doesn't exist.
2019llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
2020
2021 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002022 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002023
2024 // Check for existing entry.
Adrian Prantla03a85a2013-03-06 22:03:30 +00002025 llvm::Value *V = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002026 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2027 CompletedTypeCache.find(Ty.getAsOpaquePtr());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002028 if (it != CompletedTypeCache.end())
2029 V = it->second;
2030 else {
Adrian Prantl73409ce2013-03-11 18:33:46 +00002031 V = getCachedInterfaceTypeOrNull(Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002032 }
2033
Adrian Prantla03a85a2013-03-06 22:03:30 +00002034 // Verify that any cached debug info still exists.
David Blaikie80d28de2013-08-13 04:21:38 +00002035 return llvm::DIType(cast_or_null<llvm::MDNode>(V));
Guy Benyei11169dd2012-12-18 14:30:41 +00002036}
2037
David Blaikie0e716b42014-03-03 23:48:23 +00002038void CGDebugInfo::completeTemplateDefinition(
2039 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002040 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2041 return;
2042
David Blaikie0e716b42014-03-03 23:48:23 +00002043 completeClassData(&SD);
2044 // In case this type has no member function definitions being emitted, ensure
2045 // it is retained
2046 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2047}
2048
Adrian Prantl73409ce2013-03-11 18:33:46 +00002049/// getCachedInterfaceTypeOrNull - Get the type from the interface
2050/// cache, unless it needs to regenerated. Otherwise return null.
2051llvm::Value *CGDebugInfo::getCachedInterfaceTypeOrNull(QualType Ty) {
2052 // Is there a cached interface that hasn't changed?
2053 llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned > >
2054 ::iterator it1 = ObjCInterfaceCache.find(Ty.getAsOpaquePtr());
2055
2056 if (it1 != ObjCInterfaceCache.end())
2057 if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty))
2058 if (Checksum(Decl) == it1->second.second)
2059 // Return cached forward declaration.
2060 return it1->second.first;
2061
2062 return 0;
2063}
Guy Benyei11169dd2012-12-18 14:30:41 +00002064
2065/// getOrCreateType - Get the type from the cache or create a new
2066/// one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +00002067llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002068 if (Ty.isNull())
2069 return llvm::DIType();
2070
2071 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002072 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002073
David Blaikie99dab3b2013-09-04 22:03:57 +00002074 if (llvm::DIType T = getCompletedTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002075 return T;
2076
2077 // Otherwise create the type.
David Blaikie99dab3b2013-09-04 22:03:57 +00002078 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Adrian Prantl73409ce2013-03-11 18:33:46 +00002079 void* TyPtr = Ty.getAsOpaquePtr();
2080
2081 // And update the type cache.
2082 TypeCache[TyPtr] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002083
David Blaikie6a723442013-08-15 21:21:19 +00002084 // FIXME: this getTypeOrNull call seems silly when we just inserted the type
2085 // into the cache - but getTypeOrNull has a special case for cached interface
2086 // types. We should probably just pull that out as a special case for the
2087 // "else" block below & skip the otherwise needless lookup.
Guy Benyei11169dd2012-12-18 14:30:41 +00002088 llvm::DIType TC = getTypeOrNull(Ty);
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002089 if (TC && TC.isForwardDecl())
Adrian Prantl73409ce2013-03-11 18:33:46 +00002090 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
2091 else if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty)) {
2092 // Interface types may have elements added to them by a
2093 // subsequent implementation or extension, so we keep them in
2094 // the ObjCInterfaceCache together with a checksum. Instead of
Adrian Prantlc20237d2013-05-08 23:37:22 +00002095 // the (possibly) incomplete interface type, we return a forward
Adrian Prantl73409ce2013-03-11 18:33:46 +00002096 // declaration that gets RAUW'd in CGDebugInfo::finalize().
David Blaikie8e5939b2013-05-21 18:29:40 +00002097 std::pair<llvm::WeakVH, unsigned> &V = ObjCInterfaceCache[TyPtr];
2098 if (V.first)
2099 return llvm::DIType(cast<llvm::MDNode>(V.first));
2100 TC = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2101 Decl->getName(), TheCU, Unit,
2102 getLineNumber(Decl->getLocation()),
2103 TheCU.getLanguage());
2104 // Store the forward declaration in the cache.
2105 V.first = TC;
2106 V.second = Checksum(Decl);
Adrian Prantl73409ce2013-03-11 18:33:46 +00002107
David Blaikie8e5939b2013-05-21 18:29:40 +00002108 // Register the type for replacement in finalize().
2109 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
2110
Adrian Prantl73409ce2013-03-11 18:33:46 +00002111 return TC;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002112 }
2113
Guy Benyei11169dd2012-12-18 14:30:41 +00002114 if (!Res.isForwardDecl())
Adrian Prantl73409ce2013-03-11 18:33:46 +00002115 CompletedTypeCache[TyPtr] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002116
2117 return Res;
2118}
2119
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002120/// Currently the checksum of an interface includes the number of
2121/// ivars and property accessors.
Eric Christopher1ecc5632013-06-07 22:54:39 +00002122unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl817bbb32013-06-07 01:10:48 +00002123 // The assumption is that the number of ivars can only increase
2124 // monotonically, so it is safe to just use their current number as
2125 // a checksum.
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002126 unsigned Sum = 0;
2127 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
2128 Ivar != 0; Ivar = Ivar->getNextIvar())
2129 ++Sum;
2130
2131 return Sum;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002132}
2133
2134ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2135 switch (Ty->getTypeClass()) {
2136 case Type::ObjCObjectPointer:
Eric Christopher0fdcb312013-05-16 00:52:20 +00002137 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
2138 ->getPointeeType());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002139 case Type::ObjCInterface:
2140 return cast<ObjCInterfaceType>(Ty)->getDecl();
2141 default:
2142 return 0;
2143 }
2144}
2145
Guy Benyei11169dd2012-12-18 14:30:41 +00002146/// CreateTypeNode - Create a new debug type node.
David Blaikie99dab3b2013-09-04 22:03:57 +00002147llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002148 // Handle qualifiers, which recursively handles what they refer to.
2149 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002150 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002151
2152 const char *Diag = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002153
Guy Benyei11169dd2012-12-18 14:30:41 +00002154 // Work out details of type.
2155 switch (Ty->getTypeClass()) {
2156#define TYPE(Class, Base)
2157#define ABSTRACT_TYPE(Class, Base)
2158#define NON_CANONICAL_TYPE(Class, Base)
2159#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2160#include "clang/AST/TypeNodes.def"
2161 llvm_unreachable("Dependent types cannot show up in debug information");
2162
2163 case Type::ExtVector:
2164 case Type::Vector:
2165 return CreateType(cast<VectorType>(Ty), Unit);
2166 case Type::ObjCObjectPointer:
2167 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2168 case Type::ObjCObject:
2169 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2170 case Type::ObjCInterface:
2171 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2172 case Type::Builtin:
2173 return CreateType(cast<BuiltinType>(Ty));
2174 case Type::Complex:
2175 return CreateType(cast<ComplexType>(Ty));
2176 case Type::Pointer:
2177 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002178 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002179 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002180 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002181 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002182 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002183 case Type::BlockPointer:
2184 return CreateType(cast<BlockPointerType>(Ty), Unit);
2185 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002186 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002187 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002188 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002189 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002190 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002191 case Type::FunctionProto:
2192 case Type::FunctionNoProto:
2193 return CreateType(cast<FunctionType>(Ty), Unit);
2194 case Type::ConstantArray:
2195 case Type::VariableArray:
2196 case Type::IncompleteArray:
2197 return CreateType(cast<ArrayType>(Ty), Unit);
2198
2199 case Type::LValueReference:
2200 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2201 case Type::RValueReference:
2202 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2203
2204 case Type::MemberPointer:
2205 return CreateType(cast<MemberPointerType>(Ty), Unit);
2206
2207 case Type::Atomic:
2208 return CreateType(cast<AtomicType>(Ty), Unit);
2209
2210 case Type::Attributed:
2211 case Type::TemplateSpecialization:
2212 case Type::Elaborated:
2213 case Type::Paren:
2214 case Type::SubstTemplateTypeParm:
2215 case Type::TypeOfExpr:
2216 case Type::TypeOf:
2217 case Type::Decltype:
2218 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002219 case Type::PackExpansion:
Guy Benyei11169dd2012-12-18 14:30:41 +00002220 llvm_unreachable("type should have been unwrapped!");
David Blaikie22c460a02013-05-24 21:24:35 +00002221 case Type::Auto:
2222 Diag = "auto";
2223 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002224 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002225
Guy Benyei11169dd2012-12-18 14:30:41 +00002226 assert(Diag && "Fall through without a diagnostic?");
2227 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2228 "debug information for %0 is not yet supported");
2229 CGM.getDiags().Report(DiagID)
2230 << Diag;
2231 return llvm::DIType();
2232}
2233
2234/// getOrCreateLimitedType - Get the type from the cache or create a new
2235/// limited type if necessary.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002236llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002237 llvm::DIFile Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002238 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002239
David Blaikie8d5e1282013-08-20 21:03:29 +00002240 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002241
2242 // We may have cached a forward decl when we could have created
2243 // a non-forward decl. Go ahead and create a non-forward decl
2244 // now.
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002245 if (T && !T.isForwardDecl()) return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002246
2247 // Otherwise create the type.
David Blaikie8d5e1282013-08-20 21:03:29 +00002248 llvm::DICompositeType Res = CreateLimitedType(Ty);
2249
2250 // Propagate members from the declaration to the definition
2251 // CreateType(const RecordType*) will overwrite this with the members in the
2252 // correct order if the full type is needed.
2253 Res.setTypeArray(T.getTypeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002254
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002255 if (T && T.isForwardDecl())
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002256 ReplaceMap.push_back(
2257 std::make_pair(QTy.getAsOpaquePtr(), static_cast<llvm::Value *>(T)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002258
2259 // And update the type cache.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002260 TypeCache[QTy.getAsOpaquePtr()] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002261 return Res;
2262}
2263
2264// TODO: Currently used for context chains when limiting debug info.
David Blaikie8d5e1282013-08-20 21:03:29 +00002265llvm::DICompositeType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002266 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002267
Guy Benyei11169dd2012-12-18 14:30:41 +00002268 // Get overall information about the record type for the debug info.
2269 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2270 unsigned Line = getLineNumber(RD->getLocation());
2271 StringRef RDName = getClassName(RD);
2272
Eric Christopher07429ff2013-10-15 21:22:34 +00002273 llvm::DIDescriptor RDContext =
2274 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002275
David Blaikied2785892013-08-18 17:36:19 +00002276 // If we ended up creating the type during the context chain construction,
2277 // just return that.
2278 // FIXME: this could be dealt with better if the type was recorded as
2279 // completed before we started this (see the CompletedTypeCache usage in
2280 // CGDebugInfo::CreateTypeDefinition(const RecordType*) - that would need to
2281 // be pushed to before context creation, but after it was known to be
2282 // destined for completion (might still have an issue if this caller only
2283 // required a declaration but the context construction ended up creating a
2284 // definition)
David Blaikie8d5e1282013-08-20 21:03:29 +00002285 llvm::DICompositeType T(getTypeOrNull(CGM.getContext().getRecordType(RD)));
2286 if (T && (!T.isForwardDecl() || !RD->getDefinition()))
David Blaikied2785892013-08-18 17:36:19 +00002287 return T;
2288
Adrian Prantl381e7552014-02-04 21:29:50 +00002289 // If this is just a forward or incomplete declaration, construct an
2290 // appropriately marked node and just return it.
2291 const RecordDecl *D = RD->getDefinition();
2292 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002293 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002294
2295 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2296 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
David Blaikie49ae6a72013-03-26 23:47:35 +00002297 llvm::DICompositeType RealDecl;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002298
Manman Rene0064d82013-08-29 23:19:58 +00002299 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2300
Guy Benyei11169dd2012-12-18 14:30:41 +00002301 if (RD->isUnion())
2302 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Manman Rene0064d82013-08-29 23:19:58 +00002303 Size, Align, 0, llvm::DIArray(), 0,
2304 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002305 else if (RD->isClass()) {
2306 // FIXME: This could be a struct type giving a default visibility different
2307 // than C++ class type, but needs llvm metadata changes first.
2308 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002309 Size, Align, 0, 0, llvm::DIType(),
2310 llvm::DIArray(), llvm::DIType(),
Manman Rene0064d82013-08-29 23:19:58 +00002311 llvm::DIArray(), FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002312 } else
2313 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopher0fdcb312013-05-16 00:52:20 +00002314 Size, Align, 0, llvm::DIType(),
David Blaikieba477362013-11-18 23:38:26 +00002315 llvm::DIArray(), 0, llvm::DIType(),
2316 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002317
2318 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie49ae6a72013-03-26 23:47:35 +00002319 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002320
David Blaikieadfbf992013-08-18 16:55:33 +00002321 if (const ClassTemplateSpecializationDecl *TSpecial =
2322 dyn_cast<ClassTemplateSpecializationDecl>(RD))
2323 RealDecl.setTypeArray(llvm::DIArray(),
2324 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002325 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002326}
2327
David Blaikieadfbf992013-08-18 16:55:33 +00002328void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2329 llvm::DICompositeType RealDecl) {
2330 // A class's primary base or the class itself contains the vtable.
2331 llvm::DICompositeType ContainingType;
2332 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2333 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002334 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002335 while (1) {
2336 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2337 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2338 if (PBT && !BRL.isPrimaryBaseVirtual())
2339 PBase = PBT;
2340 else
2341 break;
2342 }
2343 ContainingType = llvm::DICompositeType(
2344 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2345 getOrCreateFile(RD->getLocation())));
2346 } else if (RD->isDynamicClass())
2347 ContainingType = RealDecl;
2348
2349 RealDecl.setContainingType(ContainingType);
2350}
2351
Guy Benyei11169dd2012-12-18 14:30:41 +00002352/// CreateMemberType - Create new member and increase Offset by FType's size.
2353llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2354 StringRef Name,
2355 uint64_t *Offset) {
2356 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2357 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2358 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2359 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2360 FieldSize, FieldAlign,
2361 *Offset, 0, FieldTy);
2362 *Offset += FieldSize;
2363 return Ty;
2364}
2365
David Blaikiebd483762013-05-20 04:58:53 +00002366llvm::DIDescriptor CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
2367 // We only need a declaration (not a definition) of the type - so use whatever
2368 // we would otherwise do to get a type for a pointee. (forward declarations in
2369 // limited debug info, full definitions (if the type definition is available)
2370 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002371 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2372 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002373 getOrCreateFile(TD->getLocation()));
David Blaikiebd483762013-05-20 04:58:53 +00002374 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2375 // This doesn't handle providing declarations (for functions or variables) for
2376 // entities without definitions in this TU, nor when the definition proceeds
2377 // the call to this function.
2378 // FIXME: This should be split out into more specific maps with support for
2379 // emitting forward declarations and merging definitions with declarations,
2380 // the same way as we do for types.
2381 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2382 DeclCache.find(D->getCanonicalDecl());
2383 if (I == DeclCache.end())
2384 return llvm::DIDescriptor();
2385 llvm::Value *V = I->second;
2386 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(V));
2387}
2388
Guy Benyei11169dd2012-12-18 14:30:41 +00002389/// getFunctionDeclaration - Return debug info descriptor to describe method
2390/// declaration for the given method definition.
2391llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002392 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2393 return llvm::DISubprogram();
2394
Guy Benyei11169dd2012-12-18 14:30:41 +00002395 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2396 if (!FD) return llvm::DISubprogram();
2397
2398 // Setup context.
David Blaikiefd07c602013-08-09 17:20:05 +00002399 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002400
2401 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2402 MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002403 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002404 if (const CXXMethodDecl *MD =
2405 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikiefd07c602013-08-09 17:20:05 +00002406 llvm::DICompositeType T(S);
Eric Christopherf86c4052013-08-28 23:12:10 +00002407 llvm::DISubprogram SP =
2408 CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
David Blaikiefd07c602013-08-09 17:20:05 +00002409 return SP;
2410 }
2411 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002412 if (MI != SPCache.end()) {
2413 llvm::Value *V = MI->second;
2414 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002415 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002416 return SP;
2417 }
2418
Aaron Ballman86c93902014-03-06 23:45:36 +00002419 for (auto NextFD : FD->redecls()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002420 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2421 MI = SPCache.find(NextFD->getCanonicalDecl());
2422 if (MI != SPCache.end()) {
2423 llvm::Value *V = MI->second;
2424 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002425 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002426 return SP;
2427 }
2428 }
2429 return llvm::DISubprogram();
2430}
2431
2432// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2433// implicit parameter "this".
David Blaikie469f0792013-05-22 23:22:42 +00002434llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2435 QualType FnType,
2436 llvm::DIFile F) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002437 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2438 // Create fake but valid subroutine type. Otherwise
2439 // llvm::DISubprogram::Verify() would return false, and
2440 // subprogram DIE will miss DW_AT_decl_file and
2441 // DW_AT_decl_line fields.
2442 return DBuilder.createSubroutineType(F, DBuilder.getOrCreateArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002443
2444 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2445 return getOrCreateMethodType(Method, F);
2446 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2447 // Add "self" and "_cmd"
2448 SmallVector<llvm::Value *, 16> Elts;
2449
2450 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002451 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002452
2453 // Replace the instancetype keyword with the actual type.
2454 if (ResultTy == CGM.getContext().getObjCInstanceType())
2455 ResultTy = CGM.getContext().getPointerType(
2456 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2457
Adrian Prantl7bec9032013-05-10 21:08:31 +00002458 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002459 // "self" pointer is always first argument.
Adrian Prantlde17db32013-03-29 19:20:29 +00002460 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2461 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2462 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002463 // "_cmd" pointer is always second argument.
2464 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2465 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2466 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002467 for (const auto *PI : OMethod->params())
2468 Elts.push_back(getOrCreateType(PI->getType(), F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002469
2470 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2471 return DBuilder.createSubroutineType(F, EltTypeArray);
2472 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002473
Adrian Prantl800faef2014-02-25 23:42:18 +00002474 // Handle variadic function types; they need an additional
2475 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002476 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2477 if (FD->isVariadic()) {
2478 SmallVector<llvm::Value *, 16> EltTys;
2479 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2480 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2481 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2482 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2483 EltTys.push_back(DBuilder.createUnspecifiedParameter());
2484 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
2485 return DBuilder.createSubroutineType(F, EltTypeArray);
2486 }
2487
David Blaikie469f0792013-05-22 23:22:42 +00002488 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002489}
2490
2491/// EmitFunctionStart - Constructs the debug code for entering a function.
2492void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
2493 llvm::Function *Fn,
2494 CGBuilderTy &Builder) {
2495
2496 StringRef Name;
2497 StringRef LinkageName;
2498
2499 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2500
2501 const Decl *D = GD.getDecl();
2502 // Function may lack declaration in source code if it is created by Clang
2503 // CodeGen (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
2504 bool HasDecl = (D != 0);
2505 // Use the location of the declaration.
2506 SourceLocation Loc;
2507 if (HasDecl)
2508 Loc = D->getLocation();
2509
2510 unsigned Flags = 0;
2511 llvm::DIFile Unit = getOrCreateFile(Loc);
2512 llvm::DIDescriptor FDContext(Unit);
2513 llvm::DIArray TParamsArray;
2514 if (!HasDecl) {
2515 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002516 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002517 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2518 // If there is a DISubprogram for this function available then use it.
2519 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2520 FI = SPCache.find(FD->getCanonicalDecl());
2521 if (FI != SPCache.end()) {
2522 llvm::Value *V = FI->second;
2523 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2524 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2525 llvm::MDNode *SPN = SP;
2526 LexicalBlockStack.push_back(SPN);
2527 RegionMap[D] = llvm::WeakVH(SP);
2528 return;
2529 }
2530 }
2531 Name = getFunctionName(FD);
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002532 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00002533 if (FD->hasPrototype()) {
2534 LinkageName = CGM.getMangledName(GD);
2535 Flags |= llvm::DIDescriptor::FlagPrototyped;
2536 }
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002537 // No need to replicate the linkage name if it isn't different from the
2538 // subprogram name, no need to have it at all unless coverage is enabled or
2539 // debug is set to more than just line tables.
Guy Benyei11169dd2012-12-18 14:30:41 +00002540 if (LinkageName == Name ||
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002541 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2542 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher75e17682013-05-16 00:45:23 +00002543 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei11169dd2012-12-18 14:30:41 +00002544 LinkageName = StringRef();
2545
Eric Christopher75e17682013-05-16 00:45:23 +00002546 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002547 if (const NamespaceDecl *NSDecl =
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002548 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00002549 FDContext = getOrCreateNameSpace(NSDecl);
2550 else if (const RecordDecl *RDecl =
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002551 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2552 FDContext = getContextDescriptor(cast<Decl>(RDecl));
Guy Benyei11169dd2012-12-18 14:30:41 +00002553
2554 // Collect template parameters.
2555 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2556 }
2557 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2558 Name = getObjCMethodName(OMD);
2559 Flags |= llvm::DIDescriptor::FlagPrototyped;
2560 } else {
2561 // Use llvm function name.
2562 Name = Fn->getName();
2563 Flags |= llvm::DIDescriptor::FlagPrototyped;
2564 }
2565 if (!Name.empty() && Name[0] == '\01')
2566 Name = Name.substr(1);
2567
2568 unsigned LineNo = getLineNumber(Loc);
2569 if (!HasDecl || D->isImplicit())
2570 Flags |= llvm::DIDescriptor::FlagArtificial;
2571
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002572 llvm::DISubprogram SP =
2573 DBuilder.createFunction(FDContext, Name, LinkageName, Unit, LineNo,
2574 getOrCreateFunctionType(D, FnType, Unit),
2575 Fn->hasInternalLinkage(), true /*definition*/,
2576 getLineNumber(CurLoc), Flags,
2577 CGM.getLangOpts().Optimize, Fn, TParamsArray,
2578 getFunctionDeclaration(D));
David Blaikiebd483762013-05-20 04:58:53 +00002579 if (HasDecl)
2580 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002581
2582 // Push function on region stack.
2583 llvm::MDNode *SPN = SP;
2584 LexicalBlockStack.push_back(SPN);
2585 if (HasDecl)
2586 RegionMap[D] = llvm::WeakVH(SP);
2587}
2588
2589/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl02c0caa2013-07-18 00:27:59 +00002590/// information in the source file. If the location is invalid, the
2591/// previous location will be reused.
Adrian Prantlc7822422013-03-12 20:43:25 +00002592void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
Adrian Prantle83b1302014-01-07 22:05:52 +00002593 bool ForceColumnInfo) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002594 // Update our current location
2595 setLocation(Loc);
2596
2597 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2598
2599 // Don't bother if things are the same as last time.
2600 SourceManager &SM = CGM.getContext().getSourceManager();
2601 if (CurLoc == PrevLoc ||
2602 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2603 // New Builder may not be in sync with CGDebugInfo.
David Blaikie357aafb2013-02-01 19:09:49 +00002604 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2605 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2606 LexicalBlockStack.back())
Guy Benyei11169dd2012-12-18 14:30:41 +00002607 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002608
Guy Benyei11169dd2012-12-18 14:30:41 +00002609 // Update last state.
2610 PrevLoc = CurLoc;
2611
Adrian Prantle83b1302014-01-07 22:05:52 +00002612 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantlc7822422013-03-12 20:43:25 +00002613 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2614 (getLineNumber(CurLoc),
2615 getColumnNumber(CurLoc, ForceColumnInfo),
2616 Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002617}
2618
2619/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2620/// the stack.
2621void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2622 llvm::DIDescriptor D =
2623 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2624 llvm::DIDescriptor() :
2625 llvm::DIDescriptor(LexicalBlockStack.back()),
2626 getOrCreateFile(CurLoc),
2627 getLineNumber(CurLoc),
Diego Novilloe6d398182014-03-03 18:53:32 +00002628 getColumnNumber(CurLoc),
2629 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002630 llvm::MDNode *DN = D;
2631 LexicalBlockStack.push_back(DN);
2632}
2633
2634/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2635/// region - beginning of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002636void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2637 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002638 // Set our current location.
2639 setLocation(Loc);
2640
2641 // Create a new lexical block and push it on the stack.
2642 CreateLexicalBlock(Loc);
2643
2644 // Emit a line table change for the current location inside the new scope.
2645 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2646 getColumnNumber(Loc),
2647 LexicalBlockStack.back()));
2648}
2649
2650/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2651/// region - end of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002652void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2653 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002654 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2655
2656 // Provide an entry in the line table for the end of the block.
2657 EmitLocation(Builder, Loc);
2658
2659 LexicalBlockStack.pop_back();
2660}
2661
2662/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2663void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2664 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2665 unsigned RCount = FnBeginRegionCount.back();
2666 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2667
2668 // Pop all regions for this function.
2669 while (LexicalBlockStack.size() != RCount)
2670 EmitLexicalBlockEnd(Builder, CurLoc);
2671 FnBeginRegionCount.pop_back();
2672}
2673
Eric Christopherb2a008c2013-05-16 00:45:12 +00002674// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei11169dd2012-12-18 14:30:41 +00002675// See BuildByRefType.
2676llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2677 uint64_t *XOffset) {
2678
2679 SmallVector<llvm::Value *, 5> EltTys;
2680 QualType FType;
2681 uint64_t FieldSize, FieldOffset;
2682 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002683
Guy Benyei11169dd2012-12-18 14:30:41 +00002684 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002685 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002686
2687 FieldOffset = 0;
2688 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2689 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2690 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2691 FType = CGM.getContext().IntTy;
2692 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2693 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2694
2695 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2696 if (HasCopyAndDispose) {
2697 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2698 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2699 &FieldOffset));
2700 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2701 &FieldOffset));
2702 }
2703 bool HasByrefExtendedLayout;
2704 Qualifiers::ObjCLifetime Lifetime;
2705 if (CGM.getContext().getByrefLifetime(Type,
2706 Lifetime, HasByrefExtendedLayout)
Adrian Prantlead2ba42013-07-23 00:12:14 +00002707 && HasByrefExtendedLayout) {
2708 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002709 EltTys.push_back(CreateMemberType(Unit, FType,
2710 "__byref_variable_layout",
2711 &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002712 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002713
Guy Benyei11169dd2012-12-18 14:30:41 +00002714 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2715 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002716 CGM.getTarget().getPointerAlign(0))) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002717 CharUnits FieldOffsetInBytes
Guy Benyei11169dd2012-12-18 14:30:41 +00002718 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2719 CharUnits AlignedOffsetInBytes
2720 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2721 CharUnits NumPaddingBytes
2722 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002723
Guy Benyei11169dd2012-12-18 14:30:41 +00002724 if (NumPaddingBytes.isPositive()) {
2725 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2726 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2727 pad, ArrayType::Normal, 0);
2728 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2729 }
2730 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002731
Guy Benyei11169dd2012-12-18 14:30:41 +00002732 FType = Type;
2733 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2734 FieldSize = CGM.getContext().getTypeSize(FType);
2735 FieldAlign = CGM.getContext().toBits(Align);
2736
Eric Christopherb2a008c2013-05-16 00:45:12 +00002737 *XOffset = FieldOffset;
Guy Benyei11169dd2012-12-18 14:30:41 +00002738 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2739 0, FieldSize, FieldAlign,
2740 FieldOffset, 0, FieldTy);
2741 EltTys.push_back(FieldTy);
2742 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002743
Guy Benyei11169dd2012-12-18 14:30:41 +00002744 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002745
Guy Benyei11169dd2012-12-18 14:30:41 +00002746 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002747
Guy Benyei11169dd2012-12-18 14:30:41 +00002748 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00002749 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002750}
2751
2752/// EmitDeclare - Emit local variable declaration debug info.
2753void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +00002754 llvm::Value *Storage,
Guy Benyei11169dd2012-12-18 14:30:41 +00002755 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002756 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002757 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2758
David Blaikie7fceebf2013-08-19 03:37:48 +00002759 bool Unwritten =
2760 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2761 cast<Decl>(VD->getDeclContext())->isImplicit());
2762 llvm::DIFile Unit;
2763 if (!Unwritten)
2764 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002765 llvm::DIType Ty;
2766 uint64_t XOffset = 0;
2767 if (VD->hasAttr<BlocksAttr>())
2768 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002769 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002770 Ty = getOrCreateType(VD->getType(), Unit);
2771
2772 // If there is no debug info for this type then do not emit debug info
2773 // for this variable.
2774 if (!Ty)
2775 return;
2776
Guy Benyei11169dd2012-12-18 14:30:41 +00002777 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002778 unsigned Line = 0;
2779 unsigned Column = 0;
2780 if (!Unwritten) {
2781 Line = getLineNumber(VD->getLocation());
2782 Column = getColumnNumber(VD->getLocation());
2783 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002784 unsigned Flags = 0;
2785 if (VD->isImplicit())
2786 Flags |= llvm::DIDescriptor::FlagArtificial;
2787 // If this is the first argument and it is implicit then
2788 // give it an object pointer flag.
2789 // FIXME: There has to be a better way to do this, but for static
2790 // functions there won't be an implicit param at arg1 and
2791 // otherwise it is 'self' or 'this'.
2792 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2793 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002794 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002795 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2796 !VD->getType()->isPointerType())
David Blaikieb9c667d2013-06-19 21:53:53 +00002797 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
Guy Benyei11169dd2012-12-18 14:30:41 +00002798
2799 llvm::MDNode *Scope = LexicalBlockStack.back();
2800
2801 StringRef Name = VD->getName();
2802 if (!Name.empty()) {
2803 if (VD->hasAttr<BlocksAttr>()) {
2804 CharUnits offset = CharUnits::fromQuantity(32);
2805 SmallVector<llvm::Value *, 9> addr;
2806 llvm::Type *Int64Ty = CGM.Int64Ty;
2807 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2808 // offset of __forwarding field
2809 offset = CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002810 CGM.getTarget().getPointerWidth(0));
Guy Benyei11169dd2012-12-18 14:30:41 +00002811 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2812 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2813 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2814 // offset of x field
2815 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2816 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2817
2818 // Create the descriptor for the variable.
2819 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002820 DBuilder.createComplexVariable(Tag,
Guy Benyei11169dd2012-12-18 14:30:41 +00002821 llvm::DIDescriptor(Scope),
2822 VD->getName(), Unit, Line, Ty,
2823 addr, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002824
Guy Benyei11169dd2012-12-18 14:30:41 +00002825 // Insert an llvm.dbg.declare into the current block.
2826 llvm::Instruction *Call =
2827 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2828 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2829 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00002830 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl0315f382013-09-18 22:08:57 +00002831 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
David Blaikiea76a7c92013-01-05 05:58:35 +00002832 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2833 // If VD is an anonymous union then Storage represents value for
2834 // all union fields.
Guy Benyei11169dd2012-12-18 14:30:41 +00002835 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikie219c7d92013-01-05 20:03:07 +00002836 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002837 for (const auto *Field : RD->fields()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002838 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2839 StringRef FieldName = Field->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002840
Guy Benyei11169dd2012-12-18 14:30:41 +00002841 // Ignore unnamed fields. Do not ignore unnamed records.
2842 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2843 continue;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002844
Guy Benyei11169dd2012-12-18 14:30:41 +00002845 // Use VarDecl's Tag, Scope and Line number.
2846 llvm::DIVariable D =
2847 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopherb2a008c2013-05-16 00:45:12 +00002848 FieldName, Unit, Line, FieldTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00002849 CGM.getLangOpts().Optimize, Flags,
2850 ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002851
Guy Benyei11169dd2012-12-18 14:30:41 +00002852 // Insert an llvm.dbg.declare into the current block.
2853 llvm::Instruction *Call =
2854 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2855 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2856 }
David Blaikie219c7d92013-01-05 20:03:07 +00002857 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002858 }
2859 }
David Blaikiea76a7c92013-01-05 05:58:35 +00002860
2861 // Create the descriptor for the variable.
2862 llvm::DIVariable D =
2863 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2864 Name, Unit, Line, Ty,
2865 CGM.getLangOpts().Optimize, Flags, ArgNo);
2866
2867 // Insert an llvm.dbg.declare into the current block.
2868 llvm::Instruction *Call =
2869 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2870 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002871}
2872
2873void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2874 llvm::Value *Storage,
2875 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002876 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002877 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2878}
2879
Adrian Prantlde17db32013-03-29 19:20:29 +00002880/// Look up the completed type for a self pointer in the TypeCache and
2881/// create a copy of it with the ObjectPointer and Artificial flags
2882/// set. If the type is not cached, a new one is created. This should
2883/// never happen though, since creating a type for the implicit self
2884/// argument implies that we already parsed the interface definition
2885/// and the ivar declarations in the implementation.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002886llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2887 llvm::DIType Ty) {
Adrian Prantlde17db32013-03-29 19:20:29 +00002888 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002889 if (CachedTy) Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00002890 else DEBUG(llvm::dbgs() << "No cached type for self.");
2891 return DBuilder.createObjectPointerType(Ty);
2892}
2893
Guy Benyei11169dd2012-12-18 14:30:41 +00002894void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2895 llvm::Value *Storage,
2896 CGBuilderTy &Builder,
2897 const CGBlockInfo &blockInfo) {
Eric Christopher75e17682013-05-16 00:45:23 +00002898 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002899 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00002900
Guy Benyei11169dd2012-12-18 14:30:41 +00002901 if (Builder.GetInsertBlock() == 0)
2902 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002903
Guy Benyei11169dd2012-12-18 14:30:41 +00002904 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002905
Guy Benyei11169dd2012-12-18 14:30:41 +00002906 uint64_t XOffset = 0;
2907 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2908 llvm::DIType Ty;
2909 if (isByRef)
2910 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002911 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002912 Ty = getOrCreateType(VD->getType(), Unit);
2913
2914 // Self is passed along as an implicit non-arg variable in a
2915 // block. Mark it as the object pointer.
2916 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00002917 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002918
2919 // Get location information.
2920 unsigned Line = getLineNumber(VD->getLocation());
2921 unsigned Column = getColumnNumber(VD->getLocation());
2922
2923 const llvm::DataLayout &target = CGM.getDataLayout();
2924
2925 CharUnits offset = CharUnits::fromQuantity(
2926 target.getStructLayout(blockInfo.StructureType)
2927 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2928
2929 SmallVector<llvm::Value *, 9> addr;
2930 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl0f6df002013-03-29 19:20:35 +00002931 if (isa<llvm::AllocaInst>(Storage))
2932 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei11169dd2012-12-18 14:30:41 +00002933 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2934 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2935 if (isByRef) {
2936 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2937 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2938 // offset of __forwarding field
2939 offset = CGM.getContext()
2940 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2941 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2942 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2943 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2944 // offset of x field
2945 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2946 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2947 }
2948
2949 // Create the descriptor for the variable.
2950 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002951 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei11169dd2012-12-18 14:30:41 +00002952 llvm::DIDescriptor(LexicalBlockStack.back()),
2953 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl0f6df002013-03-29 19:20:35 +00002954
Guy Benyei11169dd2012-12-18 14:30:41 +00002955 // Insert an llvm.dbg.declare into the current block.
2956 llvm::Instruction *Call =
2957 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2958 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2959 LexicalBlockStack.back()));
2960}
2961
2962/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2963/// variable declaration.
2964void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2965 unsigned ArgNo,
2966 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002967 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002968 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2969}
2970
2971namespace {
2972 struct BlockLayoutChunk {
2973 uint64_t OffsetInBits;
2974 const BlockDecl::Capture *Capture;
2975 };
2976 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2977 return l.OffsetInBits < r.OffsetInBits;
2978 }
2979}
2980
2981void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00002982 llvm::Value *Arg,
2983 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00002984 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002985 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002986 ASTContext &C = CGM.getContext();
2987 const BlockDecl *blockDecl = block.getBlockDecl();
2988
2989 // Collect some general information about the block's location.
2990 SourceLocation loc = blockDecl->getCaretLocation();
2991 llvm::DIFile tunit = getOrCreateFile(loc);
2992 unsigned line = getLineNumber(loc);
2993 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002994
Guy Benyei11169dd2012-12-18 14:30:41 +00002995 // Build the debug-info type for the block literal.
2996 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2997
2998 const llvm::StructLayout *blockLayout =
2999 CGM.getDataLayout().getStructLayout(block.StructureType);
3000
3001 SmallVector<llvm::Value*, 16> fields;
3002 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
3003 blockLayout->getElementOffsetInBits(0),
3004 tunit, tunit));
3005 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
3006 blockLayout->getElementOffsetInBits(1),
3007 tunit, tunit));
3008 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
3009 blockLayout->getElementOffsetInBits(2),
3010 tunit, tunit));
3011 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
3012 blockLayout->getElementOffsetInBits(3),
3013 tunit, tunit));
3014 fields.push_back(createFieldType("__descriptor",
3015 C.getPointerType(block.NeedsCopyDispose ?
3016 C.getBlockDescriptorExtendedType() :
3017 C.getBlockDescriptorType()),
3018 0, loc, AS_public,
3019 blockLayout->getElementOffsetInBits(4),
3020 tunit, tunit));
3021
3022 // We want to sort the captures by offset, not because DWARF
3023 // requires this, but because we're paranoid about debuggers.
3024 SmallVector<BlockLayoutChunk, 8> chunks;
3025
3026 // 'this' capture.
3027 if (blockDecl->capturesCXXThis()) {
3028 BlockLayoutChunk chunk;
3029 chunk.OffsetInBits =
3030 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
3031 chunk.Capture = 0;
3032 chunks.push_back(chunk);
3033 }
3034
3035 // Variable captures.
3036 for (BlockDecl::capture_const_iterator
3037 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
3038 i != e; ++i) {
3039 const BlockDecl::Capture &capture = *i;
3040 const VarDecl *variable = capture.getVariable();
3041 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3042
3043 // Ignore constant captures.
3044 if (captureInfo.isConstant())
3045 continue;
3046
3047 BlockLayoutChunk chunk;
3048 chunk.OffsetInBits =
3049 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
3050 chunk.Capture = &capture;
3051 chunks.push_back(chunk);
3052 }
3053
3054 // Sort by offset.
3055 llvm::array_pod_sort(chunks.begin(), chunks.end());
3056
3057 for (SmallVectorImpl<BlockLayoutChunk>::iterator
3058 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
3059 uint64_t offsetInBits = i->OffsetInBits;
3060 const BlockDecl::Capture *capture = i->Capture;
3061
3062 // If we have a null capture, this must be the C++ 'this' capture.
3063 if (!capture) {
3064 const CXXMethodDecl *method =
3065 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
3066 QualType type = method->getThisType(C);
3067
3068 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3069 offsetInBits, tunit, tunit));
3070 continue;
3071 }
3072
3073 const VarDecl *variable = capture->getVariable();
3074 StringRef name = variable->getName();
3075
3076 llvm::DIType fieldType;
3077 if (capture->isByRef()) {
3078 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
3079
3080 // FIXME: this creates a second copy of this type!
3081 uint64_t xoffset;
3082 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
3083 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
3084 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3085 ptrInfo.first, ptrInfo.second,
3086 offsetInBits, 0, fieldType);
3087 } else {
3088 fieldType = createFieldType(name, variable->getType(), 0,
3089 loc, AS_public, offsetInBits, tunit, tunit);
3090 }
3091 fields.push_back(fieldType);
3092 }
3093
3094 SmallString<36> typeName;
3095 llvm::raw_svector_ostream(typeName)
3096 << "__block_literal_" << CGM.getUniqueBlockCount();
3097
3098 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3099
3100 llvm::DIType type =
3101 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3102 CGM.getContext().toBits(block.BlockSize),
3103 CGM.getContext().toBits(block.BlockAlign),
David Blaikie6d4fe152013-02-25 01:07:08 +00003104 0, llvm::DIType(), fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003105 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3106
3107 // Get overall information about the block.
3108 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3109 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei11169dd2012-12-18 14:30:41 +00003110
3111 // Create the descriptor for the parameter.
3112 llvm::DIVariable debugVar =
3113 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopherb2a008c2013-05-16 00:45:12 +00003114 llvm::DIDescriptor(scope),
Adrian Prantl51936dd2013-03-14 17:53:33 +00003115 Arg->getName(), tunit, line, type,
Guy Benyei11169dd2012-12-18 14:30:41 +00003116 CGM.getLangOpts().Optimize, flags,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003117 cast<llvm::Argument>(Arg)->getArgNo() + 1);
3118
Adrian Prantl616bef42013-03-14 21:52:59 +00003119 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003120 // Insert an llvm.dbg.value into the current block.
Adrian Prantl616bef42013-03-14 21:52:59 +00003121 llvm::Instruction *DbgVal =
3122 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00003123 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003124 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3125 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003126
Adrian Prantl616bef42013-03-14 21:52:59 +00003127 // Insert an llvm.dbg.declare into the current block.
3128 llvm::Instruction *DbgDecl =
3129 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
3130 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003131}
3132
David Blaikie6943dea2013-08-20 01:28:15 +00003133/// If D is an out-of-class definition of a static data member of a class, find
3134/// its corresponding in-class declaration.
3135llvm::DIDerivedType
3136CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3137 if (!D->isStaticDataMember())
3138 return llvm::DIDerivedType();
3139 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
3140 StaticDataMemberCache.find(D->getCanonicalDecl());
3141 if (MI != StaticDataMemberCache.end()) {
3142 assert(MI->second && "Static data member declaration should still exist");
3143 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003144 }
David Blaikiece763042013-08-20 21:49:21 +00003145
3146 // If the member wasn't found in the cache, lazily construct and add it to the
3147 // type (used when a limited form of the type is emitted).
David Blaikie6943dea2013-08-20 01:28:15 +00003148 llvm::DICompositeType Ctxt(
3149 getContextDescriptor(cast<Decl>(D->getDeclContext())));
3150 llvm::DIDerivedType T = CreateRecordStaticField(D, Ctxt);
David Blaikie6943dea2013-08-20 01:28:15 +00003151 return T;
3152}
3153
Guy Benyei11169dd2012-12-18 14:30:41 +00003154/// EmitGlobalVariable - Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003155void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003156 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003157 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003158 // Create global variable debug descriptor.
3159 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
3160 unsigned LineNo = getLineNumber(D->getLocation());
3161
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003162 setLocation(D->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00003163
3164 QualType T = D->getType();
3165 if (T->isIncompleteArrayType()) {
3166
3167 // CodeGen turns int[] into int[1] so we'll do the same here.
3168 llvm::APInt ConstVal(32, 1);
3169 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3170
3171 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3172 ArrayType::Normal, 0);
3173 }
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003174 StringRef DeclName = D->getName();
3175 StringRef LinkageName;
3176 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
3177 && !isa<ObjCMethodDecl>(D->getDeclContext()))
3178 LinkageName = Var->getName();
3179 if (LinkageName == DeclName)
3180 LinkageName = StringRef();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003181 llvm::DIDescriptor DContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00003182 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
David Blaikie6943dea2013-08-20 01:28:15 +00003183 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
3184 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003185 Var->hasInternalLinkage(), Var,
David Blaikie6943dea2013-08-20 01:28:15 +00003186 getOrCreateStaticDataMemberDeclarationOrNull(D));
David Blaikiebd483762013-05-20 04:58:53 +00003187 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003188}
3189
3190/// EmitGlobalVariable - Emit information about an objective-c interface.
3191void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3192 ObjCInterfaceDecl *ID) {
Eric Christopher75e17682013-05-16 00:45:23 +00003193 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003194 // Create global variable debug descriptor.
3195 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
3196 unsigned LineNo = getLineNumber(ID->getLocation());
3197
3198 StringRef Name = ID->getName();
3199
3200 QualType T = CGM.getContext().getObjCInterfaceType(ID);
3201 if (T->isIncompleteArrayType()) {
3202
3203 // CodeGen turns int[] into int[1] so we'll do the same here.
3204 llvm::APInt ConstVal(32, 1);
3205 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3206
3207 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3208 ArrayType::Normal, 0);
3209 }
3210
3211 DBuilder.createGlobalVariable(Name, Unit, LineNo,
3212 getOrCreateType(T, Unit),
3213 Var->hasInternalLinkage(), Var);
3214}
3215
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003216/// EmitGlobalVariable - Emit global variable's debug info.
3217void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3218 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003219 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003220 // Create the descriptor for the variable.
3221 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3222 StringRef Name = VD->getName();
3223 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3224 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3225 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3226 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3227 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3228 }
3229 // Do not use DIGlobalVariable for enums.
3230 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3231 return;
3232 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
3233 Unit, Name, Name, Unit, getLineNumber(VD->getLocation()), Ty, true, Init,
3234 getOrCreateStaticDataMemberDeclarationOrNull(cast<VarDecl>(VD)));
3235 DeclCache.insert(std::make_pair(VD->getCanonicalDecl(), llvm::WeakVH(GV)));
David Blaikiebd483762013-05-20 04:58:53 +00003236}
3237
3238llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3239 if (!LexicalBlockStack.empty())
3240 return llvm::DIScope(LexicalBlockStack.back());
3241 return getContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003242}
3243
David Blaikie9f88fe82013-04-22 06:13:21 +00003244void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003245 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3246 return;
David Blaikie9f88fe82013-04-22 06:13:21 +00003247 DBuilder.createImportedModule(
David Blaikiebd483762013-05-20 04:58:53 +00003248 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3249 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie9f88fe82013-04-22 06:13:21 +00003250 getLineNumber(UD.getLocation()));
3251}
3252
David Blaikiebd483762013-05-20 04:58:53 +00003253void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3254 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3255 return;
3256 assert(UD.shadow_size() &&
3257 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3258 // Emitting one decl is sufficient - debuggers can detect that this is an
3259 // overloaded name & provide lookup for all the overloads.
3260 const UsingShadowDecl &USD = **UD.shadow_begin();
Eric Christopher1ecc5632013-06-07 22:54:39 +00003261 if (llvm::DIDescriptor Target =
3262 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003263 DBuilder.createImportedDeclaration(
3264 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3265 getLineNumber(USD.getLocation()));
3266}
3267
David Blaikief121b932013-05-20 22:50:41 +00003268llvm::DIImportedEntity
3269CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3270 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3271 return llvm::DIImportedEntity(0);
3272 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3273 if (VH)
3274 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
3275 llvm::DIImportedEntity R(0);
3276 if (const NamespaceAliasDecl *Underlying =
3277 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3278 // This could cache & dedup here rather than relying on metadata deduping.
3279 R = DBuilder.createImportedModule(
3280 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3281 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3282 NA.getName());
3283 else
3284 R = DBuilder.createImportedModule(
3285 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3286 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3287 getLineNumber(NA.getLocation()), NA.getName());
3288 VH = R;
3289 return R;
3290}
3291
Guy Benyei11169dd2012-12-18 14:30:41 +00003292/// getOrCreateNamesSpace - Return namespace descriptor for the given
3293/// namespace decl.
Eric Christopherb2a008c2013-05-16 00:45:12 +00003294llvm::DINameSpace
Guy Benyei11169dd2012-12-18 14:30:41 +00003295CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003296 NSDecl = NSDecl->getCanonicalDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003297 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei11169dd2012-12-18 14:30:41 +00003298 NameSpaceCache.find(NSDecl);
3299 if (I != NameSpaceCache.end())
3300 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003301
Guy Benyei11169dd2012-12-18 14:30:41 +00003302 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3303 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003304 llvm::DIDescriptor Context =
Guy Benyei11169dd2012-12-18 14:30:41 +00003305 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3306 llvm::DINameSpace NS =
3307 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3308 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3309 return NS;
3310}
3311
3312void CGDebugInfo::finalize() {
3313 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
3314 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
3315 llvm::DIType Ty, RepTy;
3316 // Verify that the debug info still exists.
3317 if (llvm::Value *V = VI->second)
3318 Ty = llvm::DIType(cast<llvm::MDNode>(V));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003319
Guy Benyei11169dd2012-12-18 14:30:41 +00003320 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
3321 TypeCache.find(VI->first);
3322 if (it != TypeCache.end()) {
3323 // Verify that the debug info still exists.
3324 if (llvm::Value *V = it->second)
3325 RepTy = llvm::DIType(cast<llvm::MDNode>(V));
3326 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003327
Eric Christopherf8bc4d82013-07-18 00:52:50 +00003328 if (Ty && Ty.isForwardDecl() && RepTy)
Guy Benyei11169dd2012-12-18 14:30:41 +00003329 Ty.replaceAllUsesWith(RepTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003330 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003331
3332 // We keep our own list of retained types, because we need to look
3333 // up the final type in the type cache.
3334 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3335 RE = RetainedTypes.end(); RI != RE; ++RI)
David Blaikie0856f662014-03-04 22:01:08 +00003336 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003337
Guy Benyei11169dd2012-12-18 14:30:41 +00003338 DBuilder.finalize();
3339}