blob: d0861507bcd7aa6b650271b7e5bf51051e774c6e [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();
David Blaikieaabde052014-05-14 00:29:00 +0000115 llvm::DIScope Scope(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000116 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000117
David Blaikieaabde052014-05-14 00:29:00 +0000118 if (PCLoc.isInvalid() || Scope.getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000119 return;
120
Guy Benyei11169dd2012-12-18 14:30:41 +0000121 if (Scope.isLexicalBlockFile()) {
David Blaikieaabde052014-05-14 00:29:00 +0000122 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(Scope);
Guy Benyei11169dd2012-12-18 14:30:41 +0000123 llvm::DIDescriptor D
124 = DBuilder.createLexicalBlockFile(LBF.getScope(),
125 getOrCreateFile(CurLoc));
126 llvm::MDNode *N = D;
127 LexicalBlockStack.pop_back();
128 LexicalBlockStack.push_back(N);
David Blaikie0a21d0d2013-01-26 22:16:26 +0000129 } else if (Scope.isLexicalBlock() || Scope.isSubprogram()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000130 llvm::DIDescriptor D
131 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
132 llvm::MDNode *N = D;
133 LexicalBlockStack.pop_back();
134 LexicalBlockStack.push_back(N);
135 }
136}
137
138/// getContextDescriptor - Get context info for the decl.
David Blaikiebfa52742013-04-19 06:56:38 +0000139llvm::DIScope CGDebugInfo::getContextDescriptor(const Decl *Context) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000140 if (!Context)
141 return TheCU;
142
143 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
144 I = RegionMap.find(Context);
145 if (I != RegionMap.end()) {
146 llvm::Value *V = I->second;
David Blaikiebfa52742013-04-19 06:56:38 +0000147 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
Guy Benyei11169dd2012-12-18 14:30:41 +0000148 }
149
150 // Check namespace.
151 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000152 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000153
David Blaikiebfa52742013-04-19 06:56:38 +0000154 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
155 if (!RDecl->isDependentType())
156 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Guy Benyei11169dd2012-12-18 14:30:41 +0000157 getOrCreateMainFile());
Guy Benyei11169dd2012-12-18 14:30:41 +0000158 return TheCU;
159}
160
161/// getFunctionName - Get function name for the given FunctionDecl. If the
Benjamin Kramer60509af2013-09-09 14:48:42 +0000162/// name is constructed on demand (e.g. C++ destructor) then the name
Guy Benyei11169dd2012-12-18 14:30:41 +0000163/// is stored on the side.
164StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
165 assert (FD && "Invalid FunctionDecl!");
166 IdentifierInfo *FII = FD->getIdentifier();
167 FunctionTemplateSpecializationInfo *Info
168 = FD->getTemplateSpecializationInfo();
169 if (!Info && FII)
170 return FII->getName();
171
172 // Otherwise construct human readable name for debug info.
Benjamin Kramer9170e912013-02-22 15:46:01 +0000173 SmallString<128> NS;
174 llvm::raw_svector_ostream OS(NS);
175 FD->printName(OS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000176
177 // Add any template specialization args.
178 if (Info) {
179 const TemplateArgumentList *TArgs = Info->TemplateArguments;
180 const TemplateArgument *Args = TArgs->data();
181 unsigned NumArgs = TArgs->size();
182 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer9170e912013-02-22 15:46:01 +0000183 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
184 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000185 }
186
187 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000188 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000189}
190
191StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
192 SmallString<256> MethodName;
193 llvm::raw_svector_ostream OS(MethodName);
194 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
195 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000196 if (const ObjCImplementationDecl *OID =
Guy Benyei11169dd2012-12-18 14:30:41 +0000197 dyn_cast<const ObjCImplementationDecl>(DC)) {
198 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000199 } else if (const ObjCInterfaceDecl *OID =
Guy Benyei11169dd2012-12-18 14:30:41 +0000200 dyn_cast<const ObjCInterfaceDecl>(DC)) {
201 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000202 } else if (const ObjCCategoryImplDecl *OCD =
Guy Benyei11169dd2012-12-18 14:30:41 +0000203 dyn_cast<const ObjCCategoryImplDecl>(DC)){
204 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
205 OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000206 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000207 // We can extract the type of the class from the self pointer.
208 if (ImplicitParamDecl* SelfDecl = OMD->getSelfDecl()) {
209 QualType ClassTy =
210 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
211 ClassTy.print(OS, PrintingPolicy(LangOptions()));
212 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000213 }
214 OS << ' ' << OMD->getSelector().getAsString() << ']';
215
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000216 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000217}
218
219/// getSelectorName - Return selector name. This is used for debugging
220/// info.
221StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000222 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000223}
224
225/// getClassName - Get class name including template argument list.
Eric Christopherb2a008c2013-05-16 00:45:12 +0000226StringRef
Guy Benyei11169dd2012-12-18 14:30:41 +0000227CGDebugInfo::getClassName(const RecordDecl *RD) {
David Blaikie65813a32014-04-02 18:21:09 +0000228 // quick optimization to avoid having to intern strings that are already
229 // stored reliably elsewhere
230 if (!isa<ClassTemplateSpecializationDecl>(RD))
Guy Benyei11169dd2012-12-18 14:30:41 +0000231 return RD->getName();
232
David Blaikie65813a32014-04-02 18:21:09 +0000233 SmallString<128> Name;
Benjamin Kramer9170e912013-02-22 15:46:01 +0000234 {
David Blaikie65813a32014-04-02 18:21:09 +0000235 llvm::raw_svector_ostream OS(Name);
236 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
237 /*Qualified*/ false);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000238 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000239
240 // Copy this name on the side and use its reference.
David Blaikie65813a32014-04-02 18:21:09 +0000241 return internString(Name);
Guy Benyei11169dd2012-12-18 14:30:41 +0000242}
243
244/// getOrCreateFile - Get the file debug info descriptor for the input location.
245llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
246 if (!Loc.isValid())
247 // If Location is not valid then use main input file.
248 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
249
250 SourceManager &SM = CGM.getContext().getSourceManager();
251 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
252
253 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
254 // If the location is not valid then use main input file.
255 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
256
257 // Cache the results.
258 const char *fname = PLoc.getFilename();
259 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
260 DIFileCache.find(fname);
261
262 if (it != DIFileCache.end()) {
263 // Verify that the information still exists.
264 if (llvm::Value *V = it->second)
265 return llvm::DIFile(cast<llvm::MDNode>(V));
266 }
267
268 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
269
270 DIFileCache[fname] = F;
271 return F;
272}
273
274/// getOrCreateMainFile - Get the file info for main compile unit.
275llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
276 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
277}
278
279/// getLineNumber - Get line number for the location. If location is invalid
280/// then use current location.
281unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
282 if (Loc.isInvalid() && CurLoc.isInvalid())
283 return 0;
284 SourceManager &SM = CGM.getContext().getSourceManager();
285 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
286 return PLoc.isValid()? PLoc.getLine() : 0;
287}
288
289/// getColumnNumber - Get column number for the location.
Adrian Prantlc7822422013-03-12 20:43:25 +0000290unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000291 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000292 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000293 return 0;
294
295 // If the location is invalid then use the current column.
296 if (Loc.isInvalid() && CurLoc.isInvalid())
297 return 0;
298 SourceManager &SM = CGM.getContext().getSourceManager();
299 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
300 return PLoc.isValid()? PLoc.getColumn() : 0;
301}
302
303StringRef CGDebugInfo::getCurrentDirname() {
304 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
305 return CGM.getCodeGenOpts().DebugCompilationDir;
306
307 if (!CWDName.empty())
308 return CWDName;
309 SmallString<256> CWD;
310 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000311 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000312}
313
314/// CreateCompileUnit - Create new compile unit.
315void CGDebugInfo::CreateCompileUnit() {
316
David Blaikieaabde052014-05-14 00:29:00 +0000317 // Should we be asking the SourceManager for the main file name, instead of
318 // accepting it as an argument? This just causes the main file name to
319 // mismatch with source locations and create extra lexical scopes or
320 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
321 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
322 // because that's what the SourceManager says)
323
Guy Benyei11169dd2012-12-18 14:30:41 +0000324 // Get absolute path name.
325 SourceManager &SM = CGM.getContext().getSourceManager();
326 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
327 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000328 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000329
330 // The main file name provided via the "-main-file-name" option contains just
331 // the file name itself with no path information. This file name may have had
332 // a relative path, so we look into the actual file entry for the main
333 // file to determine the real absolute path for the file.
334 std::string MainFileDir;
335 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
336 MainFileDir = MainFile->getDir()->getName();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000337 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000338 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
339 llvm::sys::path::append(MainFileDirSS, MainFileName);
340 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000341 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000342 }
343
344 // Save filename string.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000345 StringRef Filename = internString(MainFileName);
Eric Christopherf1545832013-02-22 23:50:16 +0000346
347 // Save split dwarf file string.
348 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000349 StringRef SplitDwarfFilename = internString(SplitDwarfFile);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000350
Ed Masteda706022014-05-07 12:49:30 +0000351 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000352 const LangOptions &LO = CGM.getLangOpts();
353 if (LO.CPlusPlus) {
354 if (LO.ObjC1)
355 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
356 else
357 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
358 } else if (LO.ObjC1) {
359 LangTag = llvm::dwarf::DW_LANG_ObjC;
360 } else if (LO.C99) {
361 LangTag = llvm::dwarf::DW_LANG_C99;
362 } else {
363 LangTag = llvm::dwarf::DW_LANG_C89;
364 }
365
366 std::string Producer = getClangFullVersion();
367
368 // Figure out which version of the ObjC runtime we have.
369 unsigned RuntimeVers = 0;
370 if (LO.ObjC1)
371 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
372
373 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000374 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000375 TheCU = DBuilder.createCompileUnit(
376 LangTag, Filename, getCurrentDirname(), Producer, LO.Optimize,
377 CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers, SplitDwarfFilename,
378 DebugKind == CodeGenOptions::DebugLineTablesOnly
379 ? llvm::DIBuilder::LineTablesOnly
380 : llvm::DIBuilder::FullDebug);
Guy Benyei11169dd2012-12-18 14:30:41 +0000381}
382
383/// CreateType - Get the Basic type from the cache or create a new
384/// one if necessary.
385llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000386 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000387 StringRef BTName;
388 switch (BT->getKind()) {
389#define BUILTIN_TYPE(Id, SingletonId)
390#define PLACEHOLDER_TYPE(Id, SingletonId) \
391 case BuiltinType::Id:
392#include "clang/AST/BuiltinTypes.def"
393 case BuiltinType::Dependent:
394 llvm_unreachable("Unexpected builtin type");
395 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000396 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000397 case BuiltinType::Void:
398 return llvm::DIType();
399 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000400 if (!ClassTy)
401 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
402 "objc_class", TheCU,
403 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000404 return ClassTy;
405 case BuiltinType::ObjCId: {
406 // typedef struct objc_class *Class;
407 // typedef struct objc_object {
408 // Class isa;
409 // } *id;
410
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000411 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000412 return ObjTy;
413
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000414 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000415 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
416 "objc_class", TheCU,
417 getOrCreateMainFile(), 0);
418
419 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000420
Guy Benyei11169dd2012-12-18 14:30:41 +0000421 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
422
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000423 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000424 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
425 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000426
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000427 ObjTy.setTypeArray(DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
428 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000429 return ObjTy;
430 }
431 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000432 if (!SelTy)
433 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
434 "objc_selector", TheCU,
435 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 return SelTy;
437 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000438
439 case BuiltinType::OCLImage1d:
440 return getOrCreateStructPtrType("opencl_image1d_t",
441 OCLImage1dDITy);
442 case BuiltinType::OCLImage1dArray:
Eric Christopherb2a008c2013-05-16 00:45:12 +0000443 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000444 OCLImage1dArrayDITy);
445 case BuiltinType::OCLImage1dBuffer:
446 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
447 OCLImage1dBufferDITy);
448 case BuiltinType::OCLImage2d:
449 return getOrCreateStructPtrType("opencl_image2d_t",
450 OCLImage2dDITy);
451 case BuiltinType::OCLImage2dArray:
452 return getOrCreateStructPtrType("opencl_image2d_array_t",
453 OCLImage2dArrayDITy);
454 case BuiltinType::OCLImage3d:
455 return getOrCreateStructPtrType("opencl_image3d_t",
456 OCLImage3dDITy);
Guy Benyei61054192013-02-07 10:55:47 +0000457 case BuiltinType::OCLSampler:
458 return DBuilder.createBasicType("opencl_sampler_t",
459 CGM.getContext().getTypeSize(BT),
460 CGM.getContext().getTypeAlign(BT),
461 llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000462 case BuiltinType::OCLEvent:
463 return getOrCreateStructPtrType("opencl_event_t",
464 OCLEventDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000465
Guy Benyei11169dd2012-12-18 14:30:41 +0000466 case BuiltinType::UChar:
467 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
468 case BuiltinType::Char_S:
469 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
470 case BuiltinType::Char16:
471 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
472 case BuiltinType::UShort:
473 case BuiltinType::UInt:
474 case BuiltinType::UInt128:
475 case BuiltinType::ULong:
476 case BuiltinType::WChar_U:
477 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
478 case BuiltinType::Short:
479 case BuiltinType::Int:
480 case BuiltinType::Int128:
481 case BuiltinType::Long:
482 case BuiltinType::WChar_S:
483 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
484 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
485 case BuiltinType::Half:
486 case BuiltinType::Float:
487 case BuiltinType::LongDouble:
488 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
489 }
490
491 switch (BT->getKind()) {
492 case BuiltinType::Long: BTName = "long int"; break;
493 case BuiltinType::LongLong: BTName = "long long int"; break;
494 case BuiltinType::ULong: BTName = "long unsigned int"; break;
495 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
496 default:
497 BTName = BT->getName(CGM.getLangOpts());
498 break;
499 }
500 // Bit size, align and offset of the type.
501 uint64_t Size = CGM.getContext().getTypeSize(BT);
502 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000503 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +0000504 DBuilder.createBasicType(BTName, Size, Align, Encoding);
505 return DbgTy;
506}
507
508llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
509 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000510 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000511 if (Ty->isComplexIntegerType())
512 Encoding = llvm::dwarf::DW_ATE_lo_user;
513
514 uint64_t Size = CGM.getContext().getTypeSize(Ty);
515 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000516 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +0000517 DBuilder.createBasicType("complex", Size, Align, Encoding);
518
519 return DbgTy;
520}
521
522/// CreateCVRType - Get the qualified type from the cache or create
523/// a new one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +0000524llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000525 QualifierCollector Qc;
526 const Type *T = Qc.strip(Ty);
527
528 // Ignore these qualifiers for now.
529 Qc.removeObjCGCAttr();
530 Qc.removeAddressSpace();
531 Qc.removeObjCLifetime();
532
533 // We will create one Derived type for one qualifier and recurse to handle any
534 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000535 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000536 if (Qc.hasConst()) {
537 Tag = llvm::dwarf::DW_TAG_const_type;
538 Qc.removeConst();
539 } else if (Qc.hasVolatile()) {
540 Tag = llvm::dwarf::DW_TAG_volatile_type;
541 Qc.removeVolatile();
542 } else if (Qc.hasRestrict()) {
543 Tag = llvm::dwarf::DW_TAG_restrict_type;
544 Qc.removeRestrict();
545 } else {
546 assert(Qc.empty() && "Unknown type qualifier for debug info");
547 return getOrCreateType(QualType(T, 0), Unit);
548 }
549
David Blaikie99dab3b2013-09-04 22:03:57 +0000550 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000551
552 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
553 // CVR derived types.
554 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000555
Guy Benyei11169dd2012-12-18 14:30:41 +0000556 return DbgTy;
557}
558
559llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
560 llvm::DIFile Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000561
562 // The frontend treats 'id' as a typedef to an ObjCObjectType,
563 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
564 // debug info, we want to emit 'id' in both cases.
565 if (Ty->isObjCQualifiedIdType())
566 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
567
Guy Benyei11169dd2012-12-18 14:30:41 +0000568 llvm::DIType DbgTy =
Eric Christopherb2a008c2013-05-16 00:45:12 +0000569 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000570 Ty->getPointeeType(), Unit);
571 return DbgTy;
572}
573
574llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
575 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000576 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000577 Ty->getPointeeType(), Unit);
578}
579
Manman Rene0064d82013-08-29 23:19:58 +0000580/// In C++ mode, types have linkage, so we can rely on the ODR and
581/// on their mangled names, if they're external.
582static SmallString<256>
583getUniqueTagTypeName(const TagType *Ty, CodeGenModule &CGM,
584 llvm::DICompileUnit TheCU) {
585 SmallString<256> FullName;
586 // FIXME: ODR should apply to ObjC++ exactly the same wasy it does to C++.
587 // For now, only apply ODR with C++.
588 const TagDecl *TD = Ty->getDecl();
589 if (TheCU.getLanguage() != llvm::dwarf::DW_LANG_C_plus_plus ||
590 !TD->isExternallyVisible())
591 return FullName;
592 // Microsoft Mangler does not have support for mangleCXXRTTIName yet.
593 if (CGM.getTarget().getCXXABI().isMicrosoft())
594 return FullName;
595
596 // TODO: This is using the RTTI name. Is there a better way to get
597 // a unique string for a type?
598 llvm::raw_svector_ostream Out(FullName);
599 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
600 Out.flush();
601 return FullName;
602}
603
Guy Benyei11169dd2012-12-18 14:30:41 +0000604// Creates a forward declaration for a RecordDecl in the given context.
David Blaikie8d5e1282013-08-20 21:03:29 +0000605llvm::DICompositeType
Manman Ren1b457022013-08-28 21:20:28 +0000606CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
David Blaikie8d5e1282013-08-20 21:03:29 +0000607 llvm::DIDescriptor Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000608 const RecordDecl *RD = Ty->getDecl();
David Blaikie4e7ef802013-08-15 20:17:25 +0000609 if (llvm::DIType T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
David Blaikie8d5e1282013-08-20 21:03:29 +0000610 return llvm::DICompositeType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000611 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
612 unsigned Line = getLineNumber(RD->getLocation());
613 StringRef RDName = getClassName(RD);
614
Ed Masteda706022014-05-07 12:49:30 +0000615 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000616 if (RD->isStruct() || RD->isInterface())
617 Tag = llvm::dwarf::DW_TAG_structure_type;
618 else if (RD->isUnion())
619 Tag = llvm::dwarf::DW_TAG_union_type;
620 else {
621 assert(RD->isClass());
622 Tag = llvm::dwarf::DW_TAG_class_type;
623 }
624
625 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000626 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
David Blaikief427b002014-05-06 03:42:01 +0000627 llvm::DICompositeType RetTy = DBuilder.createReplaceableForwardDecl(
628 Tag, RDName, Ctx, DefUnit, Line, 0, 0, 0, FullName);
629 ReplaceMap.push_back(std::make_pair(Ty, static_cast<llvm::Value *>(RetTy)));
630 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000631}
632
Ed Masteda706022014-05-07 12:49:30 +0000633llvm::DIType CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +0000634 const Type *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000635 QualType PointeeTy,
636 llvm::DIFile Unit) {
637 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
638 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikie99dab3b2013-09-04 22:03:57 +0000639 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit));
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000640
Guy Benyei11169dd2012-12-18 14:30:41 +0000641 // Bit size, align and offset of the type.
642 // Size is always the size of a pointer. We can't use getTypeSize here
643 // because that does not return the correct value for references.
644 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000645 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000646 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
647
David Blaikie99dab3b2013-09-04 22:03:57 +0000648 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
649 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000650}
651
Eric Christopher0fdcb312013-05-16 00:52:20 +0000652llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
653 llvm::DIType &Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000654 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000655 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000656 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
657 TheCU, getOrCreateMainFile(), 0);
658 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
659 Cache = DBuilder.createPointerType(Cache, Size);
660 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000661}
662
Guy Benyei11169dd2012-12-18 14:30:41 +0000663llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
664 llvm::DIFile Unit) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000665 if (BlockLiteralGeneric)
Guy Benyei11169dd2012-12-18 14:30:41 +0000666 return BlockLiteralGeneric;
667
668 SmallVector<llvm::Value *, 8> EltTys;
669 llvm::DIType FieldTy;
670 QualType FType;
671 uint64_t FieldSize, FieldOffset;
672 unsigned FieldAlign;
673 llvm::DIArray Elements;
674 llvm::DIType EltTy, DescTy;
675
676 FieldOffset = 0;
677 FType = CGM.getContext().UnsignedLongTy;
678 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
679 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
680
681 Elements = DBuilder.getOrCreateArray(EltTys);
682 EltTys.clear();
683
684 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
685 unsigned LineNo = getLineNumber(CurLoc);
686
687 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
688 Unit, LineNo, FieldOffset, 0,
David Blaikie6d4fe152013-02-25 01:07:08 +0000689 Flags, llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000690
691 // Bit size, align and offset of the type.
692 uint64_t Size = CGM.getContext().getTypeSize(Ty);
693
694 DescTy = DBuilder.createPointerType(EltTy, Size);
695
696 FieldOffset = 0;
697 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
698 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
699 FType = CGM.getContext().IntTy;
700 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
701 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
702 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
703 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
704
705 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
706 FieldTy = DescTy;
707 FieldSize = CGM.getContext().getTypeSize(Ty);
708 FieldAlign = CGM.getContext().getTypeAlign(Ty);
709 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
710 LineNo, FieldSize, FieldAlign,
711 FieldOffset, 0, FieldTy);
712 EltTys.push_back(FieldTy);
713
714 FieldOffset += FieldSize;
715 Elements = DBuilder.getOrCreateArray(EltTys);
716
717 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
718 Unit, LineNo, FieldOffset, 0,
David Blaikie6d4fe152013-02-25 01:07:08 +0000719 Flags, llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000720
Guy Benyei11169dd2012-12-18 14:30:41 +0000721 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
722 return BlockLiteralGeneric;
723}
724
David Blaikief1b382e2014-04-06 17:14:06 +0000725llvm::DIType CGDebugInfo::CreateType(const TemplateSpecializationType *Ty, llvm::DIFile Unit) {
726 assert(Ty->isTypeAlias());
727 llvm::DIType Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000728
729 SmallString<128> NS;
730 llvm::raw_svector_ostream OS(NS);
731 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(), /*qualified*/ false);
732
733 TemplateSpecializationType::PrintTemplateArgumentList(
734 OS, Ty->getArgs(), Ty->getNumArgs(),
735 CGM.getContext().getPrintingPolicy());
736
737 TypeAliasDecl *AliasDecl =
738 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
739 ->getTemplatedDecl();
740
741 SourceLocation Loc = AliasDecl->getLocation();
742 llvm::DIFile File = getOrCreateFile(Loc);
743 unsigned Line = getLineNumber(Loc);
744
745 llvm::DIDescriptor Ctxt = getContextDescriptor(cast<Decl>(AliasDecl->getDeclContext()));
746
747 return DBuilder.createTypedef(Src, internString(OS.str()), File, Line, Ctxt);
748}
749
David Blaikie99dab3b2013-09-04 22:03:57 +0000750llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000751 // Typedefs are derived from some other type. If we have a typedef of a
752 // typedef, make sure to emit the whole chain.
David Blaikie99dab3b2013-09-04 22:03:57 +0000753 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000754 // 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) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +0000837 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +0000838 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();
Craig Topper8a13c412014-05-21 05:09:00 +0000881 llvm::Constant *C = nullptr;
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,
Craig Topper8a13c412014-05-21 05:09:00 +00001125 Flags, CGM.getLangOpts().Optimize, nullptr,
Guy Benyei11169dd2012-12-18 14:30:41 +00001126 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);
Craig Topper8a13c412014-05-21 05:09:00 +00001253 llvm::Value *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001254 // 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);
Craig Topper8a13c412014-05-21 05:09:00 +00001285 llvm::Value *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001286 // 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(),
Craig Topper8a13c412014-05-21 05:09:00 +00001315 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit));
David Blaikie47c11502013-06-22 18:59:18 +00001316 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) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001359 // Always get the full list of parameters, not just the ones from
1360 // the specialization.
1361 TemplateParameterList *TPList =
1362 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001363 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001364 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001365}
1366
1367/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1368llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1369 if (VTablePtrType.isValid())
1370 return VTablePtrType;
1371
1372 ASTContext &Context = CGM.getContext();
1373
1374 /* Function type */
1375 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1376 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1377 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1378 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1379 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1380 "__vtbl_ptr_type");
1381 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1382 return VTablePtrType;
1383}
1384
1385/// getVTableName - Get vtable name for the given Class.
1386StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001387 // Copy the gdb compatible name on the side and use its reference.
1388 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001389}
1390
1391
1392/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1393/// debug info entry in EltTys vector.
1394void CGDebugInfo::
1395CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1396 SmallVectorImpl<llvm::Value *> &EltTys) {
1397 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1398
1399 // If there is a primary base then it will hold vtable info.
1400 if (RL.getPrimaryBase())
1401 return;
1402
1403 // If this class is not dynamic then there is not any vtable info to collect.
1404 if (!RD->isDynamicClass())
1405 return;
1406
1407 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1408 llvm::DIType VPTR
1409 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Eric Christopher0fdcb312013-05-16 00:52:20 +00001410 0, Size, 0, 0,
1411 llvm::DIDescriptor::FlagArtificial,
Guy Benyei11169dd2012-12-18 14:30:41 +00001412 getOrCreateVTablePtrType(Unit));
1413 EltTys.push_back(VPTR);
1414}
1415
Eric Christopherb2a008c2013-05-16 00:45:12 +00001416/// getOrCreateRecordType - Emit record type's standalone debug info.
1417llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00001418 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001419 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001420 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1421 return T;
1422}
1423
1424/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1425/// debug info.
1426llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001427 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001428 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001429 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantl73409ce2013-03-11 18:33:46 +00001430 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001431 return T;
1432}
1433
David Blaikie483a9da2014-05-06 18:35:21 +00001434void CGDebugInfo::completeType(const EnumDecl *ED) {
1435 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1436 return;
1437 QualType Ty = CGM.getContext().getEnumType(ED);
1438 void* TyPtr = Ty.getAsOpaquePtr();
1439 auto I = TypeCache.find(TyPtr);
1440 if (I == TypeCache.end() ||
1441 !llvm::DIType(cast<llvm::MDNode>(static_cast<llvm::Value *>(I->second)))
1442 .isForwardDecl())
1443 return;
1444 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<EnumType>());
1445 assert(!Res.isForwardDecl());
1446 TypeCache[TyPtr] = Res;
1447}
1448
David Blaikieb2e86eb2013-08-15 20:49:17 +00001449void CGDebugInfo::completeType(const RecordDecl *RD) {
1450 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1451 !CGM.getLangOpts().CPlusPlus)
1452 completeRequiredType(RD);
1453}
1454
1455void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie0856f662014-03-04 22:01:08 +00001456 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1457 return;
1458
David Blaikie6943dea2013-08-20 01:28:15 +00001459 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1460 if (CXXDecl->isDynamicClass())
1461 return;
1462
David Blaikieb2e86eb2013-08-15 20:49:17 +00001463 QualType Ty = CGM.getContext().getRecordType(RD);
1464 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie6943dea2013-08-20 01:28:15 +00001465 if (T && T.isForwardDecl())
1466 completeClassData(RD);
1467}
1468
1469void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1470 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001471 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001472 QualType Ty = CGM.getContext().getRecordType(RD);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001473 void* TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001474 auto I = TypeCache.find(TyPtr);
1475 if (I != TypeCache.end() &&
1476 !llvm::DIType(cast<llvm::MDNode>(static_cast<llvm::Value *>(I->second)))
1477 .isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001478 return;
1479 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1480 assert(!Res.isForwardDecl());
David Blaikieb2e86eb2013-08-15 20:49:17 +00001481 TypeCache[TyPtr] = Res;
1482}
1483
David Blaikie0e716b42014-03-03 23:48:23 +00001484static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1485 CXXRecordDecl::method_iterator End) {
1486 for (; I != End; ++I)
1487 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001488 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1489 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001490 return true;
1491 return false;
1492}
1493
1494static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
1495 const RecordDecl *RD,
1496 const LangOptions &LangOpts) {
1497 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1498 return false;
1499
1500 if (!LangOpts.CPlusPlus)
1501 return false;
1502
1503 if (!RD->isCompleteDefinitionRequired())
1504 return true;
1505
1506 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1507
1508 if (!CXXDecl)
1509 return false;
1510
1511 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1512 return true;
1513
1514 TemplateSpecializationKind Spec = TSK_Undeclared;
1515 if (const ClassTemplateSpecializationDecl *SD =
1516 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1517 Spec = SD->getSpecializationKind();
1518
1519 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1520 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1521 CXXDecl->method_end()))
1522 return true;
1523
1524 return false;
1525}
1526
Guy Benyei11169dd2012-12-18 14:30:41 +00001527/// CreateType - get structure or union type.
David Blaikie99dab3b2013-09-04 22:03:57 +00001528llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001529 RecordDecl *RD = Ty->getDecl();
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001530 llvm::DICompositeType T(getTypeOrNull(QualType(Ty, 0)));
David Blaikie0e716b42014-03-03 23:48:23 +00001531 if (T || shouldOmitDefinition(DebugKind, RD, CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001532 if (!T)
David Blaikie65ec94e2014-02-18 20:52:05 +00001533 T = getOrCreateRecordFwdDecl(
1534 Ty, getContextDescriptor(cast<Decl>(RD->getDeclContext())));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001535 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001536 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001537
David Blaikieb2e86eb2013-08-15 20:49:17 +00001538 return CreateTypeDefinition(Ty);
1539}
1540
1541llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1542 RecordDecl *RD = Ty->getDecl();
1543
Guy Benyei11169dd2012-12-18 14:30:41 +00001544 // Get overall information about the record type for the debug info.
1545 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1546
1547 // Records and classes and unions can all be recursive. To handle them, we
1548 // first generate a debug descriptor for the struct as a forward declaration.
1549 // Then (if it is a definition) we go through and get debug info for all of
1550 // its members. Finally, we create a descriptor for the complete type (which
1551 // may refer to the forward decl if the struct is recursive) and replace all
1552 // uses of the forward declaration with the final definition.
1553
David Blaikie4a2b5ef2013-08-12 22:24:20 +00001554 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Ren0d441f12013-07-02 19:01:53 +00001555 assert(FwdDecl.isCompositeType() &&
David Blaikie469f0792013-05-22 23:22:42 +00001556 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei11169dd2012-12-18 14:30:41 +00001557
1558 if (FwdDecl.isForwardDecl())
1559 return FwdDecl;
1560
David Blaikieadfbf992013-08-18 16:55:33 +00001561 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1562 CollectContainingType(CXXDecl, FwdDecl);
1563
Guy Benyei11169dd2012-12-18 14:30:41 +00001564 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001565 LexicalBlockStack.push_back(&*FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001566 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1567
Guy Benyei11169dd2012-12-18 14:30:41 +00001568 // Convert all the elements.
1569 SmallVector<llvm::Value *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001570 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001571
1572 // Note: The split of CXXDecl information here is intentional, the
1573 // gdb tests will depend on a certain ordering at printout. The debug
1574 // information offsets are still correct if we merge them all together
1575 // though.
1576 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1577 if (CXXDecl) {
1578 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1579 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1580 }
1581
Eric Christopher91a31902013-01-16 01:22:32 +00001582 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001583 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001584 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001585 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001586
1587 LexicalBlockStack.pop_back();
1588 RegionMap.erase(Ty->getDecl());
1589
1590 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
David Blaikie4a5b8952013-08-01 20:31:40 +00001591 FwdDecl.setTypeArray(Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001592
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001593 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1594 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001595}
1596
1597/// CreateType - get objective-c object type.
1598llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1599 llvm::DIFile Unit) {
1600 // Ignore protocols.
1601 return getOrCreateType(Ty->getBaseType(), Unit);
1602}
1603
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001604
1605/// \return true if Getter has the default name for the property PD.
1606static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1607 const ObjCMethodDecl *Getter) {
1608 assert(PD);
1609 if (!Getter)
1610 return true;
1611
1612 assert(Getter->getDeclName().isObjCZeroArgSelector());
1613 return PD->getName() ==
1614 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
1615}
1616
1617/// \return true if Setter has the default name for the property PD.
1618static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1619 const ObjCMethodDecl *Setter) {
1620 assert(PD);
1621 if (!Setter)
1622 return true;
1623
1624 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001625 return SelectorTable::constructSetterName(PD->getName()) ==
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001626 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
1627}
1628
Guy Benyei11169dd2012-12-18 14:30:41 +00001629/// CreateType - get objective-c interface type.
1630llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1631 llvm::DIFile Unit) {
1632 ObjCInterfaceDecl *ID = Ty->getDecl();
1633 if (!ID)
1634 return llvm::DIType();
1635
1636 // Get overall information about the record type for the debug info.
1637 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1638 unsigned Line = getLineNumber(ID->getLocation());
Ed Masteda706022014-05-07 12:49:30 +00001639 llvm::dwarf::SourceLanguage RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001640
1641 // If this is just a forward declaration return a special forward-declaration
1642 // debug type since we won't be able to lay out the entire type.
1643 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001644 if (!Def || !Def->getImplementation()) {
David Blaikief427b002014-05-06 03:42:01 +00001645 llvm::DIType FwdDecl = DBuilder.createReplaceableForwardDecl(
1646 llvm::dwarf::DW_TAG_structure_type, ID->getName(), TheCU, DefUnit, Line,
1647 RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001648 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001649 return FwdDecl;
1650 }
1651
David Blaikieef8a9512014-05-05 23:23:53 +00001652
1653 return CreateTypeDefinition(Ty, Unit);
1654}
1655
1656llvm::DIType CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty, llvm::DIFile Unit) {
1657 ObjCInterfaceDecl *ID = Ty->getDecl();
1658 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1659 unsigned Line = getLineNumber(ID->getLocation());
1660 unsigned RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001661
1662 // Bit size, align and offset of the type.
1663 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1664 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1665
1666 unsigned Flags = 0;
1667 if (ID->getImplementation())
1668 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1669
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001670 llvm::DICompositeType RealDecl =
Guy Benyei11169dd2012-12-18 14:30:41 +00001671 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1672 Line, Size, Align, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00001673 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001674
David Blaikieef8a9512014-05-05 23:23:53 +00001675 QualType QTy(Ty, 0);
1676 TypeCache[QTy.getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001677
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001678 // Push the struct on region stack.
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001679 LexicalBlockStack.push_back(static_cast<llvm::MDNode*>(RealDecl));
Guy Benyei11169dd2012-12-18 14:30:41 +00001680 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1681
1682 // Convert all the elements.
1683 SmallVector<llvm::Value *, 16> EltTys;
1684
1685 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1686 if (SClass) {
1687 llvm::DIType SClassTy =
1688 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1689 if (!SClassTy.isValid())
1690 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001691
Guy Benyei11169dd2012-12-18 14:30:41 +00001692 llvm::DIType InhTag =
1693 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1694 EltTys.push_back(InhTag);
1695 }
1696
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001697 // Create entries for all of the properties.
Aaron Ballmand174edf2014-03-13 19:11:50 +00001698 for (const auto *PD : ID->properties()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001699 SourceLocation Loc = PD->getLocation();
1700 llvm::DIFile PUnit = getOrCreateFile(Loc);
1701 unsigned PLine = getLineNumber(Loc);
1702 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1703 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1704 llvm::MDNode *PropertyNode =
1705 DBuilder.createObjCProperty(PD->getName(),
Eric Christopherc0c5d462013-02-21 22:35:08 +00001706 PUnit, PLine,
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001707 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001708 getSelectorName(PD->getGetterName()),
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001709 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001710 getSelectorName(PD->getSetterName()),
1711 PD->getPropertyAttributes(),
Eric Christopherc0c5d462013-02-21 22:35:08 +00001712 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001713 EltTys.push_back(PropertyNode);
1714 }
1715
1716 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1717 unsigned FieldNo = 0;
1718 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1719 Field = Field->getNextIvar(), ++FieldNo) {
1720 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1721 if (!FieldTy.isValid())
1722 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001723
Guy Benyei11169dd2012-12-18 14:30:41 +00001724 StringRef FieldName = Field->getName();
1725
1726 // Ignore unnamed fields.
1727 if (FieldName.empty())
1728 continue;
1729
1730 // Get the location for the field.
1731 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1732 unsigned FieldLine = getLineNumber(Field->getLocation());
1733 QualType FType = Field->getType();
1734 uint64_t FieldSize = 0;
1735 unsigned FieldAlign = 0;
1736
1737 if (!FType->isIncompleteArrayType()) {
1738
1739 // Bit size, align and offset of the type.
1740 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001741 ? Field->getBitWidthValue(CGM.getContext())
1742 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001743 FieldAlign = CGM.getContext().getTypeAlign(FType);
1744 }
1745
1746 uint64_t FieldOffset;
1747 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1748 // We don't know the runtime offset of an ivar if we're using the
1749 // non-fragile ABI. For bitfields, use the bit offset into the first
1750 // byte of storage of the bitfield. For other fields, use zero.
1751 if (Field->isBitField()) {
1752 FieldOffset = CGM.getObjCRuntime().ComputeBitfieldBitOffset(
1753 CGM, ID, Field);
1754 FieldOffset %= CGM.getContext().getCharWidth();
1755 } else {
1756 FieldOffset = 0;
1757 }
1758 } else {
1759 FieldOffset = RL.getFieldOffset(FieldNo);
1760 }
1761
1762 unsigned Flags = 0;
1763 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1764 Flags = llvm::DIDescriptor::FlagProtected;
1765 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1766 Flags = llvm::DIDescriptor::FlagPrivate;
1767
Craig Topper8a13c412014-05-21 05:09:00 +00001768 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001769 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001770 if (ObjCPropertyImplDecl *PImpD =
Guy Benyei11169dd2012-12-18 14:30:41 +00001771 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1772 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001773 SourceLocation Loc = PD->getLocation();
1774 llvm::DIFile PUnit = getOrCreateFile(Loc);
1775 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001776 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1777 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1778 PropertyNode =
1779 DBuilder.createObjCProperty(PD->getName(),
1780 PUnit, PLine,
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001781 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001782 getSelectorName(PD->getGetterName()),
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001783 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei11169dd2012-12-18 14:30:41 +00001784 getSelectorName(PD->getSetterName()),
1785 PD->getPropertyAttributes(),
1786 getOrCreateType(PD->getType(), PUnit));
1787 }
1788 }
1789 }
1790 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1791 FieldLine, FieldSize, FieldAlign,
1792 FieldOffset, Flags, FieldTy,
1793 PropertyNode);
1794 EltTys.push_back(FieldTy);
1795 }
1796
1797 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001798 RealDecl.setTypeArray(Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001799
Guy Benyei11169dd2012-12-18 14:30:41 +00001800 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001801 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001802}
1803
1804llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1805 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1806 int64_t Count = Ty->getNumElements();
1807 if (Count == 0)
1808 // If number of elements are not known then this is an unbounded array.
1809 // Use Count == -1 to express such arrays.
1810 Count = -1;
1811
1812 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1813 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1814
1815 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1816 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1817
1818 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1819}
1820
1821llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1822 llvm::DIFile Unit) {
1823 uint64_t Size;
1824 uint64_t Align;
1825
1826 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1827 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1828 Size = 0;
1829 Align =
1830 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1831 } else if (Ty->isIncompleteArrayType()) {
1832 Size = 0;
1833 if (Ty->getElementType()->isIncompleteType())
1834 Align = 0;
1835 else
1836 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001837 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001838 Size = 0;
1839 Align = 0;
1840 } else {
1841 // Size and align of the whole array, not the element type.
1842 Size = CGM.getContext().getTypeSize(Ty);
1843 Align = CGM.getContext().getTypeAlign(Ty);
1844 }
1845
1846 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1847 // interior arrays, do we care? Why aren't nested arrays represented the
1848 // obvious/recursive way?
1849 SmallVector<llvm::Value *, 8> Subscripts;
1850 QualType EltTy(Ty, 0);
1851 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1852 // If the number of elements is known, then count is that number. Otherwise,
1853 // it's -1. This allows us to represent a subrange with an array of 0
1854 // elements, like this:
1855 //
1856 // struct foo {
1857 // int x[0];
1858 // };
1859 int64_t Count = -1; // Count == -1 is an unbounded array.
1860 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1861 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001862
Guy Benyei11169dd2012-12-18 14:30:41 +00001863 // FIXME: Verify this is right for VLAs.
1864 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1865 EltTy = Ty->getElementType();
1866 }
1867
1868 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1869
Eric Christopherb2a008c2013-05-16 00:45:12 +00001870 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001871 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1872 SubscriptArray);
1873 return DbgTy;
1874}
1875
Eric Christopherb2a008c2013-05-16 00:45:12 +00001876llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001877 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001878 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001879 Ty, Ty->getPointeeType(), Unit);
1880}
1881
Eric Christopherb2a008c2013-05-16 00:45:12 +00001882llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001883 llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001884 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei11169dd2012-12-18 14:30:41 +00001885 Ty, Ty->getPointeeType(), Unit);
1886}
1887
Eric Christopherb2a008c2013-05-16 00:45:12 +00001888llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001889 llvm::DIFile U) {
David Blaikie2c705ca2013-01-19 19:20:56 +00001890 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1891 if (!Ty->getPointeeType()->isFunctionType())
1892 return DBuilder.createMemberPointerType(
David Blaikie99dab3b2013-09-04 22:03:57 +00001893 getOrCreateType(Ty->getPointeeType(), U), ClassType);
Adrian Prantl0866acd2013-12-19 01:38:47 +00001894
1895 const FunctionProtoType *FPT =
1896 Ty->getPointeeType()->getAs<FunctionProtoType>();
David Blaikie2c705ca2013-01-19 19:20:56 +00001897 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
Adrian Prantl0866acd2013-12-19 01:38:47 +00001898 CGM.getContext().getPointerType(QualType(Ty->getClass(),
1899 FPT->getTypeQuals())),
1900 FPT, U), ClassType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001901}
1902
Eric Christopherb2a008c2013-05-16 00:45:12 +00001903llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001904 llvm::DIFile U) {
1905 // Ignore the atomic wrapping
1906 // FIXME: What is the correct representation?
1907 return getOrCreateType(Ty->getValueType(), U);
1908}
1909
1910/// CreateEnumType - get enumeration type.
Manman Ren501ecf92013-08-28 21:46:36 +00001911llvm::DIType CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00001912 const EnumDecl *ED = Ty->getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00001913 uint64_t Size = 0;
1914 uint64_t Align = 0;
1915 if (!ED->getTypeForDecl()->isIncompleteType()) {
1916 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1917 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1918 }
1919
Manman Rene0064d82013-08-29 23:19:58 +00001920 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1921
Guy Benyei11169dd2012-12-18 14:30:41 +00001922 // If this is just a forward declaration, construct an appropriately
1923 // marked node and just return it.
1924 if (!ED->getDefinition()) {
1925 llvm::DIDescriptor EDContext;
1926 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1927 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1928 unsigned Line = getLineNumber(ED->getLocation());
1929 StringRef EDName = ED->getName();
David Blaikief427b002014-05-06 03:42:01 +00001930 llvm::DIType RetTy = DBuilder.createReplaceableForwardDecl(
1931 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
1932 0, Size, Align, FullName);
1933 ReplaceMap.push_back(std::make_pair(Ty, static_cast<llvm::Value *>(RetTy)));
1934 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00001935 }
1936
David Blaikie483a9da2014-05-06 18:35:21 +00001937 return CreateTypeDefinition(Ty);
1938}
1939
1940llvm::DIType CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
1941 const EnumDecl *ED = Ty->getDecl();
1942 uint64_t Size = 0;
1943 uint64_t Align = 0;
1944 if (!ED->getTypeForDecl()->isIncompleteType()) {
1945 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1946 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1947 }
1948
1949 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1950
Guy Benyei11169dd2012-12-18 14:30:41 +00001951 // Create DIEnumerator elements for each enumerator.
1952 SmallVector<llvm::Value *, 16> Enumerators;
1953 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00001954 for (const auto *Enum : ED->enumerators()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001955 Enumerators.push_back(
1956 DBuilder.createEnumerator(Enum->getName(),
David Blaikiece1ae382013-06-24 07:13:13 +00001957 Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001958 }
1959
1960 // Return a CompositeType for the enum itself.
1961 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1962
1963 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1964 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001965 llvm::DIDescriptor EnumContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00001966 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantlc60dc712013-04-19 19:56:39 +00001967 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei11169dd2012-12-18 14:30:41 +00001968 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001969 llvm::DIType DbgTy =
Guy Benyei11169dd2012-12-18 14:30:41 +00001970 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1971 Size, Align, EltArray,
Manman Rene0064d82013-08-29 23:19:58 +00001972 ClassTy, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001973 return DbgTy;
1974}
1975
David Blaikie05491062013-01-21 04:37:12 +00001976static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1977 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001978 do {
Adrian Prantl179af902013-09-26 21:35:50 +00001979 Qualifiers InnerQuals = T.getLocalQualifiers();
1980 // Qualifiers::operator+() doesn't like it if you add a Qualifier
1981 // that is already there.
1982 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
1983 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001984 QualType LastT = T;
1985 switch (T->getTypeClass()) {
1986 default:
David Blaikie05491062013-01-21 04:37:12 +00001987 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00001988 case Type::TemplateSpecialization: {
1989 const auto *Spec = cast<TemplateSpecializationType>(T);
1990 if (Spec->isTypeAlias())
1991 return C.getQualifiedType(T.getTypePtr(), Quals);
1992 T = Spec->desugar();
1993 break; }
Guy Benyei11169dd2012-12-18 14:30:41 +00001994 case Type::TypeOfExpr:
1995 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1996 break;
1997 case Type::TypeOf:
1998 T = cast<TypeOfType>(T)->getUnderlyingType();
1999 break;
2000 case Type::Decltype:
2001 T = cast<DecltypeType>(T)->getUnderlyingType();
2002 break;
2003 case Type::UnaryTransform:
2004 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2005 break;
2006 case Type::Attributed:
2007 T = cast<AttributedType>(T)->getEquivalentType();
2008 break;
2009 case Type::Elaborated:
2010 T = cast<ElaboratedType>(T)->getNamedType();
2011 break;
2012 case Type::Paren:
2013 T = cast<ParenType>(T)->getInnerType();
2014 break;
David Blaikie05491062013-01-21 04:37:12 +00002015 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002016 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002017 break;
2018 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002019 QualType DT = cast<AutoType>(T)->getDeducedType();
2020 if (DT.isNull())
2021 return T;
2022 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002023 break;
2024 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002025
Guy Benyei11169dd2012-12-18 14:30:41 +00002026 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002027 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002028 } while (true);
2029}
2030
Eric Christopher0fdcb312013-05-16 00:52:20 +00002031/// getType - Get the type from the cache or return null type if it doesn't
2032/// exist.
Guy Benyei11169dd2012-12-18 14:30:41 +00002033llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
2034
2035 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002036 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002037
David Blaikief427b002014-05-06 03:42:01 +00002038 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002039 if (it != TypeCache.end()) {
2040 // Verify that the debug info still exists.
2041 if (llvm::Value *V = it->second)
2042 return llvm::DIType(cast<llvm::MDNode>(V));
2043 }
2044
2045 return llvm::DIType();
2046}
2047
David Blaikie0e716b42014-03-03 23:48:23 +00002048void CGDebugInfo::completeTemplateDefinition(
2049 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002050 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2051 return;
2052
David Blaikie0e716b42014-03-03 23:48:23 +00002053 completeClassData(&SD);
2054 // In case this type has no member function definitions being emitted, ensure
2055 // it is retained
2056 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2057}
2058
Guy Benyei11169dd2012-12-18 14:30:41 +00002059/// getOrCreateType - Get the type from the cache or create a new
2060/// one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +00002061llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002062 if (Ty.isNull())
2063 return llvm::DIType();
2064
2065 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002066 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002067
David Blaikieef8a9512014-05-05 23:23:53 +00002068 if (llvm::DIType T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002069 return T;
2070
2071 // Otherwise create the type.
David Blaikie99dab3b2013-09-04 22:03:57 +00002072 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Adrian Prantl73409ce2013-03-11 18:33:46 +00002073 void* TyPtr = Ty.getAsOpaquePtr();
2074
2075 // And update the type cache.
2076 TypeCache[TyPtr] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002077
Guy Benyei11169dd2012-12-18 14:30:41 +00002078 return Res;
2079}
2080
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002081/// Currently the checksum of an interface includes the number of
2082/// ivars and property accessors.
Eric Christopher1ecc5632013-06-07 22:54:39 +00002083unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl817bbb32013-06-07 01:10:48 +00002084 // The assumption is that the number of ivars can only increase
2085 // monotonically, so it is safe to just use their current number as
2086 // a checksum.
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002087 unsigned Sum = 0;
2088 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
Craig Topper8a13c412014-05-21 05:09:00 +00002089 Ivar != nullptr; Ivar = Ivar->getNextIvar())
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002090 ++Sum;
2091
2092 return Sum;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002093}
2094
2095ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2096 switch (Ty->getTypeClass()) {
2097 case Type::ObjCObjectPointer:
Eric Christopher0fdcb312013-05-16 00:52:20 +00002098 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
2099 ->getPointeeType());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002100 case Type::ObjCInterface:
2101 return cast<ObjCInterfaceType>(Ty)->getDecl();
2102 default:
Craig Topper8a13c412014-05-21 05:09:00 +00002103 return nullptr;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002104 }
2105}
2106
Guy Benyei11169dd2012-12-18 14:30:41 +00002107/// CreateTypeNode - Create a new debug type node.
David Blaikie99dab3b2013-09-04 22:03:57 +00002108llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002109 // Handle qualifiers, which recursively handles what they refer to.
2110 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002111 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002112
Craig Topper8a13c412014-05-21 05:09:00 +00002113 const char *Diag = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002114
Guy Benyei11169dd2012-12-18 14:30:41 +00002115 // Work out details of type.
2116 switch (Ty->getTypeClass()) {
2117#define TYPE(Class, Base)
2118#define ABSTRACT_TYPE(Class, Base)
2119#define NON_CANONICAL_TYPE(Class, Base)
2120#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2121#include "clang/AST/TypeNodes.def"
2122 llvm_unreachable("Dependent types cannot show up in debug information");
2123
2124 case Type::ExtVector:
2125 case Type::Vector:
2126 return CreateType(cast<VectorType>(Ty), Unit);
2127 case Type::ObjCObjectPointer:
2128 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2129 case Type::ObjCObject:
2130 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2131 case Type::ObjCInterface:
2132 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2133 case Type::Builtin:
2134 return CreateType(cast<BuiltinType>(Ty));
2135 case Type::Complex:
2136 return CreateType(cast<ComplexType>(Ty));
2137 case Type::Pointer:
2138 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002139 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002140 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002141 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002142 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002143 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002144 case Type::BlockPointer:
2145 return CreateType(cast<BlockPointerType>(Ty), Unit);
2146 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002147 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002148 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002149 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002150 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002151 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002152 case Type::FunctionProto:
2153 case Type::FunctionNoProto:
2154 return CreateType(cast<FunctionType>(Ty), Unit);
2155 case Type::ConstantArray:
2156 case Type::VariableArray:
2157 case Type::IncompleteArray:
2158 return CreateType(cast<ArrayType>(Ty), Unit);
2159
2160 case Type::LValueReference:
2161 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2162 case Type::RValueReference:
2163 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2164
2165 case Type::MemberPointer:
2166 return CreateType(cast<MemberPointerType>(Ty), Unit);
2167
2168 case Type::Atomic:
2169 return CreateType(cast<AtomicType>(Ty), Unit);
2170
Guy Benyei11169dd2012-12-18 14:30:41 +00002171 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002172 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2173
2174 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002175 case Type::Elaborated:
2176 case Type::Paren:
2177 case Type::SubstTemplateTypeParm:
2178 case Type::TypeOfExpr:
2179 case Type::TypeOf:
2180 case Type::Decltype:
2181 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002182 case Type::PackExpansion:
Guy Benyei11169dd2012-12-18 14:30:41 +00002183 llvm_unreachable("type should have been unwrapped!");
David Blaikie22c460a02013-05-24 21:24:35 +00002184 case Type::Auto:
2185 Diag = "auto";
2186 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002187 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002188
Guy Benyei11169dd2012-12-18 14:30:41 +00002189 assert(Diag && "Fall through without a diagnostic?");
2190 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2191 "debug information for %0 is not yet supported");
2192 CGM.getDiags().Report(DiagID)
2193 << Diag;
2194 return llvm::DIType();
2195}
2196
2197/// getOrCreateLimitedType - Get the type from the cache or create a new
2198/// limited type if necessary.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002199llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002200 llvm::DIFile Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002201 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002202
David Blaikie8d5e1282013-08-20 21:03:29 +00002203 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002204
2205 // We may have cached a forward decl when we could have created
2206 // a non-forward decl. Go ahead and create a non-forward decl
2207 // now.
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002208 if (T && !T.isForwardDecl()) return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002209
2210 // Otherwise create the type.
David Blaikie8d5e1282013-08-20 21:03:29 +00002211 llvm::DICompositeType Res = CreateLimitedType(Ty);
2212
2213 // Propagate members from the declaration to the definition
2214 // CreateType(const RecordType*) will overwrite this with the members in the
2215 // correct order if the full type is needed.
2216 Res.setTypeArray(T.getTypeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002217
Guy Benyei11169dd2012-12-18 14:30:41 +00002218 // And update the type cache.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002219 TypeCache[QTy.getAsOpaquePtr()] = Res;
Guy Benyei11169dd2012-12-18 14:30:41 +00002220 return Res;
2221}
2222
2223// TODO: Currently used for context chains when limiting debug info.
David Blaikie8d5e1282013-08-20 21:03:29 +00002224llvm::DICompositeType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002225 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002226
Guy Benyei11169dd2012-12-18 14:30:41 +00002227 // Get overall information about the record type for the debug info.
2228 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2229 unsigned Line = getLineNumber(RD->getLocation());
2230 StringRef RDName = getClassName(RD);
2231
Eric Christopher07429ff2013-10-15 21:22:34 +00002232 llvm::DIDescriptor RDContext =
2233 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002234
David Blaikied2785892013-08-18 17:36:19 +00002235 // If we ended up creating the type during the context chain construction,
2236 // just return that.
David Blaikie8d5e1282013-08-20 21:03:29 +00002237 llvm::DICompositeType T(getTypeOrNull(CGM.getContext().getRecordType(RD)));
2238 if (T && (!T.isForwardDecl() || !RD->getDefinition()))
David Blaikied2785892013-08-18 17:36:19 +00002239 return T;
2240
Adrian Prantl381e7552014-02-04 21:29:50 +00002241 // If this is just a forward or incomplete declaration, construct an
2242 // appropriately marked node and just return it.
2243 const RecordDecl *D = RD->getDefinition();
2244 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002245 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002246
2247 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2248 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
David Blaikie49ae6a72013-03-26 23:47:35 +00002249 llvm::DICompositeType RealDecl;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002250
Manman Rene0064d82013-08-29 23:19:58 +00002251 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2252
Guy Benyei11169dd2012-12-18 14:30:41 +00002253 if (RD->isUnion())
2254 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Manman Rene0064d82013-08-29 23:19:58 +00002255 Size, Align, 0, llvm::DIArray(), 0,
2256 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002257 else if (RD->isClass()) {
2258 // FIXME: This could be a struct type giving a default visibility different
2259 // than C++ class type, but needs llvm metadata changes first.
2260 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002261 Size, Align, 0, 0, llvm::DIType(),
2262 llvm::DIArray(), llvm::DIType(),
Manman Rene0064d82013-08-29 23:19:58 +00002263 llvm::DIArray(), FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002264 } else
2265 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopher0fdcb312013-05-16 00:52:20 +00002266 Size, Align, 0, llvm::DIType(),
David Blaikieba477362013-11-18 23:38:26 +00002267 llvm::DIArray(), 0, llvm::DIType(),
2268 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002269
2270 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie49ae6a72013-03-26 23:47:35 +00002271 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002272
David Blaikieadfbf992013-08-18 16:55:33 +00002273 if (const ClassTemplateSpecializationDecl *TSpecial =
2274 dyn_cast<ClassTemplateSpecializationDecl>(RD))
2275 RealDecl.setTypeArray(llvm::DIArray(),
2276 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002277 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002278}
2279
David Blaikieadfbf992013-08-18 16:55:33 +00002280void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2281 llvm::DICompositeType RealDecl) {
2282 // A class's primary base or the class itself contains the vtable.
2283 llvm::DICompositeType ContainingType;
2284 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2285 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002286 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002287 while (1) {
2288 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2289 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2290 if (PBT && !BRL.isPrimaryBaseVirtual())
2291 PBase = PBT;
2292 else
2293 break;
2294 }
2295 ContainingType = llvm::DICompositeType(
2296 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2297 getOrCreateFile(RD->getLocation())));
2298 } else if (RD->isDynamicClass())
2299 ContainingType = RealDecl;
2300
2301 RealDecl.setContainingType(ContainingType);
2302}
2303
Guy Benyei11169dd2012-12-18 14:30:41 +00002304/// CreateMemberType - Create new member and increase Offset by FType's size.
2305llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2306 StringRef Name,
2307 uint64_t *Offset) {
2308 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2309 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2310 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2311 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2312 FieldSize, FieldAlign,
2313 *Offset, 0, FieldTy);
2314 *Offset += FieldSize;
2315 return Ty;
2316}
2317
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002318llvm::DIScope CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002319 // We only need a declaration (not a definition) of the type - so use whatever
2320 // we would otherwise do to get a type for a pointee. (forward declarations in
2321 // limited debug info, full definitions (if the type definition is available)
2322 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002323 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2324 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002325 getOrCreateFile(TD->getLocation()));
David Blaikiebd483762013-05-20 04:58:53 +00002326 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2327 // This doesn't handle providing declarations (for functions or variables) for
2328 // entities without definitions in this TU, nor when the definition proceeds
2329 // the call to this function.
2330 // FIXME: This should be split out into more specific maps with support for
2331 // emitting forward declarations and merging definitions with declarations,
2332 // the same way as we do for types.
2333 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2334 DeclCache.find(D->getCanonicalDecl());
2335 if (I == DeclCache.end())
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002336 return llvm::DIScope();
David Blaikiebd483762013-05-20 04:58:53 +00002337 llvm::Value *V = I->second;
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00002338 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikiebd483762013-05-20 04:58:53 +00002339}
2340
Guy Benyei11169dd2012-12-18 14:30:41 +00002341/// getFunctionDeclaration - Return debug info descriptor to describe method
2342/// declaration for the given method definition.
2343llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002344 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2345 return llvm::DISubprogram();
2346
Guy Benyei11169dd2012-12-18 14:30:41 +00002347 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2348 if (!FD) return llvm::DISubprogram();
2349
2350 // Setup context.
David Blaikiefd07c602013-08-09 17:20:05 +00002351 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002352
2353 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2354 MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002355 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002356 if (const CXXMethodDecl *MD =
2357 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikiefd07c602013-08-09 17:20:05 +00002358 llvm::DICompositeType T(S);
Eric Christopherf86c4052013-08-28 23:12:10 +00002359 llvm::DISubprogram SP =
2360 CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
David Blaikiefd07c602013-08-09 17:20:05 +00002361 return SP;
2362 }
2363 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002364 if (MI != SPCache.end()) {
2365 llvm::Value *V = MI->second;
2366 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002367 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002368 return SP;
2369 }
2370
Aaron Ballman86c93902014-03-06 23:45:36 +00002371 for (auto NextFD : FD->redecls()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002372 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2373 MI = SPCache.find(NextFD->getCanonicalDecl());
2374 if (MI != SPCache.end()) {
2375 llvm::Value *V = MI->second;
2376 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
David Blaikie18cfbc52013-06-22 00:09:36 +00002377 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002378 return SP;
2379 }
2380 }
2381 return llvm::DISubprogram();
2382}
2383
2384// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2385// implicit parameter "this".
David Blaikie469f0792013-05-22 23:22:42 +00002386llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2387 QualType FnType,
2388 llvm::DIFile F) {
David Blaikie18cfbc52013-06-22 00:09:36 +00002389 if (!D || DebugKind == CodeGenOptions::DebugLineTablesOnly)
2390 // Create fake but valid subroutine type. Otherwise
2391 // llvm::DISubprogram::Verify() would return false, and
2392 // subprogram DIE will miss DW_AT_decl_file and
2393 // DW_AT_decl_line fields.
2394 return DBuilder.createSubroutineType(F, DBuilder.getOrCreateArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002395
2396 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2397 return getOrCreateMethodType(Method, F);
2398 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2399 // Add "self" and "_cmd"
2400 SmallVector<llvm::Value *, 16> Elts;
2401
2402 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002403 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002404
2405 // Replace the instancetype keyword with the actual type.
2406 if (ResultTy == CGM.getContext().getObjCInstanceType())
2407 ResultTy = CGM.getContext().getPointerType(
2408 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2409
Adrian Prantl7bec9032013-05-10 21:08:31 +00002410 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002411 // "self" pointer is always first argument.
Adrian Prantlde17db32013-03-29 19:20:29 +00002412 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2413 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2414 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002415 // "_cmd" pointer is always second argument.
2416 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2417 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2418 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002419 for (const auto *PI : OMethod->params())
2420 Elts.push_back(getOrCreateType(PI->getType(), F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002421
2422 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2423 return DBuilder.createSubroutineType(F, EltTypeArray);
2424 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002425
Adrian Prantl800faef2014-02-25 23:42:18 +00002426 // Handle variadic function types; they need an additional
2427 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002428 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2429 if (FD->isVariadic()) {
2430 SmallVector<llvm::Value *, 16> EltTys;
2431 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2432 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2433 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2434 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2435 EltTys.push_back(DBuilder.createUnspecifiedParameter());
2436 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
2437 return DBuilder.createSubroutineType(F, EltTypeArray);
2438 }
2439
David Blaikie469f0792013-05-22 23:22:42 +00002440 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002441}
2442
2443/// EmitFunctionStart - Constructs the debug code for entering a function.
Adrian Prantl42d71b92014-04-10 23:21:53 +00002444void CGDebugInfo::EmitFunctionStart(GlobalDecl GD,
2445 SourceLocation Loc,
2446 SourceLocation ScopeLoc,
2447 QualType FnType,
Guy Benyei11169dd2012-12-18 14:30:41 +00002448 llvm::Function *Fn,
2449 CGBuilderTy &Builder) {
2450
2451 StringRef Name;
2452 StringRef LinkageName;
2453
2454 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2455
2456 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002457 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002458
Guy Benyei11169dd2012-12-18 14:30:41 +00002459 unsigned Flags = 0;
2460 llvm::DIFile Unit = getOrCreateFile(Loc);
2461 llvm::DIDescriptor FDContext(Unit);
2462 llvm::DIArray TParamsArray;
2463 if (!HasDecl) {
2464 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002465 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002466 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2467 // If there is a DISubprogram for this function available then use it.
2468 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2469 FI = SPCache.find(FD->getCanonicalDecl());
2470 if (FI != SPCache.end()) {
2471 llvm::Value *V = FI->second;
2472 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2473 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2474 llvm::MDNode *SPN = SP;
2475 LexicalBlockStack.push_back(SPN);
2476 RegionMap[D] = llvm::WeakVH(SP);
2477 return;
2478 }
2479 }
2480 Name = getFunctionName(FD);
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002481 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00002482 if (FD->hasPrototype()) {
2483 LinkageName = CGM.getMangledName(GD);
2484 Flags |= llvm::DIDescriptor::FlagPrototyped;
2485 }
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002486 // No need to replicate the linkage name if it isn't different from the
2487 // subprogram name, no need to have it at all unless coverage is enabled or
2488 // debug is set to more than just line tables.
Guy Benyei11169dd2012-12-18 14:30:41 +00002489 if (LinkageName == Name ||
Nick Lewyckyc02bbb62013-03-20 01:38:16 +00002490 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2491 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher75e17682013-05-16 00:45:23 +00002492 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei11169dd2012-12-18 14:30:41 +00002493 LinkageName = StringRef();
2494
Eric Christopher75e17682013-05-16 00:45:23 +00002495 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Eric Christopher4cbd0d9d2014-03-27 05:29:34 +00002496 if (const NamespaceDecl *NSDecl =
2497 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2498 FDContext = getOrCreateNameSpace(NSDecl);
2499 else if (const RecordDecl *RDecl =
2500 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2501 FDContext = getContextDescriptor(cast<Decl>(RDecl));
2502
2503 // Collect template parameters.
Guy Benyei11169dd2012-12-18 14:30:41 +00002504 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2505 }
2506 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2507 Name = getObjCMethodName(OMD);
2508 Flags |= llvm::DIDescriptor::FlagPrototyped;
2509 } else {
2510 // Use llvm function name.
2511 Name = Fn->getName();
2512 Flags |= llvm::DIDescriptor::FlagPrototyped;
2513 }
2514 if (!Name.empty() && Name[0] == '\01')
2515 Name = Name.substr(1);
2516
Adrian Prantl42d71b92014-04-10 23:21:53 +00002517 if (!HasDecl || D->isImplicit()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002518 Flags |= llvm::DIDescriptor::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002519 // Artificial functions without a location should not silently reuse CurLoc.
2520 if (Loc.isInvalid())
2521 CurLoc = SourceLocation();
2522 }
2523 unsigned LineNo = getLineNumber(Loc);
2524 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002525
Eric Christopher8018e412014-03-27 18:50:35 +00002526 // FIXME: The function declaration we're constructing here is mostly reusing
2527 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2528 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2529 // all subprograms instead of the actual context since subprogram definitions
2530 // are emitted as CU level entities by the backend.
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002531 llvm::DISubprogram SP =
2532 DBuilder.createFunction(FDContext, Name, LinkageName, Unit, LineNo,
2533 getOrCreateFunctionType(D, FnType, Unit),
2534 Fn->hasInternalLinkage(), true /*definition*/,
Adrian Prantl42d71b92014-04-10 23:21:53 +00002535 ScopeLine, Flags,
Eric Christopher9e6f5f92013-10-17 01:31:21 +00002536 CGM.getLangOpts().Optimize, Fn, TParamsArray,
2537 getFunctionDeclaration(D));
David Blaikiebd483762013-05-20 04:58:53 +00002538 if (HasDecl)
2539 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002540
Adrian Prantlbebb8932014-03-21 21:01:58 +00002541 // Push the function onto the lexical block stack.
Guy Benyei11169dd2012-12-18 14:30:41 +00002542 llvm::MDNode *SPN = SP;
2543 LexicalBlockStack.push_back(SPN);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002544
Guy Benyei11169dd2012-12-18 14:30:41 +00002545 if (HasDecl)
2546 RegionMap[D] = llvm::WeakVH(SP);
2547}
2548
2549/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl02c0caa2013-07-18 00:27:59 +00002550/// information in the source file. If the location is invalid, the
2551/// previous location will be reused.
Adrian Prantlc7822422013-03-12 20:43:25 +00002552void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
Adrian Prantle83b1302014-01-07 22:05:52 +00002553 bool ForceColumnInfo) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002554 // Update our current location
2555 setLocation(Loc);
2556
2557 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2558
2559 // Don't bother if things are the same as last time.
2560 SourceManager &SM = CGM.getContext().getSourceManager();
2561 if (CurLoc == PrevLoc ||
2562 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2563 // New Builder may not be in sync with CGDebugInfo.
David Blaikie357aafb2013-02-01 19:09:49 +00002564 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2565 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2566 LexicalBlockStack.back())
Guy Benyei11169dd2012-12-18 14:30:41 +00002567 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002568
Guy Benyei11169dd2012-12-18 14:30:41 +00002569 // Update last state.
2570 PrevLoc = CurLoc;
2571
Adrian Prantle83b1302014-01-07 22:05:52 +00002572 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantlc7822422013-03-12 20:43:25 +00002573 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2574 (getLineNumber(CurLoc),
2575 getColumnNumber(CurLoc, ForceColumnInfo),
2576 Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002577}
2578
2579/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2580/// the stack.
2581void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
David Blaikief9ea2422014-06-02 16:32:05 +00002582 llvm::DIDescriptor D = DBuilder.createLexicalBlock(
2583 llvm::DIDescriptor(LexicalBlockStack.empty() ? nullptr
2584 : LexicalBlockStack.back()),
2585 getOrCreateFile(CurLoc), getLineNumber(CurLoc), getColumnNumber(CurLoc),
2586 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002587 llvm::MDNode *DN = D;
2588 LexicalBlockStack.push_back(DN);
2589}
2590
2591/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2592/// region - beginning of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002593void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2594 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002595 // Set our current location.
2596 setLocation(Loc);
2597
2598 // Create a new lexical block and push it on the stack.
2599 CreateLexicalBlock(Loc);
2600
2601 // Emit a line table change for the current location inside the new scope.
2602 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2603 getColumnNumber(Loc),
2604 LexicalBlockStack.back()));
2605}
2606
2607/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2608/// region - end of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002609void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2610 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002611 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2612
2613 // Provide an entry in the line table for the end of the block.
2614 EmitLocation(Builder, Loc);
2615
2616 LexicalBlockStack.pop_back();
2617}
2618
2619/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2620void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2621 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2622 unsigned RCount = FnBeginRegionCount.back();
2623 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2624
2625 // Pop all regions for this function.
2626 while (LexicalBlockStack.size() != RCount)
2627 EmitLexicalBlockEnd(Builder, CurLoc);
2628 FnBeginRegionCount.pop_back();
2629}
2630
Eric Christopherb2a008c2013-05-16 00:45:12 +00002631// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei11169dd2012-12-18 14:30:41 +00002632// See BuildByRefType.
2633llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2634 uint64_t *XOffset) {
2635
2636 SmallVector<llvm::Value *, 5> EltTys;
2637 QualType FType;
2638 uint64_t FieldSize, FieldOffset;
2639 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002640
Guy Benyei11169dd2012-12-18 14:30:41 +00002641 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002642 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002643
2644 FieldOffset = 0;
2645 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2646 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2647 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2648 FType = CGM.getContext().IntTy;
2649 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2650 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2651
2652 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2653 if (HasCopyAndDispose) {
2654 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2655 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2656 &FieldOffset));
2657 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2658 &FieldOffset));
2659 }
2660 bool HasByrefExtendedLayout;
2661 Qualifiers::ObjCLifetime Lifetime;
2662 if (CGM.getContext().getByrefLifetime(Type,
2663 Lifetime, HasByrefExtendedLayout)
Adrian Prantlead2ba42013-07-23 00:12:14 +00002664 && HasByrefExtendedLayout) {
2665 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002666 EltTys.push_back(CreateMemberType(Unit, FType,
2667 "__byref_variable_layout",
2668 &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002669 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002670
Guy Benyei11169dd2012-12-18 14:30:41 +00002671 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2672 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002673 CGM.getTarget().getPointerAlign(0))) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002674 CharUnits FieldOffsetInBytes
Guy Benyei11169dd2012-12-18 14:30:41 +00002675 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2676 CharUnits AlignedOffsetInBytes
2677 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2678 CharUnits NumPaddingBytes
2679 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002680
Guy Benyei11169dd2012-12-18 14:30:41 +00002681 if (NumPaddingBytes.isPositive()) {
2682 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2683 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2684 pad, ArrayType::Normal, 0);
2685 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2686 }
2687 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002688
Guy Benyei11169dd2012-12-18 14:30:41 +00002689 FType = Type;
David Blaikief427b002014-05-06 03:42:01 +00002690 llvm::DIType FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002691 FieldSize = CGM.getContext().getTypeSize(FType);
2692 FieldAlign = CGM.getContext().toBits(Align);
2693
Eric Christopherb2a008c2013-05-16 00:45:12 +00002694 *XOffset = FieldOffset;
Guy Benyei11169dd2012-12-18 14:30:41 +00002695 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2696 0, FieldSize, FieldAlign,
2697 FieldOffset, 0, FieldTy);
2698 EltTys.push_back(FieldTy);
2699 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002700
Guy Benyei11169dd2012-12-18 14:30:41 +00002701 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002702
Guy Benyei11169dd2012-12-18 14:30:41 +00002703 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002704
Guy Benyei11169dd2012-12-18 14:30:41 +00002705 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00002706 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002707}
2708
2709/// EmitDeclare - Emit local variable declaration debug info.
Ed Masteda706022014-05-07 12:49:30 +00002710void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::dwarf::LLVMConstants Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +00002711 llvm::Value *Storage,
Guy Benyei11169dd2012-12-18 14:30:41 +00002712 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002713 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002714 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2715
David Blaikie7fceebf2013-08-19 03:37:48 +00002716 bool Unwritten =
2717 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2718 cast<Decl>(VD->getDeclContext())->isImplicit());
2719 llvm::DIFile Unit;
2720 if (!Unwritten)
2721 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002722 llvm::DIType Ty;
2723 uint64_t XOffset = 0;
2724 if (VD->hasAttr<BlocksAttr>())
2725 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002726 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002727 Ty = getOrCreateType(VD->getType(), Unit);
2728
2729 // If there is no debug info for this type then do not emit debug info
2730 // for this variable.
2731 if (!Ty)
2732 return;
2733
Guy Benyei11169dd2012-12-18 14:30:41 +00002734 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002735 unsigned Line = 0;
2736 unsigned Column = 0;
2737 if (!Unwritten) {
2738 Line = getLineNumber(VD->getLocation());
2739 Column = getColumnNumber(VD->getLocation());
2740 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002741 unsigned Flags = 0;
2742 if (VD->isImplicit())
2743 Flags |= llvm::DIDescriptor::FlagArtificial;
2744 // If this is the first argument and it is implicit then
2745 // give it an object pointer flag.
2746 // FIXME: There has to be a better way to do this, but for static
2747 // functions there won't be an implicit param at arg1 and
2748 // otherwise it is 'self' or 'this'.
2749 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2750 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002751 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002752 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2753 !VD->getType()->isPointerType())
David Blaikieb9c667d2013-06-19 21:53:53 +00002754 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
Guy Benyei11169dd2012-12-18 14:30:41 +00002755
2756 llvm::MDNode *Scope = LexicalBlockStack.back();
2757
2758 StringRef Name = VD->getName();
2759 if (!Name.empty()) {
2760 if (VD->hasAttr<BlocksAttr>()) {
2761 CharUnits offset = CharUnits::fromQuantity(32);
2762 SmallVector<llvm::Value *, 9> addr;
2763 llvm::Type *Int64Ty = CGM.Int64Ty;
2764 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2765 // offset of __forwarding field
2766 offset = CGM.getContext().toCharUnitsFromBits(
John McCallc8e01702013-04-16 22:48:15 +00002767 CGM.getTarget().getPointerWidth(0));
Guy Benyei11169dd2012-12-18 14:30:41 +00002768 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2769 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2770 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2771 // offset of x field
2772 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2773 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2774
2775 // Create the descriptor for the variable.
2776 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002777 DBuilder.createComplexVariable(Tag,
Guy Benyei11169dd2012-12-18 14:30:41 +00002778 llvm::DIDescriptor(Scope),
2779 VD->getName(), Unit, Line, Ty,
2780 addr, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002781
Guy Benyei11169dd2012-12-18 14:30:41 +00002782 // Insert an llvm.dbg.declare into the current block.
2783 llvm::Instruction *Call =
2784 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2785 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2786 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00002787 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl0315f382013-09-18 22:08:57 +00002788 Flags |= llvm::DIDescriptor::FlagIndirectVariable;
David Blaikiea76a7c92013-01-05 05:58:35 +00002789 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2790 // If VD is an anonymous union then Storage represents value for
2791 // all union fields.
Guy Benyei11169dd2012-12-18 14:30:41 +00002792 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikie219c7d92013-01-05 20:03:07 +00002793 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002794 for (const auto *Field : RD->fields()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002795 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2796 StringRef FieldName = Field->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002797
Guy Benyei11169dd2012-12-18 14:30:41 +00002798 // Ignore unnamed fields. Do not ignore unnamed records.
2799 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2800 continue;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002801
Guy Benyei11169dd2012-12-18 14:30:41 +00002802 // Use VarDecl's Tag, Scope and Line number.
2803 llvm::DIVariable D =
2804 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopherb2a008c2013-05-16 00:45:12 +00002805 FieldName, Unit, Line, FieldTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00002806 CGM.getLangOpts().Optimize, Flags,
2807 ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002808
Guy Benyei11169dd2012-12-18 14:30:41 +00002809 // Insert an llvm.dbg.declare into the current block.
2810 llvm::Instruction *Call =
2811 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2812 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2813 }
David Blaikie219c7d92013-01-05 20:03:07 +00002814 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002815 }
2816 }
David Blaikiea76a7c92013-01-05 05:58:35 +00002817
2818 // Create the descriptor for the variable.
2819 llvm::DIVariable D =
2820 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2821 Name, Unit, Line, Ty,
2822 CGM.getLangOpts().Optimize, Flags, ArgNo);
2823
2824 // Insert an llvm.dbg.declare into the current block.
2825 llvm::Instruction *Call =
2826 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2827 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002828}
2829
2830void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2831 llvm::Value *Storage,
2832 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002833 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002834 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2835}
2836
Adrian Prantlde17db32013-03-29 19:20:29 +00002837/// Look up the completed type for a self pointer in the TypeCache and
2838/// create a copy of it with the ObjectPointer and Artificial flags
2839/// set. If the type is not cached, a new one is created. This should
2840/// never happen though, since creating a type for the implicit self
2841/// argument implies that we already parsed the interface definition
2842/// and the ivar declarations in the implementation.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002843llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2844 llvm::DIType Ty) {
Adrian Prantlde17db32013-03-29 19:20:29 +00002845 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christopherf8bc4d82013-07-18 00:52:50 +00002846 if (CachedTy) Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00002847 return DBuilder.createObjectPointerType(Ty);
2848}
2849
Guy Benyei11169dd2012-12-18 14:30:41 +00002850void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2851 llvm::Value *Storage,
2852 CGBuilderTy &Builder,
2853 const CGBlockInfo &blockInfo) {
Eric Christopher75e17682013-05-16 00:45:23 +00002854 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002855 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00002856
Craig Topper8a13c412014-05-21 05:09:00 +00002857 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00002858 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002859
Guy Benyei11169dd2012-12-18 14:30:41 +00002860 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002861
Guy Benyei11169dd2012-12-18 14:30:41 +00002862 uint64_t XOffset = 0;
2863 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2864 llvm::DIType Ty;
2865 if (isByRef)
2866 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002867 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002868 Ty = getOrCreateType(VD->getType(), Unit);
2869
2870 // Self is passed along as an implicit non-arg variable in a
2871 // block. Mark it as the object pointer.
2872 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00002873 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002874
2875 // Get location information.
2876 unsigned Line = getLineNumber(VD->getLocation());
2877 unsigned Column = getColumnNumber(VD->getLocation());
2878
2879 const llvm::DataLayout &target = CGM.getDataLayout();
2880
2881 CharUnits offset = CharUnits::fromQuantity(
2882 target.getStructLayout(blockInfo.StructureType)
2883 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2884
2885 SmallVector<llvm::Value *, 9> addr;
2886 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl0f6df002013-03-29 19:20:35 +00002887 if (isa<llvm::AllocaInst>(Storage))
2888 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei11169dd2012-12-18 14:30:41 +00002889 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2890 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2891 if (isByRef) {
2892 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2893 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2894 // offset of __forwarding field
2895 offset = CGM.getContext()
2896 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2897 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2898 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2899 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2900 // offset of x field
2901 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2902 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2903 }
2904
2905 // Create the descriptor for the variable.
2906 llvm::DIVariable D =
Eric Christopherb2a008c2013-05-16 00:45:12 +00002907 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei11169dd2012-12-18 14:30:41 +00002908 llvm::DIDescriptor(LexicalBlockStack.back()),
2909 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl0f6df002013-03-29 19:20:35 +00002910
Guy Benyei11169dd2012-12-18 14:30:41 +00002911 // Insert an llvm.dbg.declare into the current block.
2912 llvm::Instruction *Call =
2913 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2914 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2915 LexicalBlockStack.back()));
2916}
2917
2918/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2919/// variable declaration.
2920void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2921 unsigned ArgNo,
2922 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002923 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002924 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2925}
2926
2927namespace {
2928 struct BlockLayoutChunk {
2929 uint64_t OffsetInBits;
2930 const BlockDecl::Capture *Capture;
2931 };
2932 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2933 return l.OffsetInBits < r.OffsetInBits;
2934 }
2935}
2936
2937void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00002938 llvm::Value *Arg,
2939 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00002940 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002941 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002942 ASTContext &C = CGM.getContext();
2943 const BlockDecl *blockDecl = block.getBlockDecl();
2944
2945 // Collect some general information about the block's location.
2946 SourceLocation loc = blockDecl->getCaretLocation();
2947 llvm::DIFile tunit = getOrCreateFile(loc);
2948 unsigned line = getLineNumber(loc);
2949 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002950
Guy Benyei11169dd2012-12-18 14:30:41 +00002951 // Build the debug-info type for the block literal.
2952 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2953
2954 const llvm::StructLayout *blockLayout =
2955 CGM.getDataLayout().getStructLayout(block.StructureType);
2956
2957 SmallVector<llvm::Value*, 16> fields;
2958 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2959 blockLayout->getElementOffsetInBits(0),
2960 tunit, tunit));
2961 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2962 blockLayout->getElementOffsetInBits(1),
2963 tunit, tunit));
2964 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2965 blockLayout->getElementOffsetInBits(2),
2966 tunit, tunit));
2967 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2968 blockLayout->getElementOffsetInBits(3),
2969 tunit, tunit));
2970 fields.push_back(createFieldType("__descriptor",
2971 C.getPointerType(block.NeedsCopyDispose ?
2972 C.getBlockDescriptorExtendedType() :
2973 C.getBlockDescriptorType()),
2974 0, loc, AS_public,
2975 blockLayout->getElementOffsetInBits(4),
2976 tunit, tunit));
2977
2978 // We want to sort the captures by offset, not because DWARF
2979 // requires this, but because we're paranoid about debuggers.
2980 SmallVector<BlockLayoutChunk, 8> chunks;
2981
2982 // 'this' capture.
2983 if (blockDecl->capturesCXXThis()) {
2984 BlockLayoutChunk chunk;
2985 chunk.OffsetInBits =
2986 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00002987 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002988 chunks.push_back(chunk);
2989 }
2990
2991 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002992 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002993 const VarDecl *variable = capture.getVariable();
2994 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2995
2996 // Ignore constant captures.
2997 if (captureInfo.isConstant())
2998 continue;
2999
3000 BlockLayoutChunk chunk;
3001 chunk.OffsetInBits =
3002 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
3003 chunk.Capture = &capture;
3004 chunks.push_back(chunk);
3005 }
3006
3007 // Sort by offset.
3008 llvm::array_pod_sort(chunks.begin(), chunks.end());
3009
3010 for (SmallVectorImpl<BlockLayoutChunk>::iterator
3011 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
3012 uint64_t offsetInBits = i->OffsetInBits;
3013 const BlockDecl::Capture *capture = i->Capture;
3014
3015 // If we have a null capture, this must be the C++ 'this' capture.
3016 if (!capture) {
3017 const CXXMethodDecl *method =
3018 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
3019 QualType type = method->getThisType(C);
3020
3021 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3022 offsetInBits, tunit, tunit));
3023 continue;
3024 }
3025
3026 const VarDecl *variable = capture->getVariable();
3027 StringRef name = variable->getName();
3028
3029 llvm::DIType fieldType;
3030 if (capture->isByRef()) {
3031 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
3032
3033 // FIXME: this creates a second copy of this type!
3034 uint64_t xoffset;
3035 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
3036 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
3037 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3038 ptrInfo.first, ptrInfo.second,
3039 offsetInBits, 0, fieldType);
3040 } else {
3041 fieldType = createFieldType(name, variable->getType(), 0,
3042 loc, AS_public, offsetInBits, tunit, tunit);
3043 }
3044 fields.push_back(fieldType);
3045 }
3046
3047 SmallString<36> typeName;
3048 llvm::raw_svector_ostream(typeName)
3049 << "__block_literal_" << CGM.getUniqueBlockCount();
3050
3051 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3052
3053 llvm::DIType type =
3054 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3055 CGM.getContext().toBits(block.BlockSize),
3056 CGM.getContext().toBits(block.BlockAlign),
David Blaikie6d4fe152013-02-25 01:07:08 +00003057 0, llvm::DIType(), fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003058 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3059
3060 // Get overall information about the block.
3061 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3062 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei11169dd2012-12-18 14:30:41 +00003063
3064 // Create the descriptor for the parameter.
3065 llvm::DIVariable debugVar =
3066 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopherb2a008c2013-05-16 00:45:12 +00003067 llvm::DIDescriptor(scope),
Adrian Prantl51936dd2013-03-14 17:53:33 +00003068 Arg->getName(), tunit, line, type,
Guy Benyei11169dd2012-12-18 14:30:41 +00003069 CGM.getLangOpts().Optimize, flags,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003070 cast<llvm::Argument>(Arg)->getArgNo() + 1);
3071
Adrian Prantl616bef42013-03-14 21:52:59 +00003072 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003073 // Insert an llvm.dbg.value into the current block.
Adrian Prantl616bef42013-03-14 21:52:59 +00003074 llvm::Instruction *DbgVal =
3075 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00003076 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003077 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3078 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003079
Adrian Prantl616bef42013-03-14 21:52:59 +00003080 // Insert an llvm.dbg.declare into the current block.
3081 llvm::Instruction *DbgDecl =
3082 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
3083 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003084}
3085
David Blaikie6943dea2013-08-20 01:28:15 +00003086/// If D is an out-of-class definition of a static data member of a class, find
3087/// its corresponding in-class declaration.
3088llvm::DIDerivedType
3089CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3090 if (!D->isStaticDataMember())
3091 return llvm::DIDerivedType();
3092 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator MI =
3093 StaticDataMemberCache.find(D->getCanonicalDecl());
3094 if (MI != StaticDataMemberCache.end()) {
3095 assert(MI->second && "Static data member declaration should still exist");
3096 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003097 }
David Blaikiece763042013-08-20 21:49:21 +00003098
3099 // If the member wasn't found in the cache, lazily construct and add it to the
3100 // type (used when a limited form of the type is emitted).
David Blaikie6943dea2013-08-20 01:28:15 +00003101 llvm::DICompositeType Ctxt(
3102 getContextDescriptor(cast<Decl>(D->getDeclContext())));
3103 llvm::DIDerivedType T = CreateRecordStaticField(D, Ctxt);
David Blaikie6943dea2013-08-20 01:28:15 +00003104 return T;
3105}
3106
Eric Christophercab9fae2014-04-10 05:20:00 +00003107/// Recursively collect all of the member fields of a global anonymous decl and
3108/// create static variables for them. The first time this is called it needs
3109/// to be on a union and then from there we can have additional unnamed fields.
3110llvm::DIGlobalVariable
3111CGDebugInfo::CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile Unit,
3112 unsigned LineNo, StringRef LinkageName,
3113 llvm::GlobalVariable *Var,
3114 llvm::DIDescriptor DContext) {
3115 llvm::DIGlobalVariable GV;
3116
3117 for (const auto *Field : RD->fields()) {
3118 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
3119 StringRef FieldName = Field->getName();
3120
3121 // Ignore unnamed fields, but recurse into anonymous records.
3122 if (FieldName.empty()) {
3123 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3124 if (RT)
3125 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3126 Var, DContext);
3127 continue;
3128 }
3129 // Use VarDecl's Tag, Scope and Line number.
3130 GV = DBuilder.createStaticVariable(DContext, FieldName, LinkageName, Unit,
3131 LineNo, FieldTy,
3132 Var->hasInternalLinkage(), Var,
3133 llvm::DIDerivedType());
3134 }
3135 return GV;
3136}
3137
Guy Benyei11169dd2012-12-18 14:30:41 +00003138/// EmitGlobalVariable - Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003139void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003140 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003141 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003142 // Create global variable debug descriptor.
3143 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
3144 unsigned LineNo = getLineNumber(D->getLocation());
3145
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003146 setLocation(D->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00003147
3148 QualType T = D->getType();
3149 if (T->isIncompleteArrayType()) {
3150
3151 // CodeGen turns int[] into int[1] so we'll do the same here.
3152 llvm::APInt ConstVal(32, 1);
3153 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3154
3155 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3156 ArrayType::Normal, 0);
3157 }
Eric Christophercab9fae2014-04-10 05:20:00 +00003158
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003159 StringRef DeclName = D->getName();
3160 StringRef LinkageName;
Eric Christophercab9fae2014-04-10 05:20:00 +00003161 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext()) &&
3162 !isa<ObjCMethodDecl>(D->getDeclContext()))
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003163 LinkageName = Var->getName();
3164 if (LinkageName == DeclName)
3165 LinkageName = StringRef();
Eric Christophercab9fae2014-04-10 05:20:00 +00003166
Eric Christopherb2a008c2013-05-16 00:45:12 +00003167 llvm::DIDescriptor DContext =
Guy Benyei11169dd2012-12-18 14:30:41 +00003168 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
Eric Christophercab9fae2014-04-10 05:20:00 +00003169
3170 // Attempt to store one global variable for the declaration - even if we
3171 // emit a lot of fields.
3172 llvm::DIGlobalVariable GV;
3173
3174 // If this is an anonymous union then we'll want to emit a global
3175 // variable for each member of the anonymous union so that it's possible
3176 // to find the name of any field in the union.
3177 if (T->isUnionType() && DeclName.empty()) {
3178 const RecordDecl *RD = cast<RecordType>(T)->getDecl();
3179 assert(RD->isAnonymousStructOrUnion() && "unnamed non-anonymous struct or union?");
3180 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3181 } else {
3182 GV = DBuilder.createStaticVariable(
3183 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3184 Var->hasInternalLinkage(), Var,
3185 getOrCreateStaticDataMemberDeclarationOrNull(D));
3186 }
David Blaikiebd483762013-05-20 04:58:53 +00003187 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003188}
3189
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003190/// EmitGlobalVariable - Emit global variable's debug info.
3191void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3192 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003193 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003194 // Create the descriptor for the variable.
3195 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3196 StringRef Name = VD->getName();
3197 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3198 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3199 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3200 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3201 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3202 }
3203 // Do not use DIGlobalVariable for enums.
3204 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3205 return;
David Blaikiea15565562014-04-04 20:56:17 +00003206 // Do not emit separate definitions for function local const/statics.
3207 if (isa<FunctionDecl>(VD->getDeclContext()))
3208 return;
David Blaikiebb113912014-04-05 07:23:17 +00003209 VD = cast<ValueDecl>(VD->getCanonicalDecl());
3210 auto pair = DeclCache.insert(std::make_pair(VD, llvm::WeakVH()));
3211 if (!pair.second)
3212 return;
David Blaikie506a7452014-04-05 07:46:57 +00003213 llvm::DIDescriptor DContext =
3214 getContextDescriptor(dyn_cast<Decl>(VD->getDeclContext()));
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003215 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003216 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
3217 true, Init,
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003218 getOrCreateStaticDataMemberDeclarationOrNull(cast<VarDecl>(VD)));
David Blaikiebb113912014-04-05 07:23:17 +00003219 pair.first->second = llvm::WeakVH(GV);
David Blaikiebd483762013-05-20 04:58:53 +00003220}
3221
3222llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3223 if (!LexicalBlockStack.empty())
3224 return llvm::DIScope(LexicalBlockStack.back());
3225 return getContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003226}
3227
David Blaikie9f88fe82013-04-22 06:13:21 +00003228void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003229 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3230 return;
David Blaikie9f88fe82013-04-22 06:13:21 +00003231 DBuilder.createImportedModule(
David Blaikiebd483762013-05-20 04:58:53 +00003232 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3233 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie9f88fe82013-04-22 06:13:21 +00003234 getLineNumber(UD.getLocation()));
3235}
3236
David Blaikiebd483762013-05-20 04:58:53 +00003237void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3238 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3239 return;
3240 assert(UD.shadow_size() &&
3241 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3242 // Emitting one decl is sufficient - debuggers can detect that this is an
3243 // overloaded name & provide lookup for all the overloads.
3244 const UsingShadowDecl &USD = **UD.shadow_begin();
Adrian Prantl6cdce9e2014-04-01 03:41:01 +00003245 if (llvm::DIScope Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003246 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003247 DBuilder.createImportedDeclaration(
3248 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3249 getLineNumber(USD.getLocation()));
3250}
3251
David Blaikief121b932013-05-20 22:50:41 +00003252llvm::DIImportedEntity
3253CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3254 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00003255 return llvm::DIImportedEntity(nullptr);
David Blaikief121b932013-05-20 22:50:41 +00003256 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3257 if (VH)
3258 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
Craig Topper8a13c412014-05-21 05:09:00 +00003259 llvm::DIImportedEntity R(nullptr);
David Blaikief121b932013-05-20 22:50:41 +00003260 if (const NamespaceAliasDecl *Underlying =
3261 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3262 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003263 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003264 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3265 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3266 NA.getName());
3267 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003268 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003269 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3270 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3271 getLineNumber(NA.getLocation()), NA.getName());
3272 VH = R;
3273 return R;
3274}
3275
Guy Benyei11169dd2012-12-18 14:30:41 +00003276/// getOrCreateNamesSpace - Return namespace descriptor for the given
3277/// namespace decl.
Eric Christopherb2a008c2013-05-16 00:45:12 +00003278llvm::DINameSpace
Guy Benyei11169dd2012-12-18 14:30:41 +00003279CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003280 NSDecl = NSDecl->getCanonicalDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003281 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei11169dd2012-12-18 14:30:41 +00003282 NameSpaceCache.find(NSDecl);
3283 if (I != NameSpaceCache.end())
3284 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003285
Guy Benyei11169dd2012-12-18 14:30:41 +00003286 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3287 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003288 llvm::DIDescriptor Context =
Guy Benyei11169dd2012-12-18 14:30:41 +00003289 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3290 llvm::DINameSpace NS =
3291 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3292 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3293 return NS;
3294}
3295
3296void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003297 // Creating types might create further types - invalidating the current
3298 // element and the size(), so don't cache/reference them.
3299 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3300 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
3301 E.Decl.replaceAllUsesWith(CGM.getLLVMContext(),
3302 E.Type->getDecl()->getDefinition()
3303 ? CreateTypeDefinition(E.Type, E.Unit)
3304 : E.Decl);
3305 }
3306
David Blaikief427b002014-05-06 03:42:01 +00003307 for (auto p : ReplaceMap) {
3308 assert(p.second);
3309 llvm::DIType Ty(cast<llvm::MDNode>(p.second));
David Blaikieb8149042014-05-05 21:21:39 +00003310 assert(Ty.isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003311
David Blaikief427b002014-05-06 03:42:01 +00003312 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003313 assert(it != TypeCache.end());
3314 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003315
David Blaikief427b002014-05-06 03:42:01 +00003316 llvm::DIType RepTy(cast<llvm::MDNode>(it->second));
3317 Ty.replaceAllUsesWith(CGM.getLLVMContext(), RepTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003318 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003319
3320 // We keep our own list of retained types, because we need to look
3321 // up the final type in the type cache.
3322 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3323 RE = RetainedTypes.end(); RI != RE; ++RI)
David Blaikie0856f662014-03-04 22:01:08 +00003324 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003325
Guy Benyei11169dd2012-12-18 14:30:41 +00003326 DBuilder.finalize();
3327}