blob: 2013825d33ca9c3529a658fa0d12ca41d0e51f7d [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());
110 CGF->Builder.SetCurrentDebugLocation(
111 llvm::DebugLoc::get(0, 0, DI->LexicalBlockStack.back()));
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
Guy Benyei11169dd2012-12-18 14:30:41 +0000137void CGDebugInfo::setLocation(SourceLocation Loc) {
138 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000139 if (Loc.isInvalid())
140 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000141
142 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
143
144 // If we've changed files in the middle of a lexical scope go ahead
145 // and create a new lexical scope with file node if it's different
146 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000147 if (LexicalBlockStack.empty())
148 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000149
150 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000151 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000152 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000153
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000154 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000155 return;
156
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000157 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000158 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000159 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
160 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000161 } else if (isa<llvm::DILexicalBlock>(Scope) ||
162 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000163 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000164 LexicalBlockStack.emplace_back(
165 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000166 }
167}
168
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000169llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000170 llvm::DIScope *Mod = getParentModuleOrNull(D);
171 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
172 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000173}
174
175llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
176 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000177 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000178 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000179
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000180 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000181 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000182 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000183 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000184 }
185
186 // Check namespace.
David Majnemer58ed0f32016-07-17 00:39:12 +0000187 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000188 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000189
David Majnemer58ed0f32016-07-17 00:39:12 +0000190 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000191 if (!RDecl->isDependentType())
192 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000193 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000194 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000195}
196
Guy Benyei11169dd2012-12-18 14:30:41 +0000197StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000198 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000199 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000200 FunctionTemplateSpecializationInfo *Info =
201 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000202
Reid Kleckner31abd802016-06-30 17:41:31 +0000203 // Emit the unqualified name in normal operation. LLVM and the debugger can
204 // compute the fully qualified name from the scope chain. If we're only
205 // emitting line table info, there won't be any scope chains, so emit the
206 // fully qualified name here so that stack traces are more accurate.
207 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
208 // evaluating the size impact.
209 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
210 CGM.getCodeGenOpts().EmitCodeView;
211
212 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000213 return FII->getName();
214
Benjamin Kramer9170e912013-02-22 15:46:01 +0000215 SmallString<128> NS;
216 llvm::raw_svector_ostream OS(NS);
Reid Kleckner60103382015-12-16 02:04:40 +0000217 PrintingPolicy Policy(CGM.getLangOpts());
Reid Kleckner829398e2016-06-17 16:11:20 +0000218 Policy.MSVCFormatting = CGM.getCodeGenOpts().EmitCodeView;
Reid Kleckner31abd802016-06-30 17:41:31 +0000219 if (!UseQualifiedName)
220 FD->printName(OS);
221 else
222 FD->printQualifiedName(OS, Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000223
Reid Kleckner829398e2016-06-17 16:11:20 +0000224 // Add any template specialization args.
225 if (Info) {
226 const TemplateArgumentList *TArgs = Info->TemplateArguments;
David Majnemer6fbeee32016-07-07 04:43:07 +0000227 TemplateSpecializationType::PrintTemplateArgumentList(OS, TArgs->asArray(),
Reid Kleckner829398e2016-06-17 16:11:20 +0000228 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000229 }
230
231 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000232 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000233}
234
235StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
236 SmallString<256> MethodName;
237 llvm::raw_svector_ostream OS(MethodName);
238 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
239 const DeclContext *DC = OMD->getDeclContext();
David Majnemer58ed0f32016-07-17 00:39:12 +0000240 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000241 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000242 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000243 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000244 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000245 if (OC->IsClassExtension()) {
246 OS << OC->getClassInterface()->getName();
247 } else {
David Majnemer58ed0f32016-07-17 00:39:12 +0000248 OS << OC->getIdentifier()->getNameStart() << '('
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000249 << OC->getIdentifier()->getNameStart() << ')';
250 }
David Majnemer58ed0f32016-07-17 00:39:12 +0000251 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000252 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
253 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000254 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000255 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000256 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000257 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000258 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000259 ClassTy.print(OS, PrintingPolicy(LangOptions()));
260 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000261 }
262 OS << ' ' << OMD->getSelector().getAsString() << ']';
263
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000264 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000265}
266
Guy Benyei11169dd2012-12-18 14:30:41 +0000267StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000268 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000269}
270
Eric Christophere7b87e52014-10-26 23:40:33 +0000271StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000272 if (isa<ClassTemplateSpecializationDecl>(RD)) {
273 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000274 llvm::raw_svector_ostream OS(Name);
275 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
276 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000277
278 // Copy this name on the side and use its reference.
279 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000280 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000281
David Majnemerbc5976a2016-07-01 23:12:54 +0000282 // quick optimization to avoid having to intern strings that are already
283 // stored reliably elsewhere
284 if (const IdentifierInfo *II = RD->getIdentifier())
285 return II->getName();
286
287 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
288 // used to reconstruct the fully qualified type names.
289 if (CGM.getCodeGenOpts().EmitCodeView) {
290 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
291 assert(RD->getDeclContext() == D->getDeclContext() &&
292 "Typedef should not be in another decl context!");
293 assert(D->getDeclName().getAsIdentifierInfo() &&
294 "Typedef was not named!");
295 return D->getDeclName().getAsIdentifierInfo()->getName();
296 }
297
298 if (CGM.getLangOpts().CPlusPlus) {
299 StringRef Name;
300
301 ASTContext &Context = CGM.getContext();
302 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
303 // Anonymous types without a name for linkage purposes have their
304 // declarator mangled in if they have one.
305 Name = DD->getName();
306 else if (const TypedefNameDecl *TND =
307 Context.getTypedefNameForUnnamedTagDecl(RD))
308 // Anonymous types without a name for linkage purposes have their
309 // associate typedef mangled in if they have one.
310 Name = TND->getName();
311
312 if (!Name.empty()) {
313 SmallString<256> UnnamedType("<unnamed-type-");
314 UnnamedType += Name;
315 UnnamedType += '>';
316 return internString(UnnamedType);
317 }
318 }
319 }
320
321 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000322}
323
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000324llvm::DIFile::ChecksumKind
325CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
326 Checksum.clear();
327
328 if (!CGM.getCodeGenOpts().EmitCodeView)
329 return llvm::DIFile::CSK_None;
330
331 SourceManager &SM = CGM.getContext().getSourceManager();
332 bool Invalid;
333 llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
334 if (Invalid)
335 return llvm::DIFile::CSK_None;
336
337 llvm::MD5 Hash;
338 llvm::MD5::MD5Result Result;
339
340 Hash.update(MemBuffer->getBuffer());
341 Hash.final(Result);
342
343 Hash.stringifyResult(Result, Checksum);
344 return llvm::DIFile::CSK_MD5;
345}
346
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000347llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000348 if (!Loc.isValid())
349 // If Location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000350 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000351 remapDIPath(TheCU->getDirectory()),
352 TheCU->getFile()->getChecksumKind(),
353 TheCU->getFile()->getChecksum());
Guy Benyei11169dd2012-12-18 14:30:41 +0000354
355 SourceManager &SM = CGM.getContext().getSourceManager();
356 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
357
358 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
359 // If the location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000360 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000361 remapDIPath(TheCU->getDirectory()),
362 TheCU->getFile()->getChecksumKind(),
363 TheCU->getFile()->getChecksum());
Guy Benyei11169dd2012-12-18 14:30:41 +0000364
365 // Cache the results.
366 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000367 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000368
369 if (it != DIFileCache.end()) {
370 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000371 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000372 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000373 }
374
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000375 SmallString<32> Checksum;
376 llvm::DIFile::ChecksumKind CSKind =
377 computeChecksum(SM.getFileID(Loc), Checksum);
378
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000379 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000380 remapDIPath(getCurrentDirname()),
381 CSKind, Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000382
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000383 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000384 return F;
385}
386
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000387llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000388 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000389 remapDIPath(TheCU->getDirectory()),
390 TheCU->getFile()->getChecksumKind(),
391 TheCU->getFile()->getChecksum());
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000392}
393
394std::string CGDebugInfo::remapDIPath(StringRef Path) const {
395 for (const auto &Entry : DebugPrefixMap)
396 if (Path.startswith(Entry.first))
397 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
398 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000399}
400
Guy Benyei11169dd2012-12-18 14:30:41 +0000401unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
402 if (Loc.isInvalid() && CurLoc.isInvalid())
403 return 0;
404 SourceManager &SM = CGM.getContext().getSourceManager();
405 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000406 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000407}
408
Adrian Prantlc7822422013-03-12 20:43:25 +0000409unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000410 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000411 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000412 return 0;
413
414 // If the location is invalid then use the current column.
415 if (Loc.isInvalid() && CurLoc.isInvalid())
416 return 0;
417 SourceManager &SM = CGM.getContext().getSourceManager();
418 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000419 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000420}
421
422StringRef CGDebugInfo::getCurrentDirname() {
423 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
424 return CGM.getCodeGenOpts().DebugCompilationDir;
425
426 if (!CWDName.empty())
427 return CWDName;
428 SmallString<256> CWD;
429 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000430 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000431}
432
Guy Benyei11169dd2012-12-18 14:30:41 +0000433void CGDebugInfo::CreateCompileUnit() {
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000434 SmallString<32> Checksum;
435 llvm::DIFile::ChecksumKind CSKind = llvm::DIFile::CSK_None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000436
David Blaikieaabde052014-05-14 00:29:00 +0000437 // Should we be asking the SourceManager for the main file name, instead of
438 // accepting it as an argument? This just causes the main file name to
439 // mismatch with source locations and create extra lexical scopes or
440 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
441 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
442 // because that's what the SourceManager says)
443
Guy Benyei11169dd2012-12-18 14:30:41 +0000444 // Get absolute path name.
445 SourceManager &SM = CGM.getContext().getSourceManager();
446 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
447 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000448 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000449
450 // The main file name provided via the "-main-file-name" option contains just
451 // the file name itself with no path information. This file name may have had
452 // a relative path, so we look into the actual file entry for the main
453 // file to determine the real absolute path for the file.
454 std::string MainFileDir;
455 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000456 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000457 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000458 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
459 llvm::sys::path::append(MainFileDirSS, MainFileName);
460 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000461 }
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000462 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 }
464
Ed Masteda706022014-05-07 12:49:30 +0000465 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000466 const LangOptions &LO = CGM.getLangOpts();
467 if (LO.CPlusPlus) {
468 if (LO.ObjC1)
469 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
470 else
471 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
472 } else if (LO.ObjC1) {
473 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000474 } else if (LO.RenderScript) {
475 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000476 } else if (LO.C99) {
477 LangTag = llvm::dwarf::DW_LANG_C99;
478 } else {
479 LangTag = llvm::dwarf::DW_LANG_C89;
480 }
481
482 std::string Producer = getClangFullVersion();
483
484 // Figure out which version of the ObjC runtime we have.
485 unsigned RuntimeVers = 0;
486 if (LO.ObjC1)
487 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
488
Adrian Prantl826824e2016-04-08 22:43:06 +0000489 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
490 switch (DebugKind) {
491 case codegenoptions::NoDebugInfo:
492 case codegenoptions::LocTrackingOnly:
493 EmissionKind = llvm::DICompileUnit::NoDebug;
494 break;
495 case codegenoptions::DebugLineTablesOnly:
496 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
497 break;
498 case codegenoptions::LimitedDebugInfo:
499 case codegenoptions::FullDebugInfo:
500 EmissionKind = llvm::DICompileUnit::FullDebug;
501 break;
502 }
503
Guy Benyei11169dd2012-12-18 14:30:41 +0000504 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000505 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000506 TheCU = DBuilder.createCompileUnit(
Amjad Aboudfa9a17e2016-12-14 20:24:40 +0000507 LangTag, DBuilder.createFile(remapDIPath(MainFileName),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000508 remapDIPath(getCurrentDirname()), CSKind,
509 Checksum),
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000510 Producer, LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers,
David Blaikiea45c31a2016-08-24 18:29:58 +0000511 CGM.getCodeGenOpts().SplitDwarfFile, EmissionKind, 0 /* DWOid */,
512 CGM.getCodeGenOpts().SplitDwarfInlining);
Guy Benyei11169dd2012-12-18 14:30:41 +0000513}
514
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000515llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000516 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000517 StringRef BTName;
518 switch (BT->getKind()) {
519#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000520#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000521#include "clang/AST/BuiltinTypes.def"
522 case BuiltinType::Dependent:
523 llvm_unreachable("Unexpected builtin type");
524 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000525 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000526 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000527 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000528 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000529 if (!ClassTy)
530 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
531 "objc_class", TheCU,
532 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000533 return ClassTy;
534 case BuiltinType::ObjCId: {
535 // typedef struct objc_class *Class;
536 // typedef struct objc_object {
537 // Class isa;
538 // } *id;
539
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000540 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000541 return ObjTy;
542
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000543 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000544 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
545 "objc_class", TheCU,
546 getOrCreateMainFile(), 0);
547
548 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000549
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000550 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000551
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000552 ObjTy = DBuilder.createStructType(
553 TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
554 llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000555
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000556 DBuilder.replaceArrays(
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000557 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
558 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
559 llvm::DINode::FlagZero, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000560 return ObjTy;
561 }
562 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000563 if (!SelTy)
564 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
565 "objc_selector", TheCU,
566 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000567 return SelTy;
568 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000569
Alexey Bader954ba212016-04-08 13:40:33 +0000570#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
571 case BuiltinType::Id: \
572 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
573 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000574#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000575 case BuiltinType::OCLSampler:
Yaxun Liu0bc4b2d2016-07-28 19:26:30 +0000576 return getOrCreateStructPtrType("opencl_sampler_t",
577 OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000578 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000579 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000580 case BuiltinType::OCLClkEvent:
581 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
582 case BuiltinType::OCLQueue:
583 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
584 case BuiltinType::OCLNDRange:
585 return getOrCreateStructPtrType("opencl_ndrange_t", OCLNDRangeDITy);
586 case BuiltinType::OCLReserveID:
587 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000588
Guy Benyei11169dd2012-12-18 14:30:41 +0000589 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000590 case BuiltinType::Char_U:
591 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
592 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000593 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000594 case BuiltinType::SChar:
595 Encoding = llvm::dwarf::DW_ATE_signed_char;
596 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000597 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000598 case BuiltinType::Char32:
599 Encoding = llvm::dwarf::DW_ATE_UTF;
600 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000601 case BuiltinType::UShort:
602 case BuiltinType::UInt:
603 case BuiltinType::UInt128:
604 case BuiltinType::ULong:
605 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000606 case BuiltinType::ULongLong:
607 Encoding = llvm::dwarf::DW_ATE_unsigned;
608 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000609 case BuiltinType::Short:
610 case BuiltinType::Int:
611 case BuiltinType::Int128:
612 case BuiltinType::Long:
613 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000614 case BuiltinType::LongLong:
615 Encoding = llvm::dwarf::DW_ATE_signed;
616 break;
617 case BuiltinType::Bool:
618 Encoding = llvm::dwarf::DW_ATE_boolean;
619 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000620 case BuiltinType::Half:
621 case BuiltinType::Float:
622 case BuiltinType::LongDouble:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000623 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000624 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000625 // FIXME: For targets where long double and __float128 have the same size,
626 // they are currently indistinguishable in the debugger without some
627 // special treatment. However, there is currently no consensus on encoding
628 // and this should be updated once a DWARF encoding exists for distinct
629 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000630 Encoding = llvm::dwarf::DW_ATE_float;
631 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000632 }
633
634 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000635 case BuiltinType::Long:
636 BTName = "long int";
637 break;
638 case BuiltinType::LongLong:
639 BTName = "long long int";
640 break;
641 case BuiltinType::ULong:
642 BTName = "long unsigned int";
643 break;
644 case BuiltinType::ULongLong:
645 BTName = "long long unsigned int";
646 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000647 default:
648 BTName = BT->getName(CGM.getLangOpts());
649 break;
650 }
Victor Leschuka7ece032016-10-20 00:13:19 +0000651 // Bit size and offset of the type.
Guy Benyei11169dd2012-12-18 14:30:41 +0000652 uint64_t Size = CGM.getContext().getTypeSize(BT);
Victor Leschuka7ece032016-10-20 00:13:19 +0000653 return DBuilder.createBasicType(BTName, Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000654}
655
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000656llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Victor Leschuka7ece032016-10-20 00:13:19 +0000657 // Bit size and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000658 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000659 if (Ty->isComplexIntegerType())
660 Encoding = llvm::dwarf::DW_ATE_lo_user;
661
662 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000663 return DBuilder.createBasicType("complex", Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000664}
665
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000666llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
667 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000668 QualifierCollector Qc;
669 const Type *T = Qc.strip(Ty);
670
671 // Ignore these qualifiers for now.
672 Qc.removeObjCGCAttr();
673 Qc.removeAddressSpace();
674 Qc.removeObjCLifetime();
675
676 // We will create one Derived type for one qualifier and recurse to handle any
677 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000678 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000679 if (Qc.hasConst()) {
680 Tag = llvm::dwarf::DW_TAG_const_type;
681 Qc.removeConst();
682 } else if (Qc.hasVolatile()) {
683 Tag = llvm::dwarf::DW_TAG_volatile_type;
684 Qc.removeVolatile();
685 } else if (Qc.hasRestrict()) {
686 Tag = llvm::dwarf::DW_TAG_restrict_type;
687 Qc.removeRestrict();
688 } else {
689 assert(Qc.empty() && "Unknown type qualifier for debug info");
690 return getOrCreateType(QualType(T, 0), Unit);
691 }
692
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000693 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000694
695 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
696 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000697 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000698}
699
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000700llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
701 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000702
703 // The frontend treats 'id' as a typedef to an ObjCObjectType,
704 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
705 // debug info, we want to emit 'id' in both cases.
706 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000707 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000708
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000709 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
710 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000711}
712
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000713llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
714 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000715 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000716 Ty->getPointeeType(), Unit);
717}
718
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000719/// \return whether a C++ mangling exists for the type defined by TD.
720static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
721 switch (TheCU->getSourceLanguage()) {
722 case llvm::dwarf::DW_LANG_C_plus_plus:
723 return true;
724 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
725 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
726 default:
727 return false;
728 }
729}
730
Manman Rene0064d82013-08-29 23:19:58 +0000731/// In C++ mode, types have linkage, so we can rely on the ODR and
732/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000733static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
734 CodeGenModule &CGM,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000735 llvm::DICompileUnit *TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000736 SmallString<256> FullName;
Manman Rene0064d82013-08-29 23:19:58 +0000737 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000738
739 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
Manman Rene0064d82013-08-29 23:19:58 +0000740 return FullName;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000741
Manman Rene0064d82013-08-29 23:19:58 +0000742 // TODO: This is using the RTTI name. Is there a better way to get
743 // a unique string for a type?
744 llvm::raw_svector_ostream Out(FullName);
745 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Manman Rene0064d82013-08-29 23:19:58 +0000746 return FullName;
747}
748
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000749/// \return the approproate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000750static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
751 llvm::dwarf::Tag Tag;
752 if (RD->isStruct() || RD->isInterface())
753 Tag = llvm::dwarf::DW_TAG_structure_type;
754 else if (RD->isUnion())
755 Tag = llvm::dwarf::DW_TAG_union_type;
756 else {
757 // FIXME: This could be a struct type giving a default visibility different
758 // than C++ class type, but needs llvm metadata changes first.
759 assert(RD->isClass());
760 Tag = llvm::dwarf::DW_TAG_class_type;
761 }
762 return Tag;
763}
764
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000765llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000766CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000767 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000768 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000769 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
770 return cast<llvm::DICompositeType>(T);
771 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000772 unsigned Line = getLineNumber(RD->getLocation());
773 StringRef RDName = getClassName(RD);
774
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000775 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000776 uint32_t Align = 0;
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000777
778 const RecordDecl *D = RD->getDefinition();
779 if (D && D->isCompleteDefinition()) {
780 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000781 Align = getDeclAlignIfRequired(D, CGM.getContext());
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000782 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000783
784 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000785 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000786 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000787 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000788 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000789 ReplaceMap.emplace_back(
790 std::piecewise_construct, std::make_tuple(Ty),
791 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000792 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000793}
794
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000795llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000796 const Type *Ty,
797 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000798 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000799 // Bit size, align and offset of the type.
800 // Size is always the size of a pointer. We can't use getTypeSize here
801 // because that does not return the correct value for references.
802 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000803 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +0000804 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +0000805
Keno Fischer87842f32015-11-16 09:04:13 +0000806 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
807 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
808 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
809 Size, Align);
810 else
811 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
812 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000813}
814
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000815llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
816 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000817 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000818 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000819 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
820 TheCU, getOrCreateMainFile(), 0);
821 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
822 Cache = DBuilder.createPointerType(Cache, Size);
823 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000824}
825
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000826llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
827 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000828 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000829 QualType FType;
830 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000831 uint32_t FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000832 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000833
834 FieldOffset = 0;
835 FType = CGM.getContext().UnsignedLongTy;
836 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
837 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
838
839 Elements = DBuilder.getOrCreateArray(EltTys);
840 EltTys.clear();
841
Leny Kholodov80c047d2016-09-06 10:48:04 +0000842 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000843 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000844
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000845 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000846 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000847 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000848
849 // Bit size, align and offset of the type.
850 uint64_t Size = CGM.getContext().getTypeSize(Ty);
851
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000852 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000853
854 FieldOffset = 0;
855 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
856 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
857 FType = CGM.getContext().IntTy;
858 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
859 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000860 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000861 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
862
863 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000864 FieldSize = CGM.getContext().getTypeSize(Ty);
865 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000866 EltTys.push_back(DBuilder.createMemberType(
867 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign, FieldOffset,
868 llvm::DINode::FlagZero, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000869
870 FieldOffset += FieldSize;
871 Elements = DBuilder.getOrCreateArray(EltTys);
872
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000873 // The __block_literal_generic structs are marked with a special
874 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
875 // the debugger needs to know about. To allow type uniquing, emit
876 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000877 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000878 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000879 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000880
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000881 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000882}
883
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000884llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
885 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000886 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000887 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000888
889 SmallString<128> NS;
890 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000891 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
892 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000893
894 TemplateSpecializationType::PrintTemplateArgumentList(
David Majnemer6fbeee32016-07-07 04:43:07 +0000895 OS, Ty->template_arguments(),
David Blaikief1b382e2014-04-06 17:14:06 +0000896 CGM.getContext().getPrintingPolicy());
897
David Majnemer58ed0f32016-07-17 00:39:12 +0000898 auto *AliasDecl = cast<TypeAliasTemplateDecl>(
Eric Christophere7b87e52014-10-26 23:40:33 +0000899 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000900
901 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000902 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
903 getLineNumber(Loc),
904 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000905}
906
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000907llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
908 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000909 // We don't set size information, but do specify where the typedef was
910 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +0000911 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000912
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000913 // Typedefs are derived from some other type.
914 return DBuilder.createTypedef(
915 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
916 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +0000917 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000918}
919
Reid Klecknerf00f8032016-06-08 20:41:54 +0000920static unsigned getDwarfCC(CallingConv CC) {
921 switch (CC) {
922 case CC_C:
923 // Avoid emitting DW_AT_calling_convention if the C convention was used.
924 return 0;
925
926 case CC_X86StdCall:
927 return llvm::dwarf::DW_CC_BORLAND_stdcall;
928 case CC_X86FastCall:
929 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
930 case CC_X86ThisCall:
931 return llvm::dwarf::DW_CC_BORLAND_thiscall;
932 case CC_X86VectorCall:
933 return llvm::dwarf::DW_CC_LLVM_vectorcall;
934 case CC_X86Pascal:
935 return llvm::dwarf::DW_CC_BORLAND_pascal;
936
937 // FIXME: Create new DW_CC_ codes for these calling conventions.
938 case CC_X86_64Win64:
939 case CC_X86_64SysV:
940 case CC_AAPCS:
941 case CC_AAPCS_VFP:
942 case CC_IntelOclBicc:
943 case CC_SpirFunction:
Nikolay Haustov8c6538b2016-06-30 09:06:33 +0000944 case CC_OpenCLKernel:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000945 case CC_Swift:
946 case CC_PreserveMost:
947 case CC_PreserveAll:
Erich Keane757d3172016-11-02 18:29:35 +0000948 case CC_X86RegCall:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000949 return 0;
950 }
951 return 0;
952}
953
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000954llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
955 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000956 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000957
958 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000959 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000960
961 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000962 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000963 if (isa<FunctionNoProtoType>(Ty))
964 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +0000965 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
966 for (const QualType &ParamType : FPT->param_types())
967 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000968 if (FPT->isVariadic())
969 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000970 }
971
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000972 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +0000973 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +0000974 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000975}
976
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000977/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000978/// As an optimization, return 0 if the access specifier equals the
979/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000980static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
981 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +0000982 AccessSpecifier Default = clang::AS_none;
983 if (RD && RD->isClass())
984 Default = clang::AS_private;
985 else if (RD && (RD->isStruct() || RD->isUnion()))
986 Default = clang::AS_public;
987
988 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +0000989 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000990
Eric Christophere7b87e52014-10-26 23:40:33 +0000991 switch (Access) {
992 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000993 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +0000994 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000995 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +0000996 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000997 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +0000998 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +0000999 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001000 }
1001 llvm_unreachable("unexpected access enumerator");
1002}
Guy Benyei11169dd2012-12-18 14:30:41 +00001003
David Majnemerb4b671e2016-06-30 03:01:59 +00001004llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1005 llvm::DIScope *RecordTy,
1006 const RecordDecl *RD) {
1007 StringRef Name = BitFieldDecl->getName();
1008 QualType Ty = BitFieldDecl->getType();
1009 SourceLocation Loc = BitFieldDecl->getLocation();
1010 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1011 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1012
1013 // Get the location for the field.
1014 llvm::DIFile *File = getOrCreateFile(Loc);
1015 unsigned Line = getLineNumber(Loc);
1016
1017 const CGBitFieldInfo &BitFieldInfo =
1018 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1019 uint64_t SizeInBits = BitFieldInfo.Size;
1020 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001021 uint64_t StorageOffsetInBits =
1022 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1023 uint64_t OffsetInBits = StorageOffsetInBits + BitFieldInfo.Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001024 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001025 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001026 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1027 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001028}
1029
1030llvm::DIType *
1031CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1032 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001033 uint32_t AlignInBits, llvm::DIFile *tunit,
1034 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001035 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001036
1037 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001038 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001039 unsigned line = getLineNumber(loc);
1040
David Majnemer34b57492014-07-30 01:30:47 +00001041 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001042 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001043 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001044 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1045 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001046 if (!Align)
1047 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001048 }
1049
Leny Kholodov80c047d2016-09-06 10:48:04 +00001050 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +00001051 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001052 Align, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001053}
1054
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001055void CGDebugInfo::CollectRecordLambdaFields(
1056 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001057 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001058 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1059 // has the name and the location of the variable so we should iterate over
1060 // both concurrently.
1061 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1062 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1063 unsigned fieldno = 0;
1064 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001065 E = CXXDecl->captures_end();
1066 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001067 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001068 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001069 SourceLocation Loc = C.getLocation();
1070 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001071 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001072 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001073 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001074 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001075 llvm::DIType *FieldType = createFieldType(
1076 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001077 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001078 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001079 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001080 // TODO: Need to handle 'this' in some way by probably renaming the
1081 // this of the lambda class and having a field member of 'this' or
1082 // by using AT_object_pointer for the function and having that be
1083 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001084 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001085 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001086 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001087 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001088 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001089 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001090
1091 elements.push_back(fieldType);
1092 }
1093 }
1094}
1095
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001096llvm::DIDerivedType *
1097CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001098 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001099 // Create the descriptor for the static variable, with or without
1100 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001101 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001102 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1103 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001104
Eric Christopher91a31902013-01-16 01:22:32 +00001105 unsigned LineNumber = getLineNumber(Var->getLocation());
1106 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001107 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001108 if (Var->getInit()) {
1109 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001110 if (Value) {
1111 if (Value->isInt())
1112 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1113 if (Value->isFloat())
1114 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1115 }
Eric Christopher91a31902013-01-16 01:22:32 +00001116 }
1117
Leny Kholodov80c047d2016-09-06 10:48:04 +00001118 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001119 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001120 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001121 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001122 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001123 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001124}
1125
Eric Christophere7b87e52014-10-26 23:40:33 +00001126void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001127 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1128 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001129 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001130 StringRef name = field->getName();
1131 QualType type = field->getType();
1132
1133 // Ignore unnamed fields unless they're anonymous structs/unions.
1134 if (name.empty() && !type->isRecordType())
1135 return;
1136
David Majnemerb4b671e2016-06-30 03:01:59 +00001137 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001138 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001139 FieldType = createBitFieldType(field, RecordTy, RD);
1140 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001141 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001142 FieldType =
1143 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001144 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001145 }
1146
David Majnemerb4b671e2016-06-30 03:01:59 +00001147 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001148}
1149
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001150void CGDebugInfo::CollectRecordNestedRecord(
1151 const RecordDecl *RD, SmallVectorImpl<llvm::Metadata *> &elements) {
1152 QualType Ty = CGM.getContext().getTypeDeclType(RD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001153 // Injected class names are not considered nested records.
1154 if (isa<InjectedClassNameType>(Ty))
1155 return;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001156 SourceLocation Loc = RD->getLocation();
1157 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1158 elements.push_back(nestedType);
1159}
1160
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001161void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001162 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001163 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001164 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001165 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001166
Eric Christopher91a31902013-01-16 01:22:32 +00001167 if (CXXDecl && CXXDecl->isLambda())
1168 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1169 else {
1170 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001171
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001172 // Debug info for nested records is included in the member list only for
1173 // CodeView.
1174 bool IncludeNestedRecords = CGM.getCodeGenOpts().EmitCodeView;
1175
Eric Christopher91a31902013-01-16 01:22:32 +00001176 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001177 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001178
Eric Christopher91a31902013-01-16 01:22:32 +00001179 // Static and non-static members should appear in the same order as
1180 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001181 for (const auto *I : record->decls())
1182 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001183 if (V->hasAttr<NoDebugAttr>())
1184 continue;
David Blaikiece763042013-08-20 21:49:21 +00001185 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001186 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001187 if (MI != StaticDataMemberCache.end()) {
1188 assert(MI->second &&
1189 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001190 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001191 } else {
1192 auto Field = CreateRecordStaticField(V, RecordTy, record);
1193 elements.push_back(Field);
1194 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001195 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001196 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1197 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001198
1199 // Bump field number for next field.
1200 ++fieldNo;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001201 } else if (const auto *nestedRec = dyn_cast<CXXRecordDecl>(I))
1202 if (IncludeNestedRecords && !nestedRec->isImplicit() &&
1203 nestedRec->getDeclContext() == record)
1204 CollectRecordNestedRecord(nestedRec, elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001205 }
1206}
1207
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001208llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001209CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001210 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001211 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001212 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001213 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001214 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001215 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1216 Func, Unit);
1217}
David Blaikie2aaf0652013-01-07 22:24:59 +00001218
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001219llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1220 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001221 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001222 llvm::DITypeRefArray Args(
1223 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001224 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001225 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001226
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001227 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001228
1229 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001230 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001231
David Blaikie2aaf0652013-01-07 22:24:59 +00001232 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001233 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001234 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1235 // Create pointer type directly in this case.
1236 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1237 QualType PointeeTy = ThisPtrTy->getPointeeType();
1238 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001239 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001240 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001241 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1242 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001243 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001244 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001245 // TODO: This and the artificial type below are misleading, the
1246 // types aren't artificial the argument is, but the current
1247 // metadata doesn't represent that.
1248 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1249 Elts.push_back(ThisPtrType);
1250 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001251 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001252 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001253 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1254 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001255 }
1256
1257 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001258 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1259 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001260
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001261 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001262
Leny Kholodov80c047d2016-09-06 10:48:04 +00001263 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001264 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001265 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001266 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001267 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001268
Reid Klecknerf00f8032016-06-08 20:41:54 +00001269 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1270 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001271}
1272
Eric Christopherb2a008c2013-05-16 00:45:12 +00001273/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001274/// inside a function.
1275static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001276 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001277 return isFunctionLocalClass(NRD);
1278 if (isa<FunctionDecl>(RD->getDeclContext()))
1279 return true;
1280 return false;
1281}
1282
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001283llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1284 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001285 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001286 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001287
Guy Benyei11169dd2012-12-18 14:30:41 +00001288 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001289 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001290
1291 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1292 // make sense to give a single ctor/dtor a linkage name.
1293 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001294 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1295 // property to use here. It may've been intended to model "is non-external
1296 // type" but misses cases of non-function-local but non-external classes such
1297 // as those in anonymous namespaces as well as the reverse - external types
1298 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001299 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1300 MethodLinkageName = CGM.getMangledName(Method);
1301
1302 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001303 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001304 unsigned MethodLine = 0;
1305 if (!Method->isImplicit()) {
1306 MethodDefUnit = getOrCreateFile(Method->getLocation());
1307 MethodLine = getLineNumber(Method->getLocation());
1308 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001309
1310 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001311 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001312 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001313 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001314 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001315 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001316
Guy Benyei11169dd2012-12-18 14:30:41 +00001317 if (Method->isVirtual()) {
1318 if (Method->isPure())
1319 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1320 else
1321 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001322
Reid Kleckner216d0a12016-06-16 20:08:51 +00001323 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1324 // It doesn't make sense to give a virtual destructor a vtable index,
1325 // since a single destructor has two entries in the vtable.
1326 if (!isa<CXXDestructorDecl>(Method))
1327 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1328 } else {
1329 // Emit MS ABI vftable information. There is only one entry for the
1330 // deleting dtor.
1331 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1332 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1333 MicrosoftVTableContext::MethodVFTableLocation ML =
1334 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1335 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001336
1337 // CodeView only records the vftable offset in the class that introduces
1338 // the virtual method. This is possible because, unlike Itanium, the MS
1339 // C++ ABI does not include all virtual methods from non-primary bases in
1340 // the vtable for the most derived class. For example, if C inherits from
1341 // A and B, C's primary vftable will not include B's virtual methods.
1342 if (Method->begin_overridden_methods() == Method->end_overridden_methods())
1343 Flags |= llvm::DINode::FlagIntroducedVirtual;
1344
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001345 // The 'this' adjustment accounts for both the virtual and non-virtual
1346 // portions of the adjustment. Presumably the debugger only uses it when
1347 // it knows the dynamic type of an object.
1348 ThisAdjustment = CGM.getCXXABI()
1349 .getVirtualFunctionPrologueThisAdjustment(GD)
1350 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001351 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001352 ContainingType = RecordTy;
1353 }
1354
Guy Benyei11169dd2012-12-18 14:30:41 +00001355 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001356 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001357 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001358 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001359 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001360 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001361 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001362 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001363 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001364 }
1365 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001366 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001367 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001368 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001369 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001370 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001371
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001372 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1373 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001374 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001375 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1376 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1377 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001378
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001379 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001380
1381 return SP;
1382}
1383
Eric Christophere7b87e52014-10-26 23:40:33 +00001384void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001385 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1386 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001387
1388 // Since we want more than just the individual member decls if we
1389 // have templated functions iterate over every declaration to gather
1390 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001391 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001392 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1393 // If the member is implicit, don't add it to the member list. This avoids
1394 // the member being added to type units by LLVM, while still allowing it
1395 // to be emitted into the type declaration/reference inside the compile
1396 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001397 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001398 // FIXME: Handle Using(Shadow?)Decls here to create
1399 // DW_TAG_imported_declarations inside the class for base decls brought into
1400 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1401 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1402 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001403 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001404 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001405
1406 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1407 continue;
1408
David Blaikiefd580722014-10-06 05:18:55 +00001409 // Reuse the existing member function declaration if it exists.
1410 // It may be associated with the declaration of the type & should be
1411 // reused as we're building the definition.
1412 //
1413 // This situation can arise in the vtable-based debug info reduction where
1414 // implicit members are emitted in a non-vtable TU.
1415 auto MI = SPCache.find(Method->getCanonicalDecl());
1416 EltTys.push_back(MI == SPCache.end()
1417 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001418 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001419 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001420}
Guy Benyei11169dd2012-12-18 14:30:41 +00001421
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001422void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001423 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001424 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001425 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1426 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1427 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001428
Bob Haarmandff36732016-10-25 22:19:32 +00001429 // If we are generating CodeView debug info, we also need to emit records for
1430 // indirect virtual base classes.
1431 if (CGM.getCodeGenOpts().EmitCodeView) {
1432 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1433 llvm::DINode::FlagIndirectVirtualBase);
1434 }
1435}
1436
1437void CGDebugInfo::CollectCXXBasesAux(
1438 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1439 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1440 const CXXRecordDecl::base_class_const_range &Bases,
1441 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1442 llvm::DINode::DIFlags StartingFlags) {
1443 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1444 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001445 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001446 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001447 if (!SeenTypes.insert(Base).second)
1448 continue;
1449 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1450 llvm::DINode::DIFlags BFlags = StartingFlags;
1451 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001452
Aaron Ballman574705e2014-03-13 15:41:46 +00001453 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001454 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1455 // virtual base offset offset is -ve. The code generator emits dwarf
1456 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001457 BaseOffset = 0 - CGM.getItaniumVTableContext()
1458 .getVirtualBaseOffsetOffset(RD, Base)
1459 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001460 } else {
1461 // In the MS ABI, store the vbtable offset, which is analogous to the
1462 // vbase offset offset in Itanium.
1463 BaseOffset =
1464 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1465 }
Bob Haarmandff36732016-10-25 22:19:32 +00001466 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001467 } else
1468 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1469 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1470 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001471
Adrian Prantl21361fb2014-08-29 22:44:27 +00001472 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Bob Haarmandff36732016-10-25 22:19:32 +00001473 llvm::DIType *DTy =
1474 DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001475 EltTys.push_back(DTy);
1476 }
1477}
1478
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001479llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001480CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1481 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001482 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001483 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001484 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1485 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001486 StringRef Name;
1487 if (TPList)
1488 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001489 switch (TA.getKind()) {
1490 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001491 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001492 TemplateParams.push_back(
1493 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001494 } break;
1495 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001496 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001497 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1498 TheCU, Name, TTy,
1499 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001500 } break;
1501 case TemplateArgument::Declaration: {
1502 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001503 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001504 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001505 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001506 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001507 // Variable pointer template parameters have a value that is the address
1508 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001509 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001510 V = CGM.GetAddrOfGlobalVar(VD);
1511 // Member function pointers have special support for building them, though
1512 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001513 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001514 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001515 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001516 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001517 // Member data pointers have special handling too to compute the fixed
1518 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001519 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001520 // These five lines (& possibly the above member function pointer
1521 // handling) might be able to be refactored to use similar code in
1522 // CodeGenModule::getMemberPointerConstant
1523 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1524 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001525 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001526 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001527 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001528 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1529 TheCU, Name, TTy,
1530 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001531 } break;
1532 case TemplateArgument::NullPtr: {
1533 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001534 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001535 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001536 // Special case member data pointer null values since they're actually -1
1537 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001538 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001539 // But treat member function pointers as simple zero integers because
1540 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1541 // CodeGen grows handling for values of non-null member function
1542 // pointers then perhaps we could remove this special case and rely on
1543 // EmitNullMemberPointer for member function pointers.
1544 if (MPT->isMemberDataPointer())
1545 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1546 if (!V)
1547 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001548 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001549 TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001550 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001551 case TemplateArgument::Template:
1552 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001553 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001554 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1555 break;
1556 case TemplateArgument::Pack:
1557 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1558 TheCU, Name, nullptr,
1559 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1560 break;
David Majnemer5559d472013-08-24 08:21:10 +00001561 case TemplateArgument::Expression: {
1562 const Expr *E = TA.getAsExpr();
1563 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001564 if (E->isGLValue())
1565 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001566 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001567 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001568 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001569 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001570 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001571 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001572 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001573 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001574 case TemplateArgument::Null:
1575 llvm_unreachable(
1576 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001577 }
1578 }
1579 return DBuilder.getOrCreateArray(TemplateParams);
1580}
1581
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001582llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001583CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001584 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001585 if (FD->getTemplatedKind() ==
1586 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001587 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1588 ->getTemplate()
1589 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001590 return CollectTemplateParams(
1591 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001592 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001593 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001594}
1595
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001596llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1597 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001598 // Always get the full list of parameters, not just the ones from
1599 // the specialization.
1600 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001601 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001602 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001603 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001604}
1605
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001606llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001607 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001608 return VTablePtrType;
1609
1610 ASTContext &Context = CGM.getContext();
1611
1612 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001613 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001614 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001615 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001616 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001617 llvm::DIType *vtbl_ptr_type =
Eric Christophere7b87e52014-10-26 23:40:33 +00001618 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001619 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1620 return VTablePtrType;
1621}
1622
Guy Benyei11169dd2012-12-18 14:30:41 +00001623StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001624 // Copy the gdb compatible name on the side and use its reference.
1625 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001626}
1627
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001628void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001629 SmallVectorImpl<llvm::Metadata *> &EltTys,
1630 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001631 // If this class is not dynamic then there is not any vtable info to collect.
1632 if (!RD->isDynamicClass())
1633 return;
1634
Reid Kleckner59812422016-08-31 20:35:01 +00001635 // Don't emit any vtable shape or vptr info if this class doesn't have an
1636 // extendable vfptr. This can happen if the class doesn't have virtual
1637 // methods, or in the MS ABI if those virtual methods only come from virtually
1638 // inherited bases.
1639 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1640 if (!RL.hasExtendableVFPtr())
1641 return;
1642
Reid Klecknerdc124992016-08-31 16:11:43 +00001643 // CodeView needs to know how large the vtable of every dynamic class is, so
1644 // emit a special named pointer type into the element list. The vptr type
1645 // points to this type as well.
1646 llvm::DIType *VPtrTy = nullptr;
1647 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1648 CGM.getTarget().getCXXABI().isMicrosoft();
1649 if (NeedVTableShape) {
1650 uint64_t PtrWidth =
1651 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1652 const VTableLayout &VFTLayout =
1653 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1654 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001655 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001656 unsigned VTableWidth = PtrWidth * VSlotCount;
1657
1658 // Create a very wide void* type and insert it directly in the element list.
1659 llvm::DIType *VTableType =
1660 DBuilder.createPointerType(nullptr, VTableWidth, 0, "__vtbl_ptr_type");
1661 EltTys.push_back(VTableType);
1662
1663 // The vptr is a pointer to this special vtable type.
1664 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1665 }
1666
1667 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001668 if (RL.getPrimaryBase())
1669 return;
1670
1671 if (!VPtrTy)
1672 VPtrTy = getOrCreateVTablePtrType(Unit);
1673
Guy Benyei11169dd2012-12-18 14:30:41 +00001674 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001675 llvm::DIType *VPtrMember = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001676 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Reid Klecknerdc124992016-08-31 16:11:43 +00001677 llvm::DINode::FlagArtificial, VPtrTy);
1678 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001679}
1680
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001681llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001682 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001683 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001684 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001685 return T;
1686}
1687
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001688llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001689 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001690 return getOrCreateStandaloneType(D, Loc);
1691}
1692
1693llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1694 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001695 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001696 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001697 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001698 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001699
Adrian Prantl73409ce2013-03-11 18:33:46 +00001700 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001701 return T;
1702}
1703
David Blaikie483a9da2014-05-06 18:35:21 +00001704void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001705 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001706 return;
1707 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001708 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001709 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001710 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001711 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001712 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001713 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001714 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001715}
1716
David Blaikieb2e86eb2013-08-15 20:49:17 +00001717void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001718 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001719 !CGM.getLangOpts().CPlusPlus)
1720 completeRequiredType(RD);
1721}
1722
David Blaikie6943dea2013-08-20 01:28:15 +00001723void CGDebugInfo::completeClassData(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001724 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001725 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001726 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001727 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001728 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001729 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001730 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001731 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001732 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001733 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001734}
1735
David Blaikie0e716b42014-03-03 23:48:23 +00001736static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1737 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001738 for (CXXMethodDecl *MD : llvm::make_range(I, End))
1739 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001740 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00001741 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001742 return true;
1743 return false;
1744}
1745
Adrian Prantl05fefa42016-04-25 20:52:40 +00001746/// Does a type definition exist in an imported clang module?
1747static bool isDefinedInClangModule(const RecordDecl *RD) {
Adrian Prantl09906a62016-08-22 22:38:16 +00001748 // Only definitions that where imported from an AST file come from a module.
Adrian Prantl88d79172016-04-26 21:58:18 +00001749 if (!RD || !RD->isFromASTFile())
Adrian Prantl05fefa42016-04-25 20:52:40 +00001750 return false;
Adrian Prantl09906a62016-08-22 22:38:16 +00001751 // Anonymous entities cannot be addressed. Treat them as not from module.
Adrian Prantl05fefa42016-04-25 20:52:40 +00001752 if (!RD->isExternallyVisible() && RD->getName().empty())
1753 return false;
Adrian Prantl94913712016-04-26 23:42:43 +00001754 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
Adrian Prantla72972b2016-08-22 22:23:58 +00001755 if (!CXXDecl->isCompleteDefinition())
1756 return false;
Adrian Prantl26cb1d22016-08-17 18:27:24 +00001757 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1758 if (TemplateKind != TSK_Undeclared) {
1759 // This is a template, check the origin of the first member.
1760 if (CXXDecl->field_begin() == CXXDecl->field_end())
1761 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1762 if (!CXXDecl->field_begin()->isFromASTFile())
1763 return false;
1764 }
Adrian Prantl94913712016-04-26 23:42:43 +00001765 }
Adrian Prantl05fefa42016-04-25 20:52:40 +00001766 return true;
1767}
1768
Reid Klecknerc9404e12016-09-09 16:27:04 +00001769/// Return true if the class or any of its methods are marked dllimport.
1770static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1771 if (RD->hasAttr<DLLImportAttr>())
1772 return true;
1773 for (const CXXMethodDecl *MD : RD->methods())
1774 if (MD->hasAttr<DLLImportAttr>())
1775 return true;
1776 return false;
1777}
1778
Benjamin Kramer8c305922016-02-02 11:06:51 +00001779static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1780 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001781 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001782 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001783 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001784
Benjamin Kramer8c305922016-02-02 11:06:51 +00001785 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001786 return false;
1787
1788 if (!LangOpts.CPlusPlus)
1789 return false;
1790
1791 if (!RD->isCompleteDefinitionRequired())
1792 return true;
1793
David Majnemer58ed0f32016-07-17 00:39:12 +00001794 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00001795
1796 if (!CXXDecl)
1797 return false;
1798
Adrian McCarthy99242982016-08-16 22:11:18 +00001799 // Only emit complete debug info for a dynamic class when its vtable is
1800 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00001801 // across DLL boundaries, so skip this optimization if the class or any of its
1802 // methods are marked dllimport. This isn't a complete solution, since objects
1803 // without any dllimport methods can be used in one DLL and constructed in
1804 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00001805 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00001806 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00001807 return true;
1808
1809 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00001810 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00001811 Spec = SD->getSpecializationKind();
1812
1813 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1814 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1815 CXXDecl->method_end()))
1816 return true;
1817
1818 return false;
1819}
1820
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00001821void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
1822 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
1823 return;
1824
1825 QualType Ty = CGM.getContext().getRecordType(RD);
1826 llvm::DIType *T = getTypeOrNull(Ty);
1827 if (T && T->isForwardDecl())
1828 completeClassData(RD);
1829}
1830
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001831llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001832 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001833 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001834 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1835 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001836 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001837 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001838 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001839 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001840
David Blaikieb2e86eb2013-08-15 20:49:17 +00001841 return CreateTypeDefinition(Ty);
1842}
1843
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001844llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001845 RecordDecl *RD = Ty->getDecl();
1846
Guy Benyei11169dd2012-12-18 14:30:41 +00001847 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001848 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001849
1850 // Records and classes and unions can all be recursive. To handle them, we
1851 // first generate a debug descriptor for the struct as a forward declaration.
1852 // Then (if it is a definition) we go through and get debug info for all of
1853 // its members. Finally, we create a descriptor for the complete type (which
1854 // may refer to the forward decl if the struct is recursive) and replace all
1855 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001856 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001857
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001858 const RecordDecl *D = RD->getDefinition();
1859 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001860 return FwdDecl;
1861
David Majnemer58ed0f32016-07-17 00:39:12 +00001862 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00001863 CollectContainingType(CXXDecl, FwdDecl);
1864
Guy Benyei11169dd2012-12-18 14:30:41 +00001865 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001866 LexicalBlockStack.emplace_back(&*FwdDecl);
1867 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001868
Guy Benyei11169dd2012-12-18 14:30:41 +00001869 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001870 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001871 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001872
1873 // Note: The split of CXXDecl information here is intentional, the
1874 // gdb tests will depend on a certain ordering at printout. The debug
1875 // information offsets are still correct if we merge them all together
1876 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00001877 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00001878 if (CXXDecl) {
1879 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00001880 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001881 }
1882
Eric Christopher91a31902013-01-16 01:22:32 +00001883 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001884 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001885 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001886 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001887
1888 LexicalBlockStack.pop_back();
1889 RegionMap.erase(Ty->getDecl());
1890
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001891 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001892 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001893
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001894 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001895 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001896 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001897
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001898 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001899 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001900}
1901
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001902llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1903 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001904 // Ignore protocols.
1905 return getOrCreateType(Ty->getBaseType(), Unit);
1906}
1907
Manman Rene6be26c2016-09-13 17:25:08 +00001908llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
1909 llvm::DIFile *Unit) {
1910 // Ignore protocols.
1911 SourceLocation Loc = Ty->getDecl()->getLocation();
1912
1913 // Use Typedefs to represent ObjCTypeParamType.
1914 return DBuilder.createTypedef(
1915 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1916 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
1917 getDeclContextDescriptor(Ty->getDecl()));
1918}
1919
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001920/// \return true if Getter has the default name for the property PD.
1921static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1922 const ObjCMethodDecl *Getter) {
1923 assert(PD);
1924 if (!Getter)
1925 return true;
1926
1927 assert(Getter->getDeclName().isObjCZeroArgSelector());
1928 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001929 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001930}
1931
1932/// \return true if Setter has the default name for the property PD.
1933static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1934 const ObjCMethodDecl *Setter) {
1935 assert(PD);
1936 if (!Setter)
1937 return true;
1938
1939 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001940 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001941 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001942}
1943
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001944llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1945 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001946 ObjCInterfaceDecl *ID = Ty->getDecl();
1947 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001948 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001949
Adrian Prantl50fd1a82016-04-20 23:59:32 +00001950 // Return a forward declaration if this type was imported from a clang module,
1951 // and this is not the compile unit with the implementation of the type (which
1952 // may contain hidden ivars).
1953 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
1954 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001955 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1956 ID->getName(),
1957 getDeclContextDescriptor(ID), Unit, 0);
1958
Guy Benyei11169dd2012-12-18 14:30:41 +00001959 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001960 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001961 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001962 auto RuntimeLang =
1963 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00001964
1965 // If this is just a forward declaration return a special forward-declaration
1966 // debug type since we won't be able to lay out the entire type.
1967 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001968 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001969 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001970 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001971 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
1972 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001973 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001974 return FwdDecl;
1975 }
1976
David Blaikieef8a9512014-05-05 23:23:53 +00001977 return CreateTypeDefinition(Ty, Unit);
1978}
1979
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001980llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00001981CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
1982 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00001983 // Use the Module pointer as the key into the cache. This is a
1984 // nullptr if the "Module" is a PCH, which is safe because we don't
1985 // support chained PCH debug info, so there can only be a single PCH.
1986 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001987 auto ModRef = ModuleCache.find(M);
1988 if (ModRef != ModuleCache.end())
1989 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00001990
1991 // Macro definitions that were defined with "-D" on the command line.
1992 SmallString<128> ConfigMacros;
1993 {
1994 llvm::raw_svector_ostream OS(ConfigMacros);
1995 const auto &PPOpts = CGM.getPreprocessorOpts();
1996 unsigned I = 0;
1997 // Translate the macro definitions back into a commmand line.
1998 for (auto &M : PPOpts.Macros) {
1999 if (++I > 1)
2000 OS << " ";
2001 const std::string &Macro = M.first;
2002 bool Undef = M.second;
2003 OS << "\"-" << (Undef ? 'U' : 'D');
2004 for (char c : Macro)
2005 switch (c) {
2006 case '\\' : OS << "\\\\"; break;
2007 case '"' : OS << "\\\""; break;
2008 default: OS << c;
2009 }
2010 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002011 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002012 }
Adrian Prantl66689202015-09-18 23:01:45 +00002013
Adrian Prantl835e6632015-09-24 16:10:10 +00002014 bool IsRootModule = M ? !M->Parent : true;
2015 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002016 // PCH files don't have a signature field in the control block,
2017 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Adrian Prantl98bfc822016-01-22 19:29:41 +00002018 uint64_t Signature = Mod.getSignature() ? Mod.getSignature() : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002019 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002020 DIB.createCompileUnit(TheCU->getSourceLanguage(),
2021 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2022 TheCU->getProducer(), true, StringRef(), 0,
2023 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2024 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002025 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002026 }
Adrian Prantl835e6632015-09-24 16:10:10 +00002027 llvm::DIModule *Parent =
2028 IsRootModule ? nullptr
2029 : getOrCreateModuleRef(
2030 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2031 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002032 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002033 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2034 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002035 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002036 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002037}
2038
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002039llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2040 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002041 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002042 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002043 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002044 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002045
2046 // Bit size, align and offset of the type.
2047 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002048 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002049
Leny Kholodov80c047d2016-09-06 10:48:04 +00002050 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002051 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002052 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002053
Adrian Prantlfd696112015-10-01 00:48:51 +00002054 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002055 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002056 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2057 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002058
David Blaikieef8a9512014-05-05 23:23:53 +00002059 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002060 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002061
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002062 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002063 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002064 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002065
2066 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002067 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002068
2069 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2070 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002071 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002072 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002073 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002074 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002075
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002076 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0,
2077 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002078 EltTys.push_back(InhTag);
2079 }
2080
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002081 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002082 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002083 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002084 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002085 unsigned PLine = getLineNumber(Loc);
2086 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2087 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002088 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2089 PD->getName(), PUnit, PLine,
2090 hasDefaultGetterName(PD, Getter) ? ""
2091 : getSelectorName(PD->getGetterName()),
2092 hasDefaultSetterName(PD, Setter) ? ""
2093 : getSelectorName(PD->getSetterName()),
2094 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002095 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002096 };
2097 {
2098 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002099 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002100 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002101 PropertySet.insert(PD->getIdentifier());
2102 AddProperty(PD);
2103 }
Manman Renefe1bac2016-01-27 20:00:32 +00002104 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002105 // Don't emit duplicate metadata for properties that were already in a
2106 // class extension.
2107 if (!PropertySet.insert(PD->getIdentifier()).second)
2108 continue;
2109 AddProperty(PD);
2110 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002111 }
2112
2113 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2114 unsigned FieldNo = 0;
2115 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2116 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002117 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002118 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002119 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002120
Guy Benyei11169dd2012-12-18 14:30:41 +00002121 StringRef FieldName = Field->getName();
2122
2123 // Ignore unnamed fields.
2124 if (FieldName.empty())
2125 continue;
2126
2127 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002128 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002129 unsigned FieldLine = getLineNumber(Field->getLocation());
2130 QualType FType = Field->getType();
2131 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002132 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002133
2134 if (!FType->isIncompleteArrayType()) {
2135
2136 // Bit size, align and offset of the type.
2137 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002138 ? Field->getBitWidthValue(CGM.getContext())
2139 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002140 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002141 }
2142
2143 uint64_t FieldOffset;
2144 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2145 // We don't know the runtime offset of an ivar if we're using the
2146 // non-fragile ABI. For bitfields, use the bit offset into the first
2147 // byte of storage of the bitfield. For other fields, use zero.
2148 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002149 FieldOffset =
2150 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002151 FieldOffset %= CGM.getContext().getCharWidth();
2152 } else {
2153 FieldOffset = 0;
2154 }
2155 } else {
2156 FieldOffset = RL.getFieldOffset(FieldNo);
2157 }
2158
Leny Kholodov80c047d2016-09-06 10:48:04 +00002159 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002160 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002161 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002162 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002163 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002164 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002165 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002166
Craig Topper8a13c412014-05-21 05:09:00 +00002167 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002168 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002169 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002170 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002171 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002172 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002173 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002174 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002175 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2176 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002177 PropertyNode = DBuilder.createObjCProperty(
2178 PD->getName(), PUnit, PLine,
2179 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2180 PD->getGetterName()),
2181 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2182 PD->getSetterName()),
2183 PD->getPropertyAttributes(),
2184 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002185 }
2186 }
2187 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002188 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2189 FieldSize, FieldAlign, FieldOffset, Flags,
2190 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002191 EltTys.push_back(FieldTy);
2192 }
2193
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002194 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002195 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002196
Guy Benyei11169dd2012-12-18 14:30:41 +00002197 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002198 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002199}
2200
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002201llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2202 llvm::DIFile *Unit) {
2203 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002204 int64_t Count = Ty->getNumElements();
2205 if (Count == 0)
2206 // If number of elements are not known then this is an unbounded array.
2207 // Use Count == -1 to express such arrays.
2208 Count = -1;
2209
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002210 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002211 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002212
2213 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002214 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002215
2216 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2217}
2218
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002219llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002220 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002221 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002222
2223 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002224 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002225 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002226 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2227 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002228 } else if (Ty->isIncompleteArrayType()) {
2229 Size = 0;
2230 if (Ty->getElementType()->isIncompleteType())
2231 Align = 0;
2232 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002233 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002234 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002235 Size = 0;
2236 Align = 0;
2237 } else {
2238 // Size and align of the whole array, not the element type.
2239 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002240 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002241 }
2242
2243 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2244 // interior arrays, do we care? Why aren't nested arrays represented the
2245 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002246 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002247 QualType EltTy(Ty, 0);
2248 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2249 // If the number of elements is known, then count is that number. Otherwise,
2250 // it's -1. This allows us to represent a subrange with an array of 0
2251 // elements, like this:
2252 //
2253 // struct foo {
2254 // int x[0];
2255 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002256 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002257 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002258 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002259 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002260 if (Expr *Size = VAT->getSizeExpr()) {
2261 llvm::APSInt V;
2262 if (Size->EvaluateAsInt(V, CGM.getContext()))
2263 Count = V.getExtValue();
2264 }
David Blaikie87173f12016-08-22 17:49:56 +00002265 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002266
Guy Benyei11169dd2012-12-18 14:30:41 +00002267 // FIXME: Verify this is right for VLAs.
2268 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2269 EltTy = Ty->getElementType();
2270 }
2271
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002272 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002273
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002274 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2275 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002276}
2277
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002278llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2279 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002280 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2281 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002282}
2283
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002284llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2285 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002286 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2287 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002288}
2289
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002290llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2291 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002292 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002293 uint64_t Size = 0;
2294
2295 if (!Ty->isIncompleteType()) {
2296 Size = CGM.getContext().getTypeSize(Ty);
2297
2298 // Set the MS inheritance model. There is no flag for the unspecified model.
2299 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2300 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2301 case MSInheritanceAttr::Keyword_single_inheritance:
2302 Flags |= llvm::DINode::FlagSingleInheritance;
2303 break;
2304 case MSInheritanceAttr::Keyword_multiple_inheritance:
2305 Flags |= llvm::DINode::FlagMultipleInheritance;
2306 break;
2307 case MSInheritanceAttr::Keyword_virtual_inheritance:
2308 Flags |= llvm::DINode::FlagVirtualInheritance;
2309 break;
2310 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2311 break;
2312 }
2313 }
2314 }
2315
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002316 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002317 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002318 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002319 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2320 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002321
2322 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002323 Ty->getPointeeType()->getAs<FunctionProtoType>();
2324 return DBuilder.createMemberPointerType(
2325 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2326 Ty->getClass(), FPT->getTypeQuals())),
2327 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002328 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002329}
2330
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002331llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002332 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2333 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002334}
2335
Xiuli Pan9c14e282016-01-09 12:53:17 +00002336llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2337 llvm::DIFile *U) {
2338 return getOrCreateType(Ty->getElementType(), U);
2339}
2340
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002341llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002342 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002343
Guy Benyei11169dd2012-12-18 14:30:41 +00002344 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002345 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002346 if (!ED->getTypeForDecl()->isIncompleteType()) {
2347 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002348 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002349 }
2350
Manman Rene0064d82013-08-29 23:19:58 +00002351 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2352
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002353 bool isImportedFromModule =
2354 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2355
Guy Benyei11169dd2012-12-18 14:30:41 +00002356 // If this is just a forward declaration, construct an appropriately
2357 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002358 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002359 // Note that it is possible for enums to be created as part of
2360 // their own declcontext. In this case a FwdDecl will be created
2361 // twice. This doesn't cause a problem because both FwdDecls are
2362 // entered into the ReplaceMap: finalize() will replace the first
2363 // FwdDecl with the second and then replace the second with
2364 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002365 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002366 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002367 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2368 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002369
Guy Benyei11169dd2012-12-18 14:30:41 +00002370 unsigned Line = getLineNumber(ED->getLocation());
2371 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002372 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002373 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2374 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Adrian Prantla40030f2016-02-06 01:59:09 +00002375
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002376 ReplaceMap.emplace_back(
2377 std::piecewise_construct, std::make_tuple(Ty),
2378 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002379 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002380 }
2381
David Blaikie483a9da2014-05-06 18:35:21 +00002382 return CreateTypeDefinition(Ty);
2383}
2384
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002385llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002386 const EnumDecl *ED = Ty->getDecl();
2387 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002388 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002389 if (!ED->getTypeForDecl()->isIncompleteType()) {
2390 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002391 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002392 }
2393
2394 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2395
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002396 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002397 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002398 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002399 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002400 Enumerators.push_back(DBuilder.createEnumerator(
2401 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 }
2403
2404 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002405 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002406
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002407 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002408 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002409 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002410 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002411 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2412 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2413 Line, Size, Align, EltArray, ClassTy,
2414 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002415}
2416
David Blaikie05491062013-01-21 04:37:12 +00002417static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2418 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002419 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002420 Qualifiers InnerQuals = T.getLocalQualifiers();
2421 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2422 // that is already there.
2423 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2424 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002425 QualType LastT = T;
2426 switch (T->getTypeClass()) {
2427 default:
David Blaikie05491062013-01-21 04:37:12 +00002428 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002429 case Type::TemplateSpecialization: {
2430 const auto *Spec = cast<TemplateSpecializationType>(T);
2431 if (Spec->isTypeAlias())
2432 return C.getQualifiedType(T.getTypePtr(), Quals);
2433 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002434 break;
2435 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002436 case Type::TypeOfExpr:
2437 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2438 break;
2439 case Type::TypeOf:
2440 T = cast<TypeOfType>(T)->getUnderlyingType();
2441 break;
2442 case Type::Decltype:
2443 T = cast<DecltypeType>(T)->getUnderlyingType();
2444 break;
2445 case Type::UnaryTransform:
2446 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2447 break;
2448 case Type::Attributed:
2449 T = cast<AttributedType>(T)->getEquivalentType();
2450 break;
2451 case Type::Elaborated:
2452 T = cast<ElaboratedType>(T)->getNamedType();
2453 break;
2454 case Type::Paren:
2455 T = cast<ParenType>(T)->getInnerType();
2456 break;
David Blaikie05491062013-01-21 04:37:12 +00002457 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002458 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002459 break;
Jordan Rose303e2f12016-11-10 23:28:17 +00002460 case Type::Auto: {
David Blaikie22c460a02013-05-24 21:24:35 +00002461 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002462 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002463 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002464 break;
2465 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002466 case Type::Adjusted:
2467 case Type::Decayed:
2468 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2469 T = cast<AdjustedType>(T)->getAdjustedType();
2470 break;
2471 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002472
Guy Benyei11169dd2012-12-18 14:30:41 +00002473 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002474 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002475 } while (true);
2476}
2477
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002478llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002479
2480 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002481 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002482
David Blaikief427b002014-05-06 03:42:01 +00002483 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002484 if (it != TypeCache.end()) {
2485 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002486 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002487 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002488 }
2489
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002490 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002491}
2492
David Blaikie0e716b42014-03-03 23:48:23 +00002493void CGDebugInfo::completeTemplateDefinition(
2494 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002495 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002496 return;
2497
David Blaikie0e716b42014-03-03 23:48:23 +00002498 completeClassData(&SD);
2499 // In case this type has no member function definitions being emitted, ensure
2500 // it is retained
2501 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2502}
2503
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002504llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002505 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002506 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002507
2508 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002509 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002510
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002511 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002512 return T;
2513
Adrian Prantlca844182015-09-11 17:23:03 +00002514 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002515 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002516
2517 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002518 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002519
Guy Benyei11169dd2012-12-18 14:30:41 +00002520 return Res;
2521}
2522
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002523llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002524 // A forward declaration inside a module header does not belong to the module.
2525 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2526 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002527 if (DebugTypeExtRefs && D->isFromASTFile()) {
2528 // Record a reference to an imported clang module or precompiled header.
2529 auto *Reader = CGM.getContext().getExternalSource();
2530 auto Idx = D->getOwningModuleID();
2531 auto Info = Reader->getSourceDescriptor(Idx);
2532 if (Info)
2533 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2534 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002535 // We are building a clang module or a precompiled header.
2536 //
2537 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2538 // and it wouldn't be necessary to specify the parent scope
2539 // because the type is already unique by definition (it would look
2540 // like the output of -fno-standalone-debug). On the other hand,
2541 // the parent scope helps a consumer to quickly locate the object
2542 // file where the type's definition is located, so it might be
2543 // best to make this behavior a command line or debugger tuning
2544 // option.
2545 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
2546 if (Module *M = ClangModuleMap->inferModuleFromLocation(Loc)) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002547 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002548 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2549 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002550 } else {
2551 // This the precompiled header being built.
2552 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002553 }
2554 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002555
Adrian Prantl9402cef2015-09-20 16:51:35 +00002556 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002557}
2558
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002559llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002560 // Handle qualifiers, which recursively handles what they refer to.
2561 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002562 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002563
Guy Benyei11169dd2012-12-18 14:30:41 +00002564 // Work out details of type.
2565 switch (Ty->getTypeClass()) {
2566#define TYPE(Class, Base)
2567#define ABSTRACT_TYPE(Class, Base)
2568#define NON_CANONICAL_TYPE(Class, Base)
2569#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2570#include "clang/AST/TypeNodes.def"
2571 llvm_unreachable("Dependent types cannot show up in debug information");
2572
2573 case Type::ExtVector:
2574 case Type::Vector:
2575 return CreateType(cast<VectorType>(Ty), Unit);
2576 case Type::ObjCObjectPointer:
2577 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2578 case Type::ObjCObject:
2579 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002580 case Type::ObjCTypeParam:
2581 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002582 case Type::ObjCInterface:
2583 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2584 case Type::Builtin:
2585 return CreateType(cast<BuiltinType>(Ty));
2586 case Type::Complex:
2587 return CreateType(cast<ComplexType>(Ty));
2588 case Type::Pointer:
2589 return CreateType(cast<PointerType>(Ty), Unit);
2590 case Type::BlockPointer:
2591 return CreateType(cast<BlockPointerType>(Ty), Unit);
2592 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002593 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002594 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002595 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002596 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002597 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002598 case Type::FunctionProto:
2599 case Type::FunctionNoProto:
2600 return CreateType(cast<FunctionType>(Ty), Unit);
2601 case Type::ConstantArray:
2602 case Type::VariableArray:
2603 case Type::IncompleteArray:
2604 return CreateType(cast<ArrayType>(Ty), Unit);
2605
2606 case Type::LValueReference:
2607 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2608 case Type::RValueReference:
2609 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2610
2611 case Type::MemberPointer:
2612 return CreateType(cast<MemberPointerType>(Ty), Unit);
2613
2614 case Type::Atomic:
2615 return CreateType(cast<AtomicType>(Ty), Unit);
2616
Xiuli Pan9c14e282016-01-09 12:53:17 +00002617 case Type::Pipe:
2618 return CreateType(cast<PipeType>(Ty), Unit);
2619
Guy Benyei11169dd2012-12-18 14:30:41 +00002620 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002621 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2622
David Blaikie42edade2014-11-11 20:44:45 +00002623 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002624 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00002625 case Type::Adjusted:
2626 case Type::Decayed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002627 case Type::Elaborated:
2628 case Type::Paren:
2629 case Type::SubstTemplateTypeParm:
2630 case Type::TypeOfExpr:
2631 case Type::TypeOf:
2632 case Type::Decltype:
2633 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002634 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002635 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002636 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002637
David Blaikie42edade2014-11-11 20:44:45 +00002638 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002639}
2640
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002641llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2642 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002643 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002644
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002645 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002646
2647 // We may have cached a forward decl when we could have created
2648 // a non-forward decl. Go ahead and create a non-forward decl
2649 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002650 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002651 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002652
2653 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002654 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002655
2656 // Propagate members from the declaration to the definition
2657 // CreateType(const RecordType*) will overwrite this with the members in the
2658 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002659 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002660
Guy Benyei11169dd2012-12-18 14:30:41 +00002661 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002662 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002663 return Res;
2664}
2665
2666// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002667llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002668 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002669
Guy Benyei11169dd2012-12-18 14:30:41 +00002670 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002671 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002672 unsigned Line = getLineNumber(RD->getLocation());
2673 StringRef RDName = getClassName(RD);
2674
Amjad Abouddc4531e2016-04-30 01:44:38 +00002675 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002676
David Blaikied2785892013-08-18 17:36:19 +00002677 // If we ended up creating the type during the context chain construction,
2678 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002679 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002680 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002681 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002682 return T;
David Blaikied2785892013-08-18 17:36:19 +00002683
Adrian Prantl381e7552014-02-04 21:29:50 +00002684 // If this is just a forward or incomplete declaration, construct an
2685 // appropriately marked node and just return it.
2686 const RecordDecl *D = RD->getDefinition();
2687 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002688 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002689
2690 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002691 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002692
Manman Rene0064d82013-08-29 23:19:58 +00002693 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2694
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002695 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00002696 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
2697 llvm::DINode::FlagZero, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002698
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002699 // Elements of composite types usually have back to the type, creating
2700 // uniquing cycles. Distinct nodes are more efficient.
2701 switch (RealDecl->getTag()) {
2702 default:
2703 llvm_unreachable("invalid composite type tag");
2704
2705 case llvm::dwarf::DW_TAG_array_type:
2706 case llvm::dwarf::DW_TAG_enumeration_type:
2707 // Array elements and most enumeration elements don't have back references,
2708 // so they don't tend to be involved in uniquing cycles and there is some
2709 // chance of merging them when linking together two modules. Only make
2710 // them distinct if they are ODR-uniqued.
2711 if (FullName.empty())
2712 break;
2713
2714 case llvm::dwarf::DW_TAG_structure_type:
2715 case llvm::dwarf::DW_TAG_union_type:
2716 case llvm::dwarf::DW_TAG_class_type:
2717 // Immediatley resolve to a distinct node.
2718 RealDecl =
2719 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2720 break;
2721 }
2722
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002723 RegionMap[Ty->getDecl()].reset(RealDecl);
2724 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002725
David Majnemer58ed0f32016-07-17 00:39:12 +00002726 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002727 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002728 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002729 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002730}
2731
David Blaikieadfbf992013-08-18 16:55:33 +00002732void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002733 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002734 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002735 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002736 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2737 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002738 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002739 while (1) {
2740 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2741 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2742 if (PBT && !BRL.isPrimaryBaseVirtual())
2743 PBase = PBT;
2744 else
2745 break;
2746 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002747 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002748 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2749 getOrCreateFile(RD->getLocation())));
2750 } else if (RD->isDynamicClass())
2751 ContainingType = RealDecl;
2752
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002753 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002754}
2755
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002756llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002757 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002758 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002759 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002760 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002761 llvm::DIType *Ty =
2762 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
2763 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002764 *Offset += FieldSize;
2765 return Ty;
2766}
2767
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002768void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002769 StringRef &Name,
2770 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002771 llvm::DIScope *&FDContext,
2772 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00002773 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002774 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00002775 Name = getFunctionName(FD);
2776 // Use mangled name as linkage name for C/C++ functions.
2777 if (FD->hasPrototype()) {
2778 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002779 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002780 }
2781 // No need to replicate the linkage name if it isn't different from the
2782 // subprogram name, no need to have it at all unless coverage is enabled or
2783 // debug is set to more than just line tables.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002784 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2785 !CGM.getCodeGenOpts().EmitGcovNotes &&
2786 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00002787 LinkageName = StringRef();
2788
Benjamin Kramer8c305922016-02-02 11:06:51 +00002789 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002790 if (const NamespaceDecl *NSDecl =
2791 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2792 FDContext = getOrCreateNameSpace(NSDecl);
2793 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002794 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2795 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2796 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2797 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00002798 // Check if it is a noreturn-marked function
2799 if (FD->isNoReturn())
2800 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00002801 // Collect template parameters.
2802 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2803 }
2804}
2805
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002806void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002807 unsigned &LineNo, QualType &T,
2808 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002809 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002810 Unit = getOrCreateFile(VD->getLocation());
2811 LineNo = getLineNumber(VD->getLocation());
2812
2813 setLocation(VD->getLocation());
2814
2815 T = VD->getType();
2816 if (T->isIncompleteArrayType()) {
2817 // CodeGen turns int[] into int[1] so we'll do the same here.
2818 llvm::APInt ConstVal(32, 1);
2819 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2820
2821 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2822 ArrayType::Normal, 0);
2823 }
2824
2825 Name = VD->getName();
2826 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2827 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2828 LinkageName = CGM.getMangledName(VD);
2829 if (LinkageName == Name)
2830 LinkageName = StringRef();
2831
2832 // Since we emit declarations (DW_AT_members) for static members, place the
2833 // definition of those static members in the namespace they were declared in
2834 // in the source code (the lexical decl context).
2835 // FIXME: Generalize this for even non-member global variables where the
2836 // declaration and definition may have different lexical decl contexts, once
2837 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002838 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2839 : VD->getDeclContext();
2840 // When a record type contains an in-line initialization of a static data
2841 // member, and the record type is marked as __declspec(dllexport), an implicit
2842 // definition of the member will be created in the record context. DWARF
2843 // doesn't seem to have a nice way to describe this in a form that consumers
2844 // are likely to understand, so fake the "normal" situation of a definition
2845 // outside the class by putting it in the global scope.
2846 if (DC->isRecord())
2847 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002848
Amjad Abouddc4531e2016-04-30 01:44:38 +00002849 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2850 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002851}
2852
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002853llvm::DISubprogram *
Frederic Rissd253ed62014-11-18 03:40:51 +00002854CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002855 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002856 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00002857 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Frederic Rissd253ed62014-11-18 03:40:51 +00002858 SourceLocation Loc = FD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002859 llvm::DIFile *Unit = getOrCreateFile(Loc);
2860 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002861 unsigned Line = getLineNumber(Loc);
2862
2863 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2864 TParamsArray, Flags);
2865 // Build function type.
2866 SmallVector<QualType, 16> ArgTypes;
2867 for (const ParmVarDecl *Parm: FD->parameters())
2868 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00002869 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2870 QualType FnType = CGM.getContext().getFunctionType(
2871 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002872 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002873 DContext, Name, LinkageName, Unit, Line,
2874 getOrCreateFunctionType(FD, FnType, Unit), !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002875 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002876 TParamsArray.get(), getFunctionDeclaration(FD));
David Majnemer58ed0f32016-07-17 00:39:12 +00002877 const auto *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002878 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2879 std::make_tuple(CanonDecl),
2880 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002881 return SP;
2882}
2883
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002884llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002885CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2886 QualType T;
2887 StringRef Name, LinkageName;
2888 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002889 llvm::DIFile *Unit = getOrCreateFile(Loc);
2890 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002891 unsigned Line = getLineNumber(Loc);
2892
2893 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00002894 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002895 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
2896 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Adrian Prantl5f4740d2016-12-20 02:10:02 +00002897 !VD->isExternallyVisible(), nullptr, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002898 FwdDeclReplaceMap.emplace_back(
2899 std::piecewise_construct,
2900 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2901 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002902 return GV;
2903}
2904
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002905llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002906 // We only need a declaration (not a definition) of the type - so use whatever
2907 // we would otherwise do to get a type for a pointee. (forward declarations in
2908 // limited debug info, full definitions (if the type definition is available)
2909 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00002910 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00002911 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002912 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002913 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002914
Adrian Prantl5f4740d2016-12-20 02:10:02 +00002915 if (I != DeclCache.end()) {
2916 auto N = I->second;
2917 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
2918 return GVE->getVariable();
2919 return dyn_cast_or_null<llvm::DINode>(N);
2920 }
Frederic Rissd253ed62014-11-18 03:40:51 +00002921
2922 // No definition for now. Emit a forward definition that might be
2923 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00002924 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00002925 return getFunctionForwardDeclaration(FD);
2926 else if (const auto *VD = dyn_cast<VarDecl>(D))
2927 return getGlobalVariableForwardDeclaration(VD);
2928
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002929 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00002930}
2931
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002932llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002933 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002934 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00002935
David Majnemer58ed0f32016-07-17 00:39:12 +00002936 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002937 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002938 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002939
2940 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002941 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00002942
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002943 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002944 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002945 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00002946 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002947 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00002948 }
2949 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002950 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002951 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002952 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002953 return SP;
2954 }
2955
Aaron Ballman86c93902014-03-06 23:45:36 +00002956 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002957 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002958 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002959 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002960 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002961 return SP;
2962 }
2963 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002964 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002965}
2966
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002967// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00002968// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002969llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002970 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002971 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002972 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002973 // Create fake but valid subroutine type. Otherwise -verify would fail, and
2974 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00002975 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002976
David Majnemer58ed0f32016-07-17 00:39:12 +00002977 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00002978 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002979
2980 const auto *FTy = FnType->getAs<FunctionType>();
2981 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
2982
David Majnemer58ed0f32016-07-17 00:39:12 +00002983 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002984 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002985 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002986
2987 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002988 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002989
2990 // Replace the instancetype keyword with the actual type.
2991 if (ResultTy == CGM.getContext().getObjCInstanceType())
2992 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002993 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002994
Adrian Prantl7bec9032013-05-10 21:08:31 +00002995 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002996 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002997 QualType SelfDeclTy;
2998 if (auto *SelfDecl = OMethod->getSelfDecl())
2999 SelfDeclTy = SelfDecl->getType();
3000 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3001 if (FPT->getNumParams() > 1)
3002 SelfDeclTy = FPT->getParamType(0);
3003 if (!SelfDeclTy.isNull())
3004 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003005 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003006 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003007 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003008 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003009 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003010 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003011 // Variadic methods need a special marker at the end of the type list.
3012 if (OMethod->isVariadic())
3013 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003014
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003015 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003016 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3017 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003018 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003019
Adrian Prantl800faef2014-02-25 23:42:18 +00003020 // Handle variadic function types; they need an additional
3021 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003022 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003023 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003024 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003025 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003026 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3027 for (QualType ParamType : FPT->param_types())
3028 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003029 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003030 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003031 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3032 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003033 }
3034
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003035 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003036}
3037
Eric Christophere7b87e52014-10-26 23:40:33 +00003038void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3039 SourceLocation ScopeLoc, QualType FnType,
3040 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003041
3042 StringRef Name;
3043 StringRef LinkageName;
3044
3045 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3046
3047 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003048 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003049
Leny Kholodov80c047d2016-09-06 10:48:04 +00003050 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003051 llvm::DIFile *Unit = getOrCreateFile(Loc);
3052 llvm::DIScope *FDContext = Unit;
3053 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003054 if (!HasDecl) {
3055 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003056 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003057 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003058 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003059 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003060 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003061 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003062 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003063 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003064 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003065 return;
3066 }
3067 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003068 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3069 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003070 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003071 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003072 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003073 } else {
3074 // Use llvm function name.
3075 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003076 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003077 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003078 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003079 Name = Name.substr(1);
3080
Adrian Prantl42d71b92014-04-10 23:21:53 +00003081 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003082 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003083 // Artificial functions should not silently reuse CurLoc.
3084 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003085 }
3086 unsigned LineNo = getLineNumber(Loc);
3087 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003088
Eric Christopher8018e412014-03-27 18:50:35 +00003089 // FIXME: The function declaration we're constructing here is mostly reusing
3090 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3091 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3092 // all subprograms instead of the actual context since subprogram definitions
3093 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003094 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003095 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00003096 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003097 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003098 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003099 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003100 // We might get here with a VarDecl in the case we're generating
3101 // code for the initialization of globals. Do not record these decls
3102 // as they will overwrite the actual VarDecl Decl in the cache.
3103 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003104 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003105
Adrian Prantlbebb8932014-03-21 21:01:58 +00003106 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003107 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003108
Guy Benyei11169dd2012-12-18 14:30:41 +00003109 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003110 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003111}
3112
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003113void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3114 QualType FnType) {
3115 StringRef Name;
3116 StringRef LinkageName;
3117
3118 const Decl *D = GD.getDecl();
3119 if (!D)
3120 return;
3121
Leny Kholodov80c047d2016-09-06 10:48:04 +00003122 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003123 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003124 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003125 llvm::DINodeArray TParamsArray;
3126 if (isa<FunctionDecl>(D)) {
3127 // If there is a DISubprogram for this function available then use it.
3128 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3129 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003130 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003131 Name = getObjCMethodName(OMD);
3132 Flags |= llvm::DINode::FlagPrototyped;
3133 } else {
3134 llvm_unreachable("not a function or ObjC method");
3135 }
3136 if (!Name.empty() && Name[0] == '\01')
3137 Name = Name.substr(1);
3138
3139 if (D->isImplicit()) {
3140 Flags |= llvm::DINode::FlagArtificial;
3141 // Artificial functions without a location should not silently reuse CurLoc.
3142 if (Loc.isInvalid())
3143 CurLoc = SourceLocation();
3144 }
3145 unsigned LineNo = getLineNumber(Loc);
3146 unsigned ScopeLine = 0;
3147
Adrian Prantle76bda52016-04-15 15:55:45 +00003148 DBuilder.retainType(DBuilder.createFunction(
3149 FDContext, Name, LinkageName, Unit, LineNo,
3150 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3151 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3152 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003153}
3154
David Blaikie835afb22015-01-21 23:08:17 +00003155void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003156 // Update our current location
3157 setLocation(Loc);
3158
Eric Christophere7b87e52014-10-26 23:40:33 +00003159 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3160 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003161
Adrian Prantle83b1302014-01-07 22:05:52 +00003162 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00003163 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00003164 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003165}
3166
Guy Benyei11169dd2012-12-18 14:30:41 +00003167void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003168 llvm::MDNode *Back = nullptr;
3169 if (!LexicalBlockStack.empty())
3170 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003171 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003172 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003173 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003174}
3175
Eric Christopher0fdcb312013-05-16 00:52:20 +00003176void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3177 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003178 // Set our current location.
3179 setLocation(Loc);
3180
Guy Benyei11169dd2012-12-18 14:30:41 +00003181 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00003182 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3183 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00003184
Benjamin Kramer8c305922016-02-02 11:06:51 +00003185 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003186 return;
3187
3188 // Create a new lexical block and push it on the stack.
3189 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003190}
3191
Eric Christopher0fdcb312013-05-16 00:52:20 +00003192void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3193 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003194 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3195
3196 // Provide an entry in the line table for the end of the block.
3197 EmitLocation(Builder, Loc);
3198
Benjamin Kramer8c305922016-02-02 11:06:51 +00003199 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003200 return;
3201
Guy Benyei11169dd2012-12-18 14:30:41 +00003202 LexicalBlockStack.pop_back();
3203}
3204
Guy Benyei11169dd2012-12-18 14:30:41 +00003205void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
3206 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3207 unsigned RCount = FnBeginRegionCount.back();
3208 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3209
3210 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003211 while (LexicalBlockStack.size() != RCount) {
3212 // Provide an entry in the line table for the end of the block.
3213 EmitLocation(Builder, CurLoc);
3214 LexicalBlockStack.pop_back();
3215 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003216 FnBeginRegionCount.pop_back();
3217}
3218
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003219llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003220 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003221
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003222 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003223 QualType FType;
3224 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003225 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003226
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003227 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003228 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003229
3230 FieldOffset = 0;
3231 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3232 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3233 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3234 FType = CGM.getContext().IntTy;
3235 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3236 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3237
3238 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3239 if (HasCopyAndDispose) {
3240 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003241 EltTys.push_back(
3242 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3243 EltTys.push_back(
3244 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003245 }
3246 bool HasByrefExtendedLayout;
3247 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003248 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3249 HasByrefExtendedLayout) &&
3250 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003251 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003252 EltTys.push_back(
3253 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003254 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003255
Guy Benyei11169dd2012-12-18 14:30:41 +00003256 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3257 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003258 CGM.getTarget().getPointerAlign(0))) {
3259 CharUnits FieldOffsetInBytes =
3260 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003261 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003262 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003263
Guy Benyei11169dd2012-12-18 14:30:41 +00003264 if (NumPaddingBytes.isPositive()) {
3265 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3266 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3267 pad, ArrayType::Normal, 0);
3268 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3269 }
3270 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003271
Guy Benyei11169dd2012-12-18 14:30:41 +00003272 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003273 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003274 FieldSize = CGM.getContext().getTypeSize(FType);
3275 FieldAlign = CGM.getContext().toBits(Align);
3276
Eric Christopherb2a008c2013-05-16 00:45:12 +00003277 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003278 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003279 FieldAlign, FieldOffset,
3280 llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003281 EltTys.push_back(FieldTy);
3282 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003283
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003284 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003285
Leny Kholodov80c047d2016-09-06 10:48:04 +00003286 llvm::DINode::DIFlags Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003287
Guy Benyei11169dd2012-12-18 14:30:41 +00003288 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003289 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003290}
3291
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003292void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3293 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00003294 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003295 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003296 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003297 if (VD->hasAttr<NoDebugAttr>())
3298 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003299
David Blaikie7fceebf2013-08-19 03:37:48 +00003300 bool Unwritten =
3301 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3302 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003303 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003304 if (!Unwritten)
3305 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003306 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003307 uint64_t XOffset = 0;
3308 if (VD->hasAttr<BlocksAttr>())
3309 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003310 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003311 Ty = getOrCreateType(VD->getType(), Unit);
3312
3313 // If there is no debug info for this type then do not emit debug info
3314 // for this variable.
3315 if (!Ty)
3316 return;
3317
Guy Benyei11169dd2012-12-18 14:30:41 +00003318 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003319 unsigned Line = 0;
3320 unsigned Column = 0;
3321 if (!Unwritten) {
3322 Line = getLineNumber(VD->getLocation());
3323 Column = getColumnNumber(VD->getLocation());
3324 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003325 SmallVector<int64_t, 9> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003326 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003327 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003328 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003329
3330 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3331
Guy Benyei11169dd2012-12-18 14:30:41 +00003332 // If this is the first argument and it is implicit then
3333 // give it an object pointer flag.
3334 // FIXME: There has to be a better way to do this, but for static
3335 // functions there won't be an implicit param at arg1 and
3336 // otherwise it is 'self' or 'this'.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003337 if (isa<ImplicitParamDecl>(VD) && ArgNo && *ArgNo == 1)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003338 Flags |= llvm::DINode::FlagObjectPointer;
David Majnemer58ed0f32016-07-17 00:39:12 +00003339 if (auto *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00003340 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
3341 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003342 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00003343
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003344 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003345
3346 StringRef Name = VD->getName();
3347 if (!Name.empty()) {
3348 if (VD->hasAttr<BlocksAttr>()) {
3349 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003350 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003351 // offset of __forwarding field
3352 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003353 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003354 Expr.push_back(offset.getQuantity());
3355 Expr.push_back(llvm::dwarf::DW_OP_deref);
3356 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003357 // offset of x field
3358 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003359 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003360
3361 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003362 auto *D = ArgNo
3363 ? DBuilder.createParameterVariable(Scope, VD->getName(),
3364 *ArgNo, Unit, Line, Ty)
3365 : DBuilder.createAutoVariable(Scope, VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003366 Line, Ty, Align);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003367
Guy Benyei11169dd2012-12-18 14:30:41 +00003368 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003369 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3370 llvm::DebugLoc::get(Line, Column, Scope),
3371 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003372 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00003373 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003374 Expr.push_back(llvm::dwarf::DW_OP_deref);
David Majnemer58ed0f32016-07-17 00:39:12 +00003375 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003376 // If VD is an anonymous union then Storage represents value for
3377 // all union fields.
David Majnemer58ed0f32016-07-17 00:39:12 +00003378 const auto *RD = cast<RecordDecl>(RT->getDecl());
Adrian Prantl0d820892015-04-29 15:05:50 +00003379 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003380 // GDB has trouble finding local variables in anonymous unions, so we emit
3381 // artifical local variables for each of the members.
3382 //
3383 // FIXME: Remove this code as soon as GDB supports this.
3384 // The debug info verifier in LLVM operates based on the assumption that a
3385 // variable has the same size as its storage and we had to disable the check
3386 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003387 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003388 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003389 StringRef FieldName = Field->getName();
3390
3391 // Ignore unnamed fields. Do not ignore unnamed records.
3392 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3393 continue;
3394
3395 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003396 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003397 auto *D = DBuilder.createAutoVariable(
3398 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003399 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003400
3401 // Insert an llvm.dbg.declare into the current block.
3402 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3403 llvm::DebugLoc::get(Line, Column, Scope),
3404 Builder.GetInsertBlock());
3405 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003406 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003407 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003408
3409 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003410 auto *D = ArgNo
3411 ? DBuilder.createParameterVariable(
3412 Scope, Name, *ArgNo, Unit, Line, Ty,
3413 CGM.getLangOpts().Optimize, Flags)
3414 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3415 CGM.getLangOpts().Optimize, Flags,
3416 Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003417
3418 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003419 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3420 llvm::DebugLoc::get(Line, Column, Scope),
3421 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003422}
3423
3424void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3425 llvm::Value *Storage,
3426 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003427 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003428 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003429}
3430
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003431llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3432 llvm::DIType *Ty) {
3433 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003434 if (CachedTy)
3435 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003436 return DBuilder.createObjectPointerType(Ty);
3437}
3438
Eric Christophere7b87e52014-10-26 23:40:33 +00003439void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3440 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003441 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003442 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003443 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003444
Craig Topper8a13c412014-05-21 05:09:00 +00003445 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003446 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003447 if (VD->hasAttr<NoDebugAttr>())
3448 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003449
Guy Benyei11169dd2012-12-18 14:30:41 +00003450 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003451
Guy Benyei11169dd2012-12-18 14:30:41 +00003452 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003453 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3454 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003455 if (isByRef)
3456 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003457 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003458 Ty = getOrCreateType(VD->getType(), Unit);
3459
3460 // Self is passed along as an implicit non-arg variable in a
3461 // block. Mark it as the object pointer.
3462 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00003463 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003464
3465 // Get location information.
3466 unsigned Line = getLineNumber(VD->getLocation());
3467 unsigned Column = getColumnNumber(VD->getLocation());
3468
3469 const llvm::DataLayout &target = CGM.getDataLayout();
3470
3471 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003472 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003473 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3474
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003475 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00003476 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003477 addr.push_back(llvm::dwarf::DW_OP_deref);
3478 addr.push_back(llvm::dwarf::DW_OP_plus);
3479 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003480 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003481 addr.push_back(llvm::dwarf::DW_OP_deref);
3482 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003483 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003484 offset =
3485 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003486 addr.push_back(offset.getQuantity());
3487 addr.push_back(llvm::dwarf::DW_OP_deref);
3488 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003489 // offset of x field
3490 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003491 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003492 }
3493
3494 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003495 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003496 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003497 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003498 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003499
Guy Benyei11169dd2012-12-18 14:30:41 +00003500 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003501 auto DL = llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back());
3502 if (InsertPoint)
3503 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3504 InsertPoint);
3505 else
3506 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3507 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003508}
3509
Guy Benyei11169dd2012-12-18 14:30:41 +00003510void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3511 unsigned ArgNo,
3512 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003513 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003514 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003515}
3516
3517namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003518struct BlockLayoutChunk {
3519 uint64_t OffsetInBits;
3520 const BlockDecl::Capture *Capture;
3521};
3522bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3523 return l.OffsetInBits < r.OffsetInBits;
3524}
Guy Benyei11169dd2012-12-18 14:30:41 +00003525}
3526
3527void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003528 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003529 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003530 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003531 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003532 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003533 ASTContext &C = CGM.getContext();
3534 const BlockDecl *blockDecl = block.getBlockDecl();
3535
3536 // Collect some general information about the block's location.
3537 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003538 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003539 unsigned line = getLineNumber(loc);
3540 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003541
Guy Benyei11169dd2012-12-18 14:30:41 +00003542 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003543 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003544
3545 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003546 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003547
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003548 SmallVector<llvm::Metadata *, 16> fields;
David Majnemerb4b671e2016-06-30 03:01:59 +00003549 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003550 blockLayout->getElementOffsetInBits(0),
3551 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003552 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003553 blockLayout->getElementOffsetInBits(1),
3554 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003555 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003556 blockLayout->getElementOffsetInBits(2),
3557 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003558 auto *FnTy = block.getBlockExpr()->getFunctionType();
3559 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
David Majnemerb4b671e2016-06-30 03:01:59 +00003560 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003561 blockLayout->getElementOffsetInBits(3),
3562 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003563 fields.push_back(createFieldType(
3564 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3565 ? C.getBlockDescriptorExtendedType()
3566 : C.getBlockDescriptorType()),
David Majnemerb4b671e2016-06-30 03:01:59 +00003567 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003568
3569 // We want to sort the captures by offset, not because DWARF
3570 // requires this, but because we're paranoid about debuggers.
3571 SmallVector<BlockLayoutChunk, 8> chunks;
3572
3573 // 'this' capture.
3574 if (blockDecl->capturesCXXThis()) {
3575 BlockLayoutChunk chunk;
3576 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003577 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003578 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003579 chunks.push_back(chunk);
3580 }
3581
3582 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003583 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003584 const VarDecl *variable = capture.getVariable();
3585 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3586
3587 // Ignore constant captures.
3588 if (captureInfo.isConstant())
3589 continue;
3590
3591 BlockLayoutChunk chunk;
3592 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003593 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003594 chunk.Capture = &capture;
3595 chunks.push_back(chunk);
3596 }
3597
3598 // Sort by offset.
3599 llvm::array_pod_sort(chunks.begin(), chunks.end());
3600
David Majnemer58ed0f32016-07-17 00:39:12 +00003601 for (const BlockLayoutChunk &Chunk : chunks) {
3602 uint64_t offsetInBits = Chunk.OffsetInBits;
3603 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00003604
3605 // If we have a null capture, this must be the C++ 'this' capture.
3606 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003607 QualType type;
3608 if (auto *Method =
3609 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3610 type = Method->getThisType(C);
3611 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3612 type = QualType(RDecl->getTypeForDecl(), 0);
3613 else
3614 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003615
David Majnemerb4b671e2016-06-30 03:01:59 +00003616 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003617 offsetInBits, tunit, tunit));
3618 continue;
3619 }
3620
3621 const VarDecl *variable = capture->getVariable();
3622 StringRef name = variable->getName();
3623
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003624 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003625 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003626 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00003627 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00003628
3629 // FIXME: this creates a second copy of this type!
3630 uint64_t xoffset;
3631 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003632 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00003633 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3634 PtrInfo.Width, Align, offsetInBits,
3635 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003636 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003637 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00003638 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00003639 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003640 }
3641 fields.push_back(fieldType);
3642 }
3643
3644 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003645 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3646 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003647
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003648 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003649
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003650 llvm::DIType *type =
3651 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00003652 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003653 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003654 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3655
3656 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00003657 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003658 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003659
3660 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003661 auto *debugVar = DBuilder.createParameterVariable(
3662 scope, Arg->getName(), ArgNo, tunit, line, type,
3663 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003664
Adrian Prantl616bef42013-03-14 21:52:59 +00003665 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003666 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003667 DBuilder.insertDbgValueIntrinsic(
Eric Christophere7b87e52014-10-26 23:40:33 +00003668 LocalAddr, 0, debugVar, DBuilder.createExpression(),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003669 llvm::DebugLoc::get(line, column, scope), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003670 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003671
Adrian Prantl616bef42013-03-14 21:52:59 +00003672 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003673 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
3674 llvm::DebugLoc::get(line, column, scope),
3675 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003676}
3677
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003678llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003679CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3680 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003681 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003682
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003683 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003684 if (MI != StaticDataMemberCache.end()) {
3685 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003686 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003687 }
David Blaikiece763042013-08-20 21:49:21 +00003688
3689 // If the member wasn't found in the cache, lazily construct and add it to the
3690 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003691 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003692 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003693 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003694}
3695
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003696llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003697 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3698 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003699 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003700
3701 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003702 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003703 StringRef FieldName = Field->getName();
3704
3705 // Ignore unnamed fields, but recurse into anonymous records.
3706 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003707 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003708 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Eric Christophercab9fae2014-04-10 05:20:00 +00003709 Var, DContext);
3710 continue;
3711 }
3712 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003713 GVE = DBuilder.createGlobalVariableExpression(
3714 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
3715 Var->hasLocalLinkage());
3716 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00003717 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003718 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00003719}
3720
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003721void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003722 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003723 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003724 if (D->hasAttr<NoDebugAttr>())
3725 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00003726
3727 // If we already created a DIGlobalVariable for this declaration, just attach
3728 // it to the llvm::GlobalVariable.
3729 auto Cached = DeclCache.find(D->getCanonicalDecl());
3730 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003731 return Var->addDebugInfo(
3732 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00003733
Guy Benyei11169dd2012-12-18 14:30:41 +00003734 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003735 llvm::DIFile *Unit = nullptr;
3736 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003737 unsigned LineNo;
3738 StringRef DeclName, LinkageName;
3739 QualType T;
3740 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003741
3742 // Attempt to store one global variable for the declaration - even if we
3743 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003744 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003745
3746 // If this is an anonymous union then we'll want to emit a global
3747 // variable for each member of the anonymous union so that it's possible
3748 // to find the name of any field in the union.
3749 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003750 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003751 assert(RD->isAnonymousStructOrUnion() &&
3752 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003753 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003754 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003755 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003756 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00003757 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003758 Var->hasLocalLinkage(), /*Expr=*/nullptr,
Victor Leschuka7ece032016-10-20 00:13:19 +00003759 getOrCreateStaticDataMemberDeclarationOrNull(D), Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003760 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00003761 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003762 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00003763}
3764
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003765void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003766 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003767 if (VD->hasAttr<NoDebugAttr>())
3768 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00003769 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003770 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003771 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003772 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003773 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00003774 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3775 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003776 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3777 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3778 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003779 // Do not use global variables for enums.
3780 //
3781 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003782 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003783 return;
David Blaikiea15565562014-04-04 20:56:17 +00003784 // Do not emit separate definitions for function local const/statics.
3785 if (isa<FunctionDecl>(VD->getDeclContext()))
3786 return;
David Blaikiebb113912014-04-05 07:23:17 +00003787 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003788 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003789 if (VarD->isStaticDataMember()) {
3790 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003791 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003792 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00003793 //
3794 // FIXME: This is probably unnecessary, since Ty should reference RD
3795 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00003796 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003797 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003798 return;
3799 }
3800
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003801 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003802
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003803 auto &GV = DeclCache[VD];
3804 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003805 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003806 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00003807 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
3808 // FIXME: Add a representation for integer constants wider than 64 bits.
3809 if (Init.isInt())
3810 InitExpr =
3811 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
3812 else if (Init.isFloat())
3813 InitExpr = DBuilder.createConstantValueExpression(
3814 Init.getFloat().bitcastToAPInt().getZExtValue());
3815 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003816 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00003817 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00003818 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
3819 Align));
David Blaikiebd483762013-05-20 04:58:53 +00003820}
3821
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003822llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003823 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003824 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003825 llvm::DIScope *Mod = getParentModuleOrNull(D);
3826 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003827}
3828
David Blaikie9f88fe82013-04-22 06:13:21 +00003829void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003830 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003831 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003832 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00003833 if (!NSDecl->isAnonymousNamespace() ||
3834 CGM.getCodeGenOpts().DebugExplicitImport) {
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003835 DBuilder.createImportedModule(
3836 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3837 getOrCreateNameSpace(NSDecl),
3838 getLineNumber(UD.getLocation()));
3839 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003840}
3841
David Blaikiebd483762013-05-20 04:58:53 +00003842void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003843 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003844 return;
3845 assert(UD.shadow_size() &&
3846 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3847 // Emitting one decl is sufficient - debuggers can detect that this is an
3848 // overloaded name & provide lookup for all the overloads.
3849 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00003850
3851 // FIXME: Skip functions with undeduced auto return type for now since we
3852 // don't currently have the plumbing for separate declarations & definitions
3853 // of free functions and mismatched types (auto in the declaration, concrete
3854 // return type in the definition)
3855 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
3856 if (const auto *AT =
3857 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
3858 if (AT->getDeducedType().isNull())
3859 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003860 if (llvm::DINode *Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003861 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003862 DBuilder.createImportedDeclaration(
3863 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3864 getLineNumber(USD.getLocation()));
3865}
3866
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003867void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00003868 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
3869 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00003870 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00003871 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl8a634c12015-12-18 19:44:31 +00003872 DBuilder.createImportedDeclaration(
3873 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
3874 getOrCreateModuleRef(Info, DebugTypeExtRefs),
3875 getLineNumber(ID.getLocation()));
3876 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003877}
3878
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003879llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00003880CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003881 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003882 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003883 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003884 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003885 return cast<llvm::DIImportedEntity>(VH);
3886 llvm::DIImportedEntity *R;
David Majnemer58ed0f32016-07-17 00:39:12 +00003887 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00003888 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3889 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003890 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003891 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3892 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3893 NA.getName());
3894 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003895 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003896 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3897 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3898 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003899 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003900 return R;
3901}
3902
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003903llvm::DINamespace *
Guy Benyei11169dd2012-12-18 14:30:41 +00003904CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003905 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003906 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003907 if (I != NameSpaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003908 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003909
Guy Benyei11169dd2012-12-18 14:30:41 +00003910 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003911 llvm::DIFile *FileD = getOrCreateFile(NSDecl->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003912 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantlbd87eb42016-11-03 19:42:14 +00003913 llvm::DINamespace *NS = DBuilder.createNameSpace(
3914 Context, NSDecl->getName(), FileD, LineNo, NSDecl->isInline());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003915 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003916 return NS;
3917}
3918
Adrian Prantla5206ce2015-09-22 23:26:43 +00003919void CGDebugInfo::setDwoId(uint64_t Signature) {
3920 assert(TheCU && "no main compile unit");
3921 TheCU->setDWOId(Signature);
3922}
3923
3924
Guy Benyei11169dd2012-12-18 14:30:41 +00003925void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003926 // Creating types might create further types - invalidating the current
3927 // element and the size(), so don't cache/reference them.
3928 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3929 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003930 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00003931 ? CreateTypeDefinition(E.Type, E.Unit)
3932 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003933 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00003934 }
3935
David Blaikief427b002014-05-06 03:42:01 +00003936 for (auto p : ReplaceMap) {
3937 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003938 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003939 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003940
David Blaikief427b002014-05-06 03:42:01 +00003941 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003942 assert(it != TypeCache.end());
3943 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003944
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003945 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
3946 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00003947 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003948
Frederic Rissd253ed62014-11-18 03:40:51 +00003949 for (const auto &p : FwdDeclReplaceMap) {
3950 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003951 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003952 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003953
3954 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003955 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003956 // with ourselves, that will destroy the temporary MDNode and
3957 // replace it with a standard one, avoiding leaking memory.
3958 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003959 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003960 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003961 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003962
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003963 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
3964 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003965 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00003966 }
3967
Adrian Prantl73409ce2013-03-11 18:33:46 +00003968 // We keep our own list of retained types, because we need to look
3969 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00003970 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00003971 if (auto MD = TypeCache[RT])
3972 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003973
Guy Benyei11169dd2012-12-18 14:30:41 +00003974 DBuilder.finalize();
3975}
David Blaikie66088d52014-09-24 17:01:27 +00003976
3977void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003978 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00003979 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003980
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003981 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003982 // Don't ignore in case of explicit cast where it is referenced indirectly.
3983 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003984}
Amara Emerson652795d2016-11-10 14:44:30 +00003985
3986llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
3987 if (LexicalBlockStack.empty())
3988 return llvm::DebugLoc();
3989
3990 llvm::MDNode *Scope = LexicalBlockStack.back();
3991 return llvm::DebugLoc::get(
3992 getLineNumber(Loc), getColumnNumber(Loc), Scope);
3993}