blob: 3fb839369dbece1bf91a602ffd802d24793bd845 [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
David Blaikie66e41972015-01-14 07:38:27 +000055ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
David Blaikie835afb22015-01-21 23:08:17 +000056 SourceLocation TemporaryLocation)
David Blaikie66e41972015-01-14 07:38:27 +000057 : CGF(CGF) {
Adrian Prantl39428e72015-02-03 18:40:42 +000058 assert(!TemporaryLocation.isInvalid() && "invalid location");
David Blaikie9b479662015-01-25 01:19:10 +000059 init(TemporaryLocation);
60}
61
Adrian Prantl39428e72015-02-03 18:40:42 +000062ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
63 bool MarkAsPrologue,
64 SourceLocation TemporaryLocation)
65 : CGF(CGF) {
66 init(TemporaryLocation, MarkAsPrologue);
67}
68
69void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
70 bool MarkAsPrologue) {
David Blaikie66e41972015-01-14 07:38:27 +000071 if (auto *DI = CGF.getDebugInfo()) {
72 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
Adrian Prantl39428e72015-02-03 18:40:42 +000073 if (TemporaryLocation.isInvalid()) {
74 if (MarkAsPrologue)
75 CGF.Builder.SetCurrentDebugLocation(llvm::DebugLoc());
76 else {
77 // Construct a location that has a valid scope, but no line info.
78 assert(!DI->LexicalBlockStack.empty());
79 llvm::DIDescriptor Scope(DI->LexicalBlockStack.back());
80 CGF.Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(0, 0, Scope));
81 }
82 } else
David Blaikie835afb22015-01-21 23:08:17 +000083 DI->EmitLocation(CGF.Builder, TemporaryLocation);
David Blaikie66e41972015-01-14 07:38:27 +000084 }
Adrian Prantl2e0637f2013-07-18 00:28:02 +000085}
86
David Blaikie9b479662015-01-25 01:19:10 +000087ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
88 : CGF(CGF) {
89 init(E->getExprLoc());
90}
91
David Blaikie66e41972015-01-14 07:38:27 +000092ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
93 : CGF(CGF) {
94 if (CGF.getDebugInfo()) {
95 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
96 if (!Loc.isUnknown())
97 CGF.Builder.SetCurrentDebugLocation(Loc);
98 }
99}
100
101ApplyDebugLocation::~ApplyDebugLocation() {
102 // Query CGF so the location isn't overwritten when location updates are
103 // temporarily disabled (for C++ default function arguments)
104 if (CGF.getDebugInfo())
105 CGF.Builder.SetCurrentDebugLocation(OriginalLocation);
106}
107
108/// ArtificialLocation - An RAII object that temporarily switches to
109/// an artificial debug location that has a valid scope, but no line
Guy Benyei11169dd2012-12-18 14:30:41 +0000110void CGDebugInfo::setLocation(SourceLocation Loc) {
111 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000112 if (Loc.isInvalid())
113 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000114
115 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
116
117 // If we've changed files in the middle of a lexical scope go ahead
118 // and create a new lexical scope with file node if it's different
119 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000120 if (LexicalBlockStack.empty())
121 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000122
123 SourceManager &SM = CGM.getContext().getSourceManager();
David Blaikieaabde052014-05-14 00:29:00 +0000124 llvm::DIScope Scope(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000125 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000126
David Blaikieaabde052014-05-14 00:29:00 +0000127 if (PCLoc.isInvalid() || Scope.getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000128 return;
129
Guy Benyei11169dd2012-12-18 14:30:41 +0000130 if (Scope.isLexicalBlockFile()) {
David Blaikieaabde052014-05-14 00:29:00 +0000131 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(Scope);
Eric Christophere7b87e52014-10-26 23:40:33 +0000132 llvm::DIDescriptor D = DBuilder.createLexicalBlockFile(
133 LBF.getScope(), getOrCreateFile(CurLoc));
Guy Benyei11169dd2012-12-18 14:30:41 +0000134 llvm::MDNode *N = D;
135 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000136 LexicalBlockStack.emplace_back(N);
David Blaikie0a21d0d2013-01-26 22:16:26 +0000137 } else if (Scope.isLexicalBlock() || Scope.isSubprogram()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000138 llvm::DIDescriptor D =
139 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
Guy Benyei11169dd2012-12-18 14:30:41 +0000140 llvm::MDNode *N = D;
141 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000142 LexicalBlockStack.emplace_back(N);
Guy Benyei11169dd2012-12-18 14:30:41 +0000143 }
144}
145
146/// getContextDescriptor - Get context info for the decl.
David Blaikiebfa52742013-04-19 06:56:38 +0000147llvm::DIScope CGDebugInfo::getContextDescriptor(const Decl *Context) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000148 if (!Context)
149 return TheCU;
150
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000151 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000152 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000153 llvm::Metadata *V = I->second;
David Blaikiebfa52742013-04-19 06:56:38 +0000154 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
Guy Benyei11169dd2012-12-18 14:30:41 +0000155 }
156
157 // Check namespace.
158 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000159 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000160
David Blaikiebfa52742013-04-19 06:56:38 +0000161 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
162 if (!RDecl->isDependentType())
163 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000164 getOrCreateMainFile());
Guy Benyei11169dd2012-12-18 14:30:41 +0000165 return TheCU;
166}
167
168/// getFunctionName - Get function name for the given FunctionDecl. If the
Benjamin Kramer60509af2013-09-09 14:48:42 +0000169/// name is constructed on demand (e.g. C++ destructor) then the name
Guy Benyei11169dd2012-12-18 14:30:41 +0000170/// is stored on the side.
171StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000172 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000173 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000174 FunctionTemplateSpecializationInfo *Info =
175 FD->getTemplateSpecializationInfo();
Guy Benyei11169dd2012-12-18 14:30:41 +0000176 if (!Info && FII)
177 return FII->getName();
178
179 // Otherwise construct human readable name for debug info.
Benjamin Kramer9170e912013-02-22 15:46:01 +0000180 SmallString<128> NS;
181 llvm::raw_svector_ostream OS(NS);
182 FD->printName(OS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000183
184 // Add any template specialization args.
185 if (Info) {
186 const TemplateArgumentList *TArgs = Info->TemplateArguments;
187 const TemplateArgument *Args = TArgs->data();
188 unsigned NumArgs = TArgs->size();
189 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer9170e912013-02-22 15:46:01 +0000190 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
191 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000192 }
193
194 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000195 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000196}
197
198StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
199 SmallString<256> MethodName;
200 llvm::raw_svector_ostream OS(MethodName);
201 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
202 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000203 if (const ObjCImplementationDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000204 dyn_cast<const ObjCImplementationDecl>(DC)) {
205 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000206 } else if (const ObjCInterfaceDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000207 dyn_cast<const ObjCInterfaceDecl>(DC)) {
208 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000209 } else if (const ObjCCategoryImplDecl *OCD =
Eric Christophere7b87e52014-10-26 23:40:33 +0000210 dyn_cast<const ObjCCategoryImplDecl>(DC)) {
211 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
212 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000213 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000214 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000215 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000216 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000217 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000218 ClassTy.print(OS, PrintingPolicy(LangOptions()));
219 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000220 }
221 OS << ' ' << OMD->getSelector().getAsString() << ']';
222
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000223 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000224}
225
226/// getSelectorName - Return selector name. This is used for debugging
227/// info.
228StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000229 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000230}
231
232/// getClassName - Get class name including template argument list.
Eric Christophere7b87e52014-10-26 23:40:33 +0000233StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Blaikie65813a32014-04-02 18:21:09 +0000234 // quick optimization to avoid having to intern strings that are already
235 // stored reliably elsewhere
236 if (!isa<ClassTemplateSpecializationDecl>(RD))
Guy Benyei11169dd2012-12-18 14:30:41 +0000237 return RD->getName();
238
David Blaikie65813a32014-04-02 18:21:09 +0000239 SmallString<128> Name;
Benjamin Kramer9170e912013-02-22 15:46:01 +0000240 {
David Blaikie65813a32014-04-02 18:21:09 +0000241 llvm::raw_svector_ostream OS(Name);
242 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
243 /*Qualified*/ false);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000244 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000245
246 // Copy this name on the side and use its reference.
David Blaikie65813a32014-04-02 18:21:09 +0000247 return internString(Name);
Guy Benyei11169dd2012-12-18 14:30:41 +0000248}
249
250/// getOrCreateFile - Get the file debug info descriptor for the input location.
251llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
252 if (!Loc.isValid())
253 // If Location is not valid then use main input file.
254 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
255
256 SourceManager &SM = CGM.getContext().getSourceManager();
257 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
258
259 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
260 // If the location is not valid then use main input file.
261 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
262
263 // Cache the results.
264 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000265 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000266
267 if (it != DIFileCache.end()) {
268 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000269 if (llvm::Metadata *V = it->second)
Guy Benyei11169dd2012-12-18 14:30:41 +0000270 return llvm::DIFile(cast<llvm::MDNode>(V));
271 }
272
273 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
274
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000275 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000276 return F;
277}
278
279/// getOrCreateMainFile - Get the file info for main compile unit.
280llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
281 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
282}
283
284/// getLineNumber - Get line number for the location. If location is invalid
285/// then use current location.
286unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
287 if (Loc.isInvalid() && CurLoc.isInvalid())
288 return 0;
289 SourceManager &SM = CGM.getContext().getSourceManager();
290 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000291 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000292}
293
294/// getColumnNumber - Get column number for the location.
Adrian Prantlc7822422013-03-12 20:43:25 +0000295unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000296 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000297 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000298 return 0;
299
300 // If the location is invalid then use the current column.
301 if (Loc.isInvalid() && CurLoc.isInvalid())
302 return 0;
303 SourceManager &SM = CGM.getContext().getSourceManager();
304 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000305 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000306}
307
308StringRef CGDebugInfo::getCurrentDirname() {
309 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
310 return CGM.getCodeGenOpts().DebugCompilationDir;
311
312 if (!CWDName.empty())
313 return CWDName;
314 SmallString<256> CWD;
315 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000316 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000317}
318
319/// CreateCompileUnit - Create new compile unit.
320void CGDebugInfo::CreateCompileUnit() {
321
David Blaikieaabde052014-05-14 00:29:00 +0000322 // Should we be asking the SourceManager for the main file name, instead of
323 // accepting it as an argument? This just causes the main file name to
324 // mismatch with source locations and create extra lexical scopes or
325 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
326 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
327 // because that's what the SourceManager says)
328
Guy Benyei11169dd2012-12-18 14:30:41 +0000329 // Get absolute path name.
330 SourceManager &SM = CGM.getContext().getSourceManager();
331 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
332 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000333 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000334
335 // The main file name provided via the "-main-file-name" option contains just
336 // the file name itself with no path information. This file name may have had
337 // a relative path, so we look into the actual file entry for the main
338 // file to determine the real absolute path for the file.
339 std::string MainFileDir;
340 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
341 MainFileDir = MainFile->getDir()->getName();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000342 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000343 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
344 llvm::sys::path::append(MainFileDirSS, MainFileName);
345 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000346 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000347 }
348
349 // Save filename string.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000350 StringRef Filename = internString(MainFileName);
Eric Christopherf1545832013-02-22 23:50:16 +0000351
352 // Save split dwarf file string.
353 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000354 StringRef SplitDwarfFilename = internString(SplitDwarfFile);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000355
Ed Masteda706022014-05-07 12:49:30 +0000356 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000357 const LangOptions &LO = CGM.getLangOpts();
358 if (LO.CPlusPlus) {
359 if (LO.ObjC1)
360 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
361 else
362 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
363 } else if (LO.ObjC1) {
364 LangTag = llvm::dwarf::DW_LANG_ObjC;
365 } else if (LO.C99) {
366 LangTag = llvm::dwarf::DW_LANG_C99;
367 } else {
368 LangTag = llvm::dwarf::DW_LANG_C89;
369 }
370
371 std::string Producer = getClangFullVersion();
372
373 // Figure out which version of the ObjC runtime we have.
374 unsigned RuntimeVers = 0;
375 if (LO.ObjC1)
376 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
377
378 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000379 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000380 TheCU = DBuilder.createCompileUnit(
381 LangTag, Filename, getCurrentDirname(), Producer, LO.Optimize,
382 CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers, SplitDwarfFilename,
Diego Novillo913690c2014-06-24 17:02:17 +0000383 DebugKind <= CodeGenOptions::DebugLineTablesOnly
Eric Christophere4200a22014-02-27 01:25:08 +0000384 ? llvm::DIBuilder::LineTablesOnly
Diego Novillo913690c2014-06-24 17:02:17 +0000385 : llvm::DIBuilder::FullDebug,
386 DebugKind != CodeGenOptions::LocTrackingOnly);
Guy Benyei11169dd2012-12-18 14:30:41 +0000387}
388
389/// CreateType - Get the Basic type from the cache or create a new
390/// one if necessary.
391llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000392 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000393 StringRef BTName;
394 switch (BT->getKind()) {
395#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000396#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000397#include "clang/AST/BuiltinTypes.def"
398 case BuiltinType::Dependent:
399 llvm_unreachable("Unexpected builtin type");
400 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000401 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000402 case BuiltinType::Void:
403 return llvm::DIType();
404 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000405 if (!ClassTy)
406 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
407 "objc_class", TheCU,
408 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000409 return ClassTy;
410 case BuiltinType::ObjCId: {
411 // typedef struct objc_class *Class;
412 // typedef struct objc_object {
413 // Class isa;
414 // } *id;
415
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000416 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000417 return ObjTy;
418
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000419 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000420 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
421 "objc_class", TheCU,
422 getOrCreateMainFile(), 0);
423
424 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000425
Guy Benyei11169dd2012-12-18 14:30:41 +0000426 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
427
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000428 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000429 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
430 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000431
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000432 DBuilder.replaceArrays(
433 ObjTy,
434 DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
435 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 return ObjTy;
437 }
438 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000439 if (!SelTy)
440 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
441 "objc_selector", TheCU,
442 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000443 return SelTy;
444 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000445
446 case BuiltinType::OCLImage1d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000447 return getOrCreateStructPtrType("opencl_image1d_t", OCLImage1dDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000448 case BuiltinType::OCLImage1dArray:
Eric Christopherb2a008c2013-05-16 00:45:12 +0000449 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000450 OCLImage1dArrayDITy);
451 case BuiltinType::OCLImage1dBuffer:
452 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
453 OCLImage1dBufferDITy);
454 case BuiltinType::OCLImage2d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000455 return getOrCreateStructPtrType("opencl_image2d_t", OCLImage2dDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000456 case BuiltinType::OCLImage2dArray:
457 return getOrCreateStructPtrType("opencl_image2d_array_t",
458 OCLImage2dArrayDITy);
459 case BuiltinType::OCLImage3d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000460 return getOrCreateStructPtrType("opencl_image3d_t", OCLImage3dDITy);
Guy Benyei61054192013-02-07 10:55:47 +0000461 case BuiltinType::OCLSampler:
Eric Christophere7b87e52014-10-26 23:40:33 +0000462 return DBuilder.createBasicType(
463 "opencl_sampler_t", CGM.getContext().getTypeSize(BT),
464 CGM.getContext().getTypeAlign(BT), llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000465 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000466 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000467
Guy Benyei11169dd2012-12-18 14:30:41 +0000468 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000469 case BuiltinType::Char_U:
470 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
471 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000472 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000473 case BuiltinType::SChar:
474 Encoding = llvm::dwarf::DW_ATE_signed_char;
475 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000476 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000477 case BuiltinType::Char32:
478 Encoding = llvm::dwarf::DW_ATE_UTF;
479 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000480 case BuiltinType::UShort:
481 case BuiltinType::UInt:
482 case BuiltinType::UInt128:
483 case BuiltinType::ULong:
484 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000485 case BuiltinType::ULongLong:
486 Encoding = llvm::dwarf::DW_ATE_unsigned;
487 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000488 case BuiltinType::Short:
489 case BuiltinType::Int:
490 case BuiltinType::Int128:
491 case BuiltinType::Long:
492 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000493 case BuiltinType::LongLong:
494 Encoding = llvm::dwarf::DW_ATE_signed;
495 break;
496 case BuiltinType::Bool:
497 Encoding = llvm::dwarf::DW_ATE_boolean;
498 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000499 case BuiltinType::Half:
500 case BuiltinType::Float:
501 case BuiltinType::LongDouble:
Eric Christophere7b87e52014-10-26 23:40:33 +0000502 case BuiltinType::Double:
503 Encoding = llvm::dwarf::DW_ATE_float;
504 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000505 }
506
507 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000508 case BuiltinType::Long:
509 BTName = "long int";
510 break;
511 case BuiltinType::LongLong:
512 BTName = "long long int";
513 break;
514 case BuiltinType::ULong:
515 BTName = "long unsigned int";
516 break;
517 case BuiltinType::ULongLong:
518 BTName = "long long unsigned int";
519 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000520 default:
521 BTName = BT->getName(CGM.getLangOpts());
522 break;
523 }
524 // Bit size, align and offset of the type.
525 uint64_t Size = CGM.getContext().getTypeSize(BT);
526 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christophere7b87e52014-10-26 23:40:33 +0000527 llvm::DIType DbgTy = DBuilder.createBasicType(BTName, Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000528 return DbgTy;
529}
530
531llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
532 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000533 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000534 if (Ty->isComplexIntegerType())
535 Encoding = llvm::dwarf::DW_ATE_lo_user;
536
537 uint64_t Size = CGM.getContext().getTypeSize(Ty);
538 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000539 llvm::DIType DbgTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000540 DBuilder.createBasicType("complex", Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000541
542 return DbgTy;
543}
544
545/// CreateCVRType - Get the qualified type from the cache or create
546/// a new one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +0000547llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000548 QualifierCollector Qc;
549 const Type *T = Qc.strip(Ty);
550
551 // Ignore these qualifiers for now.
552 Qc.removeObjCGCAttr();
553 Qc.removeAddressSpace();
554 Qc.removeObjCLifetime();
555
556 // We will create one Derived type for one qualifier and recurse to handle any
557 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000558 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000559 if (Qc.hasConst()) {
560 Tag = llvm::dwarf::DW_TAG_const_type;
561 Qc.removeConst();
562 } else if (Qc.hasVolatile()) {
563 Tag = llvm::dwarf::DW_TAG_volatile_type;
564 Qc.removeVolatile();
565 } else if (Qc.hasRestrict()) {
566 Tag = llvm::dwarf::DW_TAG_restrict_type;
567 Qc.removeRestrict();
568 } else {
569 assert(Qc.empty() && "Unknown type qualifier for debug info");
570 return getOrCreateType(QualType(T, 0), Unit);
571 }
572
David Blaikie99dab3b2013-09-04 22:03:57 +0000573 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000574
575 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
576 // CVR derived types.
577 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000578
Guy Benyei11169dd2012-12-18 14:30:41 +0000579 return DbgTy;
580}
581
582llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
583 llvm::DIFile Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000584
585 // The frontend treats 'id' as a typedef to an ObjCObjectType,
586 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
587 // debug info, we want to emit 'id' in both cases.
588 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000589 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000590
Eric Christophere7b87e52014-10-26 23:40:33 +0000591 llvm::DIType DbgTy = CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type,
592 Ty, Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000593 return DbgTy;
594}
595
Eric Christophere7b87e52014-10-26 23:40:33 +0000596llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty, llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000597 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000598 Ty->getPointeeType(), Unit);
599}
600
Manman Rene0064d82013-08-29 23:19:58 +0000601/// In C++ mode, types have linkage, so we can rely on the ODR and
602/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000603static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
604 CodeGenModule &CGM,
605 llvm::DICompileUnit TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000606 SmallString<256> FullName;
607 // FIXME: ODR should apply to ObjC++ exactly the same wasy it does to C++.
608 // For now, only apply ODR with C++.
609 const TagDecl *TD = Ty->getDecl();
610 if (TheCU.getLanguage() != llvm::dwarf::DW_LANG_C_plus_plus ||
611 !TD->isExternallyVisible())
612 return FullName;
613 // Microsoft Mangler does not have support for mangleCXXRTTIName yet.
614 if (CGM.getTarget().getCXXABI().isMicrosoft())
615 return FullName;
616
617 // TODO: This is using the RTTI name. Is there a better way to get
618 // a unique string for a type?
619 llvm::raw_svector_ostream Out(FullName);
620 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
621 Out.flush();
622 return FullName;
623}
624
Guy Benyei11169dd2012-12-18 14:30:41 +0000625// Creates a forward declaration for a RecordDecl in the given context.
David Blaikie8d5e1282013-08-20 21:03:29 +0000626llvm::DICompositeType
Manman Ren1b457022013-08-28 21:20:28 +0000627CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
David Blaikie8d5e1282013-08-20 21:03:29 +0000628 llvm::DIDescriptor Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000629 const RecordDecl *RD = Ty->getDecl();
David Blaikie4e7ef802013-08-15 20:17:25 +0000630 if (llvm::DIType T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
David Blaikie8d5e1282013-08-20 21:03:29 +0000631 return llvm::DICompositeType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000632 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
633 unsigned Line = getLineNumber(RD->getLocation());
634 StringRef RDName = getClassName(RD);
635
Ed Masteda706022014-05-07 12:49:30 +0000636 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000637 if (RD->isStruct() || RD->isInterface())
638 Tag = llvm::dwarf::DW_TAG_structure_type;
639 else if (RD->isUnion())
640 Tag = llvm::dwarf::DW_TAG_union_type;
641 else {
642 assert(RD->isClass());
643 Tag = llvm::dwarf::DW_TAG_class_type;
644 }
645
646 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000647 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
David Blaikief427b002014-05-06 03:42:01 +0000648 llvm::DICompositeType RetTy = DBuilder.createReplaceableForwardDecl(
649 Tag, RDName, Ctx, DefUnit, Line, 0, 0, 0, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000650 ReplaceMap.emplace_back(
651 std::piecewise_construct, std::make_tuple(Ty),
652 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000653 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000654}
655
Ed Masteda706022014-05-07 12:49:30 +0000656llvm::DIType CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +0000657 const Type *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000658 QualType PointeeTy,
659 llvm::DIFile Unit) {
660 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
661 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikie99dab3b2013-09-04 22:03:57 +0000662 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit));
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000663
Guy Benyei11169dd2012-12-18 14:30:41 +0000664 // Bit size, align and offset of the type.
665 // Size is always the size of a pointer. We can't use getTypeSize here
666 // because that does not return the correct value for references.
667 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000668 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000669 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
670
David Blaikie99dab3b2013-09-04 22:03:57 +0000671 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
672 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000673}
674
Eric Christopher0fdcb312013-05-16 00:52:20 +0000675llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
676 llvm::DIType &Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000677 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000678 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000679 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
680 TheCU, getOrCreateMainFile(), 0);
681 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
682 Cache = DBuilder.createPointerType(Cache, Size);
683 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000684}
685
Guy Benyei11169dd2012-12-18 14:30:41 +0000686llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
687 llvm::DIFile Unit) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000688 if (BlockLiteralGeneric)
Guy Benyei11169dd2012-12-18 14:30:41 +0000689 return BlockLiteralGeneric;
690
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000691 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000692 llvm::DIType FieldTy;
693 QualType FType;
694 uint64_t FieldSize, FieldOffset;
695 unsigned FieldAlign;
696 llvm::DIArray Elements;
697 llvm::DIType EltTy, DescTy;
698
699 FieldOffset = 0;
700 FType = CGM.getContext().UnsignedLongTy;
701 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
702 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
703
704 Elements = DBuilder.getOrCreateArray(EltTys);
705 EltTys.clear();
706
707 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
708 unsigned LineNo = getLineNumber(CurLoc);
709
Eric Christophere7b87e52014-10-26 23:40:33 +0000710 EltTy = DBuilder.createStructType(Unit, "__block_descriptor", Unit, LineNo,
711 FieldOffset, 0, Flags, llvm::DIType(),
712 Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000713
714 // Bit size, align and offset of the type.
715 uint64_t Size = CGM.getContext().getTypeSize(Ty);
716
717 DescTy = DBuilder.createPointerType(EltTy, Size);
718
719 FieldOffset = 0;
720 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
721 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
722 FType = CGM.getContext().IntTy;
723 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
724 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000725 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000726 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
727
728 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
729 FieldTy = DescTy;
730 FieldSize = CGM.getContext().getTypeSize(Ty);
731 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Eric Christophere7b87e52014-10-26 23:40:33 +0000732 FieldTy =
733 DBuilder.createMemberType(Unit, "__descriptor", Unit, LineNo, FieldSize,
734 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000735 EltTys.push_back(FieldTy);
736
737 FieldOffset += FieldSize;
738 Elements = DBuilder.getOrCreateArray(EltTys);
739
Eric Christophere7b87e52014-10-26 23:40:33 +0000740 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic", Unit,
741 LineNo, FieldOffset, 0, Flags,
742 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000743
Guy Benyei11169dd2012-12-18 14:30:41 +0000744 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
745 return BlockLiteralGeneric;
746}
747
Eric Christophere7b87e52014-10-26 23:40:33 +0000748llvm::DIType CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
749 llvm::DIFile Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000750 assert(Ty->isTypeAlias());
751 llvm::DIType Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000752
753 SmallString<128> NS;
754 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000755 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
756 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000757
758 TemplateSpecializationType::PrintTemplateArgumentList(
759 OS, Ty->getArgs(), Ty->getNumArgs(),
760 CGM.getContext().getPrintingPolicy());
761
Eric Christophere7b87e52014-10-26 23:40:33 +0000762 TypeAliasDecl *AliasDecl = cast<TypeAliasTemplateDecl>(
763 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000764
765 SourceLocation Loc = AliasDecl->getLocation();
766 llvm::DIFile File = getOrCreateFile(Loc);
767 unsigned Line = getLineNumber(Loc);
768
Eric Christophere7b87e52014-10-26 23:40:33 +0000769 llvm::DIDescriptor Ctxt =
770 getContextDescriptor(cast<Decl>(AliasDecl->getDeclContext()));
David Blaikief1b382e2014-04-06 17:14:06 +0000771
772 return DBuilder.createTypedef(Src, internString(OS.str()), File, Line, Ctxt);
773}
774
David Blaikie99dab3b2013-09-04 22:03:57 +0000775llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000776 // Typedefs are derived from some other type. If we have a typedef of a
777 // typedef, make sure to emit the whole chain.
David Blaikie99dab3b2013-09-04 22:03:57 +0000778 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000779 // We don't set size information, but do specify where the typedef was
780 // declared.
Adrian Prantl3eff2252014-01-21 18:42:27 +0000781 SourceLocation Loc = Ty->getDecl()->getLocation();
782 llvm::DIFile File = getOrCreateFile(Loc);
783 unsigned Line = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000784 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000785
Guy Benyei11169dd2012-12-18 14:30:41 +0000786 llvm::DIDescriptor TypedefContext =
Eric Christophere7b87e52014-10-26 23:40:33 +0000787 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopherb2a008c2013-05-16 00:45:12 +0000788
Eric Christophere7b87e52014-10-26 23:40:33 +0000789 return DBuilder.createTypedef(Src, TyDecl->getName(), File, Line,
790 TypedefContext);
Guy Benyei11169dd2012-12-18 14:30:41 +0000791}
792
793llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
794 llvm::DIFile Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000795 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000796
797 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000798 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000799
800 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000801 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000802 if (isa<FunctionNoProtoType>(Ty))
803 EltTys.push_back(DBuilder.createUnspecifiedParameter());
804 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000805 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
806 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000807 if (FPT->isVariadic())
808 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000809 }
810
Manman Ren67f005e2014-07-28 22:24:34 +0000811 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Guy Benyei11169dd2012-12-18 14:30:41 +0000812 return DBuilder.createSubroutineType(Unit, EltTypeArray);
813}
814
Adrian Prantl21361fb2014-08-29 22:44:27 +0000815/// Convert an AccessSpecifier into the corresponding DIDescriptor flag.
816/// As an optimization, return 0 if the access specifier equals the
817/// default for the containing type.
818static unsigned getAccessFlag(AccessSpecifier Access, const RecordDecl *RD) {
819 AccessSpecifier Default = clang::AS_none;
820 if (RD && RD->isClass())
821 Default = clang::AS_private;
822 else if (RD && (RD->isStruct() || RD->isUnion()))
823 Default = clang::AS_public;
824
825 if (Access == Default)
826 return 0;
827
Eric Christophere7b87e52014-10-26 23:40:33 +0000828 switch (Access) {
829 case clang::AS_private:
830 return llvm::DIDescriptor::FlagPrivate;
831 case clang::AS_protected:
832 return llvm::DIDescriptor::FlagProtected;
833 case clang::AS_public:
834 return llvm::DIDescriptor::FlagPublic;
835 case clang::AS_none:
836 return 0;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000837 }
838 llvm_unreachable("unexpected access enumerator");
839}
Guy Benyei11169dd2012-12-18 14:30:41 +0000840
Eric Christophere7b87e52014-10-26 23:40:33 +0000841llvm::DIType CGDebugInfo::createFieldType(
842 StringRef name, QualType type, uint64_t sizeInBitsOverride,
843 SourceLocation loc, AccessSpecifier AS, uint64_t offsetInBits,
844 llvm::DIFile tunit, llvm::DIScope scope, const RecordDecl *RD) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000845 llvm::DIType debugType = getOrCreateType(type, tunit);
846
847 // Get the location for the field.
848 llvm::DIFile file = getOrCreateFile(loc);
849 unsigned line = getLineNumber(loc);
850
David Majnemer34b57492014-07-30 01:30:47 +0000851 uint64_t SizeInBits = 0;
852 unsigned AlignInBits = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000853 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +0000854 TypeInfo TI = CGM.getContext().getTypeInfo(type);
855 SizeInBits = TI.Width;
856 AlignInBits = TI.Align;
Guy Benyei11169dd2012-12-18 14:30:41 +0000857
858 if (sizeInBitsOverride)
David Majnemer34b57492014-07-30 01:30:47 +0000859 SizeInBits = sizeInBitsOverride;
Guy Benyei11169dd2012-12-18 14:30:41 +0000860 }
861
Adrian Prantl21361fb2014-08-29 22:44:27 +0000862 unsigned flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +0000863 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
864 AlignInBits, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +0000865}
866
Eric Christopher91a31902013-01-16 01:22:32 +0000867/// CollectRecordLambdaFields - Helper for CollectRecordFields.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000868void CGDebugInfo::CollectRecordLambdaFields(
869 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
870 llvm::DIType RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000871 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
872 // has the name and the location of the variable so we should iterate over
873 // both concurrently.
874 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
875 RecordDecl::field_iterator Field = CXXDecl->field_begin();
876 unsigned fieldno = 0;
877 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +0000878 E = CXXDecl->captures_end();
879 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +0000880 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +0000881 if (C.capturesVariable()) {
882 VarDecl *V = C.getCapturedVar();
883 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
884 StringRef VName = V->getName();
885 uint64_t SizeInBitsOverride = 0;
886 if (Field->isBitField()) {
887 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
888 assert(SizeInBitsOverride && "found named 0-width bitfield");
889 }
Eric Christophere7b87e52014-10-26 23:40:33 +0000890 llvm::DIType fieldType = createFieldType(
891 VName, Field->getType(), SizeInBitsOverride, C.getLocation(),
892 Field->getAccess(), layout.getFieldOffset(fieldno), VUnit, RecordTy,
893 CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000894 elements.push_back(fieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +0000895 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +0000896 // TODO: Need to handle 'this' in some way by probably renaming the
897 // this of the lambda class and having a field member of 'this' or
898 // by using AT_object_pointer for the function and having that be
899 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +0000900 FieldDecl *f = *Field;
901 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
902 QualType type = f->getType();
Eric Christophere7b87e52014-10-26 23:40:33 +0000903 llvm::DIType fieldType = createFieldType(
904 "this", type, 0, f->getLocation(), f->getAccess(),
905 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000906
907 elements.push_back(fieldType);
908 }
909 }
910}
911
David Blaikie6943dea2013-08-20 01:28:15 +0000912/// Helper for CollectRecordFields.
Eric Christophere7b87e52014-10-26 23:40:33 +0000913llvm::DIDerivedType CGDebugInfo::CreateRecordStaticField(const VarDecl *Var,
914 llvm::DIType RecordTy,
915 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000916 // Create the descriptor for the static variable, with or without
917 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +0000918 Var = Var->getCanonicalDecl();
Eric Christopher91a31902013-01-16 01:22:32 +0000919 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
920 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
921
Eric Christopher91a31902013-01-16 01:22:32 +0000922 unsigned LineNumber = getLineNumber(Var->getLocation());
923 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +0000924 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +0000925 if (Var->getInit()) {
926 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000927 if (Value) {
928 if (Value->isInt())
929 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
930 if (Value->isFloat())
931 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
932 }
Eric Christopher91a31902013-01-16 01:22:32 +0000933 }
934
Adrian Prantl21361fb2014-08-29 22:44:27 +0000935 unsigned Flags = getAccessFlag(Var->getAccess(), RD);
David Blaikieae019462013-08-15 22:50:29 +0000936 llvm::DIDerivedType GV = DBuilder.createStaticMemberType(
937 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000938 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +0000939 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +0000940}
941
942/// CollectRecordNormalField - Helper for CollectRecordFields.
Eric Christophere7b87e52014-10-26 23:40:33 +0000943void CGDebugInfo::CollectRecordNormalField(
944 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000945 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +0000946 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000947 StringRef name = field->getName();
948 QualType type = field->getType();
949
950 // Ignore unnamed fields unless they're anonymous structs/unions.
951 if (name.empty() && !type->isRecordType())
952 return;
953
954 uint64_t SizeInBitsOverride = 0;
955 if (field->isBitField()) {
956 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
957 assert(SizeInBitsOverride && "found named 0-width bitfield");
958 }
959
Eric Christophere7b87e52014-10-26 23:40:33 +0000960 llvm::DIType fieldType =
961 createFieldType(name, type, SizeInBitsOverride, field->getLocation(),
962 field->getAccess(), OffsetInBits, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +0000963
964 elements.push_back(fieldType);
965}
966
Guy Benyei11169dd2012-12-18 14:30:41 +0000967/// CollectRecordFields - A helper function to collect debug info for
968/// record fields. This is used while creating debug info entry for a Record.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000969void CGDebugInfo::CollectRecordFields(
970 const RecordDecl *record, llvm::DIFile tunit,
971 SmallVectorImpl<llvm::Metadata *> &elements,
972 llvm::DICompositeType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000973 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
974
Eric Christopher91a31902013-01-16 01:22:32 +0000975 if (CXXDecl && CXXDecl->isLambda())
976 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
977 else {
978 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +0000979
Eric Christopher91a31902013-01-16 01:22:32 +0000980 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +0000981 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +0000982
Eric Christopher91a31902013-01-16 01:22:32 +0000983 // Static and non-static members should appear in the same order as
984 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +0000985 for (const auto *I : record->decls())
986 if (const auto *V = dyn_cast<VarDecl>(I)) {
David Blaikiece763042013-08-20 21:49:21 +0000987 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000988 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +0000989 if (MI != StaticDataMemberCache.end()) {
990 assert(MI->second &&
991 "Static data member declaration should still exist");
992 elements.push_back(
993 llvm::DIDerivedType(cast<llvm::MDNode>(MI->second)));
Adrian Prantl21361fb2014-08-29 22:44:27 +0000994 } else {
995 auto Field = CreateRecordStaticField(V, RecordTy, record);
996 elements.push_back(Field);
997 }
Aaron Ballman629afae2014-03-07 19:56:05 +0000998 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000999 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1000 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001001
1002 // Bump field number for next field.
1003 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +00001004 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001005 }
1006}
1007
1008/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
1009/// function type is not updated to include implicit "this" pointer. Use this
1010/// routine to get a method type which includes "this" pointer.
David Blaikie469f0792013-05-22 23:22:42 +00001011llvm::DICompositeType
Guy Benyei11169dd2012-12-18 14:30:41 +00001012CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1013 llvm::DIFile Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001014 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001015 if (Method->isStatic())
David Blaikie469f0792013-05-22 23:22:42 +00001016 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001017 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1018 Func, Unit);
1019}
David Blaikie2aaf0652013-01-07 22:24:59 +00001020
David Blaikie469f0792013-05-22 23:22:42 +00001021llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie7eb06852013-01-07 23:06:35 +00001022 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001023 // Add "this" pointer.
Manman Ren67f005e2014-07-28 22:24:34 +00001024 llvm::DITypeArray Args = llvm::DISubroutineType(
1025 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Eric Christophere7b87e52014-10-26 23:40:33 +00001026 assert(Args.getNumElements() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001027
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001028 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001029
1030 // First element is always return type. For 'void' functions it is NULL.
1031 Elts.push_back(Args.getElement(0));
1032
David Blaikie2aaf0652013-01-07 22:24:59 +00001033 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001034 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001035 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1036 // Create pointer type directly in this case.
1037 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1038 QualType PointeeTy = ThisPtrTy->getPointeeType();
1039 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001040 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001041 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
1042 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopher0fdcb312013-05-16 00:52:20 +00001043 llvm::DIType ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001044 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001045 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001046 // TODO: This and the artificial type below are misleading, the
1047 // types aren't artificial the argument is, but the current
1048 // metadata doesn't represent that.
1049 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1050 Elts.push_back(ThisPtrType);
1051 } else {
1052 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001053 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001054 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1055 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001056 }
1057
1058 // Copy rest of the arguments.
1059 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
1060 Elts.push_back(Args.getElement(i));
1061
Manman Ren67f005e2014-07-28 22:24:34 +00001062 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001063
Adrian Prantl0630eb72013-12-18 21:48:18 +00001064 unsigned Flags = 0;
1065 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1066 Flags |= llvm::DIDescriptor::FlagLValueReference;
1067 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1068 Flags |= llvm::DIDescriptor::FlagRValueReference;
1069
1070 return DBuilder.createSubroutineType(Unit, EltTypeArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001071}
1072
Eric Christopherb2a008c2013-05-16 00:45:12 +00001073/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001074/// inside a function.
1075static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1076 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1077 return isFunctionLocalClass(NRD);
1078 if (isa<FunctionDecl>(RD->getDeclContext()))
1079 return true;
1080 return false;
1081}
1082
1083/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1084/// a single member function GlobalDecl.
1085llvm::DISubprogram
1086CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
Eric Christophere7b87e52014-10-26 23:40:33 +00001087 llvm::DIFile Unit, llvm::DIType RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001088 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001089 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001090
Guy Benyei11169dd2012-12-18 14:30:41 +00001091 StringRef MethodName = getFunctionName(Method);
David Blaikie469f0792013-05-22 23:22:42 +00001092 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001093
1094 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1095 // make sense to give a single ctor/dtor a linkage name.
1096 StringRef MethodLinkageName;
1097 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1098 MethodLinkageName = CGM.getMangledName(Method);
1099
1100 // Get the location for the method.
David Blaikie7fceebf2013-08-19 03:37:48 +00001101 llvm::DIFile MethodDefUnit;
1102 unsigned MethodLine = 0;
1103 if (!Method->isImplicit()) {
1104 MethodDefUnit = getOrCreateFile(Method->getLocation());
1105 MethodLine = getLineNumber(Method->getLocation());
1106 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001107
1108 // Collect virtual method info.
1109 llvm::DIType ContainingType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001110 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001111 unsigned VIndex = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001112
Guy Benyei11169dd2012-12-18 14:30:41 +00001113 if (Method->isVirtual()) {
1114 if (Method->isPure())
1115 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1116 else
1117 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001118
Guy Benyei11169dd2012-12-18 14:30:41 +00001119 // It doesn't make sense to give a virtual destructor a vtable index,
1120 // since a single destructor has two entries in the vtable.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001121 // FIXME: Add proper support for debug info for virtual calls in
1122 // the Microsoft ABI, where we may use multiple vptrs to make a vftable
1123 // lookup if we have multiple or virtual inheritance.
1124 if (!isa<CXXDestructorDecl>(Method) &&
1125 !CGM.getTarget().getCXXABI().isMicrosoft())
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001126 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
Guy Benyei11169dd2012-12-18 14:30:41 +00001127 ContainingType = RecordTy;
1128 }
1129
1130 unsigned Flags = 0;
1131 if (Method->isImplicit())
1132 Flags |= llvm::DIDescriptor::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001133 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
Guy Benyei11169dd2012-12-18 14:30:41 +00001134 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1135 if (CXXC->isExplicit())
1136 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001137 } else if (const CXXConversionDecl *CXXC =
Eric Christophere7b87e52014-10-26 23:40:33 +00001138 dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001139 if (CXXC->isExplicit())
1140 Flags |= llvm::DIDescriptor::FlagExplicit;
1141 }
1142 if (Method->hasPrototype())
1143 Flags |= llvm::DIDescriptor::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001144 if (Method->getRefQualifier() == RQ_LValue)
1145 Flags |= llvm::DIDescriptor::FlagLValueReference;
1146 if (Method->getRefQualifier() == RQ_RValue)
1147 Flags |= llvm::DIDescriptor::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001148
1149 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
Eric Christophere7b87e52014-10-26 23:40:33 +00001150 llvm::DISubprogram SP = DBuilder.createMethod(
1151 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1152 MethodTy, /*isLocalToUnit=*/false,
1153 /* isDefinition=*/false, Virtuality, VIndex, ContainingType, Flags,
1154 CGM.getLangOpts().Optimize, nullptr, TParamsArray);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001155
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001156 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001157
1158 return SP;
1159}
1160
1161/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001162/// C++ member functions. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001163/// a Record.
Eric Christophere7b87e52014-10-26 23:40:33 +00001164void CGDebugInfo::CollectCXXMemberFunctions(
1165 const CXXRecordDecl *RD, llvm::DIFile Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001166 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001167
1168 // Since we want more than just the individual member decls if we
1169 // have templated functions iterate over every declaration to gather
1170 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001171 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001172 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1173 // If the member is implicit, don't add it to the member list. This avoids
1174 // the member being added to type units by LLVM, while still allowing it
1175 // to be emitted into the type declaration/reference inside the compile
1176 // unit.
David Blaikie6dddfe32014-10-06 05:52:27 +00001177 // FIXME: Handle Using(Shadow?)Decls here to create
1178 // DW_TAG_imported_declarations inside the class for base decls brought into
1179 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1180 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1181 // referenced)
David Blaikiefd580722014-10-06 05:18:55 +00001182 if (!Method || Method->isImplicit())
1183 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001184
1185 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1186 continue;
1187
David Blaikiefd580722014-10-06 05:18:55 +00001188 // Reuse the existing member function declaration if it exists.
1189 // It may be associated with the declaration of the type & should be
1190 // reused as we're building the definition.
1191 //
1192 // This situation can arise in the vtable-based debug info reduction where
1193 // implicit members are emitted in a non-vtable TU.
1194 auto MI = SPCache.find(Method->getCanonicalDecl());
1195 EltTys.push_back(MI == SPCache.end()
1196 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001197 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001198 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001199}
Guy Benyei11169dd2012-12-18 14:30:41 +00001200
Guy Benyei11169dd2012-12-18 14:30:41 +00001201/// CollectCXXBases - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001202/// C++ base classes. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001203/// a Record.
Eric Christophere7b87e52014-10-26 23:40:33 +00001204void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001205 SmallVectorImpl<llvm::Metadata *> &EltTys,
Eric Christophere7b87e52014-10-26 23:40:33 +00001206 llvm::DIType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001207
1208 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001209 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001210 unsigned BFlags = 0;
1211 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001212
Guy Benyei11169dd2012-12-18 14:30:41 +00001213 const CXXRecordDecl *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001214 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001215
Aaron Ballman574705e2014-03-13 15:41:46 +00001216 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001217 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1218 // virtual base offset offset is -ve. The code generator emits dwarf
1219 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001220 BaseOffset = 0 - CGM.getItaniumVTableContext()
1221 .getVirtualBaseOffsetOffset(RD, Base)
1222 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001223 } else {
1224 // In the MS ABI, store the vbtable offset, which is analogous to the
1225 // vbase offset offset in Itanium.
1226 BaseOffset =
1227 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1228 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001229 BFlags = llvm::DIDescriptor::FlagVirtual;
1230 } else
1231 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1232 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1233 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001234
Adrian Prantl21361fb2014-08-29 22:44:27 +00001235 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001236 llvm::DIType DTy = DBuilder.createInheritance(
1237 RecordTy, getOrCreateType(BI.getType(), Unit), BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001238 EltTys.push_back(DTy);
1239 }
1240}
1241
1242/// CollectTemplateParams - A helper function to collect template parameters.
Eric Christophere7b87e52014-10-26 23:40:33 +00001243llvm::DIArray
1244CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1245 ArrayRef<TemplateArgument> TAList,
1246 llvm::DIFile Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001247 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001248 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1249 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001250 StringRef Name;
1251 if (TPList)
1252 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001253 switch (TA.getKind()) {
1254 case TemplateArgument::Type: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001255 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1256 llvm::DITemplateTypeParameter TTP =
David Blaikie47c11502013-06-22 18:59:18 +00001257 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001258 TemplateParams.push_back(TTP);
David Blaikie38079fd2013-05-10 21:53:14 +00001259 } break;
1260 case TemplateArgument::Integral: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001261 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1262 llvm::DITemplateValueParameter TVP =
David Blaikie38079fd2013-05-10 21:53:14 +00001263 DBuilder.createTemplateValueParameter(
David Blaikie47c11502013-06-22 18:59:18 +00001264 TheCU, Name, TTy,
David Blaikie38079fd2013-05-10 21:53:14 +00001265 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1266 TemplateParams.push_back(TVP);
1267 } break;
1268 case TemplateArgument::Declaration: {
1269 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001270 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
David Blaikie38079fd2013-05-10 21:53:14 +00001271 llvm::DIType TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001272 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001273 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001274 // Variable pointer template parameters have a value that is the address
1275 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001276 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001277 V = CGM.GetAddrOfGlobalVar(VD);
1278 // Member function pointers have special support for building them, though
1279 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001280 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Blaikie0a7c9d52014-10-20 20:29:35 +00001281 V = CGM.getCXXABI().EmitMemberPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001282 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001283 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001284 // Member data pointers have special handling too to compute the fixed
1285 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001286 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001287 // These five lines (& possibly the above member function pointer
1288 // handling) might be able to be refactored to use similar code in
1289 // CodeGenModule::getMemberPointerConstant
1290 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1291 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001292 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001293 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001294 }
1295 llvm::DITemplateValueParameter TVP =
Duncan P. N. Exon Smith2f68dad2014-11-15 00:24:50 +00001296 DBuilder.createTemplateValueParameter(
1297 TheCU, Name, TTy,
1298 cast_or_null<llvm::Constant>(V->stripPointerCasts()));
David Blaikie38079fd2013-05-10 21:53:14 +00001299 TemplateParams.push_back(TVP);
1300 } break;
1301 case TemplateArgument::NullPtr: {
1302 QualType T = TA.getNullPtrType();
1303 llvm::DIType TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001304 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001305 // Special case member data pointer null values since they're actually -1
1306 // instead of zero.
1307 if (const MemberPointerType *MPT =
1308 dyn_cast<MemberPointerType>(T.getTypePtr()))
1309 // But treat member function pointers as simple zero integers because
1310 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1311 // CodeGen grows handling for values of non-null member function
1312 // pointers then perhaps we could remove this special case and rely on
1313 // EmitNullMemberPointer for member function pointers.
1314 if (MPT->isMemberDataPointer())
1315 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1316 if (!V)
1317 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1318 llvm::DITemplateValueParameter TVP =
Duncan P. N. Exon Smith2f68dad2014-11-15 00:24:50 +00001319 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1320 cast<llvm::Constant>(V));
David Blaikie38079fd2013-05-10 21:53:14 +00001321 TemplateParams.push_back(TVP);
1322 } break;
David Blaikie47c11502013-06-22 18:59:18 +00001323 case TemplateArgument::Template: {
Eric Christophere7b87e52014-10-26 23:40:33 +00001324 llvm::DITemplateValueParameter
1325 TVP = DBuilder.createTemplateTemplateParameter(
1326 TheCU, Name, llvm::DIType(),
1327 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString());
David Blaikie47c11502013-06-22 18:59:18 +00001328 TemplateParams.push_back(TVP);
1329 } break;
1330 case TemplateArgument::Pack: {
Eric Christophere7b87e52014-10-26 23:40:33 +00001331 llvm::DITemplateValueParameter TVP = DBuilder.createTemplateParameterPack(
1332 TheCU, Name, llvm::DIType(),
1333 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit));
David Blaikie47c11502013-06-22 18:59:18 +00001334 TemplateParams.push_back(TVP);
1335 } break;
David Majnemer5559d472013-08-24 08:21:10 +00001336 case TemplateArgument::Expression: {
1337 const Expr *E = TA.getAsExpr();
1338 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001339 if (E->isGLValue())
1340 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001341 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001342 assert(V && "Expression in template argument isn't constant");
1343 llvm::DIType TTy = getOrCreateType(T, Unit);
1344 llvm::DITemplateValueParameter TVP =
Duncan P. N. Exon Smith2f68dad2014-11-15 00:24:50 +00001345 DBuilder.createTemplateValueParameter(
1346 TheCU, Name, TTy, cast<llvm::Constant>(V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001347 TemplateParams.push_back(TVP);
1348 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001349 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001350 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001351 case TemplateArgument::Null:
1352 llvm_unreachable(
1353 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001354 }
1355 }
1356 return DBuilder.getOrCreateArray(TemplateParams);
1357}
1358
1359/// CollectFunctionTemplateParams - A helper function to collect debug
1360/// info for function template parameters.
Eric Christophere7b87e52014-10-26 23:40:33 +00001361llvm::DIArray CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1362 llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001363 if (FD->getTemplatedKind() ==
1364 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001365 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1366 ->getTemplate()
1367 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001368 return CollectTemplateParams(
1369 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001370 }
1371 return llvm::DIArray();
1372}
1373
1374/// CollectCXXTemplateParams - A helper function to collect debug info for
1375/// template parameters.
Eric Christophere7b87e52014-10-26 23:40:33 +00001376llvm::DIArray CGDebugInfo::CollectCXXTemplateParams(
1377 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001378 // Always get the full list of parameters, not just the ones from
1379 // the specialization.
1380 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001381 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001382 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001383 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001384}
1385
1386/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1387llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1388 if (VTablePtrType.isValid())
1389 return VTablePtrType;
1390
1391 ASTContext &Context = CGM.getContext();
1392
1393 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001394 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Manman Ren67f005e2014-07-28 22:24:34 +00001395 llvm::DITypeArray SElements = DBuilder.getOrCreateTypeArray(STy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001396 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1397 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00001398 llvm::DIType vtbl_ptr_type =
1399 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001400 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1401 return VTablePtrType;
1402}
1403
1404/// getVTableName - Get vtable name for the given Class.
1405StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001406 // Copy the gdb compatible name on the side and use its reference.
1407 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001408}
1409
Guy Benyei11169dd2012-12-18 14:30:41 +00001410/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1411/// debug info entry in EltTys vector.
Eric Christophere7b87e52014-10-26 23:40:33 +00001412void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001413 SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001414 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1415
1416 // If there is a primary base then it will hold vtable info.
1417 if (RL.getPrimaryBase())
1418 return;
1419
1420 // If this class is not dynamic then there is not any vtable info to collect.
1421 if (!RD->isDynamicClass())
1422 return;
1423
1424 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00001425 llvm::DIType VPTR = DBuilder.createMemberType(
1426 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1427 llvm::DIDescriptor::FlagArtificial, getOrCreateVTablePtrType(Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001428 EltTys.push_back(VPTR);
1429}
1430
Eric Christopherb2a008c2013-05-16 00:45:12 +00001431/// getOrCreateRecordType - Emit record type's standalone debug info.
1432llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00001433 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001434 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001435 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1436 return T;
1437}
1438
1439/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1440/// debug info.
1441llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001442 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001443 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001444 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantl73409ce2013-03-11 18:33:46 +00001445 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001446 return T;
1447}
1448
David Blaikie483a9da2014-05-06 18:35:21 +00001449void CGDebugInfo::completeType(const EnumDecl *ED) {
1450 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1451 return;
1452 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001453 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001454 auto I = TypeCache.find(TyPtr);
1455 if (I == TypeCache.end() ||
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001456 !llvm::DIType(cast<llvm::MDNode>(I->second)).isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001457 return;
1458 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<EnumType>());
1459 assert(!Res.isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001460 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001461}
1462
David Blaikieb2e86eb2013-08-15 20:49:17 +00001463void CGDebugInfo::completeType(const RecordDecl *RD) {
1464 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1465 !CGM.getLangOpts().CPlusPlus)
1466 completeRequiredType(RD);
1467}
1468
1469void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie0856f662014-03-04 22:01:08 +00001470 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1471 return;
1472
David Blaikie6943dea2013-08-20 01:28:15 +00001473 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1474 if (CXXDecl->isDynamicClass())
1475 return;
1476
David Blaikieb2e86eb2013-08-15 20:49:17 +00001477 QualType Ty = CGM.getContext().getRecordType(RD);
1478 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie6943dea2013-08-20 01:28:15 +00001479 if (T && T.isForwardDecl())
1480 completeClassData(RD);
1481}
1482
1483void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1484 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001485 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001486 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001487 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001488 auto I = TypeCache.find(TyPtr);
1489 if (I != TypeCache.end() &&
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001490 !llvm::DIType(cast<llvm::MDNode>(I->second)).isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001491 return;
1492 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1493 assert(!Res.isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001494 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001495}
1496
David Blaikie0e716b42014-03-03 23:48:23 +00001497static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1498 CXXRecordDecl::method_iterator End) {
1499 for (; I != End; ++I)
1500 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001501 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1502 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001503 return true;
1504 return false;
1505}
1506
1507static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
1508 const RecordDecl *RD,
1509 const LangOptions &LangOpts) {
1510 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1511 return false;
1512
1513 if (!LangOpts.CPlusPlus)
1514 return false;
1515
1516 if (!RD->isCompleteDefinitionRequired())
1517 return true;
1518
1519 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1520
1521 if (!CXXDecl)
1522 return false;
1523
1524 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1525 return true;
1526
1527 TemplateSpecializationKind Spec = TSK_Undeclared;
1528 if (const ClassTemplateSpecializationDecl *SD =
1529 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1530 Spec = SD->getSpecializationKind();
1531
1532 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1533 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1534 CXXDecl->method_end()))
1535 return true;
1536
1537 return false;
1538}
1539
Guy Benyei11169dd2012-12-18 14:30:41 +00001540/// CreateType - get structure or union type.
David Blaikie99dab3b2013-09-04 22:03:57 +00001541llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001542 RecordDecl *RD = Ty->getDecl();
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001543 llvm::DICompositeType T(getTypeOrNull(QualType(Ty, 0)));
David Blaikie0e716b42014-03-03 23:48:23 +00001544 if (T || shouldOmitDefinition(DebugKind, RD, CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001545 if (!T)
David Blaikie65ec94e2014-02-18 20:52:05 +00001546 T = getOrCreateRecordFwdDecl(
1547 Ty, getContextDescriptor(cast<Decl>(RD->getDeclContext())));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001548 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001549 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001550
David Blaikieb2e86eb2013-08-15 20:49:17 +00001551 return CreateTypeDefinition(Ty);
1552}
1553
1554llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1555 RecordDecl *RD = Ty->getDecl();
1556
Guy Benyei11169dd2012-12-18 14:30:41 +00001557 // Get overall information about the record type for the debug info.
1558 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1559
1560 // Records and classes and unions can all be recursive. To handle them, we
1561 // first generate a debug descriptor for the struct as a forward declaration.
1562 // Then (if it is a definition) we go through and get debug info for all of
1563 // its members. Finally, we create a descriptor for the complete type (which
1564 // may refer to the forward decl if the struct is recursive) and replace all
1565 // uses of the forward declaration with the final definition.
1566
David Blaikie4a2b5ef2013-08-12 22:24:20 +00001567 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Ren0d441f12013-07-02 19:01:53 +00001568 assert(FwdDecl.isCompositeType() &&
David Blaikie469f0792013-05-22 23:22:42 +00001569 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei11169dd2012-12-18 14:30:41 +00001570
1571 if (FwdDecl.isForwardDecl())
1572 return FwdDecl;
1573
David Blaikieadfbf992013-08-18 16:55:33 +00001574 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1575 CollectContainingType(CXXDecl, FwdDecl);
1576
Guy Benyei11169dd2012-12-18 14:30:41 +00001577 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001578 LexicalBlockStack.emplace_back(&*FwdDecl);
1579 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001580
Guy Benyei11169dd2012-12-18 14:30:41 +00001581 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001582 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001583 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001584
1585 // Note: The split of CXXDecl information here is intentional, the
1586 // gdb tests will depend on a certain ordering at printout. The debug
1587 // information offsets are still correct if we merge them all together
1588 // though.
1589 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1590 if (CXXDecl) {
1591 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1592 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1593 }
1594
Eric Christopher91a31902013-01-16 01:22:32 +00001595 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001596 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001597 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001598 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001599
1600 LexicalBlockStack.pop_back();
1601 RegionMap.erase(Ty->getDecl());
1602
1603 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001604 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001605
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001606 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001607 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001608}
1609
1610/// CreateType - get objective-c object type.
1611llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1612 llvm::DIFile Unit) {
1613 // Ignore protocols.
1614 return getOrCreateType(Ty->getBaseType(), Unit);
1615}
1616
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001617/// \return true if Getter has the default name for the property PD.
1618static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1619 const ObjCMethodDecl *Getter) {
1620 assert(PD);
1621 if (!Getter)
1622 return true;
1623
1624 assert(Getter->getDeclName().isObjCZeroArgSelector());
1625 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001626 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001627}
1628
1629/// \return true if Setter has the default name for the property PD.
1630static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1631 const ObjCMethodDecl *Setter) {
1632 assert(PD);
1633 if (!Setter)
1634 return true;
1635
1636 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001637 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001638 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001639}
1640
Guy Benyei11169dd2012-12-18 14:30:41 +00001641/// CreateType - get objective-c interface type.
1642llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1643 llvm::DIFile Unit) {
1644 ObjCInterfaceDecl *ID = Ty->getDecl();
1645 if (!ID)
1646 return llvm::DIType();
1647
1648 // Get overall information about the record type for the debug info.
1649 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1650 unsigned Line = getLineNumber(ID->getLocation());
Ed Masteda706022014-05-07 12:49:30 +00001651 llvm::dwarf::SourceLanguage RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001652
1653 // If this is just a forward declaration return a special forward-declaration
1654 // debug type since we won't be able to lay out the entire type.
1655 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001656 if (!Def || !Def->getImplementation()) {
David Blaikief427b002014-05-06 03:42:01 +00001657 llvm::DIType FwdDecl = DBuilder.createReplaceableForwardDecl(
1658 llvm::dwarf::DW_TAG_structure_type, ID->getName(), TheCU, DefUnit, Line,
1659 RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001660 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001661 return FwdDecl;
1662 }
1663
David Blaikieef8a9512014-05-05 23:23:53 +00001664 return CreateTypeDefinition(Ty, Unit);
1665}
1666
Eric Christophere7b87e52014-10-26 23:40:33 +00001667llvm::DIType CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
1668 llvm::DIFile Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00001669 ObjCInterfaceDecl *ID = Ty->getDecl();
1670 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1671 unsigned Line = getLineNumber(ID->getLocation());
1672 unsigned RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001673
1674 // Bit size, align and offset of the type.
1675 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1676 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1677
1678 unsigned Flags = 0;
1679 if (ID->getImplementation())
1680 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1681
Eric Christophere7b87e52014-10-26 23:40:33 +00001682 llvm::DICompositeType RealDecl = DBuilder.createStructType(
1683 Unit, ID->getName(), DefUnit, Line, Size, Align, Flags, llvm::DIType(),
1684 llvm::DIArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001685
David Blaikieef8a9512014-05-05 23:23:53 +00001686 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001687 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001688
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001689 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001690 LexicalBlockStack.emplace_back(static_cast<llvm::MDNode *>(RealDecl));
1691 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001692
1693 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001694 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001695
1696 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1697 if (SClass) {
1698 llvm::DIType SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001699 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001700 if (!SClassTy.isValid())
1701 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001702
Eric Christophere7b87e52014-10-26 23:40:33 +00001703 llvm::DIType InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00001704 EltTys.push_back(InhTag);
1705 }
1706
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001707 // Create entries for all of the properties.
Aaron Ballmand174edf2014-03-13 19:11:50 +00001708 for (const auto *PD : ID->properties()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001709 SourceLocation Loc = PD->getLocation();
1710 llvm::DIFile PUnit = getOrCreateFile(Loc);
1711 unsigned PLine = getLineNumber(Loc);
1712 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1713 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001714 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
1715 PD->getName(), PUnit, PLine,
1716 hasDefaultGetterName(PD, Getter) ? ""
1717 : getSelectorName(PD->getGetterName()),
1718 hasDefaultSetterName(PD, Setter) ? ""
1719 : getSelectorName(PD->getSetterName()),
1720 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001721 EltTys.push_back(PropertyNode);
1722 }
1723
1724 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1725 unsigned FieldNo = 0;
1726 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1727 Field = Field->getNextIvar(), ++FieldNo) {
1728 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1729 if (!FieldTy.isValid())
1730 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001731
Guy Benyei11169dd2012-12-18 14:30:41 +00001732 StringRef FieldName = Field->getName();
1733
1734 // Ignore unnamed fields.
1735 if (FieldName.empty())
1736 continue;
1737
1738 // Get the location for the field.
1739 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1740 unsigned FieldLine = getLineNumber(Field->getLocation());
1741 QualType FType = Field->getType();
1742 uint64_t FieldSize = 0;
1743 unsigned FieldAlign = 0;
1744
1745 if (!FType->isIncompleteArrayType()) {
1746
1747 // Bit size, align and offset of the type.
1748 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001749 ? Field->getBitWidthValue(CGM.getContext())
1750 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001751 FieldAlign = CGM.getContext().getTypeAlign(FType);
1752 }
1753
1754 uint64_t FieldOffset;
1755 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1756 // We don't know the runtime offset of an ivar if we're using the
1757 // non-fragile ABI. For bitfields, use the bit offset into the first
1758 // byte of storage of the bitfield. For other fields, use zero.
1759 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001760 FieldOffset =
1761 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00001762 FieldOffset %= CGM.getContext().getCharWidth();
1763 } else {
1764 FieldOffset = 0;
1765 }
1766 } else {
1767 FieldOffset = RL.getFieldOffset(FieldNo);
1768 }
1769
1770 unsigned Flags = 0;
1771 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1772 Flags = llvm::DIDescriptor::FlagProtected;
1773 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1774 Flags = llvm::DIDescriptor::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001775 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
1776 Flags = llvm::DIDescriptor::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00001777
Craig Topper8a13c412014-05-21 05:09:00 +00001778 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001779 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001780 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00001781 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001782 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001783 SourceLocation Loc = PD->getLocation();
1784 llvm::DIFile PUnit = getOrCreateFile(Loc);
1785 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001786 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1787 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001788 PropertyNode = DBuilder.createObjCProperty(
1789 PD->getName(), PUnit, PLine,
1790 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
1791 PD->getGetterName()),
1792 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
1793 PD->getSetterName()),
1794 PD->getPropertyAttributes(),
1795 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001796 }
1797 }
1798 }
Eric Christophere7b87e52014-10-26 23:40:33 +00001799 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
1800 FieldSize, FieldAlign, FieldOffset, Flags,
1801 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00001802 EltTys.push_back(FieldTy);
1803 }
1804
1805 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001806 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001807
Guy Benyei11169dd2012-12-18 14:30:41 +00001808 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001809 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001810}
1811
1812llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1813 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1814 int64_t Count = Ty->getNumElements();
1815 if (Count == 0)
1816 // If number of elements are not known then this is an unbounded array.
1817 // Use Count == -1 to express such arrays.
1818 Count = -1;
1819
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001820 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Guy Benyei11169dd2012-12-18 14:30:41 +00001821 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1822
1823 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1824 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1825
1826 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1827}
1828
Eric Christophere7b87e52014-10-26 23:40:33 +00001829llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001830 uint64_t Size;
1831 uint64_t Align;
1832
1833 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1834 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1835 Size = 0;
1836 Align =
Eric Christophere7b87e52014-10-26 23:40:33 +00001837 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Guy Benyei11169dd2012-12-18 14:30:41 +00001838 } else if (Ty->isIncompleteArrayType()) {
1839 Size = 0;
1840 if (Ty->getElementType()->isIncompleteType())
1841 Align = 0;
1842 else
1843 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001844 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001845 Size = 0;
1846 Align = 0;
1847 } else {
1848 // Size and align of the whole array, not the element type.
1849 Size = CGM.getContext().getTypeSize(Ty);
1850 Align = CGM.getContext().getTypeAlign(Ty);
1851 }
1852
1853 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1854 // interior arrays, do we care? Why aren't nested arrays represented the
1855 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001856 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001857 QualType EltTy(Ty, 0);
1858 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1859 // If the number of elements is known, then count is that number. Otherwise,
1860 // it's -1. This allows us to represent a subrange with an array of 0
1861 // elements, like this:
1862 //
1863 // struct foo {
1864 // int x[0];
1865 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00001866 int64_t Count = -1; // Count == -1 is an unbounded array.
Guy Benyei11169dd2012-12-18 14:30:41 +00001867 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1868 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001869
Guy Benyei11169dd2012-12-18 14:30:41 +00001870 // FIXME: Verify this is right for VLAs.
1871 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1872 EltTy = Ty->getElementType();
1873 }
1874
1875 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1876
Eric Christophere7b87e52014-10-26 23:40:33 +00001877 llvm::DIType DbgTy = DBuilder.createArrayType(
1878 Size, Align, getOrCreateType(EltTy, Unit), SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00001879 return DbgTy;
1880}
1881
Eric Christopherb2a008c2013-05-16 00:45:12 +00001882llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001883 llvm::DIFile Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001884 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
1885 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001886}
1887
Eric Christopherb2a008c2013-05-16 00:45:12 +00001888llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001889 llvm::DIFile Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001890 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
1891 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001892}
1893
Eric Christopherb2a008c2013-05-16 00:45:12 +00001894llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001895 llvm::DIFile U) {
David Blaikie2c705ca2013-01-19 19:20:56 +00001896 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1897 if (!Ty->getPointeeType()->isFunctionType())
1898 return DBuilder.createMemberPointerType(
Adrian Prantlee24e142014-12-23 19:11:54 +00001899 getOrCreateType(Ty->getPointeeType(), U), ClassType,
Adrian Prantl0772dbd2015-01-07 17:49:30 +00001900 CGM.getContext().getTypeSize(Ty));
Adrian Prantl0866acd2013-12-19 01:38:47 +00001901
1902 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00001903 Ty->getPointeeType()->getAs<FunctionProtoType>();
1904 return DBuilder.createMemberPointerType(
1905 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
1906 Ty->getClass(), FPT->getTypeQuals())),
1907 FPT, U),
Adrian Prantl0772dbd2015-01-07 17:49:30 +00001908 ClassType, CGM.getContext().getTypeSize(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00001909}
1910
Eric Christophere7b87e52014-10-26 23:40:33 +00001911llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001912 // Ignore the atomic wrapping
1913 // FIXME: What is the correct representation?
1914 return getOrCreateType(Ty->getValueType(), U);
1915}
1916
1917/// CreateEnumType - get enumeration type.
Manman Ren501ecf92013-08-28 21:46:36 +00001918llvm::DIType CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00001919 const EnumDecl *ED = Ty->getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00001920 uint64_t Size = 0;
1921 uint64_t Align = 0;
1922 if (!ED->getTypeForDecl()->isIncompleteType()) {
1923 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1924 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1925 }
1926
Manman Rene0064d82013-08-29 23:19:58 +00001927 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1928
Guy Benyei11169dd2012-12-18 14:30:41 +00001929 // If this is just a forward declaration, construct an appropriately
1930 // marked node and just return it.
1931 if (!ED->getDefinition()) {
1932 llvm::DIDescriptor EDContext;
1933 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1934 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1935 unsigned Line = getLineNumber(ED->getLocation());
1936 StringRef EDName = ED->getName();
David Blaikief427b002014-05-06 03:42:01 +00001937 llvm::DIType RetTy = DBuilder.createReplaceableForwardDecl(
1938 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
1939 0, Size, Align, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001940 ReplaceMap.emplace_back(
1941 std::piecewise_construct, std::make_tuple(Ty),
1942 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00001943 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00001944 }
1945
David Blaikie483a9da2014-05-06 18:35:21 +00001946 return CreateTypeDefinition(Ty);
1947}
1948
1949llvm::DIType CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
1950 const EnumDecl *ED = Ty->getDecl();
1951 uint64_t Size = 0;
1952 uint64_t Align = 0;
1953 if (!ED->getTypeForDecl()->isIncompleteType()) {
1954 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1955 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1956 }
1957
1958 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1959
Guy Benyei11169dd2012-12-18 14:30:41 +00001960 // Create DIEnumerator elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001961 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00001962 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00001963 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001964 Enumerators.push_back(DBuilder.createEnumerator(
1965 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001966 }
1967
1968 // Return a CompositeType for the enum itself.
1969 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1970
1971 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1972 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001973 llvm::DIDescriptor EnumContext =
Eric Christophere7b87e52014-10-26 23:40:33 +00001974 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1975 llvm::DIType ClassTy = ED->isFixed()
1976 ? getOrCreateType(ED->getIntegerType(), DefUnit)
1977 : llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001978 llvm::DIType DbgTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001979 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1980 Size, Align, EltArray, ClassTy, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00001981 return DbgTy;
1982}
1983
David Blaikie05491062013-01-21 04:37:12 +00001984static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1985 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001986 do {
Adrian Prantl179af902013-09-26 21:35:50 +00001987 Qualifiers InnerQuals = T.getLocalQualifiers();
1988 // Qualifiers::operator+() doesn't like it if you add a Qualifier
1989 // that is already there.
1990 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
1991 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00001992 QualType LastT = T;
1993 switch (T->getTypeClass()) {
1994 default:
David Blaikie05491062013-01-21 04:37:12 +00001995 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00001996 case Type::TemplateSpecialization: {
1997 const auto *Spec = cast<TemplateSpecializationType>(T);
1998 if (Spec->isTypeAlias())
1999 return C.getQualifiedType(T.getTypePtr(), Quals);
2000 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002001 break;
2002 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002003 case Type::TypeOfExpr:
2004 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2005 break;
2006 case Type::TypeOf:
2007 T = cast<TypeOfType>(T)->getUnderlyingType();
2008 break;
2009 case Type::Decltype:
2010 T = cast<DecltypeType>(T)->getUnderlyingType();
2011 break;
2012 case Type::UnaryTransform:
2013 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2014 break;
2015 case Type::Attributed:
2016 T = cast<AttributedType>(T)->getEquivalentType();
2017 break;
2018 case Type::Elaborated:
2019 T = cast<ElaboratedType>(T)->getNamedType();
2020 break;
2021 case Type::Paren:
2022 T = cast<ParenType>(T)->getInnerType();
2023 break;
David Blaikie05491062013-01-21 04:37:12 +00002024 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002025 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002026 break;
2027 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002028 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002029 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002030 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002031 break;
2032 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002033
Guy Benyei11169dd2012-12-18 14:30:41 +00002034 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002035 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002036 } while (true);
2037}
2038
Eric Christopher0fdcb312013-05-16 00:52:20 +00002039/// getType - Get the type from the cache or return null type if it doesn't
2040/// exist.
Guy Benyei11169dd2012-12-18 14:30:41 +00002041llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
2042
2043 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002044 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002045
David Blaikief427b002014-05-06 03:42:01 +00002046 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002047 if (it != TypeCache.end()) {
2048 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002049 if (llvm::Metadata *V = it->second)
Guy Benyei11169dd2012-12-18 14:30:41 +00002050 return llvm::DIType(cast<llvm::MDNode>(V));
2051 }
2052
2053 return llvm::DIType();
2054}
2055
David Blaikie0e716b42014-03-03 23:48:23 +00002056void CGDebugInfo::completeTemplateDefinition(
2057 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002058 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2059 return;
2060
David Blaikie0e716b42014-03-03 23:48:23 +00002061 completeClassData(&SD);
2062 // In case this type has no member function definitions being emitted, ensure
2063 // it is retained
2064 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2065}
2066
Guy Benyei11169dd2012-12-18 14:30:41 +00002067/// getOrCreateType - Get the type from the cache or create a new
2068/// one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +00002069llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002070 if (Ty.isNull())
2071 return llvm::DIType();
2072
2073 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002074 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002075
David Blaikieef8a9512014-05-05 23:23:53 +00002076 if (llvm::DIType T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002077 return T;
2078
2079 // Otherwise create the type.
David Blaikie99dab3b2013-09-04 22:03:57 +00002080 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Eric Christophere7b87e52014-10-26 23:40:33 +00002081 void *TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002082
2083 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002084 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002085
Guy Benyei11169dd2012-12-18 14:30:41 +00002086 return Res;
2087}
2088
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002089/// Currently the checksum of an interface includes the number of
2090/// ivars and property accessors.
Eric Christopher1ecc5632013-06-07 22:54:39 +00002091unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl817bbb32013-06-07 01:10:48 +00002092 // The assumption is that the number of ivars can only increase
2093 // monotonically, so it is safe to just use their current number as
2094 // a checksum.
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002095 unsigned Sum = 0;
2096 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
Craig Topper8a13c412014-05-21 05:09:00 +00002097 Ivar != nullptr; Ivar = Ivar->getNextIvar())
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002098 ++Sum;
2099
2100 return Sum;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002101}
2102
2103ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2104 switch (Ty->getTypeClass()) {
2105 case Type::ObjCObjectPointer:
Eric Christophere7b87e52014-10-26 23:40:33 +00002106 return getObjCInterfaceDecl(
2107 cast<ObjCObjectPointerType>(Ty)->getPointeeType());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002108 case Type::ObjCInterface:
2109 return cast<ObjCInterfaceType>(Ty)->getDecl();
2110 default:
Craig Topper8a13c412014-05-21 05:09:00 +00002111 return nullptr;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002112 }
2113}
2114
Guy Benyei11169dd2012-12-18 14:30:41 +00002115/// CreateTypeNode - Create a new debug type node.
David Blaikie99dab3b2013-09-04 22:03:57 +00002116llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002117 // Handle qualifiers, which recursively handles what they refer to.
2118 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002119 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002120
Guy Benyei11169dd2012-12-18 14:30:41 +00002121 // Work out details of type.
2122 switch (Ty->getTypeClass()) {
2123#define TYPE(Class, Base)
2124#define ABSTRACT_TYPE(Class, Base)
2125#define NON_CANONICAL_TYPE(Class, Base)
2126#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2127#include "clang/AST/TypeNodes.def"
2128 llvm_unreachable("Dependent types cannot show up in debug information");
2129
2130 case Type::ExtVector:
2131 case Type::Vector:
2132 return CreateType(cast<VectorType>(Ty), Unit);
2133 case Type::ObjCObjectPointer:
2134 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2135 case Type::ObjCObject:
2136 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2137 case Type::ObjCInterface:
2138 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2139 case Type::Builtin:
2140 return CreateType(cast<BuiltinType>(Ty));
2141 case Type::Complex:
2142 return CreateType(cast<ComplexType>(Ty));
2143 case Type::Pointer:
2144 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002145 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002146 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002147 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002148 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002149 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002150 case Type::BlockPointer:
2151 return CreateType(cast<BlockPointerType>(Ty), Unit);
2152 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002153 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002154 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002155 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002156 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002157 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002158 case Type::FunctionProto:
2159 case Type::FunctionNoProto:
2160 return CreateType(cast<FunctionType>(Ty), Unit);
2161 case Type::ConstantArray:
2162 case Type::VariableArray:
2163 case Type::IncompleteArray:
2164 return CreateType(cast<ArrayType>(Ty), Unit);
2165
2166 case Type::LValueReference:
2167 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2168 case Type::RValueReference:
2169 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2170
2171 case Type::MemberPointer:
2172 return CreateType(cast<MemberPointerType>(Ty), Unit);
2173
2174 case Type::Atomic:
2175 return CreateType(cast<AtomicType>(Ty), Unit);
2176
Guy Benyei11169dd2012-12-18 14:30:41 +00002177 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002178 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2179
David Blaikie42edade2014-11-11 20:44:45 +00002180 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002181 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002182 case Type::Elaborated:
2183 case Type::Paren:
2184 case Type::SubstTemplateTypeParm:
2185 case Type::TypeOfExpr:
2186 case Type::TypeOf:
2187 case Type::Decltype:
2188 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002189 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002190 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002191 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002192
David Blaikie42edade2014-11-11 20:44:45 +00002193 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002194}
2195
2196/// getOrCreateLimitedType - Get the type from the cache or create a new
2197/// limited type if necessary.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002198llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002199 llvm::DIFile Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002200 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002201
David Blaikie8d5e1282013-08-20 21:03:29 +00002202 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002203
2204 // We may have cached a forward decl when we could have created
2205 // a non-forward decl. Go ahead and create a non-forward decl
2206 // now.
Eric Christophere7b87e52014-10-26 23:40:33 +00002207 if (T && !T.isForwardDecl())
2208 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.
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002216 DBuilder.replaceArrays(Res, T.getElements());
Guy Benyei11169dd2012-12-18 14:30:41 +00002217
Guy Benyei11169dd2012-12-18 14:30:41 +00002218 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002219 TypeCache[QTy.getAsOpaquePtr()].reset(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()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002239 return T;
David Blaikied2785892013-08-18 17:36:19 +00002240
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())
Eric Christophere7b87e52014-10-26 23:40:33 +00002254 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line, Size,
2255 Align, 0, llvm::DIArray(), 0, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002256 else if (RD->isClass()) {
2257 // FIXME: This could be a struct type giving a default visibility different
2258 // than C++ class type, but needs llvm metadata changes first.
Eric Christophere7b87e52014-10-26 23:40:33 +00002259 RealDecl = DBuilder.createClassType(
2260 RDContext, RDName, DefUnit, Line, Size, Align, 0, 0, llvm::DIType(),
2261 llvm::DIArray(), llvm::DIType(), llvm::DIArray(), FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002262 } else
Eric Christophere7b87e52014-10-26 23:40:33 +00002263 RealDecl = DBuilder.createStructType(
2264 RDContext, RDName, DefUnit, Line, Size, Align, 0, llvm::DIType(),
2265 llvm::DIArray(), 0, llvm::DIType(), FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002266
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002267 RegionMap[Ty->getDecl()].reset(RealDecl);
2268 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002269
David Blaikieadfbf992013-08-18 16:55:33 +00002270 if (const ClassTemplateSpecializationDecl *TSpecial =
2271 dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002272 DBuilder.replaceArrays(RealDecl, llvm::DIArray(),
2273 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002274 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002275}
2276
David Blaikieadfbf992013-08-18 16:55:33 +00002277void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2278 llvm::DICompositeType RealDecl) {
2279 // A class's primary base or the class itself contains the vtable.
2280 llvm::DICompositeType ContainingType;
2281 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2282 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002283 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002284 while (1) {
2285 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2286 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2287 if (PBT && !BRL.isPrimaryBaseVirtual())
2288 PBase = PBT;
2289 else
2290 break;
2291 }
2292 ContainingType = llvm::DICompositeType(
2293 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2294 getOrCreateFile(RD->getLocation())));
2295 } else if (RD->isDynamicClass())
2296 ContainingType = RealDecl;
2297
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002298 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002299}
2300
Guy Benyei11169dd2012-12-18 14:30:41 +00002301/// CreateMemberType - Create new member and increase Offset by FType's size.
2302llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
Eric Christophere7b87e52014-10-26 23:40:33 +00002303 StringRef Name, uint64_t *Offset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002304 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2305 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2306 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Eric Christophere7b87e52014-10-26 23:40:33 +00002307 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize,
2308 FieldAlign, *Offset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002309 *Offset += FieldSize;
2310 return Ty;
2311}
2312
Frederic Riss9db79f12014-11-18 03:40:46 +00002313void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD,
2314 llvm::DIFile Unit,
2315 StringRef &Name, StringRef &LinkageName,
2316 llvm::DIDescriptor &FDContext,
2317 llvm::DIArray &TParamsArray,
2318 unsigned &Flags) {
2319 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
2320 Name = getFunctionName(FD);
2321 // Use mangled name as linkage name for C/C++ functions.
2322 if (FD->hasPrototype()) {
2323 LinkageName = CGM.getMangledName(GD);
2324 Flags |= llvm::DIDescriptor::FlagPrototyped;
2325 }
2326 // No need to replicate the linkage name if it isn't different from the
2327 // subprogram name, no need to have it at all unless coverage is enabled or
2328 // debug is set to more than just line tables.
2329 if (LinkageName == Name ||
2330 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2331 !CGM.getCodeGenOpts().EmitGcovNotes &&
2332 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
2333 LinkageName = StringRef();
2334
2335 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
2336 if (const NamespaceDecl *NSDecl =
2337 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2338 FDContext = getOrCreateNameSpace(NSDecl);
2339 else if (const RecordDecl *RDecl =
2340 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2341 FDContext = getContextDescriptor(cast<Decl>(RDecl));
2342 // Collect template parameters.
2343 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2344 }
2345}
2346
2347void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile &Unit,
2348 unsigned &LineNo, QualType &T,
2349 StringRef &Name, StringRef &LinkageName,
2350 llvm::DIDescriptor &VDContext) {
2351 Unit = getOrCreateFile(VD->getLocation());
2352 LineNo = getLineNumber(VD->getLocation());
2353
2354 setLocation(VD->getLocation());
2355
2356 T = VD->getType();
2357 if (T->isIncompleteArrayType()) {
2358 // CodeGen turns int[] into int[1] so we'll do the same here.
2359 llvm::APInt ConstVal(32, 1);
2360 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2361
2362 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2363 ArrayType::Normal, 0);
2364 }
2365
2366 Name = VD->getName();
2367 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2368 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2369 LinkageName = CGM.getMangledName(VD);
2370 if (LinkageName == Name)
2371 LinkageName = StringRef();
2372
2373 // Since we emit declarations (DW_AT_members) for static members, place the
2374 // definition of those static members in the namespace they were declared in
2375 // in the source code (the lexical decl context).
2376 // FIXME: Generalize this for even non-member global variables where the
2377 // declaration and definition may have different lexical decl contexts, once
2378 // we have support for emitting declarations of (non-member) global variables.
2379 VDContext = getContextDescriptor(
2380 dyn_cast<Decl>(VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2381 : VD->getDeclContext()));
2382}
2383
Frederic Rissd253ed62014-11-18 03:40:51 +00002384llvm::DISubprogram
2385CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
2386 llvm::DIArray TParamsArray;
2387 StringRef Name, LinkageName;
2388 unsigned Flags = 0;
2389 SourceLocation Loc = FD->getLocation();
2390 llvm::DIFile Unit = getOrCreateFile(Loc);
2391 llvm::DIDescriptor DContext(Unit);
2392 unsigned Line = getLineNumber(Loc);
2393
2394 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2395 TParamsArray, Flags);
2396 // Build function type.
2397 SmallVector<QualType, 16> ArgTypes;
2398 for (const ParmVarDecl *Parm: FD->parameters())
2399 ArgTypes.push_back(Parm->getType());
2400 QualType FnType =
2401 CGM.getContext().getFunctionType(FD->getReturnType(), ArgTypes,
2402 FunctionProtoType::ExtProtoInfo());
2403 llvm::DISubprogram SP =
2404 DBuilder.createTempFunctionFwdDecl(DContext, Name, LinkageName, Unit, Line,
2405 getOrCreateFunctionType(FD, FnType, Unit),
2406 !FD->isExternallyVisible(),
2407 false /*declaration*/, 0, Flags,
2408 CGM.getLangOpts().Optimize, nullptr,
2409 TParamsArray, getFunctionDeclaration(FD));
2410 const FunctionDecl *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002411 FwdDeclReplaceMap.emplace_back(
2412 std::piecewise_construct, std::make_tuple(CanonDecl),
2413 std::make_tuple(static_cast<llvm::Metadata *>(SP)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002414 return SP;
2415}
2416
2417llvm::DIGlobalVariable
2418CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2419 QualType T;
2420 StringRef Name, LinkageName;
2421 SourceLocation Loc = VD->getLocation();
2422 llvm::DIFile Unit = getOrCreateFile(Loc);
2423 llvm::DIDescriptor DContext(Unit);
2424 unsigned Line = getLineNumber(Loc);
2425
2426 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
2427 llvm::DIGlobalVariable GV =
2428 DBuilder.createTempGlobalVariableFwdDecl(DContext, Name, LinkageName, Unit,
2429 Line, getOrCreateType(T, Unit),
2430 !VD->isExternallyVisible(),
2431 nullptr, nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002432 FwdDeclReplaceMap.emplace_back(
2433 std::piecewise_construct,
2434 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2435 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002436 return GV;
2437}
2438
Frederic Riss442293e2014-11-06 21:12:06 +00002439llvm::DIDescriptor CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002440 // We only need a declaration (not a definition) of the type - so use whatever
2441 // we would otherwise do to get a type for a pointee. (forward declarations in
2442 // limited debug info, full definitions (if the type definition is available)
2443 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002444 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2445 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002446 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002447 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002448
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002449 if (I != DeclCache.end())
2450 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(I->second));
Frederic Rissd253ed62014-11-18 03:40:51 +00002451
2452 // No definition for now. Emit a forward definition that might be
2453 // merged with a potential upcoming definition.
2454 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
2455 return getFunctionForwardDeclaration(FD);
2456 else if (const auto *VD = dyn_cast<VarDecl>(D))
2457 return getGlobalVariableForwardDeclaration(VD);
2458
2459 return llvm::DIDescriptor();
David Blaikiebd483762013-05-20 04:58:53 +00002460}
2461
Guy Benyei11169dd2012-12-18 14:30:41 +00002462/// getFunctionDeclaration - Return debug info descriptor to describe method
2463/// declaration for the given method definition.
2464llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Diego Novillo913690c2014-06-24 17:02:17 +00002465 if (!D || DebugKind <= CodeGenOptions::DebugLineTablesOnly)
David Blaikie18cfbc52013-06-22 00:09:36 +00002466 return llvm::DISubprogram();
2467
Guy Benyei11169dd2012-12-18 14:30:41 +00002468 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002469 if (!FD)
2470 return llvm::DISubprogram();
Guy Benyei11169dd2012-12-18 14:30:41 +00002471
2472 // Setup context.
David Blaikiefd07c602013-08-09 17:20:05 +00002473 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002474
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002475 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002476 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002477 if (const CXXMethodDecl *MD =
2478 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikiefd07c602013-08-09 17:20:05 +00002479 llvm::DICompositeType T(S);
Eric Christopherf86c4052013-08-28 23:12:10 +00002480 llvm::DISubprogram SP =
2481 CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
David Blaikiefd07c602013-08-09 17:20:05 +00002482 return SP;
2483 }
2484 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002485 if (MI != SPCache.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002486 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(MI->second));
David Blaikie18cfbc52013-06-22 00:09:36 +00002487 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002488 return SP;
2489 }
2490
Aaron Ballman86c93902014-03-06 23:45:36 +00002491 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002492 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002493 if (MI != SPCache.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002494 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(MI->second));
David Blaikie18cfbc52013-06-22 00:09:36 +00002495 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002496 return SP;
2497 }
2498 }
2499 return llvm::DISubprogram();
2500}
2501
2502// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2503// implicit parameter "this".
David Blaikie469f0792013-05-22 23:22:42 +00002504llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2505 QualType FnType,
2506 llvm::DIFile F) {
Diego Novillo913690c2014-06-24 17:02:17 +00002507 if (!D || DebugKind <= CodeGenOptions::DebugLineTablesOnly)
David Blaikie18cfbc52013-06-22 00:09:36 +00002508 // Create fake but valid subroutine type. Otherwise
2509 // llvm::DISubprogram::Verify() would return false, and
2510 // subprogram DIE will miss DW_AT_decl_file and
2511 // DW_AT_decl_line fields.
Manman Ren67f005e2014-07-28 22:24:34 +00002512 return DBuilder.createSubroutineType(F,
2513 DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002514
2515 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2516 return getOrCreateMethodType(Method, F);
2517 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2518 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002519 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002520
2521 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002522 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002523
2524 // Replace the instancetype keyword with the actual type.
2525 if (ResultTy == CGM.getContext().getObjCInstanceType())
2526 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002527 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002528
Adrian Prantl7bec9032013-05-10 21:08:31 +00002529 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002530 // "self" pointer is always first argument.
Adrian Prantlde17db32013-03-29 19:20:29 +00002531 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2532 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2533 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002534 // "_cmd" pointer is always second argument.
2535 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2536 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2537 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002538 for (const auto *PI : OMethod->params())
2539 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00002540 // Variadic methods need a special marker at the end of the type list.
2541 if (OMethod->isVariadic())
2542 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00002543
Manman Ren67f005e2014-07-28 22:24:34 +00002544 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002545 return DBuilder.createSubroutineType(F, EltTypeArray);
2546 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002547
Adrian Prantl800faef2014-02-25 23:42:18 +00002548 // Handle variadic function types; they need an additional
2549 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002550 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2551 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002552 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00002553 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2554 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2555 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2556 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2557 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Manman Ren67f005e2014-07-28 22:24:34 +00002558 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Adrian Prantld45ba252014-02-25 19:38:11 +00002559 return DBuilder.createSubroutineType(F, EltTypeArray);
2560 }
2561
David Blaikie469f0792013-05-22 23:22:42 +00002562 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002563}
2564
2565/// EmitFunctionStart - Constructs the debug code for entering a function.
Eric Christophere7b87e52014-10-26 23:40:33 +00002566void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
2567 SourceLocation ScopeLoc, QualType FnType,
2568 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002569
2570 StringRef Name;
2571 StringRef LinkageName;
2572
2573 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2574
2575 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002576 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002577
Guy Benyei11169dd2012-12-18 14:30:41 +00002578 unsigned Flags = 0;
2579 llvm::DIFile Unit = getOrCreateFile(Loc);
2580 llvm::DIDescriptor FDContext(Unit);
2581 llvm::DIArray TParamsArray;
2582 if (!HasDecl) {
2583 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002584 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002585 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2586 // If there is a DISubprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002587 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002588 if (FI != SPCache.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002589 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(FI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00002590 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2591 llvm::MDNode *SPN = SP;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002592 LexicalBlockStack.emplace_back(SPN);
2593 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002594 return;
2595 }
2596 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002597 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2598 TParamsArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002599 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2600 Name = getObjCMethodName(OMD);
2601 Flags |= llvm::DIDescriptor::FlagPrototyped;
2602 } else {
2603 // Use llvm function name.
2604 Name = Fn->getName();
2605 Flags |= llvm::DIDescriptor::FlagPrototyped;
2606 }
2607 if (!Name.empty() && Name[0] == '\01')
2608 Name = Name.substr(1);
2609
Adrian Prantl42d71b92014-04-10 23:21:53 +00002610 if (!HasDecl || D->isImplicit()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002611 Flags |= llvm::DIDescriptor::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002612 // Artificial functions without a location should not silently reuse CurLoc.
2613 if (Loc.isInvalid())
2614 CurLoc = SourceLocation();
2615 }
2616 unsigned LineNo = getLineNumber(Loc);
2617 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002618
Eric Christopher8018e412014-03-27 18:50:35 +00002619 // FIXME: The function declaration we're constructing here is mostly reusing
2620 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2621 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2622 // all subprograms instead of the actual context since subprogram definitions
2623 // are emitted as CU level entities by the backend.
Eric Christophere7b87e52014-10-26 23:40:33 +00002624 llvm::DISubprogram SP = DBuilder.createFunction(
2625 FDContext, Name, LinkageName, Unit, LineNo,
2626 getOrCreateFunctionType(D, FnType, Unit), Fn->hasInternalLinkage(),
2627 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize, Fn,
2628 TParamsArray, getFunctionDeclaration(D));
Frederic Rissb1ab28c2014-11-05 19:19:04 +00002629 // We might get here with a VarDecl in the case we're generating
2630 // code for the initialization of globals. Do not record these decls
2631 // as they will overwrite the actual VarDecl Decl in the cache.
2632 if (HasDecl && isa<FunctionDecl>(D))
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002633 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(SP));
Guy Benyei11169dd2012-12-18 14:30:41 +00002634
Adrian Prantlbebb8932014-03-21 21:01:58 +00002635 // Push the function onto the lexical block stack.
Guy Benyei11169dd2012-12-18 14:30:41 +00002636 llvm::MDNode *SPN = SP;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002637 LexicalBlockStack.emplace_back(SPN);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002638
Guy Benyei11169dd2012-12-18 14:30:41 +00002639 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002640 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002641}
2642
2643/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl02c0caa2013-07-18 00:27:59 +00002644/// information in the source file. If the location is invalid, the
2645/// previous location will be reused.
David Blaikie835afb22015-01-21 23:08:17 +00002646void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002647 // Update our current location
2648 setLocation(Loc);
2649
Eric Christophere7b87e52014-10-26 23:40:33 +00002650 if (CurLoc.isInvalid() || CurLoc.isMacroID())
2651 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002652
Adrian Prantle83b1302014-01-07 22:05:52 +00002653 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00002654 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00002655 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002656}
2657
2658/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2659/// the stack.
2660void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002661 llvm::MDNode *Back = nullptr;
2662 if (!LexicalBlockStack.empty())
2663 Back = LexicalBlockStack.back().get();
David Blaikief9ea2422014-06-02 16:32:05 +00002664 llvm::DIDescriptor D = DBuilder.createLexicalBlock(
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002665 llvm::DIDescriptor(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
2666 getColumnNumber(CurLoc));
Guy Benyei11169dd2012-12-18 14:30:41 +00002667 llvm::MDNode *DN = D;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002668 LexicalBlockStack.emplace_back(DN);
Guy Benyei11169dd2012-12-18 14:30:41 +00002669}
2670
2671/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2672/// region - beginning of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002673void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2674 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002675 // Set our current location.
2676 setLocation(Loc);
2677
Guy Benyei11169dd2012-12-18 14:30:41 +00002678 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00002679 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
2680 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00002681
2682 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2683 return;
2684
2685 // Create a new lexical block and push it on the stack.
2686 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002687}
2688
2689/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2690/// region - end of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002691void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2692 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002693 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2694
2695 // Provide an entry in the line table for the end of the block.
2696 EmitLocation(Builder, Loc);
2697
David Blaikie60a877b2014-10-22 19:34:33 +00002698 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2699 return;
2700
Guy Benyei11169dd2012-12-18 14:30:41 +00002701 LexicalBlockStack.pop_back();
2702}
2703
2704/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2705void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2706 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2707 unsigned RCount = FnBeginRegionCount.back();
2708 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2709
2710 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00002711 while (LexicalBlockStack.size() != RCount) {
2712 // Provide an entry in the line table for the end of the block.
2713 EmitLocation(Builder, CurLoc);
2714 LexicalBlockStack.pop_back();
2715 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002716 FnBeginRegionCount.pop_back();
2717}
2718
Eric Christopherb2a008c2013-05-16 00:45:12 +00002719// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei11169dd2012-12-18 14:30:41 +00002720// See BuildByRefType.
2721llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2722 uint64_t *XOffset) {
2723
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002724 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002725 QualType FType;
2726 uint64_t FieldSize, FieldOffset;
2727 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002728
Guy Benyei11169dd2012-12-18 14:30:41 +00002729 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002730 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002731
2732 FieldOffset = 0;
2733 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2734 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2735 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2736 FType = CGM.getContext().IntTy;
2737 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2738 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2739
2740 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2741 if (HasCopyAndDispose) {
2742 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002743 EltTys.push_back(
2744 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
2745 EltTys.push_back(
2746 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00002747 }
2748 bool HasByrefExtendedLayout;
2749 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00002750 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
2751 HasByrefExtendedLayout) &&
2752 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00002753 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002754 EltTys.push_back(
2755 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002756 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002757
Guy Benyei11169dd2012-12-18 14:30:41 +00002758 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2759 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00002760 CGM.getTarget().getPointerAlign(0))) {
2761 CharUnits FieldOffsetInBytes =
2762 CGM.getContext().toCharUnitsFromBits(FieldOffset);
2763 CharUnits AlignedOffsetInBytes =
2764 FieldOffsetInBytes.RoundUpToAlignment(Align);
2765 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002766
Guy Benyei11169dd2012-12-18 14:30:41 +00002767 if (NumPaddingBytes.isPositive()) {
2768 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2769 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2770 pad, ArrayType::Normal, 0);
2771 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2772 }
2773 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002774
Guy Benyei11169dd2012-12-18 14:30:41 +00002775 FType = Type;
David Blaikief427b002014-05-06 03:42:01 +00002776 llvm::DIType FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002777 FieldSize = CGM.getContext().getTypeSize(FType);
2778 FieldAlign = CGM.getContext().toBits(Align);
2779
Eric Christopherb2a008c2013-05-16 00:45:12 +00002780 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00002781 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
2782 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002783 EltTys.push_back(FieldTy);
2784 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002785
Guy Benyei11169dd2012-12-18 14:30:41 +00002786 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002787
Guy Benyei11169dd2012-12-18 14:30:41 +00002788 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002789
Guy Benyei11169dd2012-12-18 14:30:41 +00002790 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00002791 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002792}
2793
2794/// EmitDeclare - Emit local variable declaration debug info.
Ed Masteda706022014-05-07 12:49:30 +00002795void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::dwarf::LLVMConstants Tag,
Eric Christophere7b87e52014-10-26 23:40:33 +00002796 llvm::Value *Storage, unsigned ArgNo,
2797 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002798 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002799 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2800
David Blaikie7fceebf2013-08-19 03:37:48 +00002801 bool Unwritten =
2802 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2803 cast<Decl>(VD->getDeclContext())->isImplicit());
2804 llvm::DIFile Unit;
2805 if (!Unwritten)
2806 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002807 llvm::DIType Ty;
2808 uint64_t XOffset = 0;
2809 if (VD->hasAttr<BlocksAttr>())
2810 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002811 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002812 Ty = getOrCreateType(VD->getType(), Unit);
2813
2814 // If there is no debug info for this type then do not emit debug info
2815 // for this variable.
2816 if (!Ty)
2817 return;
2818
Guy Benyei11169dd2012-12-18 14:30:41 +00002819 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002820 unsigned Line = 0;
2821 unsigned Column = 0;
2822 if (!Unwritten) {
2823 Line = getLineNumber(VD->getLocation());
2824 Column = getColumnNumber(VD->getLocation());
2825 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002826 SmallVector<int64_t, 9> Expr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002827 unsigned Flags = 0;
2828 if (VD->isImplicit())
2829 Flags |= llvm::DIDescriptor::FlagArtificial;
2830 // If this is the first argument and it is implicit then
2831 // give it an object pointer flag.
2832 // FIXME: There has to be a better way to do this, but for static
2833 // functions there won't be an implicit param at arg1 and
2834 // otherwise it is 'self' or 'this'.
2835 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2836 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002837 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002838 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2839 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002840 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00002841
2842 llvm::MDNode *Scope = LexicalBlockStack.back();
2843
2844 StringRef Name = VD->getName();
2845 if (!Name.empty()) {
2846 if (VD->hasAttr<BlocksAttr>()) {
2847 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002848 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002849 // offset of __forwarding field
2850 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00002851 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002852 Expr.push_back(offset.getQuantity());
2853 Expr.push_back(llvm::dwarf::DW_OP_deref);
2854 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002855 // offset of x field
2856 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002857 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002858
2859 // Create the descriptor for the variable.
Eric Christophere7b87e52014-10-26 23:40:33 +00002860 llvm::DIVariable D = DBuilder.createLocalVariable(
2861 Tag, llvm::DIDescriptor(Scope), VD->getName(), Unit, Line, Ty, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002862
Guy Benyei11169dd2012-12-18 14:30:41 +00002863 // Insert an llvm.dbg.declare into the current block.
2864 llvm::Instruction *Call =
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002865 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Eric Christophere7b87e52014-10-26 23:40:33 +00002866 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00002867 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2868 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00002869 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002870 Expr.push_back(llvm::dwarf::DW_OP_deref);
David Blaikiea76a7c92013-01-05 05:58:35 +00002871 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2872 // If VD is an anonymous union then Storage represents value for
2873 // all union fields.
Guy Benyei11169dd2012-12-18 14:30:41 +00002874 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikie219c7d92013-01-05 20:03:07 +00002875 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002876 for (const auto *Field : RD->fields()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002877 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2878 StringRef FieldName = Field->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002879
Guy Benyei11169dd2012-12-18 14:30:41 +00002880 // Ignore unnamed fields. Do not ignore unnamed records.
2881 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2882 continue;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002883
Guy Benyei11169dd2012-12-18 14:30:41 +00002884 // Use VarDecl's Tag, Scope and Line number.
Eric Christophere7b87e52014-10-26 23:40:33 +00002885 llvm::DIVariable D = DBuilder.createLocalVariable(
2886 Tag, llvm::DIDescriptor(Scope), FieldName, Unit, Line, FieldTy,
2887 CGM.getLangOpts().Optimize, Flags, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002888
Guy Benyei11169dd2012-12-18 14:30:41 +00002889 // Insert an llvm.dbg.declare into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00002890 llvm::Instruction *Call = DBuilder.insertDeclare(
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002891 Storage, D, DBuilder.createExpression(Expr),
2892 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00002893 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2894 }
David Blaikie219c7d92013-01-05 20:03:07 +00002895 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002896 }
2897 }
David Blaikiea76a7c92013-01-05 05:58:35 +00002898
2899 // Create the descriptor for the variable.
Eric Christophere7b87e52014-10-26 23:40:33 +00002900 llvm::DIVariable D = DBuilder.createLocalVariable(
2901 Tag, llvm::DIDescriptor(Scope), Name, Unit, Line, Ty,
2902 CGM.getLangOpts().Optimize, Flags, ArgNo);
David Blaikiea76a7c92013-01-05 05:58:35 +00002903
2904 // Insert an llvm.dbg.declare into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00002905 llvm::Instruction *Call = DBuilder.insertDeclare(
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002906 Storage, D, DBuilder.createExpression(Expr), Builder.GetInsertBlock());
David Blaikiea76a7c92013-01-05 05:58:35 +00002907 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002908}
2909
2910void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2911 llvm::Value *Storage,
2912 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002913 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002914 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2915}
2916
Adrian Prantlde17db32013-03-29 19:20:29 +00002917/// Look up the completed type for a self pointer in the TypeCache and
2918/// create a copy of it with the ObjectPointer and Artificial flags
2919/// set. If the type is not cached, a new one is created. This should
2920/// never happen though, since creating a type for the implicit self
2921/// argument implies that we already parsed the interface definition
2922/// and the ivar declarations in the implementation.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002923llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2924 llvm::DIType Ty) {
Adrian Prantlde17db32013-03-29 19:20:29 +00002925 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002926 if (CachedTy)
2927 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00002928 return DBuilder.createObjectPointerType(Ty);
2929}
2930
Eric Christophere7b87e52014-10-26 23:40:33 +00002931void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
2932 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00002933 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Eric Christopher75e17682013-05-16 00:45:23 +00002934 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002935 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00002936
Craig Topper8a13c412014-05-21 05:09:00 +00002937 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00002938 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002939
Guy Benyei11169dd2012-12-18 14:30:41 +00002940 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002941
Guy Benyei11169dd2012-12-18 14:30:41 +00002942 uint64_t XOffset = 0;
2943 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2944 llvm::DIType Ty;
2945 if (isByRef)
2946 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002947 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002948 Ty = getOrCreateType(VD->getType(), Unit);
2949
2950 // Self is passed along as an implicit non-arg variable in a
2951 // block. Mark it as the object pointer.
2952 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00002953 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002954
2955 // Get location information.
2956 unsigned Line = getLineNumber(VD->getLocation());
2957 unsigned Column = getColumnNumber(VD->getLocation());
2958
2959 const llvm::DataLayout &target = CGM.getDataLayout();
2960
2961 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00002962 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00002963 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2964
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002965 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00002966 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002967 addr.push_back(llvm::dwarf::DW_OP_deref);
2968 addr.push_back(llvm::dwarf::DW_OP_plus);
2969 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002970 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002971 addr.push_back(llvm::dwarf::DW_OP_deref);
2972 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002973 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00002974 offset =
2975 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002976 addr.push_back(offset.getQuantity());
2977 addr.push_back(llvm::dwarf::DW_OP_deref);
2978 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002979 // offset of x field
2980 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002981 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002982 }
2983
2984 // Create the descriptor for the variable.
2985 llvm::DIVariable D =
Eric Christophere7b87e52014-10-26 23:40:33 +00002986 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_auto_variable,
2987 llvm::DIDescriptor(LexicalBlockStack.back()),
2988 VD->getName(), Unit, Line, Ty);
Adrian Prantl0f6df002013-03-29 19:20:35 +00002989
Guy Benyei11169dd2012-12-18 14:30:41 +00002990 // Insert an llvm.dbg.declare into the current block.
Adrian Prantl88eec392014-11-21 00:35:25 +00002991 llvm::Instruction *Call = InsertPoint ?
2992 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr),
2993 InsertPoint)
2994 : DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr),
2995 Builder.GetInsertBlock());
Eric Christophere7b87e52014-10-26 23:40:33 +00002996 Call->setDebugLoc(
2997 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002998}
2999
3000/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
3001/// variable declaration.
3002void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3003 unsigned ArgNo,
3004 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003005 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003006 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
3007}
3008
3009namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003010struct BlockLayoutChunk {
3011 uint64_t OffsetInBits;
3012 const BlockDecl::Capture *Capture;
3013};
3014bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3015 return l.OffsetInBits < r.OffsetInBits;
3016}
Guy Benyei11169dd2012-12-18 14:30:41 +00003017}
3018
3019void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003020 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003021 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003022 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003023 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003024 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003025 ASTContext &C = CGM.getContext();
3026 const BlockDecl *blockDecl = block.getBlockDecl();
3027
3028 // Collect some general information about the block's location.
3029 SourceLocation loc = blockDecl->getCaretLocation();
3030 llvm::DIFile tunit = getOrCreateFile(loc);
3031 unsigned line = getLineNumber(loc);
3032 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003033
Guy Benyei11169dd2012-12-18 14:30:41 +00003034 // Build the debug-info type for the block literal.
3035 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
3036
3037 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003038 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003039
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003040 SmallVector<llvm::Metadata *, 16> fields;
Guy Benyei11169dd2012-12-18 14:30:41 +00003041 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
3042 blockLayout->getElementOffsetInBits(0),
3043 tunit, tunit));
3044 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
3045 blockLayout->getElementOffsetInBits(1),
3046 tunit, tunit));
3047 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
3048 blockLayout->getElementOffsetInBits(2),
3049 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003050 auto *FnTy = block.getBlockExpr()->getFunctionType();
3051 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3052 fields.push_back(createFieldType("__FuncPtr", FnPtrType, 0, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003053 blockLayout->getElementOffsetInBits(3),
3054 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003055 fields.push_back(createFieldType(
3056 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3057 ? C.getBlockDescriptorExtendedType()
3058 : C.getBlockDescriptorType()),
3059 0, loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003060
3061 // We want to sort the captures by offset, not because DWARF
3062 // requires this, but because we're paranoid about debuggers.
3063 SmallVector<BlockLayoutChunk, 8> chunks;
3064
3065 // 'this' capture.
3066 if (blockDecl->capturesCXXThis()) {
3067 BlockLayoutChunk chunk;
3068 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003069 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003070 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003071 chunks.push_back(chunk);
3072 }
3073
3074 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003075 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003076 const VarDecl *variable = capture.getVariable();
3077 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3078
3079 // Ignore constant captures.
3080 if (captureInfo.isConstant())
3081 continue;
3082
3083 BlockLayoutChunk chunk;
3084 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003085 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003086 chunk.Capture = &capture;
3087 chunks.push_back(chunk);
3088 }
3089
3090 // Sort by offset.
3091 llvm::array_pod_sort(chunks.begin(), chunks.end());
3092
Eric Christophere7b87e52014-10-26 23:40:33 +00003093 for (SmallVectorImpl<BlockLayoutChunk>::iterator i = chunks.begin(),
3094 e = chunks.end();
3095 i != e; ++i) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003096 uint64_t offsetInBits = i->OffsetInBits;
3097 const BlockDecl::Capture *capture = i->Capture;
3098
3099 // If we have a null capture, this must be the C++ 'this' capture.
3100 if (!capture) {
3101 const CXXMethodDecl *method =
Eric Christophere7b87e52014-10-26 23:40:33 +00003102 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00003103 QualType type = method->getThisType(C);
3104
3105 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3106 offsetInBits, tunit, tunit));
3107 continue;
3108 }
3109
3110 const VarDecl *variable = capture->getVariable();
3111 StringRef name = variable->getName();
3112
3113 llvm::DIType fieldType;
3114 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003115 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003116
3117 // FIXME: this creates a second copy of this type!
3118 uint64_t xoffset;
3119 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003120 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3121 fieldType =
3122 DBuilder.createMemberType(tunit, name, tunit, line, PtrInfo.Width,
3123 PtrInfo.Align, offsetInBits, 0, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003124 } else {
Eric Christophere7b87e52014-10-26 23:40:33 +00003125 fieldType = createFieldType(name, variable->getType(), 0, loc, AS_public,
3126 offsetInBits, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003127 }
3128 fields.push_back(fieldType);
3129 }
3130
3131 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003132 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3133 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003134
3135 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3136
3137 llvm::DIType type =
Eric Christophere7b87e52014-10-26 23:40:33 +00003138 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3139 CGM.getContext().toBits(block.BlockSize),
3140 CGM.getContext().toBits(block.BlockAlign), 0,
3141 llvm::DIType(), fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003142 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3143
3144 // Get overall information about the block.
3145 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3146 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei11169dd2012-12-18 14:30:41 +00003147
3148 // Create the descriptor for the parameter.
Eric Christophere7b87e52014-10-26 23:40:33 +00003149 llvm::DIVariable debugVar = DBuilder.createLocalVariable(
3150 llvm::dwarf::DW_TAG_arg_variable, llvm::DIDescriptor(scope),
3151 Arg->getName(), tunit, line, type, CGM.getLangOpts().Optimize, flags,
3152 ArgNo);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003153
Adrian Prantl616bef42013-03-14 21:52:59 +00003154 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003155 // Insert an llvm.dbg.value into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00003156 llvm::Instruction *DbgVal = DBuilder.insertDbgValueIntrinsic(
3157 LocalAddr, 0, debugVar, DBuilder.createExpression(),
3158 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003159 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3160 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003161
Adrian Prantl616bef42013-03-14 21:52:59 +00003162 // Insert an llvm.dbg.declare into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00003163 llvm::Instruction *DbgDecl = DBuilder.insertDeclare(
3164 Arg, debugVar, DBuilder.createExpression(), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003165 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003166}
3167
David Blaikie6943dea2013-08-20 01:28:15 +00003168/// If D is an out-of-class definition of a static data member of a class, find
3169/// its corresponding in-class declaration.
3170llvm::DIDerivedType
3171CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3172 if (!D->isStaticDataMember())
3173 return llvm::DIDerivedType();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003174 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003175 if (MI != StaticDataMemberCache.end()) {
3176 assert(MI->second && "Static data member declaration should still exist");
3177 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003178 }
David Blaikiece763042013-08-20 21:49:21 +00003179
3180 // If the member wasn't found in the cache, lazily construct and add it to the
3181 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003182 auto DC = D->getDeclContext();
3183 llvm::DICompositeType Ctxt(getContextDescriptor(cast<Decl>(DC)));
3184 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003185}
3186
Eric Christophercab9fae2014-04-10 05:20:00 +00003187/// Recursively collect all of the member fields of a global anonymous decl and
3188/// create static variables for them. The first time this is called it needs
3189/// to be on a union and then from there we can have additional unnamed fields.
3190llvm::DIGlobalVariable
3191CGDebugInfo::CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile Unit,
3192 unsigned LineNo, StringRef LinkageName,
3193 llvm::GlobalVariable *Var,
3194 llvm::DIDescriptor DContext) {
3195 llvm::DIGlobalVariable GV;
3196
3197 for (const auto *Field : RD->fields()) {
3198 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
3199 StringRef FieldName = Field->getName();
3200
3201 // Ignore unnamed fields, but recurse into anonymous records.
3202 if (FieldName.empty()) {
3203 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3204 if (RT)
3205 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3206 Var, DContext);
3207 continue;
3208 }
3209 // Use VarDecl's Tag, Scope and Line number.
Eric Christophere7b87e52014-10-26 23:40:33 +00003210 GV = DBuilder.createGlobalVariable(
3211 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
3212 Var->hasInternalLinkage(), Var, llvm::DIDerivedType());
Eric Christophercab9fae2014-04-10 05:20:00 +00003213 }
3214 return GV;
3215}
3216
Guy Benyei11169dd2012-12-18 14:30:41 +00003217/// EmitGlobalVariable - Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003218void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003219 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003220 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003221 // Create global variable debug descriptor.
Frederic Riss9db79f12014-11-18 03:40:46 +00003222 llvm::DIFile Unit;
3223 llvm::DIDescriptor DContext;
3224 unsigned LineNo;
3225 StringRef DeclName, LinkageName;
3226 QualType T;
3227 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003228
3229 // Attempt to store one global variable for the declaration - even if we
3230 // emit a lot of fields.
3231 llvm::DIGlobalVariable GV;
3232
3233 // If this is an anonymous union then we'll want to emit a global
3234 // variable for each member of the anonymous union so that it's possible
3235 // to find the name of any field in the union.
3236 if (T->isUnionType() && DeclName.empty()) {
3237 const RecordDecl *RD = cast<RecordType>(T)->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003238 assert(RD->isAnonymousStructOrUnion() &&
3239 "unnamed non-anonymous struct or union?");
Eric Christophercab9fae2014-04-10 05:20:00 +00003240 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3241 } else {
David Blaikie7550b112014-10-20 17:42:23 +00003242 GV = DBuilder.createGlobalVariable(
Eric Christophercab9fae2014-04-10 05:20:00 +00003243 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3244 Var->hasInternalLinkage(), Var,
3245 getOrCreateStaticDataMemberDeclarationOrNull(D));
3246 }
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003247 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(GV));
Guy Benyei11169dd2012-12-18 14:30:41 +00003248}
3249
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003250/// EmitGlobalVariable - Emit global variable's debug info.
3251void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3252 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003253 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003254 // Create the descriptor for the variable.
3255 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3256 StringRef Name = VD->getName();
3257 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3258 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3259 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3260 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3261 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3262 }
3263 // Do not use DIGlobalVariable for enums.
3264 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3265 return;
David Blaikiea15565562014-04-04 20:56:17 +00003266 // Do not emit separate definitions for function local const/statics.
3267 if (isa<FunctionDecl>(VD->getDeclContext()))
3268 return;
David Blaikiebb113912014-04-05 07:23:17 +00003269 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003270 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003271 if (VarD->isStaticDataMember()) {
3272 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
3273 getContextDescriptor(RD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003274 // Ensure that the type is retained even though it's otherwise unreferenced.
3275 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003276 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003277 return;
3278 }
3279
David Blaikieaf080852014-11-21 00:20:58 +00003280 llvm::DIDescriptor DContext =
3281 getContextDescriptor(dyn_cast<Decl>(VD->getDeclContext()));
3282
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003283 auto &GV = DeclCache[VD];
3284 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003285 return;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003286 GV.reset(DBuilder.createGlobalVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003287 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003288 true, Init, getOrCreateStaticDataMemberDeclarationOrNull(VarD)));
David Blaikiebd483762013-05-20 04:58:53 +00003289}
3290
3291llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3292 if (!LexicalBlockStack.empty())
3293 return llvm::DIScope(LexicalBlockStack.back());
3294 return getContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003295}
3296
David Blaikie9f88fe82013-04-22 06:13:21 +00003297void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003298 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3299 return;
David Blaikie9f88fe82013-04-22 06:13:21 +00003300 DBuilder.createImportedModule(
David Blaikiebd483762013-05-20 04:58:53 +00003301 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3302 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie9f88fe82013-04-22 06:13:21 +00003303 getLineNumber(UD.getLocation()));
3304}
3305
David Blaikiebd483762013-05-20 04:58:53 +00003306void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3307 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3308 return;
3309 assert(UD.shadow_size() &&
3310 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3311 // Emitting one decl is sufficient - debuggers can detect that this is an
3312 // overloaded name & provide lookup for all the overloads.
3313 const UsingShadowDecl &USD = **UD.shadow_begin();
Frederic Riss442293e2014-11-06 21:12:06 +00003314 if (llvm::DIDescriptor Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003315 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003316 DBuilder.createImportedDeclaration(
3317 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3318 getLineNumber(USD.getLocation()));
3319}
3320
David Blaikief121b932013-05-20 22:50:41 +00003321llvm::DIImportedEntity
3322CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3323 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
Craig Topper8a13c412014-05-21 05:09:00 +00003324 return llvm::DIImportedEntity(nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003325 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003326 if (VH)
3327 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
Craig Topper8a13c412014-05-21 05:09:00 +00003328 llvm::DIImportedEntity R(nullptr);
David Blaikief121b932013-05-20 22:50:41 +00003329 if (const NamespaceAliasDecl *Underlying =
3330 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3331 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003332 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003333 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3334 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3335 NA.getName());
3336 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003337 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003338 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3339 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3340 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003341 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003342 return R;
3343}
3344
Guy Benyei11169dd2012-12-18 14:30:41 +00003345/// getOrCreateNamesSpace - Return namespace descriptor for the given
3346/// namespace decl.
Eric Christopherb2a008c2013-05-16 00:45:12 +00003347llvm::DINameSpace
Guy Benyei11169dd2012-12-18 14:30:41 +00003348CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003349 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003350 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003351 if (I != NameSpaceCache.end())
3352 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003353
Guy Benyei11169dd2012-12-18 14:30:41 +00003354 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3355 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003356 llvm::DIDescriptor Context =
Guy Benyei11169dd2012-12-18 14:30:41 +00003357 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3358 llvm::DINameSpace NS =
3359 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003360 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003361 return NS;
3362}
3363
3364void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003365 // Creating types might create further types - invalidating the current
3366 // element and the size(), so don't cache/reference them.
3367 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3368 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
3369 E.Decl.replaceAllUsesWith(CGM.getLLVMContext(),
3370 E.Type->getDecl()->getDefinition()
3371 ? CreateTypeDefinition(E.Type, E.Unit)
3372 : E.Decl);
3373 }
3374
David Blaikief427b002014-05-06 03:42:01 +00003375 for (auto p : ReplaceMap) {
3376 assert(p.second);
3377 llvm::DIType Ty(cast<llvm::MDNode>(p.second));
David Blaikieb8149042014-05-05 21:21:39 +00003378 assert(Ty.isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003379
David Blaikief427b002014-05-06 03:42:01 +00003380 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003381 assert(it != TypeCache.end());
3382 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003383
David Blaikief427b002014-05-06 03:42:01 +00003384 llvm::DIType RepTy(cast<llvm::MDNode>(it->second));
3385 Ty.replaceAllUsesWith(CGM.getLLVMContext(), RepTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003386 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003387
Frederic Rissd253ed62014-11-18 03:40:51 +00003388 for (const auto &p : FwdDeclReplaceMap) {
3389 assert(p.second);
3390 llvm::DIDescriptor FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003391 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003392
3393 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003394 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003395 // with ourselves, that will destroy the temporary MDNode and
3396 // replace it with a standard one, avoiding leaking memory.
3397 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003398 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003399 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003400 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003401
Frederic Rissd253ed62014-11-18 03:40:51 +00003402 FwdDecl.replaceAllUsesWith(CGM.getLLVMContext(),
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003403 llvm::DIDescriptor(cast<llvm::MDNode>(Repl)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003404 }
3405
Adrian Prantl73409ce2013-03-11 18:33:46 +00003406 // We keep our own list of retained types, because we need to look
3407 // up the final type in the type cache.
3408 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3409 RE = RetainedTypes.end(); RI != RE; ++RI)
David Blaikie0856f662014-03-04 22:01:08 +00003410 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003411
Guy Benyei11169dd2012-12-18 14:30:41 +00003412 DBuilder.finalize();
3413}
David Blaikie66088d52014-09-24 17:01:27 +00003414
3415void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
3416 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3417 return;
3418 llvm::DIType DieTy = getOrCreateType(Ty, getOrCreateMainFile());
3419 // Don't ignore in case of explicit cast where it is referenced indirectly.
3420 DBuilder.retainType(DieTy);
3421}