blob: c9aa04815f19635ded3a35a4a3c496dbc59a67b9 [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This coordinates the debug information generation while generating code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGDebugInfo.h"
15#include "CGBlocks.h"
David Blaikie38079fd2013-05-10 21:53:14 +000016#include "CGCXXABI.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000017#include "CGObjCRuntime.h"
Bob Haarmandff36732016-10-25 22:19:32 +000018#include "CGRecordLayout.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000019#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"
Bob Haarmandff36732016-10-25 22:19:32 +000034#include "llvm/ADT/DenseSet.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000035#include "llvm/ADT/SmallVector.h"
36#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000037#include "llvm/IR/Constants.h"
38#include "llvm/IR/DataLayout.h"
39#include "llvm/IR/DerivedTypes.h"
40#include "llvm/IR/Instructions.h"
41#include "llvm/IR/Intrinsics.h"
42#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000043#include "llvm/Support/FileSystem.h"
Amjad Aboude2aab8c2016-12-25 10:12:27 +000044#include "llvm/Support/MD5.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000045#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000046using namespace clang;
47using namespace clang::CodeGen;
48
Victor Leschuka7ece032016-10-20 00:13:19 +000049static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
50 auto TI = Ctx.getTypeInfo(Ty);
51 return TI.AlignIsRequired ? TI.Align : 0;
52}
53
54static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
55 return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
56}
57
58static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
59 return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
60}
61
Guy Benyei11169dd2012-12-18 14:30:41 +000062CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000063 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
Adrian Prantl6b21ab22015-08-27 19:46:20 +000064 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
Eric Christopher324bbbd2013-07-14 21:12:44 +000065 DBuilder(CGM.getModule()) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000066 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
67 DebugPrefixMap[KV.first] = KV.second;
Guy Benyei11169dd2012-12-18 14:30:41 +000068 CreateCompileUnit();
69}
70
71CGDebugInfo::~CGDebugInfo() {
72 assert(LexicalBlockStack.empty() &&
73 "Region stack mismatch, stack not empty!");
74}
75
David Blaikie66e41972015-01-14 07:38:27 +000076ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
David Blaikie835afb22015-01-21 23:08:17 +000077 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000078 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +000079 init(TemporaryLocation);
80}
81
Adrian Prantl39428e72015-02-03 18:40:42 +000082ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000083 bool DefaultToEmpty,
Adrian Prantl39428e72015-02-03 18:40:42 +000084 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000085 : CGF(&CGF) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000086 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000087}
88
89void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Adrian Prantl95b24e92015-02-03 20:00:54 +000090 bool DefaultToEmpty) {
David Blaikied7057d92015-08-12 23:49:57 +000091 auto *DI = CGF->getDebugInfo();
92 if (!DI) {
93 CGF = nullptr;
94 return;
David Blaikie66e41972015-01-14 07:38:27 +000095 }
David Blaikied7057d92015-08-12 23:49:57 +000096
97 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
98 if (TemporaryLocation.isValid()) {
99 DI->EmitLocation(CGF->Builder, TemporaryLocation);
100 return;
101 }
102
103 if (DefaultToEmpty) {
104 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
105 return;
106 }
107
108 // Construct a location that has a valid scope, but no line info.
109 assert(!DI->LexicalBlockStack.empty());
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000110 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
111 0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000112}
113
David Blaikie9b479662015-01-25 01:19:10 +0000114ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
David Blaikied7057d92015-08-12 23:49:57 +0000115 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +0000116 init(E->getExprLoc());
117}
118
David Blaikie66e41972015-01-14 07:38:27 +0000119ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
David Blaikied7057d92015-08-12 23:49:57 +0000120 : CGF(&CGF) {
121 if (!CGF.getDebugInfo()) {
122 this->CGF = nullptr;
123 return;
David Blaikie66e41972015-01-14 07:38:27 +0000124 }
David Blaikied7057d92015-08-12 23:49:57 +0000125 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
126 if (Loc)
127 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +0000128}
129
130ApplyDebugLocation::~ApplyDebugLocation() {
131 // Query CGF so the location isn't overwritten when location updates are
132 // temporarily disabled (for C++ default function arguments)
David Blaikied7057d92015-08-12 23:49:57 +0000133 if (CGF)
134 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000135}
136
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000137ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
138 GlobalDecl InlinedFn)
139 : CGF(&CGF) {
140 if (!CGF.getDebugInfo()) {
141 this->CGF = nullptr;
142 return;
143 }
144 auto &DI = *CGF.getDebugInfo();
145 SavedLocation = DI.getLocation();
146 assert((DI.getInlinedAt() ==
147 CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
148 "CGDebugInfo and IRBuilder are out of sync");
149
150 DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
151}
152
153ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
154 if (!CGF)
155 return;
156 auto &DI = *CGF->getDebugInfo();
157 DI.EmitInlineFunctionEnd(CGF->Builder);
158 DI.EmitLocation(CGF->Builder, SavedLocation);
159}
160
Guy Benyei11169dd2012-12-18 14:30:41 +0000161void CGDebugInfo::setLocation(SourceLocation Loc) {
162 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000163 if (Loc.isInvalid())
164 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000165
166 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
167
168 // If we've changed files in the middle of a lexical scope go ahead
169 // and create a new lexical scope with file node if it's different
170 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000171 if (LexicalBlockStack.empty())
172 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000173
174 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000175 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000176 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000177
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000178 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000179 return;
180
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000181 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000182 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000183 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
184 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000185 } else if (isa<llvm::DILexicalBlock>(Scope) ||
186 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000187 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000188 LexicalBlockStack.emplace_back(
189 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000190 }
191}
192
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000193llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000194 llvm::DIScope *Mod = getParentModuleOrNull(D);
195 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
196 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000197}
198
199llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
200 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000201 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000202 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000203
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000204 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000205 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000206 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000207 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000208 }
209
210 // Check namespace.
Adrian Prantlddb8e062017-05-12 16:23:53 +0000211 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
212 return getOrCreateNamespace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000213
David Majnemer58ed0f32016-07-17 00:39:12 +0000214 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000215 if (!RDecl->isDependentType())
216 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000217 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000218 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000219}
220
Guy Benyei11169dd2012-12-18 14:30:41 +0000221StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000222 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000223 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000224 FunctionTemplateSpecializationInfo *Info =
225 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000226
Reid Kleckner31abd802016-06-30 17:41:31 +0000227 // Emit the unqualified name in normal operation. LLVM and the debugger can
228 // compute the fully qualified name from the scope chain. If we're only
229 // emitting line table info, there won't be any scope chains, so emit the
230 // fully qualified name here so that stack traces are more accurate.
231 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
232 // evaluating the size impact.
233 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
234 CGM.getCodeGenOpts().EmitCodeView;
235
236 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000237 return FII->getName();
238
Benjamin Kramer9170e912013-02-22 15:46:01 +0000239 SmallString<128> NS;
240 llvm::raw_svector_ostream OS(NS);
Reid Kleckner60103382015-12-16 02:04:40 +0000241 PrintingPolicy Policy(CGM.getLangOpts());
Reid Kleckner829398e2016-06-17 16:11:20 +0000242 Policy.MSVCFormatting = CGM.getCodeGenOpts().EmitCodeView;
Reid Kleckner31abd802016-06-30 17:41:31 +0000243 if (!UseQualifiedName)
244 FD->printName(OS);
245 else
246 FD->printQualifiedName(OS, Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000247
Reid Kleckner829398e2016-06-17 16:11:20 +0000248 // Add any template specialization args.
249 if (Info) {
250 const TemplateArgumentList *TArgs = Info->TemplateArguments;
David Majnemer6fbeee32016-07-07 04:43:07 +0000251 TemplateSpecializationType::PrintTemplateArgumentList(OS, TArgs->asArray(),
Reid Kleckner829398e2016-06-17 16:11:20 +0000252 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000253 }
254
255 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000256 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000257}
258
259StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
260 SmallString<256> MethodName;
261 llvm::raw_svector_ostream OS(MethodName);
262 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
263 const DeclContext *DC = OMD->getDeclContext();
David Majnemer58ed0f32016-07-17 00:39:12 +0000264 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000265 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000266 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000267 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000268 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000269 if (OC->IsClassExtension()) {
270 OS << OC->getClassInterface()->getName();
271 } else {
David Majnemer58ed0f32016-07-17 00:39:12 +0000272 OS << OC->getIdentifier()->getNameStart() << '('
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000273 << OC->getIdentifier()->getNameStart() << ')';
274 }
David Majnemer58ed0f32016-07-17 00:39:12 +0000275 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
Argyrios Kyrtzidisa166a2b2017-03-07 09:26:07 +0000276 OS << OCD->getClassInterface()->getName() << '('
277 << OCD->getName() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000278 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000279 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000280 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000281 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000282 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000283 ClassTy.print(OS, PrintingPolicy(LangOptions()));
284 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000285 }
286 OS << ' ' << OMD->getSelector().getAsString() << ']';
287
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000288 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000289}
290
Guy Benyei11169dd2012-12-18 14:30:41 +0000291StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000292 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000293}
294
Eric Christophere7b87e52014-10-26 23:40:33 +0000295StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000296 if (isa<ClassTemplateSpecializationDecl>(RD)) {
297 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000298 llvm::raw_svector_ostream OS(Name);
299 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
300 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000301
302 // Copy this name on the side and use its reference.
303 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000304 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000305
David Majnemerbc5976a2016-07-01 23:12:54 +0000306 // quick optimization to avoid having to intern strings that are already
307 // stored reliably elsewhere
308 if (const IdentifierInfo *II = RD->getIdentifier())
309 return II->getName();
310
311 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
312 // used to reconstruct the fully qualified type names.
313 if (CGM.getCodeGenOpts().EmitCodeView) {
314 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
315 assert(RD->getDeclContext() == D->getDeclContext() &&
316 "Typedef should not be in another decl context!");
317 assert(D->getDeclName().getAsIdentifierInfo() &&
318 "Typedef was not named!");
319 return D->getDeclName().getAsIdentifierInfo()->getName();
320 }
321
322 if (CGM.getLangOpts().CPlusPlus) {
323 StringRef Name;
324
325 ASTContext &Context = CGM.getContext();
326 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
327 // Anonymous types without a name for linkage purposes have their
328 // declarator mangled in if they have one.
329 Name = DD->getName();
330 else if (const TypedefNameDecl *TND =
331 Context.getTypedefNameForUnnamedTagDecl(RD))
332 // Anonymous types without a name for linkage purposes have their
333 // associate typedef mangled in if they have one.
334 Name = TND->getName();
335
336 if (!Name.empty()) {
337 SmallString<256> UnnamedType("<unnamed-type-");
338 UnnamedType += Name;
339 UnnamedType += '>';
340 return internString(UnnamedType);
341 }
342 }
343 }
344
345 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000346}
347
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000348llvm::DIFile::ChecksumKind
349CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
350 Checksum.clear();
351
352 if (!CGM.getCodeGenOpts().EmitCodeView)
353 return llvm::DIFile::CSK_None;
354
355 SourceManager &SM = CGM.getContext().getSourceManager();
356 bool Invalid;
357 llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
358 if (Invalid)
359 return llvm::DIFile::CSK_None;
360
361 llvm::MD5 Hash;
362 llvm::MD5::MD5Result Result;
363
364 Hash.update(MemBuffer->getBuffer());
365 Hash.final(Result);
366
367 Hash.stringifyResult(Result, Checksum);
368 return llvm::DIFile::CSK_MD5;
369}
370
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000371llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000372 if (!Loc.isValid())
373 // If Location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000374 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000375 remapDIPath(TheCU->getDirectory()),
376 TheCU->getFile()->getChecksumKind(),
377 TheCU->getFile()->getChecksum());
Guy Benyei11169dd2012-12-18 14:30:41 +0000378
379 SourceManager &SM = CGM.getContext().getSourceManager();
380 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
381
382 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
383 // If the location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000384 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000385 remapDIPath(TheCU->getDirectory()),
386 TheCU->getFile()->getChecksumKind(),
387 TheCU->getFile()->getChecksum());
Guy Benyei11169dd2012-12-18 14:30:41 +0000388
389 // Cache the results.
390 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000391 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000392
393 if (it != DIFileCache.end()) {
394 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000395 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000396 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000397 }
398
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000399 SmallString<32> Checksum;
400 llvm::DIFile::ChecksumKind CSKind =
401 computeChecksum(SM.getFileID(Loc), Checksum);
402
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000403 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000404 remapDIPath(getCurrentDirname()),
405 CSKind, Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000406
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000407 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000408 return F;
409}
410
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000411llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000412 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000413 remapDIPath(TheCU->getDirectory()),
414 TheCU->getFile()->getChecksumKind(),
415 TheCU->getFile()->getChecksum());
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000416}
417
418std::string CGDebugInfo::remapDIPath(StringRef Path) const {
419 for (const auto &Entry : DebugPrefixMap)
420 if (Path.startswith(Entry.first))
421 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
422 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000423}
424
Guy Benyei11169dd2012-12-18 14:30:41 +0000425unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
426 if (Loc.isInvalid() && CurLoc.isInvalid())
427 return 0;
428 SourceManager &SM = CGM.getContext().getSourceManager();
429 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000430 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000431}
432
Adrian Prantlc7822422013-03-12 20:43:25 +0000433unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000434 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000435 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 return 0;
437
438 // If the location is invalid then use the current column.
439 if (Loc.isInvalid() && CurLoc.isInvalid())
440 return 0;
441 SourceManager &SM = CGM.getContext().getSourceManager();
442 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000443 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000444}
445
446StringRef CGDebugInfo::getCurrentDirname() {
447 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
448 return CGM.getCodeGenOpts().DebugCompilationDir;
449
450 if (!CWDName.empty())
451 return CWDName;
452 SmallString<256> CWD;
453 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000454 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000455}
456
Guy Benyei11169dd2012-12-18 14:30:41 +0000457void CGDebugInfo::CreateCompileUnit() {
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000458 SmallString<32> Checksum;
459 llvm::DIFile::ChecksumKind CSKind = llvm::DIFile::CSK_None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000460
David Blaikieaabde052014-05-14 00:29:00 +0000461 // Should we be asking the SourceManager for the main file name, instead of
462 // accepting it as an argument? This just causes the main file name to
463 // mismatch with source locations and create extra lexical scopes or
464 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
465 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
466 // because that's what the SourceManager says)
467
Guy Benyei11169dd2012-12-18 14:30:41 +0000468 // Get absolute path name.
469 SourceManager &SM = CGM.getContext().getSourceManager();
470 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
471 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000472 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000473
474 // The main file name provided via the "-main-file-name" option contains just
475 // the file name itself with no path information. This file name may have had
476 // a relative path, so we look into the actual file entry for the main
477 // file to determine the real absolute path for the file.
478 std::string MainFileDir;
479 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000480 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000481 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000482 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
483 llvm::sys::path::append(MainFileDirSS, MainFileName);
484 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000485 }
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000486 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000487 }
488
Ed Masteda706022014-05-07 12:49:30 +0000489 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000490 const LangOptions &LO = CGM.getLangOpts();
491 if (LO.CPlusPlus) {
492 if (LO.ObjC1)
493 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
494 else
495 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
496 } else if (LO.ObjC1) {
497 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000498 } else if (LO.RenderScript) {
499 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000500 } else if (LO.C99) {
501 LangTag = llvm::dwarf::DW_LANG_C99;
502 } else {
503 LangTag = llvm::dwarf::DW_LANG_C89;
504 }
505
506 std::string Producer = getClangFullVersion();
507
508 // Figure out which version of the ObjC runtime we have.
509 unsigned RuntimeVers = 0;
510 if (LO.ObjC1)
511 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
512
Adrian Prantl826824e2016-04-08 22:43:06 +0000513 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
514 switch (DebugKind) {
515 case codegenoptions::NoDebugInfo:
516 case codegenoptions::LocTrackingOnly:
517 EmissionKind = llvm::DICompileUnit::NoDebug;
518 break;
519 case codegenoptions::DebugLineTablesOnly:
520 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
521 break;
522 case codegenoptions::LimitedDebugInfo:
523 case codegenoptions::FullDebugInfo:
524 EmissionKind = llvm::DICompileUnit::FullDebug;
525 break;
526 }
527
Guy Benyei11169dd2012-12-18 14:30:41 +0000528 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000529 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000530 TheCU = DBuilder.createCompileUnit(
David Blaikie81503552017-04-21 23:35:36 +0000531 LangTag,
532 DBuilder.createFile(remapDIPath(MainFileName),
533 remapDIPath(getCurrentDirname()), CSKind, Checksum),
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000534 Producer, LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers,
David Blaikie81503552017-04-21 23:35:36 +0000535 CGM.getCodeGenOpts().EnableSplitDwarf
536 ? ""
537 : CGM.getCodeGenOpts().SplitDwarfFile,
538 EmissionKind, 0 /* DWOid */, CGM.getCodeGenOpts().SplitDwarfInlining,
Dehao Chen5a3f8902017-02-01 22:45:21 +0000539 CGM.getCodeGenOpts().DebugInfoForProfiling);
Guy Benyei11169dd2012-12-18 14:30:41 +0000540}
541
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000542llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000543 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000544 StringRef BTName;
545 switch (BT->getKind()) {
546#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000547#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000548#include "clang/AST/BuiltinTypes.def"
549 case BuiltinType::Dependent:
550 llvm_unreachable("Unexpected builtin type");
551 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000552 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000553 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000554 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000555 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000556 if (!ClassTy)
557 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
558 "objc_class", TheCU,
559 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000560 return ClassTy;
561 case BuiltinType::ObjCId: {
562 // typedef struct objc_class *Class;
563 // typedef struct objc_object {
564 // Class isa;
565 // } *id;
566
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000567 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000568 return ObjTy;
569
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000570 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000571 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
572 "objc_class", TheCU,
573 getOrCreateMainFile(), 0);
574
575 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000576
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000577 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000578
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000579 ObjTy = DBuilder.createStructType(
580 TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
581 llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000582
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000583 DBuilder.replaceArrays(
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000584 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
585 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
586 llvm::DINode::FlagZero, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000587 return ObjTy;
588 }
589 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000590 if (!SelTy)
591 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
592 "objc_selector", TheCU,
593 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000594 return SelTy;
595 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000596
Alexey Bader954ba212016-04-08 13:40:33 +0000597#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
598 case BuiltinType::Id: \
599 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
600 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000601#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000602 case BuiltinType::OCLSampler:
Yaxun Liu0bc4b2d2016-07-28 19:26:30 +0000603 return getOrCreateStructPtrType("opencl_sampler_t",
604 OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000605 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000606 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000607 case BuiltinType::OCLClkEvent:
608 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
609 case BuiltinType::OCLQueue:
610 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000611 case BuiltinType::OCLReserveID:
612 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000613
Guy Benyei11169dd2012-12-18 14:30:41 +0000614 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000615 case BuiltinType::Char_U:
616 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
617 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000618 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000619 case BuiltinType::SChar:
620 Encoding = llvm::dwarf::DW_ATE_signed_char;
621 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000622 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000623 case BuiltinType::Char32:
624 Encoding = llvm::dwarf::DW_ATE_UTF;
625 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000626 case BuiltinType::UShort:
627 case BuiltinType::UInt:
628 case BuiltinType::UInt128:
629 case BuiltinType::ULong:
630 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000631 case BuiltinType::ULongLong:
632 Encoding = llvm::dwarf::DW_ATE_unsigned;
633 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000634 case BuiltinType::Short:
635 case BuiltinType::Int:
636 case BuiltinType::Int128:
637 case BuiltinType::Long:
638 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000639 case BuiltinType::LongLong:
640 Encoding = llvm::dwarf::DW_ATE_signed;
641 break;
642 case BuiltinType::Bool:
643 Encoding = llvm::dwarf::DW_ATE_boolean;
644 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000645 case BuiltinType::Half:
646 case BuiltinType::Float:
647 case BuiltinType::LongDouble:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000648 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000649 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000650 // FIXME: For targets where long double and __float128 have the same size,
651 // they are currently indistinguishable in the debugger without some
652 // special treatment. However, there is currently no consensus on encoding
653 // and this should be updated once a DWARF encoding exists for distinct
654 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000655 Encoding = llvm::dwarf::DW_ATE_float;
656 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000657 }
658
659 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000660 case BuiltinType::Long:
661 BTName = "long int";
662 break;
663 case BuiltinType::LongLong:
664 BTName = "long long int";
665 break;
666 case BuiltinType::ULong:
667 BTName = "long unsigned int";
668 break;
669 case BuiltinType::ULongLong:
670 BTName = "long long unsigned int";
671 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000672 default:
673 BTName = BT->getName(CGM.getLangOpts());
674 break;
675 }
Victor Leschuka7ece032016-10-20 00:13:19 +0000676 // Bit size and offset of the type.
Guy Benyei11169dd2012-12-18 14:30:41 +0000677 uint64_t Size = CGM.getContext().getTypeSize(BT);
Victor Leschuka7ece032016-10-20 00:13:19 +0000678 return DBuilder.createBasicType(BTName, Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000679}
680
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000681llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Victor Leschuka7ece032016-10-20 00:13:19 +0000682 // Bit size and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000683 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000684 if (Ty->isComplexIntegerType())
685 Encoding = llvm::dwarf::DW_ATE_lo_user;
686
687 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000688 return DBuilder.createBasicType("complex", Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000689}
690
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000691llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
692 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000693 QualifierCollector Qc;
694 const Type *T = Qc.strip(Ty);
695
696 // Ignore these qualifiers for now.
697 Qc.removeObjCGCAttr();
698 Qc.removeAddressSpace();
699 Qc.removeObjCLifetime();
700
701 // We will create one Derived type for one qualifier and recurse to handle any
702 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000703 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000704 if (Qc.hasConst()) {
705 Tag = llvm::dwarf::DW_TAG_const_type;
706 Qc.removeConst();
707 } else if (Qc.hasVolatile()) {
708 Tag = llvm::dwarf::DW_TAG_volatile_type;
709 Qc.removeVolatile();
710 } else if (Qc.hasRestrict()) {
711 Tag = llvm::dwarf::DW_TAG_restrict_type;
712 Qc.removeRestrict();
713 } else {
714 assert(Qc.empty() && "Unknown type qualifier for debug info");
715 return getOrCreateType(QualType(T, 0), Unit);
716 }
717
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000718 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000719
720 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
721 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000722 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000723}
724
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000725llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
726 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000727
728 // The frontend treats 'id' as a typedef to an ObjCObjectType,
729 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
730 // debug info, we want to emit 'id' in both cases.
731 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000732 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000733
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000734 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
735 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000736}
737
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000738llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
739 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000740 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000741 Ty->getPointeeType(), Unit);
742}
743
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000744/// \return whether a C++ mangling exists for the type defined by TD.
745static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
746 switch (TheCU->getSourceLanguage()) {
747 case llvm::dwarf::DW_LANG_C_plus_plus:
748 return true;
749 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
750 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
751 default:
752 return false;
753 }
754}
755
Manman Rene0064d82013-08-29 23:19:58 +0000756/// In C++ mode, types have linkage, so we can rely on the ODR and
757/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000758static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
759 CodeGenModule &CGM,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000760 llvm::DICompileUnit *TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000761 SmallString<256> FullName;
Manman Rene0064d82013-08-29 23:19:58 +0000762 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000763
764 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
Manman Rene0064d82013-08-29 23:19:58 +0000765 return FullName;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000766
Manman Rene0064d82013-08-29 23:19:58 +0000767 // TODO: This is using the RTTI name. Is there a better way to get
768 // a unique string for a type?
769 llvm::raw_svector_ostream Out(FullName);
770 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Manman Rene0064d82013-08-29 23:19:58 +0000771 return FullName;
772}
773
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000774/// \return the approproate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000775static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
776 llvm::dwarf::Tag Tag;
777 if (RD->isStruct() || RD->isInterface())
778 Tag = llvm::dwarf::DW_TAG_structure_type;
779 else if (RD->isUnion())
780 Tag = llvm::dwarf::DW_TAG_union_type;
781 else {
782 // FIXME: This could be a struct type giving a default visibility different
783 // than C++ class type, but needs llvm metadata changes first.
784 assert(RD->isClass());
785 Tag = llvm::dwarf::DW_TAG_class_type;
786 }
787 return Tag;
788}
789
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000790llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000791CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000792 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000793 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000794 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
795 return cast<llvm::DICompositeType>(T);
796 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000797 unsigned Line = getLineNumber(RD->getLocation());
798 StringRef RDName = getClassName(RD);
799
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000800 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000801 uint32_t Align = 0;
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000802
Guy Benyei11169dd2012-12-18 14:30:41 +0000803 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000804 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000805 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000806 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000807 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000808 ReplaceMap.emplace_back(
809 std::piecewise_construct, std::make_tuple(Ty),
810 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000811 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000812}
813
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000814llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000815 const Type *Ty,
816 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000817 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000818 // Bit size, align and offset of the type.
819 // Size is always the size of a pointer. We can't use getTypeSize here
820 // because that does not return the correct value for references.
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000821 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
822 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
Victor Leschuka7ece032016-10-20 00:13:19 +0000823 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000824 Optional<unsigned> DWARFAddressSpace =
825 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000826
Keno Fischer87842f32015-11-16 09:04:13 +0000827 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
828 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
829 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000830 Size, Align, DWARFAddressSpace);
Keno Fischer87842f32015-11-16 09:04:13 +0000831 else
832 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000833 Align, DWARFAddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000834}
835
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000836llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
837 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000838 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000839 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000840 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
841 TheCU, getOrCreateMainFile(), 0);
842 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
843 Cache = DBuilder.createPointerType(Cache, Size);
844 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000845}
846
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000847llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
848 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000849 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000850 QualType FType;
851 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000852 uint32_t FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000853 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000854
855 FieldOffset = 0;
856 FType = CGM.getContext().UnsignedLongTy;
857 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
858 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
859
860 Elements = DBuilder.getOrCreateArray(EltTys);
861 EltTys.clear();
862
Leny Kholodov80c047d2016-09-06 10:48:04 +0000863 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000864 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000865
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000866 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000867 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000868 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000869
870 // Bit size, align and offset of the type.
871 uint64_t Size = CGM.getContext().getTypeSize(Ty);
872
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000873 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000874
875 FieldOffset = 0;
876 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
877 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
878 FType = CGM.getContext().IntTy;
879 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
880 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000881 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000882 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
883
884 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000885 FieldSize = CGM.getContext().getTypeSize(Ty);
886 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000887 EltTys.push_back(DBuilder.createMemberType(
888 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign, FieldOffset,
889 llvm::DINode::FlagZero, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000890
891 FieldOffset += FieldSize;
892 Elements = DBuilder.getOrCreateArray(EltTys);
893
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000894 // The __block_literal_generic structs are marked with a special
895 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
896 // the debugger needs to know about. To allow type uniquing, emit
897 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000898 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000899 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000900 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000901
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000902 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000903}
904
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000905llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
906 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000907 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000908 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000909
910 SmallString<128> NS;
911 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000912 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
913 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000914
915 TemplateSpecializationType::PrintTemplateArgumentList(
David Majnemer6fbeee32016-07-07 04:43:07 +0000916 OS, Ty->template_arguments(),
David Blaikief1b382e2014-04-06 17:14:06 +0000917 CGM.getContext().getPrintingPolicy());
918
David Majnemer58ed0f32016-07-17 00:39:12 +0000919 auto *AliasDecl = cast<TypeAliasTemplateDecl>(
Eric Christophere7b87e52014-10-26 23:40:33 +0000920 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000921
922 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000923 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
924 getLineNumber(Loc),
925 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000926}
927
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000928llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
929 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000930 // We don't set size information, but do specify where the typedef was
931 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +0000932 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000933
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000934 // Typedefs are derived from some other type.
935 return DBuilder.createTypedef(
936 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
937 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +0000938 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000939}
940
Reid Klecknerf00f8032016-06-08 20:41:54 +0000941static unsigned getDwarfCC(CallingConv CC) {
942 switch (CC) {
943 case CC_C:
944 // Avoid emitting DW_AT_calling_convention if the C convention was used.
945 return 0;
946
947 case CC_X86StdCall:
948 return llvm::dwarf::DW_CC_BORLAND_stdcall;
949 case CC_X86FastCall:
950 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
951 case CC_X86ThisCall:
952 return llvm::dwarf::DW_CC_BORLAND_thiscall;
953 case CC_X86VectorCall:
954 return llvm::dwarf::DW_CC_LLVM_vectorcall;
955 case CC_X86Pascal:
956 return llvm::dwarf::DW_CC_BORLAND_pascal;
957
958 // FIXME: Create new DW_CC_ codes for these calling conventions.
Martin Storsjo022e7822017-07-17 20:49:45 +0000959 case CC_Win64:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000960 case CC_X86_64SysV:
961 case CC_AAPCS:
962 case CC_AAPCS_VFP:
963 case CC_IntelOclBicc:
964 case CC_SpirFunction:
Nikolay Haustov8c6538b2016-06-30 09:06:33 +0000965 case CC_OpenCLKernel:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000966 case CC_Swift:
967 case CC_PreserveMost:
968 case CC_PreserveAll:
Erich Keane757d3172016-11-02 18:29:35 +0000969 case CC_X86RegCall:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000970 return 0;
971 }
972 return 0;
973}
974
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000975llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
976 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000977 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000978
979 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000980 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000981
982 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000983 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000984 if (isa<FunctionNoProtoType>(Ty))
985 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +0000986 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
987 for (const QualType &ParamType : FPT->param_types())
988 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000989 if (FPT->isVariadic())
990 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000991 }
992
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000993 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +0000994 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +0000995 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000996}
997
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000998/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000999/// As an optimization, return 0 if the access specifier equals the
1000/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +00001001static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1002 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +00001003 AccessSpecifier Default = clang::AS_none;
1004 if (RD && RD->isClass())
1005 Default = clang::AS_private;
1006 else if (RD && (RD->isStruct() || RD->isUnion()))
1007 Default = clang::AS_public;
1008
1009 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +00001010 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001011
Eric Christophere7b87e52014-10-26 23:40:33 +00001012 switch (Access) {
1013 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001014 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +00001015 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001016 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +00001017 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001018 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +00001019 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +00001020 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001021 }
1022 llvm_unreachable("unexpected access enumerator");
1023}
Guy Benyei11169dd2012-12-18 14:30:41 +00001024
David Majnemerb4b671e2016-06-30 03:01:59 +00001025llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1026 llvm::DIScope *RecordTy,
1027 const RecordDecl *RD) {
1028 StringRef Name = BitFieldDecl->getName();
1029 QualType Ty = BitFieldDecl->getType();
1030 SourceLocation Loc = BitFieldDecl->getLocation();
1031 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1032 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1033
1034 // Get the location for the field.
1035 llvm::DIFile *File = getOrCreateFile(Loc);
1036 unsigned Line = getLineNumber(Loc);
1037
1038 const CGBitFieldInfo &BitFieldInfo =
1039 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1040 uint64_t SizeInBits = BitFieldInfo.Size;
1041 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001042 uint64_t StorageOffsetInBits =
1043 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
Reid Kleckner06a4b2a2017-06-12 19:57:56 +00001044 uint64_t Offset = BitFieldInfo.Offset;
1045 // The bit offsets for big endian machines are reversed for big
1046 // endian target, compensate for that as the DIDerivedType requires
1047 // un-reversed offsets.
1048 if (CGM.getDataLayout().isBigEndian())
1049 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1050 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001051 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001052 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001053 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1054 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001055}
1056
1057llvm::DIType *
1058CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1059 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001060 uint32_t AlignInBits, llvm::DIFile *tunit,
1061 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001062 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001063
1064 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001065 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001066 unsigned line = getLineNumber(loc);
1067
David Majnemer34b57492014-07-30 01:30:47 +00001068 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001069 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001070 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001071 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1072 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001073 if (!Align)
1074 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001075 }
1076
Leny Kholodov80c047d2016-09-06 10:48:04 +00001077 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +00001078 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001079 Align, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001080}
1081
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001082void CGDebugInfo::CollectRecordLambdaFields(
1083 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001084 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001085 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1086 // has the name and the location of the variable so we should iterate over
1087 // both concurrently.
1088 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1089 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1090 unsigned fieldno = 0;
1091 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001092 E = CXXDecl->captures_end();
1093 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001094 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001095 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001096 SourceLocation Loc = C.getLocation();
1097 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001098 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001099 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001100 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001101 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001102 llvm::DIType *FieldType = createFieldType(
1103 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001104 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001105 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001106 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001107 // TODO: Need to handle 'this' in some way by probably renaming the
1108 // this of the lambda class and having a field member of 'this' or
1109 // by using AT_object_pointer for the function and having that be
1110 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001111 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001112 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001113 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001114 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001115 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001116 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001117
1118 elements.push_back(fieldType);
1119 }
1120 }
1121}
1122
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001123llvm::DIDerivedType *
1124CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001125 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001126 // Create the descriptor for the static variable, with or without
1127 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001128 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001129 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1130 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001131
Eric Christopher91a31902013-01-16 01:22:32 +00001132 unsigned LineNumber = getLineNumber(Var->getLocation());
1133 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001134 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001135 if (Var->getInit()) {
1136 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001137 if (Value) {
1138 if (Value->isInt())
1139 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1140 if (Value->isFloat())
1141 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1142 }
Eric Christopher91a31902013-01-16 01:22:32 +00001143 }
1144
Leny Kholodov80c047d2016-09-06 10:48:04 +00001145 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001146 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001147 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001148 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001149 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001150 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001151}
1152
Eric Christophere7b87e52014-10-26 23:40:33 +00001153void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001154 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1155 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001156 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001157 StringRef name = field->getName();
1158 QualType type = field->getType();
1159
1160 // Ignore unnamed fields unless they're anonymous structs/unions.
1161 if (name.empty() && !type->isRecordType())
1162 return;
1163
David Majnemerb4b671e2016-06-30 03:01:59 +00001164 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001165 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001166 FieldType = createBitFieldType(field, RecordTy, RD);
1167 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001168 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001169 FieldType =
1170 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001171 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001172 }
1173
David Majnemerb4b671e2016-06-30 03:01:59 +00001174 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001175}
1176
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001177void CGDebugInfo::CollectRecordNestedRecord(
1178 const RecordDecl *RD, SmallVectorImpl<llvm::Metadata *> &elements) {
1179 QualType Ty = CGM.getContext().getTypeDeclType(RD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001180 // Injected class names are not considered nested records.
1181 if (isa<InjectedClassNameType>(Ty))
1182 return;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001183 SourceLocation Loc = RD->getLocation();
1184 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1185 elements.push_back(nestedType);
1186}
1187
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001188void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001189 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001190 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001191 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001192 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001193
Eric Christopher91a31902013-01-16 01:22:32 +00001194 if (CXXDecl && CXXDecl->isLambda())
1195 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1196 else {
1197 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001198
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001199 // Debug info for nested records is included in the member list only for
1200 // CodeView.
1201 bool IncludeNestedRecords = CGM.getCodeGenOpts().EmitCodeView;
1202
Eric Christopher91a31902013-01-16 01:22:32 +00001203 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001204 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001205
Eric Christopher91a31902013-01-16 01:22:32 +00001206 // Static and non-static members should appear in the same order as
1207 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001208 for (const auto *I : record->decls())
1209 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001210 if (V->hasAttr<NoDebugAttr>())
1211 continue;
David Blaikiece763042013-08-20 21:49:21 +00001212 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001213 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001214 if (MI != StaticDataMemberCache.end()) {
1215 assert(MI->second &&
1216 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001217 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001218 } else {
1219 auto Field = CreateRecordStaticField(V, RecordTy, record);
1220 elements.push_back(Field);
1221 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001222 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001223 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1224 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001225
1226 // Bump field number for next field.
1227 ++fieldNo;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001228 } else if (const auto *nestedRec = dyn_cast<CXXRecordDecl>(I))
1229 if (IncludeNestedRecords && !nestedRec->isImplicit() &&
1230 nestedRec->getDeclContext() == record)
1231 CollectRecordNestedRecord(nestedRec, elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001232 }
1233}
1234
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001235llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001236CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001237 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001238 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001239 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001240 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001241 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001242 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1243 Func, Unit);
1244}
David Blaikie2aaf0652013-01-07 22:24:59 +00001245
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001246llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1247 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001248 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001249 llvm::DITypeRefArray Args(
1250 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001251 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001252 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001253
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001254 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001255
1256 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001257 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001258
David Blaikie2aaf0652013-01-07 22:24:59 +00001259 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001260 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001261 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1262 // Create pointer type directly in this case.
1263 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1264 QualType PointeeTy = ThisPtrTy->getPointeeType();
1265 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001266 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001267 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001268 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1269 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001270 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001271 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001272 // TODO: This and the artificial type below are misleading, the
1273 // types aren't artificial the argument is, but the current
1274 // metadata doesn't represent that.
1275 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1276 Elts.push_back(ThisPtrType);
1277 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001278 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001279 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001280 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1281 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001282 }
1283
1284 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001285 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1286 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001287
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001288 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001289
Leny Kholodov80c047d2016-09-06 10:48:04 +00001290 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001291 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001292 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001293 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001294 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001295
Reid Klecknerf00f8032016-06-08 20:41:54 +00001296 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1297 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001298}
1299
Eric Christopherb2a008c2013-05-16 00:45:12 +00001300/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001301/// inside a function.
1302static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001303 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001304 return isFunctionLocalClass(NRD);
1305 if (isa<FunctionDecl>(RD->getDeclContext()))
1306 return true;
1307 return false;
1308}
1309
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001310llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1311 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001312 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001313 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001314
Guy Benyei11169dd2012-12-18 14:30:41 +00001315 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001316 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001317
1318 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1319 // make sense to give a single ctor/dtor a linkage name.
1320 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001321 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1322 // property to use here. It may've been intended to model "is non-external
1323 // type" but misses cases of non-function-local but non-external classes such
1324 // as those in anonymous namespaces as well as the reverse - external types
1325 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001326 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1327 MethodLinkageName = CGM.getMangledName(Method);
1328
1329 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001330 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001331 unsigned MethodLine = 0;
1332 if (!Method->isImplicit()) {
1333 MethodDefUnit = getOrCreateFile(Method->getLocation());
1334 MethodLine = getLineNumber(Method->getLocation());
1335 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001336
1337 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001338 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001339 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001340 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001341 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001342 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001343
Guy Benyei11169dd2012-12-18 14:30:41 +00001344 if (Method->isVirtual()) {
1345 if (Method->isPure())
1346 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1347 else
1348 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001349
Reid Kleckner216d0a12016-06-16 20:08:51 +00001350 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1351 // It doesn't make sense to give a virtual destructor a vtable index,
1352 // since a single destructor has two entries in the vtable.
1353 if (!isa<CXXDestructorDecl>(Method))
1354 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1355 } else {
1356 // Emit MS ABI vftable information. There is only one entry for the
1357 // deleting dtor.
1358 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1359 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1360 MicrosoftVTableContext::MethodVFTableLocation ML =
1361 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1362 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001363
1364 // CodeView only records the vftable offset in the class that introduces
1365 // the virtual method. This is possible because, unlike Itanium, the MS
1366 // C++ ABI does not include all virtual methods from non-primary bases in
1367 // the vtable for the most derived class. For example, if C inherits from
1368 // A and B, C's primary vftable will not include B's virtual methods.
1369 if (Method->begin_overridden_methods() == Method->end_overridden_methods())
1370 Flags |= llvm::DINode::FlagIntroducedVirtual;
1371
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001372 // The 'this' adjustment accounts for both the virtual and non-virtual
1373 // portions of the adjustment. Presumably the debugger only uses it when
1374 // it knows the dynamic type of an object.
1375 ThisAdjustment = CGM.getCXXABI()
1376 .getVirtualFunctionPrologueThisAdjustment(GD)
1377 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001378 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001379 ContainingType = RecordTy;
1380 }
1381
Guy Benyei11169dd2012-12-18 14:30:41 +00001382 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001383 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001384 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001385 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001386 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001387 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001388 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001389 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001390 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001391 }
1392 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001393 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001394 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001395 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001396 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001397 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001398
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001399 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1400 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001401 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001402 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1403 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1404 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001405
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001406 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001407
1408 return SP;
1409}
1410
Eric Christophere7b87e52014-10-26 23:40:33 +00001411void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001412 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1413 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001414
1415 // Since we want more than just the individual member decls if we
1416 // have templated functions iterate over every declaration to gather
1417 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001418 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001419 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1420 // If the member is implicit, don't add it to the member list. This avoids
1421 // the member being added to type units by LLVM, while still allowing it
1422 // to be emitted into the type declaration/reference inside the compile
1423 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001424 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001425 // FIXME: Handle Using(Shadow?)Decls here to create
1426 // DW_TAG_imported_declarations inside the class for base decls brought into
1427 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1428 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1429 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001430 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001431 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001432
1433 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1434 continue;
1435
David Blaikiefd580722014-10-06 05:18:55 +00001436 // Reuse the existing member function declaration if it exists.
1437 // It may be associated with the declaration of the type & should be
1438 // reused as we're building the definition.
1439 //
1440 // This situation can arise in the vtable-based debug info reduction where
1441 // implicit members are emitted in a non-vtable TU.
1442 auto MI = SPCache.find(Method->getCanonicalDecl());
1443 EltTys.push_back(MI == SPCache.end()
1444 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001445 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001446 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001447}
Guy Benyei11169dd2012-12-18 14:30:41 +00001448
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001449void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001450 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001451 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001452 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1453 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1454 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001455
Bob Haarmandff36732016-10-25 22:19:32 +00001456 // If we are generating CodeView debug info, we also need to emit records for
1457 // indirect virtual base classes.
1458 if (CGM.getCodeGenOpts().EmitCodeView) {
1459 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1460 llvm::DINode::FlagIndirectVirtualBase);
1461 }
1462}
1463
1464void CGDebugInfo::CollectCXXBasesAux(
1465 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1466 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1467 const CXXRecordDecl::base_class_const_range &Bases,
1468 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1469 llvm::DINode::DIFlags StartingFlags) {
1470 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1471 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001472 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001473 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001474 if (!SeenTypes.insert(Base).second)
1475 continue;
1476 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1477 llvm::DINode::DIFlags BFlags = StartingFlags;
1478 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001479
Aaron Ballman574705e2014-03-13 15:41:46 +00001480 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001481 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1482 // virtual base offset offset is -ve. The code generator emits dwarf
1483 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001484 BaseOffset = 0 - CGM.getItaniumVTableContext()
1485 .getVirtualBaseOffsetOffset(RD, Base)
1486 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001487 } else {
1488 // In the MS ABI, store the vbtable offset, which is analogous to the
1489 // vbase offset offset in Itanium.
1490 BaseOffset =
1491 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1492 }
Bob Haarmandff36732016-10-25 22:19:32 +00001493 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001494 } else
1495 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1496 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1497 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001498
Adrian Prantl21361fb2014-08-29 22:44:27 +00001499 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Bob Haarmandff36732016-10-25 22:19:32 +00001500 llvm::DIType *DTy =
1501 DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001502 EltTys.push_back(DTy);
1503 }
1504}
1505
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001506llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001507CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1508 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001509 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001510 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001511 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1512 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001513 StringRef Name;
1514 if (TPList)
1515 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001516 switch (TA.getKind()) {
1517 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001518 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001519 TemplateParams.push_back(
1520 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001521 } break;
1522 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001523 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001524 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1525 TheCU, Name, TTy,
1526 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001527 } break;
1528 case TemplateArgument::Declaration: {
1529 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001530 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001531 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001532 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001533 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001534 // Variable pointer template parameters have a value that is the address
1535 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001536 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001537 V = CGM.GetAddrOfGlobalVar(VD);
1538 // Member function pointers have special support for building them, though
1539 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001540 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001541 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001542 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001543 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001544 // Member data pointers have special handling too to compute the fixed
1545 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001546 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001547 // These five lines (& possibly the above member function pointer
1548 // handling) might be able to be refactored to use similar code in
1549 // CodeGenModule::getMemberPointerConstant
1550 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1551 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001552 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001553 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001554 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001555 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1556 TheCU, Name, TTy,
1557 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001558 } break;
1559 case TemplateArgument::NullPtr: {
1560 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001561 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001562 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001563 // Special case member data pointer null values since they're actually -1
1564 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001565 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001566 // But treat member function pointers as simple zero integers because
1567 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1568 // CodeGen grows handling for values of non-null member function
1569 // pointers then perhaps we could remove this special case and rely on
1570 // EmitNullMemberPointer for member function pointers.
1571 if (MPT->isMemberDataPointer())
1572 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1573 if (!V)
1574 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001575 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001576 TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001577 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001578 case TemplateArgument::Template:
1579 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001580 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001581 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1582 break;
1583 case TemplateArgument::Pack:
1584 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1585 TheCU, Name, nullptr,
1586 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1587 break;
David Majnemer5559d472013-08-24 08:21:10 +00001588 case TemplateArgument::Expression: {
1589 const Expr *E = TA.getAsExpr();
1590 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001591 if (E->isGLValue())
1592 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001593 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001594 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001595 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001596 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001597 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001598 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001599 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001600 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001601 case TemplateArgument::Null:
1602 llvm_unreachable(
1603 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001604 }
1605 }
1606 return DBuilder.getOrCreateArray(TemplateParams);
1607}
1608
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001609llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001610CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001611 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001612 if (FD->getTemplatedKind() ==
1613 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001614 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1615 ->getTemplate()
1616 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001617 return CollectTemplateParams(
1618 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001619 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001620 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001621}
1622
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001623llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1624 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001625 // Always get the full list of parameters, not just the ones from
1626 // the specialization.
1627 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001628 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001629 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001630 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001631}
1632
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001633llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001634 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001635 return VTablePtrType;
1636
1637 ASTContext &Context = CGM.getContext();
1638
1639 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001640 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001641 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001642 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001643 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001644 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1645 Optional<unsigned> DWARFAddressSpace =
1646 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1647
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001648 llvm::DIType *vtbl_ptr_type =
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001649 DBuilder.createPointerType(SubTy, Size, 0, DWARFAddressSpace,
1650 "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001651 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1652 return VTablePtrType;
1653}
1654
Guy Benyei11169dd2012-12-18 14:30:41 +00001655StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001656 // Copy the gdb compatible name on the side and use its reference.
1657 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001658}
1659
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001660void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001661 SmallVectorImpl<llvm::Metadata *> &EltTys,
1662 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001663 // If this class is not dynamic then there is not any vtable info to collect.
1664 if (!RD->isDynamicClass())
1665 return;
1666
Reid Kleckner59812422016-08-31 20:35:01 +00001667 // Don't emit any vtable shape or vptr info if this class doesn't have an
1668 // extendable vfptr. This can happen if the class doesn't have virtual
1669 // methods, or in the MS ABI if those virtual methods only come from virtually
1670 // inherited bases.
1671 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1672 if (!RL.hasExtendableVFPtr())
1673 return;
1674
Reid Klecknerdc124992016-08-31 16:11:43 +00001675 // CodeView needs to know how large the vtable of every dynamic class is, so
1676 // emit a special named pointer type into the element list. The vptr type
1677 // points to this type as well.
1678 llvm::DIType *VPtrTy = nullptr;
1679 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1680 CGM.getTarget().getCXXABI().isMicrosoft();
1681 if (NeedVTableShape) {
1682 uint64_t PtrWidth =
1683 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1684 const VTableLayout &VFTLayout =
1685 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1686 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001687 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001688 unsigned VTableWidth = PtrWidth * VSlotCount;
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001689 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1690 Optional<unsigned> DWARFAddressSpace =
1691 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
Reid Klecknerdc124992016-08-31 16:11:43 +00001692
1693 // Create a very wide void* type and insert it directly in the element list.
1694 llvm::DIType *VTableType =
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001695 DBuilder.createPointerType(nullptr, VTableWidth, 0, DWARFAddressSpace,
1696 "__vtbl_ptr_type");
Reid Klecknerdc124992016-08-31 16:11:43 +00001697 EltTys.push_back(VTableType);
1698
1699 // The vptr is a pointer to this special vtable type.
1700 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1701 }
1702
1703 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001704 if (RL.getPrimaryBase())
1705 return;
1706
1707 if (!VPtrTy)
1708 VPtrTy = getOrCreateVTablePtrType(Unit);
1709
Guy Benyei11169dd2012-12-18 14:30:41 +00001710 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001711 llvm::DIType *VPtrMember = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001712 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Reid Klecknerdc124992016-08-31 16:11:43 +00001713 llvm::DINode::FlagArtificial, VPtrTy);
1714 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001715}
1716
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001717llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001718 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001719 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001720 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001721 return T;
1722}
1723
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001724llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001725 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001726 return getOrCreateStandaloneType(D, Loc);
1727}
1728
1729llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1730 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001731 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001732 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001733 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001734 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001735
Adrian Prantl73409ce2013-03-11 18:33:46 +00001736 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001737 return T;
1738}
1739
David Blaikie483a9da2014-05-06 18:35:21 +00001740void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001741 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001742 return;
1743 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001744 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001745 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001746 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001747 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001748 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001749 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001750 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001751}
1752
David Blaikieb2e86eb2013-08-15 20:49:17 +00001753void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001754 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001755 !CGM.getLangOpts().CPlusPlus)
1756 completeRequiredType(RD);
1757}
1758
David Blaikieb11c8732017-01-30 06:36:08 +00001759/// Return true if the class or any of its methods are marked dllimport.
1760static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1761 if (RD->hasAttr<DLLImportAttr>())
1762 return true;
1763 for (const CXXMethodDecl *MD : RD->methods())
1764 if (MD->hasAttr<DLLImportAttr>())
1765 return true;
1766 return false;
1767}
1768
Adrian Prantla43acdc2017-07-24 23:48:51 +00001769/// Does a type definition exist in an imported clang module?
1770static bool isDefinedInClangModule(const RecordDecl *RD) {
1771 // Only definitions that where imported from an AST file come from a module.
1772 if (!RD || !RD->isFromASTFile())
1773 return false;
1774 // Anonymous entities cannot be addressed. Treat them as not from module.
1775 if (!RD->isExternallyVisible() && RD->getName().empty())
1776 return false;
1777 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1778 if (!CXXDecl->isCompleteDefinition())
1779 return false;
1780 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1781 if (TemplateKind != TSK_Undeclared) {
1782 // This is a template, check the origin of the first member.
1783 if (CXXDecl->field_begin() == CXXDecl->field_end())
1784 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1785 if (!CXXDecl->field_begin()->isFromASTFile())
1786 return false;
1787 }
1788 }
1789 return true;
1790}
1791
David Blaikie6943dea2013-08-20 01:28:15 +00001792void CGDebugInfo::completeClassData(const RecordDecl *RD) {
David Blaikieb11c8732017-01-30 06:36:08 +00001793 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1794 if (CXXRD->isDynamicClass() &&
1795 CGM.getVTableLinkage(CXXRD) ==
1796 llvm::GlobalValue::AvailableExternallyLinkage &&
1797 !isClassOrMethodDLLImport(CXXRD))
1798 return;
Adrian Prantla43acdc2017-07-24 23:48:51 +00001799
1800 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1801 return;
1802
David Blaikieb11c8732017-01-30 06:36:08 +00001803 completeClass(RD);
1804}
1805
1806void CGDebugInfo::completeClass(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001807 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001808 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001809 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001810 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001811 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001812 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001813 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001814 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001815 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001816 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001817}
1818
David Blaikie0e716b42014-03-03 23:48:23 +00001819static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1820 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001821 for (CXXMethodDecl *MD : llvm::make_range(I, End))
1822 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001823 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00001824 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001825 return true;
1826 return false;
1827}
1828
Benjamin Kramer8c305922016-02-02 11:06:51 +00001829static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1830 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001831 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001832 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001833 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001834
David Blaikie1ac9c982017-04-11 21:13:37 +00001835 if (auto *ES = RD->getASTContext().getExternalSource())
1836 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
1837 return true;
1838
Benjamin Kramer8c305922016-02-02 11:06:51 +00001839 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001840 return false;
1841
1842 if (!LangOpts.CPlusPlus)
1843 return false;
1844
1845 if (!RD->isCompleteDefinitionRequired())
1846 return true;
1847
David Majnemer58ed0f32016-07-17 00:39:12 +00001848 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00001849
1850 if (!CXXDecl)
1851 return false;
1852
Adrian McCarthy99242982016-08-16 22:11:18 +00001853 // Only emit complete debug info for a dynamic class when its vtable is
1854 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00001855 // across DLL boundaries, so skip this optimization if the class or any of its
1856 // methods are marked dllimport. This isn't a complete solution, since objects
1857 // without any dllimport methods can be used in one DLL and constructed in
1858 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00001859 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00001860 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00001861 return true;
1862
1863 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00001864 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00001865 Spec = SD->getSpecializationKind();
1866
1867 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1868 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1869 CXXDecl->method_end()))
1870 return true;
1871
1872 return false;
1873}
1874
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00001875void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
1876 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
1877 return;
1878
1879 QualType Ty = CGM.getContext().getRecordType(RD);
1880 llvm::DIType *T = getTypeOrNull(Ty);
1881 if (T && T->isForwardDecl())
1882 completeClassData(RD);
1883}
1884
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001885llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001886 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001887 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001888 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1889 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001890 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001891 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001892 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001893 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001894
David Blaikieb2e86eb2013-08-15 20:49:17 +00001895 return CreateTypeDefinition(Ty);
1896}
1897
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001898llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001899 RecordDecl *RD = Ty->getDecl();
1900
Guy Benyei11169dd2012-12-18 14:30:41 +00001901 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001902 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001903
1904 // Records and classes and unions can all be recursive. To handle them, we
1905 // first generate a debug descriptor for the struct as a forward declaration.
1906 // Then (if it is a definition) we go through and get debug info for all of
1907 // its members. Finally, we create a descriptor for the complete type (which
1908 // may refer to the forward decl if the struct is recursive) and replace all
1909 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001910 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001911
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001912 const RecordDecl *D = RD->getDefinition();
1913 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001914 return FwdDecl;
1915
David Majnemer58ed0f32016-07-17 00:39:12 +00001916 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00001917 CollectContainingType(CXXDecl, FwdDecl);
1918
Guy Benyei11169dd2012-12-18 14:30:41 +00001919 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001920 LexicalBlockStack.emplace_back(&*FwdDecl);
1921 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001922
Guy Benyei11169dd2012-12-18 14:30:41 +00001923 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001924 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001925 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001926
1927 // Note: The split of CXXDecl information here is intentional, the
1928 // gdb tests will depend on a certain ordering at printout. The debug
1929 // information offsets are still correct if we merge them all together
1930 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00001931 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00001932 if (CXXDecl) {
1933 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00001934 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001935 }
1936
Eric Christopher91a31902013-01-16 01:22:32 +00001937 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001938 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001939 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001940 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001941
1942 LexicalBlockStack.pop_back();
1943 RegionMap.erase(Ty->getDecl());
1944
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001945 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001946 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001947
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001948 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001949 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001950 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001951
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001952 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001953 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001954}
1955
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001956llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1957 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001958 // Ignore protocols.
1959 return getOrCreateType(Ty->getBaseType(), Unit);
1960}
1961
Manman Rene6be26c2016-09-13 17:25:08 +00001962llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
1963 llvm::DIFile *Unit) {
1964 // Ignore protocols.
1965 SourceLocation Loc = Ty->getDecl()->getLocation();
1966
1967 // Use Typedefs to represent ObjCTypeParamType.
1968 return DBuilder.createTypedef(
1969 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1970 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
1971 getDeclContextDescriptor(Ty->getDecl()));
1972}
1973
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001974/// \return true if Getter has the default name for the property PD.
1975static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1976 const ObjCMethodDecl *Getter) {
1977 assert(PD);
1978 if (!Getter)
1979 return true;
1980
1981 assert(Getter->getDeclName().isObjCZeroArgSelector());
1982 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001983 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001984}
1985
1986/// \return true if Setter has the default name for the property PD.
1987static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1988 const ObjCMethodDecl *Setter) {
1989 assert(PD);
1990 if (!Setter)
1991 return true;
1992
1993 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001994 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001995 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001996}
1997
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001998llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1999 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002000 ObjCInterfaceDecl *ID = Ty->getDecl();
2001 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002002 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002003
Adrian Prantl50fd1a82016-04-20 23:59:32 +00002004 // Return a forward declaration if this type was imported from a clang module,
2005 // and this is not the compile unit with the implementation of the type (which
2006 // may contain hidden ivars).
2007 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2008 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002009 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2010 ID->getName(),
2011 getDeclContextDescriptor(ID), Unit, 0);
2012
Guy Benyei11169dd2012-12-18 14:30:41 +00002013 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002014 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002015 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002016 auto RuntimeLang =
2017 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00002018
2019 // If this is just a forward declaration return a special forward-declaration
2020 // debug type since we won't be able to lay out the entire type.
2021 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00002022 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002023 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002024 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002025 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2026 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00002027 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002028 return FwdDecl;
2029 }
2030
David Blaikieef8a9512014-05-05 23:23:53 +00002031 return CreateTypeDefinition(Ty, Unit);
2032}
2033
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002034llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00002035CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2036 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00002037 // Use the Module pointer as the key into the cache. This is a
2038 // nullptr if the "Module" is a PCH, which is safe because we don't
2039 // support chained PCH debug info, so there can only be a single PCH.
2040 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002041 auto ModRef = ModuleCache.find(M);
2042 if (ModRef != ModuleCache.end())
2043 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00002044
2045 // Macro definitions that were defined with "-D" on the command line.
2046 SmallString<128> ConfigMacros;
2047 {
2048 llvm::raw_svector_ostream OS(ConfigMacros);
2049 const auto &PPOpts = CGM.getPreprocessorOpts();
2050 unsigned I = 0;
2051 // Translate the macro definitions back into a commmand line.
2052 for (auto &M : PPOpts.Macros) {
2053 if (++I > 1)
2054 OS << " ";
2055 const std::string &Macro = M.first;
2056 bool Undef = M.second;
2057 OS << "\"-" << (Undef ? 'U' : 'D');
2058 for (char c : Macro)
2059 switch (c) {
2060 case '\\' : OS << "\\\\"; break;
2061 case '"' : OS << "\\\""; break;
2062 default: OS << c;
2063 }
2064 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002065 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002066 }
Adrian Prantl66689202015-09-18 23:01:45 +00002067
Adrian Prantl835e6632015-09-24 16:10:10 +00002068 bool IsRootModule = M ? !M->Parent : true;
2069 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002070 // PCH files don't have a signature field in the control block,
2071 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00002072 // We use the lower 64 bits for debug info.
2073 uint64_t Signature =
2074 Mod.getSignature()
2075 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2076 : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002077 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002078 DIB.createCompileUnit(TheCU->getSourceLanguage(),
2079 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2080 TheCU->getProducer(), true, StringRef(), 0,
2081 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2082 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002083 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002084 }
Adrian Prantl835e6632015-09-24 16:10:10 +00002085 llvm::DIModule *Parent =
2086 IsRootModule ? nullptr
2087 : getOrCreateModuleRef(
2088 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2089 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002090 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002091 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2092 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002093 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002094 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002095}
2096
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002097llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2098 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002099 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002100 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002101 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002102 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002103
2104 // Bit size, align and offset of the type.
2105 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002106 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002107
Leny Kholodov80c047d2016-09-06 10:48:04 +00002108 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002109 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002110 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002111
Adrian Prantlfd696112015-10-01 00:48:51 +00002112 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002113 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002114 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2115 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002116
David Blaikieef8a9512014-05-05 23:23:53 +00002117 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002118 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002119
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002120 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002121 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002122 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002123
2124 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002125 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002126
2127 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2128 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002129 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002130 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002131 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002132 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002133
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002134 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0,
2135 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002136 EltTys.push_back(InhTag);
2137 }
2138
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002139 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002140 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002141 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002142 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002143 unsigned PLine = getLineNumber(Loc);
2144 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2145 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002146 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2147 PD->getName(), PUnit, PLine,
2148 hasDefaultGetterName(PD, Getter) ? ""
2149 : getSelectorName(PD->getGetterName()),
2150 hasDefaultSetterName(PD, Setter) ? ""
2151 : getSelectorName(PD->getSetterName()),
2152 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002153 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002154 };
2155 {
2156 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002157 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002158 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002159 PropertySet.insert(PD->getIdentifier());
2160 AddProperty(PD);
2161 }
Manman Renefe1bac2016-01-27 20:00:32 +00002162 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002163 // Don't emit duplicate metadata for properties that were already in a
2164 // class extension.
2165 if (!PropertySet.insert(PD->getIdentifier()).second)
2166 continue;
2167 AddProperty(PD);
2168 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002169 }
2170
2171 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2172 unsigned FieldNo = 0;
2173 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2174 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002175 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002176 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002177 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002178
Guy Benyei11169dd2012-12-18 14:30:41 +00002179 StringRef FieldName = Field->getName();
2180
2181 // Ignore unnamed fields.
2182 if (FieldName.empty())
2183 continue;
2184
2185 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002186 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002187 unsigned FieldLine = getLineNumber(Field->getLocation());
2188 QualType FType = Field->getType();
2189 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002190 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002191
2192 if (!FType->isIncompleteArrayType()) {
2193
2194 // Bit size, align and offset of the type.
2195 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002196 ? Field->getBitWidthValue(CGM.getContext())
2197 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002198 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002199 }
2200
2201 uint64_t FieldOffset;
2202 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2203 // We don't know the runtime offset of an ivar if we're using the
2204 // non-fragile ABI. For bitfields, use the bit offset into the first
2205 // byte of storage of the bitfield. For other fields, use zero.
2206 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002207 FieldOffset =
2208 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002209 FieldOffset %= CGM.getContext().getCharWidth();
2210 } else {
2211 FieldOffset = 0;
2212 }
2213 } else {
2214 FieldOffset = RL.getFieldOffset(FieldNo);
2215 }
2216
Leny Kholodov80c047d2016-09-06 10:48:04 +00002217 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002218 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002219 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002220 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002221 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002222 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002223 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002224
Craig Topper8a13c412014-05-21 05:09:00 +00002225 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002226 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002227 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002228 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002229 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002230 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002231 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002232 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002233 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2234 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002235 PropertyNode = DBuilder.createObjCProperty(
2236 PD->getName(), PUnit, PLine,
2237 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2238 PD->getGetterName()),
2239 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2240 PD->getSetterName()),
2241 PD->getPropertyAttributes(),
2242 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002243 }
2244 }
2245 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002246 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2247 FieldSize, FieldAlign, FieldOffset, Flags,
2248 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002249 EltTys.push_back(FieldTy);
2250 }
2251
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002252 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002253 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002254
Guy Benyei11169dd2012-12-18 14:30:41 +00002255 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002256 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002257}
2258
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002259llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2260 llvm::DIFile *Unit) {
2261 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002262 int64_t Count = Ty->getNumElements();
2263 if (Count == 0)
2264 // If number of elements are not known then this is an unbounded array.
2265 // Use Count == -1 to express such arrays.
2266 Count = -1;
2267
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002268 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002269 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002270
2271 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002272 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002273
2274 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2275}
2276
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002277llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002278 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002279 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002280
2281 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002282 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002283 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002284 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2285 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002286 } else if (Ty->isIncompleteArrayType()) {
2287 Size = 0;
2288 if (Ty->getElementType()->isIncompleteType())
2289 Align = 0;
2290 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002291 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002292 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002293 Size = 0;
2294 Align = 0;
2295 } else {
2296 // Size and align of the whole array, not the element type.
2297 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002298 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002299 }
2300
2301 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2302 // interior arrays, do we care? Why aren't nested arrays represented the
2303 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002304 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002305 QualType EltTy(Ty, 0);
2306 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2307 // If the number of elements is known, then count is that number. Otherwise,
2308 // it's -1. This allows us to represent a subrange with an array of 0
2309 // elements, like this:
2310 //
2311 // struct foo {
2312 // int x[0];
2313 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002314 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002315 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002316 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002317 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002318 if (Expr *Size = VAT->getSizeExpr()) {
2319 llvm::APSInt V;
2320 if (Size->EvaluateAsInt(V, CGM.getContext()))
2321 Count = V.getExtValue();
2322 }
David Blaikie87173f12016-08-22 17:49:56 +00002323 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002324
Guy Benyei11169dd2012-12-18 14:30:41 +00002325 // FIXME: Verify this is right for VLAs.
2326 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2327 EltTy = Ty->getElementType();
2328 }
2329
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002330 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002331
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002332 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2333 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002334}
2335
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002336llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2337 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002338 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2339 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002340}
2341
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002342llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2343 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002344 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2345 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002346}
2347
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002348llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2349 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002350 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002351 uint64_t Size = 0;
2352
2353 if (!Ty->isIncompleteType()) {
2354 Size = CGM.getContext().getTypeSize(Ty);
2355
2356 // Set the MS inheritance model. There is no flag for the unspecified model.
2357 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2358 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2359 case MSInheritanceAttr::Keyword_single_inheritance:
2360 Flags |= llvm::DINode::FlagSingleInheritance;
2361 break;
2362 case MSInheritanceAttr::Keyword_multiple_inheritance:
2363 Flags |= llvm::DINode::FlagMultipleInheritance;
2364 break;
2365 case MSInheritanceAttr::Keyword_virtual_inheritance:
2366 Flags |= llvm::DINode::FlagVirtualInheritance;
2367 break;
2368 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2369 break;
2370 }
2371 }
2372 }
2373
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002374 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002375 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002376 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002377 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2378 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002379
2380 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002381 Ty->getPointeeType()->getAs<FunctionProtoType>();
2382 return DBuilder.createMemberPointerType(
2383 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2384 Ty->getClass(), FPT->getTypeQuals())),
2385 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002386 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002387}
2388
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002389llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002390 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2391 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002392}
2393
Xiuli Pan9c14e282016-01-09 12:53:17 +00002394llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2395 llvm::DIFile *U) {
2396 return getOrCreateType(Ty->getElementType(), U);
2397}
2398
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002399llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002400 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002401
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002403 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002404 if (!ED->getTypeForDecl()->isIncompleteType()) {
2405 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002406 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002407 }
2408
Manman Rene0064d82013-08-29 23:19:58 +00002409 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2410
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002411 bool isImportedFromModule =
2412 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2413
Guy Benyei11169dd2012-12-18 14:30:41 +00002414 // If this is just a forward declaration, construct an appropriately
2415 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002416 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002417 // Note that it is possible for enums to be created as part of
2418 // their own declcontext. In this case a FwdDecl will be created
2419 // twice. This doesn't cause a problem because both FwdDecls are
2420 // entered into the ReplaceMap: finalize() will replace the first
2421 // FwdDecl with the second and then replace the second with
2422 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002423 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002424 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002425 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2426 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002427
Guy Benyei11169dd2012-12-18 14:30:41 +00002428 unsigned Line = getLineNumber(ED->getLocation());
2429 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002430 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002431 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2432 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Adrian Prantla40030f2016-02-06 01:59:09 +00002433
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002434 ReplaceMap.emplace_back(
2435 std::piecewise_construct, std::make_tuple(Ty),
2436 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002437 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002438 }
2439
David Blaikie483a9da2014-05-06 18:35:21 +00002440 return CreateTypeDefinition(Ty);
2441}
2442
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002443llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002444 const EnumDecl *ED = Ty->getDecl();
2445 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002446 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002447 if (!ED->getTypeForDecl()->isIncompleteType()) {
2448 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002449 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002450 }
2451
2452 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2453
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002454 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002455 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002456 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002457 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002458 Enumerators.push_back(DBuilder.createEnumerator(
2459 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002460 }
2461
2462 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002463 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002464
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002465 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002466 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002467 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002468 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002469 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2470 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2471 Line, Size, Align, EltArray, ClassTy,
2472 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002473}
2474
Amjad Aboud546bc112017-02-09 22:07:24 +00002475llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2476 unsigned MType, SourceLocation LineLoc,
2477 StringRef Name, StringRef Value) {
2478 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2479 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2480}
2481
2482llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2483 SourceLocation LineLoc,
2484 SourceLocation FileLoc) {
2485 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2486 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2487 return DBuilder.createTempMacroFile(Parent, Line, FName);
2488}
2489
David Blaikie05491062013-01-21 04:37:12 +00002490static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2491 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002492 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002493 Qualifiers InnerQuals = T.getLocalQualifiers();
2494 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2495 // that is already there.
2496 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2497 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002498 QualType LastT = T;
2499 switch (T->getTypeClass()) {
2500 default:
David Blaikie05491062013-01-21 04:37:12 +00002501 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002502 case Type::TemplateSpecialization: {
2503 const auto *Spec = cast<TemplateSpecializationType>(T);
2504 if (Spec->isTypeAlias())
2505 return C.getQualifiedType(T.getTypePtr(), Quals);
2506 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002507 break;
2508 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002509 case Type::TypeOfExpr:
2510 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2511 break;
2512 case Type::TypeOf:
2513 T = cast<TypeOfType>(T)->getUnderlyingType();
2514 break;
2515 case Type::Decltype:
2516 T = cast<DecltypeType>(T)->getUnderlyingType();
2517 break;
2518 case Type::UnaryTransform:
2519 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2520 break;
2521 case Type::Attributed:
2522 T = cast<AttributedType>(T)->getEquivalentType();
2523 break;
2524 case Type::Elaborated:
2525 T = cast<ElaboratedType>(T)->getNamedType();
2526 break;
2527 case Type::Paren:
2528 T = cast<ParenType>(T)->getInnerType();
2529 break;
David Blaikie05491062013-01-21 04:37:12 +00002530 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002531 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002532 break;
Richard Smitha0abc422017-02-22 00:13:14 +00002533 case Type::Auto:
2534 case Type::DeducedTemplateSpecialization: {
2535 QualType DT = cast<DeducedType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002536 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002537 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 break;
2539 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002540 case Type::Adjusted:
2541 case Type::Decayed:
2542 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2543 T = cast<AdjustedType>(T)->getAdjustedType();
2544 break;
2545 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002546
Guy Benyei11169dd2012-12-18 14:30:41 +00002547 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002548 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002549 } while (true);
2550}
2551
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002552llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002553
2554 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002555 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002556
David Blaikief427b002014-05-06 03:42:01 +00002557 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002558 if (it != TypeCache.end()) {
2559 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002560 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002561 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002562 }
2563
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002564 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002565}
2566
David Blaikie0e716b42014-03-03 23:48:23 +00002567void CGDebugInfo::completeTemplateDefinition(
2568 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002569 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002570 return;
David Blaikie1ac9c982017-04-11 21:13:37 +00002571 completeUnusedClass(SD);
2572}
David Blaikie0856f662014-03-04 22:01:08 +00002573
David Blaikie1ac9c982017-04-11 21:13:37 +00002574void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2575 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2576 return;
2577
2578 completeClassData(&D);
David Blaikie0e716b42014-03-03 23:48:23 +00002579 // In case this type has no member function definitions being emitted, ensure
2580 // it is retained
David Blaikie1ac9c982017-04-11 21:13:37 +00002581 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
David Blaikie0e716b42014-03-03 23:48:23 +00002582}
2583
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002584llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002585 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002586 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002587
2588 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002589 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002590
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002591 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002592 return T;
2593
Adrian Prantlca844182015-09-11 17:23:03 +00002594 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002595 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002596
2597 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002598 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002599
Guy Benyei11169dd2012-12-18 14:30:41 +00002600 return Res;
2601}
2602
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002603llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002604 // A forward declaration inside a module header does not belong to the module.
2605 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2606 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002607 if (DebugTypeExtRefs && D->isFromASTFile()) {
2608 // Record a reference to an imported clang module or precompiled header.
2609 auto *Reader = CGM.getContext().getExternalSource();
2610 auto Idx = D->getOwningModuleID();
2611 auto Info = Reader->getSourceDescriptor(Idx);
2612 if (Info)
2613 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2614 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002615 // We are building a clang module or a precompiled header.
2616 //
2617 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2618 // and it wouldn't be necessary to specify the parent scope
2619 // because the type is already unique by definition (it would look
2620 // like the output of -fno-standalone-debug). On the other hand,
2621 // the parent scope helps a consumer to quickly locate the object
2622 // file where the type's definition is located, so it might be
2623 // best to make this behavior a command line or debugger tuning
2624 // option.
2625 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
Richard Smith54f04402017-05-18 02:29:20 +00002626 if (Module *M = D->getOwningModule()) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002627 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002628 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2629 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002630 } else {
2631 // This the precompiled header being built.
2632 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002633 }
2634 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002635
Adrian Prantl9402cef2015-09-20 16:51:35 +00002636 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002637}
2638
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002639llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002640 // Handle qualifiers, which recursively handles what they refer to.
2641 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002642 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002643
Guy Benyei11169dd2012-12-18 14:30:41 +00002644 // Work out details of type.
2645 switch (Ty->getTypeClass()) {
2646#define TYPE(Class, Base)
2647#define ABSTRACT_TYPE(Class, Base)
2648#define NON_CANONICAL_TYPE(Class, Base)
2649#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2650#include "clang/AST/TypeNodes.def"
2651 llvm_unreachable("Dependent types cannot show up in debug information");
2652
2653 case Type::ExtVector:
2654 case Type::Vector:
2655 return CreateType(cast<VectorType>(Ty), Unit);
2656 case Type::ObjCObjectPointer:
2657 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2658 case Type::ObjCObject:
2659 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002660 case Type::ObjCTypeParam:
2661 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002662 case Type::ObjCInterface:
2663 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2664 case Type::Builtin:
2665 return CreateType(cast<BuiltinType>(Ty));
2666 case Type::Complex:
2667 return CreateType(cast<ComplexType>(Ty));
2668 case Type::Pointer:
2669 return CreateType(cast<PointerType>(Ty), Unit);
2670 case Type::BlockPointer:
2671 return CreateType(cast<BlockPointerType>(Ty), Unit);
2672 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002673 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002674 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002675 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002676 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002677 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002678 case Type::FunctionProto:
2679 case Type::FunctionNoProto:
2680 return CreateType(cast<FunctionType>(Ty), Unit);
2681 case Type::ConstantArray:
2682 case Type::VariableArray:
2683 case Type::IncompleteArray:
2684 return CreateType(cast<ArrayType>(Ty), Unit);
2685
2686 case Type::LValueReference:
2687 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2688 case Type::RValueReference:
2689 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2690
2691 case Type::MemberPointer:
2692 return CreateType(cast<MemberPointerType>(Ty), Unit);
2693
2694 case Type::Atomic:
2695 return CreateType(cast<AtomicType>(Ty), Unit);
2696
Xiuli Pan9c14e282016-01-09 12:53:17 +00002697 case Type::Pipe:
2698 return CreateType(cast<PipeType>(Ty), Unit);
2699
Guy Benyei11169dd2012-12-18 14:30:41 +00002700 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002701 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2702
David Blaikie42edade2014-11-11 20:44:45 +00002703 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002704 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00002705 case Type::Adjusted:
2706 case Type::Decayed:
Richard Smith600b5262017-01-26 20:40:47 +00002707 case Type::DeducedTemplateSpecialization:
Guy Benyei11169dd2012-12-18 14:30:41 +00002708 case Type::Elaborated:
2709 case Type::Paren:
2710 case Type::SubstTemplateTypeParm:
2711 case Type::TypeOfExpr:
2712 case Type::TypeOf:
2713 case Type::Decltype:
2714 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002715 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002716 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002717 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002718
David Blaikie42edade2014-11-11 20:44:45 +00002719 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002720}
2721
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002722llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2723 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002724 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002725
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002726 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002727
2728 // We may have cached a forward decl when we could have created
2729 // a non-forward decl. Go ahead and create a non-forward decl
2730 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002731 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002732 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002733
2734 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002735 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002736
2737 // Propagate members from the declaration to the definition
2738 // CreateType(const RecordType*) will overwrite this with the members in the
2739 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002740 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002741
Guy Benyei11169dd2012-12-18 14:30:41 +00002742 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002743 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002744 return Res;
2745}
2746
2747// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002748llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002749 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002750
Guy Benyei11169dd2012-12-18 14:30:41 +00002751 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002752 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002753 unsigned Line = getLineNumber(RD->getLocation());
2754 StringRef RDName = getClassName(RD);
2755
Amjad Abouddc4531e2016-04-30 01:44:38 +00002756 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002757
David Blaikied2785892013-08-18 17:36:19 +00002758 // If we ended up creating the type during the context chain construction,
2759 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002760 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002761 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002762 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002763 return T;
David Blaikied2785892013-08-18 17:36:19 +00002764
Adrian Prantl381e7552014-02-04 21:29:50 +00002765 // If this is just a forward or incomplete declaration, construct an
2766 // appropriately marked node and just return it.
2767 const RecordDecl *D = RD->getDefinition();
2768 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002769 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002770
2771 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002772 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002773
Manman Rene0064d82013-08-29 23:19:58 +00002774 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2775
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002776 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00002777 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
2778 llvm::DINode::FlagZero, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002779
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002780 // Elements of composite types usually have back to the type, creating
2781 // uniquing cycles. Distinct nodes are more efficient.
2782 switch (RealDecl->getTag()) {
2783 default:
2784 llvm_unreachable("invalid composite type tag");
2785
2786 case llvm::dwarf::DW_TAG_array_type:
2787 case llvm::dwarf::DW_TAG_enumeration_type:
2788 // Array elements and most enumeration elements don't have back references,
2789 // so they don't tend to be involved in uniquing cycles and there is some
2790 // chance of merging them when linking together two modules. Only make
2791 // them distinct if they are ODR-uniqued.
2792 if (FullName.empty())
2793 break;
Galina Kistanova0872d6c2017-06-03 06:30:46 +00002794 LLVM_FALLTHROUGH;
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002795
2796 case llvm::dwarf::DW_TAG_structure_type:
2797 case llvm::dwarf::DW_TAG_union_type:
2798 case llvm::dwarf::DW_TAG_class_type:
2799 // Immediatley resolve to a distinct node.
2800 RealDecl =
2801 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2802 break;
2803 }
2804
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002805 RegionMap[Ty->getDecl()].reset(RealDecl);
2806 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002807
David Majnemer58ed0f32016-07-17 00:39:12 +00002808 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002809 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002810 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002811 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002812}
2813
David Blaikieadfbf992013-08-18 16:55:33 +00002814void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002815 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002816 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002817 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002818 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2819 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002820 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002821 while (1) {
2822 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2823 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2824 if (PBT && !BRL.isPrimaryBaseVirtual())
2825 PBase = PBT;
2826 else
2827 break;
2828 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002829 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002830 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2831 getOrCreateFile(RD->getLocation())));
2832 } else if (RD->isDynamicClass())
2833 ContainingType = RealDecl;
2834
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002835 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002836}
2837
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002838llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002839 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002840 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002841 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002842 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002843 llvm::DIType *Ty =
2844 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
2845 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002846 *Offset += FieldSize;
2847 return Ty;
2848}
2849
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002850void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002851 StringRef &Name,
2852 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002853 llvm::DIScope *&FDContext,
2854 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00002855 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002856 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00002857 Name = getFunctionName(FD);
2858 // Use mangled name as linkage name for C/C++ functions.
2859 if (FD->hasPrototype()) {
2860 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002861 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002862 }
2863 // No need to replicate the linkage name if it isn't different from the
2864 // subprogram name, no need to have it at all unless coverage is enabled or
Dehao Chenb3a70de2017-01-19 00:44:21 +00002865 // debug is set to more than just line tables or extra debug info is needed.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002866 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2867 !CGM.getCodeGenOpts().EmitGcovNotes &&
Dehao Chenb3a70de2017-01-19 00:44:21 +00002868 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
Benjamin Kramer8c305922016-02-02 11:06:51 +00002869 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00002870 LinkageName = StringRef();
2871
Benjamin Kramer8c305922016-02-02 11:06:51 +00002872 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002873 if (const NamespaceDecl *NSDecl =
Adrian Prantl6fc88752017-05-16 23:46:10 +00002874 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Adrian Prantlddb8e062017-05-12 16:23:53 +00002875 FDContext = getOrCreateNamespace(NSDecl);
Frederic Riss9db79f12014-11-18 03:40:46 +00002876 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002877 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2878 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2879 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2880 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00002881 // Check if it is a noreturn-marked function
2882 if (FD->isNoReturn())
2883 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00002884 // Collect template parameters.
2885 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2886 }
2887}
2888
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002889void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002890 unsigned &LineNo, QualType &T,
2891 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002892 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002893 Unit = getOrCreateFile(VD->getLocation());
2894 LineNo = getLineNumber(VD->getLocation());
2895
2896 setLocation(VD->getLocation());
2897
2898 T = VD->getType();
2899 if (T->isIncompleteArrayType()) {
2900 // CodeGen turns int[] into int[1] so we'll do the same here.
2901 llvm::APInt ConstVal(32, 1);
2902 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2903
2904 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2905 ArrayType::Normal, 0);
2906 }
2907
2908 Name = VD->getName();
2909 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2910 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2911 LinkageName = CGM.getMangledName(VD);
2912 if (LinkageName == Name)
2913 LinkageName = StringRef();
2914
2915 // Since we emit declarations (DW_AT_members) for static members, place the
2916 // definition of those static members in the namespace they were declared in
2917 // in the source code (the lexical decl context).
2918 // FIXME: Generalize this for even non-member global variables where the
2919 // declaration and definition may have different lexical decl contexts, once
2920 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002921 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2922 : VD->getDeclContext();
2923 // When a record type contains an in-line initialization of a static data
2924 // member, and the record type is marked as __declspec(dllexport), an implicit
2925 // definition of the member will be created in the record context. DWARF
2926 // doesn't seem to have a nice way to describe this in a form that consumers
2927 // are likely to understand, so fake the "normal" situation of a definition
2928 // outside the class by putting it in the global scope.
2929 if (DC->isRecord())
2930 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002931
Amjad Abouddc4531e2016-04-30 01:44:38 +00002932 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2933 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002934}
2935
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002936llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
2937 bool Stub) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002938 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002939 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00002940 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002941 SourceLocation Loc = GD.getDecl()->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002942 llvm::DIFile *Unit = getOrCreateFile(Loc);
2943 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002944 unsigned Line = getLineNumber(Loc);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002945 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext,
Frederic Rissd253ed62014-11-18 03:40:51 +00002946 TParamsArray, Flags);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002947 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
2948
Frederic Rissd253ed62014-11-18 03:40:51 +00002949 // Build function type.
2950 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002951 if (FD)
2952 for (const ParmVarDecl *Parm : FD->parameters())
2953 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00002954 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2955 QualType FnType = CGM.getContext().getFunctionType(
2956 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002957 if (Stub) {
2958 return DBuilder.createFunction(
2959 DContext, Name, LinkageName, Unit, Line,
2960 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
2961 !FD->isExternallyVisible(),
2962 /* isDefinition = */ true, 0, Flags, CGM.getLangOpts().Optimize,
2963 TParamsArray.get(), getFunctionDeclaration(FD));
2964 }
2965
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002966 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002967 DContext, Name, LinkageName, Unit, Line,
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002968 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
2969 !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002970 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002971 TParamsArray.get(), getFunctionDeclaration(FD));
David Majnemer58ed0f32016-07-17 00:39:12 +00002972 const auto *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002973 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2974 std::make_tuple(CanonDecl),
2975 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002976 return SP;
2977}
2978
Adrian Prantlb7acfc02017-02-27 21:30:05 +00002979llvm::DISubprogram *
2980CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
2981 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
2982}
2983
2984llvm::DISubprogram *
2985CGDebugInfo::getFunctionStub(GlobalDecl GD) {
2986 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
2987}
2988
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002989llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002990CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2991 QualType T;
2992 StringRef Name, LinkageName;
2993 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002994 llvm::DIFile *Unit = getOrCreateFile(Loc);
2995 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002996 unsigned Line = getLineNumber(Loc);
2997
2998 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00002999 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003000 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3001 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003002 !VD->isExternallyVisible(), nullptr, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003003 FwdDeclReplaceMap.emplace_back(
3004 std::piecewise_construct,
3005 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3006 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003007 return GV;
3008}
3009
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003010llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003011 // We only need a declaration (not a definition) of the type - so use whatever
3012 // we would otherwise do to get a type for a pointee. (forward declarations in
3013 // limited debug info, full definitions (if the type definition is available)
3014 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00003015 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00003016 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00003017 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003018 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00003019
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003020 if (I != DeclCache.end()) {
3021 auto N = I->second;
3022 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3023 return GVE->getVariable();
3024 return dyn_cast_or_null<llvm::DINode>(N);
3025 }
Frederic Rissd253ed62014-11-18 03:40:51 +00003026
3027 // No definition for now. Emit a forward definition that might be
3028 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00003029 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00003030 return getFunctionForwardDeclaration(FD);
3031 else if (const auto *VD = dyn_cast<VarDecl>(D))
3032 return getGlobalVariableForwardDeclaration(VD);
3033
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003034 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00003035}
3036
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003037llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003038 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003039 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00003040
David Majnemer58ed0f32016-07-17 00:39:12 +00003041 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00003042 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003043 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003044
3045 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003046 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003047
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003048 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00003049 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003050 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003051 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003052 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00003053 }
3054 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003055 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003056 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003057 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003058 return SP;
3059 }
3060
Aaron Ballman86c93902014-03-06 23:45:36 +00003061 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003062 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003063 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003064 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003065 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003066 return SP;
3067 }
3068 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003069 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003070}
3071
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003072// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00003073// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003074llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003075 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003076 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003077 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003078 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3079 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00003080 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00003081
David Majnemer58ed0f32016-07-17 00:39:12 +00003082 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00003083 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00003084
3085 const auto *FTy = FnType->getAs<FunctionType>();
3086 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3087
David Majnemer58ed0f32016-07-17 00:39:12 +00003088 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003089 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003090 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00003091
3092 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00003093 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00003094
3095 // Replace the instancetype keyword with the actual type.
3096 if (ResultTy == CGM.getContext().getObjCInstanceType())
3097 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00003098 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00003099
Adrian Prantl7bec9032013-05-10 21:08:31 +00003100 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003101 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003102 QualType SelfDeclTy;
3103 if (auto *SelfDecl = OMethod->getSelfDecl())
3104 SelfDeclTy = SelfDecl->getType();
3105 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3106 if (FPT->getNumParams() > 1)
3107 SelfDeclTy = FPT->getParamType(0);
3108 if (!SelfDeclTy.isNull())
3109 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003110 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003111 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003112 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003113 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003114 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003115 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003116 // Variadic methods need a special marker at the end of the type list.
3117 if (OMethod->isVariadic())
3118 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003119
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003120 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003121 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3122 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003123 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003124
Adrian Prantl800faef2014-02-25 23:42:18 +00003125 // Handle variadic function types; they need an additional
3126 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003127 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003128 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003129 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003130 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003131 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3132 for (QualType ParamType : FPT->param_types())
3133 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003134 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003135 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003136 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3137 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003138 }
3139
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003140 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003141}
3142
Eric Christophere7b87e52014-10-26 23:40:33 +00003143void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3144 SourceLocation ScopeLoc, QualType FnType,
3145 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003146
3147 StringRef Name;
3148 StringRef LinkageName;
3149
3150 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3151
3152 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003153 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003154
Leny Kholodov80c047d2016-09-06 10:48:04 +00003155 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003156 llvm::DIFile *Unit = getOrCreateFile(Loc);
3157 llvm::DIScope *FDContext = Unit;
3158 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003159 if (!HasDecl) {
3160 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003161 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003162 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003163 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003164 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003165 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003166 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003167 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003168 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003169 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003170 return;
3171 }
3172 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003173 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3174 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003175 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003176 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003177 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003178 } else {
3179 // Use llvm function name.
3180 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003181 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003182 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003183 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003184 Name = Name.substr(1);
3185
Adrian Prantl42d71b92014-04-10 23:21:53 +00003186 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003187 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003188 // Artificial functions should not silently reuse CurLoc.
3189 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003190 }
3191 unsigned LineNo = getLineNumber(Loc);
3192 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003193
Eric Christopher8018e412014-03-27 18:50:35 +00003194 // FIXME: The function declaration we're constructing here is mostly reusing
3195 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3196 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3197 // all subprograms instead of the actual context since subprogram definitions
3198 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003199 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003200 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00003201 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003202 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003203 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003204 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003205 // We might get here with a VarDecl in the case we're generating
3206 // code for the initialization of globals. Do not record these decls
3207 // as they will overwrite the actual VarDecl Decl in the cache.
3208 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003209 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003210
Adrian Prantlbebb8932014-03-21 21:01:58 +00003211 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003212 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003213
Guy Benyei11169dd2012-12-18 14:30:41 +00003214 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003215 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003216}
3217
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003218void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3219 QualType FnType) {
3220 StringRef Name;
3221 StringRef LinkageName;
3222
3223 const Decl *D = GD.getDecl();
3224 if (!D)
3225 return;
3226
Leny Kholodov80c047d2016-09-06 10:48:04 +00003227 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003228 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003229 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003230 llvm::DINodeArray TParamsArray;
3231 if (isa<FunctionDecl>(D)) {
3232 // If there is a DISubprogram for this function available then use it.
3233 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3234 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003235 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003236 Name = getObjCMethodName(OMD);
3237 Flags |= llvm::DINode::FlagPrototyped;
3238 } else {
3239 llvm_unreachable("not a function or ObjC method");
3240 }
3241 if (!Name.empty() && Name[0] == '\01')
3242 Name = Name.substr(1);
3243
3244 if (D->isImplicit()) {
3245 Flags |= llvm::DINode::FlagArtificial;
3246 // Artificial functions without a location should not silently reuse CurLoc.
3247 if (Loc.isInvalid())
3248 CurLoc = SourceLocation();
3249 }
3250 unsigned LineNo = getLineNumber(Loc);
3251 unsigned ScopeLine = 0;
3252
Adrian Prantle76bda52016-04-15 15:55:45 +00003253 DBuilder.retainType(DBuilder.createFunction(
3254 FDContext, Name, LinkageName, Unit, LineNo,
3255 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3256 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3257 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003258}
3259
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003260void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3261 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3262 // If there is a subprogram for this function available then use it.
3263 auto FI = SPCache.find(FD->getCanonicalDecl());
3264 llvm::DISubprogram *SP = nullptr;
3265 if (FI != SPCache.end())
3266 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3267 if (!SP)
3268 SP = getFunctionStub(GD);
3269 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3270 LexicalBlockStack.emplace_back(SP);
3271 setInlinedAt(Builder.getCurrentDebugLocation());
3272 EmitLocation(Builder, FD->getLocation());
3273}
3274
3275void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3276 assert(CurInlinedAt && "unbalanced inline scope stack");
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003277 EmitFunctionEnd(Builder, nullptr);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003278 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3279}
3280
David Blaikie835afb22015-01-21 23:08:17 +00003281void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003282 // Update our current location
3283 setLocation(Loc);
3284
Eric Christophere7b87e52014-10-26 23:40:33 +00003285 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3286 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003287
Adrian Prantle83b1302014-01-07 22:05:52 +00003288 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00003289 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003290 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
Guy Benyei11169dd2012-12-18 14:30:41 +00003291}
3292
Guy Benyei11169dd2012-12-18 14:30:41 +00003293void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003294 llvm::MDNode *Back = nullptr;
3295 if (!LexicalBlockStack.empty())
3296 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003297 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003298 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003299 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003300}
3301
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003302void CGDebugInfo::AppendAddressSpaceXDeref(
3303 unsigned AddressSpace,
3304 SmallVectorImpl<int64_t> &Expr) const {
3305 Optional<unsigned> DWARFAddressSpace =
3306 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3307 if (!DWARFAddressSpace)
3308 return;
3309
3310 Expr.push_back(llvm::dwarf::DW_OP_constu);
3311 Expr.push_back(DWARFAddressSpace.getValue());
3312 Expr.push_back(llvm::dwarf::DW_OP_swap);
3313 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3314}
3315
Eric Christopher0fdcb312013-05-16 00:52:20 +00003316void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3317 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003318 // Set our current location.
3319 setLocation(Loc);
3320
Guy Benyei11169dd2012-12-18 14:30:41 +00003321 // Emit a line table change for the current location inside the new scope.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003322 Builder.SetCurrentDebugLocation(
3323 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3324 LexicalBlockStack.back(), CurInlinedAt));
David Blaikie60a877b2014-10-22 19:34:33 +00003325
Benjamin Kramer8c305922016-02-02 11:06:51 +00003326 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003327 return;
3328
3329 // Create a new lexical block and push it on the stack.
3330 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003331}
3332
Eric Christopher0fdcb312013-05-16 00:52:20 +00003333void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3334 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003335 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3336
3337 // Provide an entry in the line table for the end of the block.
3338 EmitLocation(Builder, Loc);
3339
Benjamin Kramer8c305922016-02-02 11:06:51 +00003340 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003341 return;
3342
Guy Benyei11169dd2012-12-18 14:30:41 +00003343 LexicalBlockStack.pop_back();
3344}
3345
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003346void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003347 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3348 unsigned RCount = FnBeginRegionCount.back();
3349 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3350
3351 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003352 while (LexicalBlockStack.size() != RCount) {
3353 // Provide an entry in the line table for the end of the block.
3354 EmitLocation(Builder, CurLoc);
3355 LexicalBlockStack.pop_back();
3356 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003357 FnBeginRegionCount.pop_back();
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003358
3359 if (Fn && Fn->getSubprogram())
3360 DBuilder.finalizeSubprogram(Fn->getSubprogram());
Guy Benyei11169dd2012-12-18 14:30:41 +00003361}
3362
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003363llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003364 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003365
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003366 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003367 QualType FType;
3368 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003369 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003370
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003371 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003372 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003373
3374 FieldOffset = 0;
3375 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3376 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3377 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3378 FType = CGM.getContext().IntTy;
3379 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3380 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3381
3382 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3383 if (HasCopyAndDispose) {
3384 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003385 EltTys.push_back(
3386 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3387 EltTys.push_back(
3388 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003389 }
3390 bool HasByrefExtendedLayout;
3391 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003392 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3393 HasByrefExtendedLayout) &&
3394 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003395 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003396 EltTys.push_back(
3397 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003398 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003399
Guy Benyei11169dd2012-12-18 14:30:41 +00003400 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3401 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003402 CGM.getTarget().getPointerAlign(0))) {
3403 CharUnits FieldOffsetInBytes =
3404 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003405 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003406 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003407
Guy Benyei11169dd2012-12-18 14:30:41 +00003408 if (NumPaddingBytes.isPositive()) {
3409 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3410 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3411 pad, ArrayType::Normal, 0);
3412 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3413 }
3414 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003415
Guy Benyei11169dd2012-12-18 14:30:41 +00003416 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003417 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003418 FieldSize = CGM.getContext().getTypeSize(FType);
3419 FieldAlign = CGM.getContext().toBits(Align);
3420
Eric Christopherb2a008c2013-05-16 00:45:12 +00003421 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003422 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003423 FieldAlign, FieldOffset,
3424 llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003425 EltTys.push_back(FieldTy);
3426 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003427
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003428 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003429
Leny Kholodov80c047d2016-09-06 10:48:04 +00003430 llvm::DINode::DIFlags Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003431
Guy Benyei11169dd2012-12-18 14:30:41 +00003432 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003433 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003434}
3435
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003436void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3437 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00003438 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003439 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003440 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003441 if (VD->hasAttr<NoDebugAttr>())
3442 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003443
David Blaikie7fceebf2013-08-19 03:37:48 +00003444 bool Unwritten =
3445 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3446 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003447 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003448 if (!Unwritten)
3449 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003450 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003451 uint64_t XOffset = 0;
3452 if (VD->hasAttr<BlocksAttr>())
3453 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003454 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003455 Ty = getOrCreateType(VD->getType(), Unit);
3456
3457 // If there is no debug info for this type then do not emit debug info
3458 // for this variable.
3459 if (!Ty)
3460 return;
3461
Guy Benyei11169dd2012-12-18 14:30:41 +00003462 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003463 unsigned Line = 0;
3464 unsigned Column = 0;
3465 if (!Unwritten) {
3466 Line = getLineNumber(VD->getLocation());
3467 Column = getColumnNumber(VD->getLocation());
3468 }
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003469 SmallVector<int64_t, 13> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003470 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003471 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003472 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003473
3474 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3475
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003476 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3477 AppendAddressSpaceXDeref(AddressSpace, Expr);
3478
Alexey Bataev24f710182017-06-09 13:55:08 +00003479 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3480 // object pointer flag.
Alexey Bataev56223232017-06-09 13:40:18 +00003481 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3482 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3483 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3484 Flags |= llvm::DINode::FlagObjectPointer;
3485 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003486
Adrian Prantlc3782a12017-04-18 01:22:01 +00003487 // Note: Older versions of clang used to emit byval references with an extra
3488 // DW_OP_deref, because they referenced the IR arg directly instead of
3489 // referencing an alloca. Newer versions of LLVM don't treat allocas
3490 // differently from other function arguments when used in a dbg.declare.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003491 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003492 StringRef Name = VD->getName();
3493 if (!Name.empty()) {
3494 if (VD->hasAttr<BlocksAttr>()) {
Adrian Prantlc3782a12017-04-18 01:22:01 +00003495 // Here, we need an offset *into* the alloca.
Guy Benyei11169dd2012-12-18 14:30:41 +00003496 CharUnits offset = CharUnits::fromQuantity(32);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003497 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003498 // offset of __forwarding field
3499 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003500 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003501 Expr.push_back(offset.getQuantity());
3502 Expr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003503 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003504 // offset of x field
3505 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003506 Expr.push_back(offset.getQuantity());
Adrian Prantlc3782a12017-04-18 01:22:01 +00003507 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003508 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003509 // If VD is an anonymous union then Storage represents value for
3510 // all union fields.
David Majnemer58ed0f32016-07-17 00:39:12 +00003511 const auto *RD = cast<RecordDecl>(RT->getDecl());
Adrian Prantl0d820892015-04-29 15:05:50 +00003512 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003513 // GDB has trouble finding local variables in anonymous unions, so we emit
3514 // artifical local variables for each of the members.
3515 //
3516 // FIXME: Remove this code as soon as GDB supports this.
3517 // The debug info verifier in LLVM operates based on the assumption that a
3518 // variable has the same size as its storage and we had to disable the check
3519 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003520 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003521 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003522 StringRef FieldName = Field->getName();
3523
3524 // Ignore unnamed fields. Do not ignore unnamed records.
3525 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3526 continue;
3527
3528 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003529 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003530 auto *D = DBuilder.createAutoVariable(
3531 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003532 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003533
3534 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003535 DBuilder.insertDeclare(
3536 Storage, D, DBuilder.createExpression(Expr),
3537 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3538 Builder.GetInsertBlock());
Adrian Prantl0d820892015-04-29 15:05:50 +00003539 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003540 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003541 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003542
3543 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003544 auto *D = ArgNo
3545 ? DBuilder.createParameterVariable(
3546 Scope, Name, *ArgNo, Unit, Line, Ty,
3547 CGM.getLangOpts().Optimize, Flags)
3548 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3549 CGM.getLangOpts().Optimize, Flags,
3550 Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003551
3552 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003553 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003554 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003555 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003556}
3557
3558void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3559 llvm::Value *Storage,
3560 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003561 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003562 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003563}
3564
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003565llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3566 llvm::DIType *Ty) {
3567 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003568 if (CachedTy)
3569 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003570 return DBuilder.createObjectPointerType(Ty);
3571}
3572
Eric Christophere7b87e52014-10-26 23:40:33 +00003573void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3574 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003575 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003576 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003577 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003578
Craig Topper8a13c412014-05-21 05:09:00 +00003579 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003580 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003581 if (VD->hasAttr<NoDebugAttr>())
3582 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003583
Guy Benyei11169dd2012-12-18 14:30:41 +00003584 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003585
Guy Benyei11169dd2012-12-18 14:30:41 +00003586 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003587 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3588 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003589 if (isByRef)
3590 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003591 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003592 Ty = getOrCreateType(VD->getType(), Unit);
3593
3594 // Self is passed along as an implicit non-arg variable in a
3595 // block. Mark it as the object pointer.
Alexey Bataev56223232017-06-09 13:40:18 +00003596 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3597 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3598 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003599
3600 // Get location information.
3601 unsigned Line = getLineNumber(VD->getLocation());
3602 unsigned Column = getColumnNumber(VD->getLocation());
3603
3604 const llvm::DataLayout &target = CGM.getDataLayout();
3605
3606 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003607 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003608 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3609
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003610 SmallVector<int64_t, 9> addr;
Adrian Prantlc3782a12017-04-18 01:22:01 +00003611 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003612 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003613 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003614 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003615 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003616 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003617 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003618 offset =
3619 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003620 addr.push_back(offset.getQuantity());
3621 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003622 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003623 // offset of x field
3624 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003625 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003626 }
3627
3628 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003629 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003630 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003631 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003632 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003633
Guy Benyei11169dd2012-12-18 14:30:41 +00003634 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003635 auto DL =
3636 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
Adrian Prantlc3782a12017-04-18 01:22:01 +00003637 auto *Expr = DBuilder.createExpression(addr);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003638 if (InsertPoint)
Adrian Prantlc3782a12017-04-18 01:22:01 +00003639 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003640 else
Adrian Prantlc3782a12017-04-18 01:22:01 +00003641 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003642}
3643
Guy Benyei11169dd2012-12-18 14:30:41 +00003644void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3645 unsigned ArgNo,
3646 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003647 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003648 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003649}
3650
3651namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003652struct BlockLayoutChunk {
3653 uint64_t OffsetInBits;
3654 const BlockDecl::Capture *Capture;
3655};
3656bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3657 return l.OffsetInBits < r.OffsetInBits;
3658}
Guy Benyei11169dd2012-12-18 14:30:41 +00003659}
3660
3661void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003662 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003663 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003664 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003665 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003666 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003667 ASTContext &C = CGM.getContext();
3668 const BlockDecl *blockDecl = block.getBlockDecl();
3669
3670 // Collect some general information about the block's location.
3671 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003672 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003673 unsigned line = getLineNumber(loc);
3674 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003675
Guy Benyei11169dd2012-12-18 14:30:41 +00003676 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003677 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003678
3679 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003680 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003681
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003682 SmallVector<llvm::Metadata *, 16> fields;
David Majnemerb4b671e2016-06-30 03:01:59 +00003683 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003684 blockLayout->getElementOffsetInBits(0),
3685 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003686 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003687 blockLayout->getElementOffsetInBits(1),
3688 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003689 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003690 blockLayout->getElementOffsetInBits(2),
3691 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003692 auto *FnTy = block.getBlockExpr()->getFunctionType();
3693 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
David Majnemerb4b671e2016-06-30 03:01:59 +00003694 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003695 blockLayout->getElementOffsetInBits(3),
3696 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003697 fields.push_back(createFieldType(
3698 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3699 ? C.getBlockDescriptorExtendedType()
3700 : C.getBlockDescriptorType()),
David Majnemerb4b671e2016-06-30 03:01:59 +00003701 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003702
3703 // We want to sort the captures by offset, not because DWARF
3704 // requires this, but because we're paranoid about debuggers.
3705 SmallVector<BlockLayoutChunk, 8> chunks;
3706
3707 // 'this' capture.
3708 if (blockDecl->capturesCXXThis()) {
3709 BlockLayoutChunk chunk;
3710 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003711 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003712 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003713 chunks.push_back(chunk);
3714 }
3715
3716 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003717 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003718 const VarDecl *variable = capture.getVariable();
3719 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3720
3721 // Ignore constant captures.
3722 if (captureInfo.isConstant())
3723 continue;
3724
3725 BlockLayoutChunk chunk;
3726 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003727 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003728 chunk.Capture = &capture;
3729 chunks.push_back(chunk);
3730 }
3731
3732 // Sort by offset.
3733 llvm::array_pod_sort(chunks.begin(), chunks.end());
3734
David Majnemer58ed0f32016-07-17 00:39:12 +00003735 for (const BlockLayoutChunk &Chunk : chunks) {
3736 uint64_t offsetInBits = Chunk.OffsetInBits;
3737 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00003738
3739 // If we have a null capture, this must be the C++ 'this' capture.
3740 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003741 QualType type;
3742 if (auto *Method =
3743 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3744 type = Method->getThisType(C);
3745 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3746 type = QualType(RDecl->getTypeForDecl(), 0);
3747 else
3748 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003749
David Majnemerb4b671e2016-06-30 03:01:59 +00003750 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003751 offsetInBits, tunit, tunit));
3752 continue;
3753 }
3754
3755 const VarDecl *variable = capture->getVariable();
3756 StringRef name = variable->getName();
3757
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003758 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003759 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003760 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00003761 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00003762
3763 // FIXME: this creates a second copy of this type!
3764 uint64_t xoffset;
3765 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003766 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00003767 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3768 PtrInfo.Width, Align, offsetInBits,
3769 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003770 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003771 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00003772 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00003773 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003774 }
3775 fields.push_back(fieldType);
3776 }
3777
3778 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003779 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3780 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003781
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003782 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003783
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003784 llvm::DIType *type =
3785 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00003786 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003787 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003788 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3789
3790 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00003791 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003792 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003793
3794 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003795 auto *debugVar = DBuilder.createParameterVariable(
3796 scope, Arg->getName(), ArgNo, tunit, line, type,
3797 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003798
Adrian Prantl616bef42013-03-14 21:52:59 +00003799 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003800 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003801 DBuilder.insertDbgValueIntrinsic(
Adrian Prantl1fa18852017-07-28 20:21:08 +00003802 LocalAddr, debugVar, DBuilder.createExpression(),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003803 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
3804 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003805 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003806
Adrian Prantl616bef42013-03-14 21:52:59 +00003807 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003808 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003809 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003810 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003811}
3812
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003813llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003814CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3815 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003816 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003817
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003818 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003819 if (MI != StaticDataMemberCache.end()) {
3820 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003821 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003822 }
David Blaikiece763042013-08-20 21:49:21 +00003823
3824 // If the member wasn't found in the cache, lazily construct and add it to the
3825 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003826 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003827 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003828 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003829}
3830
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003831llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003832 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3833 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003834 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003835
3836 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003837 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003838 StringRef FieldName = Field->getName();
3839
3840 // Ignore unnamed fields, but recurse into anonymous records.
3841 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003842 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003843 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Eric Christophercab9fae2014-04-10 05:20:00 +00003844 Var, DContext);
3845 continue;
3846 }
3847 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003848 GVE = DBuilder.createGlobalVariableExpression(
3849 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
3850 Var->hasLocalLinkage());
3851 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00003852 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003853 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00003854}
3855
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003856void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003857 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003858 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003859 if (D->hasAttr<NoDebugAttr>())
3860 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00003861
3862 // If we already created a DIGlobalVariable for this declaration, just attach
3863 // it to the llvm::GlobalVariable.
3864 auto Cached = DeclCache.find(D->getCanonicalDecl());
3865 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003866 return Var->addDebugInfo(
3867 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00003868
Guy Benyei11169dd2012-12-18 14:30:41 +00003869 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003870 llvm::DIFile *Unit = nullptr;
3871 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003872 unsigned LineNo;
3873 StringRef DeclName, LinkageName;
3874 QualType T;
3875 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003876
3877 // Attempt to store one global variable for the declaration - even if we
3878 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003879 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003880
3881 // If this is an anonymous union then we'll want to emit a global
3882 // variable for each member of the anonymous union so that it's possible
3883 // to find the name of any field in the union.
3884 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003885 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003886 assert(RD->isAnonymousStructOrUnion() &&
3887 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003888 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003889 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003890 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003891
3892 SmallVector<int64_t, 4> Expr;
3893 unsigned AddressSpace =
3894 CGM.getContext().getTargetAddressSpace(D->getType());
3895 AppendAddressSpaceXDeref(AddressSpace, Expr);
3896
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003897 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00003898 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003899 Var->hasLocalLinkage(),
3900 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
Victor Leschuka7ece032016-10-20 00:13:19 +00003901 getOrCreateStaticDataMemberDeclarationOrNull(D), Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003902 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00003903 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003904 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00003905}
3906
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003907void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003908 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003909 if (VD->hasAttr<NoDebugAttr>())
3910 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00003911 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003912 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003913 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003914 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003915 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00003916 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3917 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003918 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3919 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3920 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003921 // Do not use global variables for enums.
3922 //
3923 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003924 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003925 return;
David Blaikiea15565562014-04-04 20:56:17 +00003926 // Do not emit separate definitions for function local const/statics.
3927 if (isa<FunctionDecl>(VD->getDeclContext()))
3928 return;
David Blaikiebb113912014-04-05 07:23:17 +00003929 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003930 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003931 if (VarD->isStaticDataMember()) {
3932 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003933 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003934 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00003935 //
3936 // FIXME: This is probably unnecessary, since Ty should reference RD
3937 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00003938 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003939 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003940 return;
3941 }
3942
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003943 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003944
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003945 auto &GV = DeclCache[VD];
3946 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003947 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003948 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00003949 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
3950 // FIXME: Add a representation for integer constants wider than 64 bits.
3951 if (Init.isInt())
3952 InitExpr =
3953 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
3954 else if (Init.isFloat())
3955 InitExpr = DBuilder.createConstantValueExpression(
3956 Init.getFloat().bitcastToAPInt().getZExtValue());
3957 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003958 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00003959 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00003960 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
3961 Align));
David Blaikiebd483762013-05-20 04:58:53 +00003962}
3963
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003964llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003965 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003966 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003967 llvm::DIScope *Mod = getParentModuleOrNull(D);
3968 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003969}
3970
David Blaikie9f88fe82013-04-22 06:13:21 +00003971void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003972 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003973 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003974 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00003975 if (!NSDecl->isAnonymousNamespace() ||
3976 CGM.getCodeGenOpts().DebugExplicitImport) {
Adrian Prantl5649b0e2017-07-19 00:09:58 +00003977 auto Loc = UD.getLocation();
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003978 DBuilder.createImportedModule(
3979 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00003980 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003981 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003982}
3983
David Blaikiebd483762013-05-20 04:58:53 +00003984void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003985 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003986 return;
3987 assert(UD.shadow_size() &&
3988 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3989 // Emitting one decl is sufficient - debuggers can detect that this is an
3990 // overloaded name & provide lookup for all the overloads.
3991 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00003992
3993 // FIXME: Skip functions with undeduced auto return type for now since we
3994 // don't currently have the plumbing for separate declarations & definitions
3995 // of free functions and mismatched types (auto in the declaration, concrete
3996 // return type in the definition)
3997 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
3998 if (const auto *AT =
3999 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4000 if (AT->getDeducedType().isNull())
4001 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004002 if (llvm::DINode *Target =
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004003 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4004 auto Loc = USD.getLocation();
David Blaikiebd483762013-05-20 04:58:53 +00004005 DBuilder.createImportedDeclaration(
4006 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004007 getOrCreateFile(Loc), getLineNumber(Loc));
4008 }
David Blaikiebd483762013-05-20 04:58:53 +00004009}
4010
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004011void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00004012 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4013 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00004014 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00004015 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004016 auto Loc = ID.getLocation();
Adrian Prantl8a634c12015-12-18 19:44:31 +00004017 DBuilder.createImportedDeclaration(
4018 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004019 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4020 getLineNumber(Loc));
Adrian Prantl8a634c12015-12-18 19:44:31 +00004021 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004022}
4023
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004024llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00004025CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004026 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004027 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004028 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00004029 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004030 return cast<llvm::DIImportedEntity>(VH);
4031 llvm::DIImportedEntity *R;
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004032 auto Loc = NA.getLocation();
David Majnemer58ed0f32016-07-17 00:39:12 +00004033 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00004034 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4035 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00004036 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004037 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004038 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4039 getLineNumber(Loc), NA.getName());
David Blaikief121b932013-05-20 22:50:41 +00004040 else
David Blaikie551fb0a2014-04-06 06:30:03 +00004041 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004042 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantlddb8e062017-05-12 16:23:53 +00004043 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004044 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004045 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00004046 return R;
4047}
4048
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004049llvm::DINamespace *
Adrian Prantlddb8e062017-05-12 16:23:53 +00004050CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4051 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4052 // if necessary, and this way multiple declarations of the same namespace in
4053 // different parent modules stay distinct.
4054 auto I = NamespaceCache.find(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004055 if (I != NamespaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004056 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00004057
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004058 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004059 // Don't trust the context if it is a DIModule (see comment above).
Adrian Prantlddb8e062017-05-12 16:23:53 +00004060 llvm::DINamespace *NS =
4061 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4062 NamespaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00004063 return NS;
4064}
4065
Adrian Prantla5206ce2015-09-22 23:26:43 +00004066void CGDebugInfo::setDwoId(uint64_t Signature) {
4067 assert(TheCU && "no main compile unit");
4068 TheCU->setDWOId(Signature);
4069}
4070
4071
Guy Benyei11169dd2012-12-18 14:30:41 +00004072void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00004073 // Creating types might create further types - invalidating the current
4074 // element and the size(), so don't cache/reference them.
4075 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4076 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004077 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00004078 ? CreateTypeDefinition(E.Type, E.Unit)
4079 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004080 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00004081 }
4082
David Blaikief427b002014-05-06 03:42:01 +00004083 for (auto p : ReplaceMap) {
4084 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004085 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004086 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00004087
David Blaikief427b002014-05-06 03:42:01 +00004088 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00004089 assert(it != TypeCache.end());
4090 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00004091
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004092 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4093 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00004094 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00004095
Frederic Rissd253ed62014-11-18 03:40:51 +00004096 for (const auto &p : FwdDeclReplaceMap) {
4097 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004098 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004099 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00004100
4101 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00004102 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00004103 // with ourselves, that will destroy the temporary MDNode and
4104 // replace it with a standard one, avoiding leaking memory.
4105 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004106 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00004107 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004108 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00004109
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004110 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4111 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004112 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00004113 }
4114
Adrian Prantl73409ce2013-03-11 18:33:46 +00004115 // We keep our own list of retained types, because we need to look
4116 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00004117 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00004118 if (auto MD = TypeCache[RT])
4119 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00004120
Guy Benyei11169dd2012-12-18 14:30:41 +00004121 DBuilder.finalize();
4122}
David Blaikie66088d52014-09-24 17:01:27 +00004123
4124void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004125 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00004126 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004127
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00004128 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004129 // Don't ignore in case of explicit cast where it is referenced indirectly.
4130 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00004131}
Amara Emerson652795d2016-11-10 14:44:30 +00004132
4133llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4134 if (LexicalBlockStack.empty())
4135 return llvm::DebugLoc();
4136
4137 llvm::MDNode *Scope = LexicalBlockStack.back();
4138 return llvm::DebugLoc::get(
4139 getLineNumber(Loc), getColumnNumber(Loc), Scope);
4140}