blob: 00e0da4d9fc570267a852dea195f37dda05369a4 [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 Majnemerb4b671e2016-06-30 03:01:59 +000016#include "CGRecordLayout.h"
David Blaikie38079fd2013-05-10 21:53:14 +000017#include "CGCXXABI.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000018#include "CGObjCRuntime.h"
19#include "CodeGenFunction.h"
20#include "CodeGenModule.h"
21#include "clang/AST/ASTContext.h"
22#include "clang/AST/DeclFriend.h"
23#include "clang/AST/DeclObjC.h"
24#include "clang/AST/DeclTemplate.h"
25#include "clang/AST/Expr.h"
26#include "clang/AST/RecordLayout.h"
27#include "clang/Basic/FileManager.h"
28#include "clang/Basic/SourceManager.h"
29#include "clang/Basic/Version.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000030#include "clang/Frontend/CodeGenOptions.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000031#include "clang/Lex/HeaderSearchOptions.h"
Adrian Prantl9402cef2015-09-20 16:51:35 +000032#include "clang/Lex/ModuleMap.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000033#include "clang/Lex/PreprocessorOptions.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000034#include "llvm/ADT/SmallVector.h"
35#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000036#include "llvm/IR/Constants.h"
37#include "llvm/IR/DataLayout.h"
38#include "llvm/IR/DerivedTypes.h"
39#include "llvm/IR/Instructions.h"
40#include "llvm/IR/Intrinsics.h"
41#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000042#include "llvm/Support/FileSystem.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000043#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000044using namespace clang;
45using namespace clang::CodeGen;
46
47CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000048 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
Adrian Prantl6b21ab22015-08-27 19:46:20 +000049 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
Eric Christopher324bbbd2013-07-14 21:12:44 +000050 DBuilder(CGM.getModule()) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000051 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
52 DebugPrefixMap[KV.first] = KV.second;
Guy Benyei11169dd2012-12-18 14:30:41 +000053 CreateCompileUnit();
54}
55
56CGDebugInfo::~CGDebugInfo() {
57 assert(LexicalBlockStack.empty() &&
58 "Region stack mismatch, stack not empty!");
59}
60
David Blaikie66e41972015-01-14 07:38:27 +000061ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
David Blaikie835afb22015-01-21 23:08:17 +000062 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000063 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +000064 init(TemporaryLocation);
65}
66
Adrian Prantl39428e72015-02-03 18:40:42 +000067ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000068 bool DefaultToEmpty,
Adrian Prantl39428e72015-02-03 18:40:42 +000069 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000070 : CGF(&CGF) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000071 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000072}
73
74void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Adrian Prantl95b24e92015-02-03 20:00:54 +000075 bool DefaultToEmpty) {
David Blaikied7057d92015-08-12 23:49:57 +000076 auto *DI = CGF->getDebugInfo();
77 if (!DI) {
78 CGF = nullptr;
79 return;
David Blaikie66e41972015-01-14 07:38:27 +000080 }
David Blaikied7057d92015-08-12 23:49:57 +000081
82 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
83 if (TemporaryLocation.isValid()) {
84 DI->EmitLocation(CGF->Builder, TemporaryLocation);
85 return;
86 }
87
88 if (DefaultToEmpty) {
89 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
90 return;
91 }
92
93 // Construct a location that has a valid scope, but no line info.
94 assert(!DI->LexicalBlockStack.empty());
95 CGF->Builder.SetCurrentDebugLocation(
96 llvm::DebugLoc::get(0, 0, DI->LexicalBlockStack.back()));
Adrian Prantl2e0637f2013-07-18 00:28:02 +000097}
98
David Blaikie9b479662015-01-25 01:19:10 +000099ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
David Blaikied7057d92015-08-12 23:49:57 +0000100 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +0000101 init(E->getExprLoc());
102}
103
David Blaikie66e41972015-01-14 07:38:27 +0000104ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
David Blaikied7057d92015-08-12 23:49:57 +0000105 : CGF(&CGF) {
106 if (!CGF.getDebugInfo()) {
107 this->CGF = nullptr;
108 return;
David Blaikie66e41972015-01-14 07:38:27 +0000109 }
David Blaikied7057d92015-08-12 23:49:57 +0000110 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
111 if (Loc)
112 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +0000113}
114
115ApplyDebugLocation::~ApplyDebugLocation() {
116 // Query CGF so the location isn't overwritten when location updates are
117 // temporarily disabled (for C++ default function arguments)
David Blaikied7057d92015-08-12 23:49:57 +0000118 if (CGF)
119 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000120}
121
Guy Benyei11169dd2012-12-18 14:30:41 +0000122void CGDebugInfo::setLocation(SourceLocation Loc) {
123 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000124 if (Loc.isInvalid())
125 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000126
127 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
128
129 // If we've changed files in the middle of a lexical scope go ahead
130 // and create a new lexical scope with file node if it's different
131 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000132 if (LexicalBlockStack.empty())
133 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000134
135 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000136 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000137 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000138
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000139 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000140 return;
141
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000142 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000143 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000144 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
145 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000146 } else if (isa<llvm::DILexicalBlock>(Scope) ||
147 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000148 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000149 LexicalBlockStack.emplace_back(
150 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000151 }
152}
153
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000154llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000155 llvm::DIScope *Mod = getParentModuleOrNull(D);
156 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
157 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000158}
159
160llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
161 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000162 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000163 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000164
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000165 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000166 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000167 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000168 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000169 }
170
171 // Check namespace.
David Majnemer58ed0f32016-07-17 00:39:12 +0000172 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000173 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000174
David Majnemer58ed0f32016-07-17 00:39:12 +0000175 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000176 if (!RDecl->isDependentType())
177 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000178 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000179 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000180}
181
Guy Benyei11169dd2012-12-18 14:30:41 +0000182StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000183 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000184 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000185 FunctionTemplateSpecializationInfo *Info =
186 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000187
Reid Kleckner31abd802016-06-30 17:41:31 +0000188 // Emit the unqualified name in normal operation. LLVM and the debugger can
189 // compute the fully qualified name from the scope chain. If we're only
190 // emitting line table info, there won't be any scope chains, so emit the
191 // fully qualified name here so that stack traces are more accurate.
192 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
193 // evaluating the size impact.
194 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
195 CGM.getCodeGenOpts().EmitCodeView;
196
197 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000198 return FII->getName();
199
Benjamin Kramer9170e912013-02-22 15:46:01 +0000200 SmallString<128> NS;
201 llvm::raw_svector_ostream OS(NS);
Reid Kleckner60103382015-12-16 02:04:40 +0000202 PrintingPolicy Policy(CGM.getLangOpts());
Reid Kleckner829398e2016-06-17 16:11:20 +0000203 Policy.MSVCFormatting = CGM.getCodeGenOpts().EmitCodeView;
Reid Kleckner31abd802016-06-30 17:41:31 +0000204 if (!UseQualifiedName)
205 FD->printName(OS);
206 else
207 FD->printQualifiedName(OS, Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000208
Reid Kleckner829398e2016-06-17 16:11:20 +0000209 // Add any template specialization args.
210 if (Info) {
211 const TemplateArgumentList *TArgs = Info->TemplateArguments;
David Majnemer6fbeee32016-07-07 04:43:07 +0000212 TemplateSpecializationType::PrintTemplateArgumentList(OS, TArgs->asArray(),
Reid Kleckner829398e2016-06-17 16:11:20 +0000213 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000214 }
215
216 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000217 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000218}
219
220StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
221 SmallString<256> MethodName;
222 llvm::raw_svector_ostream OS(MethodName);
223 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
224 const DeclContext *DC = OMD->getDeclContext();
David Majnemer58ed0f32016-07-17 00:39:12 +0000225 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000226 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000227 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000228 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000229 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000230 if (OC->IsClassExtension()) {
231 OS << OC->getClassInterface()->getName();
232 } else {
David Majnemer58ed0f32016-07-17 00:39:12 +0000233 OS << OC->getIdentifier()->getNameStart() << '('
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000234 << OC->getIdentifier()->getNameStart() << ')';
235 }
David Majnemer58ed0f32016-07-17 00:39:12 +0000236 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000237 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
238 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000239 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000240 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000241 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000242 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000243 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000244 ClassTy.print(OS, PrintingPolicy(LangOptions()));
245 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000246 }
247 OS << ' ' << OMD->getSelector().getAsString() << ']';
248
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000249 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000250}
251
Guy Benyei11169dd2012-12-18 14:30:41 +0000252StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000253 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000254}
255
Eric Christophere7b87e52014-10-26 23:40:33 +0000256StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000257 if (isa<ClassTemplateSpecializationDecl>(RD)) {
258 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000259 llvm::raw_svector_ostream OS(Name);
260 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
261 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000262
263 // Copy this name on the side and use its reference.
264 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000265 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000266
David Majnemerbc5976a2016-07-01 23:12:54 +0000267 // quick optimization to avoid having to intern strings that are already
268 // stored reliably elsewhere
269 if (const IdentifierInfo *II = RD->getIdentifier())
270 return II->getName();
271
272 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
273 // used to reconstruct the fully qualified type names.
274 if (CGM.getCodeGenOpts().EmitCodeView) {
275 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
276 assert(RD->getDeclContext() == D->getDeclContext() &&
277 "Typedef should not be in another decl context!");
278 assert(D->getDeclName().getAsIdentifierInfo() &&
279 "Typedef was not named!");
280 return D->getDeclName().getAsIdentifierInfo()->getName();
281 }
282
283 if (CGM.getLangOpts().CPlusPlus) {
284 StringRef Name;
285
286 ASTContext &Context = CGM.getContext();
287 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
288 // Anonymous types without a name for linkage purposes have their
289 // declarator mangled in if they have one.
290 Name = DD->getName();
291 else if (const TypedefNameDecl *TND =
292 Context.getTypedefNameForUnnamedTagDecl(RD))
293 // Anonymous types without a name for linkage purposes have their
294 // associate typedef mangled in if they have one.
295 Name = TND->getName();
296
297 if (!Name.empty()) {
298 SmallString<256> UnnamedType("<unnamed-type-");
299 UnnamedType += Name;
300 UnnamedType += '>';
301 return internString(UnnamedType);
302 }
303 }
304 }
305
306 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000307}
308
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000309llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000310 if (!Loc.isValid())
311 // If Location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000312 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
313 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000314
315 SourceManager &SM = CGM.getContext().getSourceManager();
316 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
317
318 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
319 // If the location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000320 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
321 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000322
323 // Cache the results.
324 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000325 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000326
327 if (it != DIFileCache.end()) {
328 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000329 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000330 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000331 }
332
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000333 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
334 remapDIPath(getCurrentDirname()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000335
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000336 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000337 return F;
338}
339
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000340llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000341 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
342 remapDIPath(TheCU->getDirectory()));
343}
344
345std::string CGDebugInfo::remapDIPath(StringRef Path) const {
346 for (const auto &Entry : DebugPrefixMap)
347 if (Path.startswith(Entry.first))
348 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
349 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000350}
351
Guy Benyei11169dd2012-12-18 14:30:41 +0000352unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
353 if (Loc.isInvalid() && CurLoc.isInvalid())
354 return 0;
355 SourceManager &SM = CGM.getContext().getSourceManager();
356 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000357 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000358}
359
Adrian Prantlc7822422013-03-12 20:43:25 +0000360unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000361 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000362 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000363 return 0;
364
365 // If the location is invalid then use the current column.
366 if (Loc.isInvalid() && CurLoc.isInvalid())
367 return 0;
368 SourceManager &SM = CGM.getContext().getSourceManager();
369 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000370 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000371}
372
373StringRef CGDebugInfo::getCurrentDirname() {
374 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
375 return CGM.getCodeGenOpts().DebugCompilationDir;
376
377 if (!CWDName.empty())
378 return CWDName;
379 SmallString<256> CWD;
380 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000381 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000382}
383
Guy Benyei11169dd2012-12-18 14:30:41 +0000384void CGDebugInfo::CreateCompileUnit() {
385
David Blaikieaabde052014-05-14 00:29:00 +0000386 // Should we be asking the SourceManager for the main file name, instead of
387 // accepting it as an argument? This just causes the main file name to
388 // mismatch with source locations and create extra lexical scopes or
389 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
390 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
391 // because that's what the SourceManager says)
392
Guy Benyei11169dd2012-12-18 14:30:41 +0000393 // Get absolute path name.
394 SourceManager &SM = CGM.getContext().getSourceManager();
395 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
396 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000397 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000398
399 // The main file name provided via the "-main-file-name" option contains just
400 // the file name itself with no path information. This file name may have had
401 // a relative path, so we look into the actual file entry for the main
402 // file to determine the real absolute path for the file.
403 std::string MainFileDir;
404 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000405 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000406 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000407 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
408 llvm::sys::path::append(MainFileDirSS, MainFileName);
409 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000410 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000411 }
412
Ed Masteda706022014-05-07 12:49:30 +0000413 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000414 const LangOptions &LO = CGM.getLangOpts();
415 if (LO.CPlusPlus) {
416 if (LO.ObjC1)
417 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
418 else
419 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
420 } else if (LO.ObjC1) {
421 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000422 } else if (LO.RenderScript) {
423 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000424 } else if (LO.C99) {
425 LangTag = llvm::dwarf::DW_LANG_C99;
426 } else {
427 LangTag = llvm::dwarf::DW_LANG_C89;
428 }
429
430 std::string Producer = getClangFullVersion();
431
432 // Figure out which version of the ObjC runtime we have.
433 unsigned RuntimeVers = 0;
434 if (LO.ObjC1)
435 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
436
Adrian Prantl826824e2016-04-08 22:43:06 +0000437 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
438 switch (DebugKind) {
439 case codegenoptions::NoDebugInfo:
440 case codegenoptions::LocTrackingOnly:
441 EmissionKind = llvm::DICompileUnit::NoDebug;
442 break;
443 case codegenoptions::DebugLineTablesOnly:
444 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
445 break;
446 case codegenoptions::LimitedDebugInfo:
447 case codegenoptions::FullDebugInfo:
448 EmissionKind = llvm::DICompileUnit::FullDebug;
449 break;
450 }
451
Guy Benyei11169dd2012-12-18 14:30:41 +0000452 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000453 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000454 TheCU = DBuilder.createCompileUnit(
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000455 LangTag, remapDIPath(MainFileName), remapDIPath(getCurrentDirname()),
456 Producer, LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers,
David Blaikiea45c31a2016-08-24 18:29:58 +0000457 CGM.getCodeGenOpts().SplitDwarfFile, EmissionKind, 0 /* DWOid */,
458 CGM.getCodeGenOpts().SplitDwarfInlining);
Guy Benyei11169dd2012-12-18 14:30:41 +0000459}
460
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000461llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000462 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 StringRef BTName;
464 switch (BT->getKind()) {
465#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000466#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000467#include "clang/AST/BuiltinTypes.def"
468 case BuiltinType::Dependent:
469 llvm_unreachable("Unexpected builtin type");
470 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000471 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000472 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000473 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000474 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000475 if (!ClassTy)
476 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
477 "objc_class", TheCU,
478 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000479 return ClassTy;
480 case BuiltinType::ObjCId: {
481 // typedef struct objc_class *Class;
482 // typedef struct objc_object {
483 // Class isa;
484 // } *id;
485
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000486 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000487 return ObjTy;
488
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000489 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000490 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
491 "objc_class", TheCU,
492 getOrCreateMainFile(), 0);
493
494 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000495
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000496 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000497
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000498 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000499 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000500 0, 0, 0, 0, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000501
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000502 DBuilder.replaceArrays(
503 ObjTy,
504 DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
505 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000506 return ObjTy;
507 }
508 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000509 if (!SelTy)
510 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
511 "objc_selector", TheCU,
512 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000513 return SelTy;
514 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000515
Alexey Bader954ba212016-04-08 13:40:33 +0000516#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
517 case BuiltinType::Id: \
518 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
519 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000520#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000521 case BuiltinType::OCLSampler:
Yaxun Liu0bc4b2d2016-07-28 19:26:30 +0000522 return getOrCreateStructPtrType("opencl_sampler_t",
523 OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000524 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000525 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000526 case BuiltinType::OCLClkEvent:
527 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
528 case BuiltinType::OCLQueue:
529 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
530 case BuiltinType::OCLNDRange:
531 return getOrCreateStructPtrType("opencl_ndrange_t", OCLNDRangeDITy);
532 case BuiltinType::OCLReserveID:
533 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000534
Guy Benyei11169dd2012-12-18 14:30:41 +0000535 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000536 case BuiltinType::Char_U:
537 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
538 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000539 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000540 case BuiltinType::SChar:
541 Encoding = llvm::dwarf::DW_ATE_signed_char;
542 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000543 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000544 case BuiltinType::Char32:
545 Encoding = llvm::dwarf::DW_ATE_UTF;
546 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000547 case BuiltinType::UShort:
548 case BuiltinType::UInt:
549 case BuiltinType::UInt128:
550 case BuiltinType::ULong:
551 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000552 case BuiltinType::ULongLong:
553 Encoding = llvm::dwarf::DW_ATE_unsigned;
554 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000555 case BuiltinType::Short:
556 case BuiltinType::Int:
557 case BuiltinType::Int128:
558 case BuiltinType::Long:
559 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000560 case BuiltinType::LongLong:
561 Encoding = llvm::dwarf::DW_ATE_signed;
562 break;
563 case BuiltinType::Bool:
564 Encoding = llvm::dwarf::DW_ATE_boolean;
565 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000566 case BuiltinType::Half:
567 case BuiltinType::Float:
568 case BuiltinType::LongDouble:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000569 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000570 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000571 // FIXME: For targets where long double and __float128 have the same size,
572 // they are currently indistinguishable in the debugger without some
573 // special treatment. However, there is currently no consensus on encoding
574 // and this should be updated once a DWARF encoding exists for distinct
575 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000576 Encoding = llvm::dwarf::DW_ATE_float;
577 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000578 }
579
580 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000581 case BuiltinType::Long:
582 BTName = "long int";
583 break;
584 case BuiltinType::LongLong:
585 BTName = "long long int";
586 break;
587 case BuiltinType::ULong:
588 BTName = "long unsigned int";
589 break;
590 case BuiltinType::ULongLong:
591 BTName = "long long unsigned int";
592 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000593 default:
594 BTName = BT->getName(CGM.getLangOpts());
595 break;
596 }
597 // Bit size, align and offset of the type.
598 uint64_t Size = CGM.getContext().getTypeSize(BT);
599 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000600 return DBuilder.createBasicType(BTName, Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000601}
602
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000603llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000604 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000605 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000606 if (Ty->isComplexIntegerType())
607 Encoding = llvm::dwarf::DW_ATE_lo_user;
608
609 uint64_t Size = CGM.getContext().getTypeSize(Ty);
610 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000611 return DBuilder.createBasicType("complex", Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000612}
613
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000614llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
615 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000616 QualifierCollector Qc;
617 const Type *T = Qc.strip(Ty);
618
619 // Ignore these qualifiers for now.
620 Qc.removeObjCGCAttr();
621 Qc.removeAddressSpace();
622 Qc.removeObjCLifetime();
623
624 // We will create one Derived type for one qualifier and recurse to handle any
625 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000626 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000627 if (Qc.hasConst()) {
628 Tag = llvm::dwarf::DW_TAG_const_type;
629 Qc.removeConst();
630 } else if (Qc.hasVolatile()) {
631 Tag = llvm::dwarf::DW_TAG_volatile_type;
632 Qc.removeVolatile();
633 } else if (Qc.hasRestrict()) {
634 Tag = llvm::dwarf::DW_TAG_restrict_type;
635 Qc.removeRestrict();
636 } else {
637 assert(Qc.empty() && "Unknown type qualifier for debug info");
638 return getOrCreateType(QualType(T, 0), Unit);
639 }
640
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000641 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000642
643 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
644 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000645 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000646}
647
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000648llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
649 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000650
651 // The frontend treats 'id' as a typedef to an ObjCObjectType,
652 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
653 // debug info, we want to emit 'id' in both cases.
654 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000655 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000656
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000657 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
658 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000659}
660
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000661llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
662 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000663 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000664 Ty->getPointeeType(), Unit);
665}
666
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000667/// \return whether a C++ mangling exists for the type defined by TD.
668static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
669 switch (TheCU->getSourceLanguage()) {
670 case llvm::dwarf::DW_LANG_C_plus_plus:
671 return true;
672 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
673 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
674 default:
675 return false;
676 }
677}
678
Manman Rene0064d82013-08-29 23:19:58 +0000679/// In C++ mode, types have linkage, so we can rely on the ODR and
680/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000681static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
682 CodeGenModule &CGM,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000683 llvm::DICompileUnit *TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000684 SmallString<256> FullName;
Manman Rene0064d82013-08-29 23:19:58 +0000685 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000686
687 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
Manman Rene0064d82013-08-29 23:19:58 +0000688 return FullName;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000689
Manman Rene0064d82013-08-29 23:19:58 +0000690 // TODO: This is using the RTTI name. Is there a better way to get
691 // a unique string for a type?
692 llvm::raw_svector_ostream Out(FullName);
693 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Manman Rene0064d82013-08-29 23:19:58 +0000694 return FullName;
695}
696
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000697/// \return the approproate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000698static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
699 llvm::dwarf::Tag Tag;
700 if (RD->isStruct() || RD->isInterface())
701 Tag = llvm::dwarf::DW_TAG_structure_type;
702 else if (RD->isUnion())
703 Tag = llvm::dwarf::DW_TAG_union_type;
704 else {
705 // FIXME: This could be a struct type giving a default visibility different
706 // than C++ class type, but needs llvm metadata changes first.
707 assert(RD->isClass());
708 Tag = llvm::dwarf::DW_TAG_class_type;
709 }
710 return Tag;
711}
712
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000713llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000714CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000715 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000716 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000717 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
718 return cast<llvm::DICompositeType>(T);
719 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000720 unsigned Line = getLineNumber(RD->getLocation());
721 StringRef RDName = getClassName(RD);
722
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000723 uint64_t Size = 0;
724 uint64_t Align = 0;
725
726 const RecordDecl *D = RD->getDefinition();
727 if (D && D->isCompleteDefinition()) {
728 Size = CGM.getContext().getTypeSize(Ty);
729 Align = CGM.getContext().getTypeAlign(Ty);
730 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000731
732 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000733 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000734 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000735 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000736 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000737 ReplaceMap.emplace_back(
738 std::piecewise_construct, std::make_tuple(Ty),
739 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000740 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000741}
742
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000743llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000744 const Type *Ty,
745 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000746 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000747 // Bit size, align and offset of the type.
748 // Size is always the size of a pointer. We can't use getTypeSize here
749 // because that does not return the correct value for references.
750 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000751 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000752 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
753
Keno Fischer87842f32015-11-16 09:04:13 +0000754 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
755 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
756 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
757 Size, Align);
758 else
759 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
760 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000761}
762
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000763llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
764 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000765 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000766 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000767 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
768 TheCU, getOrCreateMainFile(), 0);
769 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
770 Cache = DBuilder.createPointerType(Cache, Size);
771 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000772}
773
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000774llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
775 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000776 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000777 QualType FType;
778 uint64_t FieldSize, FieldOffset;
779 unsigned FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000780 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000781
782 FieldOffset = 0;
783 FType = CGM.getContext().UnsignedLongTy;
784 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
785 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
786
787 Elements = DBuilder.getOrCreateArray(EltTys);
788 EltTys.clear();
789
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000790 unsigned Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000791 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000792
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000793 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000794 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000795 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000796
797 // Bit size, align and offset of the type.
798 uint64_t Size = CGM.getContext().getTypeSize(Ty);
799
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000800 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000801
802 FieldOffset = 0;
803 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
804 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
805 FType = CGM.getContext().IntTy;
806 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
807 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000808 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000809 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
810
811 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000812 FieldSize = CGM.getContext().getTypeSize(Ty);
813 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Adrian Prantl498fff62015-07-06 21:31:35 +0000814 EltTys.push_back(DBuilder.createMemberType(Unit, "__descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000815 FieldSize, FieldAlign, FieldOffset,
816 0, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000817
818 FieldOffset += FieldSize;
819 Elements = DBuilder.getOrCreateArray(EltTys);
820
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000821 // The __block_literal_generic structs are marked with a special
822 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
823 // the debugger needs to know about. To allow type uniquing, emit
824 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000825 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000826 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000827 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000828
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000829 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000830}
831
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000832llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
833 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000834 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000835 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000836
837 SmallString<128> NS;
838 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000839 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
840 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000841
842 TemplateSpecializationType::PrintTemplateArgumentList(
David Majnemer6fbeee32016-07-07 04:43:07 +0000843 OS, Ty->template_arguments(),
David Blaikief1b382e2014-04-06 17:14:06 +0000844 CGM.getContext().getPrintingPolicy());
845
David Majnemer58ed0f32016-07-17 00:39:12 +0000846 auto *AliasDecl = cast<TypeAliasTemplateDecl>(
Eric Christophere7b87e52014-10-26 23:40:33 +0000847 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000848
849 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000850 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
851 getLineNumber(Loc),
852 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000853}
854
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000855llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
856 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000857 // We don't set size information, but do specify where the typedef was
858 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +0000859 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000860
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000861 // Typedefs are derived from some other type.
862 return DBuilder.createTypedef(
863 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
864 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +0000865 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000866}
867
Reid Klecknerf00f8032016-06-08 20:41:54 +0000868static unsigned getDwarfCC(CallingConv CC) {
869 switch (CC) {
870 case CC_C:
871 // Avoid emitting DW_AT_calling_convention if the C convention was used.
872 return 0;
873
874 case CC_X86StdCall:
875 return llvm::dwarf::DW_CC_BORLAND_stdcall;
876 case CC_X86FastCall:
877 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
878 case CC_X86ThisCall:
879 return llvm::dwarf::DW_CC_BORLAND_thiscall;
880 case CC_X86VectorCall:
881 return llvm::dwarf::DW_CC_LLVM_vectorcall;
882 case CC_X86Pascal:
883 return llvm::dwarf::DW_CC_BORLAND_pascal;
884
885 // FIXME: Create new DW_CC_ codes for these calling conventions.
886 case CC_X86_64Win64:
887 case CC_X86_64SysV:
888 case CC_AAPCS:
889 case CC_AAPCS_VFP:
890 case CC_IntelOclBicc:
891 case CC_SpirFunction:
Nikolay Haustov8c6538b2016-06-30 09:06:33 +0000892 case CC_OpenCLKernel:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000893 case CC_Swift:
894 case CC_PreserveMost:
895 case CC_PreserveAll:
896 return 0;
897 }
898 return 0;
899}
900
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000901llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
902 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000903 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000904
905 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000906 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000907
908 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000909 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000910 if (isa<FunctionNoProtoType>(Ty))
911 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +0000912 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
913 for (const QualType &ParamType : FPT->param_types())
914 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000915 if (FPT->isVariadic())
916 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000917 }
918
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000919 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Reid Klecknerf00f8032016-06-08 20:41:54 +0000920 return DBuilder.createSubroutineType(EltTypeArray, 0,
921 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000922}
923
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000924/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000925/// As an optimization, return 0 if the access specifier equals the
926/// default for the containing type.
927static unsigned getAccessFlag(AccessSpecifier Access, const RecordDecl *RD) {
928 AccessSpecifier Default = clang::AS_none;
929 if (RD && RD->isClass())
930 Default = clang::AS_private;
931 else if (RD && (RD->isStruct() || RD->isUnion()))
932 Default = clang::AS_public;
933
934 if (Access == Default)
935 return 0;
936
Eric Christophere7b87e52014-10-26 23:40:33 +0000937 switch (Access) {
938 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000939 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +0000940 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000941 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +0000942 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000943 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +0000944 case clang::AS_none:
945 return 0;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000946 }
947 llvm_unreachable("unexpected access enumerator");
948}
Guy Benyei11169dd2012-12-18 14:30:41 +0000949
David Majnemerb4b671e2016-06-30 03:01:59 +0000950llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
951 llvm::DIScope *RecordTy,
952 const RecordDecl *RD) {
953 StringRef Name = BitFieldDecl->getName();
954 QualType Ty = BitFieldDecl->getType();
955 SourceLocation Loc = BitFieldDecl->getLocation();
956 llvm::DIFile *VUnit = getOrCreateFile(Loc);
957 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
958
959 // Get the location for the field.
960 llvm::DIFile *File = getOrCreateFile(Loc);
961 unsigned Line = getLineNumber(Loc);
962
963 const CGBitFieldInfo &BitFieldInfo =
964 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
965 uint64_t SizeInBits = BitFieldInfo.Size;
966 assert(SizeInBits > 0 && "found named 0-width bitfield");
967 unsigned AlignInBits = CGM.getContext().getTypeAlign(Ty);
968 uint64_t StorageOffsetInBits =
969 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
970 uint64_t OffsetInBits = StorageOffsetInBits + BitFieldInfo.Offset;
971 unsigned Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
972 return DBuilder.createBitFieldMemberType(
973 RecordTy, Name, File, Line, SizeInBits, AlignInBits, OffsetInBits,
974 StorageOffsetInBits, Flags, DebugType);
975}
976
977llvm::DIType *
978CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
979 AccessSpecifier AS, uint64_t offsetInBits,
980 llvm::DIFile *tunit, llvm::DIScope *scope,
981 const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000982 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000983
984 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000985 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000986 unsigned line = getLineNumber(loc);
987
David Majnemer34b57492014-07-30 01:30:47 +0000988 uint64_t SizeInBits = 0;
989 unsigned AlignInBits = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000990 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +0000991 TypeInfo TI = CGM.getContext().getTypeInfo(type);
992 SizeInBits = TI.Width;
993 AlignInBits = TI.Align;
Guy Benyei11169dd2012-12-18 14:30:41 +0000994 }
995
Adrian Prantl21361fb2014-08-29 22:44:27 +0000996 unsigned flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +0000997 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
998 AlignInBits, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +0000999}
1000
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001001void CGDebugInfo::CollectRecordLambdaFields(
1002 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001003 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001004 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1005 // has the name and the location of the variable so we should iterate over
1006 // both concurrently.
1007 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1008 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1009 unsigned fieldno = 0;
1010 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001011 E = CXXDecl->captures_end();
1012 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001013 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001014 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001015 SourceLocation Loc = C.getLocation();
1016 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001017 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001018 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001019 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1020 llvm::DIType *FieldType = createFieldType(
1021 VName, Field->getType(), Loc, Field->getAccess(),
1022 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1023 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001024 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001025 // TODO: Need to handle 'this' in some way by probably renaming the
1026 // this of the lambda class and having a field member of 'this' or
1027 // by using AT_object_pointer for the function and having that be
1028 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001029 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001030 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001031 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001032 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001033 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001034 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001035
1036 elements.push_back(fieldType);
1037 }
1038 }
1039}
1040
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001041llvm::DIDerivedType *
1042CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001043 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001044 // Create the descriptor for the static variable, with or without
1045 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001046 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001047 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1048 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001049
Eric Christopher91a31902013-01-16 01:22:32 +00001050 unsigned LineNumber = getLineNumber(Var->getLocation());
1051 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001052 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001053 if (Var->getInit()) {
1054 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001055 if (Value) {
1056 if (Value->isInt())
1057 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1058 if (Value->isFloat())
1059 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1060 }
Eric Christopher91a31902013-01-16 01:22:32 +00001061 }
1062
Adrian Prantl21361fb2014-08-29 22:44:27 +00001063 unsigned Flags = getAccessFlag(Var->getAccess(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001064 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
David Blaikieae019462013-08-15 22:50:29 +00001065 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001066 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001067 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001068}
1069
Eric Christophere7b87e52014-10-26 23:40:33 +00001070void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001071 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1072 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001073 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001074 StringRef name = field->getName();
1075 QualType type = field->getType();
1076
1077 // Ignore unnamed fields unless they're anonymous structs/unions.
1078 if (name.empty() && !type->isRecordType())
1079 return;
1080
David Majnemerb4b671e2016-06-30 03:01:59 +00001081 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001082 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001083 FieldType = createBitFieldType(field, RecordTy, RD);
1084 } else {
1085 FieldType =
1086 createFieldType(name, type, field->getLocation(), field->getAccess(),
1087 OffsetInBits, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001088 }
1089
David Majnemerb4b671e2016-06-30 03:01:59 +00001090 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001091}
1092
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001093void CGDebugInfo::CollectRecordNestedRecord(
1094 const RecordDecl *RD, SmallVectorImpl<llvm::Metadata *> &elements) {
1095 QualType Ty = CGM.getContext().getTypeDeclType(RD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001096 // Injected class names are not considered nested records.
1097 if (isa<InjectedClassNameType>(Ty))
1098 return;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001099 SourceLocation Loc = RD->getLocation();
1100 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1101 elements.push_back(nestedType);
1102}
1103
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001104void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001105 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001106 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001107 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001108 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001109
Eric Christopher91a31902013-01-16 01:22:32 +00001110 if (CXXDecl && CXXDecl->isLambda())
1111 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1112 else {
1113 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001114
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001115 // Debug info for nested records is included in the member list only for
1116 // CodeView.
1117 bool IncludeNestedRecords = CGM.getCodeGenOpts().EmitCodeView;
1118
Eric Christopher91a31902013-01-16 01:22:32 +00001119 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001120 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001121
Eric Christopher91a31902013-01-16 01:22:32 +00001122 // Static and non-static members should appear in the same order as
1123 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001124 for (const auto *I : record->decls())
1125 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001126 if (V->hasAttr<NoDebugAttr>())
1127 continue;
David Blaikiece763042013-08-20 21:49:21 +00001128 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001129 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001130 if (MI != StaticDataMemberCache.end()) {
1131 assert(MI->second &&
1132 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001133 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001134 } else {
1135 auto Field = CreateRecordStaticField(V, RecordTy, record);
1136 elements.push_back(Field);
1137 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001138 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001139 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1140 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001141
1142 // Bump field number for next field.
1143 ++fieldNo;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001144 } else if (const auto *nestedRec = dyn_cast<CXXRecordDecl>(I))
1145 if (IncludeNestedRecords && !nestedRec->isImplicit() &&
1146 nestedRec->getDeclContext() == record)
1147 CollectRecordNestedRecord(nestedRec, elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001148 }
1149}
1150
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001151llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001152CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001153 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001154 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001155 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001156 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001157 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001158 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1159 Func, Unit);
1160}
David Blaikie2aaf0652013-01-07 22:24:59 +00001161
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001162llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1163 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001164 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001165 llvm::DITypeRefArray Args(
1166 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001167 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001168 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001169
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001170 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001171
1172 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001173 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001174
David Blaikie2aaf0652013-01-07 22:24:59 +00001175 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001176 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001177 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1178 // Create pointer type directly in this case.
1179 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1180 QualType PointeeTy = ThisPtrTy->getPointeeType();
1181 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001182 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001183 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001184 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1185 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001186 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001187 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001188 // TODO: This and the artificial type below are misleading, the
1189 // types aren't artificial the argument is, but the current
1190 // metadata doesn't represent that.
1191 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1192 Elts.push_back(ThisPtrType);
1193 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001194 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001195 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001196 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1197 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001198 }
1199
1200 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001201 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1202 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001203
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001204 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001205
Adrian Prantl0630eb72013-12-18 21:48:18 +00001206 unsigned Flags = 0;
1207 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001208 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001209 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001210 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001211
Reid Klecknerf00f8032016-06-08 20:41:54 +00001212 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1213 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001214}
1215
Eric Christopherb2a008c2013-05-16 00:45:12 +00001216/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001217/// inside a function.
1218static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001219 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001220 return isFunctionLocalClass(NRD);
1221 if (isa<FunctionDecl>(RD->getDeclContext()))
1222 return true;
1223 return false;
1224}
1225
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001226llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1227 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001228 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001229 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001230
Guy Benyei11169dd2012-12-18 14:30:41 +00001231 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001232 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001233
1234 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1235 // make sense to give a single ctor/dtor a linkage name.
1236 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001237 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1238 // property to use here. It may've been intended to model "is non-external
1239 // type" but misses cases of non-function-local but non-external classes such
1240 // as those in anonymous namespaces as well as the reverse - external types
1241 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001242 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1243 MethodLinkageName = CGM.getMangledName(Method);
1244
1245 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001246 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001247 unsigned MethodLine = 0;
1248 if (!Method->isImplicit()) {
1249 MethodDefUnit = getOrCreateFile(Method->getLocation());
1250 MethodLine = getLineNumber(Method->getLocation());
1251 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001252
1253 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001254 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001255 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001256 unsigned VIndex = 0;
Reid Klecknerfb727182016-06-17 22:27:59 +00001257 unsigned Flags = 0;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001258 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001259
Guy Benyei11169dd2012-12-18 14:30:41 +00001260 if (Method->isVirtual()) {
1261 if (Method->isPure())
1262 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1263 else
1264 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001265
Reid Kleckner216d0a12016-06-16 20:08:51 +00001266 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1267 // It doesn't make sense to give a virtual destructor a vtable index,
1268 // since a single destructor has two entries in the vtable.
1269 if (!isa<CXXDestructorDecl>(Method))
1270 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1271 } else {
1272 // Emit MS ABI vftable information. There is only one entry for the
1273 // deleting dtor.
1274 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1275 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1276 MicrosoftVTableContext::MethodVFTableLocation ML =
1277 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1278 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001279
1280 // CodeView only records the vftable offset in the class that introduces
1281 // the virtual method. This is possible because, unlike Itanium, the MS
1282 // C++ ABI does not include all virtual methods from non-primary bases in
1283 // the vtable for the most derived class. For example, if C inherits from
1284 // A and B, C's primary vftable will not include B's virtual methods.
1285 if (Method->begin_overridden_methods() == Method->end_overridden_methods())
1286 Flags |= llvm::DINode::FlagIntroducedVirtual;
1287
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001288 // The 'this' adjustment accounts for both the virtual and non-virtual
1289 // portions of the adjustment. Presumably the debugger only uses it when
1290 // it knows the dynamic type of an object.
1291 ThisAdjustment = CGM.getCXXABI()
1292 .getVirtualFunctionPrologueThisAdjustment(GD)
1293 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001294 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001295 ContainingType = RecordTy;
1296 }
1297
Guy Benyei11169dd2012-12-18 14:30:41 +00001298 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001299 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001300 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001301 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001302 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001303 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001304 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001305 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001306 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001307 }
1308 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001309 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001310 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001311 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001312 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001313 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001314
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001315 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1316 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001317 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001318 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1319 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1320 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001321
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001322 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001323
1324 return SP;
1325}
1326
Eric Christophere7b87e52014-10-26 23:40:33 +00001327void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001328 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1329 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001330
1331 // Since we want more than just the individual member decls if we
1332 // have templated functions iterate over every declaration to gather
1333 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001334 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001335 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1336 // If the member is implicit, don't add it to the member list. This avoids
1337 // the member being added to type units by LLVM, while still allowing it
1338 // to be emitted into the type declaration/reference inside the compile
1339 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001340 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001341 // FIXME: Handle Using(Shadow?)Decls here to create
1342 // DW_TAG_imported_declarations inside the class for base decls brought into
1343 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1344 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1345 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001346 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001347 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001348
1349 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1350 continue;
1351
David Blaikiefd580722014-10-06 05:18:55 +00001352 // Reuse the existing member function declaration if it exists.
1353 // It may be associated with the declaration of the type & should be
1354 // reused as we're building the definition.
1355 //
1356 // This situation can arise in the vtable-based debug info reduction where
1357 // implicit members are emitted in a non-vtable TU.
1358 auto MI = SPCache.find(Method->getCanonicalDecl());
1359 EltTys.push_back(MI == SPCache.end()
1360 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001361 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001362 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001363}
Guy Benyei11169dd2012-12-18 14:30:41 +00001364
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001365void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001366 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001367 llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001368 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001369 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001370 unsigned BFlags = 0;
1371 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001372
David Majnemer58ed0f32016-07-17 00:39:12 +00001373 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001374 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001375
Aaron Ballman574705e2014-03-13 15:41:46 +00001376 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001377 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1378 // virtual base offset offset is -ve. The code generator emits dwarf
1379 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001380 BaseOffset = 0 - CGM.getItaniumVTableContext()
1381 .getVirtualBaseOffsetOffset(RD, Base)
1382 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001383 } else {
1384 // In the MS ABI, store the vbtable offset, which is analogous to the
1385 // vbase offset offset in Itanium.
1386 BaseOffset =
1387 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1388 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001389 BFlags = llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001390 } else
1391 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1392 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1393 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001394
Adrian Prantl21361fb2014-08-29 22:44:27 +00001395 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001396 llvm::DIType *DTy = DBuilder.createInheritance(
Eric Christophere7b87e52014-10-26 23:40:33 +00001397 RecordTy, getOrCreateType(BI.getType(), Unit), BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001398 EltTys.push_back(DTy);
1399 }
1400}
1401
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001402llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001403CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1404 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001405 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001406 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001407 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1408 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001409 StringRef Name;
1410 if (TPList)
1411 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001412 switch (TA.getKind()) {
1413 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001414 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001415 TemplateParams.push_back(
1416 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001417 } break;
1418 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001419 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001420 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1421 TheCU, Name, TTy,
1422 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001423 } break;
1424 case TemplateArgument::Declaration: {
1425 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001426 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001427 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001428 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001429 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001430 // Variable pointer template parameters have a value that is the address
1431 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001432 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001433 V = CGM.GetAddrOfGlobalVar(VD);
1434 // Member function pointers have special support for building them, though
1435 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001436 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001437 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001438 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001439 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001440 // Member data pointers have special handling too to compute the fixed
1441 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001442 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001443 // These five lines (& possibly the above member function pointer
1444 // handling) might be able to be refactored to use similar code in
1445 // CodeGenModule::getMemberPointerConstant
1446 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1447 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001448 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001449 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001450 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001451 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1452 TheCU, Name, TTy,
1453 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001454 } break;
1455 case TemplateArgument::NullPtr: {
1456 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001457 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001458 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001459 // Special case member data pointer null values since they're actually -1
1460 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001461 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001462 // But treat member function pointers as simple zero integers because
1463 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1464 // CodeGen grows handling for values of non-null member function
1465 // pointers then perhaps we could remove this special case and rely on
1466 // EmitNullMemberPointer for member function pointers.
1467 if (MPT->isMemberDataPointer())
1468 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1469 if (!V)
1470 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001471 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001472 TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001473 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001474 case TemplateArgument::Template:
1475 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001476 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001477 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1478 break;
1479 case TemplateArgument::Pack:
1480 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1481 TheCU, Name, nullptr,
1482 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1483 break;
David Majnemer5559d472013-08-24 08:21:10 +00001484 case TemplateArgument::Expression: {
1485 const Expr *E = TA.getAsExpr();
1486 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001487 if (E->isGLValue())
1488 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001489 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001490 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001491 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001492 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001493 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001494 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001495 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001496 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001497 case TemplateArgument::Null:
1498 llvm_unreachable(
1499 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001500 }
1501 }
1502 return DBuilder.getOrCreateArray(TemplateParams);
1503}
1504
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001505llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001506CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001507 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001508 if (FD->getTemplatedKind() ==
1509 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001510 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1511 ->getTemplate()
1512 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001513 return CollectTemplateParams(
1514 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001515 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001516 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001517}
1518
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001519llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1520 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001521 // Always get the full list of parameters, not just the ones from
1522 // the specialization.
1523 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001524 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001525 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001526 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001527}
1528
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001529llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001530 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001531 return VTablePtrType;
1532
1533 ASTContext &Context = CGM.getContext();
1534
1535 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001536 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001537 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001538 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001539 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001540 llvm::DIType *vtbl_ptr_type =
Eric Christophere7b87e52014-10-26 23:40:33 +00001541 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001542 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1543 return VTablePtrType;
1544}
1545
Guy Benyei11169dd2012-12-18 14:30:41 +00001546StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001547 // Copy the gdb compatible name on the side and use its reference.
1548 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001549}
1550
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001551void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001552 SmallVectorImpl<llvm::Metadata *> &EltTys,
1553 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001554 // If this class is not dynamic then there is not any vtable info to collect.
1555 if (!RD->isDynamicClass())
1556 return;
1557
Reid Klecknerdc124992016-08-31 16:11:43 +00001558 // CodeView needs to know how large the vtable of every dynamic class is, so
1559 // emit a special named pointer type into the element list. The vptr type
1560 // points to this type as well.
1561 llvm::DIType *VPtrTy = nullptr;
1562 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1563 CGM.getTarget().getCXXABI().isMicrosoft();
1564 if (NeedVTableShape) {
1565 uint64_t PtrWidth =
1566 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1567 const VTableLayout &VFTLayout =
1568 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1569 unsigned VSlotCount =
1570 VFTLayout.getNumVTableComponents() - CGM.getLangOpts().RTTIData;
1571 unsigned VTableWidth = PtrWidth * VSlotCount;
1572
1573 // Create a very wide void* type and insert it directly in the element list.
1574 llvm::DIType *VTableType =
1575 DBuilder.createPointerType(nullptr, VTableWidth, 0, "__vtbl_ptr_type");
1576 EltTys.push_back(VTableType);
1577
1578 // The vptr is a pointer to this special vtable type.
1579 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1580 }
1581
1582 // If there is a primary base then the artificial vptr member lives there.
1583 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1584 if (RL.getPrimaryBase())
1585 return;
1586
1587 if (!VPtrTy)
1588 VPtrTy = getOrCreateVTablePtrType(Unit);
1589
Guy Benyei11169dd2012-12-18 14:30:41 +00001590 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001591 llvm::DIType *VPtrMember = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001592 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Reid Klecknerdc124992016-08-31 16:11:43 +00001593 llvm::DINode::FlagArtificial, VPtrTy);
1594 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001595}
1596
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001597llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001598 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001599 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001600 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001601 return T;
1602}
1603
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001604llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001605 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001606 return getOrCreateStandaloneType(D, Loc);
1607}
1608
1609llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1610 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001611 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001612 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001613 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001614 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001615
Adrian Prantl73409ce2013-03-11 18:33:46 +00001616 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001617 return T;
1618}
1619
David Blaikie483a9da2014-05-06 18:35:21 +00001620void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001621 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001622 return;
1623 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001624 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001625 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001626 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001627 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001628 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001629 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001630 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001631}
1632
David Blaikieb2e86eb2013-08-15 20:49:17 +00001633void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001634 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001635 !CGM.getLangOpts().CPlusPlus)
1636 completeRequiredType(RD);
1637}
1638
1639void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001640 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00001641 return;
1642
David Majnemer58ed0f32016-07-17 00:39:12 +00001643 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikie6943dea2013-08-20 01:28:15 +00001644 if (CXXDecl->isDynamicClass())
1645 return;
1646
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001647 if (DebugTypeExtRefs && RD->isFromASTFile())
1648 return;
1649
David Blaikieb2e86eb2013-08-15 20:49:17 +00001650 QualType Ty = CGM.getContext().getRecordType(RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001651 llvm::DIType *T = getTypeOrNull(Ty);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001652 if (T && T->isForwardDecl())
David Blaikie6943dea2013-08-20 01:28:15 +00001653 completeClassData(RD);
1654}
1655
1656void CGDebugInfo::completeClassData(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001657 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001658 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001659 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001660 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001661 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001662 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001663 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001664 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001665 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001666 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001667}
1668
David Blaikie0e716b42014-03-03 23:48:23 +00001669static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1670 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001671 for (CXXMethodDecl *MD : llvm::make_range(I, End))
1672 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001673 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00001674 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001675 return true;
1676 return false;
1677}
1678
Adrian Prantl05fefa42016-04-25 20:52:40 +00001679/// Does a type definition exist in an imported clang module?
1680static bool isDefinedInClangModule(const RecordDecl *RD) {
Adrian Prantl09906a62016-08-22 22:38:16 +00001681 // Only definitions that where imported from an AST file come from a module.
Adrian Prantl88d79172016-04-26 21:58:18 +00001682 if (!RD || !RD->isFromASTFile())
Adrian Prantl05fefa42016-04-25 20:52:40 +00001683 return false;
Adrian Prantl09906a62016-08-22 22:38:16 +00001684 // Anonymous entities cannot be addressed. Treat them as not from module.
Adrian Prantl05fefa42016-04-25 20:52:40 +00001685 if (!RD->isExternallyVisible() && RD->getName().empty())
1686 return false;
Adrian Prantl94913712016-04-26 23:42:43 +00001687 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
Adrian Prantla72972b2016-08-22 22:23:58 +00001688 if (!CXXDecl->isCompleteDefinition())
1689 return false;
Adrian Prantl26cb1d22016-08-17 18:27:24 +00001690 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1691 if (TemplateKind != TSK_Undeclared) {
1692 // This is a template, check the origin of the first member.
1693 if (CXXDecl->field_begin() == CXXDecl->field_end())
1694 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1695 if (!CXXDecl->field_begin()->isFromASTFile())
1696 return false;
1697 }
Adrian Prantl94913712016-04-26 23:42:43 +00001698 }
Adrian Prantl05fefa42016-04-25 20:52:40 +00001699 return true;
1700}
1701
Benjamin Kramer8c305922016-02-02 11:06:51 +00001702static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1703 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001704 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001705 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001706 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001707
Benjamin Kramer8c305922016-02-02 11:06:51 +00001708 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001709 return false;
1710
1711 if (!LangOpts.CPlusPlus)
1712 return false;
1713
1714 if (!RD->isCompleteDefinitionRequired())
1715 return true;
1716
David Majnemer58ed0f32016-07-17 00:39:12 +00001717 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00001718
1719 if (!CXXDecl)
1720 return false;
1721
Adrian McCarthy99242982016-08-16 22:11:18 +00001722 // Only emit complete debug info for a dynamic class when its vtable is
1723 // emitted. However, Microsoft debuggers don't resolve type information
1724 // across DLL boundaries, so skip this optimization if the class is marked
1725 // dllimport.
1726 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
1727 !CXXDecl->hasAttr<DLLImportAttr>())
David Blaikie0e716b42014-03-03 23:48:23 +00001728 return true;
1729
1730 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00001731 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00001732 Spec = SD->getSpecializationKind();
1733
1734 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1735 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1736 CXXDecl->method_end()))
1737 return true;
1738
1739 return false;
1740}
1741
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001742llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001743 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001744 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001745 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1746 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001747 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001748 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001749 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001750 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001751
David Blaikieb2e86eb2013-08-15 20:49:17 +00001752 return CreateTypeDefinition(Ty);
1753}
1754
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001755llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001756 RecordDecl *RD = Ty->getDecl();
1757
Guy Benyei11169dd2012-12-18 14:30:41 +00001758 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001759 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001760
1761 // Records and classes and unions can all be recursive. To handle them, we
1762 // first generate a debug descriptor for the struct as a forward declaration.
1763 // Then (if it is a definition) we go through and get debug info for all of
1764 // its members. Finally, we create a descriptor for the complete type (which
1765 // may refer to the forward decl if the struct is recursive) and replace all
1766 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001767 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001768
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001769 const RecordDecl *D = RD->getDefinition();
1770 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001771 return FwdDecl;
1772
David Majnemer58ed0f32016-07-17 00:39:12 +00001773 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00001774 CollectContainingType(CXXDecl, FwdDecl);
1775
Guy Benyei11169dd2012-12-18 14:30:41 +00001776 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001777 LexicalBlockStack.emplace_back(&*FwdDecl);
1778 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001779
Guy Benyei11169dd2012-12-18 14:30:41 +00001780 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001781 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001782 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001783
1784 // Note: The split of CXXDecl information here is intentional, the
1785 // gdb tests will depend on a certain ordering at printout. The debug
1786 // information offsets are still correct if we merge them all together
1787 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00001788 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00001789 if (CXXDecl) {
1790 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00001791 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001792 }
1793
Eric Christopher91a31902013-01-16 01:22:32 +00001794 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001795 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001796 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001797 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001798
1799 LexicalBlockStack.pop_back();
1800 RegionMap.erase(Ty->getDecl());
1801
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001802 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001803 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001804
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001805 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001806 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001807 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001808
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001809 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001810 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001811}
1812
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001813llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1814 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001815 // Ignore protocols.
1816 return getOrCreateType(Ty->getBaseType(), Unit);
1817}
1818
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001819/// \return true if Getter has the default name for the property PD.
1820static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1821 const ObjCMethodDecl *Getter) {
1822 assert(PD);
1823 if (!Getter)
1824 return true;
1825
1826 assert(Getter->getDeclName().isObjCZeroArgSelector());
1827 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001828 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001829}
1830
1831/// \return true if Setter has the default name for the property PD.
1832static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1833 const ObjCMethodDecl *Setter) {
1834 assert(PD);
1835 if (!Setter)
1836 return true;
1837
1838 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001839 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001840 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001841}
1842
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001843llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1844 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001845 ObjCInterfaceDecl *ID = Ty->getDecl();
1846 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001847 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001848
Adrian Prantl50fd1a82016-04-20 23:59:32 +00001849 // Return a forward declaration if this type was imported from a clang module,
1850 // and this is not the compile unit with the implementation of the type (which
1851 // may contain hidden ivars).
1852 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
1853 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001854 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1855 ID->getName(),
1856 getDeclContextDescriptor(ID), Unit, 0);
1857
Guy Benyei11169dd2012-12-18 14:30:41 +00001858 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001859 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001860 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001861 auto RuntimeLang =
1862 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00001863
1864 // If this is just a forward declaration return a special forward-declaration
1865 // debug type since we won't be able to lay out the entire type.
1866 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001867 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001868 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001869 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001870 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
1871 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001872 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001873 return FwdDecl;
1874 }
1875
David Blaikieef8a9512014-05-05 23:23:53 +00001876 return CreateTypeDefinition(Ty, Unit);
1877}
1878
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001879llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00001880CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
1881 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00001882 // Use the Module pointer as the key into the cache. This is a
1883 // nullptr if the "Module" is a PCH, which is safe because we don't
1884 // support chained PCH debug info, so there can only be a single PCH.
1885 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001886 auto ModRef = ModuleCache.find(M);
1887 if (ModRef != ModuleCache.end())
1888 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00001889
1890 // Macro definitions that were defined with "-D" on the command line.
1891 SmallString<128> ConfigMacros;
1892 {
1893 llvm::raw_svector_ostream OS(ConfigMacros);
1894 const auto &PPOpts = CGM.getPreprocessorOpts();
1895 unsigned I = 0;
1896 // Translate the macro definitions back into a commmand line.
1897 for (auto &M : PPOpts.Macros) {
1898 if (++I > 1)
1899 OS << " ";
1900 const std::string &Macro = M.first;
1901 bool Undef = M.second;
1902 OS << "\"-" << (Undef ? 'U' : 'D');
1903 for (char c : Macro)
1904 switch (c) {
1905 case '\\' : OS << "\\\\"; break;
1906 case '"' : OS << "\\\""; break;
1907 default: OS << c;
1908 }
1909 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001910 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001911 }
Adrian Prantl66689202015-09-18 23:01:45 +00001912
Adrian Prantl835e6632015-09-24 16:10:10 +00001913 bool IsRootModule = M ? !M->Parent : true;
1914 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00001915 // PCH files don't have a signature field in the control block,
1916 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Adrian Prantl98bfc822016-01-22 19:29:41 +00001917 uint64_t Signature = Mod.getSignature() ? Mod.getSignature() : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00001918 llvm::DIBuilder DIB(CGM.getModule());
Adrian Prantl835e6632015-09-24 16:10:10 +00001919 DIB.createCompileUnit(TheCU->getSourceLanguage(), Mod.getModuleName(),
Adrian Prantl6083b082015-09-24 16:10:00 +00001920 Mod.getPath(), TheCU->getProducer(), true,
1921 StringRef(), 0, Mod.getASTFile(),
Adrian Prantl3563c552016-03-31 23:57:45 +00001922 llvm::DICompileUnit::FullDebug, Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00001923 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00001924 }
Adrian Prantl835e6632015-09-24 16:10:10 +00001925 llvm::DIModule *Parent =
1926 IsRootModule ? nullptr
1927 : getOrCreateModuleRef(
1928 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
1929 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00001930 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00001931 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
1932 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001933 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00001934 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001935}
1936
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001937llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
1938 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00001939 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001940 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00001941 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001942 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001943
1944 // Bit size, align and offset of the type.
1945 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1946 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1947
1948 unsigned Flags = 0;
1949 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001950 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00001951
Adrian Prantlfd696112015-10-01 00:48:51 +00001952 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001953 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00001954 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
1955 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001956
David Blaikieef8a9512014-05-05 23:23:53 +00001957 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001958 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001959
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001960 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001961 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001962 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001963
1964 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001965 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001966
1967 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1968 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001969 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001970 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001971 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001972 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001973
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001974 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00001975 EltTys.push_back(InhTag);
1976 }
1977
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001978 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00001979 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001980 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001981 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001982 unsigned PLine = getLineNumber(Loc);
1983 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1984 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001985 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
1986 PD->getName(), PUnit, PLine,
1987 hasDefaultGetterName(PD, Getter) ? ""
1988 : getSelectorName(PD->getGetterName()),
1989 hasDefaultSetterName(PD, Setter) ? ""
1990 : getSelectorName(PD->getSetterName()),
1991 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001992 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00001993 };
1994 {
1995 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00001996 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00001997 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00001998 PropertySet.insert(PD->getIdentifier());
1999 AddProperty(PD);
2000 }
Manman Renefe1bac2016-01-27 20:00:32 +00002001 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002002 // Don't emit duplicate metadata for properties that were already in a
2003 // class extension.
2004 if (!PropertySet.insert(PD->getIdentifier()).second)
2005 continue;
2006 AddProperty(PD);
2007 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002008 }
2009
2010 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2011 unsigned FieldNo = 0;
2012 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2013 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002014 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002015 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002016 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002017
Guy Benyei11169dd2012-12-18 14:30:41 +00002018 StringRef FieldName = Field->getName();
2019
2020 // Ignore unnamed fields.
2021 if (FieldName.empty())
2022 continue;
2023
2024 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002025 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002026 unsigned FieldLine = getLineNumber(Field->getLocation());
2027 QualType FType = Field->getType();
2028 uint64_t FieldSize = 0;
2029 unsigned FieldAlign = 0;
2030
2031 if (!FType->isIncompleteArrayType()) {
2032
2033 // Bit size, align and offset of the type.
2034 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002035 ? Field->getBitWidthValue(CGM.getContext())
2036 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002037 FieldAlign = CGM.getContext().getTypeAlign(FType);
2038 }
2039
2040 uint64_t FieldOffset;
2041 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2042 // We don't know the runtime offset of an ivar if we're using the
2043 // non-fragile ABI. For bitfields, use the bit offset into the first
2044 // byte of storage of the bitfield. For other fields, use zero.
2045 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002046 FieldOffset =
2047 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002048 FieldOffset %= CGM.getContext().getCharWidth();
2049 } else {
2050 FieldOffset = 0;
2051 }
2052 } else {
2053 FieldOffset = RL.getFieldOffset(FieldNo);
2054 }
2055
2056 unsigned Flags = 0;
2057 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002058 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002059 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002060 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002061 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002062 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002063
Craig Topper8a13c412014-05-21 05:09:00 +00002064 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002065 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002066 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002067 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002068 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002069 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002070 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002071 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002072 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2073 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002074 PropertyNode = DBuilder.createObjCProperty(
2075 PD->getName(), PUnit, PLine,
2076 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2077 PD->getGetterName()),
2078 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2079 PD->getSetterName()),
2080 PD->getPropertyAttributes(),
2081 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002082 }
2083 }
2084 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002085 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2086 FieldSize, FieldAlign, FieldOffset, Flags,
2087 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002088 EltTys.push_back(FieldTy);
2089 }
2090
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002091 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002092 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002093
Guy Benyei11169dd2012-12-18 14:30:41 +00002094 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002095 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002096}
2097
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002098llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2099 llvm::DIFile *Unit) {
2100 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002101 int64_t Count = Ty->getNumElements();
2102 if (Count == 0)
2103 // If number of elements are not known then this is an unbounded array.
2104 // Use Count == -1 to express such arrays.
2105 Count = -1;
2106
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002107 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002108 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002109
2110 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2111 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
2112
2113 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2114}
2115
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002116llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002117 uint64_t Size;
2118 uint64_t Align;
2119
2120 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002121 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002122 Size = 0;
2123 Align =
Eric Christophere7b87e52014-10-26 23:40:33 +00002124 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Guy Benyei11169dd2012-12-18 14:30:41 +00002125 } else if (Ty->isIncompleteArrayType()) {
2126 Size = 0;
2127 if (Ty->getElementType()->isIncompleteType())
2128 Align = 0;
2129 else
2130 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00002131 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002132 Size = 0;
2133 Align = 0;
2134 } else {
2135 // Size and align of the whole array, not the element type.
2136 Size = CGM.getContext().getTypeSize(Ty);
2137 Align = CGM.getContext().getTypeAlign(Ty);
2138 }
2139
2140 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2141 // interior arrays, do we care? Why aren't nested arrays represented the
2142 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002143 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002144 QualType EltTy(Ty, 0);
2145 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2146 // If the number of elements is known, then count is that number. Otherwise,
2147 // it's -1. This allows us to represent a subrange with an array of 0
2148 // elements, like this:
2149 //
2150 // struct foo {
2151 // int x[0];
2152 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002153 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002154 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002155 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002156 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2157 llvm::APSInt V;
2158 if (VAT->getSizeExpr()->EvaluateAsInt(V, CGM.getContext()))
2159 Count = V.getExtValue();
2160 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002161
Guy Benyei11169dd2012-12-18 14:30:41 +00002162 // FIXME: Verify this is right for VLAs.
2163 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2164 EltTy = Ty->getElementType();
2165 }
2166
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002167 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002168
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002169 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2170 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002171}
2172
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002173llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2174 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002175 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2176 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002177}
2178
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002179llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2180 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002181 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2182 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002183}
2184
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002185llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2186 llvm::DIFile *U) {
Reid Klecknerfb727182016-06-17 22:27:59 +00002187 unsigned Flags = 0;
2188 uint64_t Size = 0;
2189
2190 if (!Ty->isIncompleteType()) {
2191 Size = CGM.getContext().getTypeSize(Ty);
2192
2193 // Set the MS inheritance model. There is no flag for the unspecified model.
2194 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2195 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2196 case MSInheritanceAttr::Keyword_single_inheritance:
2197 Flags |= llvm::DINode::FlagSingleInheritance;
2198 break;
2199 case MSInheritanceAttr::Keyword_multiple_inheritance:
2200 Flags |= llvm::DINode::FlagMultipleInheritance;
2201 break;
2202 case MSInheritanceAttr::Keyword_virtual_inheritance:
2203 Flags |= llvm::DINode::FlagVirtualInheritance;
2204 break;
2205 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2206 break;
2207 }
2208 }
2209 }
2210
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002211 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002212 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002213 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002214 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2215 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002216
2217 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002218 Ty->getPointeeType()->getAs<FunctionProtoType>();
2219 return DBuilder.createMemberPointerType(
2220 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2221 Ty->getClass(), FPT->getTypeQuals())),
2222 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002223 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002224}
2225
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002226llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002227 // Ignore the atomic wrapping
2228 // FIXME: What is the correct representation?
2229 return getOrCreateType(Ty->getValueType(), U);
2230}
2231
Xiuli Pan9c14e282016-01-09 12:53:17 +00002232llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2233 llvm::DIFile *U) {
2234 return getOrCreateType(Ty->getElementType(), U);
2235}
2236
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002237llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002238 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002239
Guy Benyei11169dd2012-12-18 14:30:41 +00002240 uint64_t Size = 0;
2241 uint64_t Align = 0;
2242 if (!ED->getTypeForDecl()->isIncompleteType()) {
2243 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2244 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2245 }
2246
Manman Rene0064d82013-08-29 23:19:58 +00002247 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2248
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002249 bool isImportedFromModule =
2250 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2251
Guy Benyei11169dd2012-12-18 14:30:41 +00002252 // If this is just a forward declaration, construct an appropriately
2253 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002254 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002255 // Note that it is possible for enums to be created as part of
2256 // their own declcontext. In this case a FwdDecl will be created
2257 // twice. This doesn't cause a problem because both FwdDecls are
2258 // entered into the ReplaceMap: finalize() will replace the first
2259 // FwdDecl with the second and then replace the second with
2260 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002261 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002262 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002263 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2264 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002265
Guy Benyei11169dd2012-12-18 14:30:41 +00002266 unsigned Line = getLineNumber(ED->getLocation());
2267 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002268 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002269 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2270 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Adrian Prantla40030f2016-02-06 01:59:09 +00002271
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002272 ReplaceMap.emplace_back(
2273 std::piecewise_construct, std::make_tuple(Ty),
2274 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002275 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002276 }
2277
David Blaikie483a9da2014-05-06 18:35:21 +00002278 return CreateTypeDefinition(Ty);
2279}
2280
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002281llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002282 const EnumDecl *ED = Ty->getDecl();
2283 uint64_t Size = 0;
2284 uint64_t Align = 0;
2285 if (!ED->getTypeForDecl()->isIncompleteType()) {
2286 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2287 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2288 }
2289
2290 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2291
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002292 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002293 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002294 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002295 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002296 Enumerators.push_back(DBuilder.createEnumerator(
2297 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002298 }
2299
2300 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002301 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002302
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002303 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002304 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002305 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002306 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002307 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2308 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2309 Line, Size, Align, EltArray, ClassTy,
2310 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002311}
2312
David Blaikie05491062013-01-21 04:37:12 +00002313static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2314 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002315 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002316 Qualifiers InnerQuals = T.getLocalQualifiers();
2317 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2318 // that is already there.
2319 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2320 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002321 QualType LastT = T;
2322 switch (T->getTypeClass()) {
2323 default:
David Blaikie05491062013-01-21 04:37:12 +00002324 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002325 case Type::TemplateSpecialization: {
2326 const auto *Spec = cast<TemplateSpecializationType>(T);
2327 if (Spec->isTypeAlias())
2328 return C.getQualifiedType(T.getTypePtr(), Quals);
2329 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002330 break;
2331 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002332 case Type::TypeOfExpr:
2333 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2334 break;
2335 case Type::TypeOf:
2336 T = cast<TypeOfType>(T)->getUnderlyingType();
2337 break;
2338 case Type::Decltype:
2339 T = cast<DecltypeType>(T)->getUnderlyingType();
2340 break;
2341 case Type::UnaryTransform:
2342 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2343 break;
2344 case Type::Attributed:
2345 T = cast<AttributedType>(T)->getEquivalentType();
2346 break;
2347 case Type::Elaborated:
2348 T = cast<ElaboratedType>(T)->getNamedType();
2349 break;
2350 case Type::Paren:
2351 T = cast<ParenType>(T)->getInnerType();
2352 break;
David Blaikie05491062013-01-21 04:37:12 +00002353 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002354 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002355 break;
2356 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002357 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002358 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002359 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002360 break;
2361 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002362
Guy Benyei11169dd2012-12-18 14:30:41 +00002363 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002364 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002365 } while (true);
2366}
2367
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002368llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002369
2370 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002371 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002372
David Blaikief427b002014-05-06 03:42:01 +00002373 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002374 if (it != TypeCache.end()) {
2375 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002376 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002377 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002378 }
2379
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002380 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002381}
2382
David Blaikie0e716b42014-03-03 23:48:23 +00002383void CGDebugInfo::completeTemplateDefinition(
2384 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002385 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002386 return;
2387
David Blaikie0e716b42014-03-03 23:48:23 +00002388 completeClassData(&SD);
2389 // In case this type has no member function definitions being emitted, ensure
2390 // it is retained
2391 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2392}
2393
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002394llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002395 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002396 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002397
2398 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002399 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002400
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002401 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 return T;
2403
Adrian Prantlca844182015-09-11 17:23:03 +00002404 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002405 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002406
2407 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002408 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002409
Guy Benyei11169dd2012-12-18 14:30:41 +00002410 return Res;
2411}
2412
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002413llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002414 // A forward declaration inside a module header does not belong to the module.
2415 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2416 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002417 if (DebugTypeExtRefs && D->isFromASTFile()) {
2418 // Record a reference to an imported clang module or precompiled header.
2419 auto *Reader = CGM.getContext().getExternalSource();
2420 auto Idx = D->getOwningModuleID();
2421 auto Info = Reader->getSourceDescriptor(Idx);
2422 if (Info)
2423 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2424 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002425 // We are building a clang module or a precompiled header.
2426 //
2427 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2428 // and it wouldn't be necessary to specify the parent scope
2429 // because the type is already unique by definition (it would look
2430 // like the output of -fno-standalone-debug). On the other hand,
2431 // the parent scope helps a consumer to quickly locate the object
2432 // file where the type's definition is located, so it might be
2433 // best to make this behavior a command line or debugger tuning
2434 // option.
2435 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
2436 if (Module *M = ClangModuleMap->inferModuleFromLocation(Loc)) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002437 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002438 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2439 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002440 } else {
2441 // This the precompiled header being built.
2442 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002443 }
2444 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002445
Adrian Prantl9402cef2015-09-20 16:51:35 +00002446 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002447}
2448
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002449llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002450 // Handle qualifiers, which recursively handles what they refer to.
2451 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002452 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002453
Guy Benyei11169dd2012-12-18 14:30:41 +00002454 // Work out details of type.
2455 switch (Ty->getTypeClass()) {
2456#define TYPE(Class, Base)
2457#define ABSTRACT_TYPE(Class, Base)
2458#define NON_CANONICAL_TYPE(Class, Base)
2459#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2460#include "clang/AST/TypeNodes.def"
2461 llvm_unreachable("Dependent types cannot show up in debug information");
2462
2463 case Type::ExtVector:
2464 case Type::Vector:
2465 return CreateType(cast<VectorType>(Ty), Unit);
2466 case Type::ObjCObjectPointer:
2467 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2468 case Type::ObjCObject:
2469 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2470 case Type::ObjCInterface:
2471 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2472 case Type::Builtin:
2473 return CreateType(cast<BuiltinType>(Ty));
2474 case Type::Complex:
2475 return CreateType(cast<ComplexType>(Ty));
2476 case Type::Pointer:
2477 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002478 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002479 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002480 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002481 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002482 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002483 case Type::BlockPointer:
2484 return CreateType(cast<BlockPointerType>(Ty), Unit);
2485 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002486 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002487 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002488 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002489 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002490 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002491 case Type::FunctionProto:
2492 case Type::FunctionNoProto:
2493 return CreateType(cast<FunctionType>(Ty), Unit);
2494 case Type::ConstantArray:
2495 case Type::VariableArray:
2496 case Type::IncompleteArray:
2497 return CreateType(cast<ArrayType>(Ty), Unit);
2498
2499 case Type::LValueReference:
2500 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2501 case Type::RValueReference:
2502 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2503
2504 case Type::MemberPointer:
2505 return CreateType(cast<MemberPointerType>(Ty), Unit);
2506
2507 case Type::Atomic:
2508 return CreateType(cast<AtomicType>(Ty), Unit);
2509
Xiuli Pan9c14e282016-01-09 12:53:17 +00002510 case Type::Pipe:
2511 return CreateType(cast<PipeType>(Ty), Unit);
2512
Guy Benyei11169dd2012-12-18 14:30:41 +00002513 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002514 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2515
David Blaikie42edade2014-11-11 20:44:45 +00002516 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002517 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002518 case Type::Elaborated:
2519 case Type::Paren:
2520 case Type::SubstTemplateTypeParm:
2521 case Type::TypeOfExpr:
2522 case Type::TypeOf:
2523 case Type::Decltype:
2524 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002525 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002526 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002527 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002528
David Blaikie42edade2014-11-11 20:44:45 +00002529 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002530}
2531
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002532llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2533 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002534 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002535
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002536 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002537
2538 // We may have cached a forward decl when we could have created
2539 // a non-forward decl. Go ahead and create a non-forward decl
2540 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002541 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002542 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002543
2544 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002545 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002546
2547 // Propagate members from the declaration to the definition
2548 // CreateType(const RecordType*) will overwrite this with the members in the
2549 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002550 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002551
Guy Benyei11169dd2012-12-18 14:30:41 +00002552 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002553 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002554 return Res;
2555}
2556
2557// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002558llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002559 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002560
Guy Benyei11169dd2012-12-18 14:30:41 +00002561 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002562 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002563 unsigned Line = getLineNumber(RD->getLocation());
2564 StringRef RDName = getClassName(RD);
2565
Amjad Abouddc4531e2016-04-30 01:44:38 +00002566 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002567
David Blaikied2785892013-08-18 17:36:19 +00002568 // If we ended up creating the type during the context chain construction,
2569 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002570 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002571 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002572 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002573 return T;
David Blaikied2785892013-08-18 17:36:19 +00002574
Adrian Prantl381e7552014-02-04 21:29:50 +00002575 // If this is just a forward or incomplete declaration, construct an
2576 // appropriately marked node and just return it.
2577 const RecordDecl *D = RD->getDefinition();
2578 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002579 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002580
2581 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2582 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002583
Manman Rene0064d82013-08-29 23:19:58 +00002584 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2585
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002586 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002587 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align, 0,
2588 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002589
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002590 // Elements of composite types usually have back to the type, creating
2591 // uniquing cycles. Distinct nodes are more efficient.
2592 switch (RealDecl->getTag()) {
2593 default:
2594 llvm_unreachable("invalid composite type tag");
2595
2596 case llvm::dwarf::DW_TAG_array_type:
2597 case llvm::dwarf::DW_TAG_enumeration_type:
2598 // Array elements and most enumeration elements don't have back references,
2599 // so they don't tend to be involved in uniquing cycles and there is some
2600 // chance of merging them when linking together two modules. Only make
2601 // them distinct if they are ODR-uniqued.
2602 if (FullName.empty())
2603 break;
2604
2605 case llvm::dwarf::DW_TAG_structure_type:
2606 case llvm::dwarf::DW_TAG_union_type:
2607 case llvm::dwarf::DW_TAG_class_type:
2608 // Immediatley resolve to a distinct node.
2609 RealDecl =
2610 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2611 break;
2612 }
2613
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002614 RegionMap[Ty->getDecl()].reset(RealDecl);
2615 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002616
David Majnemer58ed0f32016-07-17 00:39:12 +00002617 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002618 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002619 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002620 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002621}
2622
David Blaikieadfbf992013-08-18 16:55:33 +00002623void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002624 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002625 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002626 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002627 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2628 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002629 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002630 while (1) {
2631 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2632 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2633 if (PBT && !BRL.isPrimaryBaseVirtual())
2634 PBase = PBT;
2635 else
2636 break;
2637 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002638 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002639 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2640 getOrCreateFile(RD->getLocation())));
2641 } else if (RD->isDynamicClass())
2642 ContainingType = RealDecl;
2643
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002644 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002645}
2646
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002647llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002648 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002649 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002650 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2651 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002652 llvm::DIType *Ty = DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002653 FieldAlign, *Offset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002654 *Offset += FieldSize;
2655 return Ty;
2656}
2657
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002658void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002659 StringRef &Name,
2660 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002661 llvm::DIScope *&FDContext,
2662 llvm::DINodeArray &TParamsArray,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002663 unsigned &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002664 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00002665 Name = getFunctionName(FD);
2666 // Use mangled name as linkage name for C/C++ functions.
2667 if (FD->hasPrototype()) {
2668 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002669 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002670 }
2671 // No need to replicate the linkage name if it isn't different from the
2672 // subprogram name, no need to have it at all unless coverage is enabled or
2673 // debug is set to more than just line tables.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002674 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2675 !CGM.getCodeGenOpts().EmitGcovNotes &&
2676 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00002677 LinkageName = StringRef();
2678
Benjamin Kramer8c305922016-02-02 11:06:51 +00002679 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002680 if (const NamespaceDecl *NSDecl =
2681 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2682 FDContext = getOrCreateNameSpace(NSDecl);
2683 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002684 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2685 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2686 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2687 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00002688 // Check if it is a noreturn-marked function
2689 if (FD->isNoReturn())
2690 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00002691 // Collect template parameters.
2692 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2693 }
2694}
2695
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002696void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002697 unsigned &LineNo, QualType &T,
2698 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002699 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002700 Unit = getOrCreateFile(VD->getLocation());
2701 LineNo = getLineNumber(VD->getLocation());
2702
2703 setLocation(VD->getLocation());
2704
2705 T = VD->getType();
2706 if (T->isIncompleteArrayType()) {
2707 // CodeGen turns int[] into int[1] so we'll do the same here.
2708 llvm::APInt ConstVal(32, 1);
2709 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2710
2711 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2712 ArrayType::Normal, 0);
2713 }
2714
2715 Name = VD->getName();
2716 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2717 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2718 LinkageName = CGM.getMangledName(VD);
2719 if (LinkageName == Name)
2720 LinkageName = StringRef();
2721
2722 // Since we emit declarations (DW_AT_members) for static members, place the
2723 // definition of those static members in the namespace they were declared in
2724 // in the source code (the lexical decl context).
2725 // FIXME: Generalize this for even non-member global variables where the
2726 // declaration and definition may have different lexical decl contexts, once
2727 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002728 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2729 : VD->getDeclContext();
2730 // When a record type contains an in-line initialization of a static data
2731 // member, and the record type is marked as __declspec(dllexport), an implicit
2732 // definition of the member will be created in the record context. DWARF
2733 // doesn't seem to have a nice way to describe this in a form that consumers
2734 // are likely to understand, so fake the "normal" situation of a definition
2735 // outside the class by putting it in the global scope.
2736 if (DC->isRecord())
2737 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002738
Amjad Abouddc4531e2016-04-30 01:44:38 +00002739 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2740 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002741}
2742
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002743llvm::DISubprogram *
Frederic Rissd253ed62014-11-18 03:40:51 +00002744CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002745 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002746 StringRef Name, LinkageName;
2747 unsigned Flags = 0;
2748 SourceLocation Loc = FD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002749 llvm::DIFile *Unit = getOrCreateFile(Loc);
2750 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002751 unsigned Line = getLineNumber(Loc);
2752
2753 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2754 TParamsArray, Flags);
2755 // Build function type.
2756 SmallVector<QualType, 16> ArgTypes;
2757 for (const ParmVarDecl *Parm: FD->parameters())
2758 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00002759 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2760 QualType FnType = CGM.getContext().getFunctionType(
2761 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002762 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002763 DContext, Name, LinkageName, Unit, Line,
2764 getOrCreateFunctionType(FD, FnType, Unit), !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002765 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002766 TParamsArray.get(), getFunctionDeclaration(FD));
David Majnemer58ed0f32016-07-17 00:39:12 +00002767 const auto *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002768 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2769 std::make_tuple(CanonDecl),
2770 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002771 return SP;
2772}
2773
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002774llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002775CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2776 QualType T;
2777 StringRef Name, LinkageName;
2778 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002779 llvm::DIFile *Unit = getOrCreateFile(Loc);
2780 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002781 unsigned Line = getLineNumber(Loc);
2782
2783 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002784 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
2785 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
2786 !VD->isExternallyVisible(), nullptr, nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002787 FwdDeclReplaceMap.emplace_back(
2788 std::piecewise_construct,
2789 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2790 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002791 return GV;
2792}
2793
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002794llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002795 // We only need a declaration (not a definition) of the type - so use whatever
2796 // we would otherwise do to get a type for a pointee. (forward declarations in
2797 // limited debug info, full definitions (if the type definition is available)
2798 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00002799 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00002800 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002801 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002802 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002803
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002804 if (I != DeclCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002805 return dyn_cast_or_null<llvm::DINode>(I->second);
Frederic Rissd253ed62014-11-18 03:40:51 +00002806
2807 // No definition for now. Emit a forward definition that might be
2808 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00002809 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00002810 return getFunctionForwardDeclaration(FD);
2811 else if (const auto *VD = dyn_cast<VarDecl>(D))
2812 return getGlobalVariableForwardDeclaration(VD);
2813
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002814 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00002815}
2816
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002817llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002818 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002819 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00002820
David Majnemer58ed0f32016-07-17 00:39:12 +00002821 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002822 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002823 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002824
2825 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002826 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00002827
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002828 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002829 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002830 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00002831 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002832 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00002833 }
2834 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002835 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002836 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002837 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002838 return SP;
2839 }
2840
Aaron Ballman86c93902014-03-06 23:45:36 +00002841 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002842 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002843 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002844 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002845 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002846 return SP;
2847 }
2848 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002849 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002850}
2851
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002852// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00002853// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002854llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002855 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002856 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002857 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002858 // Create fake but valid subroutine type. Otherwise -verify would fail, and
2859 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00002860 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002861
David Majnemer58ed0f32016-07-17 00:39:12 +00002862 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00002863 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002864
2865 const auto *FTy = FnType->getAs<FunctionType>();
2866 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
2867
David Majnemer58ed0f32016-07-17 00:39:12 +00002868 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002869 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002870 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002871
2872 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002873 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002874
2875 // Replace the instancetype keyword with the actual type.
2876 if (ResultTy == CGM.getContext().getObjCInstanceType())
2877 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002878 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002879
Adrian Prantl7bec9032013-05-10 21:08:31 +00002880 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002881 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002882 QualType SelfDeclTy;
2883 if (auto *SelfDecl = OMethod->getSelfDecl())
2884 SelfDeclTy = SelfDecl->getType();
2885 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
2886 if (FPT->getNumParams() > 1)
2887 SelfDeclTy = FPT->getParamType(0);
2888 if (!SelfDeclTy.isNull())
2889 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002890 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002891 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002892 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002893 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00002894 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00002895 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00002896 // Variadic methods need a special marker at the end of the type list.
2897 if (OMethod->isVariadic())
2898 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00002899
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002900 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002901 return DBuilder.createSubroutineType(EltTypeArray, 0, getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00002902 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002903
Adrian Prantl800faef2014-02-25 23:42:18 +00002904 // Handle variadic function types; they need an additional
2905 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00002906 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00002907 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002908 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00002909 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00002910 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
2911 for (QualType ParamType : FPT->param_types())
2912 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00002913 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002914 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002915 return DBuilder.createSubroutineType(EltTypeArray, 0, getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00002916 }
2917
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002918 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002919}
2920
Eric Christophere7b87e52014-10-26 23:40:33 +00002921void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
2922 SourceLocation ScopeLoc, QualType FnType,
2923 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002924
2925 StringRef Name;
2926 StringRef LinkageName;
2927
2928 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2929
2930 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002931 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002932
Guy Benyei11169dd2012-12-18 14:30:41 +00002933 unsigned Flags = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002934 llvm::DIFile *Unit = getOrCreateFile(Loc);
2935 llvm::DIScope *FDContext = Unit;
2936 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00002937 if (!HasDecl) {
2938 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002939 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00002940 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002941 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002942 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002943 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002944 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002945 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002946 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002947 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002948 return;
2949 }
2950 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002951 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2952 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00002953 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002954 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002955 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002956 } else {
2957 // Use llvm function name.
2958 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002959 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002960 }
David Majnemer58ed0f32016-07-17 00:39:12 +00002961 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00002962 Name = Name.substr(1);
2963
Adrian Prantl42d71b92014-04-10 23:21:53 +00002964 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002965 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002966 // Artificial functions without a location should not silently reuse CurLoc.
2967 if (Loc.isInvalid())
2968 CurLoc = SourceLocation();
2969 }
2970 unsigned LineNo = getLineNumber(Loc);
2971 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002972
Eric Christopher8018e412014-03-27 18:50:35 +00002973 // FIXME: The function declaration we're constructing here is mostly reusing
2974 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2975 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2976 // all subprograms instead of the actual context since subprogram definitions
2977 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002978 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00002979 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00002980 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002981 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002982 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002983 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00002984 // We might get here with a VarDecl in the case we're generating
2985 // code for the initialization of globals. Do not record these decls
2986 // as they will overwrite the actual VarDecl Decl in the cache.
2987 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00002988 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002989
Adrian Prantlbebb8932014-03-21 21:01:58 +00002990 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002991 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002992
Guy Benyei11169dd2012-12-18 14:30:41 +00002993 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002994 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002995}
2996
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002997void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
2998 QualType FnType) {
2999 StringRef Name;
3000 StringRef LinkageName;
3001
3002 const Decl *D = GD.getDecl();
3003 if (!D)
3004 return;
3005
3006 unsigned Flags = 0;
3007 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003008 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003009 llvm::DINodeArray TParamsArray;
3010 if (isa<FunctionDecl>(D)) {
3011 // If there is a DISubprogram for this function available then use it.
3012 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3013 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003014 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003015 Name = getObjCMethodName(OMD);
3016 Flags |= llvm::DINode::FlagPrototyped;
3017 } else {
3018 llvm_unreachable("not a function or ObjC method");
3019 }
3020 if (!Name.empty() && Name[0] == '\01')
3021 Name = Name.substr(1);
3022
3023 if (D->isImplicit()) {
3024 Flags |= llvm::DINode::FlagArtificial;
3025 // Artificial functions without a location should not silently reuse CurLoc.
3026 if (Loc.isInvalid())
3027 CurLoc = SourceLocation();
3028 }
3029 unsigned LineNo = getLineNumber(Loc);
3030 unsigned ScopeLine = 0;
3031
Adrian Prantle76bda52016-04-15 15:55:45 +00003032 DBuilder.retainType(DBuilder.createFunction(
3033 FDContext, Name, LinkageName, Unit, LineNo,
3034 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3035 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3036 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003037}
3038
David Blaikie835afb22015-01-21 23:08:17 +00003039void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003040 // Update our current location
3041 setLocation(Loc);
3042
Eric Christophere7b87e52014-10-26 23:40:33 +00003043 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3044 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003045
Adrian Prantle83b1302014-01-07 22:05:52 +00003046 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00003047 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00003048 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003049}
3050
Guy Benyei11169dd2012-12-18 14:30:41 +00003051void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003052 llvm::MDNode *Back = nullptr;
3053 if (!LexicalBlockStack.empty())
3054 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003055 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003056 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003057 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003058}
3059
Eric Christopher0fdcb312013-05-16 00:52:20 +00003060void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3061 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003062 // Set our current location.
3063 setLocation(Loc);
3064
Guy Benyei11169dd2012-12-18 14:30:41 +00003065 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00003066 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3067 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00003068
Benjamin Kramer8c305922016-02-02 11:06:51 +00003069 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003070 return;
3071
3072 // Create a new lexical block and push it on the stack.
3073 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003074}
3075
Eric Christopher0fdcb312013-05-16 00:52:20 +00003076void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3077 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003078 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3079
3080 // Provide an entry in the line table for the end of the block.
3081 EmitLocation(Builder, Loc);
3082
Benjamin Kramer8c305922016-02-02 11:06:51 +00003083 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003084 return;
3085
Guy Benyei11169dd2012-12-18 14:30:41 +00003086 LexicalBlockStack.pop_back();
3087}
3088
Guy Benyei11169dd2012-12-18 14:30:41 +00003089void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
3090 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3091 unsigned RCount = FnBeginRegionCount.back();
3092 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3093
3094 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003095 while (LexicalBlockStack.size() != RCount) {
3096 // Provide an entry in the line table for the end of the block.
3097 EmitLocation(Builder, CurLoc);
3098 LexicalBlockStack.pop_back();
3099 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003100 FnBeginRegionCount.pop_back();
3101}
3102
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003103llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003104 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003105
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003106 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003107 QualType FType;
3108 uint64_t FieldSize, FieldOffset;
3109 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003110
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003111 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003112 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003113
3114 FieldOffset = 0;
3115 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3116 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3117 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3118 FType = CGM.getContext().IntTy;
3119 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3120 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3121
3122 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3123 if (HasCopyAndDispose) {
3124 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003125 EltTys.push_back(
3126 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3127 EltTys.push_back(
3128 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003129 }
3130 bool HasByrefExtendedLayout;
3131 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003132 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3133 HasByrefExtendedLayout) &&
3134 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003135 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003136 EltTys.push_back(
3137 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003138 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003139
Guy Benyei11169dd2012-12-18 14:30:41 +00003140 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3141 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003142 CGM.getTarget().getPointerAlign(0))) {
3143 CharUnits FieldOffsetInBytes =
3144 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003145 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003146 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003147
Guy Benyei11169dd2012-12-18 14:30:41 +00003148 if (NumPaddingBytes.isPositive()) {
3149 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3150 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3151 pad, ArrayType::Normal, 0);
3152 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3153 }
3154 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003155
Guy Benyei11169dd2012-12-18 14:30:41 +00003156 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003157 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003158 FieldSize = CGM.getContext().getTypeSize(FType);
3159 FieldAlign = CGM.getContext().toBits(Align);
3160
Eric Christopherb2a008c2013-05-16 00:45:12 +00003161 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003162 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
3163 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003164 EltTys.push_back(FieldTy);
3165 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003166
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003167 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003168
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003169 unsigned Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003170
Guy Benyei11169dd2012-12-18 14:30:41 +00003171 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003172 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003173}
3174
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003175void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3176 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00003177 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003178 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003179 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003180 if (VD->hasAttr<NoDebugAttr>())
3181 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003182
David Blaikie7fceebf2013-08-19 03:37:48 +00003183 bool Unwritten =
3184 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3185 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003186 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003187 if (!Unwritten)
3188 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003189 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003190 uint64_t XOffset = 0;
3191 if (VD->hasAttr<BlocksAttr>())
3192 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003193 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003194 Ty = getOrCreateType(VD->getType(), Unit);
3195
3196 // If there is no debug info for this type then do not emit debug info
3197 // for this variable.
3198 if (!Ty)
3199 return;
3200
Guy Benyei11169dd2012-12-18 14:30:41 +00003201 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003202 unsigned Line = 0;
3203 unsigned Column = 0;
3204 if (!Unwritten) {
3205 Line = getLineNumber(VD->getLocation());
3206 Column = getColumnNumber(VD->getLocation());
3207 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003208 SmallVector<int64_t, 9> Expr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003209 unsigned Flags = 0;
3210 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003211 Flags |= llvm::DINode::FlagArtificial;
Guy Benyei11169dd2012-12-18 14:30:41 +00003212 // If this is the first argument and it is implicit then
3213 // give it an object pointer flag.
3214 // FIXME: There has to be a better way to do this, but for static
3215 // functions there won't be an implicit param at arg1 and
3216 // otherwise it is 'self' or 'this'.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003217 if (isa<ImplicitParamDecl>(VD) && ArgNo && *ArgNo == 1)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003218 Flags |= llvm::DINode::FlagObjectPointer;
David Majnemer58ed0f32016-07-17 00:39:12 +00003219 if (auto *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00003220 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
3221 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003222 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00003223
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003224 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003225
3226 StringRef Name = VD->getName();
3227 if (!Name.empty()) {
3228 if (VD->hasAttr<BlocksAttr>()) {
3229 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003230 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003231 // offset of __forwarding field
3232 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003233 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003234 Expr.push_back(offset.getQuantity());
3235 Expr.push_back(llvm::dwarf::DW_OP_deref);
3236 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003237 // offset of x field
3238 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003239 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003240
3241 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003242 auto *D = ArgNo
3243 ? DBuilder.createParameterVariable(Scope, VD->getName(),
3244 *ArgNo, Unit, Line, Ty)
3245 : DBuilder.createAutoVariable(Scope, VD->getName(), Unit,
3246 Line, Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003247
Guy Benyei11169dd2012-12-18 14:30:41 +00003248 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003249 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3250 llvm::DebugLoc::get(Line, Column, Scope),
3251 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003252 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00003253 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003254 Expr.push_back(llvm::dwarf::DW_OP_deref);
David Majnemer58ed0f32016-07-17 00:39:12 +00003255 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003256 // If VD is an anonymous union then Storage represents value for
3257 // all union fields.
David Majnemer58ed0f32016-07-17 00:39:12 +00003258 const auto *RD = cast<RecordDecl>(RT->getDecl());
Adrian Prantl0d820892015-04-29 15:05:50 +00003259 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003260 // GDB has trouble finding local variables in anonymous unions, so we emit
3261 // artifical local variables for each of the members.
3262 //
3263 // FIXME: Remove this code as soon as GDB supports this.
3264 // The debug info verifier in LLVM operates based on the assumption that a
3265 // variable has the same size as its storage and we had to disable the check
3266 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003267 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003268 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003269 StringRef FieldName = Field->getName();
3270
3271 // Ignore unnamed fields. Do not ignore unnamed records.
3272 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3273 continue;
3274
3275 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003276 auto *D = DBuilder.createAutoVariable(
3277 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3278 Flags | llvm::DINode::FlagArtificial);
Adrian Prantl0d820892015-04-29 15:05:50 +00003279
3280 // Insert an llvm.dbg.declare into the current block.
3281 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3282 llvm::DebugLoc::get(Line, Column, Scope),
3283 Builder.GetInsertBlock());
3284 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003285 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003286 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003287
3288 // Create the descriptor for the variable.
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003289 auto *D =
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003290 ArgNo
3291 ? DBuilder.createParameterVariable(Scope, Name, *ArgNo, Unit, Line,
3292 Ty, CGM.getLangOpts().Optimize,
3293 Flags)
3294 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3295 CGM.getLangOpts().Optimize, Flags);
David Blaikiea76a7c92013-01-05 05:58:35 +00003296
3297 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003298 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3299 llvm::DebugLoc::get(Line, Column, Scope),
3300 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003301}
3302
3303void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3304 llvm::Value *Storage,
3305 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003306 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003307 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003308}
3309
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003310llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3311 llvm::DIType *Ty) {
3312 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003313 if (CachedTy)
3314 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003315 return DBuilder.createObjectPointerType(Ty);
3316}
3317
Eric Christophere7b87e52014-10-26 23:40:33 +00003318void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3319 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003320 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003321 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003322 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003323
Craig Topper8a13c412014-05-21 05:09:00 +00003324 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003325 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003326 if (VD->hasAttr<NoDebugAttr>())
3327 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003328
Guy Benyei11169dd2012-12-18 14:30:41 +00003329 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003330
Guy Benyei11169dd2012-12-18 14:30:41 +00003331 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003332 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3333 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003334 if (isByRef)
3335 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003336 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003337 Ty = getOrCreateType(VD->getType(), Unit);
3338
3339 // Self is passed along as an implicit non-arg variable in a
3340 // block. Mark it as the object pointer.
3341 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00003342 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003343
3344 // Get location information.
3345 unsigned Line = getLineNumber(VD->getLocation());
3346 unsigned Column = getColumnNumber(VD->getLocation());
3347
3348 const llvm::DataLayout &target = CGM.getDataLayout();
3349
3350 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003351 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003352 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3353
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003354 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00003355 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003356 addr.push_back(llvm::dwarf::DW_OP_deref);
3357 addr.push_back(llvm::dwarf::DW_OP_plus);
3358 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003359 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003360 addr.push_back(llvm::dwarf::DW_OP_deref);
3361 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003362 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003363 offset =
3364 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003365 addr.push_back(offset.getQuantity());
3366 addr.push_back(llvm::dwarf::DW_OP_deref);
3367 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003368 // offset of x field
3369 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003370 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003371 }
3372
3373 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003374 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003375 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003376 Line, Ty);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003377
Guy Benyei11169dd2012-12-18 14:30:41 +00003378 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003379 auto DL = llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back());
3380 if (InsertPoint)
3381 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3382 InsertPoint);
3383 else
3384 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3385 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003386}
3387
Guy Benyei11169dd2012-12-18 14:30:41 +00003388void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3389 unsigned ArgNo,
3390 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003391 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003392 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003393}
3394
3395namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003396struct BlockLayoutChunk {
3397 uint64_t OffsetInBits;
3398 const BlockDecl::Capture *Capture;
3399};
3400bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3401 return l.OffsetInBits < r.OffsetInBits;
3402}
Guy Benyei11169dd2012-12-18 14:30:41 +00003403}
3404
3405void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003406 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003407 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003408 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003409 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003410 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003411 ASTContext &C = CGM.getContext();
3412 const BlockDecl *blockDecl = block.getBlockDecl();
3413
3414 // Collect some general information about the block's location.
3415 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003416 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003417 unsigned line = getLineNumber(loc);
3418 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003419
Guy Benyei11169dd2012-12-18 14:30:41 +00003420 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003421 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003422
3423 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003424 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003425
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003426 SmallVector<llvm::Metadata *, 16> fields;
David Majnemerb4b671e2016-06-30 03:01:59 +00003427 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003428 blockLayout->getElementOffsetInBits(0),
3429 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003430 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003431 blockLayout->getElementOffsetInBits(1),
3432 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003433 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003434 blockLayout->getElementOffsetInBits(2),
3435 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003436 auto *FnTy = block.getBlockExpr()->getFunctionType();
3437 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
David Majnemerb4b671e2016-06-30 03:01:59 +00003438 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003439 blockLayout->getElementOffsetInBits(3),
3440 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003441 fields.push_back(createFieldType(
3442 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3443 ? C.getBlockDescriptorExtendedType()
3444 : C.getBlockDescriptorType()),
David Majnemerb4b671e2016-06-30 03:01:59 +00003445 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003446
3447 // We want to sort the captures by offset, not because DWARF
3448 // requires this, but because we're paranoid about debuggers.
3449 SmallVector<BlockLayoutChunk, 8> chunks;
3450
3451 // 'this' capture.
3452 if (blockDecl->capturesCXXThis()) {
3453 BlockLayoutChunk chunk;
3454 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003455 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003456 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003457 chunks.push_back(chunk);
3458 }
3459
3460 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003461 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003462 const VarDecl *variable = capture.getVariable();
3463 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3464
3465 // Ignore constant captures.
3466 if (captureInfo.isConstant())
3467 continue;
3468
3469 BlockLayoutChunk chunk;
3470 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003471 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003472 chunk.Capture = &capture;
3473 chunks.push_back(chunk);
3474 }
3475
3476 // Sort by offset.
3477 llvm::array_pod_sort(chunks.begin(), chunks.end());
3478
David Majnemer58ed0f32016-07-17 00:39:12 +00003479 for (const BlockLayoutChunk &Chunk : chunks) {
3480 uint64_t offsetInBits = Chunk.OffsetInBits;
3481 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00003482
3483 // If we have a null capture, this must be the C++ 'this' capture.
3484 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003485 QualType type;
3486 if (auto *Method =
3487 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3488 type = Method->getThisType(C);
3489 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3490 type = QualType(RDecl->getTypeForDecl(), 0);
3491 else
3492 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003493
David Majnemerb4b671e2016-06-30 03:01:59 +00003494 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003495 offsetInBits, tunit, tunit));
3496 continue;
3497 }
3498
3499 const VarDecl *variable = capture->getVariable();
3500 StringRef name = variable->getName();
3501
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003502 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003503 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003504 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003505
3506 // FIXME: this creates a second copy of this type!
3507 uint64_t xoffset;
3508 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003509 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3510 fieldType =
3511 DBuilder.createMemberType(tunit, name, tunit, line, PtrInfo.Width,
3512 PtrInfo.Align, offsetInBits, 0, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003513 } else {
David Majnemerb4b671e2016-06-30 03:01:59 +00003514 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Eric Christophere7b87e52014-10-26 23:40:33 +00003515 offsetInBits, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003516 }
3517 fields.push_back(fieldType);
3518 }
3519
3520 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003521 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3522 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003523
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003524 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003525
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003526 llvm::DIType *type = DBuilder.createStructType(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003527 tunit, typeName.str(), tunit, line,
3528 CGM.getContext().toBits(block.BlockSize),
3529 CGM.getContext().toBits(block.BlockAlign), 0, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003530 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3531
3532 // Get overall information about the block.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003533 unsigned flags = llvm::DINode::FlagArtificial;
3534 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003535
3536 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003537 auto *debugVar = DBuilder.createParameterVariable(
3538 scope, Arg->getName(), ArgNo, tunit, line, type,
3539 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003540
Adrian Prantl616bef42013-03-14 21:52:59 +00003541 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003542 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003543 DBuilder.insertDbgValueIntrinsic(
Eric Christophere7b87e52014-10-26 23:40:33 +00003544 LocalAddr, 0, debugVar, DBuilder.createExpression(),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003545 llvm::DebugLoc::get(line, column, scope), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003546 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003547
Adrian Prantl616bef42013-03-14 21:52:59 +00003548 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003549 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
3550 llvm::DebugLoc::get(line, column, scope),
3551 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003552}
3553
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003554llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003555CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3556 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003557 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003558
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003559 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003560 if (MI != StaticDataMemberCache.end()) {
3561 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003562 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003563 }
David Blaikiece763042013-08-20 21:49:21 +00003564
3565 // If the member wasn't found in the cache, lazily construct and add it to the
3566 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003567 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003568 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003569 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003570}
3571
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003572llvm::DIGlobalVariable *CGDebugInfo::CollectAnonRecordDecls(
3573 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3574 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
3575 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003576
3577 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003578 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003579 StringRef FieldName = Field->getName();
3580
3581 // Ignore unnamed fields, but recurse into anonymous records.
3582 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003583 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Eric Christophercab9fae2014-04-10 05:20:00 +00003584 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3585 Var, DContext);
3586 continue;
3587 }
3588 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003589 GV = DBuilder.createGlobalVariable(DContext, FieldName, LinkageName, Unit,
3590 LineNo, FieldTy,
David Majnemer36a6e002016-07-06 21:07:53 +00003591 Var->hasLocalLinkage(), Var, nullptr);
Eric Christophercab9fae2014-04-10 05:20:00 +00003592 }
3593 return GV;
3594}
3595
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003596void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003597 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003598 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003599 if (D->hasAttr<NoDebugAttr>())
3600 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003601 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003602 llvm::DIFile *Unit = nullptr;
3603 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003604 unsigned LineNo;
3605 StringRef DeclName, LinkageName;
3606 QualType T;
3607 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003608
3609 // Attempt to store one global variable for the declaration - even if we
3610 // emit a lot of fields.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003611 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003612
3613 // If this is an anonymous union then we'll want to emit a global
3614 // variable for each member of the anonymous union so that it's possible
3615 // to find the name of any field in the union.
3616 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003617 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003618 assert(RD->isAnonymousStructOrUnion() &&
3619 "unnamed non-anonymous struct or union?");
Eric Christophercab9fae2014-04-10 05:20:00 +00003620 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3621 } else {
David Blaikie7550b112014-10-20 17:42:23 +00003622 GV = DBuilder.createGlobalVariable(
Eric Christophercab9fae2014-04-10 05:20:00 +00003623 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
David Majnemer36a6e002016-07-06 21:07:53 +00003624 Var->hasLocalLinkage(), Var,
Eric Christophercab9fae2014-04-10 05:20:00 +00003625 getOrCreateStaticDataMemberDeclarationOrNull(D));
3626 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003627 DeclCache[D->getCanonicalDecl()].reset(GV);
Guy Benyei11169dd2012-12-18 14:30:41 +00003628}
3629
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003630void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3631 llvm::Constant *Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003632 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003633 if (VD->hasAttr<NoDebugAttr>())
3634 return;
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003635 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003636 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003637 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003638 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00003639 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3640 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003641 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3642 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3643 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003644 // Do not use global variables for enums.
3645 //
3646 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003647 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003648 return;
David Blaikiea15565562014-04-04 20:56:17 +00003649 // Do not emit separate definitions for function local const/statics.
3650 if (isa<FunctionDecl>(VD->getDeclContext()))
3651 return;
David Blaikiebb113912014-04-05 07:23:17 +00003652 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003653 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003654 if (VarD->isStaticDataMember()) {
3655 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003656 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003657 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00003658 //
3659 // FIXME: This is probably unnecessary, since Ty should reference RD
3660 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00003661 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003662 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003663 return;
3664 }
3665
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003666 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003667
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003668 auto &GV = DeclCache[VD];
3669 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003670 return;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003671 GV.reset(DBuilder.createGlobalVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003672 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003673 true, Init, getOrCreateStaticDataMemberDeclarationOrNull(VarD)));
David Blaikiebd483762013-05-20 04:58:53 +00003674}
3675
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003676llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003677 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003678 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003679 llvm::DIScope *Mod = getParentModuleOrNull(D);
3680 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003681}
3682
David Blaikie9f88fe82013-04-22 06:13:21 +00003683void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003684 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003685 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003686 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00003687 if (!NSDecl->isAnonymousNamespace() ||
3688 CGM.getCodeGenOpts().DebugExplicitImport) {
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003689 DBuilder.createImportedModule(
3690 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3691 getOrCreateNameSpace(NSDecl),
3692 getLineNumber(UD.getLocation()));
3693 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003694}
3695
David Blaikiebd483762013-05-20 04:58:53 +00003696void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003697 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003698 return;
3699 assert(UD.shadow_size() &&
3700 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3701 // Emitting one decl is sufficient - debuggers can detect that this is an
3702 // overloaded name & provide lookup for all the overloads.
3703 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00003704
3705 // FIXME: Skip functions with undeduced auto return type for now since we
3706 // don't currently have the plumbing for separate declarations & definitions
3707 // of free functions and mismatched types (auto in the declaration, concrete
3708 // return type in the definition)
3709 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
3710 if (const auto *AT =
3711 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
3712 if (AT->getDeducedType().isNull())
3713 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003714 if (llvm::DINode *Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003715 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003716 DBuilder.createImportedDeclaration(
3717 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3718 getLineNumber(USD.getLocation()));
3719}
3720
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003721void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00003722 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
3723 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00003724 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00003725 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl8a634c12015-12-18 19:44:31 +00003726 DBuilder.createImportedDeclaration(
3727 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
3728 getOrCreateModuleRef(Info, DebugTypeExtRefs),
3729 getLineNumber(ID.getLocation()));
3730 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003731}
3732
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003733llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00003734CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003735 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003736 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003737 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003738 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003739 return cast<llvm::DIImportedEntity>(VH);
3740 llvm::DIImportedEntity *R;
David Majnemer58ed0f32016-07-17 00:39:12 +00003741 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00003742 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3743 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003744 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003745 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3746 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3747 NA.getName());
3748 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003749 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003750 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3751 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3752 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003753 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003754 return R;
3755}
3756
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003757llvm::DINamespace *
Guy Benyei11169dd2012-12-18 14:30:41 +00003758CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003759 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003760 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003761 if (I != NameSpaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003762 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003763
Guy Benyei11169dd2012-12-18 14:30:41 +00003764 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003765 llvm::DIFile *FileD = getOrCreateFile(NSDecl->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003766 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003767 llvm::DINamespace *NS =
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003768 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003769 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003770 return NS;
3771}
3772
Adrian Prantla5206ce2015-09-22 23:26:43 +00003773void CGDebugInfo::setDwoId(uint64_t Signature) {
3774 assert(TheCU && "no main compile unit");
3775 TheCU->setDWOId(Signature);
3776}
3777
3778
Guy Benyei11169dd2012-12-18 14:30:41 +00003779void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003780 // Creating types might create further types - invalidating the current
3781 // element and the size(), so don't cache/reference them.
3782 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3783 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003784 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00003785 ? CreateTypeDefinition(E.Type, E.Unit)
3786 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003787 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00003788 }
3789
David Blaikief427b002014-05-06 03:42:01 +00003790 for (auto p : ReplaceMap) {
3791 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003792 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003793 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003794
David Blaikief427b002014-05-06 03:42:01 +00003795 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003796 assert(it != TypeCache.end());
3797 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003798
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003799 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
3800 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00003801 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003802
Frederic Rissd253ed62014-11-18 03:40:51 +00003803 for (const auto &p : FwdDeclReplaceMap) {
3804 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003805 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003806 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003807
3808 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003809 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003810 // with ourselves, that will destroy the temporary MDNode and
3811 // replace it with a standard one, avoiding leaking memory.
3812 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003813 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003814 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003815 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003816
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003817 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00003818 }
3819
Adrian Prantl73409ce2013-03-11 18:33:46 +00003820 // We keep our own list of retained types, because we need to look
3821 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00003822 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00003823 if (auto MD = TypeCache[RT])
3824 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003825
Guy Benyei11169dd2012-12-18 14:30:41 +00003826 DBuilder.finalize();
3827}
David Blaikie66088d52014-09-24 17:01:27 +00003828
3829void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003830 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00003831 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003832
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003833 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003834 // Don't ignore in case of explicit cast where it is referenced indirectly.
3835 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003836}