blob: 45c78064aac15dbd66c56cd44a40a838ad29ee9b [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);
725 assert(Src);
726
727 SmallString<128> NS;
728 llvm::raw_svector_ostream OS(NS);
729 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(), /*qualified*/ false);
730
731 TemplateSpecializationType::PrintTemplateArgumentList(
732 OS, Ty->getArgs(), Ty->getNumArgs(),
733 CGM.getContext().getPrintingPolicy());
734
735 TypeAliasDecl *AliasDecl =
736 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
737 ->getTemplatedDecl();
738
739 SourceLocation Loc = AliasDecl->getLocation();
740 llvm::DIFile File = getOrCreateFile(Loc);
741 unsigned Line = getLineNumber(Loc);
742
743 llvm::DIDescriptor Ctxt = getContextDescriptor(cast<Decl>(AliasDecl->getDeclContext()));
744
745 return DBuilder.createTypedef(Src, internString(OS.str()), File, Line, Ctxt);
746}
747
David Blaikie99dab3b2013-09-04 22:03:57 +0000748llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000749 // Typedefs are derived from some other type. If we have a typedef of a
750 // typedef, make sure to emit the whole chain.
David Blaikie99dab3b2013-09-04 22:03:57 +0000751 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000752 if (!Src)
Guy Benyei11169dd2012-12-18 14:30:41 +0000753 return llvm::DIType();
754 // We don't set size information, but do specify where the typedef was
755 // declared.
Adrian Prantl3eff2252014-01-21 18:42:27 +0000756 SourceLocation Loc = Ty->getDecl()->getLocation();
757 llvm::DIFile File = getOrCreateFile(Loc);
758 unsigned Line = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000759 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000760
Guy Benyei11169dd2012-12-18 14:30:41 +0000761 llvm::DIDescriptor TypedefContext =
762 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopherb2a008c2013-05-16 00:45:12 +0000763
Guy Benyei11169dd2012-12-18 14:30:41 +0000764 return
Adrian Prantl3eff2252014-01-21 18:42:27 +0000765 DBuilder.createTypedef(Src, TyDecl->getName(), File, Line, TypedefContext);
Guy Benyei11169dd2012-12-18 14:30:41 +0000766}
767
768llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
769 llvm::DIFile Unit) {
770 SmallVector<llvm::Value *, 16> EltTys;
771
772 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000773 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000774
775 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000776 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000777 if (isa<FunctionNoProtoType>(Ty))
778 EltTys.push_back(DBuilder.createUnspecifiedParameter());
779 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000780 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
781 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000782 if (FPT->isVariadic())
783 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000784 }
785
786 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
787 return DBuilder.createSubroutineType(Unit, EltTypeArray);
788}
789
790
Guy Benyei11169dd2012-12-18 14:30:41 +0000791llvm::DIType CGDebugInfo::createFieldType(StringRef name,
792 QualType type,
793 uint64_t sizeInBitsOverride,
794 SourceLocation loc,
795 AccessSpecifier AS,
796 uint64_t offsetInBits,
797 llvm::DIFile tunit,
Manman Ren2c826dc2013-09-08 03:45:05 +0000798 llvm::DIScope scope) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000799 llvm::DIType debugType = getOrCreateType(type, tunit);
800
801 // Get the location for the field.
802 llvm::DIFile file = getOrCreateFile(loc);
803 unsigned line = getLineNumber(loc);
804
805 uint64_t sizeInBits = 0;
806 unsigned alignInBits = 0;
807 if (!type->isIncompleteArrayType()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000808 std::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
Guy Benyei11169dd2012-12-18 14:30:41 +0000809
810 if (sizeInBitsOverride)
811 sizeInBits = sizeInBitsOverride;
812 }
813
814 unsigned flags = 0;
815 if (AS == clang::AS_private)
816 flags |= llvm::DIDescriptor::FlagPrivate;
817 else if (AS == clang::AS_protected)
818 flags |= llvm::DIDescriptor::FlagProtected;
819
820 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
821 alignInBits, offsetInBits, flags, debugType);
822}
823
Eric Christopher91a31902013-01-16 01:22:32 +0000824/// CollectRecordLambdaFields - Helper for CollectRecordFields.
825void CGDebugInfo::
826CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
827 SmallVectorImpl<llvm::Value *> &elements,
828 llvm::DIType RecordTy) {
829 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
830 // has the name and the location of the variable so we should iterate over
831 // both concurrently.
832 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
833 RecordDecl::field_iterator Field = CXXDecl->field_begin();
834 unsigned fieldno = 0;
835 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
836 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
837 const LambdaExpr::Capture C = *I;
838 if (C.capturesVariable()) {
839 VarDecl *V = C.getCapturedVar();
840 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
841 StringRef VName = V->getName();
842 uint64_t SizeInBitsOverride = 0;
843 if (Field->isBitField()) {
844 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
845 assert(SizeInBitsOverride && "found named 0-width bitfield");
846 }
847 llvm::DIType fieldType
848 = createFieldType(VName, Field->getType(), SizeInBitsOverride,
849 C.getLocation(), Field->getAccess(),
850 layout.getFieldOffset(fieldno), VUnit, RecordTy);
851 elements.push_back(fieldType);
852 } else {
853 // TODO: Need to handle 'this' in some way by probably renaming the
854 // this of the lambda class and having a field member of 'this' or
855 // by using AT_object_pointer for the function and having that be
856 // used as 'this' for semantic references.
857 assert(C.capturesThis() && "Field that isn't captured and isn't this?");
858 FieldDecl *f = *Field;
859 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
860 QualType type = f->getType();
861 llvm::DIType fieldType
862 = createFieldType("this", type, 0, f->getLocation(), f->getAccess(),
863 layout.getFieldOffset(fieldno), VUnit, RecordTy);
864
865 elements.push_back(fieldType);
866 }
867 }
868}
869
David Blaikie6943dea2013-08-20 01:28:15 +0000870/// Helper for CollectRecordFields.
David Blaikieae019462013-08-15 22:50:29 +0000871llvm::DIDerivedType
872CGDebugInfo::CreateRecordStaticField(const VarDecl *Var,
873 llvm::DIType RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000874 // Create the descriptor for the static variable, with or without
875 // constant initializers.
876 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
877 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
878
Eric Christopher91a31902013-01-16 01:22:32 +0000879 unsigned LineNumber = getLineNumber(Var->getLocation());
880 StringRef VName = Var->getName();
David Blaikied42917f2013-01-20 01:19:17 +0000881 llvm::Constant *C = NULL;
Eric Christopher91a31902013-01-16 01:22:32 +0000882 if (Var->getInit()) {
883 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000884 if (Value) {
885 if (Value->isInt())
886 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
887 if (Value->isFloat())
888 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
889 }
Eric Christopher91a31902013-01-16 01:22:32 +0000890 }
891
892 unsigned Flags = 0;
893 AccessSpecifier Access = Var->getAccess();
894 if (Access == clang::AS_private)
895 Flags |= llvm::DIDescriptor::FlagPrivate;
896 else if (Access == clang::AS_protected)
897 Flags |= llvm::DIDescriptor::FlagProtected;
898
David Blaikieae019462013-08-15 22:50:29 +0000899 llvm::DIDerivedType GV = DBuilder.createStaticMemberType(
900 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Eric Christopher91a31902013-01-16 01:22:32 +0000901 StaticDataMemberCache[Var->getCanonicalDecl()] = llvm::WeakVH(GV);
David Blaikieae019462013-08-15 22:50:29 +0000902 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +0000903}
904
905/// CollectRecordNormalField - Helper for CollectRecordFields.
906void CGDebugInfo::
907CollectRecordNormalField(const FieldDecl *field, uint64_t OffsetInBits,
908 llvm::DIFile tunit,
909 SmallVectorImpl<llvm::Value *> &elements,
910 llvm::DIType RecordTy) {
911 StringRef name = field->getName();
912 QualType type = field->getType();
913
914 // Ignore unnamed fields unless they're anonymous structs/unions.
915 if (name.empty() && !type->isRecordType())
916 return;
917
918 uint64_t SizeInBitsOverride = 0;
919 if (field->isBitField()) {
920 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
921 assert(SizeInBitsOverride && "found named 0-width bitfield");
922 }
923
924 llvm::DIType fieldType
925 = createFieldType(name, type, SizeInBitsOverride,
926 field->getLocation(), field->getAccess(),
927 OffsetInBits, tunit, RecordTy);
928
929 elements.push_back(fieldType);
930}
931
Guy Benyei11169dd2012-12-18 14:30:41 +0000932/// CollectRecordFields - A helper function to collect debug info for
933/// record fields. This is used while creating debug info entry for a Record.
David Blaikieab255bb2013-08-16 20:40:25 +0000934void CGDebugInfo::CollectRecordFields(const RecordDecl *record,
935 llvm::DIFile tunit,
936 SmallVectorImpl<llvm::Value *> &elements,
937 llvm::DICompositeType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000938 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
939
Eric Christopher91a31902013-01-16 01:22:32 +0000940 if (CXXDecl && CXXDecl->isLambda())
941 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
942 else {
943 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +0000944
Eric Christopher91a31902013-01-16 01:22:32 +0000945 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +0000946 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +0000947
Eric Christopher91a31902013-01-16 01:22:32 +0000948 // Static and non-static members should appear in the same order as
949 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +0000950 for (const auto *I : record->decls())
951 if (const auto *V = dyn_cast<VarDecl>(I)) {
David Blaikiece763042013-08-20 21:49:21 +0000952 // Reuse the existing static member declaration if one exists
953 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
954 StaticDataMemberCache.find(V->getCanonicalDecl());
955 if (MI != StaticDataMemberCache.end()) {
956 assert(MI->second &&
957 "Static data member declaration should still exist");
958 elements.push_back(
959 llvm::DIDerivedType(cast<llvm::MDNode>(MI->second)));
960 } else
961 elements.push_back(CreateRecordStaticField(V, RecordTy));
Aaron Ballman629afae2014-03-07 19:56:05 +0000962 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christopher91a31902013-01-16 01:22:32 +0000963 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo),
964 tunit, elements, RecordTy);
965
966 // Bump field number for next field.
967 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +0000968 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000969 }
970}
971
972/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
973/// function type is not updated to include implicit "this" pointer. Use this
974/// routine to get a method type which includes "this" pointer.
David Blaikie469f0792013-05-22 23:22:42 +0000975llvm::DICompositeType
Guy Benyei11169dd2012-12-18 14:30:41 +0000976CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
977 llvm::DIFile Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +0000978 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +0000979 if (Method->isStatic())
David Blaikie469f0792013-05-22 23:22:42 +0000980 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +0000981 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
982 Func, Unit);
983}
David Blaikie2aaf0652013-01-07 22:24:59 +0000984
David Blaikie469f0792013-05-22 23:22:42 +0000985llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie7eb06852013-01-07 23:06:35 +0000986 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000987 // Add "this" pointer.
David Blaikie7eb06852013-01-07 23:06:35 +0000988 llvm::DIArray Args = llvm::DICompositeType(
989 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +0000990 assert (Args.getNumElements() && "Invalid number of arguments!");
991
992 SmallVector<llvm::Value *, 16> Elts;
993
994 // First element is always return type. For 'void' functions it is NULL.
995 Elts.push_back(Args.getElement(0));
996
David Blaikie2aaf0652013-01-07 22:24:59 +0000997 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +0000998 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +0000999 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1000 // Create pointer type directly in this case.
1001 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1002 QualType PointeeTy = ThisPtrTy->getPointeeType();
1003 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001004 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001005 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
1006 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopher0fdcb312013-05-16 00:52:20 +00001007 llvm::DIType ThisPtrType =
1008 DBuilder.createPointerType(PointeeType, Size, Align);
David Blaikie2aaf0652013-01-07 22:24:59 +00001009 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1010 // TODO: This and the artificial type below are misleading, the
1011 // types aren't artificial the argument is, but the current
1012 // metadata doesn't represent that.
1013 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1014 Elts.push_back(ThisPtrType);
1015 } else {
1016 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
1017 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
1018 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1019 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001020 }
1021
1022 // Copy rest of the arguments.
1023 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
1024 Elts.push_back(Args.getElement(i));
1025
1026 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1027
Adrian Prantl0630eb72013-12-18 21:48:18 +00001028 unsigned Flags = 0;
1029 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1030 Flags |= llvm::DIDescriptor::FlagLValueReference;
1031 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1032 Flags |= llvm::DIDescriptor::FlagRValueReference;
1033
1034 return DBuilder.createSubroutineType(Unit, EltTypeArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001035}
1036
Eric Christopherb2a008c2013-05-16 00:45:12 +00001037/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001038/// inside a function.
1039static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1040 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1041 return isFunctionLocalClass(NRD);
1042 if (isa<FunctionDecl>(RD->getDeclContext()))
1043 return true;
1044 return false;
1045}
1046
1047/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1048/// a single member function GlobalDecl.
1049llvm::DISubprogram
1050CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
1051 llvm::DIFile Unit,
1052 llvm::DIType RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001053 bool IsCtorOrDtor =
Guy Benyei11169dd2012-12-18 14:30:41 +00001054 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001055
Guy Benyei11169dd2012-12-18 14:30:41 +00001056 StringRef MethodName = getFunctionName(Method);
David Blaikie469f0792013-05-22 23:22:42 +00001057 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001058
1059 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1060 // make sense to give a single ctor/dtor a linkage name.
1061 StringRef MethodLinkageName;
1062 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1063 MethodLinkageName = CGM.getMangledName(Method);
1064
1065 // Get the location for the method.
David Blaikie7fceebf2013-08-19 03:37:48 +00001066 llvm::DIFile MethodDefUnit;
1067 unsigned MethodLine = 0;
1068 if (!Method->isImplicit()) {
1069 MethodDefUnit = getOrCreateFile(Method->getLocation());
1070 MethodLine = getLineNumber(Method->getLocation());
1071 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001072
1073 // Collect virtual method info.
1074 llvm::DIType ContainingType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001075 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001076 unsigned VIndex = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001077
Guy Benyei11169dd2012-12-18 14:30:41 +00001078 if (Method->isVirtual()) {
1079 if (Method->isPure())
1080 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1081 else
1082 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001083
Guy Benyei11169dd2012-12-18 14:30:41 +00001084 // It doesn't make sense to give a virtual destructor a vtable index,
1085 // since a single destructor has two entries in the vtable.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001086 // FIXME: Add proper support for debug info for virtual calls in
1087 // the Microsoft ABI, where we may use multiple vptrs to make a vftable
1088 // lookup if we have multiple or virtual inheritance.
1089 if (!isa<CXXDestructorDecl>(Method) &&
1090 !CGM.getTarget().getCXXABI().isMicrosoft())
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001091 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
Guy Benyei11169dd2012-12-18 14:30:41 +00001092 ContainingType = RecordTy;
1093 }
1094
1095 unsigned Flags = 0;
1096 if (Method->isImplicit())
1097 Flags |= llvm::DIDescriptor::FlagArtificial;
1098 AccessSpecifier Access = Method->getAccess();
1099 if (Access == clang::AS_private)
1100 Flags |= llvm::DIDescriptor::FlagPrivate;
1101 else if (Access == clang::AS_protected)
1102 Flags |= llvm::DIDescriptor::FlagProtected;
1103 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1104 if (CXXC->isExplicit())
1105 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001106 } else if (const CXXConversionDecl *CXXC =
Guy Benyei11169dd2012-12-18 14:30:41 +00001107 dyn_cast<CXXConversionDecl>(Method)) {
1108 if (CXXC->isExplicit())
1109 Flags |= llvm::DIDescriptor::FlagExplicit;
1110 }
1111 if (Method->hasPrototype())
1112 Flags |= llvm::DIDescriptor::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001113 if (Method->getRefQualifier() == RQ_LValue)
1114 Flags |= llvm::DIDescriptor::FlagLValueReference;
1115 if (Method->getRefQualifier() == RQ_RValue)
1116 Flags |= llvm::DIDescriptor::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001117
1118 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1119 llvm::DISubprogram SP =
Eric Christopherb2a008c2013-05-16 00:45:12 +00001120 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Guy Benyei11169dd2012-12-18 14:30:41 +00001121 MethodDefUnit, MethodLine,
Eric Christopherb2a008c2013-05-16 00:45:12 +00001122 MethodTy, /*isLocalToUnit=*/false,
Guy Benyei11169dd2012-12-18 14:30:41 +00001123 /* isDefinition=*/ false,
1124 Virtuality, VIndex, ContainingType,
1125 Flags, CGM.getLangOpts().Optimize, NULL,
1126 TParamsArray);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001127
Guy Benyei11169dd2012-12-18 14:30:41 +00001128 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
1129
1130 return SP;
1131}
1132
1133/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001134/// C++ member functions. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001135/// a Record.
1136void CGDebugInfo::
1137CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
1138 SmallVectorImpl<llvm::Value *> &EltTys,
1139 llvm::DIType RecordTy) {
1140
1141 // Since we want more than just the individual member decls if we
1142 // have templated functions iterate over every declaration to gather
1143 // the functions.
Aaron Ballman629afae2014-03-07 19:56:05 +00001144 for(const auto *I : RD->decls()) {
1145 if (const auto *Method = dyn_cast<CXXMethodDecl>(I)) {
David Blaikiea6cc8212013-08-28 20:58:00 +00001146 // Reuse the existing member function declaration if it exists.
David Blaikie8c8e8e22013-08-28 20:24:55 +00001147 // It may be associated with the declaration of the type & should be
1148 // reused as we're building the definition.
David Blaikiea6cc8212013-08-28 20:58:00 +00001149 //
1150 // This situation can arise in the vtable-based debug info reduction where
1151 // implicit members are emitted in a non-vtable TU.
David Blaikie6943dea2013-08-20 01:28:15 +00001152 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
1153 SPCache.find(Method->getCanonicalDecl());
David Blaikiefae219a2013-08-28 17:27:13 +00001154 if (MI == SPCache.end()) {
David Blaikie8c8e8e22013-08-28 20:24:55 +00001155 // If the member is implicit, lazily create it when we see the
1156 // definition, not before. (an ODR-used implicit default ctor that's
1157 // never actually code generated should not produce debug info)
David Blaikiefae219a2013-08-28 17:27:13 +00001158 if (!Method->isImplicit())
1159 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
1160 } else
David Blaikie6943dea2013-08-20 01:28:15 +00001161 EltTys.push_back(MI->second);
Aaron Ballman629afae2014-03-07 19:56:05 +00001162 } else if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(I)) {
David Blaikief2053af2013-08-28 23:06:52 +00001163 // Add any template specializations that have already been seen. Like
1164 // implicit member functions, these may have been added to a declaration
1165 // in the case of vtable-based debug info reduction.
Aaron Ballmanb8733c52014-03-14 16:05:56 +00001166 for (const auto *SI : FTD->specializations()) {
David Blaikief2053af2013-08-28 23:06:52 +00001167 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator MI =
Aaron Ballmanb8733c52014-03-14 16:05:56 +00001168 SPCache.find(cast<CXXMethodDecl>(SI)->getCanonicalDecl());
David Blaikief2053af2013-08-28 23:06:52 +00001169 if (MI != SPCache.end())
1170 EltTys.push_back(MI->second);
1171 }
David Blaikie6943dea2013-08-20 01:28:15 +00001172 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001173 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001174}
Guy Benyei11169dd2012-12-18 14:30:41 +00001175
Guy Benyei11169dd2012-12-18 14:30:41 +00001176/// CollectCXXBases - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001177/// C++ base classes. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001178/// a Record.
1179void CGDebugInfo::
1180CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1181 SmallVectorImpl<llvm::Value *> &EltTys,
1182 llvm::DIType RecordTy) {
1183
1184 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001185 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001186 unsigned BFlags = 0;
1187 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001188
Guy Benyei11169dd2012-12-18 14:30:41 +00001189 const CXXRecordDecl *Base =
Aaron Ballman574705e2014-03-13 15:41:46 +00001190 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001191
Aaron Ballman574705e2014-03-13 15:41:46 +00001192 if (BI.isVirtual()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001193 // virtual base offset offset is -ve. The code generator emits dwarf
1194 // expression where it expects +ve number.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001195 BaseOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001196 0 - CGM.getItaniumVTableContext()
Guy Benyei11169dd2012-12-18 14:30:41 +00001197 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1198 BFlags = llvm::DIDescriptor::FlagVirtual;
1199 } else
1200 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1201 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1202 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001203
Aaron Ballman574705e2014-03-13 15:41:46 +00001204 AccessSpecifier Access = BI.getAccessSpecifier();
Guy Benyei11169dd2012-12-18 14:30:41 +00001205 if (Access == clang::AS_private)
1206 BFlags |= llvm::DIDescriptor::FlagPrivate;
1207 else if (Access == clang::AS_protected)
1208 BFlags |= llvm::DIDescriptor::FlagProtected;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001209
1210 llvm::DIType DTy =
1211 DBuilder.createInheritance(RecordTy,
Aaron Ballman574705e2014-03-13 15:41:46 +00001212 getOrCreateType(BI.getType(), Unit),
Guy Benyei11169dd2012-12-18 14:30:41 +00001213 BaseOffset, BFlags);
1214 EltTys.push_back(DTy);
1215 }
1216}
1217
1218/// CollectTemplateParams - A helper function to collect template parameters.
1219llvm::DIArray CGDebugInfo::
1220CollectTemplateParams(const TemplateParameterList *TPList,
David Blaikie47c11502013-06-22 18:59:18 +00001221 ArrayRef<TemplateArgument> TAList,
Guy Benyei11169dd2012-12-18 14:30:41 +00001222 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001223 SmallVector<llvm::Value *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001224 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1225 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001226 StringRef Name;
1227 if (TPList)
1228 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001229 switch (TA.getKind()) {
1230 case TemplateArgument::Type: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001231 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1232 llvm::DITemplateTypeParameter TTP =
David Blaikie47c11502013-06-22 18:59:18 +00001233 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001234 TemplateParams.push_back(TTP);
David Blaikie38079fd2013-05-10 21:53:14 +00001235 } break;
1236 case TemplateArgument::Integral: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001237 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1238 llvm::DITemplateValueParameter TVP =
David Blaikie38079fd2013-05-10 21:53:14 +00001239 DBuilder.createTemplateValueParameter(
David Blaikie47c11502013-06-22 18:59:18 +00001240 TheCU, Name, TTy,
David Blaikie38079fd2013-05-10 21:53:14 +00001241 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1242 TemplateParams.push_back(TVP);
1243 } break;
1244 case TemplateArgument::Declaration: {
1245 const ValueDecl *D = TA.getAsDecl();
1246 bool InstanceMember = D->isCXXInstanceMember();
1247 QualType T = InstanceMember
1248 ? CGM.getContext().getMemberPointerType(
1249 D->getType(), cast<RecordDecl>(D->getDeclContext())
1250 ->getTypeForDecl())
1251 : CGM.getContext().getPointerType(D->getType());
1252 llvm::DIType TTy = getOrCreateType(T, Unit);
1253 llvm::Value *V = 0;
1254 // Variable pointer template parameters have a value that is the address
1255 // of the variable.
1256 if (const VarDecl *VD = dyn_cast<VarDecl>(D))
1257 V = CGM.GetAddrOfGlobalVar(VD);
1258 // Member function pointers have special support for building them, though
1259 // this is currently unsupported in LLVM CodeGen.
David Blaikied900f982013-05-13 06:57:50 +00001260 if (InstanceMember) {
David Blaikie38079fd2013-05-10 21:53:14 +00001261 if (const CXXMethodDecl *method = dyn_cast<CXXMethodDecl>(D))
1262 V = CGM.getCXXABI().EmitMemberPointer(method);
David Blaikied900f982013-05-13 06:57:50 +00001263 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1264 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001265 // Member data pointers have special handling too to compute the fixed
1266 // offset within the object.
Adrian Prantlefb88052014-04-01 17:52:06 +00001267 if (isa<FieldDecl>(D) || isa<IndirectFieldDecl>(D)) {
David Blaikie38079fd2013-05-10 21:53:14 +00001268 // These five lines (& possibly the above member function pointer
1269 // handling) might be able to be refactored to use similar code in
1270 // CodeGenModule::getMemberPointerConstant
1271 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1272 CharUnits chars =
1273 CGM.getContext().toCharUnitsFromBits((int64_t) fieldOffset);
1274 V = CGM.getCXXABI().EmitMemberDataPointer(
1275 cast<MemberPointerType>(T.getTypePtr()), chars);
1276 }
1277 llvm::DITemplateValueParameter TVP =
David Majnemera3644d62013-08-25 22:13:27 +00001278 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1279 V->stripPointerCasts());
David Blaikie38079fd2013-05-10 21:53:14 +00001280 TemplateParams.push_back(TVP);
1281 } break;
1282 case TemplateArgument::NullPtr: {
1283 QualType T = TA.getNullPtrType();
1284 llvm::DIType TTy = getOrCreateType(T, Unit);
1285 llvm::Value *V = 0;
1286 // Special case member data pointer null values since they're actually -1
1287 // instead of zero.
1288 if (const MemberPointerType *MPT =
1289 dyn_cast<MemberPointerType>(T.getTypePtr()))
1290 // But treat member function pointers as simple zero integers because
1291 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1292 // CodeGen grows handling for values of non-null member function
1293 // pointers then perhaps we could remove this special case and rely on
1294 // EmitNullMemberPointer for member function pointers.
1295 if (MPT->isMemberDataPointer())
1296 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1297 if (!V)
1298 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1299 llvm::DITemplateValueParameter TVP =
David Blaikie47c11502013-06-22 18:59:18 +00001300 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V);
David Blaikie38079fd2013-05-10 21:53:14 +00001301 TemplateParams.push_back(TVP);
1302 } break;
David Blaikie47c11502013-06-22 18:59:18 +00001303 case TemplateArgument::Template: {
1304 llvm::DITemplateValueParameter TVP =
1305 DBuilder.createTemplateTemplateParameter(
1306 TheCU, Name, llvm::DIType(),
1307 TA.getAsTemplate().getAsTemplateDecl()
1308 ->getQualifiedNameAsString());
1309 TemplateParams.push_back(TVP);
1310 } break;
1311 case TemplateArgument::Pack: {
1312 llvm::DITemplateValueParameter TVP =
1313 DBuilder.createTemplateParameterPack(
1314 TheCU, Name, llvm::DIType(),
1315 CollectTemplateParams(NULL, TA.getPackAsArray(), Unit));
1316 TemplateParams.push_back(TVP);
1317 } break;
David Majnemer5559d472013-08-24 08:21:10 +00001318 case TemplateArgument::Expression: {
1319 const Expr *E = TA.getAsExpr();
1320 QualType T = E->getType();
1321 llvm::Value *V = CGM.EmitConstantExpr(E, T);
1322 assert(V && "Expression in template argument isn't constant");
1323 llvm::DIType TTy = getOrCreateType(T, Unit);
1324 llvm::DITemplateValueParameter TVP =
1325 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1326 V->stripPointerCasts());
1327 TemplateParams.push_back(TVP);
1328 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001329 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001330 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001331 case TemplateArgument::Null:
1332 llvm_unreachable(
1333 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001334 }
1335 }
1336 return DBuilder.getOrCreateArray(TemplateParams);
1337}
1338
1339/// CollectFunctionTemplateParams - A helper function to collect debug
1340/// info for function template parameters.
1341llvm::DIArray CGDebugInfo::
1342CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1343 if (FD->getTemplatedKind() ==
1344 FunctionDecl::TK_FunctionTemplateSpecialization) {
1345 const TemplateParameterList *TList =
1346 FD->getTemplateSpecializationInfo()->getTemplate()
1347 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001348 return CollectTemplateParams(
1349 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001350 }
1351 return llvm::DIArray();
1352}
1353
1354/// CollectCXXTemplateParams - A helper function to collect debug info for
1355/// template parameters.
1356llvm::DIArray CGDebugInfo::
1357CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1358 llvm::DIFile Unit) {
1359 llvm::PointerUnion<ClassTemplateDecl *,
1360 ClassTemplatePartialSpecializationDecl *>
1361 PU = TSpecial->getSpecializedTemplateOrPartial();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001362
Guy Benyei11169dd2012-12-18 14:30:41 +00001363 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1364 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1365 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1366 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001367 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001368}
1369
1370/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1371llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1372 if (VTablePtrType.isValid())
1373 return VTablePtrType;
1374
1375 ASTContext &Context = CGM.getContext();
1376
1377 /* Function type */
1378 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1379 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1380 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1381 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1382 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1383 "__vtbl_ptr_type");
1384 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1385 return VTablePtrType;
1386}
1387
1388/// getVTableName - Get vtable name for the given Class.
1389StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001390 // Copy the gdb compatible name on the side and use its reference.
1391 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001392}
1393
1394
1395/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1396/// debug info entry in EltTys vector.
1397void CGDebugInfo::
1398CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1399 SmallVectorImpl<llvm::Value *> &EltTys) {
1400 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1401
1402 // If there is a primary base then it will hold vtable info.
1403 if (RL.getPrimaryBase())
1404 return;
1405
1406 // If this class is not dynamic then there is not any vtable info to collect.
1407 if (!RD->isDynamicClass())
1408 return;
1409
1410 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1411 llvm::DIType VPTR
1412 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Eric Christopher0fdcb312013-05-16 00:52:20 +00001413 0, Size, 0, 0,
1414 llvm::DIDescriptor::FlagArtificial,
Guy Benyei11169dd2012-12-18 14:30:41 +00001415 getOrCreateVTablePtrType(Unit));
1416 EltTys.push_back(VPTR);
1417}
1418
Eric Christopherb2a008c2013-05-16 00:45:12 +00001419/// getOrCreateRecordType - Emit record type's standalone debug info.
1420llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00001421 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001422 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001423 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1424 return T;
1425}
1426
1427/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1428/// debug info.
1429llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001430 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001431 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001432 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantl73409ce2013-03-11 18:33:46 +00001433 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001434 return T;
1435}
1436
David Blaikieb2e86eb2013-08-15 20:49:17 +00001437void CGDebugInfo::completeType(const RecordDecl *RD) {
1438 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1439 !CGM.getLangOpts().CPlusPlus)
1440 completeRequiredType(RD);
1441}
1442
1443void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie0856f662014-03-04 22:01:08 +00001444 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1445 return;
1446
David Blaikie6943dea2013-08-20 01:28:15 +00001447 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1448 if (CXXDecl->isDynamicClass())
1449 return;
1450
David Blaikieb2e86eb2013-08-15 20:49:17 +00001451 QualType Ty = CGM.getContext().getRecordType(RD);
1452 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie6943dea2013-08-20 01:28:15 +00001453 if (T && T.isForwardDecl())
1454 completeClassData(RD);
1455}
1456
1457void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1458 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001459 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001460 QualType Ty = CGM.getContext().getRecordType(RD);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001461 void* TyPtr = Ty.getAsOpaquePtr();
1462 if (CompletedTypeCache.count(TyPtr))
1463 return;
1464 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1465 assert(!Res.isForwardDecl());
1466 CompletedTypeCache[TyPtr] = Res;
1467 TypeCache[TyPtr] = Res;
1468}
1469
David Blaikie0e716b42014-03-03 23:48:23 +00001470static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1471 CXXRecordDecl::method_iterator End) {
1472 for (; I != End; ++I)
1473 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001474 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1475 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001476 return true;
1477 return false;
1478}
1479
1480static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
1481 const RecordDecl *RD,
1482 const LangOptions &LangOpts) {
1483 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1484 return false;
1485
1486 if (!LangOpts.CPlusPlus)
1487 return false;
1488
1489 if (!RD->isCompleteDefinitionRequired())
1490 return true;
1491
1492 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1493
1494 if (!CXXDecl)
1495 return false;
1496
1497 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1498 return true;
1499
1500 TemplateSpecializationKind Spec = TSK_Undeclared;
1501 if (const ClassTemplateSpecializationDecl *SD =
1502 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1503 Spec = SD->getSpecializationKind();
1504
1505 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1506 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1507 CXXDecl->method_end()))
1508 return true;
1509
1510 return false;
1511}
1512
Guy Benyei11169dd2012-12-18 14:30:41 +00001513/// CreateType - get structure or union type.
David Blaikie99dab3b2013-09-04 22:03:57 +00001514llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001515 RecordDecl *RD = Ty->getDecl();
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001516 llvm::DICompositeType T(getTypeOrNull(QualType(Ty, 0)));
David Blaikie0e716b42014-03-03 23:48:23 +00001517 if (T || shouldOmitDefinition(DebugKind, RD, CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001518 if (!T)
David Blaikie65ec94e2014-02-18 20:52:05 +00001519 T = getOrCreateRecordFwdDecl(
1520 Ty, getContextDescriptor(cast<Decl>(RD->getDeclContext())));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001521 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001522 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001523
David Blaikieb2e86eb2013-08-15 20:49:17 +00001524 return CreateTypeDefinition(Ty);
1525}
1526
1527llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1528 RecordDecl *RD = Ty->getDecl();
1529
Guy Benyei11169dd2012-12-18 14:30:41 +00001530 // Get overall information about the record type for the debug info.
1531 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1532
1533 // Records and classes and unions can all be recursive. To handle them, we
1534 // first generate a debug descriptor for the struct as a forward declaration.
1535 // Then (if it is a definition) we go through and get debug info for all of
1536 // its members. Finally, we create a descriptor for the complete type (which
1537 // may refer to the forward decl if the struct is recursive) and replace all
1538 // uses of the forward declaration with the final definition.
1539
David Blaikie4a2b5ef2013-08-12 22:24:20 +00001540 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Ren0d441f12013-07-02 19:01:53 +00001541 assert(FwdDecl.isCompositeType() &&
David Blaikie469f0792013-05-22 23:22:42 +00001542 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei11169dd2012-12-18 14:30:41 +00001543
1544 if (FwdDecl.isForwardDecl())
1545 return FwdDecl;
1546
David Blaikieadfbf992013-08-18 16:55:33 +00001547 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1548 CollectContainingType(CXXDecl, FwdDecl);
1549
Guy Benyei11169dd2012-12-18 14:30:41 +00001550 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001551 LexicalBlockStack.push_back(&*FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001552 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1553
Adrian Prantla03a85a2013-03-06 22:03:30 +00001554 // Add this to the completed-type cache while we're completing it recursively.
Guy Benyei11169dd2012-12-18 14:30:41 +00001555 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1556
1557 // Convert all the elements.
1558 SmallVector<llvm::Value *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001559 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001560
1561 // Note: The split of CXXDecl information here is intentional, the
1562 // gdb tests will depend on a certain ordering at printout. The debug
1563 // information offsets are still correct if we merge them all together
1564 // though.
1565 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1566 if (CXXDecl) {
1567 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1568 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1569 }
1570
Eric Christopher91a31902013-01-16 01:22:32 +00001571 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001572 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001573 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001574 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001575
1576 LexicalBlockStack.pop_back();
1577 RegionMap.erase(Ty->getDecl());
1578
1579 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
David Blaikie4a5b8952013-08-01 20:31:40 +00001580 FwdDecl.setTypeArray(Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001581
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001582 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1583 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001584}
1585
1586/// CreateType - get objective-c object type.
1587llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1588 llvm::DIFile Unit) {
1589 // Ignore protocols.
1590 return getOrCreateType(Ty->getBaseType(), Unit);
1591}
1592
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001593
1594/// \return true if Getter has the default name for the property PD.
1595static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1596 const ObjCMethodDecl *Getter) {
1597 assert(PD);
1598 if (!Getter)
1599 return true;
1600
1601 assert(Getter->getDeclName().isObjCZeroArgSelector());
1602 return PD->getName() ==
1603 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
1604}
1605
1606/// \return true if Setter has the default name for the property PD.
1607static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1608 const ObjCMethodDecl *Setter) {
1609 assert(PD);
1610 if (!Setter)
1611 return true;
1612
1613 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001614 return SelectorTable::constructSetterName(PD->getName()) ==
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001615 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
1616}
1617
Guy Benyei11169dd2012-12-18 14:30:41 +00001618/// CreateType - get objective-c interface type.
1619llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1620 llvm::DIFile Unit) {
1621 ObjCInterfaceDecl *ID = Ty->getDecl();
1622 if (!ID)
1623 return llvm::DIType();
1624
1625 // Get overall information about the record type for the debug info.
1626 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1627 unsigned Line = getLineNumber(ID->getLocation());
1628 unsigned RuntimeLang = TheCU.getLanguage();
1629
1630 // If this is just a forward declaration return a special forward-declaration
1631 // debug type since we won't be able to lay out the entire type.
1632 ObjCInterfaceDecl *Def = ID->getDefinition();
1633 if (!Def) {
1634 llvm::DIType FwdDecl =
1635 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001636 ID->getName(), TheCU, DefUnit, Line,
1637 RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001638 return FwdDecl;
1639 }
1640
1641 ID = Def;
1642
1643 // Bit size, align and offset of the type.
1644 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1645 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1646
1647 unsigned Flags = 0;
1648 if (ID->getImplementation())
1649 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1650
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001651 llvm::DICompositeType RealDecl =
Guy Benyei11169dd2012-12-18 14:30:41 +00001652 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1653 Line, Size, Align, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00001654 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001655
1656 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1657 // will find it and we're emitting the complete type.
Adrian Prantla03a85a2013-03-06 22:03:30 +00001658 QualType QualTy = QualType(Ty, 0);
1659 CompletedTypeCache[QualTy.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
1783 // If the implementation is not yet set, we do not want to mark it
1784 // as complete. An implementation may declare additional
1785 // private ivars that we would miss otherwise.
1786 if (ID->getImplementation() == 0)
1787 CompletedTypeCache.erase(QualTy.getAsOpaquePtr());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001788
Guy Benyei11169dd2012-12-18 14:30:41 +00001789 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001790 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001791}
1792
1793llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1794 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1795 int64_t Count = Ty->getNumElements();
1796 if (Count == 0)
1797 // If number of elements are not known then this is an unbounded array.
1798 // Use Count == -1 to express such arrays.
1799 Count = -1;
1800
1801 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1802 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1803
1804 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1805 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1806
1807 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1808}
1809
1810llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1811 llvm::DIFile Unit) {
1812 uint64_t Size;
1813 uint64_t Align;
1814
1815 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1816 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1817 Size = 0;
1818 Align =
1819 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1820 } else if (Ty->isIncompleteArrayType()) {
1821 Size = 0;
1822 if (Ty->getElementType()->isIncompleteType())
1823 Align = 0;
1824 else
1825 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001826 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001827 Size = 0;
1828 Align = 0;
1829 } else {
1830 // Size and align of the whole array, not the element type.
1831 Size = CGM.getContext().getTypeSize(Ty);
1832 Align = CGM.getContext().getTypeAlign(Ty);
1833 }
1834
1835 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1836 // interior arrays, do we care? Why aren't nested arrays represented the
1837 // obvious/recursive way?
1838 SmallVector<llvm::Value *, 8> Subscripts;
1839 QualType EltTy(Ty, 0);
1840 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1841 // If the number of elements is known, then count is that number. Otherwise,
1842 // it's -1. This allows us to represent a subrange with an array of 0
1843 // elements, like this:
1844 //
1845 // struct foo {
1846 // int x[0];
1847 // };
1848 int64_t Count = -1; // Count == -1 is an unbounded array.
1849 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1850 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001851
Guy Benyei11169dd2012-12-18 14:30:41 +00001852 // FIXME: Verify this is right for VLAs.
1853 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1854 EltTy = Ty->getElementType();
1855 }
1856
1857 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1858
Eric Christopherb2a008c2013-05-16 00:45:12 +00001859 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001860 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1861 SubscriptArray);
1862 return DbgTy;
1863}
1864
Eric Christopherb2a008c2013-05-16 00:45:12 +00001865llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *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_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 RValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001872 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001873 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001874 Ty, Ty->getPointeeType(), Unit);
1875}
1876
Eric Christopherb2a008c2013-05-16 00:45:12 +00001877llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001878 llvm::DIFile U) {
David Blaikie2c705ca2013-01-19 19:20:56 +00001879 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1880 if (!Ty->getPointeeType()->isFunctionType())
1881 return DBuilder.createMemberPointerType(
David Blaikie99dab3b2013-09-04 22:03:57 +00001882 getOrCreateType(Ty->getPointeeType(), U), ClassType);
Adrian Prantl0866acd2013-12-19 01:38:47 +00001883
1884 const FunctionProtoType *FPT =
1885 Ty->getPointeeType()->getAs<FunctionProtoType>();
David Blaikie2c705ca2013-01-19 19:20:56 +00001886 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
Adrian Prantl0866acd2013-12-19 01:38:47 +00001887 CGM.getContext().getPointerType(QualType(Ty->getClass(),
1888 FPT->getTypeQuals())),
1889 FPT, U), ClassType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001890}
1891
Eric Christopherb2a008c2013-05-16 00:45:12 +00001892llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001893 llvm::DIFile U) {
1894 // Ignore the atomic wrapping
1895 // FIXME: What is the correct representation?
1896 return getOrCreateType(Ty->getValueType(), U);
1897}
1898
1899/// CreateEnumType - get enumeration type.
Manman Ren501ecf92013-08-28 21:46:36 +00001900llvm::DIType CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00001901 const EnumDecl *ED = Ty->getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00001902 uint64_t Size = 0;
1903 uint64_t Align = 0;
1904 if (!ED->getTypeForDecl()->isIncompleteType()) {
1905 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1906 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1907 }
1908
Manman Rene0064d82013-08-29 23:19:58 +00001909 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1910
Guy Benyei11169dd2012-12-18 14:30:41 +00001911 // If this is just a forward declaration, construct an appropriately
1912 // marked node and just return it.
1913 if (!ED->getDefinition()) {
1914 llvm::DIDescriptor EDContext;
1915 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1916 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1917 unsigned Line = getLineNumber(ED->getLocation());
1918 StringRef EDName = ED->getName();
1919 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_enumeration_type,
1920 EDName, EDContext, DefUnit, Line, 0,
Manman Rene0064d82013-08-29 23:19:58 +00001921 Size, Align, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001922 }
1923
1924 // Create DIEnumerator elements for each enumerator.
1925 SmallVector<llvm::Value *, 16> Enumerators;
1926 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00001927 for (const auto *Enum : ED->enumerators()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001928 Enumerators.push_back(
1929 DBuilder.createEnumerator(Enum->getName(),
David Blaikiece1ae382013-06-24 07:13:13 +00001930 Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001931 }
1932
1933 // Return a CompositeType for the enum itself.
1934 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1935
1936 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1937 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001938 llvm::DIDescriptor EnumContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00001939 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantlc60dc712013-04-19 19:56:39 +00001940 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei11169dd2012-12-18 14:30:41 +00001941 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001942 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001943 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1944 Size, Align, EltArray,
Manman Rene0064d82013-08-29 23:19:58 +00001945 ClassTy, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001946 return DbgTy;
1947}
1948
David Blaikie05491062013-01-21 04:37:12 +00001949static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1950 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001951 do {
Adrian Prantl179af902013-09-26 21:35:50 +00001952 Qualifiers InnerQuals = T.getLocalQualifiers();
1953 // Qualifiers::operator+() doesn't like it if you add a Qualifier
1954 // that is already there.
1955 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
1956 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001957 QualType LastT = T;
1958 switch (T->getTypeClass()) {
1959 default:
David Blaikie05491062013-01-21 04:37:12 +00001960 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00001961 case Type::TemplateSpecialization: {
1962 const auto *Spec = cast<TemplateSpecializationType>(T);
1963 if (Spec->isTypeAlias())
1964 return C.getQualifiedType(T.getTypePtr(), Quals);
1965 T = Spec->desugar();
1966 break; }
Guy Benyei11169dd2012-12-18 14:30:41 +00001967 case Type::TypeOfExpr:
1968 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1969 break;
1970 case Type::TypeOf:
1971 T = cast<TypeOfType>(T)->getUnderlyingType();
1972 break;
1973 case Type::Decltype:
1974 T = cast<DecltypeType>(T)->getUnderlyingType();
1975 break;
1976 case Type::UnaryTransform:
1977 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1978 break;
1979 case Type::Attributed:
1980 T = cast<AttributedType>(T)->getEquivalentType();
1981 break;
1982 case Type::Elaborated:
1983 T = cast<ElaboratedType>(T)->getNamedType();
1984 break;
1985 case Type::Paren:
1986 T = cast<ParenType>(T)->getInnerType();
1987 break;
David Blaikie05491062013-01-21 04:37:12 +00001988 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00001989 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00001990 break;
1991 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00001992 QualType DT = cast<AutoType>(T)->getDeducedType();
1993 if (DT.isNull())
1994 return T;
1995 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00001996 break;
1997 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001998
Guy Benyei11169dd2012-12-18 14:30:41 +00001999 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002000 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002001 } while (true);
2002}
2003
Eric Christopher0fdcb312013-05-16 00:52:20 +00002004/// getType - Get the type from the cache or return null type if it doesn't
2005/// exist.
Guy Benyei11169dd2012-12-18 14:30:41 +00002006llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
2007
2008 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002009 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002010
Guy Benyei11169dd2012-12-18 14:30:41 +00002011 // Check for existing entry.
Adrian Prantl73409ce2013-03-11 18:33:46 +00002012 if (Ty->getTypeClass() == Type::ObjCInterface) {
2013 llvm::Value *V = getCachedInterfaceTypeOrNull(Ty);
2014 if (V)
2015 return llvm::DIType(cast<llvm::MDNode>(V));
2016 else return llvm::DIType();
2017 }
2018
Guy Benyei11169dd2012-12-18 14:30:41 +00002019 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2020 TypeCache.find(Ty.getAsOpaquePtr());
2021 if (it != TypeCache.end()) {
2022 // Verify that the debug info still exists.
2023 if (llvm::Value *V = it->second)
2024 return llvm::DIType(cast<llvm::MDNode>(V));
2025 }
2026
2027 return llvm::DIType();
2028}
2029
2030/// getCompletedTypeOrNull - Get the type from the cache or return null if it
2031/// doesn't exist.
2032llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
2033
2034 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002035 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002036
2037 // Check for existing entry.
Adrian Prantla03a85a2013-03-06 22:03:30 +00002038 llvm::Value *V = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002039 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2040 CompletedTypeCache.find(Ty.getAsOpaquePtr());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002041 if (it != CompletedTypeCache.end())
2042 V = it->second;
2043 else {
Adrian Prantl73409ce2013-03-11 18:33:46 +00002044 V = getCachedInterfaceTypeOrNull(Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002045 }
2046
Adrian Prantla03a85a2013-03-06 22:03:30 +00002047 // Verify that any cached debug info still exists.
David Blaikie80d28de2013-08-13 04:21:38 +00002048 return llvm::DIType(cast_or_null<llvm::MDNode>(V));
Guy Benyei11169dd2012-12-18 14:30:41 +00002049}
2050
David Blaikie0e716b42014-03-03 23:48:23 +00002051void CGDebugInfo::completeTemplateDefinition(
2052 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002053 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2054 return;
2055
David Blaikie0e716b42014-03-03 23:48:23 +00002056 completeClassData(&SD);
2057 // In case this type has no member function definitions being emitted, ensure
2058 // it is retained
2059 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2060}
2061
Adrian Prantl73409ce2013-03-11 18:33:46 +00002062/// getCachedInterfaceTypeOrNull - Get the type from the interface
2063/// cache, unless it needs to regenerated. Otherwise return null.
2064llvm::Value *CGDebugInfo::getCachedInterfaceTypeOrNull(QualType Ty) {
2065 // Is there a cached interface that hasn't changed?
2066 llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned > >
2067 ::iterator it1 = ObjCInterfaceCache.find(Ty.getAsOpaquePtr());
2068
2069 if (it1 != ObjCInterfaceCache.end())
2070 if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty))
2071 if (Checksum(Decl) == it1->second.second)
2072 // Return cached forward declaration.
2073 return it1->second.first;
2074
2075 return 0;
2076}
Guy Benyei11169dd2012-12-18 14:30:41 +00002077
2078/// getOrCreateType - Get the type from the cache or create a new
2079/// one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +00002080llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002081 if (Ty.isNull())
2082 return llvm::DIType();
2083
2084 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002085 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002086
David Blaikie99dab3b2013-09-04 22:03:57 +00002087 if (llvm::DIType T = getCompletedTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002088 return T;
2089
2090 // Otherwise create the type.
David Blaikie99dab3b2013-09-04 22:03:57 +00002091 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Adrian Prantl73409ce2013-03-11 18:33:46 +00002092 void* TyPtr = Ty.getAsOpaquePtr();
2093
2094 // And update the type cache.
2095 TypeCache[TyPtr] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002096
David Blaikie6a723442013-08-15 21:21:19 +00002097 // FIXME: this getTypeOrNull call seems silly when we just inserted the type
2098 // into the cache - but getTypeOrNull has a special case for cached interface
2099 // types. We should probably just pull that out as a special case for the
2100 // "else" block below & skip the otherwise needless lookup.
Guy Benyei11169dd2012-12-18 14:30:41 +00002101 llvm::DIType TC = getTypeOrNull(Ty);
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002102 if (TC && TC.isForwardDecl())
Adrian Prantl73409ce2013-03-11 18:33:46 +00002103 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
2104 else if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty)) {
2105 // Interface types may have elements added to them by a
2106 // subsequent implementation or extension, so we keep them in
2107 // the ObjCInterfaceCache together with a checksum. Instead of
Adrian Prantlc20237d2013-05-08 23:37:22 +00002108 // the (possibly) incomplete interface type, we return a forward
Adrian Prantl73409ce2013-03-11 18:33:46 +00002109 // declaration that gets RAUW'd in CGDebugInfo::finalize().
David Blaikie8e5939b2013-05-21 18:29:40 +00002110 std::pair<llvm::WeakVH, unsigned> &V = ObjCInterfaceCache[TyPtr];
2111 if (V.first)
2112 return llvm::DIType(cast<llvm::MDNode>(V.first));
2113 TC = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2114 Decl->getName(), TheCU, Unit,
2115 getLineNumber(Decl->getLocation()),
2116 TheCU.getLanguage());
2117 // Store the forward declaration in the cache.
2118 V.first = TC;
2119 V.second = Checksum(Decl);
Adrian Prantl73409ce2013-03-11 18:33:46 +00002120
David Blaikie8e5939b2013-05-21 18:29:40 +00002121 // Register the type for replacement in finalize().
2122 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
2123
Adrian Prantl73409ce2013-03-11 18:33:46 +00002124 return TC;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002125 }
2126
Guy Benyei11169dd2012-12-18 14:30:41 +00002127 if (!Res.isForwardDecl())
Adrian Prantl73409ce2013-03-11 18:33:46 +00002128 CompletedTypeCache[TyPtr] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002129
2130 return Res;
2131}
2132
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002133/// Currently the checksum of an interface includes the number of
2134/// ivars and property accessors.
Eric Christopher1ecc5632013-06-07 22:54:39 +00002135unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl817bbb32013-06-07 01:10:48 +00002136 // The assumption is that the number of ivars can only increase
2137 // monotonically, so it is safe to just use their current number as
2138 // a checksum.
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002139 unsigned Sum = 0;
2140 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
2141 Ivar != 0; Ivar = Ivar->getNextIvar())
2142 ++Sum;
2143
2144 return Sum;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002145}
2146
2147ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2148 switch (Ty->getTypeClass()) {
2149 case Type::ObjCObjectPointer:
Eric Christopher0fdcb312013-05-16 00:52:20 +00002150 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
2151 ->getPointeeType());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002152 case Type::ObjCInterface:
2153 return cast<ObjCInterfaceType>(Ty)->getDecl();
2154 default:
2155 return 0;
2156 }
2157}
2158
Guy Benyei11169dd2012-12-18 14:30:41 +00002159/// CreateTypeNode - Create a new debug type node.
David Blaikie99dab3b2013-09-04 22:03:57 +00002160llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002161 // Handle qualifiers, which recursively handles what they refer to.
2162 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002163 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002164
2165 const char *Diag = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002166
Guy Benyei11169dd2012-12-18 14:30:41 +00002167 // Work out details of type.
2168 switch (Ty->getTypeClass()) {
2169#define TYPE(Class, Base)
2170#define ABSTRACT_TYPE(Class, Base)
2171#define NON_CANONICAL_TYPE(Class, Base)
2172#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2173#include "clang/AST/TypeNodes.def"
2174 llvm_unreachable("Dependent types cannot show up in debug information");
2175
2176 case Type::ExtVector:
2177 case Type::Vector:
2178 return CreateType(cast<VectorType>(Ty), Unit);
2179 case Type::ObjCObjectPointer:
2180 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2181 case Type::ObjCObject:
2182 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2183 case Type::ObjCInterface:
2184 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2185 case Type::Builtin:
2186 return CreateType(cast<BuiltinType>(Ty));
2187 case Type::Complex:
2188 return CreateType(cast<ComplexType>(Ty));
2189 case Type::Pointer:
2190 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002191 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002192 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002193 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002194 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002195 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002196 case Type::BlockPointer:
2197 return CreateType(cast<BlockPointerType>(Ty), Unit);
2198 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002199 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002200 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002201 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002202 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002203 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002204 case Type::FunctionProto:
2205 case Type::FunctionNoProto:
2206 return CreateType(cast<FunctionType>(Ty), Unit);
2207 case Type::ConstantArray:
2208 case Type::VariableArray:
2209 case Type::IncompleteArray:
2210 return CreateType(cast<ArrayType>(Ty), Unit);
2211
2212 case Type::LValueReference:
2213 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2214 case Type::RValueReference:
2215 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2216
2217 case Type::MemberPointer:
2218 return CreateType(cast<MemberPointerType>(Ty), Unit);
2219
2220 case Type::Atomic:
2221 return CreateType(cast<AtomicType>(Ty), Unit);
2222
Guy Benyei11169dd2012-12-18 14:30:41 +00002223 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002224 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2225
2226 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002227 case Type::Elaborated:
2228 case Type::Paren:
2229 case Type::SubstTemplateTypeParm:
2230 case Type::TypeOfExpr:
2231 case Type::TypeOf:
2232 case Type::Decltype:
2233 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002234 case Type::PackExpansion:
Guy Benyei11169dd2012-12-18 14:30:41 +00002235 llvm_unreachable("type should have been unwrapped!");
David Blaikie22c460a02013-05-24 21:24:35 +00002236 case Type::Auto:
2237 Diag = "auto";
2238 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002239 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002240
Guy Benyei11169dd2012-12-18 14:30:41 +00002241 assert(Diag && "Fall through without a diagnostic?");
2242 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2243 "debug information for %0 is not yet supported");
2244 CGM.getDiags().Report(DiagID)
2245 << Diag;
2246 return llvm::DIType();
2247}
2248
2249/// getOrCreateLimitedType - Get the type from the cache or create a new
2250/// limited type if necessary.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002251llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002252 llvm::DIFile Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002253 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002254
David Blaikie8d5e1282013-08-20 21:03:29 +00002255 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002256
2257 // We may have cached a forward decl when we could have created
2258 // a non-forward decl. Go ahead and create a non-forward decl
2259 // now.
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002260 if (T && !T.isForwardDecl()) return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002261
2262 // Otherwise create the type.
David Blaikie8d5e1282013-08-20 21:03:29 +00002263 llvm::DICompositeType Res = CreateLimitedType(Ty);
2264
2265 // Propagate members from the declaration to the definition
2266 // CreateType(const RecordType*) will overwrite this with the members in the
2267 // correct order if the full type is needed.
2268 Res.setTypeArray(T.getTypeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002269
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002270 if (T && T.isForwardDecl())
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002271 ReplaceMap.push_back(
2272 std::make_pair(QTy.getAsOpaquePtr(), static_cast<llvm::Value *>(T)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002273
2274 // And update the type cache.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002275 TypeCache[QTy.getAsOpaquePtr()] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002276 return Res;
2277}
2278
2279// TODO: Currently used for context chains when limiting debug info.
David Blaikie8d5e1282013-08-20 21:03:29 +00002280llvm::DICompositeType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002281 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002282
Guy Benyei11169dd2012-12-18 14:30:41 +00002283 // Get overall information about the record type for the debug info.
2284 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2285 unsigned Line = getLineNumber(RD->getLocation());
2286 StringRef RDName = getClassName(RD);
2287
Eric Christopher07429ff2013-10-15 21:22:34 +00002288 llvm::DIDescriptor RDContext =
2289 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002290
David Blaikied2785892013-08-18 17:36:19 +00002291 // If we ended up creating the type during the context chain construction,
2292 // just return that.
2293 // FIXME: this could be dealt with better if the type was recorded as
2294 // completed before we started this (see the CompletedTypeCache usage in
2295 // CGDebugInfo::CreateTypeDefinition(const RecordType*) - that would need to
2296 // be pushed to before context creation, but after it was known to be
2297 // destined for completion (might still have an issue if this caller only
2298 // required a declaration but the context construction ended up creating a
2299 // definition)
David Blaikie8d5e1282013-08-20 21:03:29 +00002300 llvm::DICompositeType T(getTypeOrNull(CGM.getContext().getRecordType(RD)));
2301 if (T && (!T.isForwardDecl() || !RD->getDefinition()))
David Blaikied2785892013-08-18 17:36:19 +00002302 return T;
2303
Adrian Prantl381e7552014-02-04 21:29:50 +00002304 // If this is just a forward or incomplete declaration, construct an
2305 // appropriately marked node and just return it.
2306 const RecordDecl *D = RD->getDefinition();
2307 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002308 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002309
2310 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2311 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
David Blaikie49ae6a72013-03-26 23:47:35 +00002312 llvm::DICompositeType RealDecl;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002313
Manman Rene0064d82013-08-29 23:19:58 +00002314 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2315
Guy Benyei11169dd2012-12-18 14:30:41 +00002316 if (RD->isUnion())
2317 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Manman Rene0064d82013-08-29 23:19:58 +00002318 Size, Align, 0, llvm::DIArray(), 0,
2319 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002320 else if (RD->isClass()) {
2321 // FIXME: This could be a struct type giving a default visibility different
2322 // than C++ class type, but needs llvm metadata changes first.
2323 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002324 Size, Align, 0, 0, llvm::DIType(),
2325 llvm::DIArray(), llvm::DIType(),
Manman Rene0064d82013-08-29 23:19:58 +00002326 llvm::DIArray(), FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002327 } else
2328 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopher0fdcb312013-05-16 00:52:20 +00002329 Size, Align, 0, llvm::DIType(),
David Blaikieba477362013-11-18 23:38:26 +00002330 llvm::DIArray(), 0, llvm::DIType(),
2331 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002332
2333 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie49ae6a72013-03-26 23:47:35 +00002334 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002335
David Blaikieadfbf992013-08-18 16:55:33 +00002336 if (const ClassTemplateSpecializationDecl *TSpecial =
2337 dyn_cast<ClassTemplateSpecializationDecl>(RD))
2338 RealDecl.setTypeArray(llvm::DIArray(),
2339 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002340 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002341}
2342
David Blaikieadfbf992013-08-18 16:55:33 +00002343void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2344 llvm::DICompositeType RealDecl) {
2345 // A class's primary base or the class itself contains the vtable.
2346 llvm::DICompositeType ContainingType;
2347 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2348 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002349 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002350 while (1) {
2351 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2352 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2353 if (PBT && !BRL.isPrimaryBaseVirtual())
2354 PBase = PBT;
2355 else
2356 break;
2357 }
2358 ContainingType = llvm::DICompositeType(
2359 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2360 getOrCreateFile(RD->getLocation())));
2361 } else if (RD->isDynamicClass())
2362 ContainingType = RealDecl;
2363
2364 RealDecl.setContainingType(ContainingType);
2365}
2366
Guy Benyei11169dd2012-12-18 14:30:41 +00002367/// CreateMemberType - Create new member and increase Offset by FType's size.
2368llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2369 StringRef Name,
2370 uint64_t *Offset) {
2371 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2372 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2373 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2374 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2375 FieldSize, FieldAlign,
2376 *Offset, 0, FieldTy);
2377 *Offset += FieldSize;
2378 return Ty;
2379}
2380
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002381llvm::DIScope CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002382 // We only need a declaration (not a definition) of the type - so use whatever
2383 // we would otherwise do to get a type for a pointee. (forward declarations in
2384 // limited debug info, full definitions (if the type definition is available)
2385 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002386 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2387 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002388 getOrCreateFile(TD->getLocation()));
David Blaikiebd483762013-05-20 04:58:53 +00002389 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2390 // This doesn't handle providing declarations (for functions or variables) for
2391 // entities without definitions in this TU, nor when the definition proceeds
2392 // the call to this function.
2393 // FIXME: This should be split out into more specific maps with support for
2394 // emitting forward declarations and merging definitions with declarations,
2395 // the same way as we do for types.
2396 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2397 DeclCache.find(D->getCanonicalDecl());
2398 if (I == DeclCache.end())
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002399 return llvm::DIScope();
David Blaikiebd483762013-05-20 04:58:53 +00002400 llvm::Value *V = I->second;
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002401 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikiebd483762013-05-20 04:58:53 +00002402}
2403
Guy Benyei11169dd2012-12-18 14:30:41 +00002404/// getFunctionDeclaration - Return debug info descriptor to describe method
2405/// declaration for the given method definition.
2406llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002407 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2408 return llvm::DISubprogram();
2409
Guy Benyei11169dd2012-12-18 14:30:41 +00002410 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2411 if (!FD) return llvm::DISubprogram();
2412
2413 // Setup context.
David Blaikiefd07c602013-08-09 17:20:05 +00002414 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002415
2416 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2417 MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002418 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002419 if (const CXXMethodDecl *MD =
2420 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikiefd07c602013-08-09 17:20:05 +00002421 llvm::DICompositeType T(S);
Eric Christopherf86c4052013-08-28 23:12:10 +00002422 llvm::DISubprogram SP =
2423 CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
David Blaikiefd07c602013-08-09 17:20:05 +00002424 return SP;
2425 }
2426 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002427 if (MI != SPCache.end()) {
2428 llvm::Value *V = MI->second;
2429 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002430 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002431 return SP;
2432 }
2433
Aaron Ballman86c93902014-03-06 23:45:36 +00002434 for (auto NextFD : FD->redecls()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002435 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2436 MI = SPCache.find(NextFD->getCanonicalDecl());
2437 if (MI != SPCache.end()) {
2438 llvm::Value *V = MI->second;
2439 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002440 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002441 return SP;
2442 }
2443 }
2444 return llvm::DISubprogram();
2445}
2446
2447// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2448// implicit parameter "this".
David Blaikie469f0792013-05-22 23:22:42 +00002449llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2450 QualType FnType,
2451 llvm::DIFile F) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002452 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2453 // Create fake but valid subroutine type. Otherwise
2454 // llvm::DISubprogram::Verify() would return false, and
2455 // subprogram DIE will miss DW_AT_decl_file and
2456 // DW_AT_decl_line fields.
2457 return DBuilder.createSubroutineType(F, DBuilder.getOrCreateArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002458
2459 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2460 return getOrCreateMethodType(Method, F);
2461 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2462 // Add "self" and "_cmd"
2463 SmallVector<llvm::Value *, 16> Elts;
2464
2465 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002466 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002467
2468 // Replace the instancetype keyword with the actual type.
2469 if (ResultTy == CGM.getContext().getObjCInstanceType())
2470 ResultTy = CGM.getContext().getPointerType(
2471 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2472
Adrian Prantl7bec9032013-05-10 21:08:31 +00002473 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002474 // "self" pointer is always first argument.
Adrian Prantlde17db32013-03-29 19:20:29 +00002475 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2476 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2477 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002478 // "_cmd" pointer is always second argument.
2479 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2480 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2481 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002482 for (const auto *PI : OMethod->params())
2483 Elts.push_back(getOrCreateType(PI->getType(), F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002484
2485 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2486 return DBuilder.createSubroutineType(F, EltTypeArray);
2487 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002488
Adrian Prantl800faef2014-02-25 23:42:18 +00002489 // Handle variadic function types; they need an additional
2490 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002491 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2492 if (FD->isVariadic()) {
2493 SmallVector<llvm::Value *, 16> EltTys;
2494 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2495 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2496 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2497 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2498 EltTys.push_back(DBuilder.createUnspecifiedParameter());
2499 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
2500 return DBuilder.createSubroutineType(F, EltTypeArray);
2501 }
2502
David Blaikie469f0792013-05-22 23:22:42 +00002503 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002504}
2505
2506/// EmitFunctionStart - Constructs the debug code for entering a function.
2507void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
2508 llvm::Function *Fn,
2509 CGBuilderTy &Builder) {
2510
2511 StringRef Name;
2512 StringRef LinkageName;
2513
2514 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2515
2516 const Decl *D = GD.getDecl();
Eric Christopher885c41b2014-04-01 22:25:28 +00002517
2518 // Use the location of the start of the function to determine where
2519 // the function definition is located. By default use the location
2520 // of the declaration as the location for the subprogram. A function
2521 // may lack a declaration in the source code if it is created by code
2522 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Guy Benyei11169dd2012-12-18 14:30:41 +00002523 bool HasDecl = (D != 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002524 SourceLocation Loc;
Eric Christopher885c41b2014-04-01 22:25:28 +00002525 if (HasDecl) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002526 Loc = D->getLocation();
2527
Eric Christopher885c41b2014-04-01 22:25:28 +00002528 // If this is a function specialization then use the pattern body
2529 // as the location for the function.
2530 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2531 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
2532 if (SpecDecl->hasBody(SpecDecl))
2533 Loc = SpecDecl->getLocation();
2534 }
2535
Guy Benyei11169dd2012-12-18 14:30:41 +00002536 unsigned Flags = 0;
2537 llvm::DIFile Unit = getOrCreateFile(Loc);
2538 llvm::DIDescriptor FDContext(Unit);
2539 llvm::DIArray TParamsArray;
2540 if (!HasDecl) {
2541 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002542 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002543 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2544 // If there is a DISubprogram for this function available then use it.
2545 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2546 FI = SPCache.find(FD->getCanonicalDecl());
2547 if (FI != SPCache.end()) {
2548 llvm::Value *V = FI->second;
2549 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2550 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2551 llvm::MDNode *SPN = SP;
2552 LexicalBlockStack.push_back(SPN);
2553 RegionMap[D] = llvm::WeakVH(SP);
2554 return;
2555 }
2556 }
2557 Name = getFunctionName(FD);
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002558 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00002559 if (FD->hasPrototype()) {
2560 LinkageName = CGM.getMangledName(GD);
2561 Flags |= llvm::DIDescriptor::FlagPrototyped;
2562 }
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002563 // No need to replicate the linkage name if it isn't different from the
2564 // subprogram name, no need to have it at all unless coverage is enabled or
2565 // debug is set to more than just line tables.
Guy Benyei11169dd2012-12-18 14:30:41 +00002566 if (LinkageName == Name ||
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002567 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2568 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher75e17682013-05-16 00:45:23 +00002569 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei11169dd2012-12-18 14:30:41 +00002570 LinkageName = StringRef();
2571
Eric Christopher75e17682013-05-16 00:45:23 +00002572 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Eric Christopher4cbd0d9d2014-03-27 05:29:34 +00002573 if (const NamespaceDecl *NSDecl =
2574 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2575 FDContext = getOrCreateNameSpace(NSDecl);
2576 else if (const RecordDecl *RDecl =
2577 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2578 FDContext = getContextDescriptor(cast<Decl>(RDecl));
2579
2580 // Collect template parameters.
Guy Benyei11169dd2012-12-18 14:30:41 +00002581 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2582 }
2583 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2584 Name = getObjCMethodName(OMD);
2585 Flags |= llvm::DIDescriptor::FlagPrototyped;
2586 } else {
2587 // Use llvm function name.
2588 Name = Fn->getName();
2589 Flags |= llvm::DIDescriptor::FlagPrototyped;
2590 }
2591 if (!Name.empty() && Name[0] == '\01')
2592 Name = Name.substr(1);
2593
2594 unsigned LineNo = getLineNumber(Loc);
2595 if (!HasDecl || D->isImplicit())
2596 Flags |= llvm::DIDescriptor::FlagArtificial;
2597
Eric Christopher8018e412014-03-27 18:50:35 +00002598 // FIXME: The function declaration we're constructing here is mostly reusing
2599 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2600 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2601 // all subprograms instead of the actual context since subprogram definitions
2602 // are emitted as CU level entities by the backend.
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002603 llvm::DISubprogram SP =
2604 DBuilder.createFunction(FDContext, Name, LinkageName, Unit, LineNo,
2605 getOrCreateFunctionType(D, FnType, Unit),
2606 Fn->hasInternalLinkage(), true /*definition*/,
2607 getLineNumber(CurLoc), Flags,
2608 CGM.getLangOpts().Optimize, Fn, TParamsArray,
2609 getFunctionDeclaration(D));
David Blaikiebd483762013-05-20 04:58:53 +00002610 if (HasDecl)
2611 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002612
Adrian Prantlbebb8932014-03-21 21:01:58 +00002613 // Push the function onto the lexical block stack.
Guy Benyei11169dd2012-12-18 14:30:41 +00002614 llvm::MDNode *SPN = SP;
2615 LexicalBlockStack.push_back(SPN);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002616
Guy Benyei11169dd2012-12-18 14:30:41 +00002617 if (HasDecl)
2618 RegionMap[D] = llvm::WeakVH(SP);
2619}
2620
2621/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl02c0caa2013-07-18 00:27:59 +00002622/// information in the source file. If the location is invalid, the
2623/// previous location will be reused.
Adrian Prantlc7822422013-03-12 20:43:25 +00002624void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
Adrian Prantle83b1302014-01-07 22:05:52 +00002625 bool ForceColumnInfo) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002626 // Update our current location
2627 setLocation(Loc);
2628
2629 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2630
2631 // Don't bother if things are the same as last time.
2632 SourceManager &SM = CGM.getContext().getSourceManager();
2633 if (CurLoc == PrevLoc ||
2634 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2635 // New Builder may not be in sync with CGDebugInfo.
David Blaikie357aafb2013-02-01 19:09:49 +00002636 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2637 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2638 LexicalBlockStack.back())
Guy Benyei11169dd2012-12-18 14:30:41 +00002639 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002640
Guy Benyei11169dd2012-12-18 14:30:41 +00002641 // Update last state.
2642 PrevLoc = CurLoc;
2643
Adrian Prantle83b1302014-01-07 22:05:52 +00002644 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantlc7822422013-03-12 20:43:25 +00002645 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2646 (getLineNumber(CurLoc),
2647 getColumnNumber(CurLoc, ForceColumnInfo),
2648 Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002649}
2650
2651/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2652/// the stack.
2653void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2654 llvm::DIDescriptor D =
2655 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2656 llvm::DIDescriptor() :
2657 llvm::DIDescriptor(LexicalBlockStack.back()),
2658 getOrCreateFile(CurLoc),
2659 getLineNumber(CurLoc),
Diego Novilloe6d398182014-03-03 18:53:32 +00002660 getColumnNumber(CurLoc),
2661 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002662 llvm::MDNode *DN = D;
2663 LexicalBlockStack.push_back(DN);
2664}
2665
2666/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2667/// region - beginning of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002668void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2669 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002670 // Set our current location.
2671 setLocation(Loc);
2672
2673 // Create a new lexical block and push it on the stack.
2674 CreateLexicalBlock(Loc);
2675
2676 // Emit a line table change for the current location inside the new scope.
2677 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2678 getColumnNumber(Loc),
2679 LexicalBlockStack.back()));
2680}
2681
2682/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2683/// region - end of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002684void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2685 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002686 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2687
2688 // Provide an entry in the line table for the end of the block.
2689 EmitLocation(Builder, Loc);
2690
2691 LexicalBlockStack.pop_back();
2692}
2693
2694/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2695void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2696 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2697 unsigned RCount = FnBeginRegionCount.back();
2698 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2699
2700 // Pop all regions for this function.
2701 while (LexicalBlockStack.size() != RCount)
2702 EmitLexicalBlockEnd(Builder, CurLoc);
2703 FnBeginRegionCount.pop_back();
2704}
2705
Eric Christopherb2a008c2013-05-16 00:45:12 +00002706// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei11169dd2012-12-18 14:30:41 +00002707// See BuildByRefType.
2708llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2709 uint64_t *XOffset) {
2710
2711 SmallVector<llvm::Value *, 5> EltTys;
2712 QualType FType;
2713 uint64_t FieldSize, FieldOffset;
2714 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002715
Guy Benyei11169dd2012-12-18 14:30:41 +00002716 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002717 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002718
2719 FieldOffset = 0;
2720 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2721 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2722 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2723 FType = CGM.getContext().IntTy;
2724 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2725 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2726
2727 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2728 if (HasCopyAndDispose) {
2729 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2730 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2731 &FieldOffset));
2732 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2733 &FieldOffset));
2734 }
2735 bool HasByrefExtendedLayout;
2736 Qualifiers::ObjCLifetime Lifetime;
2737 if (CGM.getContext().getByrefLifetime(Type,
2738 Lifetime, HasByrefExtendedLayout)
Adrian Prantlead2ba42013-07-23 00:12:14 +00002739 && HasByrefExtendedLayout) {
2740 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002741 EltTys.push_back(CreateMemberType(Unit, FType,
2742 "__byref_variable_layout",
2743 &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002744 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002745
Guy Benyei11169dd2012-12-18 14:30:41 +00002746 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2747 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002748 CGM.getTarget().getPointerAlign(0))) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002749 CharUnits FieldOffsetInBytes
Guy Benyei11169dd2012-12-18 14:30:41 +00002750 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2751 CharUnits AlignedOffsetInBytes
2752 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2753 CharUnits NumPaddingBytes
2754 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002755
Guy Benyei11169dd2012-12-18 14:30:41 +00002756 if (NumPaddingBytes.isPositive()) {
2757 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2758 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2759 pad, ArrayType::Normal, 0);
2760 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2761 }
2762 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002763
Guy Benyei11169dd2012-12-18 14:30:41 +00002764 FType = Type;
2765 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2766 FieldSize = CGM.getContext().getTypeSize(FType);
2767 FieldAlign = CGM.getContext().toBits(Align);
2768
Eric Christopherb2a008c2013-05-16 00:45:12 +00002769 *XOffset = FieldOffset;
Guy Benyei11169dd2012-12-18 14:30:41 +00002770 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2771 0, FieldSize, FieldAlign,
2772 FieldOffset, 0, FieldTy);
2773 EltTys.push_back(FieldTy);
2774 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002775
Guy Benyei11169dd2012-12-18 14:30:41 +00002776 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002777
Guy Benyei11169dd2012-12-18 14:30:41 +00002778 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002779
Guy Benyei11169dd2012-12-18 14:30:41 +00002780 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00002781 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002782}
2783
2784/// EmitDeclare - Emit local variable declaration debug info.
2785void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +00002786 llvm::Value *Storage,
Guy Benyei11169dd2012-12-18 14:30:41 +00002787 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002788 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002789 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2790
David Blaikie7fceebf2013-08-19 03:37:48 +00002791 bool Unwritten =
2792 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2793 cast<Decl>(VD->getDeclContext())->isImplicit());
2794 llvm::DIFile Unit;
2795 if (!Unwritten)
2796 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002797 llvm::DIType Ty;
2798 uint64_t XOffset = 0;
2799 if (VD->hasAttr<BlocksAttr>())
2800 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002801 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002802 Ty = getOrCreateType(VD->getType(), Unit);
2803
2804 // If there is no debug info for this type then do not emit debug info
2805 // for this variable.
2806 if (!Ty)
2807 return;
2808
Guy Benyei11169dd2012-12-18 14:30:41 +00002809 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002810 unsigned Line = 0;
2811 unsigned Column = 0;
2812 if (!Unwritten) {
2813 Line = getLineNumber(VD->getLocation());
2814 Column = getColumnNumber(VD->getLocation());
2815 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002816 unsigned Flags = 0;
2817 if (VD->isImplicit())
2818 Flags |= llvm::DIDescriptor::FlagArtificial;
2819 // If this is the first argument and it is implicit then
2820 // give it an object pointer flag.
2821 // FIXME: There has to be a better way to do this, but for static
2822 // functions there won't be an implicit param at arg1 and
2823 // otherwise it is 'self' or 'this'.
2824 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2825 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002826 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002827 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2828 !VD->getType()->isPointerType())
David Blaikieb9c667d2013-06-19 21:53:53 +00002829 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
Guy Benyei11169dd2012-12-18 14:30:41 +00002830
2831 llvm::MDNode *Scope = LexicalBlockStack.back();
2832
2833 StringRef Name = VD->getName();
2834 if (!Name.empty()) {
2835 if (VD->hasAttr<BlocksAttr>()) {
2836 CharUnits offset = CharUnits::fromQuantity(32);
2837 SmallVector<llvm::Value *, 9> addr;
2838 llvm::Type *Int64Ty = CGM.Int64Ty;
2839 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2840 // offset of __forwarding field
2841 offset = CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002842 CGM.getTarget().getPointerWidth(0));
Guy Benyei11169dd2012-12-18 14:30:41 +00002843 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2844 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2845 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2846 // offset of x field
2847 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2848 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2849
2850 // Create the descriptor for the variable.
2851 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002852 DBuilder.createComplexVariable(Tag,
Guy Benyei11169dd2012-12-18 14:30:41 +00002853 llvm::DIDescriptor(Scope),
2854 VD->getName(), Unit, Line, Ty,
2855 addr, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002856
Guy Benyei11169dd2012-12-18 14:30:41 +00002857 // Insert an llvm.dbg.declare into the current block.
2858 llvm::Instruction *Call =
2859 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2860 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2861 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00002862 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl0315f382013-09-18 22:08:57 +00002863 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
David Blaikiea76a7c92013-01-05 05:58:35 +00002864 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2865 // If VD is an anonymous union then Storage represents value for
2866 // all union fields.
Guy Benyei11169dd2012-12-18 14:30:41 +00002867 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikie219c7d92013-01-05 20:03:07 +00002868 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002869 for (const auto *Field : RD->fields()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002870 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2871 StringRef FieldName = Field->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002872
Guy Benyei11169dd2012-12-18 14:30:41 +00002873 // Ignore unnamed fields. Do not ignore unnamed records.
2874 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2875 continue;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002876
Guy Benyei11169dd2012-12-18 14:30:41 +00002877 // Use VarDecl's Tag, Scope and Line number.
2878 llvm::DIVariable D =
2879 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopherb2a008c2013-05-16 00:45:12 +00002880 FieldName, Unit, Line, FieldTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00002881 CGM.getLangOpts().Optimize, Flags,
2882 ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002883
Guy Benyei11169dd2012-12-18 14:30:41 +00002884 // Insert an llvm.dbg.declare into the current block.
2885 llvm::Instruction *Call =
2886 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2887 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2888 }
David Blaikie219c7d92013-01-05 20:03:07 +00002889 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002890 }
2891 }
David Blaikiea76a7c92013-01-05 05:58:35 +00002892
2893 // Create the descriptor for the variable.
2894 llvm::DIVariable D =
2895 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2896 Name, Unit, Line, Ty,
2897 CGM.getLangOpts().Optimize, Flags, ArgNo);
2898
2899 // Insert an llvm.dbg.declare into the current block.
2900 llvm::Instruction *Call =
2901 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2902 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002903}
2904
2905void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2906 llvm::Value *Storage,
2907 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002908 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002909 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2910}
2911
Adrian Prantlde17db32013-03-29 19:20:29 +00002912/// Look up the completed type for a self pointer in the TypeCache and
2913/// create a copy of it with the ObjectPointer and Artificial flags
2914/// set. If the type is not cached, a new one is created. This should
2915/// never happen though, since creating a type for the implicit self
2916/// argument implies that we already parsed the interface definition
2917/// and the ivar declarations in the implementation.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002918llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2919 llvm::DIType Ty) {
Adrian Prantlde17db32013-03-29 19:20:29 +00002920 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002921 if (CachedTy) Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00002922 else DEBUG(llvm::dbgs() << "No cached type for self.");
2923 return DBuilder.createObjectPointerType(Ty);
2924}
2925
Guy Benyei11169dd2012-12-18 14:30:41 +00002926void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2927 llvm::Value *Storage,
2928 CGBuilderTy &Builder,
2929 const CGBlockInfo &blockInfo) {
Eric Christopher75e17682013-05-16 00:45:23 +00002930 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002931 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00002932
Guy Benyei11169dd2012-12-18 14:30:41 +00002933 if (Builder.GetInsertBlock() == 0)
2934 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002935
Guy Benyei11169dd2012-12-18 14:30:41 +00002936 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002937
Guy Benyei11169dd2012-12-18 14:30:41 +00002938 uint64_t XOffset = 0;
2939 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2940 llvm::DIType Ty;
2941 if (isByRef)
2942 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002943 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002944 Ty = getOrCreateType(VD->getType(), Unit);
2945
2946 // Self is passed along as an implicit non-arg variable in a
2947 // block. Mark it as the object pointer.
2948 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00002949 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002950
2951 // Get location information.
2952 unsigned Line = getLineNumber(VD->getLocation());
2953 unsigned Column = getColumnNumber(VD->getLocation());
2954
2955 const llvm::DataLayout &target = CGM.getDataLayout();
2956
2957 CharUnits offset = CharUnits::fromQuantity(
2958 target.getStructLayout(blockInfo.StructureType)
2959 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2960
2961 SmallVector<llvm::Value *, 9> addr;
2962 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl0f6df002013-03-29 19:20:35 +00002963 if (isa<llvm::AllocaInst>(Storage))
2964 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei11169dd2012-12-18 14:30:41 +00002965 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2966 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2967 if (isByRef) {
2968 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2969 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2970 // offset of __forwarding field
2971 offset = CGM.getContext()
2972 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2973 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2974 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2975 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2976 // offset of x field
2977 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2978 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2979 }
2980
2981 // Create the descriptor for the variable.
2982 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002983 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei11169dd2012-12-18 14:30:41 +00002984 llvm::DIDescriptor(LexicalBlockStack.back()),
2985 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl0f6df002013-03-29 19:20:35 +00002986
Guy Benyei11169dd2012-12-18 14:30:41 +00002987 // Insert an llvm.dbg.declare into the current block.
2988 llvm::Instruction *Call =
2989 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2990 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2991 LexicalBlockStack.back()));
2992}
2993
2994/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2995/// variable declaration.
2996void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2997 unsigned ArgNo,
2998 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002999 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003000 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
3001}
3002
3003namespace {
3004 struct BlockLayoutChunk {
3005 uint64_t OffsetInBits;
3006 const BlockDecl::Capture *Capture;
3007 };
3008 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3009 return l.OffsetInBits < r.OffsetInBits;
3010 }
3011}
3012
3013void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003014 llvm::Value *Arg,
3015 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003016 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003017 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003018 ASTContext &C = CGM.getContext();
3019 const BlockDecl *blockDecl = block.getBlockDecl();
3020
3021 // Collect some general information about the block's location.
3022 SourceLocation loc = blockDecl->getCaretLocation();
3023 llvm::DIFile tunit = getOrCreateFile(loc);
3024 unsigned line = getLineNumber(loc);
3025 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003026
Guy Benyei11169dd2012-12-18 14:30:41 +00003027 // Build the debug-info type for the block literal.
3028 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
3029
3030 const llvm::StructLayout *blockLayout =
3031 CGM.getDataLayout().getStructLayout(block.StructureType);
3032
3033 SmallVector<llvm::Value*, 16> fields;
3034 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
3035 blockLayout->getElementOffsetInBits(0),
3036 tunit, tunit));
3037 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
3038 blockLayout->getElementOffsetInBits(1),
3039 tunit, tunit));
3040 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
3041 blockLayout->getElementOffsetInBits(2),
3042 tunit, tunit));
3043 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
3044 blockLayout->getElementOffsetInBits(3),
3045 tunit, tunit));
3046 fields.push_back(createFieldType("__descriptor",
3047 C.getPointerType(block.NeedsCopyDispose ?
3048 C.getBlockDescriptorExtendedType() :
3049 C.getBlockDescriptorType()),
3050 0, loc, AS_public,
3051 blockLayout->getElementOffsetInBits(4),
3052 tunit, tunit));
3053
3054 // We want to sort the captures by offset, not because DWARF
3055 // requires this, but because we're paranoid about debuggers.
3056 SmallVector<BlockLayoutChunk, 8> chunks;
3057
3058 // 'this' capture.
3059 if (blockDecl->capturesCXXThis()) {
3060 BlockLayoutChunk chunk;
3061 chunk.OffsetInBits =
3062 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
3063 chunk.Capture = 0;
3064 chunks.push_back(chunk);
3065 }
3066
3067 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003068 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003069 const VarDecl *variable = capture.getVariable();
3070 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3071
3072 // Ignore constant captures.
3073 if (captureInfo.isConstant())
3074 continue;
3075
3076 BlockLayoutChunk chunk;
3077 chunk.OffsetInBits =
3078 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
3079 chunk.Capture = &capture;
3080 chunks.push_back(chunk);
3081 }
3082
3083 // Sort by offset.
3084 llvm::array_pod_sort(chunks.begin(), chunks.end());
3085
3086 for (SmallVectorImpl<BlockLayoutChunk>::iterator
3087 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
3088 uint64_t offsetInBits = i->OffsetInBits;
3089 const BlockDecl::Capture *capture = i->Capture;
3090
3091 // If we have a null capture, this must be the C++ 'this' capture.
3092 if (!capture) {
3093 const CXXMethodDecl *method =
3094 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
3095 QualType type = method->getThisType(C);
3096
3097 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3098 offsetInBits, tunit, tunit));
3099 continue;
3100 }
3101
3102 const VarDecl *variable = capture->getVariable();
3103 StringRef name = variable->getName();
3104
3105 llvm::DIType fieldType;
3106 if (capture->isByRef()) {
3107 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
3108
3109 // FIXME: this creates a second copy of this type!
3110 uint64_t xoffset;
3111 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
3112 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
3113 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3114 ptrInfo.first, ptrInfo.second,
3115 offsetInBits, 0, fieldType);
3116 } else {
3117 fieldType = createFieldType(name, variable->getType(), 0,
3118 loc, AS_public, offsetInBits, tunit, tunit);
3119 }
3120 fields.push_back(fieldType);
3121 }
3122
3123 SmallString<36> typeName;
3124 llvm::raw_svector_ostream(typeName)
3125 << "__block_literal_" << CGM.getUniqueBlockCount();
3126
3127 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3128
3129 llvm::DIType type =
3130 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3131 CGM.getContext().toBits(block.BlockSize),
3132 CGM.getContext().toBits(block.BlockAlign),
David Blaikie6d4fe152013-02-25 01:07:08 +00003133 0, llvm::DIType(), fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003134 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3135
3136 // Get overall information about the block.
3137 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3138 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei11169dd2012-12-18 14:30:41 +00003139
3140 // Create the descriptor for the parameter.
3141 llvm::DIVariable debugVar =
3142 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopherb2a008c2013-05-16 00:45:12 +00003143 llvm::DIDescriptor(scope),
Adrian Prantl51936dd2013-03-14 17:53:33 +00003144 Arg->getName(), tunit, line, type,
Guy Benyei11169dd2012-12-18 14:30:41 +00003145 CGM.getLangOpts().Optimize, flags,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003146 cast<llvm::Argument>(Arg)->getArgNo() + 1);
3147
Adrian Prantl616bef42013-03-14 21:52:59 +00003148 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003149 // Insert an llvm.dbg.value into the current block.
Adrian Prantl616bef42013-03-14 21:52:59 +00003150 llvm::Instruction *DbgVal =
3151 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00003152 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003153 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3154 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003155
Adrian Prantl616bef42013-03-14 21:52:59 +00003156 // Insert an llvm.dbg.declare into the current block.
3157 llvm::Instruction *DbgDecl =
3158 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
3159 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003160}
3161
David Blaikie6943dea2013-08-20 01:28:15 +00003162/// If D is an out-of-class definition of a static data member of a class, find
3163/// its corresponding in-class declaration.
3164llvm::DIDerivedType
3165CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3166 if (!D->isStaticDataMember())
3167 return llvm::DIDerivedType();
3168 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
3169 StaticDataMemberCache.find(D->getCanonicalDecl());
3170 if (MI != StaticDataMemberCache.end()) {
3171 assert(MI->second && "Static data member declaration should still exist");
3172 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003173 }
David Blaikiece763042013-08-20 21:49:21 +00003174
3175 // If the member wasn't found in the cache, lazily construct and add it to the
3176 // type (used when a limited form of the type is emitted).
David Blaikie6943dea2013-08-20 01:28:15 +00003177 llvm::DICompositeType Ctxt(
3178 getContextDescriptor(cast<Decl>(D->getDeclContext())));
3179 llvm::DIDerivedType T = CreateRecordStaticField(D, Ctxt);
David Blaikie6943dea2013-08-20 01:28:15 +00003180 return T;
3181}
3182
Eric Christophercab9fae2014-04-10 05:20:00 +00003183/// Recursively collect all of the member fields of a global anonymous decl and
3184/// create static variables for them. The first time this is called it needs
3185/// to be on a union and then from there we can have additional unnamed fields.
3186llvm::DIGlobalVariable
3187CGDebugInfo::CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile Unit,
3188 unsigned LineNo, StringRef LinkageName,
3189 llvm::GlobalVariable *Var,
3190 llvm::DIDescriptor DContext) {
3191 llvm::DIGlobalVariable GV;
3192
3193 for (const auto *Field : RD->fields()) {
3194 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
3195 StringRef FieldName = Field->getName();
3196
3197 // Ignore unnamed fields, but recurse into anonymous records.
3198 if (FieldName.empty()) {
3199 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3200 if (RT)
3201 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3202 Var, DContext);
3203 continue;
3204 }
3205 // Use VarDecl's Tag, Scope and Line number.
3206 GV = DBuilder.createStaticVariable(DContext, FieldName, LinkageName, Unit,
3207 LineNo, FieldTy,
3208 Var->hasInternalLinkage(), Var,
3209 llvm::DIDerivedType());
3210 }
3211 return GV;
3212}
3213
Guy Benyei11169dd2012-12-18 14:30:41 +00003214/// EmitGlobalVariable - Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003215void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003216 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003217 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003218 // Create global variable debug descriptor.
3219 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
3220 unsigned LineNo = getLineNumber(D->getLocation());
3221
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003222 setLocation(D->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00003223
3224 QualType T = D->getType();
3225 if (T->isIncompleteArrayType()) {
3226
3227 // CodeGen turns int[] into int[1] so we'll do the same here.
3228 llvm::APInt ConstVal(32, 1);
3229 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3230
3231 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3232 ArrayType::Normal, 0);
3233 }
Eric Christophercab9fae2014-04-10 05:20:00 +00003234
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003235 StringRef DeclName = D->getName();
3236 StringRef LinkageName;
Eric Christophercab9fae2014-04-10 05:20:00 +00003237 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext()) &&
3238 !isa<ObjCMethodDecl>(D->getDeclContext()))
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003239 LinkageName = Var->getName();
3240 if (LinkageName == DeclName)
3241 LinkageName = StringRef();
Eric Christophercab9fae2014-04-10 05:20:00 +00003242
Eric Christopherb2a008c2013-05-16 00:45:12 +00003243 llvm::DIDescriptor DContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00003244 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
Eric Christophercab9fae2014-04-10 05:20:00 +00003245
3246 // Attempt to store one global variable for the declaration - even if we
3247 // emit a lot of fields.
3248 llvm::DIGlobalVariable GV;
3249
3250 // If this is an anonymous union then we'll want to emit a global
3251 // variable for each member of the anonymous union so that it's possible
3252 // to find the name of any field in the union.
3253 if (T->isUnionType() && DeclName.empty()) {
3254 const RecordDecl *RD = cast<RecordType>(T)->getDecl();
3255 assert(RD->isAnonymousStructOrUnion() && "unnamed non-anonymous struct or union?");
3256 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3257 } else {
3258 GV = DBuilder.createStaticVariable(
3259 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3260 Var->hasInternalLinkage(), Var,
3261 getOrCreateStaticDataMemberDeclarationOrNull(D));
3262 }
David Blaikiebd483762013-05-20 04:58:53 +00003263 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003264}
3265
3266/// EmitGlobalVariable - Emit information about an objective-c interface.
3267void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3268 ObjCInterfaceDecl *ID) {
Eric Christopher75e17682013-05-16 00:45:23 +00003269 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003270 // Create global variable debug descriptor.
3271 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
3272 unsigned LineNo = getLineNumber(ID->getLocation());
3273
3274 StringRef Name = ID->getName();
3275
3276 QualType T = CGM.getContext().getObjCInterfaceType(ID);
3277 if (T->isIncompleteArrayType()) {
3278
3279 // CodeGen turns int[] into int[1] so we'll do the same here.
3280 llvm::APInt ConstVal(32, 1);
3281 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3282
3283 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3284 ArrayType::Normal, 0);
3285 }
3286
3287 DBuilder.createGlobalVariable(Name, Unit, LineNo,
3288 getOrCreateType(T, Unit),
3289 Var->hasInternalLinkage(), Var);
3290}
3291
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003292/// EmitGlobalVariable - Emit global variable's debug info.
3293void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3294 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003295 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003296 // Create the descriptor for the variable.
3297 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3298 StringRef Name = VD->getName();
3299 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3300 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3301 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3302 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3303 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3304 }
3305 // Do not use DIGlobalVariable for enums.
3306 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3307 return;
David Blaikiea15565562014-04-04 20:56:17 +00003308 // Do not emit separate definitions for function local const/statics.
3309 if (isa<FunctionDecl>(VD->getDeclContext()))
3310 return;
David Blaikiebb113912014-04-05 07:23:17 +00003311 VD = cast<ValueDecl>(VD->getCanonicalDecl());
3312 auto pair = DeclCache.insert(std::make_pair(VD, llvm::WeakVH()));
3313 if (!pair.second)
3314 return;
David Blaikie506a7452014-04-05 07:46:57 +00003315 llvm::DIDescriptor DContext =
3316 getContextDescriptor(dyn_cast<Decl>(VD->getDeclContext()));
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003317 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003318 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
3319 true, Init,
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003320 getOrCreateStaticDataMemberDeclarationOrNull(cast<VarDecl>(VD)));
David Blaikiebb113912014-04-05 07:23:17 +00003321 pair.first->second = llvm::WeakVH(GV);
David Blaikiebd483762013-05-20 04:58:53 +00003322}
3323
3324llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3325 if (!LexicalBlockStack.empty())
3326 return llvm::DIScope(LexicalBlockStack.back());
3327 return getContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003328}
3329
David Blaikie9f88fe82013-04-22 06:13:21 +00003330void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003331 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3332 return;
David Blaikie9f88fe82013-04-22 06:13:21 +00003333 DBuilder.createImportedModule(
David Blaikiebd483762013-05-20 04:58:53 +00003334 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3335 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie9f88fe82013-04-22 06:13:21 +00003336 getLineNumber(UD.getLocation()));
3337}
3338
David Blaikiebd483762013-05-20 04:58:53 +00003339void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3340 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3341 return;
3342 assert(UD.shadow_size() &&
3343 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3344 // Emitting one decl is sufficient - debuggers can detect that this is an
3345 // overloaded name & provide lookup for all the overloads.
3346 const UsingShadowDecl &USD = **UD.shadow_begin();
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00003347 if (llvm::DIScope Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003348 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003349 DBuilder.createImportedDeclaration(
3350 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3351 getLineNumber(USD.getLocation()));
3352}
3353
David Blaikief121b932013-05-20 22:50:41 +00003354llvm::DIImportedEntity
3355CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3356 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3357 return llvm::DIImportedEntity(0);
3358 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3359 if (VH)
3360 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
3361 llvm::DIImportedEntity R(0);
3362 if (const NamespaceAliasDecl *Underlying =
3363 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3364 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003365 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003366 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3367 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3368 NA.getName());
3369 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003370 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003371 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3372 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3373 getLineNumber(NA.getLocation()), NA.getName());
3374 VH = R;
3375 return R;
3376}
3377
Guy Benyei11169dd2012-12-18 14:30:41 +00003378/// getOrCreateNamesSpace - Return namespace descriptor for the given
3379/// namespace decl.
Eric Christopherb2a008c2013-05-16 00:45:12 +00003380llvm::DINameSpace
Guy Benyei11169dd2012-12-18 14:30:41 +00003381CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003382 NSDecl = NSDecl->getCanonicalDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003383 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei11169dd2012-12-18 14:30:41 +00003384 NameSpaceCache.find(NSDecl);
3385 if (I != NameSpaceCache.end())
3386 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003387
Guy Benyei11169dd2012-12-18 14:30:41 +00003388 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3389 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003390 llvm::DIDescriptor Context =
Guy Benyei11169dd2012-12-18 14:30:41 +00003391 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3392 llvm::DINameSpace NS =
3393 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3394 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3395 return NS;
3396}
3397
3398void CGDebugInfo::finalize() {
3399 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
3400 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
3401 llvm::DIType Ty, RepTy;
3402 // Verify that the debug info still exists.
3403 if (llvm::Value *V = VI->second)
3404 Ty = llvm::DIType(cast<llvm::MDNode>(V));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003405
Guy Benyei11169dd2012-12-18 14:30:41 +00003406 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
3407 TypeCache.find(VI->first);
3408 if (it != TypeCache.end()) {
3409 // Verify that the debug info still exists.
3410 if (llvm::Value *V = it->second)
3411 RepTy = llvm::DIType(cast<llvm::MDNode>(V));
3412 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003413
Eric Christopherf8bc4d82013-07-18 00:52:50 +00003414 if (Ty && Ty.isForwardDecl() && RepTy)
Guy Benyei11169dd2012-12-18 14:30:41 +00003415 Ty.replaceAllUsesWith(RepTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003416 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003417
3418 // We keep our own list of retained types, because we need to look
3419 // up the final type in the type cache.
3420 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3421 RE = RetainedTypes.end(); RI != RE; ++RI)
David Blaikie0856f662014-03-04 22:01:08 +00003422 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003423
Guy Benyei11169dd2012-12-18 14:30:41 +00003424 DBuilder.finalize();
3425}