blob: 524ab589248bd5700b1713d843b6cf82dae9e01c [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) {
David Blaikie65813a32014-04-02 18:21:09 +0000231 // quick optimization to avoid having to intern strings that are already
232 // stored reliably elsewhere
233 if (!isa<ClassTemplateSpecializationDecl>(RD))
Guy Benyei11169dd2012-12-18 14:30:41 +0000234 return RD->getName();
235
David Blaikie65813a32014-04-02 18:21:09 +0000236 SmallString<128> Name;
Benjamin Kramer9170e912013-02-22 15:46:01 +0000237 {
David Blaikie65813a32014-04-02 18:21:09 +0000238 llvm::raw_svector_ostream OS(Name);
239 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
240 /*Qualified*/ false);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000241 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000242
243 // Copy this name on the side and use its reference.
David Blaikie65813a32014-04-02 18:21:09 +0000244 return internString(Name);
Guy Benyei11169dd2012-12-18 14:30:41 +0000245}
246
247/// getOrCreateFile - Get the file debug info descriptor for the input location.
248llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
249 if (!Loc.isValid())
250 // If Location is not valid then use main input file.
251 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
252
253 SourceManager &SM = CGM.getContext().getSourceManager();
254 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
255
256 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
257 // If the location is not valid then use main input file.
258 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
259
260 // Cache the results.
261 const char *fname = PLoc.getFilename();
262 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
263 DIFileCache.find(fname);
264
265 if (it != DIFileCache.end()) {
266 // Verify that the information still exists.
267 if (llvm::Value *V = it->second)
268 return llvm::DIFile(cast<llvm::MDNode>(V));
269 }
270
271 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
272
273 DIFileCache[fname] = F;
274 return F;
275}
276
277/// getOrCreateMainFile - Get the file info for main compile unit.
278llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
279 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
280}
281
282/// getLineNumber - Get line number for the location. If location is invalid
283/// then use current location.
284unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
285 if (Loc.isInvalid() && CurLoc.isInvalid())
286 return 0;
287 SourceManager &SM = CGM.getContext().getSourceManager();
288 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
289 return PLoc.isValid()? PLoc.getLine() : 0;
290}
291
292/// getColumnNumber - Get column number for the location.
Adrian Prantlc7822422013-03-12 20:43:25 +0000293unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000294 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000295 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000296 return 0;
297
298 // If the location is invalid then use the current column.
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.getColumn() : 0;
304}
305
306StringRef CGDebugInfo::getCurrentDirname() {
307 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
308 return CGM.getCodeGenOpts().DebugCompilationDir;
309
310 if (!CWDName.empty())
311 return CWDName;
312 SmallString<256> CWD;
313 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000314 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000315}
316
317/// CreateCompileUnit - Create new compile unit.
318void CGDebugInfo::CreateCompileUnit() {
319
320 // Get absolute path name.
321 SourceManager &SM = CGM.getContext().getSourceManager();
322 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
323 if (MainFileName.empty())
324 MainFileName = "<unknown>";
325
326 // The main file name provided via the "-main-file-name" option contains just
327 // the file name itself with no path information. This file name may have had
328 // a relative path, so we look into the actual file entry for the main
329 // file to determine the real absolute path for the file.
330 std::string MainFileDir;
331 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
332 MainFileDir = MainFile->getDir()->getName();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000333 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000334 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
335 llvm::sys::path::append(MainFileDirSS, MainFileName);
336 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000337 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000338 }
339
340 // Save filename string.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000341 StringRef Filename = internString(MainFileName);
Eric Christopherf1545832013-02-22 23:50:16 +0000342
343 // Save split dwarf file string.
344 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000345 StringRef SplitDwarfFilename = internString(SplitDwarfFile);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000346
Guy Benyei11169dd2012-12-18 14:30:41 +0000347 unsigned LangTag;
348 const LangOptions &LO = CGM.getLangOpts();
349 if (LO.CPlusPlus) {
350 if (LO.ObjC1)
351 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
352 else
353 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
354 } else if (LO.ObjC1) {
355 LangTag = llvm::dwarf::DW_LANG_ObjC;
356 } else if (LO.C99) {
357 LangTag = llvm::dwarf::DW_LANG_C99;
358 } else {
359 LangTag = llvm::dwarf::DW_LANG_C89;
360 }
361
362 std::string Producer = getClangFullVersion();
363
364 // Figure out which version of the ObjC runtime we have.
365 unsigned RuntimeVers = 0;
366 if (LO.ObjC1)
367 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
368
369 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000370 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000371 TheCU = DBuilder.createCompileUnit(
372 LangTag, Filename, getCurrentDirname(), Producer, LO.Optimize,
373 CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers, SplitDwarfFilename,
374 DebugKind == CodeGenOptions::DebugLineTablesOnly
375 ? llvm::DIBuilder::LineTablesOnly
376 : llvm::DIBuilder::FullDebug);
Guy Benyei11169dd2012-12-18 14:30:41 +0000377}
378
379/// CreateType - Get the Basic type from the cache or create a new
380/// one if necessary.
381llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
382 unsigned Encoding = 0;
383 StringRef BTName;
384 switch (BT->getKind()) {
385#define BUILTIN_TYPE(Id, SingletonId)
386#define PLACEHOLDER_TYPE(Id, SingletonId) \
387 case BuiltinType::Id:
388#include "clang/AST/BuiltinTypes.def"
389 case BuiltinType::Dependent:
390 llvm_unreachable("Unexpected builtin type");
391 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000392 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000393 case BuiltinType::Void:
394 return llvm::DIType();
395 case BuiltinType::ObjCClass:
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000396 if (ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000397 return ClassTy;
398 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
399 "objc_class", TheCU,
400 getOrCreateMainFile(), 0);
401 return ClassTy;
402 case BuiltinType::ObjCId: {
403 // typedef struct objc_class *Class;
404 // typedef struct objc_object {
405 // Class isa;
406 // } *id;
407
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000408 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000409 return ObjTy;
410
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000411 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000412 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
413 "objc_class", TheCU,
414 getOrCreateMainFile(), 0);
415
416 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000417
Guy Benyei11169dd2012-12-18 14:30:41 +0000418 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
419
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000420 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000421 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
422 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000423
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000424 ObjTy.setTypeArray(DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
425 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000426 return ObjTy;
427 }
428 case BuiltinType::ObjCSel: {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000429 if (SelTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000430 return SelTy;
431 SelTy =
432 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
433 "objc_selector", TheCU, getOrCreateMainFile(),
434 0);
435 return SelTy;
436 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000437
438 case BuiltinType::OCLImage1d:
439 return getOrCreateStructPtrType("opencl_image1d_t",
440 OCLImage1dDITy);
441 case BuiltinType::OCLImage1dArray:
Eric Christopherb2a008c2013-05-16 00:45:12 +0000442 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000443 OCLImage1dArrayDITy);
444 case BuiltinType::OCLImage1dBuffer:
445 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
446 OCLImage1dBufferDITy);
447 case BuiltinType::OCLImage2d:
448 return getOrCreateStructPtrType("opencl_image2d_t",
449 OCLImage2dDITy);
450 case BuiltinType::OCLImage2dArray:
451 return getOrCreateStructPtrType("opencl_image2d_array_t",
452 OCLImage2dArrayDITy);
453 case BuiltinType::OCLImage3d:
454 return getOrCreateStructPtrType("opencl_image3d_t",
455 OCLImage3dDITy);
Guy Benyei61054192013-02-07 10:55:47 +0000456 case BuiltinType::OCLSampler:
457 return DBuilder.createBasicType("opencl_sampler_t",
458 CGM.getContext().getTypeSize(BT),
459 CGM.getContext().getTypeAlign(BT),
460 llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000461 case BuiltinType::OCLEvent:
462 return getOrCreateStructPtrType("opencl_event_t",
463 OCLEventDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000464
Guy Benyei11169dd2012-12-18 14:30:41 +0000465 case BuiltinType::UChar:
466 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
467 case BuiltinType::Char_S:
468 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
469 case BuiltinType::Char16:
470 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
471 case BuiltinType::UShort:
472 case BuiltinType::UInt:
473 case BuiltinType::UInt128:
474 case BuiltinType::ULong:
475 case BuiltinType::WChar_U:
476 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
477 case BuiltinType::Short:
478 case BuiltinType::Int:
479 case BuiltinType::Int128:
480 case BuiltinType::Long:
481 case BuiltinType::WChar_S:
482 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
483 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
484 case BuiltinType::Half:
485 case BuiltinType::Float:
486 case BuiltinType::LongDouble:
487 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
488 }
489
490 switch (BT->getKind()) {
491 case BuiltinType::Long: BTName = "long int"; break;
492 case BuiltinType::LongLong: BTName = "long long int"; break;
493 case BuiltinType::ULong: BTName = "long unsigned int"; break;
494 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
495 default:
496 BTName = BT->getName(CGM.getLangOpts());
497 break;
498 }
499 // Bit size, align and offset of the type.
500 uint64_t Size = CGM.getContext().getTypeSize(BT);
501 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000502 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +0000503 DBuilder.createBasicType(BTName, Size, Align, Encoding);
504 return DbgTy;
505}
506
507llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
508 // Bit size, align and offset of the type.
509 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
510 if (Ty->isComplexIntegerType())
511 Encoding = llvm::dwarf::DW_ATE_lo_user;
512
513 uint64_t Size = CGM.getContext().getTypeSize(Ty);
514 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000515 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +0000516 DBuilder.createBasicType("complex", Size, Align, Encoding);
517
518 return DbgTy;
519}
520
521/// CreateCVRType - Get the qualified type from the cache or create
522/// a new one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +0000523llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000524 QualifierCollector Qc;
525 const Type *T = Qc.strip(Ty);
526
527 // Ignore these qualifiers for now.
528 Qc.removeObjCGCAttr();
529 Qc.removeAddressSpace();
530 Qc.removeObjCLifetime();
531
532 // We will create one Derived type for one qualifier and recurse to handle any
533 // additional ones.
534 unsigned Tag;
535 if (Qc.hasConst()) {
536 Tag = llvm::dwarf::DW_TAG_const_type;
537 Qc.removeConst();
538 } else if (Qc.hasVolatile()) {
539 Tag = llvm::dwarf::DW_TAG_volatile_type;
540 Qc.removeVolatile();
541 } else if (Qc.hasRestrict()) {
542 Tag = llvm::dwarf::DW_TAG_restrict_type;
543 Qc.removeRestrict();
544 } else {
545 assert(Qc.empty() && "Unknown type qualifier for debug info");
546 return getOrCreateType(QualType(T, 0), Unit);
547 }
548
David Blaikie99dab3b2013-09-04 22:03:57 +0000549 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000550
551 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
552 // CVR derived types.
553 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000554
Guy Benyei11169dd2012-12-18 14:30:41 +0000555 return DbgTy;
556}
557
558llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
559 llvm::DIFile Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000560
561 // The frontend treats 'id' as a typedef to an ObjCObjectType,
562 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
563 // debug info, we want to emit 'id' in both cases.
564 if (Ty->isObjCQualifiedIdType())
565 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
566
Guy Benyei11169dd2012-12-18 14:30:41 +0000567 llvm::DIType DbgTy =
Eric Christopherb2a008c2013-05-16 00:45:12 +0000568 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000569 Ty->getPointeeType(), Unit);
570 return DbgTy;
571}
572
573llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
574 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000575 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000576 Ty->getPointeeType(), Unit);
577}
578
Manman Rene0064d82013-08-29 23:19:58 +0000579/// In C++ mode, types have linkage, so we can rely on the ODR and
580/// on their mangled names, if they're external.
581static SmallString<256>
582getUniqueTagTypeName(const TagType *Ty, CodeGenModule &CGM,
583 llvm::DICompileUnit TheCU) {
584 SmallString<256> FullName;
585 // FIXME: ODR should apply to ObjC++ exactly the same wasy it does to C++.
586 // For now, only apply ODR with C++.
587 const TagDecl *TD = Ty->getDecl();
588 if (TheCU.getLanguage() != llvm::dwarf::DW_LANG_C_plus_plus ||
589 !TD->isExternallyVisible())
590 return FullName;
591 // Microsoft Mangler does not have support for mangleCXXRTTIName yet.
592 if (CGM.getTarget().getCXXABI().isMicrosoft())
593 return FullName;
594
595 // TODO: This is using the RTTI name. Is there a better way to get
596 // a unique string for a type?
597 llvm::raw_svector_ostream Out(FullName);
598 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
599 Out.flush();
600 return FullName;
601}
602
Guy Benyei11169dd2012-12-18 14:30:41 +0000603// Creates a forward declaration for a RecordDecl in the given context.
David Blaikie8d5e1282013-08-20 21:03:29 +0000604llvm::DICompositeType
Manman Ren1b457022013-08-28 21:20:28 +0000605CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
David Blaikie8d5e1282013-08-20 21:03:29 +0000606 llvm::DIDescriptor Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000607 const RecordDecl *RD = Ty->getDecl();
David Blaikie4e7ef802013-08-15 20:17:25 +0000608 if (llvm::DIType T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
David Blaikie8d5e1282013-08-20 21:03:29 +0000609 return llvm::DICompositeType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000610 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
611 unsigned Line = getLineNumber(RD->getLocation());
612 StringRef RDName = getClassName(RD);
613
614 unsigned Tag = 0;
615 if (RD->isStruct() || RD->isInterface())
616 Tag = llvm::dwarf::DW_TAG_structure_type;
617 else if (RD->isUnion())
618 Tag = llvm::dwarf::DW_TAG_union_type;
619 else {
620 assert(RD->isClass());
621 Tag = llvm::dwarf::DW_TAG_class_type;
622 }
623
624 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000625 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
626 return DBuilder.createForwardDecl(Tag, RDName, Ctx, DefUnit, Line, 0, 0, 0,
627 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +0000628}
629
Guy Benyei11169dd2012-12-18 14:30:41 +0000630llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +0000631 const Type *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000632 QualType PointeeTy,
633 llvm::DIFile Unit) {
634 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
635 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikie99dab3b2013-09-04 22:03:57 +0000636 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit));
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000637
Guy Benyei11169dd2012-12-18 14:30:41 +0000638 // Bit size, align and offset of the type.
639 // Size is always the size of a pointer. We can't use getTypeSize here
640 // because that does not return the correct value for references.
641 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000642 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000643 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
644
David Blaikie99dab3b2013-09-04 22:03:57 +0000645 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
646 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000647}
648
Eric Christopher0fdcb312013-05-16 00:52:20 +0000649llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
650 llvm::DIType &Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000651 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000652 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000653 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
654 TheCU, getOrCreateMainFile(), 0);
655 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
656 Cache = DBuilder.createPointerType(Cache, Size);
657 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000658}
659
Guy Benyei11169dd2012-12-18 14:30:41 +0000660llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
661 llvm::DIFile Unit) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000662 if (BlockLiteralGeneric)
Guy Benyei11169dd2012-12-18 14:30:41 +0000663 return BlockLiteralGeneric;
664
665 SmallVector<llvm::Value *, 8> EltTys;
666 llvm::DIType FieldTy;
667 QualType FType;
668 uint64_t FieldSize, FieldOffset;
669 unsigned FieldAlign;
670 llvm::DIArray Elements;
671 llvm::DIType EltTy, DescTy;
672
673 FieldOffset = 0;
674 FType = CGM.getContext().UnsignedLongTy;
675 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
676 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
677
678 Elements = DBuilder.getOrCreateArray(EltTys);
679 EltTys.clear();
680
681 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
682 unsigned LineNo = getLineNumber(CurLoc);
683
684 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
685 Unit, LineNo, FieldOffset, 0,
David Blaikie6d4fe152013-02-25 01:07:08 +0000686 Flags, llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000687
688 // Bit size, align and offset of the type.
689 uint64_t Size = CGM.getContext().getTypeSize(Ty);
690
691 DescTy = DBuilder.createPointerType(EltTy, Size);
692
693 FieldOffset = 0;
694 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
695 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
696 FType = CGM.getContext().IntTy;
697 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
698 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
699 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
700 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
701
702 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
703 FieldTy = DescTy;
704 FieldSize = CGM.getContext().getTypeSize(Ty);
705 FieldAlign = CGM.getContext().getTypeAlign(Ty);
706 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
707 LineNo, FieldSize, FieldAlign,
708 FieldOffset, 0, FieldTy);
709 EltTys.push_back(FieldTy);
710
711 FieldOffset += FieldSize;
712 Elements = DBuilder.getOrCreateArray(EltTys);
713
714 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
715 Unit, LineNo, FieldOffset, 0,
David Blaikie6d4fe152013-02-25 01:07:08 +0000716 Flags, llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000717
Guy Benyei11169dd2012-12-18 14:30:41 +0000718 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
719 return BlockLiteralGeneric;
720}
721
David Blaikief1b382e2014-04-06 17:14:06 +0000722llvm::DIType CGDebugInfo::CreateType(const TemplateSpecializationType *Ty, llvm::DIFile Unit) {
723 assert(Ty->isTypeAlias());
724 llvm::DIType Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000725
726 SmallString<128> NS;
727 llvm::raw_svector_ostream OS(NS);
728 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(), /*qualified*/ false);
729
730 TemplateSpecializationType::PrintTemplateArgumentList(
731 OS, Ty->getArgs(), Ty->getNumArgs(),
732 CGM.getContext().getPrintingPolicy());
733
734 TypeAliasDecl *AliasDecl =
735 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
736 ->getTemplatedDecl();
737
738 SourceLocation Loc = AliasDecl->getLocation();
739 llvm::DIFile File = getOrCreateFile(Loc);
740 unsigned Line = getLineNumber(Loc);
741
742 llvm::DIDescriptor Ctxt = getContextDescriptor(cast<Decl>(AliasDecl->getDeclContext()));
743
744 return DBuilder.createTypedef(Src, internString(OS.str()), File, Line, Ctxt);
745}
746
David Blaikie99dab3b2013-09-04 22:03:57 +0000747llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000748 // Typedefs are derived from some other type. If we have a typedef of a
749 // typedef, make sure to emit the whole chain.
David Blaikie99dab3b2013-09-04 22:03:57 +0000750 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000751 // We don't set size information, but do specify where the typedef was
752 // declared.
Adrian Prantl3eff2252014-01-21 18:42:27 +0000753 SourceLocation Loc = Ty->getDecl()->getLocation();
754 llvm::DIFile File = getOrCreateFile(Loc);
755 unsigned Line = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000756 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000757
Guy Benyei11169dd2012-12-18 14:30:41 +0000758 llvm::DIDescriptor TypedefContext =
759 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopherb2a008c2013-05-16 00:45:12 +0000760
Guy Benyei11169dd2012-12-18 14:30:41 +0000761 return
Adrian Prantl3eff2252014-01-21 18:42:27 +0000762 DBuilder.createTypedef(Src, TyDecl->getName(), File, Line, TypedefContext);
Guy Benyei11169dd2012-12-18 14:30:41 +0000763}
764
765llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
766 llvm::DIFile Unit) {
767 SmallVector<llvm::Value *, 16> EltTys;
768
769 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000770 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000771
772 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000773 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000774 if (isa<FunctionNoProtoType>(Ty))
775 EltTys.push_back(DBuilder.createUnspecifiedParameter());
776 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000777 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
778 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000779 if (FPT->isVariadic())
780 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000781 }
782
783 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
784 return DBuilder.createSubroutineType(Unit, EltTypeArray);
785}
786
787
Guy Benyei11169dd2012-12-18 14:30:41 +0000788llvm::DIType CGDebugInfo::createFieldType(StringRef name,
789 QualType type,
790 uint64_t sizeInBitsOverride,
791 SourceLocation loc,
792 AccessSpecifier AS,
793 uint64_t offsetInBits,
794 llvm::DIFile tunit,
Manman Ren2c826dc2013-09-08 03:45:05 +0000795 llvm::DIScope scope) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000796 llvm::DIType debugType = getOrCreateType(type, tunit);
797
798 // Get the location for the field.
799 llvm::DIFile file = getOrCreateFile(loc);
800 unsigned line = getLineNumber(loc);
801
802 uint64_t sizeInBits = 0;
803 unsigned alignInBits = 0;
804 if (!type->isIncompleteArrayType()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000805 std::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
Guy Benyei11169dd2012-12-18 14:30:41 +0000806
807 if (sizeInBitsOverride)
808 sizeInBits = sizeInBitsOverride;
809 }
810
811 unsigned flags = 0;
812 if (AS == clang::AS_private)
813 flags |= llvm::DIDescriptor::FlagPrivate;
814 else if (AS == clang::AS_protected)
815 flags |= llvm::DIDescriptor::FlagProtected;
816
817 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
818 alignInBits, offsetInBits, flags, debugType);
819}
820
Eric Christopher91a31902013-01-16 01:22:32 +0000821/// CollectRecordLambdaFields - Helper for CollectRecordFields.
822void CGDebugInfo::
823CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
824 SmallVectorImpl<llvm::Value *> &elements,
825 llvm::DIType RecordTy) {
826 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
827 // has the name and the location of the variable so we should iterate over
828 // both concurrently.
829 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
830 RecordDecl::field_iterator Field = CXXDecl->field_begin();
831 unsigned fieldno = 0;
832 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
833 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
834 const LambdaExpr::Capture C = *I;
835 if (C.capturesVariable()) {
836 VarDecl *V = C.getCapturedVar();
837 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
838 StringRef VName = V->getName();
839 uint64_t SizeInBitsOverride = 0;
840 if (Field->isBitField()) {
841 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
842 assert(SizeInBitsOverride && "found named 0-width bitfield");
843 }
844 llvm::DIType fieldType
845 = createFieldType(VName, Field->getType(), SizeInBitsOverride,
846 C.getLocation(), Field->getAccess(),
847 layout.getFieldOffset(fieldno), VUnit, RecordTy);
848 elements.push_back(fieldType);
849 } else {
850 // TODO: Need to handle 'this' in some way by probably renaming the
851 // this of the lambda class and having a field member of 'this' or
852 // by using AT_object_pointer for the function and having that be
853 // used as 'this' for semantic references.
854 assert(C.capturesThis() && "Field that isn't captured and isn't this?");
855 FieldDecl *f = *Field;
856 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
857 QualType type = f->getType();
858 llvm::DIType fieldType
859 = createFieldType("this", type, 0, f->getLocation(), f->getAccess(),
860 layout.getFieldOffset(fieldno), VUnit, RecordTy);
861
862 elements.push_back(fieldType);
863 }
864 }
865}
866
David Blaikie6943dea2013-08-20 01:28:15 +0000867/// Helper for CollectRecordFields.
David Blaikieae019462013-08-15 22:50:29 +0000868llvm::DIDerivedType
869CGDebugInfo::CreateRecordStaticField(const VarDecl *Var,
870 llvm::DIType RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000871 // Create the descriptor for the static variable, with or without
872 // constant initializers.
873 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
874 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
875
Eric Christopher91a31902013-01-16 01:22:32 +0000876 unsigned LineNumber = getLineNumber(Var->getLocation());
877 StringRef VName = Var->getName();
David Blaikied42917f2013-01-20 01:19:17 +0000878 llvm::Constant *C = NULL;
Eric Christopher91a31902013-01-16 01:22:32 +0000879 if (Var->getInit()) {
880 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000881 if (Value) {
882 if (Value->isInt())
883 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
884 if (Value->isFloat())
885 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
886 }
Eric Christopher91a31902013-01-16 01:22:32 +0000887 }
888
889 unsigned Flags = 0;
890 AccessSpecifier Access = Var->getAccess();
891 if (Access == clang::AS_private)
892 Flags |= llvm::DIDescriptor::FlagPrivate;
893 else if (Access == clang::AS_protected)
894 Flags |= llvm::DIDescriptor::FlagProtected;
895
David Blaikieae019462013-08-15 22:50:29 +0000896 llvm::DIDerivedType GV = DBuilder.createStaticMemberType(
897 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Eric Christopher91a31902013-01-16 01:22:32 +0000898 StaticDataMemberCache[Var->getCanonicalDecl()] = llvm::WeakVH(GV);
David Blaikieae019462013-08-15 22:50:29 +0000899 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +0000900}
901
902/// CollectRecordNormalField - Helper for CollectRecordFields.
903void CGDebugInfo::
904CollectRecordNormalField(const FieldDecl *field, uint64_t OffsetInBits,
905 llvm::DIFile tunit,
906 SmallVectorImpl<llvm::Value *> &elements,
907 llvm::DIType RecordTy) {
908 StringRef name = field->getName();
909 QualType type = field->getType();
910
911 // Ignore unnamed fields unless they're anonymous structs/unions.
912 if (name.empty() && !type->isRecordType())
913 return;
914
915 uint64_t SizeInBitsOverride = 0;
916 if (field->isBitField()) {
917 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
918 assert(SizeInBitsOverride && "found named 0-width bitfield");
919 }
920
921 llvm::DIType fieldType
922 = createFieldType(name, type, SizeInBitsOverride,
923 field->getLocation(), field->getAccess(),
924 OffsetInBits, tunit, RecordTy);
925
926 elements.push_back(fieldType);
927}
928
Guy Benyei11169dd2012-12-18 14:30:41 +0000929/// CollectRecordFields - A helper function to collect debug info for
930/// record fields. This is used while creating debug info entry for a Record.
David Blaikieab255bb2013-08-16 20:40:25 +0000931void CGDebugInfo::CollectRecordFields(const RecordDecl *record,
932 llvm::DIFile tunit,
933 SmallVectorImpl<llvm::Value *> &elements,
934 llvm::DICompositeType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000935 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
936
Eric Christopher91a31902013-01-16 01:22:32 +0000937 if (CXXDecl && CXXDecl->isLambda())
938 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
939 else {
940 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +0000941
Eric Christopher91a31902013-01-16 01:22:32 +0000942 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +0000943 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +0000944
Eric Christopher91a31902013-01-16 01:22:32 +0000945 // Static and non-static members should appear in the same order as
946 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +0000947 for (const auto *I : record->decls())
948 if (const auto *V = dyn_cast<VarDecl>(I)) {
David Blaikiece763042013-08-20 21:49:21 +0000949 // Reuse the existing static member declaration if one exists
950 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
951 StaticDataMemberCache.find(V->getCanonicalDecl());
952 if (MI != StaticDataMemberCache.end()) {
953 assert(MI->second &&
954 "Static data member declaration should still exist");
955 elements.push_back(
956 llvm::DIDerivedType(cast<llvm::MDNode>(MI->second)));
957 } else
958 elements.push_back(CreateRecordStaticField(V, RecordTy));
Aaron Ballman629afae2014-03-07 19:56:05 +0000959 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christopher91a31902013-01-16 01:22:32 +0000960 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo),
961 tunit, elements, RecordTy);
962
963 // Bump field number for next field.
964 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +0000965 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000966 }
967}
968
969/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
970/// function type is not updated to include implicit "this" pointer. Use this
971/// routine to get a method type which includes "this" pointer.
David Blaikie469f0792013-05-22 23:22:42 +0000972llvm::DICompositeType
Guy Benyei11169dd2012-12-18 14:30:41 +0000973CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
974 llvm::DIFile Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +0000975 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +0000976 if (Method->isStatic())
David Blaikie469f0792013-05-22 23:22:42 +0000977 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +0000978 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
979 Func, Unit);
980}
David Blaikie2aaf0652013-01-07 22:24:59 +0000981
David Blaikie469f0792013-05-22 23:22:42 +0000982llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie7eb06852013-01-07 23:06:35 +0000983 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000984 // Add "this" pointer.
David Blaikie7eb06852013-01-07 23:06:35 +0000985 llvm::DIArray Args = llvm::DICompositeType(
986 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +0000987 assert (Args.getNumElements() && "Invalid number of arguments!");
988
989 SmallVector<llvm::Value *, 16> Elts;
990
991 // First element is always return type. For 'void' functions it is NULL.
992 Elts.push_back(Args.getElement(0));
993
David Blaikie2aaf0652013-01-07 22:24:59 +0000994 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +0000995 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +0000996 if (isa<ClassTemplateSpecializationDecl>(RD)) {
997 // Create pointer type directly in this case.
998 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
999 QualType PointeeTy = ThisPtrTy->getPointeeType();
1000 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001001 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001002 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
1003 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopher0fdcb312013-05-16 00:52:20 +00001004 llvm::DIType ThisPtrType =
1005 DBuilder.createPointerType(PointeeType, Size, Align);
David Blaikie2aaf0652013-01-07 22:24:59 +00001006 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1007 // TODO: This and the artificial type below are misleading, the
1008 // types aren't artificial the argument is, but the current
1009 // metadata doesn't represent that.
1010 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1011 Elts.push_back(ThisPtrType);
1012 } else {
1013 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
1014 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1015 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1016 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001017 }
1018
1019 // Copy rest of the arguments.
1020 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
1021 Elts.push_back(Args.getElement(i));
1022
1023 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1024
Adrian Prantl0630eb72013-12-18 21:48:18 +00001025 unsigned Flags = 0;
1026 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1027 Flags |= llvm::DIDescriptor::FlagLValueReference;
1028 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1029 Flags |= llvm::DIDescriptor::FlagRValueReference;
1030
1031 return DBuilder.createSubroutineType(Unit, EltTypeArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001032}
1033
Eric Christopherb2a008c2013-05-16 00:45:12 +00001034/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001035/// inside a function.
1036static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1037 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1038 return isFunctionLocalClass(NRD);
1039 if (isa<FunctionDecl>(RD->getDeclContext()))
1040 return true;
1041 return false;
1042}
1043
1044/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1045/// a single member function GlobalDecl.
1046llvm::DISubprogram
1047CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
1048 llvm::DIFile Unit,
1049 llvm::DIType RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001050 bool IsCtorOrDtor =
Guy Benyei11169dd2012-12-18 14:30:41 +00001051 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001052
Guy Benyei11169dd2012-12-18 14:30:41 +00001053 StringRef MethodName = getFunctionName(Method);
David Blaikie469f0792013-05-22 23:22:42 +00001054 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001055
1056 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1057 // make sense to give a single ctor/dtor a linkage name.
1058 StringRef MethodLinkageName;
1059 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1060 MethodLinkageName = CGM.getMangledName(Method);
1061
1062 // Get the location for the method.
David Blaikie7fceebf2013-08-19 03:37:48 +00001063 llvm::DIFile MethodDefUnit;
1064 unsigned MethodLine = 0;
1065 if (!Method->isImplicit()) {
1066 MethodDefUnit = getOrCreateFile(Method->getLocation());
1067 MethodLine = getLineNumber(Method->getLocation());
1068 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001069
1070 // Collect virtual method info.
1071 llvm::DIType ContainingType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001072 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001073 unsigned VIndex = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001074
Guy Benyei11169dd2012-12-18 14:30:41 +00001075 if (Method->isVirtual()) {
1076 if (Method->isPure())
1077 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1078 else
1079 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001080
Guy Benyei11169dd2012-12-18 14:30:41 +00001081 // It doesn't make sense to give a virtual destructor a vtable index,
1082 // since a single destructor has two entries in the vtable.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001083 // FIXME: Add proper support for debug info for virtual calls in
1084 // the Microsoft ABI, where we may use multiple vptrs to make a vftable
1085 // lookup if we have multiple or virtual inheritance.
1086 if (!isa<CXXDestructorDecl>(Method) &&
1087 !CGM.getTarget().getCXXABI().isMicrosoft())
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001088 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
Guy Benyei11169dd2012-12-18 14:30:41 +00001089 ContainingType = RecordTy;
1090 }
1091
1092 unsigned Flags = 0;
1093 if (Method->isImplicit())
1094 Flags |= llvm::DIDescriptor::FlagArtificial;
1095 AccessSpecifier Access = Method->getAccess();
1096 if (Access == clang::AS_private)
1097 Flags |= llvm::DIDescriptor::FlagPrivate;
1098 else if (Access == clang::AS_protected)
1099 Flags |= llvm::DIDescriptor::FlagProtected;
1100 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1101 if (CXXC->isExplicit())
1102 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001103 } else if (const CXXConversionDecl *CXXC =
Guy Benyei11169dd2012-12-18 14:30:41 +00001104 dyn_cast<CXXConversionDecl>(Method)) {
1105 if (CXXC->isExplicit())
1106 Flags |= llvm::DIDescriptor::FlagExplicit;
1107 }
1108 if (Method->hasPrototype())
1109 Flags |= llvm::DIDescriptor::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001110 if (Method->getRefQualifier() == RQ_LValue)
1111 Flags |= llvm::DIDescriptor::FlagLValueReference;
1112 if (Method->getRefQualifier() == RQ_RValue)
1113 Flags |= llvm::DIDescriptor::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001114
1115 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1116 llvm::DISubprogram SP =
Eric Christopherb2a008c2013-05-16 00:45:12 +00001117 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Guy Benyei11169dd2012-12-18 14:30:41 +00001118 MethodDefUnit, MethodLine,
Eric Christopherb2a008c2013-05-16 00:45:12 +00001119 MethodTy, /*isLocalToUnit=*/false,
Guy Benyei11169dd2012-12-18 14:30:41 +00001120 /* isDefinition=*/ false,
1121 Virtuality, VIndex, ContainingType,
1122 Flags, CGM.getLangOpts().Optimize, NULL,
1123 TParamsArray);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001124
Guy Benyei11169dd2012-12-18 14:30:41 +00001125 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
1126
1127 return SP;
1128}
1129
1130/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001131/// C++ member functions. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001132/// a Record.
1133void CGDebugInfo::
1134CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
1135 SmallVectorImpl<llvm::Value *> &EltTys,
1136 llvm::DIType RecordTy) {
1137
1138 // Since we want more than just the individual member decls if we
1139 // have templated functions iterate over every declaration to gather
1140 // the functions.
Aaron Ballman629afae2014-03-07 19:56:05 +00001141 for(const auto *I : RD->decls()) {
1142 if (const auto *Method = dyn_cast<CXXMethodDecl>(I)) {
David Blaikiea6cc8212013-08-28 20:58:00 +00001143 // Reuse the existing member function declaration if it exists.
David Blaikie8c8e8e22013-08-28 20:24:55 +00001144 // It may be associated with the declaration of the type & should be
1145 // reused as we're building the definition.
David Blaikiea6cc8212013-08-28 20:58:00 +00001146 //
1147 // This situation can arise in the vtable-based debug info reduction where
1148 // implicit members are emitted in a non-vtable TU.
David Blaikie6943dea2013-08-20 01:28:15 +00001149 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
1150 SPCache.find(Method->getCanonicalDecl());
David Blaikiefae219a2013-08-28 17:27:13 +00001151 if (MI == SPCache.end()) {
David Blaikie8c8e8e22013-08-28 20:24:55 +00001152 // If the member is implicit, lazily create it when we see the
1153 // definition, not before. (an ODR-used implicit default ctor that's
1154 // never actually code generated should not produce debug info)
David Blaikiefae219a2013-08-28 17:27:13 +00001155 if (!Method->isImplicit())
1156 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
1157 } else
David Blaikie6943dea2013-08-20 01:28:15 +00001158 EltTys.push_back(MI->second);
Aaron Ballman629afae2014-03-07 19:56:05 +00001159 } else if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(I)) {
David Blaikief2053af2013-08-28 23:06:52 +00001160 // Add any template specializations that have already been seen. Like
1161 // implicit member functions, these may have been added to a declaration
1162 // in the case of vtable-based debug info reduction.
Aaron Ballmanb8733c52014-03-14 16:05:56 +00001163 for (const auto *SI : FTD->specializations()) {
David Blaikief2053af2013-08-28 23:06:52 +00001164 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
Aaron Ballmanb8733c52014-03-14 16:05:56 +00001165 SPCache.find(cast<CXXMethodDecl>(SI)->getCanonicalDecl());
David Blaikief2053af2013-08-28 23:06:52 +00001166 if (MI != SPCache.end())
1167 EltTys.push_back(MI->second);
1168 }
David Blaikie6943dea2013-08-20 01:28:15 +00001169 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001170 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001171}
Guy Benyei11169dd2012-12-18 14:30:41 +00001172
Guy Benyei11169dd2012-12-18 14:30:41 +00001173/// CollectCXXBases - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001174/// C++ base classes. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001175/// a Record.
1176void CGDebugInfo::
1177CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1178 SmallVectorImpl<llvm::Value *> &EltTys,
1179 llvm::DIType RecordTy) {
1180
1181 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001182 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001183 unsigned BFlags = 0;
1184 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001185
Guy Benyei11169dd2012-12-18 14:30:41 +00001186 const CXXRecordDecl *Base =
Aaron Ballman574705e2014-03-13 15:41:46 +00001187 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001188
Aaron Ballman574705e2014-03-13 15:41:46 +00001189 if (BI.isVirtual()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001190 // virtual base offset offset is -ve. The code generator emits dwarf
1191 // expression where it expects +ve number.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001192 BaseOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001193 0 - CGM.getItaniumVTableContext()
Guy Benyei11169dd2012-12-18 14:30:41 +00001194 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1195 BFlags = llvm::DIDescriptor::FlagVirtual;
1196 } else
1197 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1198 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1199 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001200
Aaron Ballman574705e2014-03-13 15:41:46 +00001201 AccessSpecifier Access = BI.getAccessSpecifier();
Guy Benyei11169dd2012-12-18 14:30:41 +00001202 if (Access == clang::AS_private)
1203 BFlags |= llvm::DIDescriptor::FlagPrivate;
1204 else if (Access == clang::AS_protected)
1205 BFlags |= llvm::DIDescriptor::FlagProtected;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001206
1207 llvm::DIType DTy =
1208 DBuilder.createInheritance(RecordTy,
Aaron Ballman574705e2014-03-13 15:41:46 +00001209 getOrCreateType(BI.getType(), Unit),
Guy Benyei11169dd2012-12-18 14:30:41 +00001210 BaseOffset, BFlags);
1211 EltTys.push_back(DTy);
1212 }
1213}
1214
1215/// CollectTemplateParams - A helper function to collect template parameters.
1216llvm::DIArray CGDebugInfo::
1217CollectTemplateParams(const TemplateParameterList *TPList,
David Blaikie47c11502013-06-22 18:59:18 +00001218 ArrayRef<TemplateArgument> TAList,
Guy Benyei11169dd2012-12-18 14:30:41 +00001219 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001220 SmallVector<llvm::Value *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001221 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1222 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001223 StringRef Name;
1224 if (TPList)
1225 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001226 switch (TA.getKind()) {
1227 case TemplateArgument::Type: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001228 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1229 llvm::DITemplateTypeParameter TTP =
David Blaikie47c11502013-06-22 18:59:18 +00001230 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001231 TemplateParams.push_back(TTP);
David Blaikie38079fd2013-05-10 21:53:14 +00001232 } break;
1233 case TemplateArgument::Integral: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001234 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1235 llvm::DITemplateValueParameter TVP =
David Blaikie38079fd2013-05-10 21:53:14 +00001236 DBuilder.createTemplateValueParameter(
David Blaikie47c11502013-06-22 18:59:18 +00001237 TheCU, Name, TTy,
David Blaikie38079fd2013-05-10 21:53:14 +00001238 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1239 TemplateParams.push_back(TVP);
1240 } break;
1241 case TemplateArgument::Declaration: {
1242 const ValueDecl *D = TA.getAsDecl();
1243 bool InstanceMember = D->isCXXInstanceMember();
1244 QualType T = InstanceMember
1245 ? CGM.getContext().getMemberPointerType(
1246 D->getType(), cast<RecordDecl>(D->getDeclContext())
1247 ->getTypeForDecl())
1248 : CGM.getContext().getPointerType(D->getType());
1249 llvm::DIType TTy = getOrCreateType(T, Unit);
1250 llvm::Value *V = 0;
1251 // Variable pointer template parameters have a value that is the address
1252 // of the variable.
1253 if (const VarDecl *VD = dyn_cast<VarDecl>(D))
1254 V = CGM.GetAddrOfGlobalVar(VD);
1255 // Member function pointers have special support for building them, though
1256 // this is currently unsupported in LLVM CodeGen.
David Blaikied900f982013-05-13 06:57:50 +00001257 if (InstanceMember) {
David Blaikie38079fd2013-05-10 21:53:14 +00001258 if (const CXXMethodDecl *method = dyn_cast<CXXMethodDecl>(D))
1259 V = CGM.getCXXABI().EmitMemberPointer(method);
David Blaikied900f982013-05-13 06:57:50 +00001260 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1261 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001262 // Member data pointers have special handling too to compute the fixed
1263 // offset within the object.
Adrian Prantlefb88052014-04-01 17:52:06 +00001264 if (isa<FieldDecl>(D) || isa<IndirectFieldDecl>(D)) {
David Blaikie38079fd2013-05-10 21:53:14 +00001265 // These five lines (& possibly the above member function pointer
1266 // handling) might be able to be refactored to use similar code in
1267 // CodeGenModule::getMemberPointerConstant
1268 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1269 CharUnits chars =
1270 CGM.getContext().toCharUnitsFromBits((int64_t) fieldOffset);
1271 V = CGM.getCXXABI().EmitMemberDataPointer(
1272 cast<MemberPointerType>(T.getTypePtr()), chars);
1273 }
1274 llvm::DITemplateValueParameter TVP =
David Majnemera3644d62013-08-25 22:13:27 +00001275 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1276 V->stripPointerCasts());
David Blaikie38079fd2013-05-10 21:53:14 +00001277 TemplateParams.push_back(TVP);
1278 } break;
1279 case TemplateArgument::NullPtr: {
1280 QualType T = TA.getNullPtrType();
1281 llvm::DIType TTy = getOrCreateType(T, Unit);
1282 llvm::Value *V = 0;
1283 // Special case member data pointer null values since they're actually -1
1284 // instead of zero.
1285 if (const MemberPointerType *MPT =
1286 dyn_cast<MemberPointerType>(T.getTypePtr()))
1287 // But treat member function pointers as simple zero integers because
1288 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1289 // CodeGen grows handling for values of non-null member function
1290 // pointers then perhaps we could remove this special case and rely on
1291 // EmitNullMemberPointer for member function pointers.
1292 if (MPT->isMemberDataPointer())
1293 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1294 if (!V)
1295 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1296 llvm::DITemplateValueParameter TVP =
David Blaikie47c11502013-06-22 18:59:18 +00001297 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V);
David Blaikie38079fd2013-05-10 21:53:14 +00001298 TemplateParams.push_back(TVP);
1299 } break;
David Blaikie47c11502013-06-22 18:59:18 +00001300 case TemplateArgument::Template: {
1301 llvm::DITemplateValueParameter TVP =
1302 DBuilder.createTemplateTemplateParameter(
1303 TheCU, Name, llvm::DIType(),
1304 TA.getAsTemplate().getAsTemplateDecl()
1305 ->getQualifiedNameAsString());
1306 TemplateParams.push_back(TVP);
1307 } break;
1308 case TemplateArgument::Pack: {
1309 llvm::DITemplateValueParameter TVP =
1310 DBuilder.createTemplateParameterPack(
1311 TheCU, Name, llvm::DIType(),
1312 CollectTemplateParams(NULL, TA.getPackAsArray(), Unit));
1313 TemplateParams.push_back(TVP);
1314 } break;
David Majnemer5559d472013-08-24 08:21:10 +00001315 case TemplateArgument::Expression: {
1316 const Expr *E = TA.getAsExpr();
1317 QualType T = E->getType();
1318 llvm::Value *V = CGM.EmitConstantExpr(E, T);
1319 assert(V && "Expression in template argument isn't constant");
1320 llvm::DIType TTy = getOrCreateType(T, Unit);
1321 llvm::DITemplateValueParameter TVP =
1322 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1323 V->stripPointerCasts());
1324 TemplateParams.push_back(TVP);
1325 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001326 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001327 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001328 case TemplateArgument::Null:
1329 llvm_unreachable(
1330 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001331 }
1332 }
1333 return DBuilder.getOrCreateArray(TemplateParams);
1334}
1335
1336/// CollectFunctionTemplateParams - A helper function to collect debug
1337/// info for function template parameters.
1338llvm::DIArray CGDebugInfo::
1339CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1340 if (FD->getTemplatedKind() ==
1341 FunctionDecl::TK_FunctionTemplateSpecialization) {
1342 const TemplateParameterList *TList =
1343 FD->getTemplateSpecializationInfo()->getTemplate()
1344 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001345 return CollectTemplateParams(
1346 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001347 }
1348 return llvm::DIArray();
1349}
1350
1351/// CollectCXXTemplateParams - A helper function to collect debug info for
1352/// template parameters.
1353llvm::DIArray CGDebugInfo::
1354CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1355 llvm::DIFile Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001356 // Always get the full list of parameters, not just the ones from
1357 // the specialization.
1358 TemplateParameterList *TPList =
1359 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001360 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001361 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001362}
1363
1364/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1365llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1366 if (VTablePtrType.isValid())
1367 return VTablePtrType;
1368
1369 ASTContext &Context = CGM.getContext();
1370
1371 /* Function type */
1372 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1373 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1374 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1375 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1376 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1377 "__vtbl_ptr_type");
1378 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1379 return VTablePtrType;
1380}
1381
1382/// getVTableName - Get vtable name for the given Class.
1383StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001384 // Copy the gdb compatible name on the side and use its reference.
1385 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001386}
1387
1388
1389/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1390/// debug info entry in EltTys vector.
1391void CGDebugInfo::
1392CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1393 SmallVectorImpl<llvm::Value *> &EltTys) {
1394 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1395
1396 // If there is a primary base then it will hold vtable info.
1397 if (RL.getPrimaryBase())
1398 return;
1399
1400 // If this class is not dynamic then there is not any vtable info to collect.
1401 if (!RD->isDynamicClass())
1402 return;
1403
1404 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1405 llvm::DIType VPTR
1406 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Eric Christopher0fdcb312013-05-16 00:52:20 +00001407 0, Size, 0, 0,
1408 llvm::DIDescriptor::FlagArtificial,
Guy Benyei11169dd2012-12-18 14:30:41 +00001409 getOrCreateVTablePtrType(Unit));
1410 EltTys.push_back(VPTR);
1411}
1412
Eric Christopherb2a008c2013-05-16 00:45:12 +00001413/// getOrCreateRecordType - Emit record type's standalone debug info.
1414llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00001415 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001416 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001417 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1418 return T;
1419}
1420
1421/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1422/// debug info.
1423llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001424 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001425 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001426 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantl73409ce2013-03-11 18:33:46 +00001427 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001428 return T;
1429}
1430
David Blaikieb2e86eb2013-08-15 20:49:17 +00001431void CGDebugInfo::completeType(const RecordDecl *RD) {
1432 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1433 !CGM.getLangOpts().CPlusPlus)
1434 completeRequiredType(RD);
1435}
1436
1437void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie0856f662014-03-04 22:01:08 +00001438 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1439 return;
1440
David Blaikie6943dea2013-08-20 01:28:15 +00001441 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1442 if (CXXDecl->isDynamicClass())
1443 return;
1444
David Blaikieb2e86eb2013-08-15 20:49:17 +00001445 QualType Ty = CGM.getContext().getRecordType(RD);
1446 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie6943dea2013-08-20 01:28:15 +00001447 if (T && T.isForwardDecl())
1448 completeClassData(RD);
1449}
1450
1451void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1452 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001453 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001454 QualType Ty = CGM.getContext().getRecordType(RD);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001455 void* TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001456 auto I = TypeCache.find(TyPtr);
1457 if (I != TypeCache.end() &&
1458 !llvm::DIType(cast<llvm::MDNode>(static_cast<llvm::Value *>(I->second)))
1459 .isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001460 return;
1461 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1462 assert(!Res.isForwardDecl());
David Blaikieb2e86eb2013-08-15 20:49:17 +00001463 TypeCache[TyPtr] = Res;
1464}
1465
David Blaikie0e716b42014-03-03 23:48:23 +00001466static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1467 CXXRecordDecl::method_iterator End) {
1468 for (; I != End; ++I)
1469 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001470 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1471 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001472 return true;
1473 return false;
1474}
1475
1476static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
1477 const RecordDecl *RD,
1478 const LangOptions &LangOpts) {
1479 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1480 return false;
1481
1482 if (!LangOpts.CPlusPlus)
1483 return false;
1484
1485 if (!RD->isCompleteDefinitionRequired())
1486 return true;
1487
1488 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1489
1490 if (!CXXDecl)
1491 return false;
1492
1493 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1494 return true;
1495
1496 TemplateSpecializationKind Spec = TSK_Undeclared;
1497 if (const ClassTemplateSpecializationDecl *SD =
1498 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1499 Spec = SD->getSpecializationKind();
1500
1501 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1502 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1503 CXXDecl->method_end()))
1504 return true;
1505
1506 return false;
1507}
1508
Guy Benyei11169dd2012-12-18 14:30:41 +00001509/// CreateType - get structure or union type.
David Blaikie99dab3b2013-09-04 22:03:57 +00001510llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001511 RecordDecl *RD = Ty->getDecl();
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001512 llvm::DICompositeType T(getTypeOrNull(QualType(Ty, 0)));
David Blaikie0e716b42014-03-03 23:48:23 +00001513 if (T || shouldOmitDefinition(DebugKind, RD, CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001514 if (!T)
David Blaikie65ec94e2014-02-18 20:52:05 +00001515 T = getOrCreateRecordFwdDecl(
1516 Ty, getContextDescriptor(cast<Decl>(RD->getDeclContext())));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001517 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001518 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001519
David Blaikieb2e86eb2013-08-15 20:49:17 +00001520 return CreateTypeDefinition(Ty);
1521}
1522
1523llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1524 RecordDecl *RD = Ty->getDecl();
1525
Guy Benyei11169dd2012-12-18 14:30:41 +00001526 // Get overall information about the record type for the debug info.
1527 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1528
1529 // Records and classes and unions can all be recursive. To handle them, we
1530 // first generate a debug descriptor for the struct as a forward declaration.
1531 // Then (if it is a definition) we go through and get debug info for all of
1532 // its members. Finally, we create a descriptor for the complete type (which
1533 // may refer to the forward decl if the struct is recursive) and replace all
1534 // uses of the forward declaration with the final definition.
1535
David Blaikie4a2b5ef2013-08-12 22:24:20 +00001536 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Ren0d441f12013-07-02 19:01:53 +00001537 assert(FwdDecl.isCompositeType() &&
David Blaikie469f0792013-05-22 23:22:42 +00001538 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei11169dd2012-12-18 14:30:41 +00001539
1540 if (FwdDecl.isForwardDecl())
1541 return FwdDecl;
1542
David Blaikieadfbf992013-08-18 16:55:33 +00001543 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1544 CollectContainingType(CXXDecl, FwdDecl);
1545
Guy Benyei11169dd2012-12-18 14:30:41 +00001546 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001547 LexicalBlockStack.push_back(&*FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001548 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1549
Guy Benyei11169dd2012-12-18 14:30:41 +00001550 // Convert all the elements.
1551 SmallVector<llvm::Value *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001552 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001553
1554 // Note: The split of CXXDecl information here is intentional, the
1555 // gdb tests will depend on a certain ordering at printout. The debug
1556 // information offsets are still correct if we merge them all together
1557 // though.
1558 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1559 if (CXXDecl) {
1560 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1561 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1562 }
1563
Eric Christopher91a31902013-01-16 01:22:32 +00001564 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001565 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001566 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001567 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001568
1569 LexicalBlockStack.pop_back();
1570 RegionMap.erase(Ty->getDecl());
1571
1572 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
David Blaikie4a5b8952013-08-01 20:31:40 +00001573 FwdDecl.setTypeArray(Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001574
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001575 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1576 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001577}
1578
1579/// CreateType - get objective-c object type.
1580llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1581 llvm::DIFile Unit) {
1582 // Ignore protocols.
1583 return getOrCreateType(Ty->getBaseType(), Unit);
1584}
1585
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001586
1587/// \return true if Getter has the default name for the property PD.
1588static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1589 const ObjCMethodDecl *Getter) {
1590 assert(PD);
1591 if (!Getter)
1592 return true;
1593
1594 assert(Getter->getDeclName().isObjCZeroArgSelector());
1595 return PD->getName() ==
1596 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
1597}
1598
1599/// \return true if Setter has the default name for the property PD.
1600static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1601 const ObjCMethodDecl *Setter) {
1602 assert(PD);
1603 if (!Setter)
1604 return true;
1605
1606 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001607 return SelectorTable::constructSetterName(PD->getName()) ==
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001608 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
1609}
1610
Guy Benyei11169dd2012-12-18 14:30:41 +00001611/// CreateType - get objective-c interface type.
1612llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1613 llvm::DIFile Unit) {
1614 ObjCInterfaceDecl *ID = Ty->getDecl();
1615 if (!ID)
1616 return llvm::DIType();
1617
1618 // Get overall information about the record type for the debug info.
1619 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1620 unsigned Line = getLineNumber(ID->getLocation());
1621 unsigned RuntimeLang = TheCU.getLanguage();
1622
1623 // If this is just a forward declaration return a special forward-declaration
1624 // debug type since we won't be able to lay out the entire type.
1625 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001626 if (!Def || !Def->getImplementation()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001627 llvm::DIType FwdDecl =
1628 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001629 ID->getName(), TheCU, DefUnit, Line,
1630 RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001631 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001632 return FwdDecl;
1633 }
1634
David Blaikieef8a9512014-05-05 23:23:53 +00001635
1636 return CreateTypeDefinition(Ty, Unit);
1637}
1638
1639llvm::DIType CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty, llvm::DIFile Unit) {
1640 ObjCInterfaceDecl *ID = Ty->getDecl();
1641 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1642 unsigned Line = getLineNumber(ID->getLocation());
1643 unsigned RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001644
1645 // Bit size, align and offset of the type.
1646 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1647 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1648
1649 unsigned Flags = 0;
1650 if (ID->getImplementation())
1651 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1652
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001653 llvm::DICompositeType RealDecl =
Guy Benyei11169dd2012-12-18 14:30:41 +00001654 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1655 Line, Size, Align, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00001656 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001657
David Blaikieef8a9512014-05-05 23:23:53 +00001658 QualType QTy(Ty, 0);
1659 TypeCache[QTy.getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001660
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001661 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001662 LexicalBlockStack.push_back(static_cast<llvm::MDNode*>(RealDecl));
Guy Benyei11169dd2012-12-18 14:30:41 +00001663 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1664
1665 // Convert all the elements.
1666 SmallVector<llvm::Value *, 16> EltTys;
1667
1668 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1669 if (SClass) {
1670 llvm::DIType SClassTy =
1671 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1672 if (!SClassTy.isValid())
1673 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001674
Guy Benyei11169dd2012-12-18 14:30:41 +00001675 llvm::DIType InhTag =
1676 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1677 EltTys.push_back(InhTag);
1678 }
1679
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001680 // Create entries for all of the properties.
Aaron Ballmand174edf2014-03-13 19:11:50 +00001681 for (const auto *PD : ID->properties()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001682 SourceLocation Loc = PD->getLocation();
1683 llvm::DIFile PUnit = getOrCreateFile(Loc);
1684 unsigned PLine = getLineNumber(Loc);
1685 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1686 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1687 llvm::MDNode *PropertyNode =
1688 DBuilder.createObjCProperty(PD->getName(),
Eric Christopherc0c5d462013-02-21 22:35:08 +00001689 PUnit, PLine,
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001690 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001691 getSelectorName(PD->getGetterName()),
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001692 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001693 getSelectorName(PD->getSetterName()),
1694 PD->getPropertyAttributes(),
Eric Christopherc0c5d462013-02-21 22:35:08 +00001695 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001696 EltTys.push_back(PropertyNode);
1697 }
1698
1699 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1700 unsigned FieldNo = 0;
1701 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1702 Field = Field->getNextIvar(), ++FieldNo) {
1703 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1704 if (!FieldTy.isValid())
1705 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001706
Guy Benyei11169dd2012-12-18 14:30:41 +00001707 StringRef FieldName = Field->getName();
1708
1709 // Ignore unnamed fields.
1710 if (FieldName.empty())
1711 continue;
1712
1713 // Get the location for the field.
1714 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1715 unsigned FieldLine = getLineNumber(Field->getLocation());
1716 QualType FType = Field->getType();
1717 uint64_t FieldSize = 0;
1718 unsigned FieldAlign = 0;
1719
1720 if (!FType->isIncompleteArrayType()) {
1721
1722 // Bit size, align and offset of the type.
1723 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001724 ? Field->getBitWidthValue(CGM.getContext())
1725 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001726 FieldAlign = CGM.getContext().getTypeAlign(FType);
1727 }
1728
1729 uint64_t FieldOffset;
1730 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1731 // We don't know the runtime offset of an ivar if we're using the
1732 // non-fragile ABI. For bitfields, use the bit offset into the first
1733 // byte of storage of the bitfield. For other fields, use zero.
1734 if (Field->isBitField()) {
1735 FieldOffset = CGM.getObjCRuntime().ComputeBitfieldBitOffset(
1736 CGM, ID, Field);
1737 FieldOffset %= CGM.getContext().getCharWidth();
1738 } else {
1739 FieldOffset = 0;
1740 }
1741 } else {
1742 FieldOffset = RL.getFieldOffset(FieldNo);
1743 }
1744
1745 unsigned Flags = 0;
1746 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1747 Flags = llvm::DIDescriptor::FlagProtected;
1748 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1749 Flags = llvm::DIDescriptor::FlagPrivate;
1750
1751 llvm::MDNode *PropertyNode = NULL;
1752 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001753 if (ObjCPropertyImplDecl *PImpD =
Guy Benyei11169dd2012-12-18 14:30:41 +00001754 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1755 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001756 SourceLocation Loc = PD->getLocation();
1757 llvm::DIFile PUnit = getOrCreateFile(Loc);
1758 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001759 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1760 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1761 PropertyNode =
1762 DBuilder.createObjCProperty(PD->getName(),
1763 PUnit, PLine,
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001764 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001765 getSelectorName(PD->getGetterName()),
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001766 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001767 getSelectorName(PD->getSetterName()),
1768 PD->getPropertyAttributes(),
1769 getOrCreateType(PD->getType(), PUnit));
1770 }
1771 }
1772 }
1773 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1774 FieldLine, FieldSize, FieldAlign,
1775 FieldOffset, Flags, FieldTy,
1776 PropertyNode);
1777 EltTys.push_back(FieldTy);
1778 }
1779
1780 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001781 RealDecl.setTypeArray(Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001782
Guy Benyei11169dd2012-12-18 14:30:41 +00001783 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001784 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001785}
1786
1787llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1788 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1789 int64_t Count = Ty->getNumElements();
1790 if (Count == 0)
1791 // If number of elements are not known then this is an unbounded array.
1792 // Use Count == -1 to express such arrays.
1793 Count = -1;
1794
1795 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1796 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1797
1798 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1799 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1800
1801 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1802}
1803
1804llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1805 llvm::DIFile Unit) {
1806 uint64_t Size;
1807 uint64_t Align;
1808
1809 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1810 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1811 Size = 0;
1812 Align =
1813 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1814 } else if (Ty->isIncompleteArrayType()) {
1815 Size = 0;
1816 if (Ty->getElementType()->isIncompleteType())
1817 Align = 0;
1818 else
1819 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001820 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001821 Size = 0;
1822 Align = 0;
1823 } else {
1824 // Size and align of the whole array, not the element type.
1825 Size = CGM.getContext().getTypeSize(Ty);
1826 Align = CGM.getContext().getTypeAlign(Ty);
1827 }
1828
1829 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1830 // interior arrays, do we care? Why aren't nested arrays represented the
1831 // obvious/recursive way?
1832 SmallVector<llvm::Value *, 8> Subscripts;
1833 QualType EltTy(Ty, 0);
1834 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1835 // If the number of elements is known, then count is that number. Otherwise,
1836 // it's -1. This allows us to represent a subrange with an array of 0
1837 // elements, like this:
1838 //
1839 // struct foo {
1840 // int x[0];
1841 // };
1842 int64_t Count = -1; // Count == -1 is an unbounded array.
1843 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1844 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001845
Guy Benyei11169dd2012-12-18 14:30:41 +00001846 // FIXME: Verify this is right for VLAs.
1847 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1848 EltTy = Ty->getElementType();
1849 }
1850
1851 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1852
Eric Christopherb2a008c2013-05-16 00:45:12 +00001853 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001854 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1855 SubscriptArray);
1856 return DbgTy;
1857}
1858
Eric Christopherb2a008c2013-05-16 00:45:12 +00001859llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001860 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001861 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001862 Ty, Ty->getPointeeType(), Unit);
1863}
1864
Eric Christopherb2a008c2013-05-16 00:45:12 +00001865llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001866 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001867 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001868 Ty, Ty->getPointeeType(), Unit);
1869}
1870
Eric Christopherb2a008c2013-05-16 00:45:12 +00001871llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001872 llvm::DIFile U) {
David Blaikie2c705ca2013-01-19 19:20:56 +00001873 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1874 if (!Ty->getPointeeType()->isFunctionType())
1875 return DBuilder.createMemberPointerType(
David Blaikie99dab3b2013-09-04 22:03:57 +00001876 getOrCreateType(Ty->getPointeeType(), U), ClassType);
Adrian Prantl0866acd2013-12-19 01:38:47 +00001877
1878 const FunctionProtoType *FPT =
1879 Ty->getPointeeType()->getAs<FunctionProtoType>();
David Blaikie2c705ca2013-01-19 19:20:56 +00001880 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
Adrian Prantl0866acd2013-12-19 01:38:47 +00001881 CGM.getContext().getPointerType(QualType(Ty->getClass(),
1882 FPT->getTypeQuals())),
1883 FPT, U), ClassType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001884}
1885
Eric Christopherb2a008c2013-05-16 00:45:12 +00001886llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001887 llvm::DIFile U) {
1888 // Ignore the atomic wrapping
1889 // FIXME: What is the correct representation?
1890 return getOrCreateType(Ty->getValueType(), U);
1891}
1892
1893/// CreateEnumType - get enumeration type.
Manman Ren501ecf92013-08-28 21:46:36 +00001894llvm::DIType CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00001895 const EnumDecl *ED = Ty->getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00001896 uint64_t Size = 0;
1897 uint64_t Align = 0;
1898 if (!ED->getTypeForDecl()->isIncompleteType()) {
1899 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1900 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1901 }
1902
Manman Rene0064d82013-08-29 23:19:58 +00001903 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1904
Guy Benyei11169dd2012-12-18 14:30:41 +00001905 // If this is just a forward declaration, construct an appropriately
1906 // marked node and just return it.
1907 if (!ED->getDefinition()) {
1908 llvm::DIDescriptor EDContext;
1909 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1910 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1911 unsigned Line = getLineNumber(ED->getLocation());
1912 StringRef EDName = ED->getName();
1913 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_enumeration_type,
1914 EDName, EDContext, DefUnit, Line, 0,
Manman Rene0064d82013-08-29 23:19:58 +00001915 Size, Align, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001916 }
1917
1918 // Create DIEnumerator elements for each enumerator.
1919 SmallVector<llvm::Value *, 16> Enumerators;
1920 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00001921 for (const auto *Enum : ED->enumerators()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001922 Enumerators.push_back(
1923 DBuilder.createEnumerator(Enum->getName(),
David Blaikiece1ae382013-06-24 07:13:13 +00001924 Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001925 }
1926
1927 // Return a CompositeType for the enum itself.
1928 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1929
1930 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1931 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001932 llvm::DIDescriptor EnumContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00001933 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantlc60dc712013-04-19 19:56:39 +00001934 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei11169dd2012-12-18 14:30:41 +00001935 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001936 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001937 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1938 Size, Align, EltArray,
Manman Rene0064d82013-08-29 23:19:58 +00001939 ClassTy, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001940 return DbgTy;
1941}
1942
David Blaikie05491062013-01-21 04:37:12 +00001943static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1944 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001945 do {
Adrian Prantl179af902013-09-26 21:35:50 +00001946 Qualifiers InnerQuals = T.getLocalQualifiers();
1947 // Qualifiers::operator+() doesn't like it if you add a Qualifier
1948 // that is already there.
1949 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
1950 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001951 QualType LastT = T;
1952 switch (T->getTypeClass()) {
1953 default:
David Blaikie05491062013-01-21 04:37:12 +00001954 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00001955 case Type::TemplateSpecialization: {
1956 const auto *Spec = cast<TemplateSpecializationType>(T);
1957 if (Spec->isTypeAlias())
1958 return C.getQualifiedType(T.getTypePtr(), Quals);
1959 T = Spec->desugar();
1960 break; }
Guy Benyei11169dd2012-12-18 14:30:41 +00001961 case Type::TypeOfExpr:
1962 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1963 break;
1964 case Type::TypeOf:
1965 T = cast<TypeOfType>(T)->getUnderlyingType();
1966 break;
1967 case Type::Decltype:
1968 T = cast<DecltypeType>(T)->getUnderlyingType();
1969 break;
1970 case Type::UnaryTransform:
1971 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1972 break;
1973 case Type::Attributed:
1974 T = cast<AttributedType>(T)->getEquivalentType();
1975 break;
1976 case Type::Elaborated:
1977 T = cast<ElaboratedType>(T)->getNamedType();
1978 break;
1979 case Type::Paren:
1980 T = cast<ParenType>(T)->getInnerType();
1981 break;
David Blaikie05491062013-01-21 04:37:12 +00001982 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00001983 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00001984 break;
1985 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00001986 QualType DT = cast<AutoType>(T)->getDeducedType();
1987 if (DT.isNull())
1988 return T;
1989 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00001990 break;
1991 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001992
Guy Benyei11169dd2012-12-18 14:30:41 +00001993 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00001994 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00001995 } while (true);
1996}
1997
Eric Christopher0fdcb312013-05-16 00:52:20 +00001998/// getType - Get the type from the cache or return null type if it doesn't
1999/// exist.
Guy Benyei11169dd2012-12-18 14:30:41 +00002000llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
2001
2002 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002003 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002004
Guy Benyei11169dd2012-12-18 14:30:41 +00002005 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2006 TypeCache.find(Ty.getAsOpaquePtr());
2007 if (it != TypeCache.end()) {
2008 // Verify that the debug info still exists.
2009 if (llvm::Value *V = it->second)
2010 return llvm::DIType(cast<llvm::MDNode>(V));
2011 }
2012
2013 return llvm::DIType();
2014}
2015
David Blaikie0e716b42014-03-03 23:48:23 +00002016void CGDebugInfo::completeTemplateDefinition(
2017 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002018 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2019 return;
2020
David Blaikie0e716b42014-03-03 23:48:23 +00002021 completeClassData(&SD);
2022 // In case this type has no member function definitions being emitted, ensure
2023 // it is retained
2024 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2025}
2026
Guy Benyei11169dd2012-12-18 14:30:41 +00002027/// getOrCreateType - Get the type from the cache or create a new
2028/// one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +00002029llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002030 if (Ty.isNull())
2031 return llvm::DIType();
2032
2033 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002034 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002035
David Blaikieef8a9512014-05-05 23:23:53 +00002036 if (llvm::DIType T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002037 return T;
2038
2039 // Otherwise create the type.
David Blaikie99dab3b2013-09-04 22:03:57 +00002040 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Adrian Prantl73409ce2013-03-11 18:33:46 +00002041 void* TyPtr = Ty.getAsOpaquePtr();
2042
2043 // And update the type cache.
2044 TypeCache[TyPtr] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002045
Guy Benyei11169dd2012-12-18 14:30:41 +00002046 return Res;
2047}
2048
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002049/// Currently the checksum of an interface includes the number of
2050/// ivars and property accessors.
Eric Christopher1ecc5632013-06-07 22:54:39 +00002051unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl817bbb32013-06-07 01:10:48 +00002052 // The assumption is that the number of ivars can only increase
2053 // monotonically, so it is safe to just use their current number as
2054 // a checksum.
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002055 unsigned Sum = 0;
2056 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
2057 Ivar != 0; Ivar = Ivar->getNextIvar())
2058 ++Sum;
2059
2060 return Sum;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002061}
2062
2063ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2064 switch (Ty->getTypeClass()) {
2065 case Type::ObjCObjectPointer:
Eric Christopher0fdcb312013-05-16 00:52:20 +00002066 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
2067 ->getPointeeType());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002068 case Type::ObjCInterface:
2069 return cast<ObjCInterfaceType>(Ty)->getDecl();
2070 default:
2071 return 0;
2072 }
2073}
2074
Guy Benyei11169dd2012-12-18 14:30:41 +00002075/// CreateTypeNode - Create a new debug type node.
David Blaikie99dab3b2013-09-04 22:03:57 +00002076llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002077 // Handle qualifiers, which recursively handles what they refer to.
2078 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002079 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002080
2081 const char *Diag = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002082
Guy Benyei11169dd2012-12-18 14:30:41 +00002083 // Work out details of type.
2084 switch (Ty->getTypeClass()) {
2085#define TYPE(Class, Base)
2086#define ABSTRACT_TYPE(Class, Base)
2087#define NON_CANONICAL_TYPE(Class, Base)
2088#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2089#include "clang/AST/TypeNodes.def"
2090 llvm_unreachable("Dependent types cannot show up in debug information");
2091
2092 case Type::ExtVector:
2093 case Type::Vector:
2094 return CreateType(cast<VectorType>(Ty), Unit);
2095 case Type::ObjCObjectPointer:
2096 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2097 case Type::ObjCObject:
2098 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2099 case Type::ObjCInterface:
2100 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2101 case Type::Builtin:
2102 return CreateType(cast<BuiltinType>(Ty));
2103 case Type::Complex:
2104 return CreateType(cast<ComplexType>(Ty));
2105 case Type::Pointer:
2106 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002107 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002108 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002109 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002110 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002111 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002112 case Type::BlockPointer:
2113 return CreateType(cast<BlockPointerType>(Ty), Unit);
2114 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002115 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002116 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002117 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002118 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002119 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002120 case Type::FunctionProto:
2121 case Type::FunctionNoProto:
2122 return CreateType(cast<FunctionType>(Ty), Unit);
2123 case Type::ConstantArray:
2124 case Type::VariableArray:
2125 case Type::IncompleteArray:
2126 return CreateType(cast<ArrayType>(Ty), Unit);
2127
2128 case Type::LValueReference:
2129 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2130 case Type::RValueReference:
2131 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2132
2133 case Type::MemberPointer:
2134 return CreateType(cast<MemberPointerType>(Ty), Unit);
2135
2136 case Type::Atomic:
2137 return CreateType(cast<AtomicType>(Ty), Unit);
2138
Guy Benyei11169dd2012-12-18 14:30:41 +00002139 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002140 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2141
2142 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002143 case Type::Elaborated:
2144 case Type::Paren:
2145 case Type::SubstTemplateTypeParm:
2146 case Type::TypeOfExpr:
2147 case Type::TypeOf:
2148 case Type::Decltype:
2149 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002150 case Type::PackExpansion:
Guy Benyei11169dd2012-12-18 14:30:41 +00002151 llvm_unreachable("type should have been unwrapped!");
David Blaikie22c460a02013-05-24 21:24:35 +00002152 case Type::Auto:
2153 Diag = "auto";
2154 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002155 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002156
Guy Benyei11169dd2012-12-18 14:30:41 +00002157 assert(Diag && "Fall through without a diagnostic?");
2158 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2159 "debug information for %0 is not yet supported");
2160 CGM.getDiags().Report(DiagID)
2161 << Diag;
2162 return llvm::DIType();
2163}
2164
2165/// getOrCreateLimitedType - Get the type from the cache or create a new
2166/// limited type if necessary.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002167llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002168 llvm::DIFile Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002169 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002170
David Blaikie8d5e1282013-08-20 21:03:29 +00002171 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002172
2173 // We may have cached a forward decl when we could have created
2174 // a non-forward decl. Go ahead and create a non-forward decl
2175 // now.
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002176 if (T && !T.isForwardDecl()) return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002177
2178 // Otherwise create the type.
David Blaikie8d5e1282013-08-20 21:03:29 +00002179 llvm::DICompositeType Res = CreateLimitedType(Ty);
2180
2181 // Propagate members from the declaration to the definition
2182 // CreateType(const RecordType*) will overwrite this with the members in the
2183 // correct order if the full type is needed.
2184 Res.setTypeArray(T.getTypeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002185
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002186 if (T && T.isForwardDecl())
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002187 ReplaceMap.push_back(
2188 std::make_pair(QTy.getAsOpaquePtr(), static_cast<llvm::Value *>(T)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002189
2190 // And update the type cache.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002191 TypeCache[QTy.getAsOpaquePtr()] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002192 return Res;
2193}
2194
2195// TODO: Currently used for context chains when limiting debug info.
David Blaikie8d5e1282013-08-20 21:03:29 +00002196llvm::DICompositeType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002197 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002198
Guy Benyei11169dd2012-12-18 14:30:41 +00002199 // Get overall information about the record type for the debug info.
2200 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2201 unsigned Line = getLineNumber(RD->getLocation());
2202 StringRef RDName = getClassName(RD);
2203
Eric Christopher07429ff2013-10-15 21:22:34 +00002204 llvm::DIDescriptor RDContext =
2205 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002206
David Blaikied2785892013-08-18 17:36:19 +00002207 // If we ended up creating the type during the context chain construction,
2208 // just return that.
David Blaikie8d5e1282013-08-20 21:03:29 +00002209 llvm::DICompositeType T(getTypeOrNull(CGM.getContext().getRecordType(RD)));
2210 if (T && (!T.isForwardDecl() || !RD->getDefinition()))
David Blaikied2785892013-08-18 17:36:19 +00002211 return T;
2212
Adrian Prantl381e7552014-02-04 21:29:50 +00002213 // If this is just a forward or incomplete declaration, construct an
2214 // appropriately marked node and just return it.
2215 const RecordDecl *D = RD->getDefinition();
2216 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002217 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002218
2219 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2220 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
David Blaikie49ae6a72013-03-26 23:47:35 +00002221 llvm::DICompositeType RealDecl;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002222
Manman Rene0064d82013-08-29 23:19:58 +00002223 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2224
Guy Benyei11169dd2012-12-18 14:30:41 +00002225 if (RD->isUnion())
2226 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Manman Rene0064d82013-08-29 23:19:58 +00002227 Size, Align, 0, llvm::DIArray(), 0,
2228 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002229 else if (RD->isClass()) {
2230 // FIXME: This could be a struct type giving a default visibility different
2231 // than C++ class type, but needs llvm metadata changes first.
2232 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002233 Size, Align, 0, 0, llvm::DIType(),
2234 llvm::DIArray(), llvm::DIType(),
Manman Rene0064d82013-08-29 23:19:58 +00002235 llvm::DIArray(), FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002236 } else
2237 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopher0fdcb312013-05-16 00:52:20 +00002238 Size, Align, 0, llvm::DIType(),
David Blaikieba477362013-11-18 23:38:26 +00002239 llvm::DIArray(), 0, llvm::DIType(),
2240 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002241
2242 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie49ae6a72013-03-26 23:47:35 +00002243 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002244
David Blaikieadfbf992013-08-18 16:55:33 +00002245 if (const ClassTemplateSpecializationDecl *TSpecial =
2246 dyn_cast<ClassTemplateSpecializationDecl>(RD))
2247 RealDecl.setTypeArray(llvm::DIArray(),
2248 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002249 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002250}
2251
David Blaikieadfbf992013-08-18 16:55:33 +00002252void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2253 llvm::DICompositeType RealDecl) {
2254 // A class's primary base or the class itself contains the vtable.
2255 llvm::DICompositeType ContainingType;
2256 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2257 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002258 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002259 while (1) {
2260 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2261 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2262 if (PBT && !BRL.isPrimaryBaseVirtual())
2263 PBase = PBT;
2264 else
2265 break;
2266 }
2267 ContainingType = llvm::DICompositeType(
2268 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2269 getOrCreateFile(RD->getLocation())));
2270 } else if (RD->isDynamicClass())
2271 ContainingType = RealDecl;
2272
2273 RealDecl.setContainingType(ContainingType);
2274}
2275
Guy Benyei11169dd2012-12-18 14:30:41 +00002276/// CreateMemberType - Create new member and increase Offset by FType's size.
2277llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2278 StringRef Name,
2279 uint64_t *Offset) {
2280 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2281 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2282 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2283 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2284 FieldSize, FieldAlign,
2285 *Offset, 0, FieldTy);
2286 *Offset += FieldSize;
2287 return Ty;
2288}
2289
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002290llvm::DIScope CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002291 // We only need a declaration (not a definition) of the type - so use whatever
2292 // we would otherwise do to get a type for a pointee. (forward declarations in
2293 // limited debug info, full definitions (if the type definition is available)
2294 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002295 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2296 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002297 getOrCreateFile(TD->getLocation()));
David Blaikiebd483762013-05-20 04:58:53 +00002298 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2299 // This doesn't handle providing declarations (for functions or variables) for
2300 // entities without definitions in this TU, nor when the definition proceeds
2301 // the call to this function.
2302 // FIXME: This should be split out into more specific maps with support for
2303 // emitting forward declarations and merging definitions with declarations,
2304 // the same way as we do for types.
2305 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2306 DeclCache.find(D->getCanonicalDecl());
2307 if (I == DeclCache.end())
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002308 return llvm::DIScope();
David Blaikiebd483762013-05-20 04:58:53 +00002309 llvm::Value *V = I->second;
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002310 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikiebd483762013-05-20 04:58:53 +00002311}
2312
Guy Benyei11169dd2012-12-18 14:30:41 +00002313/// getFunctionDeclaration - Return debug info descriptor to describe method
2314/// declaration for the given method definition.
2315llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002316 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2317 return llvm::DISubprogram();
2318
Guy Benyei11169dd2012-12-18 14:30:41 +00002319 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2320 if (!FD) return llvm::DISubprogram();
2321
2322 // Setup context.
David Blaikiefd07c602013-08-09 17:20:05 +00002323 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002324
2325 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2326 MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002327 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002328 if (const CXXMethodDecl *MD =
2329 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikiefd07c602013-08-09 17:20:05 +00002330 llvm::DICompositeType T(S);
Eric Christopherf86c4052013-08-28 23:12:10 +00002331 llvm::DISubprogram SP =
2332 CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
David Blaikiefd07c602013-08-09 17:20:05 +00002333 return SP;
2334 }
2335 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002336 if (MI != SPCache.end()) {
2337 llvm::Value *V = MI->second;
2338 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002339 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002340 return SP;
2341 }
2342
Aaron Ballman86c93902014-03-06 23:45:36 +00002343 for (auto NextFD : FD->redecls()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002344 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2345 MI = SPCache.find(NextFD->getCanonicalDecl());
2346 if (MI != SPCache.end()) {
2347 llvm::Value *V = MI->second;
2348 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002349 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002350 return SP;
2351 }
2352 }
2353 return llvm::DISubprogram();
2354}
2355
2356// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2357// implicit parameter "this".
David Blaikie469f0792013-05-22 23:22:42 +00002358llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2359 QualType FnType,
2360 llvm::DIFile F) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002361 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2362 // Create fake but valid subroutine type. Otherwise
2363 // llvm::DISubprogram::Verify() would return false, and
2364 // subprogram DIE will miss DW_AT_decl_file and
2365 // DW_AT_decl_line fields.
2366 return DBuilder.createSubroutineType(F, DBuilder.getOrCreateArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002367
2368 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2369 return getOrCreateMethodType(Method, F);
2370 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2371 // Add "self" and "_cmd"
2372 SmallVector<llvm::Value *, 16> Elts;
2373
2374 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002375 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002376
2377 // Replace the instancetype keyword with the actual type.
2378 if (ResultTy == CGM.getContext().getObjCInstanceType())
2379 ResultTy = CGM.getContext().getPointerType(
2380 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2381
Adrian Prantl7bec9032013-05-10 21:08:31 +00002382 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002383 // "self" pointer is always first argument.
Adrian Prantlde17db32013-03-29 19:20:29 +00002384 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2385 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2386 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002387 // "_cmd" pointer is always second argument.
2388 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2389 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2390 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002391 for (const auto *PI : OMethod->params())
2392 Elts.push_back(getOrCreateType(PI->getType(), F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002393
2394 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2395 return DBuilder.createSubroutineType(F, EltTypeArray);
2396 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002397
Adrian Prantl800faef2014-02-25 23:42:18 +00002398 // Handle variadic function types; they need an additional
2399 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002400 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2401 if (FD->isVariadic()) {
2402 SmallVector<llvm::Value *, 16> EltTys;
2403 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2404 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2405 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2406 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2407 EltTys.push_back(DBuilder.createUnspecifiedParameter());
2408 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
2409 return DBuilder.createSubroutineType(F, EltTypeArray);
2410 }
2411
David Blaikie469f0792013-05-22 23:22:42 +00002412 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002413}
2414
2415/// EmitFunctionStart - Constructs the debug code for entering a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00002416void CGDebugInfo::EmitFunctionStart(GlobalDecl GD,
2417 SourceLocation Loc,
2418 SourceLocation ScopeLoc,
2419 QualType FnType,
Guy Benyei11169dd2012-12-18 14:30:41 +00002420 llvm::Function *Fn,
2421 CGBuilderTy &Builder) {
2422
2423 StringRef Name;
2424 StringRef LinkageName;
2425
2426 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2427
2428 const Decl *D = GD.getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00002429 bool HasDecl = (D != 0);
Eric Christopher885c41b2014-04-01 22:25:28 +00002430
Guy Benyei11169dd2012-12-18 14:30:41 +00002431 unsigned Flags = 0;
2432 llvm::DIFile Unit = getOrCreateFile(Loc);
2433 llvm::DIDescriptor FDContext(Unit);
2434 llvm::DIArray TParamsArray;
2435 if (!HasDecl) {
2436 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002437 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002438 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2439 // If there is a DISubprogram for this function available then use it.
2440 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2441 FI = SPCache.find(FD->getCanonicalDecl());
2442 if (FI != SPCache.end()) {
2443 llvm::Value *V = FI->second;
2444 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2445 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2446 llvm::MDNode *SPN = SP;
2447 LexicalBlockStack.push_back(SPN);
2448 RegionMap[D] = llvm::WeakVH(SP);
2449 return;
2450 }
2451 }
2452 Name = getFunctionName(FD);
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002453 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00002454 if (FD->hasPrototype()) {
2455 LinkageName = CGM.getMangledName(GD);
2456 Flags |= llvm::DIDescriptor::FlagPrototyped;
2457 }
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002458 // No need to replicate the linkage name if it isn't different from the
2459 // subprogram name, no need to have it at all unless coverage is enabled or
2460 // debug is set to more than just line tables.
Guy Benyei11169dd2012-12-18 14:30:41 +00002461 if (LinkageName == Name ||
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002462 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2463 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher75e17682013-05-16 00:45:23 +00002464 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei11169dd2012-12-18 14:30:41 +00002465 LinkageName = StringRef();
2466
Eric Christopher75e17682013-05-16 00:45:23 +00002467 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Eric Christopher4cbd0d9d2014-03-27 05:29:34 +00002468 if (const NamespaceDecl *NSDecl =
2469 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2470 FDContext = getOrCreateNameSpace(NSDecl);
2471 else if (const RecordDecl *RDecl =
2472 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2473 FDContext = getContextDescriptor(cast<Decl>(RDecl));
2474
2475 // Collect template parameters.
Guy Benyei11169dd2012-12-18 14:30:41 +00002476 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2477 }
2478 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2479 Name = getObjCMethodName(OMD);
2480 Flags |= llvm::DIDescriptor::FlagPrototyped;
2481 } else {
2482 // Use llvm function name.
2483 Name = Fn->getName();
2484 Flags |= llvm::DIDescriptor::FlagPrototyped;
2485 }
2486 if (!Name.empty() && Name[0] == '\01')
2487 Name = Name.substr(1);
2488
Adrian Prantl42d71b92014-04-10 23:21:53 +00002489 if (!HasDecl || D->isImplicit()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002490 Flags |= llvm::DIDescriptor::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002491 // Artificial functions without a location should not silently reuse CurLoc.
2492 if (Loc.isInvalid())
2493 CurLoc = SourceLocation();
2494 }
2495 unsigned LineNo = getLineNumber(Loc);
2496 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002497
Eric Christopher8018e412014-03-27 18:50:35 +00002498 // FIXME: The function declaration we're constructing here is mostly reusing
2499 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2500 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2501 // all subprograms instead of the actual context since subprogram definitions
2502 // are emitted as CU level entities by the backend.
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002503 llvm::DISubprogram SP =
2504 DBuilder.createFunction(FDContext, Name, LinkageName, Unit, LineNo,
2505 getOrCreateFunctionType(D, FnType, Unit),
2506 Fn->hasInternalLinkage(), true /*definition*/,
Adrian Prantl42d71b92014-04-10 23:21:53 +00002507 ScopeLine, Flags,
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002508 CGM.getLangOpts().Optimize, Fn, TParamsArray,
2509 getFunctionDeclaration(D));
David Blaikiebd483762013-05-20 04:58:53 +00002510 if (HasDecl)
2511 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002512
Adrian Prantlbebb8932014-03-21 21:01:58 +00002513 // Push the function onto the lexical block stack.
Guy Benyei11169dd2012-12-18 14:30:41 +00002514 llvm::MDNode *SPN = SP;
2515 LexicalBlockStack.push_back(SPN);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002516
Guy Benyei11169dd2012-12-18 14:30:41 +00002517 if (HasDecl)
2518 RegionMap[D] = llvm::WeakVH(SP);
2519}
2520
2521/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl02c0caa2013-07-18 00:27:59 +00002522/// information in the source file. If the location is invalid, the
2523/// previous location will be reused.
Adrian Prantlc7822422013-03-12 20:43:25 +00002524void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
Adrian Prantle83b1302014-01-07 22:05:52 +00002525 bool ForceColumnInfo) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002526 // Update our current location
2527 setLocation(Loc);
2528
2529 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2530
2531 // Don't bother if things are the same as last time.
2532 SourceManager &SM = CGM.getContext().getSourceManager();
2533 if (CurLoc == PrevLoc ||
2534 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2535 // New Builder may not be in sync with CGDebugInfo.
David Blaikie357aafb2013-02-01 19:09:49 +00002536 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2537 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2538 LexicalBlockStack.back())
Guy Benyei11169dd2012-12-18 14:30:41 +00002539 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002540
Guy Benyei11169dd2012-12-18 14:30:41 +00002541 // Update last state.
2542 PrevLoc = CurLoc;
2543
Adrian Prantle83b1302014-01-07 22:05:52 +00002544 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantlc7822422013-03-12 20:43:25 +00002545 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2546 (getLineNumber(CurLoc),
2547 getColumnNumber(CurLoc, ForceColumnInfo),
2548 Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002549}
2550
2551/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2552/// the stack.
2553void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2554 llvm::DIDescriptor D =
2555 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2556 llvm::DIDescriptor() :
2557 llvm::DIDescriptor(LexicalBlockStack.back()),
2558 getOrCreateFile(CurLoc),
2559 getLineNumber(CurLoc),
Diego Novilloe6d398182014-03-03 18:53:32 +00002560 getColumnNumber(CurLoc),
2561 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002562 llvm::MDNode *DN = D;
2563 LexicalBlockStack.push_back(DN);
2564}
2565
2566/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2567/// region - beginning of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002568void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2569 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002570 // Set our current location.
2571 setLocation(Loc);
2572
2573 // Create a new lexical block and push it on the stack.
2574 CreateLexicalBlock(Loc);
2575
2576 // Emit a line table change for the current location inside the new scope.
2577 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2578 getColumnNumber(Loc),
2579 LexicalBlockStack.back()));
2580}
2581
2582/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2583/// region - end of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002584void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2585 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002586 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2587
2588 // Provide an entry in the line table for the end of the block.
2589 EmitLocation(Builder, Loc);
2590
2591 LexicalBlockStack.pop_back();
2592}
2593
2594/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2595void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2596 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2597 unsigned RCount = FnBeginRegionCount.back();
2598 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2599
2600 // Pop all regions for this function.
2601 while (LexicalBlockStack.size() != RCount)
2602 EmitLexicalBlockEnd(Builder, CurLoc);
2603 FnBeginRegionCount.pop_back();
2604}
2605
Eric Christopherb2a008c2013-05-16 00:45:12 +00002606// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei11169dd2012-12-18 14:30:41 +00002607// See BuildByRefType.
2608llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2609 uint64_t *XOffset) {
2610
2611 SmallVector<llvm::Value *, 5> EltTys;
2612 QualType FType;
2613 uint64_t FieldSize, FieldOffset;
2614 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002615
Guy Benyei11169dd2012-12-18 14:30:41 +00002616 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002617 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002618
2619 FieldOffset = 0;
2620 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2621 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2622 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2623 FType = CGM.getContext().IntTy;
2624 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2625 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2626
2627 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2628 if (HasCopyAndDispose) {
2629 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2630 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2631 &FieldOffset));
2632 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2633 &FieldOffset));
2634 }
2635 bool HasByrefExtendedLayout;
2636 Qualifiers::ObjCLifetime Lifetime;
2637 if (CGM.getContext().getByrefLifetime(Type,
2638 Lifetime, HasByrefExtendedLayout)
Adrian Prantlead2ba42013-07-23 00:12:14 +00002639 && HasByrefExtendedLayout) {
2640 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002641 EltTys.push_back(CreateMemberType(Unit, FType,
2642 "__byref_variable_layout",
2643 &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002644 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002645
Guy Benyei11169dd2012-12-18 14:30:41 +00002646 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2647 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002648 CGM.getTarget().getPointerAlign(0))) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002649 CharUnits FieldOffsetInBytes
Guy Benyei11169dd2012-12-18 14:30:41 +00002650 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2651 CharUnits AlignedOffsetInBytes
2652 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2653 CharUnits NumPaddingBytes
2654 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002655
Guy Benyei11169dd2012-12-18 14:30:41 +00002656 if (NumPaddingBytes.isPositive()) {
2657 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2658 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2659 pad, ArrayType::Normal, 0);
2660 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2661 }
2662 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002663
Guy Benyei11169dd2012-12-18 14:30:41 +00002664 FType = Type;
2665 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2666 FieldSize = CGM.getContext().getTypeSize(FType);
2667 FieldAlign = CGM.getContext().toBits(Align);
2668
Eric Christopherb2a008c2013-05-16 00:45:12 +00002669 *XOffset = FieldOffset;
Guy Benyei11169dd2012-12-18 14:30:41 +00002670 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2671 0, FieldSize, FieldAlign,
2672 FieldOffset, 0, FieldTy);
2673 EltTys.push_back(FieldTy);
2674 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002675
Guy Benyei11169dd2012-12-18 14:30:41 +00002676 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002677
Guy Benyei11169dd2012-12-18 14:30:41 +00002678 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002679
Guy Benyei11169dd2012-12-18 14:30:41 +00002680 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00002681 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002682}
2683
2684/// EmitDeclare - Emit local variable declaration debug info.
2685void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +00002686 llvm::Value *Storage,
Guy Benyei11169dd2012-12-18 14:30:41 +00002687 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002688 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002689 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2690
David Blaikie7fceebf2013-08-19 03:37:48 +00002691 bool Unwritten =
2692 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2693 cast<Decl>(VD->getDeclContext())->isImplicit());
2694 llvm::DIFile Unit;
2695 if (!Unwritten)
2696 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002697 llvm::DIType Ty;
2698 uint64_t XOffset = 0;
2699 if (VD->hasAttr<BlocksAttr>())
2700 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002701 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002702 Ty = getOrCreateType(VD->getType(), Unit);
2703
2704 // If there is no debug info for this type then do not emit debug info
2705 // for this variable.
2706 if (!Ty)
2707 return;
2708
Guy Benyei11169dd2012-12-18 14:30:41 +00002709 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002710 unsigned Line = 0;
2711 unsigned Column = 0;
2712 if (!Unwritten) {
2713 Line = getLineNumber(VD->getLocation());
2714 Column = getColumnNumber(VD->getLocation());
2715 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002716 unsigned Flags = 0;
2717 if (VD->isImplicit())
2718 Flags |= llvm::DIDescriptor::FlagArtificial;
2719 // If this is the first argument and it is implicit then
2720 // give it an object pointer flag.
2721 // FIXME: There has to be a better way to do this, but for static
2722 // functions there won't be an implicit param at arg1 and
2723 // otherwise it is 'self' or 'this'.
2724 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2725 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002726 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002727 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2728 !VD->getType()->isPointerType())
David Blaikieb9c667d2013-06-19 21:53:53 +00002729 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
Guy Benyei11169dd2012-12-18 14:30:41 +00002730
2731 llvm::MDNode *Scope = LexicalBlockStack.back();
2732
2733 StringRef Name = VD->getName();
2734 if (!Name.empty()) {
2735 if (VD->hasAttr<BlocksAttr>()) {
2736 CharUnits offset = CharUnits::fromQuantity(32);
2737 SmallVector<llvm::Value *, 9> addr;
2738 llvm::Type *Int64Ty = CGM.Int64Ty;
2739 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2740 // offset of __forwarding field
2741 offset = CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002742 CGM.getTarget().getPointerWidth(0));
Guy Benyei11169dd2012-12-18 14:30:41 +00002743 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2744 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2745 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2746 // offset of x field
2747 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2748 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2749
2750 // Create the descriptor for the variable.
2751 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002752 DBuilder.createComplexVariable(Tag,
Guy Benyei11169dd2012-12-18 14:30:41 +00002753 llvm::DIDescriptor(Scope),
2754 VD->getName(), Unit, Line, Ty,
2755 addr, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002756
Guy Benyei11169dd2012-12-18 14:30:41 +00002757 // Insert an llvm.dbg.declare into the current block.
2758 llvm::Instruction *Call =
2759 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2760 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2761 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00002762 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl0315f382013-09-18 22:08:57 +00002763 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
David Blaikiea76a7c92013-01-05 05:58:35 +00002764 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2765 // If VD is an anonymous union then Storage represents value for
2766 // all union fields.
Guy Benyei11169dd2012-12-18 14:30:41 +00002767 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikie219c7d92013-01-05 20:03:07 +00002768 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002769 for (const auto *Field : RD->fields()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002770 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2771 StringRef FieldName = Field->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002772
Guy Benyei11169dd2012-12-18 14:30:41 +00002773 // Ignore unnamed fields. Do not ignore unnamed records.
2774 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2775 continue;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002776
Guy Benyei11169dd2012-12-18 14:30:41 +00002777 // Use VarDecl's Tag, Scope and Line number.
2778 llvm::DIVariable D =
2779 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopherb2a008c2013-05-16 00:45:12 +00002780 FieldName, Unit, Line, FieldTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00002781 CGM.getLangOpts().Optimize, Flags,
2782 ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002783
Guy Benyei11169dd2012-12-18 14:30:41 +00002784 // Insert an llvm.dbg.declare into the current block.
2785 llvm::Instruction *Call =
2786 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2787 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2788 }
David Blaikie219c7d92013-01-05 20:03:07 +00002789 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002790 }
2791 }
David Blaikiea76a7c92013-01-05 05:58:35 +00002792
2793 // Create the descriptor for the variable.
2794 llvm::DIVariable D =
2795 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2796 Name, Unit, Line, Ty,
2797 CGM.getLangOpts().Optimize, Flags, ArgNo);
2798
2799 // Insert an llvm.dbg.declare into the current block.
2800 llvm::Instruction *Call =
2801 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2802 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002803}
2804
2805void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2806 llvm::Value *Storage,
2807 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002808 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002809 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2810}
2811
Adrian Prantlde17db32013-03-29 19:20:29 +00002812/// Look up the completed type for a self pointer in the TypeCache and
2813/// create a copy of it with the ObjectPointer and Artificial flags
2814/// set. If the type is not cached, a new one is created. This should
2815/// never happen though, since creating a type for the implicit self
2816/// argument implies that we already parsed the interface definition
2817/// and the ivar declarations in the implementation.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002818llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2819 llvm::DIType Ty) {
Adrian Prantlde17db32013-03-29 19:20:29 +00002820 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002821 if (CachedTy) Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00002822 return DBuilder.createObjectPointerType(Ty);
2823}
2824
Guy Benyei11169dd2012-12-18 14:30:41 +00002825void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2826 llvm::Value *Storage,
2827 CGBuilderTy &Builder,
2828 const CGBlockInfo &blockInfo) {
Eric Christopher75e17682013-05-16 00:45:23 +00002829 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002830 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00002831
Guy Benyei11169dd2012-12-18 14:30:41 +00002832 if (Builder.GetInsertBlock() == 0)
2833 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002834
Guy Benyei11169dd2012-12-18 14:30:41 +00002835 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002836
Guy Benyei11169dd2012-12-18 14:30:41 +00002837 uint64_t XOffset = 0;
2838 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2839 llvm::DIType Ty;
2840 if (isByRef)
2841 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002842 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002843 Ty = getOrCreateType(VD->getType(), Unit);
2844
2845 // Self is passed along as an implicit non-arg variable in a
2846 // block. Mark it as the object pointer.
2847 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00002848 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002849
2850 // Get location information.
2851 unsigned Line = getLineNumber(VD->getLocation());
2852 unsigned Column = getColumnNumber(VD->getLocation());
2853
2854 const llvm::DataLayout &target = CGM.getDataLayout();
2855
2856 CharUnits offset = CharUnits::fromQuantity(
2857 target.getStructLayout(blockInfo.StructureType)
2858 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2859
2860 SmallVector<llvm::Value *, 9> addr;
2861 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl0f6df002013-03-29 19:20:35 +00002862 if (isa<llvm::AllocaInst>(Storage))
2863 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei11169dd2012-12-18 14:30:41 +00002864 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2865 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2866 if (isByRef) {
2867 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2868 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2869 // offset of __forwarding field
2870 offset = CGM.getContext()
2871 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2872 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2873 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2874 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2875 // offset of x field
2876 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2877 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2878 }
2879
2880 // Create the descriptor for the variable.
2881 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002882 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei11169dd2012-12-18 14:30:41 +00002883 llvm::DIDescriptor(LexicalBlockStack.back()),
2884 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl0f6df002013-03-29 19:20:35 +00002885
Guy Benyei11169dd2012-12-18 14:30:41 +00002886 // Insert an llvm.dbg.declare into the current block.
2887 llvm::Instruction *Call =
2888 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2889 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2890 LexicalBlockStack.back()));
2891}
2892
2893/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2894/// variable declaration.
2895void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2896 unsigned ArgNo,
2897 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002898 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002899 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2900}
2901
2902namespace {
2903 struct BlockLayoutChunk {
2904 uint64_t OffsetInBits;
2905 const BlockDecl::Capture *Capture;
2906 };
2907 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2908 return l.OffsetInBits < r.OffsetInBits;
2909 }
2910}
2911
2912void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00002913 llvm::Value *Arg,
2914 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00002915 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002916 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002917 ASTContext &C = CGM.getContext();
2918 const BlockDecl *blockDecl = block.getBlockDecl();
2919
2920 // Collect some general information about the block's location.
2921 SourceLocation loc = blockDecl->getCaretLocation();
2922 llvm::DIFile tunit = getOrCreateFile(loc);
2923 unsigned line = getLineNumber(loc);
2924 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002925
Guy Benyei11169dd2012-12-18 14:30:41 +00002926 // Build the debug-info type for the block literal.
2927 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2928
2929 const llvm::StructLayout *blockLayout =
2930 CGM.getDataLayout().getStructLayout(block.StructureType);
2931
2932 SmallVector<llvm::Value*, 16> fields;
2933 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2934 blockLayout->getElementOffsetInBits(0),
2935 tunit, tunit));
2936 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2937 blockLayout->getElementOffsetInBits(1),
2938 tunit, tunit));
2939 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2940 blockLayout->getElementOffsetInBits(2),
2941 tunit, tunit));
2942 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2943 blockLayout->getElementOffsetInBits(3),
2944 tunit, tunit));
2945 fields.push_back(createFieldType("__descriptor",
2946 C.getPointerType(block.NeedsCopyDispose ?
2947 C.getBlockDescriptorExtendedType() :
2948 C.getBlockDescriptorType()),
2949 0, loc, AS_public,
2950 blockLayout->getElementOffsetInBits(4),
2951 tunit, tunit));
2952
2953 // We want to sort the captures by offset, not because DWARF
2954 // requires this, but because we're paranoid about debuggers.
2955 SmallVector<BlockLayoutChunk, 8> chunks;
2956
2957 // 'this' capture.
2958 if (blockDecl->capturesCXXThis()) {
2959 BlockLayoutChunk chunk;
2960 chunk.OffsetInBits =
2961 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2962 chunk.Capture = 0;
2963 chunks.push_back(chunk);
2964 }
2965
2966 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002967 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002968 const VarDecl *variable = capture.getVariable();
2969 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2970
2971 // Ignore constant captures.
2972 if (captureInfo.isConstant())
2973 continue;
2974
2975 BlockLayoutChunk chunk;
2976 chunk.OffsetInBits =
2977 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2978 chunk.Capture = &capture;
2979 chunks.push_back(chunk);
2980 }
2981
2982 // Sort by offset.
2983 llvm::array_pod_sort(chunks.begin(), chunks.end());
2984
2985 for (SmallVectorImpl<BlockLayoutChunk>::iterator
2986 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2987 uint64_t offsetInBits = i->OffsetInBits;
2988 const BlockDecl::Capture *capture = i->Capture;
2989
2990 // If we have a null capture, this must be the C++ 'this' capture.
2991 if (!capture) {
2992 const CXXMethodDecl *method =
2993 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2994 QualType type = method->getThisType(C);
2995
2996 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
2997 offsetInBits, tunit, tunit));
2998 continue;
2999 }
3000
3001 const VarDecl *variable = capture->getVariable();
3002 StringRef name = variable->getName();
3003
3004 llvm::DIType fieldType;
3005 if (capture->isByRef()) {
3006 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
3007
3008 // FIXME: this creates a second copy of this type!
3009 uint64_t xoffset;
3010 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
3011 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
3012 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3013 ptrInfo.first, ptrInfo.second,
3014 offsetInBits, 0, fieldType);
3015 } else {
3016 fieldType = createFieldType(name, variable->getType(), 0,
3017 loc, AS_public, offsetInBits, tunit, tunit);
3018 }
3019 fields.push_back(fieldType);
3020 }
3021
3022 SmallString<36> typeName;
3023 llvm::raw_svector_ostream(typeName)
3024 << "__block_literal_" << CGM.getUniqueBlockCount();
3025
3026 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3027
3028 llvm::DIType type =
3029 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3030 CGM.getContext().toBits(block.BlockSize),
3031 CGM.getContext().toBits(block.BlockAlign),
David Blaikie6d4fe152013-02-25 01:07:08 +00003032 0, llvm::DIType(), fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003033 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3034
3035 // Get overall information about the block.
3036 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3037 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei11169dd2012-12-18 14:30:41 +00003038
3039 // Create the descriptor for the parameter.
3040 llvm::DIVariable debugVar =
3041 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopherb2a008c2013-05-16 00:45:12 +00003042 llvm::DIDescriptor(scope),
Adrian Prantl51936dd2013-03-14 17:53:33 +00003043 Arg->getName(), tunit, line, type,
Guy Benyei11169dd2012-12-18 14:30:41 +00003044 CGM.getLangOpts().Optimize, flags,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003045 cast<llvm::Argument>(Arg)->getArgNo() + 1);
3046
Adrian Prantl616bef42013-03-14 21:52:59 +00003047 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003048 // Insert an llvm.dbg.value into the current block.
Adrian Prantl616bef42013-03-14 21:52:59 +00003049 llvm::Instruction *DbgVal =
3050 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00003051 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003052 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3053 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003054
Adrian Prantl616bef42013-03-14 21:52:59 +00003055 // Insert an llvm.dbg.declare into the current block.
3056 llvm::Instruction *DbgDecl =
3057 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
3058 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003059}
3060
David Blaikie6943dea2013-08-20 01:28:15 +00003061/// If D is an out-of-class definition of a static data member of a class, find
3062/// its corresponding in-class declaration.
3063llvm::DIDerivedType
3064CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3065 if (!D->isStaticDataMember())
3066 return llvm::DIDerivedType();
3067 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
3068 StaticDataMemberCache.find(D->getCanonicalDecl());
3069 if (MI != StaticDataMemberCache.end()) {
3070 assert(MI->second && "Static data member declaration should still exist");
3071 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003072 }
David Blaikiece763042013-08-20 21:49:21 +00003073
3074 // If the member wasn't found in the cache, lazily construct and add it to the
3075 // type (used when a limited form of the type is emitted).
David Blaikie6943dea2013-08-20 01:28:15 +00003076 llvm::DICompositeType Ctxt(
3077 getContextDescriptor(cast<Decl>(D->getDeclContext())));
3078 llvm::DIDerivedType T = CreateRecordStaticField(D, Ctxt);
David Blaikie6943dea2013-08-20 01:28:15 +00003079 return T;
3080}
3081
Eric Christophercab9fae2014-04-10 05:20:00 +00003082/// Recursively collect all of the member fields of a global anonymous decl and
3083/// create static variables for them. The first time this is called it needs
3084/// to be on a union and then from there we can have additional unnamed fields.
3085llvm::DIGlobalVariable
3086CGDebugInfo::CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile Unit,
3087 unsigned LineNo, StringRef LinkageName,
3088 llvm::GlobalVariable *Var,
3089 llvm::DIDescriptor DContext) {
3090 llvm::DIGlobalVariable GV;
3091
3092 for (const auto *Field : RD->fields()) {
3093 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
3094 StringRef FieldName = Field->getName();
3095
3096 // Ignore unnamed fields, but recurse into anonymous records.
3097 if (FieldName.empty()) {
3098 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3099 if (RT)
3100 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3101 Var, DContext);
3102 continue;
3103 }
3104 // Use VarDecl's Tag, Scope and Line number.
3105 GV = DBuilder.createStaticVariable(DContext, FieldName, LinkageName, Unit,
3106 LineNo, FieldTy,
3107 Var->hasInternalLinkage(), Var,
3108 llvm::DIDerivedType());
3109 }
3110 return GV;
3111}
3112
Guy Benyei11169dd2012-12-18 14:30:41 +00003113/// EmitGlobalVariable - Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003114void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003115 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003116 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003117 // Create global variable debug descriptor.
3118 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
3119 unsigned LineNo = getLineNumber(D->getLocation());
3120
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003121 setLocation(D->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00003122
3123 QualType T = D->getType();
3124 if (T->isIncompleteArrayType()) {
3125
3126 // CodeGen turns int[] into int[1] so we'll do the same here.
3127 llvm::APInt ConstVal(32, 1);
3128 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3129
3130 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3131 ArrayType::Normal, 0);
3132 }
Eric Christophercab9fae2014-04-10 05:20:00 +00003133
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003134 StringRef DeclName = D->getName();
3135 StringRef LinkageName;
Eric Christophercab9fae2014-04-10 05:20:00 +00003136 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext()) &&
3137 !isa<ObjCMethodDecl>(D->getDeclContext()))
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003138 LinkageName = Var->getName();
3139 if (LinkageName == DeclName)
3140 LinkageName = StringRef();
Eric Christophercab9fae2014-04-10 05:20:00 +00003141
Eric Christopherb2a008c2013-05-16 00:45:12 +00003142 llvm::DIDescriptor DContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00003143 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
Eric Christophercab9fae2014-04-10 05:20:00 +00003144
3145 // Attempt to store one global variable for the declaration - even if we
3146 // emit a lot of fields.
3147 llvm::DIGlobalVariable GV;
3148
3149 // If this is an anonymous union then we'll want to emit a global
3150 // variable for each member of the anonymous union so that it's possible
3151 // to find the name of any field in the union.
3152 if (T->isUnionType() && DeclName.empty()) {
3153 const RecordDecl *RD = cast<RecordType>(T)->getDecl();
3154 assert(RD->isAnonymousStructOrUnion() && "unnamed non-anonymous struct or union?");
3155 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3156 } else {
3157 GV = DBuilder.createStaticVariable(
3158 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3159 Var->hasInternalLinkage(), Var,
3160 getOrCreateStaticDataMemberDeclarationOrNull(D));
3161 }
David Blaikiebd483762013-05-20 04:58:53 +00003162 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003163}
3164
3165/// EmitGlobalVariable - Emit information about an objective-c interface.
3166void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3167 ObjCInterfaceDecl *ID) {
Eric Christopher75e17682013-05-16 00:45:23 +00003168 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003169 // Create global variable debug descriptor.
3170 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
3171 unsigned LineNo = getLineNumber(ID->getLocation());
3172
3173 StringRef Name = ID->getName();
3174
3175 QualType T = CGM.getContext().getObjCInterfaceType(ID);
3176 if (T->isIncompleteArrayType()) {
3177
3178 // CodeGen turns int[] into int[1] so we'll do the same here.
3179 llvm::APInt ConstVal(32, 1);
3180 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3181
3182 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3183 ArrayType::Normal, 0);
3184 }
3185
3186 DBuilder.createGlobalVariable(Name, Unit, LineNo,
3187 getOrCreateType(T, Unit),
3188 Var->hasInternalLinkage(), Var);
3189}
3190
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003191/// EmitGlobalVariable - Emit global variable's debug info.
3192void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3193 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003194 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003195 // Create the descriptor for the variable.
3196 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3197 StringRef Name = VD->getName();
3198 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3199 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3200 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3201 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3202 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3203 }
3204 // Do not use DIGlobalVariable for enums.
3205 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3206 return;
David Blaikiea15565562014-04-04 20:56:17 +00003207 // Do not emit separate definitions for function local const/statics.
3208 if (isa<FunctionDecl>(VD->getDeclContext()))
3209 return;
David Blaikiebb113912014-04-05 07:23:17 +00003210 VD = cast<ValueDecl>(VD->getCanonicalDecl());
3211 auto pair = DeclCache.insert(std::make_pair(VD, llvm::WeakVH()));
3212 if (!pair.second)
3213 return;
David Blaikie506a7452014-04-05 07:46:57 +00003214 llvm::DIDescriptor DContext =
3215 getContextDescriptor(dyn_cast<Decl>(VD->getDeclContext()));
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003216 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003217 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
3218 true, Init,
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003219 getOrCreateStaticDataMemberDeclarationOrNull(cast<VarDecl>(VD)));
David Blaikiebb113912014-04-05 07:23:17 +00003220 pair.first->second = llvm::WeakVH(GV);
David Blaikiebd483762013-05-20 04:58:53 +00003221}
3222
3223llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3224 if (!LexicalBlockStack.empty())
3225 return llvm::DIScope(LexicalBlockStack.back());
3226 return getContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003227}
3228
David Blaikie9f88fe82013-04-22 06:13:21 +00003229void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003230 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3231 return;
David Blaikie9f88fe82013-04-22 06:13:21 +00003232 DBuilder.createImportedModule(
David Blaikiebd483762013-05-20 04:58:53 +00003233 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3234 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie9f88fe82013-04-22 06:13:21 +00003235 getLineNumber(UD.getLocation()));
3236}
3237
David Blaikiebd483762013-05-20 04:58:53 +00003238void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3239 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3240 return;
3241 assert(UD.shadow_size() &&
3242 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3243 // Emitting one decl is sufficient - debuggers can detect that this is an
3244 // overloaded name & provide lookup for all the overloads.
3245 const UsingShadowDecl &USD = **UD.shadow_begin();
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00003246 if (llvm::DIScope Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003247 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003248 DBuilder.createImportedDeclaration(
3249 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3250 getLineNumber(USD.getLocation()));
3251}
3252
David Blaikief121b932013-05-20 22:50:41 +00003253llvm::DIImportedEntity
3254CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3255 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3256 return llvm::DIImportedEntity(0);
3257 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3258 if (VH)
3259 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
3260 llvm::DIImportedEntity R(0);
3261 if (const NamespaceAliasDecl *Underlying =
3262 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3263 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003264 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003265 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3266 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3267 NA.getName());
3268 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003269 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003270 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3271 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3272 getLineNumber(NA.getLocation()), NA.getName());
3273 VH = R;
3274 return R;
3275}
3276
Guy Benyei11169dd2012-12-18 14:30:41 +00003277/// getOrCreateNamesSpace - Return namespace descriptor for the given
3278/// namespace decl.
Eric Christopherb2a008c2013-05-16 00:45:12 +00003279llvm::DINameSpace
Guy Benyei11169dd2012-12-18 14:30:41 +00003280CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003281 NSDecl = NSDecl->getCanonicalDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003282 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei11169dd2012-12-18 14:30:41 +00003283 NameSpaceCache.find(NSDecl);
3284 if (I != NameSpaceCache.end())
3285 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003286
Guy Benyei11169dd2012-12-18 14:30:41 +00003287 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3288 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003289 llvm::DIDescriptor Context =
Guy Benyei11169dd2012-12-18 14:30:41 +00003290 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3291 llvm::DINameSpace NS =
3292 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3293 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3294 return NS;
3295}
3296
3297void CGDebugInfo::finalize() {
3298 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
3299 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
David Blaikieb8149042014-05-05 21:21:39 +00003300 assert(VI->second);
3301 llvm::DIType Ty(cast<llvm::MDNode>(VI->second));
3302 assert(Ty.isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003303
Guy Benyei11169dd2012-12-18 14:30:41 +00003304 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
David Blaikieb8149042014-05-05 21:21:39 +00003305 TypeCache.find(VI->first);
3306 assert(it != TypeCache.end());
3307 assert(it->second);
3308 llvm::DIType RepTy(cast<llvm::MDNode>(it->second));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003309
David Blaikieb8149042014-05-05 21:21:39 +00003310 Ty.replaceAllUsesWith(RepTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003311 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003312
David Blaikieef8a9512014-05-05 23:23:53 +00003313 for (auto E : ObjCInterfaceCache)
3314 E.Decl.replaceAllUsesWith(E.Type->getDecl()->getDefinition()
3315 ? CreateTypeDefinition(E.Type, E.Unit)
3316 : E.Decl);
3317
Adrian Prantl73409ce2013-03-11 18:33:46 +00003318 // We keep our own list of retained types, because we need to look
3319 // up the final type in the type cache.
3320 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3321 RE = RetainedTypes.end(); RI != RE; ++RI)
David Blaikie0856f662014-03-04 22:01:08 +00003322 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003323
Guy Benyei11169dd2012-12-18 14:30:41 +00003324 DBuilder.finalize();
3325}