blob: 702ae01acf358357ac04b6a06c70c39f15ab3ea1 [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
Guy Benyei11169dd2012-12-18 14:30:41 +0000778 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000779 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000780 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000781 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000782 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000783 ReplaceMap.emplace_back(
784 std::piecewise_construct, std::make_tuple(Ty),
785 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000786 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000787}
788
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000789llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000790 const Type *Ty,
791 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000792 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000793 // Bit size, align and offset of the type.
794 // Size is always the size of a pointer. We can't use getTypeSize here
795 // because that does not return the correct value for references.
796 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000797 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +0000798 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +0000799
Keno Fischer87842f32015-11-16 09:04:13 +0000800 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
801 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
802 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
803 Size, Align);
804 else
805 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
806 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000807}
808
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000809llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
810 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000811 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000812 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000813 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
814 TheCU, getOrCreateMainFile(), 0);
815 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
816 Cache = DBuilder.createPointerType(Cache, Size);
817 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000818}
819
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000820llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
821 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000822 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000823 QualType FType;
824 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000825 uint32_t FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000826 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000827
828 FieldOffset = 0;
829 FType = CGM.getContext().UnsignedLongTy;
830 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
831 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
832
833 Elements = DBuilder.getOrCreateArray(EltTys);
834 EltTys.clear();
835
Leny Kholodov80c047d2016-09-06 10:48:04 +0000836 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000837 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000838
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000839 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000840 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000841 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000842
843 // Bit size, align and offset of the type.
844 uint64_t Size = CGM.getContext().getTypeSize(Ty);
845
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000846 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000847
848 FieldOffset = 0;
849 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
850 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
851 FType = CGM.getContext().IntTy;
852 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
853 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000854 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000855 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
856
857 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000858 FieldSize = CGM.getContext().getTypeSize(Ty);
859 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000860 EltTys.push_back(DBuilder.createMemberType(
861 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign, FieldOffset,
862 llvm::DINode::FlagZero, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000863
864 FieldOffset += FieldSize;
865 Elements = DBuilder.getOrCreateArray(EltTys);
866
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000867 // The __block_literal_generic structs are marked with a special
868 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
869 // the debugger needs to know about. To allow type uniquing, emit
870 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000871 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000872 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000873 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000874
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000875 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000876}
877
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000878llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
879 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000880 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000881 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000882
883 SmallString<128> NS;
884 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000885 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
886 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000887
888 TemplateSpecializationType::PrintTemplateArgumentList(
David Majnemer6fbeee32016-07-07 04:43:07 +0000889 OS, Ty->template_arguments(),
David Blaikief1b382e2014-04-06 17:14:06 +0000890 CGM.getContext().getPrintingPolicy());
891
David Majnemer58ed0f32016-07-17 00:39:12 +0000892 auto *AliasDecl = cast<TypeAliasTemplateDecl>(
Eric Christophere7b87e52014-10-26 23:40:33 +0000893 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000894
895 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000896 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
897 getLineNumber(Loc),
898 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000899}
900
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000901llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
902 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000903 // We don't set size information, but do specify where the typedef was
904 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +0000905 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000906
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000907 // Typedefs are derived from some other type.
908 return DBuilder.createTypedef(
909 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
910 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +0000911 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000912}
913
Reid Klecknerf00f8032016-06-08 20:41:54 +0000914static unsigned getDwarfCC(CallingConv CC) {
915 switch (CC) {
916 case CC_C:
917 // Avoid emitting DW_AT_calling_convention if the C convention was used.
918 return 0;
919
920 case CC_X86StdCall:
921 return llvm::dwarf::DW_CC_BORLAND_stdcall;
922 case CC_X86FastCall:
923 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
924 case CC_X86ThisCall:
925 return llvm::dwarf::DW_CC_BORLAND_thiscall;
926 case CC_X86VectorCall:
927 return llvm::dwarf::DW_CC_LLVM_vectorcall;
928 case CC_X86Pascal:
929 return llvm::dwarf::DW_CC_BORLAND_pascal;
930
931 // FIXME: Create new DW_CC_ codes for these calling conventions.
932 case CC_X86_64Win64:
933 case CC_X86_64SysV:
934 case CC_AAPCS:
935 case CC_AAPCS_VFP:
936 case CC_IntelOclBicc:
937 case CC_SpirFunction:
Nikolay Haustov8c6538b2016-06-30 09:06:33 +0000938 case CC_OpenCLKernel:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000939 case CC_Swift:
940 case CC_PreserveMost:
941 case CC_PreserveAll:
Erich Keane757d3172016-11-02 18:29:35 +0000942 case CC_X86RegCall:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000943 return 0;
944 }
945 return 0;
946}
947
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000948llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
949 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000950 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000951
952 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000953 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000954
955 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000956 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000957 if (isa<FunctionNoProtoType>(Ty))
958 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +0000959 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
960 for (const QualType &ParamType : FPT->param_types())
961 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000962 if (FPT->isVariadic())
963 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000964 }
965
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000966 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +0000967 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +0000968 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000969}
970
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000971/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000972/// As an optimization, return 0 if the access specifier equals the
973/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000974static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
975 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +0000976 AccessSpecifier Default = clang::AS_none;
977 if (RD && RD->isClass())
978 Default = clang::AS_private;
979 else if (RD && (RD->isStruct() || RD->isUnion()))
980 Default = clang::AS_public;
981
982 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +0000983 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000984
Eric Christophere7b87e52014-10-26 23:40:33 +0000985 switch (Access) {
986 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000987 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +0000988 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000989 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +0000990 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000991 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +0000992 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +0000993 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000994 }
995 llvm_unreachable("unexpected access enumerator");
996}
Guy Benyei11169dd2012-12-18 14:30:41 +0000997
David Majnemerb4b671e2016-06-30 03:01:59 +0000998llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
999 llvm::DIScope *RecordTy,
1000 const RecordDecl *RD) {
1001 StringRef Name = BitFieldDecl->getName();
1002 QualType Ty = BitFieldDecl->getType();
1003 SourceLocation Loc = BitFieldDecl->getLocation();
1004 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1005 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1006
1007 // Get the location for the field.
1008 llvm::DIFile *File = getOrCreateFile(Loc);
1009 unsigned Line = getLineNumber(Loc);
1010
1011 const CGBitFieldInfo &BitFieldInfo =
1012 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1013 uint64_t SizeInBits = BitFieldInfo.Size;
1014 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001015 uint64_t StorageOffsetInBits =
1016 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1017 uint64_t OffsetInBits = StorageOffsetInBits + BitFieldInfo.Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001018 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001019 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001020 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1021 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001022}
1023
1024llvm::DIType *
1025CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1026 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001027 uint32_t AlignInBits, llvm::DIFile *tunit,
1028 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001029 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001030
1031 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001032 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001033 unsigned line = getLineNumber(loc);
1034
David Majnemer34b57492014-07-30 01:30:47 +00001035 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001036 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001037 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001038 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1039 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001040 if (!Align)
1041 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001042 }
1043
Leny Kholodov80c047d2016-09-06 10:48:04 +00001044 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +00001045 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001046 Align, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001047}
1048
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001049void CGDebugInfo::CollectRecordLambdaFields(
1050 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001051 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001052 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1053 // has the name and the location of the variable so we should iterate over
1054 // both concurrently.
1055 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1056 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1057 unsigned fieldno = 0;
1058 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001059 E = CXXDecl->captures_end();
1060 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001061 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001062 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001063 SourceLocation Loc = C.getLocation();
1064 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001065 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001066 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001067 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001068 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001069 llvm::DIType *FieldType = createFieldType(
1070 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001071 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001072 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001073 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001074 // TODO: Need to handle 'this' in some way by probably renaming the
1075 // this of the lambda class and having a field member of 'this' or
1076 // by using AT_object_pointer for the function and having that be
1077 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001078 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001079 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001080 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001081 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001082 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001083 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001084
1085 elements.push_back(fieldType);
1086 }
1087 }
1088}
1089
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001090llvm::DIDerivedType *
1091CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001092 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001093 // Create the descriptor for the static variable, with or without
1094 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001095 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001096 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1097 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001098
Eric Christopher91a31902013-01-16 01:22:32 +00001099 unsigned LineNumber = getLineNumber(Var->getLocation());
1100 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001101 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001102 if (Var->getInit()) {
1103 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001104 if (Value) {
1105 if (Value->isInt())
1106 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1107 if (Value->isFloat())
1108 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1109 }
Eric Christopher91a31902013-01-16 01:22:32 +00001110 }
1111
Leny Kholodov80c047d2016-09-06 10:48:04 +00001112 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001113 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001114 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001115 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001116 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001117 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001118}
1119
Eric Christophere7b87e52014-10-26 23:40:33 +00001120void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001121 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1122 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001123 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001124 StringRef name = field->getName();
1125 QualType type = field->getType();
1126
1127 // Ignore unnamed fields unless they're anonymous structs/unions.
1128 if (name.empty() && !type->isRecordType())
1129 return;
1130
David Majnemerb4b671e2016-06-30 03:01:59 +00001131 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001132 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001133 FieldType = createBitFieldType(field, RecordTy, RD);
1134 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001135 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001136 FieldType =
1137 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001138 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001139 }
1140
David Majnemerb4b671e2016-06-30 03:01:59 +00001141 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001142}
1143
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001144void CGDebugInfo::CollectRecordNestedRecord(
1145 const RecordDecl *RD, SmallVectorImpl<llvm::Metadata *> &elements) {
1146 QualType Ty = CGM.getContext().getTypeDeclType(RD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001147 // Injected class names are not considered nested records.
1148 if (isa<InjectedClassNameType>(Ty))
1149 return;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001150 SourceLocation Loc = RD->getLocation();
1151 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1152 elements.push_back(nestedType);
1153}
1154
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001155void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001156 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001157 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001158 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001159 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001160
Eric Christopher91a31902013-01-16 01:22:32 +00001161 if (CXXDecl && CXXDecl->isLambda())
1162 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1163 else {
1164 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001165
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001166 // Debug info for nested records is included in the member list only for
1167 // CodeView.
1168 bool IncludeNestedRecords = CGM.getCodeGenOpts().EmitCodeView;
1169
Eric Christopher91a31902013-01-16 01:22:32 +00001170 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001171 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001172
Eric Christopher91a31902013-01-16 01:22:32 +00001173 // Static and non-static members should appear in the same order as
1174 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001175 for (const auto *I : record->decls())
1176 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001177 if (V->hasAttr<NoDebugAttr>())
1178 continue;
David Blaikiece763042013-08-20 21:49:21 +00001179 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001180 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001181 if (MI != StaticDataMemberCache.end()) {
1182 assert(MI->second &&
1183 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001184 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001185 } else {
1186 auto Field = CreateRecordStaticField(V, RecordTy, record);
1187 elements.push_back(Field);
1188 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001189 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001190 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1191 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001192
1193 // Bump field number for next field.
1194 ++fieldNo;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001195 } else if (const auto *nestedRec = dyn_cast<CXXRecordDecl>(I))
1196 if (IncludeNestedRecords && !nestedRec->isImplicit() &&
1197 nestedRec->getDeclContext() == record)
1198 CollectRecordNestedRecord(nestedRec, elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001199 }
1200}
1201
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001202llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001203CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001204 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001205 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001206 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001207 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001208 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001209 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1210 Func, Unit);
1211}
David Blaikie2aaf0652013-01-07 22:24:59 +00001212
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001213llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1214 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001215 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001216 llvm::DITypeRefArray Args(
1217 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001218 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001219 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001220
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001221 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001222
1223 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001224 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001225
David Blaikie2aaf0652013-01-07 22:24:59 +00001226 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001227 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001228 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1229 // Create pointer type directly in this case.
1230 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1231 QualType PointeeTy = ThisPtrTy->getPointeeType();
1232 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001233 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001234 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001235 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1236 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001237 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001238 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001239 // TODO: This and the artificial type below are misleading, the
1240 // types aren't artificial the argument is, but the current
1241 // metadata doesn't represent that.
1242 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1243 Elts.push_back(ThisPtrType);
1244 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001245 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001246 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001247 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1248 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001249 }
1250
1251 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001252 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1253 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001254
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001255 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001256
Leny Kholodov80c047d2016-09-06 10:48:04 +00001257 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001258 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001259 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001260 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001261 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001262
Reid Klecknerf00f8032016-06-08 20:41:54 +00001263 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1264 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001265}
1266
Eric Christopherb2a008c2013-05-16 00:45:12 +00001267/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001268/// inside a function.
1269static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001270 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001271 return isFunctionLocalClass(NRD);
1272 if (isa<FunctionDecl>(RD->getDeclContext()))
1273 return true;
1274 return false;
1275}
1276
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001277llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1278 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001279 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001280 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001281
Guy Benyei11169dd2012-12-18 14:30:41 +00001282 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001283 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001284
1285 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1286 // make sense to give a single ctor/dtor a linkage name.
1287 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001288 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1289 // property to use here. It may've been intended to model "is non-external
1290 // type" but misses cases of non-function-local but non-external classes such
1291 // as those in anonymous namespaces as well as the reverse - external types
1292 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001293 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1294 MethodLinkageName = CGM.getMangledName(Method);
1295
1296 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001297 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001298 unsigned MethodLine = 0;
1299 if (!Method->isImplicit()) {
1300 MethodDefUnit = getOrCreateFile(Method->getLocation());
1301 MethodLine = getLineNumber(Method->getLocation());
1302 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001303
1304 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001305 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001306 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001307 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001308 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001309 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001310
Guy Benyei11169dd2012-12-18 14:30:41 +00001311 if (Method->isVirtual()) {
1312 if (Method->isPure())
1313 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1314 else
1315 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001316
Reid Kleckner216d0a12016-06-16 20:08:51 +00001317 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1318 // It doesn't make sense to give a virtual destructor a vtable index,
1319 // since a single destructor has two entries in the vtable.
1320 if (!isa<CXXDestructorDecl>(Method))
1321 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1322 } else {
1323 // Emit MS ABI vftable information. There is only one entry for the
1324 // deleting dtor.
1325 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1326 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1327 MicrosoftVTableContext::MethodVFTableLocation ML =
1328 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1329 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001330
1331 // CodeView only records the vftable offset in the class that introduces
1332 // the virtual method. This is possible because, unlike Itanium, the MS
1333 // C++ ABI does not include all virtual methods from non-primary bases in
1334 // the vtable for the most derived class. For example, if C inherits from
1335 // A and B, C's primary vftable will not include B's virtual methods.
1336 if (Method->begin_overridden_methods() == Method->end_overridden_methods())
1337 Flags |= llvm::DINode::FlagIntroducedVirtual;
1338
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001339 // The 'this' adjustment accounts for both the virtual and non-virtual
1340 // portions of the adjustment. Presumably the debugger only uses it when
1341 // it knows the dynamic type of an object.
1342 ThisAdjustment = CGM.getCXXABI()
1343 .getVirtualFunctionPrologueThisAdjustment(GD)
1344 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001345 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001346 ContainingType = RecordTy;
1347 }
1348
Guy Benyei11169dd2012-12-18 14:30:41 +00001349 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001350 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001351 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001352 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001353 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001354 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001355 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001356 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001357 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001358 }
1359 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001360 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001361 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001362 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001363 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001364 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001365
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001366 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1367 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001368 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001369 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1370 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1371 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001372
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001373 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001374
1375 return SP;
1376}
1377
Eric Christophere7b87e52014-10-26 23:40:33 +00001378void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001379 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1380 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001381
1382 // Since we want more than just the individual member decls if we
1383 // have templated functions iterate over every declaration to gather
1384 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001385 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001386 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1387 // If the member is implicit, don't add it to the member list. This avoids
1388 // the member being added to type units by LLVM, while still allowing it
1389 // to be emitted into the type declaration/reference inside the compile
1390 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001391 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001392 // FIXME: Handle Using(Shadow?)Decls here to create
1393 // DW_TAG_imported_declarations inside the class for base decls brought into
1394 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1395 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1396 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001397 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001398 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001399
1400 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1401 continue;
1402
David Blaikiefd580722014-10-06 05:18:55 +00001403 // Reuse the existing member function declaration if it exists.
1404 // It may be associated with the declaration of the type & should be
1405 // reused as we're building the definition.
1406 //
1407 // This situation can arise in the vtable-based debug info reduction where
1408 // implicit members are emitted in a non-vtable TU.
1409 auto MI = SPCache.find(Method->getCanonicalDecl());
1410 EltTys.push_back(MI == SPCache.end()
1411 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001412 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001413 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001414}
Guy Benyei11169dd2012-12-18 14:30:41 +00001415
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001416void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001417 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001418 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001419 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1420 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1421 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001422
Bob Haarmandff36732016-10-25 22:19:32 +00001423 // If we are generating CodeView debug info, we also need to emit records for
1424 // indirect virtual base classes.
1425 if (CGM.getCodeGenOpts().EmitCodeView) {
1426 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1427 llvm::DINode::FlagIndirectVirtualBase);
1428 }
1429}
1430
1431void CGDebugInfo::CollectCXXBasesAux(
1432 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1433 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1434 const CXXRecordDecl::base_class_const_range &Bases,
1435 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1436 llvm::DINode::DIFlags StartingFlags) {
1437 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1438 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001439 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001440 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001441 if (!SeenTypes.insert(Base).second)
1442 continue;
1443 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1444 llvm::DINode::DIFlags BFlags = StartingFlags;
1445 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001446
Aaron Ballman574705e2014-03-13 15:41:46 +00001447 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001448 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1449 // virtual base offset offset is -ve. The code generator emits dwarf
1450 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001451 BaseOffset = 0 - CGM.getItaniumVTableContext()
1452 .getVirtualBaseOffsetOffset(RD, Base)
1453 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001454 } else {
1455 // In the MS ABI, store the vbtable offset, which is analogous to the
1456 // vbase offset offset in Itanium.
1457 BaseOffset =
1458 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1459 }
Bob Haarmandff36732016-10-25 22:19:32 +00001460 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001461 } else
1462 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1463 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1464 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001465
Adrian Prantl21361fb2014-08-29 22:44:27 +00001466 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Bob Haarmandff36732016-10-25 22:19:32 +00001467 llvm::DIType *DTy =
1468 DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001469 EltTys.push_back(DTy);
1470 }
1471}
1472
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001473llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001474CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1475 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001476 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001477 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001478 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1479 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001480 StringRef Name;
1481 if (TPList)
1482 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001483 switch (TA.getKind()) {
1484 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001485 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001486 TemplateParams.push_back(
1487 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001488 } break;
1489 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001490 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001491 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1492 TheCU, Name, TTy,
1493 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001494 } break;
1495 case TemplateArgument::Declaration: {
1496 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001497 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001498 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001499 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001500 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001501 // Variable pointer template parameters have a value that is the address
1502 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001503 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001504 V = CGM.GetAddrOfGlobalVar(VD);
1505 // Member function pointers have special support for building them, though
1506 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001507 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001508 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001509 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001510 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001511 // Member data pointers have special handling too to compute the fixed
1512 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001513 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001514 // These five lines (& possibly the above member function pointer
1515 // handling) might be able to be refactored to use similar code in
1516 // CodeGenModule::getMemberPointerConstant
1517 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1518 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001519 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001520 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001521 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001522 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1523 TheCU, Name, TTy,
1524 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001525 } break;
1526 case TemplateArgument::NullPtr: {
1527 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001528 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001529 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001530 // Special case member data pointer null values since they're actually -1
1531 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001532 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001533 // But treat member function pointers as simple zero integers because
1534 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1535 // CodeGen grows handling for values of non-null member function
1536 // pointers then perhaps we could remove this special case and rely on
1537 // EmitNullMemberPointer for member function pointers.
1538 if (MPT->isMemberDataPointer())
1539 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1540 if (!V)
1541 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001542 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001543 TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001544 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001545 case TemplateArgument::Template:
1546 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001547 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001548 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1549 break;
1550 case TemplateArgument::Pack:
1551 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1552 TheCU, Name, nullptr,
1553 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1554 break;
David Majnemer5559d472013-08-24 08:21:10 +00001555 case TemplateArgument::Expression: {
1556 const Expr *E = TA.getAsExpr();
1557 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001558 if (E->isGLValue())
1559 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001560 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001561 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001562 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001563 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001564 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001565 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001566 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001567 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001568 case TemplateArgument::Null:
1569 llvm_unreachable(
1570 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001571 }
1572 }
1573 return DBuilder.getOrCreateArray(TemplateParams);
1574}
1575
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001576llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001577CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001578 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001579 if (FD->getTemplatedKind() ==
1580 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001581 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1582 ->getTemplate()
1583 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001584 return CollectTemplateParams(
1585 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001586 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001587 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001588}
1589
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001590llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1591 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001592 // Always get the full list of parameters, not just the ones from
1593 // the specialization.
1594 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001595 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001596 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001597 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001598}
1599
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001600llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001601 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001602 return VTablePtrType;
1603
1604 ASTContext &Context = CGM.getContext();
1605
1606 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001607 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001608 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001609 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001610 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001611 llvm::DIType *vtbl_ptr_type =
Eric Christophere7b87e52014-10-26 23:40:33 +00001612 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001613 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1614 return VTablePtrType;
1615}
1616
Guy Benyei11169dd2012-12-18 14:30:41 +00001617StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001618 // Copy the gdb compatible name on the side and use its reference.
1619 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001620}
1621
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001622void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001623 SmallVectorImpl<llvm::Metadata *> &EltTys,
1624 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001625 // If this class is not dynamic then there is not any vtable info to collect.
1626 if (!RD->isDynamicClass())
1627 return;
1628
Reid Kleckner59812422016-08-31 20:35:01 +00001629 // Don't emit any vtable shape or vptr info if this class doesn't have an
1630 // extendable vfptr. This can happen if the class doesn't have virtual
1631 // methods, or in the MS ABI if those virtual methods only come from virtually
1632 // inherited bases.
1633 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1634 if (!RL.hasExtendableVFPtr())
1635 return;
1636
Reid Klecknerdc124992016-08-31 16:11:43 +00001637 // CodeView needs to know how large the vtable of every dynamic class is, so
1638 // emit a special named pointer type into the element list. The vptr type
1639 // points to this type as well.
1640 llvm::DIType *VPtrTy = nullptr;
1641 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1642 CGM.getTarget().getCXXABI().isMicrosoft();
1643 if (NeedVTableShape) {
1644 uint64_t PtrWidth =
1645 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1646 const VTableLayout &VFTLayout =
1647 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1648 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001649 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001650 unsigned VTableWidth = PtrWidth * VSlotCount;
1651
1652 // Create a very wide void* type and insert it directly in the element list.
1653 llvm::DIType *VTableType =
1654 DBuilder.createPointerType(nullptr, VTableWidth, 0, "__vtbl_ptr_type");
1655 EltTys.push_back(VTableType);
1656
1657 // The vptr is a pointer to this special vtable type.
1658 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1659 }
1660
1661 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001662 if (RL.getPrimaryBase())
1663 return;
1664
1665 if (!VPtrTy)
1666 VPtrTy = getOrCreateVTablePtrType(Unit);
1667
Guy Benyei11169dd2012-12-18 14:30:41 +00001668 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001669 llvm::DIType *VPtrMember = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001670 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Reid Klecknerdc124992016-08-31 16:11:43 +00001671 llvm::DINode::FlagArtificial, VPtrTy);
1672 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001673}
1674
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001675llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001676 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001677 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001678 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001679 return T;
1680}
1681
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001682llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001683 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001684 return getOrCreateStandaloneType(D, Loc);
1685}
1686
1687llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1688 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001689 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001690 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001691 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001692 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001693
Adrian Prantl73409ce2013-03-11 18:33:46 +00001694 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001695 return T;
1696}
1697
David Blaikie483a9da2014-05-06 18:35:21 +00001698void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001699 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001700 return;
1701 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001702 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001703 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001704 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001705 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001706 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001707 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001708 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001709}
1710
David Blaikieb2e86eb2013-08-15 20:49:17 +00001711void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001712 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001713 !CGM.getLangOpts().CPlusPlus)
1714 completeRequiredType(RD);
1715}
1716
David Blaikieb06bcde2017-01-23 02:24:03 +00001717/// Return true if the class or any of its methods are marked dllimport.
1718static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1719 if (RD->hasAttr<DLLImportAttr>())
1720 return true;
1721 for (const CXXMethodDecl *MD : RD->methods())
1722 if (MD->hasAttr<DLLImportAttr>())
1723 return true;
1724 return false;
1725}
1726
David Blaikie6943dea2013-08-20 01:28:15 +00001727void CGDebugInfo::completeClassData(const RecordDecl *RD) {
David Blaikieb06bcde2017-01-23 02:24:03 +00001728 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1729 if (CGM.getVTableLinkage(CXXRD) ==
1730 llvm::GlobalValue::AvailableExternallyLinkage &&
1731 !isClassOrMethodDLLImport(CXXRD))
1732 return;
1733 completeClass(RD);
1734}
1735
1736void CGDebugInfo::completeClass(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001737 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001738 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001739 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001740 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001741 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001742 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001743 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001744 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001745 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001746 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001747}
1748
David Blaikie0e716b42014-03-03 23:48:23 +00001749static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1750 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001751 for (CXXMethodDecl *MD : llvm::make_range(I, End))
1752 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001753 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00001754 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001755 return true;
1756 return false;
1757}
1758
Adrian Prantl05fefa42016-04-25 20:52:40 +00001759/// Does a type definition exist in an imported clang module?
1760static bool isDefinedInClangModule(const RecordDecl *RD) {
Adrian Prantl09906a62016-08-22 22:38:16 +00001761 // Only definitions that where imported from an AST file come from a module.
Adrian Prantl88d79172016-04-26 21:58:18 +00001762 if (!RD || !RD->isFromASTFile())
Adrian Prantl05fefa42016-04-25 20:52:40 +00001763 return false;
Adrian Prantl09906a62016-08-22 22:38:16 +00001764 // Anonymous entities cannot be addressed. Treat them as not from module.
Adrian Prantl05fefa42016-04-25 20:52:40 +00001765 if (!RD->isExternallyVisible() && RD->getName().empty())
1766 return false;
Adrian Prantl94913712016-04-26 23:42:43 +00001767 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
Adrian Prantla72972b2016-08-22 22:23:58 +00001768 if (!CXXDecl->isCompleteDefinition())
1769 return false;
Adrian Prantl26cb1d22016-08-17 18:27:24 +00001770 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1771 if (TemplateKind != TSK_Undeclared) {
1772 // This is a template, check the origin of the first member.
1773 if (CXXDecl->field_begin() == CXXDecl->field_end())
1774 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1775 if (!CXXDecl->field_begin()->isFromASTFile())
1776 return false;
1777 }
Adrian Prantl94913712016-04-26 23:42:43 +00001778 }
Adrian Prantl05fefa42016-04-25 20:52:40 +00001779 return true;
1780}
1781
Benjamin Kramer8c305922016-02-02 11:06:51 +00001782static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1783 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001784 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001785 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001786 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001787
Benjamin Kramer8c305922016-02-02 11:06:51 +00001788 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001789 return false;
1790
1791 if (!LangOpts.CPlusPlus)
1792 return false;
1793
1794 if (!RD->isCompleteDefinitionRequired())
1795 return true;
1796
David Majnemer58ed0f32016-07-17 00:39:12 +00001797 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00001798
1799 if (!CXXDecl)
1800 return false;
1801
Adrian McCarthy99242982016-08-16 22:11:18 +00001802 // Only emit complete debug info for a dynamic class when its vtable is
1803 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00001804 // across DLL boundaries, so skip this optimization if the class or any of its
1805 // methods are marked dllimport. This isn't a complete solution, since objects
1806 // without any dllimport methods can be used in one DLL and constructed in
1807 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00001808 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00001809 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00001810 return true;
1811
1812 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00001813 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00001814 Spec = SD->getSpecializationKind();
1815
1816 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1817 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1818 CXXDecl->method_end()))
1819 return true;
1820
1821 return false;
1822}
1823
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00001824void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
1825 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
1826 return;
1827
1828 QualType Ty = CGM.getContext().getRecordType(RD);
1829 llvm::DIType *T = getTypeOrNull(Ty);
1830 if (T && T->isForwardDecl())
1831 completeClassData(RD);
1832}
1833
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001834llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001835 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001836 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001837 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1838 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001839 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001840 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001841 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001842 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001843
David Blaikieb2e86eb2013-08-15 20:49:17 +00001844 return CreateTypeDefinition(Ty);
1845}
1846
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001847llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001848 RecordDecl *RD = Ty->getDecl();
1849
Guy Benyei11169dd2012-12-18 14:30:41 +00001850 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001851 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001852
1853 // Records and classes and unions can all be recursive. To handle them, we
1854 // first generate a debug descriptor for the struct as a forward declaration.
1855 // Then (if it is a definition) we go through and get debug info for all of
1856 // its members. Finally, we create a descriptor for the complete type (which
1857 // may refer to the forward decl if the struct is recursive) and replace all
1858 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001859 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001860
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001861 const RecordDecl *D = RD->getDefinition();
1862 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001863 return FwdDecl;
1864
David Majnemer58ed0f32016-07-17 00:39:12 +00001865 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00001866 CollectContainingType(CXXDecl, FwdDecl);
1867
Guy Benyei11169dd2012-12-18 14:30:41 +00001868 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001869 LexicalBlockStack.emplace_back(&*FwdDecl);
1870 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001871
Guy Benyei11169dd2012-12-18 14:30:41 +00001872 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001873 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001874 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001875
1876 // Note: The split of CXXDecl information here is intentional, the
1877 // gdb tests will depend on a certain ordering at printout. The debug
1878 // information offsets are still correct if we merge them all together
1879 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00001880 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00001881 if (CXXDecl) {
1882 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00001883 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001884 }
1885
Eric Christopher91a31902013-01-16 01:22:32 +00001886 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001887 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001888 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001889 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001890
1891 LexicalBlockStack.pop_back();
1892 RegionMap.erase(Ty->getDecl());
1893
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001894 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001895 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001896
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001897 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001898 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001899 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001900
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001901 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001902 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001903}
1904
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001905llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1906 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001907 // Ignore protocols.
1908 return getOrCreateType(Ty->getBaseType(), Unit);
1909}
1910
Manman Rene6be26c2016-09-13 17:25:08 +00001911llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
1912 llvm::DIFile *Unit) {
1913 // Ignore protocols.
1914 SourceLocation Loc = Ty->getDecl()->getLocation();
1915
1916 // Use Typedefs to represent ObjCTypeParamType.
1917 return DBuilder.createTypedef(
1918 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1919 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
1920 getDeclContextDescriptor(Ty->getDecl()));
1921}
1922
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001923/// \return true if Getter has the default name for the property PD.
1924static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1925 const ObjCMethodDecl *Getter) {
1926 assert(PD);
1927 if (!Getter)
1928 return true;
1929
1930 assert(Getter->getDeclName().isObjCZeroArgSelector());
1931 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001932 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001933}
1934
1935/// \return true if Setter has the default name for the property PD.
1936static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1937 const ObjCMethodDecl *Setter) {
1938 assert(PD);
1939 if (!Setter)
1940 return true;
1941
1942 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001943 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001944 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001945}
1946
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001947llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1948 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001949 ObjCInterfaceDecl *ID = Ty->getDecl();
1950 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001951 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001952
Adrian Prantl50fd1a82016-04-20 23:59:32 +00001953 // Return a forward declaration if this type was imported from a clang module,
1954 // and this is not the compile unit with the implementation of the type (which
1955 // may contain hidden ivars).
1956 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
1957 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001958 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1959 ID->getName(),
1960 getDeclContextDescriptor(ID), Unit, 0);
1961
Guy Benyei11169dd2012-12-18 14:30:41 +00001962 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001963 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001964 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001965 auto RuntimeLang =
1966 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00001967
1968 // If this is just a forward declaration return a special forward-declaration
1969 // debug type since we won't be able to lay out the entire type.
1970 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001971 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001972 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001973 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001974 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
1975 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001976 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001977 return FwdDecl;
1978 }
1979
David Blaikieef8a9512014-05-05 23:23:53 +00001980 return CreateTypeDefinition(Ty, Unit);
1981}
1982
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001983llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00001984CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
1985 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00001986 // Use the Module pointer as the key into the cache. This is a
1987 // nullptr if the "Module" is a PCH, which is safe because we don't
1988 // support chained PCH debug info, so there can only be a single PCH.
1989 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001990 auto ModRef = ModuleCache.find(M);
1991 if (ModRef != ModuleCache.end())
1992 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00001993
1994 // Macro definitions that were defined with "-D" on the command line.
1995 SmallString<128> ConfigMacros;
1996 {
1997 llvm::raw_svector_ostream OS(ConfigMacros);
1998 const auto &PPOpts = CGM.getPreprocessorOpts();
1999 unsigned I = 0;
2000 // Translate the macro definitions back into a commmand line.
2001 for (auto &M : PPOpts.Macros) {
2002 if (++I > 1)
2003 OS << " ";
2004 const std::string &Macro = M.first;
2005 bool Undef = M.second;
2006 OS << "\"-" << (Undef ? 'U' : 'D');
2007 for (char c : Macro)
2008 switch (c) {
2009 case '\\' : OS << "\\\\"; break;
2010 case '"' : OS << "\\\""; break;
2011 default: OS << c;
2012 }
2013 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002014 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002015 }
Adrian Prantl66689202015-09-18 23:01:45 +00002016
Adrian Prantl835e6632015-09-24 16:10:10 +00002017 bool IsRootModule = M ? !M->Parent : true;
2018 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002019 // PCH files don't have a signature field in the control block,
2020 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Adrian Prantl98bfc822016-01-22 19:29:41 +00002021 uint64_t Signature = Mod.getSignature() ? Mod.getSignature() : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002022 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002023 DIB.createCompileUnit(TheCU->getSourceLanguage(),
2024 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2025 TheCU->getProducer(), true, StringRef(), 0,
2026 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2027 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002028 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002029 }
Adrian Prantl835e6632015-09-24 16:10:10 +00002030 llvm::DIModule *Parent =
2031 IsRootModule ? nullptr
2032 : getOrCreateModuleRef(
2033 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2034 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002035 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002036 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2037 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002038 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002039 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002040}
2041
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002042llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2043 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002044 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002045 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002046 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002047 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002048
2049 // Bit size, align and offset of the type.
2050 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002051 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002052
Leny Kholodov80c047d2016-09-06 10:48:04 +00002053 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002054 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002055 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002056
Adrian Prantlfd696112015-10-01 00:48:51 +00002057 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002058 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002059 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2060 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002061
David Blaikieef8a9512014-05-05 23:23:53 +00002062 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002063 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002064
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002065 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002066 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002067 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002068
2069 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002070 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002071
2072 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2073 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002074 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002075 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002076 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002077 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002078
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002079 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0,
2080 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002081 EltTys.push_back(InhTag);
2082 }
2083
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002084 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002085 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002086 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002087 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002088 unsigned PLine = getLineNumber(Loc);
2089 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2090 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002091 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2092 PD->getName(), PUnit, PLine,
2093 hasDefaultGetterName(PD, Getter) ? ""
2094 : getSelectorName(PD->getGetterName()),
2095 hasDefaultSetterName(PD, Setter) ? ""
2096 : getSelectorName(PD->getSetterName()),
2097 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002098 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002099 };
2100 {
2101 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002102 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002103 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002104 PropertySet.insert(PD->getIdentifier());
2105 AddProperty(PD);
2106 }
Manman Renefe1bac2016-01-27 20:00:32 +00002107 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002108 // Don't emit duplicate metadata for properties that were already in a
2109 // class extension.
2110 if (!PropertySet.insert(PD->getIdentifier()).second)
2111 continue;
2112 AddProperty(PD);
2113 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002114 }
2115
2116 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2117 unsigned FieldNo = 0;
2118 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2119 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002120 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002121 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002122 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002123
Guy Benyei11169dd2012-12-18 14:30:41 +00002124 StringRef FieldName = Field->getName();
2125
2126 // Ignore unnamed fields.
2127 if (FieldName.empty())
2128 continue;
2129
2130 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002131 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002132 unsigned FieldLine = getLineNumber(Field->getLocation());
2133 QualType FType = Field->getType();
2134 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002135 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002136
2137 if (!FType->isIncompleteArrayType()) {
2138
2139 // Bit size, align and offset of the type.
2140 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002141 ? Field->getBitWidthValue(CGM.getContext())
2142 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002143 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002144 }
2145
2146 uint64_t FieldOffset;
2147 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2148 // We don't know the runtime offset of an ivar if we're using the
2149 // non-fragile ABI. For bitfields, use the bit offset into the first
2150 // byte of storage of the bitfield. For other fields, use zero.
2151 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002152 FieldOffset =
2153 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002154 FieldOffset %= CGM.getContext().getCharWidth();
2155 } else {
2156 FieldOffset = 0;
2157 }
2158 } else {
2159 FieldOffset = RL.getFieldOffset(FieldNo);
2160 }
2161
Leny Kholodov80c047d2016-09-06 10:48:04 +00002162 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002163 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002164 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002165 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002166 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002167 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002168 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002169
Craig Topper8a13c412014-05-21 05:09:00 +00002170 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002171 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002172 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002173 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002174 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002175 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002176 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002177 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002178 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2179 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002180 PropertyNode = DBuilder.createObjCProperty(
2181 PD->getName(), PUnit, PLine,
2182 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2183 PD->getGetterName()),
2184 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2185 PD->getSetterName()),
2186 PD->getPropertyAttributes(),
2187 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002188 }
2189 }
2190 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002191 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2192 FieldSize, FieldAlign, FieldOffset, Flags,
2193 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002194 EltTys.push_back(FieldTy);
2195 }
2196
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002197 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002198 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002199
Guy Benyei11169dd2012-12-18 14:30:41 +00002200 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002201 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002202}
2203
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002204llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2205 llvm::DIFile *Unit) {
2206 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002207 int64_t Count = Ty->getNumElements();
2208 if (Count == 0)
2209 // If number of elements are not known then this is an unbounded array.
2210 // Use Count == -1 to express such arrays.
2211 Count = -1;
2212
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002213 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002214 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002215
2216 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002217 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002218
2219 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2220}
2221
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002222llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002223 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002224 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002225
2226 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002227 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002228 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002229 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2230 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002231 } else if (Ty->isIncompleteArrayType()) {
2232 Size = 0;
2233 if (Ty->getElementType()->isIncompleteType())
2234 Align = 0;
2235 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002236 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002237 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002238 Size = 0;
2239 Align = 0;
2240 } else {
2241 // Size and align of the whole array, not the element type.
2242 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002243 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002244 }
2245
2246 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2247 // interior arrays, do we care? Why aren't nested arrays represented the
2248 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002249 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002250 QualType EltTy(Ty, 0);
2251 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2252 // If the number of elements is known, then count is that number. Otherwise,
2253 // it's -1. This allows us to represent a subrange with an array of 0
2254 // elements, like this:
2255 //
2256 // struct foo {
2257 // int x[0];
2258 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002259 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002260 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002261 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002262 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002263 if (Expr *Size = VAT->getSizeExpr()) {
2264 llvm::APSInt V;
2265 if (Size->EvaluateAsInt(V, CGM.getContext()))
2266 Count = V.getExtValue();
2267 }
David Blaikie87173f12016-08-22 17:49:56 +00002268 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002269
Guy Benyei11169dd2012-12-18 14:30:41 +00002270 // FIXME: Verify this is right for VLAs.
2271 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2272 EltTy = Ty->getElementType();
2273 }
2274
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002275 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002276
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002277 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2278 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002279}
2280
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002281llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2282 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002283 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2284 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002285}
2286
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002287llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2288 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002289 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2290 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002291}
2292
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002293llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2294 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002295 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002296 uint64_t Size = 0;
2297
2298 if (!Ty->isIncompleteType()) {
2299 Size = CGM.getContext().getTypeSize(Ty);
2300
2301 // Set the MS inheritance model. There is no flag for the unspecified model.
2302 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2303 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2304 case MSInheritanceAttr::Keyword_single_inheritance:
2305 Flags |= llvm::DINode::FlagSingleInheritance;
2306 break;
2307 case MSInheritanceAttr::Keyword_multiple_inheritance:
2308 Flags |= llvm::DINode::FlagMultipleInheritance;
2309 break;
2310 case MSInheritanceAttr::Keyword_virtual_inheritance:
2311 Flags |= llvm::DINode::FlagVirtualInheritance;
2312 break;
2313 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2314 break;
2315 }
2316 }
2317 }
2318
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002319 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002320 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002321 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002322 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2323 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002324
2325 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002326 Ty->getPointeeType()->getAs<FunctionProtoType>();
2327 return DBuilder.createMemberPointerType(
2328 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2329 Ty->getClass(), FPT->getTypeQuals())),
2330 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002331 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002332}
2333
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002334llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002335 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2336 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002337}
2338
Xiuli Pan9c14e282016-01-09 12:53:17 +00002339llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2340 llvm::DIFile *U) {
2341 return getOrCreateType(Ty->getElementType(), U);
2342}
2343
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002344llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002345 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002346
Guy Benyei11169dd2012-12-18 14:30:41 +00002347 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002348 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002349 if (!ED->getTypeForDecl()->isIncompleteType()) {
2350 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002351 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002352 }
2353
Manman Rene0064d82013-08-29 23:19:58 +00002354 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2355
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002356 bool isImportedFromModule =
2357 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2358
Guy Benyei11169dd2012-12-18 14:30:41 +00002359 // If this is just a forward declaration, construct an appropriately
2360 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002361 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002362 // Note that it is possible for enums to be created as part of
2363 // their own declcontext. In this case a FwdDecl will be created
2364 // twice. This doesn't cause a problem because both FwdDecls are
2365 // entered into the ReplaceMap: finalize() will replace the first
2366 // FwdDecl with the second and then replace the second with
2367 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002368 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002369 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002370 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2371 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002372
Guy Benyei11169dd2012-12-18 14:30:41 +00002373 unsigned Line = getLineNumber(ED->getLocation());
2374 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002375 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002376 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2377 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Adrian Prantla40030f2016-02-06 01:59:09 +00002378
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002379 ReplaceMap.emplace_back(
2380 std::piecewise_construct, std::make_tuple(Ty),
2381 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002382 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002383 }
2384
David Blaikie483a9da2014-05-06 18:35:21 +00002385 return CreateTypeDefinition(Ty);
2386}
2387
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002388llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002389 const EnumDecl *ED = Ty->getDecl();
2390 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002391 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002392 if (!ED->getTypeForDecl()->isIncompleteType()) {
2393 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002394 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002395 }
2396
2397 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2398
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002399 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002400 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002401 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002402 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002403 Enumerators.push_back(DBuilder.createEnumerator(
2404 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002405 }
2406
2407 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002408 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002409
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002410 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002411 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002412 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002413 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002414 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2415 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2416 Line, Size, Align, EltArray, ClassTy,
2417 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002418}
2419
David Blaikie05491062013-01-21 04:37:12 +00002420static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2421 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002422 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002423 Qualifiers InnerQuals = T.getLocalQualifiers();
2424 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2425 // that is already there.
2426 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2427 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002428 QualType LastT = T;
2429 switch (T->getTypeClass()) {
2430 default:
David Blaikie05491062013-01-21 04:37:12 +00002431 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002432 case Type::TemplateSpecialization: {
2433 const auto *Spec = cast<TemplateSpecializationType>(T);
2434 if (Spec->isTypeAlias())
2435 return C.getQualifiedType(T.getTypePtr(), Quals);
2436 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002437 break;
2438 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002439 case Type::TypeOfExpr:
2440 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2441 break;
2442 case Type::TypeOf:
2443 T = cast<TypeOfType>(T)->getUnderlyingType();
2444 break;
2445 case Type::Decltype:
2446 T = cast<DecltypeType>(T)->getUnderlyingType();
2447 break;
2448 case Type::UnaryTransform:
2449 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2450 break;
2451 case Type::Attributed:
2452 T = cast<AttributedType>(T)->getEquivalentType();
2453 break;
2454 case Type::Elaborated:
2455 T = cast<ElaboratedType>(T)->getNamedType();
2456 break;
2457 case Type::Paren:
2458 T = cast<ParenType>(T)->getInnerType();
2459 break;
David Blaikie05491062013-01-21 04:37:12 +00002460 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002461 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002462 break;
Jordan Rose303e2f12016-11-10 23:28:17 +00002463 case Type::Auto: {
David Blaikie22c460a02013-05-24 21:24:35 +00002464 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002465 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002466 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002467 break;
2468 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002469 case Type::Adjusted:
2470 case Type::Decayed:
2471 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2472 T = cast<AdjustedType>(T)->getAdjustedType();
2473 break;
2474 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002475
Guy Benyei11169dd2012-12-18 14:30:41 +00002476 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002477 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002478 } while (true);
2479}
2480
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002481llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002482
2483 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002484 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002485
David Blaikief427b002014-05-06 03:42:01 +00002486 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002487 if (it != TypeCache.end()) {
2488 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002489 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002490 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002491 }
2492
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002493 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002494}
2495
David Blaikie0e716b42014-03-03 23:48:23 +00002496void CGDebugInfo::completeTemplateDefinition(
2497 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002498 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002499 return;
2500
David Blaikie0e716b42014-03-03 23:48:23 +00002501 completeClassData(&SD);
2502 // In case this type has no member function definitions being emitted, ensure
2503 // it is retained
2504 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2505}
2506
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002507llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002508 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002509 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002510
2511 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002512 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002513
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002514 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002515 return T;
2516
Adrian Prantlca844182015-09-11 17:23:03 +00002517 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002518 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002519
2520 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002521 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002522
Guy Benyei11169dd2012-12-18 14:30:41 +00002523 return Res;
2524}
2525
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002526llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002527 // A forward declaration inside a module header does not belong to the module.
2528 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2529 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002530 if (DebugTypeExtRefs && D->isFromASTFile()) {
2531 // Record a reference to an imported clang module or precompiled header.
2532 auto *Reader = CGM.getContext().getExternalSource();
2533 auto Idx = D->getOwningModuleID();
2534 auto Info = Reader->getSourceDescriptor(Idx);
2535 if (Info)
2536 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2537 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002538 // We are building a clang module or a precompiled header.
2539 //
2540 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2541 // and it wouldn't be necessary to specify the parent scope
2542 // because the type is already unique by definition (it would look
2543 // like the output of -fno-standalone-debug). On the other hand,
2544 // the parent scope helps a consumer to quickly locate the object
2545 // file where the type's definition is located, so it might be
2546 // best to make this behavior a command line or debugger tuning
2547 // option.
2548 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
2549 if (Module *M = ClangModuleMap->inferModuleFromLocation(Loc)) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002550 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002551 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2552 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002553 } else {
2554 // This the precompiled header being built.
2555 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002556 }
2557 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002558
Adrian Prantl9402cef2015-09-20 16:51:35 +00002559 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002560}
2561
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002562llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002563 // Handle qualifiers, which recursively handles what they refer to.
2564 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002565 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002566
Guy Benyei11169dd2012-12-18 14:30:41 +00002567 // Work out details of type.
2568 switch (Ty->getTypeClass()) {
2569#define TYPE(Class, Base)
2570#define ABSTRACT_TYPE(Class, Base)
2571#define NON_CANONICAL_TYPE(Class, Base)
2572#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2573#include "clang/AST/TypeNodes.def"
2574 llvm_unreachable("Dependent types cannot show up in debug information");
2575
2576 case Type::ExtVector:
2577 case Type::Vector:
2578 return CreateType(cast<VectorType>(Ty), Unit);
2579 case Type::ObjCObjectPointer:
2580 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2581 case Type::ObjCObject:
2582 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002583 case Type::ObjCTypeParam:
2584 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002585 case Type::ObjCInterface:
2586 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2587 case Type::Builtin:
2588 return CreateType(cast<BuiltinType>(Ty));
2589 case Type::Complex:
2590 return CreateType(cast<ComplexType>(Ty));
2591 case Type::Pointer:
2592 return CreateType(cast<PointerType>(Ty), Unit);
2593 case Type::BlockPointer:
2594 return CreateType(cast<BlockPointerType>(Ty), Unit);
2595 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002596 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002597 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002598 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002599 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002600 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002601 case Type::FunctionProto:
2602 case Type::FunctionNoProto:
2603 return CreateType(cast<FunctionType>(Ty), Unit);
2604 case Type::ConstantArray:
2605 case Type::VariableArray:
2606 case Type::IncompleteArray:
2607 return CreateType(cast<ArrayType>(Ty), Unit);
2608
2609 case Type::LValueReference:
2610 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2611 case Type::RValueReference:
2612 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2613
2614 case Type::MemberPointer:
2615 return CreateType(cast<MemberPointerType>(Ty), Unit);
2616
2617 case Type::Atomic:
2618 return CreateType(cast<AtomicType>(Ty), Unit);
2619
Xiuli Pan9c14e282016-01-09 12:53:17 +00002620 case Type::Pipe:
2621 return CreateType(cast<PipeType>(Ty), Unit);
2622
Guy Benyei11169dd2012-12-18 14:30:41 +00002623 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002624 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2625
David Blaikie42edade2014-11-11 20:44:45 +00002626 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002627 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00002628 case Type::Adjusted:
2629 case Type::Decayed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002630 case Type::Elaborated:
2631 case Type::Paren:
2632 case Type::SubstTemplateTypeParm:
2633 case Type::TypeOfExpr:
2634 case Type::TypeOf:
2635 case Type::Decltype:
2636 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002637 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002638 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002639 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002640
David Blaikie42edade2014-11-11 20:44:45 +00002641 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002642}
2643
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002644llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2645 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002646 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002647
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002648 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002649
2650 // We may have cached a forward decl when we could have created
2651 // a non-forward decl. Go ahead and create a non-forward decl
2652 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002653 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002654 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002655
2656 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002657 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002658
2659 // Propagate members from the declaration to the definition
2660 // CreateType(const RecordType*) will overwrite this with the members in the
2661 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002662 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002663
Guy Benyei11169dd2012-12-18 14:30:41 +00002664 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002665 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002666 return Res;
2667}
2668
2669// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002670llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002671 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002672
Guy Benyei11169dd2012-12-18 14:30:41 +00002673 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002674 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002675 unsigned Line = getLineNumber(RD->getLocation());
2676 StringRef RDName = getClassName(RD);
2677
Amjad Abouddc4531e2016-04-30 01:44:38 +00002678 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002679
David Blaikied2785892013-08-18 17:36:19 +00002680 // If we ended up creating the type during the context chain construction,
2681 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002682 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002683 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002684 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002685 return T;
David Blaikied2785892013-08-18 17:36:19 +00002686
Adrian Prantl381e7552014-02-04 21:29:50 +00002687 // If this is just a forward or incomplete declaration, construct an
2688 // appropriately marked node and just return it.
2689 const RecordDecl *D = RD->getDefinition();
2690 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002691 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002692
2693 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002694 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002695
Manman Rene0064d82013-08-29 23:19:58 +00002696 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2697
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002698 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00002699 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
2700 llvm::DINode::FlagZero, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002701
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002702 // Elements of composite types usually have back to the type, creating
2703 // uniquing cycles. Distinct nodes are more efficient.
2704 switch (RealDecl->getTag()) {
2705 default:
2706 llvm_unreachable("invalid composite type tag");
2707
2708 case llvm::dwarf::DW_TAG_array_type:
2709 case llvm::dwarf::DW_TAG_enumeration_type:
2710 // Array elements and most enumeration elements don't have back references,
2711 // so they don't tend to be involved in uniquing cycles and there is some
2712 // chance of merging them when linking together two modules. Only make
2713 // them distinct if they are ODR-uniqued.
2714 if (FullName.empty())
2715 break;
2716
2717 case llvm::dwarf::DW_TAG_structure_type:
2718 case llvm::dwarf::DW_TAG_union_type:
2719 case llvm::dwarf::DW_TAG_class_type:
2720 // Immediatley resolve to a distinct node.
2721 RealDecl =
2722 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2723 break;
2724 }
2725
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002726 RegionMap[Ty->getDecl()].reset(RealDecl);
2727 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002728
David Majnemer58ed0f32016-07-17 00:39:12 +00002729 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002730 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002731 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002732 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002733}
2734
David Blaikieadfbf992013-08-18 16:55:33 +00002735void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002736 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002737 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002738 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002739 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2740 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002741 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002742 while (1) {
2743 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2744 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2745 if (PBT && !BRL.isPrimaryBaseVirtual())
2746 PBase = PBT;
2747 else
2748 break;
2749 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002750 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002751 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2752 getOrCreateFile(RD->getLocation())));
2753 } else if (RD->isDynamicClass())
2754 ContainingType = RealDecl;
2755
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002756 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002757}
2758
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002759llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002760 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002761 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002762 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002763 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002764 llvm::DIType *Ty =
2765 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
2766 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002767 *Offset += FieldSize;
2768 return Ty;
2769}
2770
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002771void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002772 StringRef &Name,
2773 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002774 llvm::DIScope *&FDContext,
2775 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00002776 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002777 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00002778 Name = getFunctionName(FD);
2779 // Use mangled name as linkage name for C/C++ functions.
2780 if (FD->hasPrototype()) {
2781 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002782 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002783 }
2784 // No need to replicate the linkage name if it isn't different from the
2785 // subprogram name, no need to have it at all unless coverage is enabled or
Dehao Chenb3a70de2017-01-19 00:44:21 +00002786 // debug is set to more than just line tables or extra debug info is needed.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002787 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2788 !CGM.getCodeGenOpts().EmitGcovNotes &&
Dehao Chenb3a70de2017-01-19 00:44:21 +00002789 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
Benjamin Kramer8c305922016-02-02 11:06:51 +00002790 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00002791 LinkageName = StringRef();
2792
Benjamin Kramer8c305922016-02-02 11:06:51 +00002793 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002794 if (const NamespaceDecl *NSDecl =
2795 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2796 FDContext = getOrCreateNameSpace(NSDecl);
2797 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002798 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2799 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2800 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2801 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00002802 // Check if it is a noreturn-marked function
2803 if (FD->isNoReturn())
2804 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00002805 // Collect template parameters.
2806 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2807 }
2808}
2809
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002810void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002811 unsigned &LineNo, QualType &T,
2812 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002813 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002814 Unit = getOrCreateFile(VD->getLocation());
2815 LineNo = getLineNumber(VD->getLocation());
2816
2817 setLocation(VD->getLocation());
2818
2819 T = VD->getType();
2820 if (T->isIncompleteArrayType()) {
2821 // CodeGen turns int[] into int[1] so we'll do the same here.
2822 llvm::APInt ConstVal(32, 1);
2823 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2824
2825 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2826 ArrayType::Normal, 0);
2827 }
2828
2829 Name = VD->getName();
2830 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2831 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2832 LinkageName = CGM.getMangledName(VD);
2833 if (LinkageName == Name)
2834 LinkageName = StringRef();
2835
2836 // Since we emit declarations (DW_AT_members) for static members, place the
2837 // definition of those static members in the namespace they were declared in
2838 // in the source code (the lexical decl context).
2839 // FIXME: Generalize this for even non-member global variables where the
2840 // declaration and definition may have different lexical decl contexts, once
2841 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002842 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2843 : VD->getDeclContext();
2844 // When a record type contains an in-line initialization of a static data
2845 // member, and the record type is marked as __declspec(dllexport), an implicit
2846 // definition of the member will be created in the record context. DWARF
2847 // doesn't seem to have a nice way to describe this in a form that consumers
2848 // are likely to understand, so fake the "normal" situation of a definition
2849 // outside the class by putting it in the global scope.
2850 if (DC->isRecord())
2851 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002852
Amjad Abouddc4531e2016-04-30 01:44:38 +00002853 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2854 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002855}
2856
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002857llvm::DISubprogram *
Frederic Rissd253ed62014-11-18 03:40:51 +00002858CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002859 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002860 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00002861 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Frederic Rissd253ed62014-11-18 03:40:51 +00002862 SourceLocation Loc = FD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002863 llvm::DIFile *Unit = getOrCreateFile(Loc);
2864 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002865 unsigned Line = getLineNumber(Loc);
2866
2867 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2868 TParamsArray, Flags);
2869 // Build function type.
2870 SmallVector<QualType, 16> ArgTypes;
2871 for (const ParmVarDecl *Parm: FD->parameters())
2872 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00002873 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2874 QualType FnType = CGM.getContext().getFunctionType(
2875 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002876 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002877 DContext, Name, LinkageName, Unit, Line,
2878 getOrCreateFunctionType(FD, FnType, Unit), !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002879 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002880 TParamsArray.get(), getFunctionDeclaration(FD));
David Majnemer58ed0f32016-07-17 00:39:12 +00002881 const auto *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002882 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2883 std::make_tuple(CanonDecl),
2884 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002885 return SP;
2886}
2887
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002888llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002889CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2890 QualType T;
2891 StringRef Name, LinkageName;
2892 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002893 llvm::DIFile *Unit = getOrCreateFile(Loc);
2894 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002895 unsigned Line = getLineNumber(Loc);
2896
2897 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00002898 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002899 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
2900 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Adrian Prantl5f4740d2016-12-20 02:10:02 +00002901 !VD->isExternallyVisible(), nullptr, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002902 FwdDeclReplaceMap.emplace_back(
2903 std::piecewise_construct,
2904 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2905 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002906 return GV;
2907}
2908
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002909llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002910 // We only need a declaration (not a definition) of the type - so use whatever
2911 // we would otherwise do to get a type for a pointee. (forward declarations in
2912 // limited debug info, full definitions (if the type definition is available)
2913 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00002914 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00002915 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002916 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002917 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002918
Adrian Prantl5f4740d2016-12-20 02:10:02 +00002919 if (I != DeclCache.end()) {
2920 auto N = I->second;
2921 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
2922 return GVE->getVariable();
2923 return dyn_cast_or_null<llvm::DINode>(N);
2924 }
Frederic Rissd253ed62014-11-18 03:40:51 +00002925
2926 // No definition for now. Emit a forward definition that might be
2927 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00002928 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00002929 return getFunctionForwardDeclaration(FD);
2930 else if (const auto *VD = dyn_cast<VarDecl>(D))
2931 return getGlobalVariableForwardDeclaration(VD);
2932
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002933 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00002934}
2935
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002936llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002937 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002938 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00002939
David Majnemer58ed0f32016-07-17 00:39:12 +00002940 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002941 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002942 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002943
2944 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002945 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00002946
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002947 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002948 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002949 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00002950 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002951 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00002952 }
2953 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002954 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002955 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002956 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002957 return SP;
2958 }
2959
Aaron Ballman86c93902014-03-06 23:45:36 +00002960 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002961 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002962 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002963 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002964 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002965 return SP;
2966 }
2967 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002968 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002969}
2970
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002971// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00002972// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002973llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002974 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002975 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002976 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002977 // Create fake but valid subroutine type. Otherwise -verify would fail, and
2978 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00002979 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002980
David Majnemer58ed0f32016-07-17 00:39:12 +00002981 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00002982 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002983
2984 const auto *FTy = FnType->getAs<FunctionType>();
2985 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
2986
David Majnemer58ed0f32016-07-17 00:39:12 +00002987 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002988 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002989 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002990
2991 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002992 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002993
2994 // Replace the instancetype keyword with the actual type.
2995 if (ResultTy == CGM.getContext().getObjCInstanceType())
2996 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002997 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002998
Adrian Prantl7bec9032013-05-10 21:08:31 +00002999 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003000 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003001 QualType SelfDeclTy;
3002 if (auto *SelfDecl = OMethod->getSelfDecl())
3003 SelfDeclTy = SelfDecl->getType();
3004 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3005 if (FPT->getNumParams() > 1)
3006 SelfDeclTy = FPT->getParamType(0);
3007 if (!SelfDeclTy.isNull())
3008 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003009 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003010 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003011 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003012 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003013 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003014 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003015 // Variadic methods need a special marker at the end of the type list.
3016 if (OMethod->isVariadic())
3017 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003018
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003019 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003020 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3021 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003022 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003023
Adrian Prantl800faef2014-02-25 23:42:18 +00003024 // Handle variadic function types; they need an additional
3025 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003026 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003027 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003028 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003029 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003030 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3031 for (QualType ParamType : FPT->param_types())
3032 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003033 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003034 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003035 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3036 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003037 }
3038
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003039 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003040}
3041
Eric Christophere7b87e52014-10-26 23:40:33 +00003042void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3043 SourceLocation ScopeLoc, QualType FnType,
3044 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003045
3046 StringRef Name;
3047 StringRef LinkageName;
3048
3049 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3050
3051 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003052 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003053
Leny Kholodov80c047d2016-09-06 10:48:04 +00003054 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003055 llvm::DIFile *Unit = getOrCreateFile(Loc);
3056 llvm::DIScope *FDContext = Unit;
3057 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003058 if (!HasDecl) {
3059 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003060 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003061 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003062 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003063 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003064 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003065 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003066 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003067 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003068 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003069 return;
3070 }
3071 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003072 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3073 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003074 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003075 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003076 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003077 } else {
3078 // Use llvm function name.
3079 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003080 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003081 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003082 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003083 Name = Name.substr(1);
3084
Adrian Prantl42d71b92014-04-10 23:21:53 +00003085 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003086 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003087 // Artificial functions should not silently reuse CurLoc.
3088 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003089 }
3090 unsigned LineNo = getLineNumber(Loc);
3091 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003092
Eric Christopher8018e412014-03-27 18:50:35 +00003093 // FIXME: The function declaration we're constructing here is mostly reusing
3094 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3095 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3096 // all subprograms instead of the actual context since subprogram definitions
3097 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003098 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003099 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00003100 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003101 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003102 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003103 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003104 // We might get here with a VarDecl in the case we're generating
3105 // code for the initialization of globals. Do not record these decls
3106 // as they will overwrite the actual VarDecl Decl in the cache.
3107 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003108 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003109
Adrian Prantlbebb8932014-03-21 21:01:58 +00003110 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003111 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003112
Guy Benyei11169dd2012-12-18 14:30:41 +00003113 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003114 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003115}
3116
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003117void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3118 QualType FnType) {
3119 StringRef Name;
3120 StringRef LinkageName;
3121
3122 const Decl *D = GD.getDecl();
3123 if (!D)
3124 return;
3125
Leny Kholodov80c047d2016-09-06 10:48:04 +00003126 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003127 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003128 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003129 llvm::DINodeArray TParamsArray;
3130 if (isa<FunctionDecl>(D)) {
3131 // If there is a DISubprogram for this function available then use it.
3132 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3133 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003134 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003135 Name = getObjCMethodName(OMD);
3136 Flags |= llvm::DINode::FlagPrototyped;
3137 } else {
3138 llvm_unreachable("not a function or ObjC method");
3139 }
3140 if (!Name.empty() && Name[0] == '\01')
3141 Name = Name.substr(1);
3142
3143 if (D->isImplicit()) {
3144 Flags |= llvm::DINode::FlagArtificial;
3145 // Artificial functions without a location should not silently reuse CurLoc.
3146 if (Loc.isInvalid())
3147 CurLoc = SourceLocation();
3148 }
3149 unsigned LineNo = getLineNumber(Loc);
3150 unsigned ScopeLine = 0;
3151
Adrian Prantle76bda52016-04-15 15:55:45 +00003152 DBuilder.retainType(DBuilder.createFunction(
3153 FDContext, Name, LinkageName, Unit, LineNo,
3154 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3155 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3156 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003157}
3158
David Blaikie835afb22015-01-21 23:08:17 +00003159void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003160 // Update our current location
3161 setLocation(Loc);
3162
Eric Christophere7b87e52014-10-26 23:40:33 +00003163 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3164 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003165
Adrian Prantle83b1302014-01-07 22:05:52 +00003166 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00003167 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00003168 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003169}
3170
Guy Benyei11169dd2012-12-18 14:30:41 +00003171void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003172 llvm::MDNode *Back = nullptr;
3173 if (!LexicalBlockStack.empty())
3174 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003175 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003176 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003177 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003178}
3179
Eric Christopher0fdcb312013-05-16 00:52:20 +00003180void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3181 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003182 // Set our current location.
3183 setLocation(Loc);
3184
Guy Benyei11169dd2012-12-18 14:30:41 +00003185 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00003186 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3187 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00003188
Benjamin Kramer8c305922016-02-02 11:06:51 +00003189 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003190 return;
3191
3192 // Create a new lexical block and push it on the stack.
3193 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003194}
3195
Eric Christopher0fdcb312013-05-16 00:52:20 +00003196void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3197 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003198 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3199
3200 // Provide an entry in the line table for the end of the block.
3201 EmitLocation(Builder, Loc);
3202
Benjamin Kramer8c305922016-02-02 11:06:51 +00003203 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003204 return;
3205
Guy Benyei11169dd2012-12-18 14:30:41 +00003206 LexicalBlockStack.pop_back();
3207}
3208
Guy Benyei11169dd2012-12-18 14:30:41 +00003209void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
3210 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3211 unsigned RCount = FnBeginRegionCount.back();
3212 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3213
3214 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003215 while (LexicalBlockStack.size() != RCount) {
3216 // Provide an entry in the line table for the end of the block.
3217 EmitLocation(Builder, CurLoc);
3218 LexicalBlockStack.pop_back();
3219 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003220 FnBeginRegionCount.pop_back();
3221}
3222
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003223llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003224 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003225
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003226 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003227 QualType FType;
3228 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003229 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003230
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003231 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003232 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003233
3234 FieldOffset = 0;
3235 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3236 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3237 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3238 FType = CGM.getContext().IntTy;
3239 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3240 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3241
3242 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3243 if (HasCopyAndDispose) {
3244 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003245 EltTys.push_back(
3246 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3247 EltTys.push_back(
3248 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003249 }
3250 bool HasByrefExtendedLayout;
3251 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003252 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3253 HasByrefExtendedLayout) &&
3254 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003255 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003256 EltTys.push_back(
3257 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003258 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003259
Guy Benyei11169dd2012-12-18 14:30:41 +00003260 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3261 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003262 CGM.getTarget().getPointerAlign(0))) {
3263 CharUnits FieldOffsetInBytes =
3264 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003265 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003266 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003267
Guy Benyei11169dd2012-12-18 14:30:41 +00003268 if (NumPaddingBytes.isPositive()) {
3269 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3270 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3271 pad, ArrayType::Normal, 0);
3272 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3273 }
3274 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003275
Guy Benyei11169dd2012-12-18 14:30:41 +00003276 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003277 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003278 FieldSize = CGM.getContext().getTypeSize(FType);
3279 FieldAlign = CGM.getContext().toBits(Align);
3280
Eric Christopherb2a008c2013-05-16 00:45:12 +00003281 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003282 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003283 FieldAlign, FieldOffset,
3284 llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003285 EltTys.push_back(FieldTy);
3286 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003287
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003288 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003289
Leny Kholodov80c047d2016-09-06 10:48:04 +00003290 llvm::DINode::DIFlags Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003291
Guy Benyei11169dd2012-12-18 14:30:41 +00003292 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003293 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003294}
3295
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003296void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3297 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00003298 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003299 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003300 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003301 if (VD->hasAttr<NoDebugAttr>())
3302 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003303
David Blaikie7fceebf2013-08-19 03:37:48 +00003304 bool Unwritten =
3305 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3306 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003307 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003308 if (!Unwritten)
3309 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003310 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003311 uint64_t XOffset = 0;
3312 if (VD->hasAttr<BlocksAttr>())
3313 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003314 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003315 Ty = getOrCreateType(VD->getType(), Unit);
3316
3317 // If there is no debug info for this type then do not emit debug info
3318 // for this variable.
3319 if (!Ty)
3320 return;
3321
Guy Benyei11169dd2012-12-18 14:30:41 +00003322 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003323 unsigned Line = 0;
3324 unsigned Column = 0;
3325 if (!Unwritten) {
3326 Line = getLineNumber(VD->getLocation());
3327 Column = getColumnNumber(VD->getLocation());
3328 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003329 SmallVector<int64_t, 9> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003330 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003331 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003332 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003333
3334 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3335
Guy Benyei11169dd2012-12-18 14:30:41 +00003336 // If this is the first argument and it is implicit then
3337 // give it an object pointer flag.
3338 // FIXME: There has to be a better way to do this, but for static
3339 // functions there won't be an implicit param at arg1 and
3340 // otherwise it is 'self' or 'this'.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003341 if (isa<ImplicitParamDecl>(VD) && ArgNo && *ArgNo == 1)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003342 Flags |= llvm::DINode::FlagObjectPointer;
David Majnemer58ed0f32016-07-17 00:39:12 +00003343 if (auto *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00003344 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
3345 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003346 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00003347
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003348 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003349
3350 StringRef Name = VD->getName();
3351 if (!Name.empty()) {
3352 if (VD->hasAttr<BlocksAttr>()) {
3353 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003354 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003355 // offset of __forwarding field
3356 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003357 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003358 Expr.push_back(offset.getQuantity());
3359 Expr.push_back(llvm::dwarf::DW_OP_deref);
3360 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003361 // offset of x field
3362 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003363 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003364
3365 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003366 auto *D = ArgNo
3367 ? DBuilder.createParameterVariable(Scope, VD->getName(),
3368 *ArgNo, Unit, Line, Ty)
3369 : DBuilder.createAutoVariable(Scope, VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003370 Line, Ty, Align);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003371
Guy Benyei11169dd2012-12-18 14:30:41 +00003372 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003373 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3374 llvm::DebugLoc::get(Line, Column, Scope),
3375 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003376 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00003377 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003378 Expr.push_back(llvm::dwarf::DW_OP_deref);
David Majnemer58ed0f32016-07-17 00:39:12 +00003379 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003380 // If VD is an anonymous union then Storage represents value for
3381 // all union fields.
David Majnemer58ed0f32016-07-17 00:39:12 +00003382 const auto *RD = cast<RecordDecl>(RT->getDecl());
Adrian Prantl0d820892015-04-29 15:05:50 +00003383 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003384 // GDB has trouble finding local variables in anonymous unions, so we emit
3385 // artifical local variables for each of the members.
3386 //
3387 // FIXME: Remove this code as soon as GDB supports this.
3388 // The debug info verifier in LLVM operates based on the assumption that a
3389 // variable has the same size as its storage and we had to disable the check
3390 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003391 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003392 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003393 StringRef FieldName = Field->getName();
3394
3395 // Ignore unnamed fields. Do not ignore unnamed records.
3396 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3397 continue;
3398
3399 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003400 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003401 auto *D = DBuilder.createAutoVariable(
3402 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003403 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003404
3405 // Insert an llvm.dbg.declare into the current block.
3406 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3407 llvm::DebugLoc::get(Line, Column, Scope),
3408 Builder.GetInsertBlock());
3409 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003410 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003411 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003412
3413 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003414 auto *D = ArgNo
3415 ? DBuilder.createParameterVariable(
3416 Scope, Name, *ArgNo, Unit, Line, Ty,
3417 CGM.getLangOpts().Optimize, Flags)
3418 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3419 CGM.getLangOpts().Optimize, Flags,
3420 Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003421
3422 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003423 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3424 llvm::DebugLoc::get(Line, Column, Scope),
3425 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003426}
3427
3428void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3429 llvm::Value *Storage,
3430 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003431 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003432 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003433}
3434
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003435llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3436 llvm::DIType *Ty) {
3437 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003438 if (CachedTy)
3439 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003440 return DBuilder.createObjectPointerType(Ty);
3441}
3442
Eric Christophere7b87e52014-10-26 23:40:33 +00003443void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3444 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003445 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003446 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003447 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003448
Craig Topper8a13c412014-05-21 05:09:00 +00003449 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003450 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003451 if (VD->hasAttr<NoDebugAttr>())
3452 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003453
Guy Benyei11169dd2012-12-18 14:30:41 +00003454 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003455
Guy Benyei11169dd2012-12-18 14:30:41 +00003456 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003457 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3458 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003459 if (isByRef)
3460 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003461 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003462 Ty = getOrCreateType(VD->getType(), Unit);
3463
3464 // Self is passed along as an implicit non-arg variable in a
3465 // block. Mark it as the object pointer.
3466 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00003467 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003468
3469 // Get location information.
3470 unsigned Line = getLineNumber(VD->getLocation());
3471 unsigned Column = getColumnNumber(VD->getLocation());
3472
3473 const llvm::DataLayout &target = CGM.getDataLayout();
3474
3475 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003476 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003477 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3478
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003479 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00003480 if (isa<llvm::AllocaInst>(Storage))
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);
3483 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003484 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003485 addr.push_back(llvm::dwarf::DW_OP_deref);
3486 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003487 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003488 offset =
3489 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003490 addr.push_back(offset.getQuantity());
3491 addr.push_back(llvm::dwarf::DW_OP_deref);
3492 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003493 // offset of x field
3494 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003495 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003496 }
3497
3498 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003499 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003500 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003501 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003502 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003503
Guy Benyei11169dd2012-12-18 14:30:41 +00003504 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003505 auto DL = llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back());
3506 if (InsertPoint)
3507 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3508 InsertPoint);
3509 else
3510 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3511 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003512}
3513
Guy Benyei11169dd2012-12-18 14:30:41 +00003514void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3515 unsigned ArgNo,
3516 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003517 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003518 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003519}
3520
3521namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003522struct BlockLayoutChunk {
3523 uint64_t OffsetInBits;
3524 const BlockDecl::Capture *Capture;
3525};
3526bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3527 return l.OffsetInBits < r.OffsetInBits;
3528}
Guy Benyei11169dd2012-12-18 14:30:41 +00003529}
3530
3531void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003532 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003533 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003534 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003535 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003536 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003537 ASTContext &C = CGM.getContext();
3538 const BlockDecl *blockDecl = block.getBlockDecl();
3539
3540 // Collect some general information about the block's location.
3541 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003542 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003543 unsigned line = getLineNumber(loc);
3544 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003545
Guy Benyei11169dd2012-12-18 14:30:41 +00003546 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003547 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003548
3549 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003550 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003551
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003552 SmallVector<llvm::Metadata *, 16> fields;
David Majnemerb4b671e2016-06-30 03:01:59 +00003553 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003554 blockLayout->getElementOffsetInBits(0),
3555 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003556 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003557 blockLayout->getElementOffsetInBits(1),
3558 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003559 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003560 blockLayout->getElementOffsetInBits(2),
3561 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003562 auto *FnTy = block.getBlockExpr()->getFunctionType();
3563 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
David Majnemerb4b671e2016-06-30 03:01:59 +00003564 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003565 blockLayout->getElementOffsetInBits(3),
3566 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003567 fields.push_back(createFieldType(
3568 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3569 ? C.getBlockDescriptorExtendedType()
3570 : C.getBlockDescriptorType()),
David Majnemerb4b671e2016-06-30 03:01:59 +00003571 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003572
3573 // We want to sort the captures by offset, not because DWARF
3574 // requires this, but because we're paranoid about debuggers.
3575 SmallVector<BlockLayoutChunk, 8> chunks;
3576
3577 // 'this' capture.
3578 if (blockDecl->capturesCXXThis()) {
3579 BlockLayoutChunk chunk;
3580 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003581 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003582 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003583 chunks.push_back(chunk);
3584 }
3585
3586 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003587 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003588 const VarDecl *variable = capture.getVariable();
3589 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3590
3591 // Ignore constant captures.
3592 if (captureInfo.isConstant())
3593 continue;
3594
3595 BlockLayoutChunk chunk;
3596 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003597 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003598 chunk.Capture = &capture;
3599 chunks.push_back(chunk);
3600 }
3601
3602 // Sort by offset.
3603 llvm::array_pod_sort(chunks.begin(), chunks.end());
3604
David Majnemer58ed0f32016-07-17 00:39:12 +00003605 for (const BlockLayoutChunk &Chunk : chunks) {
3606 uint64_t offsetInBits = Chunk.OffsetInBits;
3607 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00003608
3609 // If we have a null capture, this must be the C++ 'this' capture.
3610 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003611 QualType type;
3612 if (auto *Method =
3613 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3614 type = Method->getThisType(C);
3615 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3616 type = QualType(RDecl->getTypeForDecl(), 0);
3617 else
3618 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003619
David Majnemerb4b671e2016-06-30 03:01:59 +00003620 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003621 offsetInBits, tunit, tunit));
3622 continue;
3623 }
3624
3625 const VarDecl *variable = capture->getVariable();
3626 StringRef name = variable->getName();
3627
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003628 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003629 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003630 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00003631 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00003632
3633 // FIXME: this creates a second copy of this type!
3634 uint64_t xoffset;
3635 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003636 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00003637 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3638 PtrInfo.Width, Align, offsetInBits,
3639 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003640 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003641 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00003642 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00003643 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003644 }
3645 fields.push_back(fieldType);
3646 }
3647
3648 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003649 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3650 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003651
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003652 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003653
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003654 llvm::DIType *type =
3655 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00003656 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003657 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003658 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3659
3660 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00003661 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003662 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003663
3664 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003665 auto *debugVar = DBuilder.createParameterVariable(
3666 scope, Arg->getName(), ArgNo, tunit, line, type,
3667 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003668
Adrian Prantl616bef42013-03-14 21:52:59 +00003669 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003670 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003671 DBuilder.insertDbgValueIntrinsic(
Eric Christophere7b87e52014-10-26 23:40:33 +00003672 LocalAddr, 0, debugVar, DBuilder.createExpression(),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003673 llvm::DebugLoc::get(line, column, scope), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003674 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003675
Adrian Prantl616bef42013-03-14 21:52:59 +00003676 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003677 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
3678 llvm::DebugLoc::get(line, column, scope),
3679 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003680}
3681
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003682llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003683CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3684 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003685 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003686
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003687 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003688 if (MI != StaticDataMemberCache.end()) {
3689 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003690 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003691 }
David Blaikiece763042013-08-20 21:49:21 +00003692
3693 // If the member wasn't found in the cache, lazily construct and add it to the
3694 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003695 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003696 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003697 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003698}
3699
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003700llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003701 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3702 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003703 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003704
3705 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003706 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003707 StringRef FieldName = Field->getName();
3708
3709 // Ignore unnamed fields, but recurse into anonymous records.
3710 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003711 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003712 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Eric Christophercab9fae2014-04-10 05:20:00 +00003713 Var, DContext);
3714 continue;
3715 }
3716 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003717 GVE = DBuilder.createGlobalVariableExpression(
3718 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
3719 Var->hasLocalLinkage());
3720 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00003721 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003722 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00003723}
3724
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003725void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003726 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003727 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003728 if (D->hasAttr<NoDebugAttr>())
3729 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00003730
3731 // If we already created a DIGlobalVariable for this declaration, just attach
3732 // it to the llvm::GlobalVariable.
3733 auto Cached = DeclCache.find(D->getCanonicalDecl());
3734 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003735 return Var->addDebugInfo(
3736 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00003737
Guy Benyei11169dd2012-12-18 14:30:41 +00003738 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003739 llvm::DIFile *Unit = nullptr;
3740 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003741 unsigned LineNo;
3742 StringRef DeclName, LinkageName;
3743 QualType T;
3744 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003745
3746 // Attempt to store one global variable for the declaration - even if we
3747 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003748 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003749
3750 // If this is an anonymous union then we'll want to emit a global
3751 // variable for each member of the anonymous union so that it's possible
3752 // to find the name of any field in the union.
3753 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003754 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003755 assert(RD->isAnonymousStructOrUnion() &&
3756 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003757 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003758 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003759 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003760 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00003761 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003762 Var->hasLocalLinkage(), /*Expr=*/nullptr,
Victor Leschuka7ece032016-10-20 00:13:19 +00003763 getOrCreateStaticDataMemberDeclarationOrNull(D), Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003764 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00003765 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003766 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00003767}
3768
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003769void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003770 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003771 if (VD->hasAttr<NoDebugAttr>())
3772 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00003773 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003774 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003775 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003776 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003777 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00003778 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3779 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003780 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3781 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3782 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003783 // Do not use global variables for enums.
3784 //
3785 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003786 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003787 return;
David Blaikiea15565562014-04-04 20:56:17 +00003788 // Do not emit separate definitions for function local const/statics.
3789 if (isa<FunctionDecl>(VD->getDeclContext()))
3790 return;
David Blaikiebb113912014-04-05 07:23:17 +00003791 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003792 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003793 if (VarD->isStaticDataMember()) {
3794 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003795 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003796 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00003797 //
3798 // FIXME: This is probably unnecessary, since Ty should reference RD
3799 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00003800 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003801 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003802 return;
3803 }
3804
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003805 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003806
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003807 auto &GV = DeclCache[VD];
3808 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003809 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00003810 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00003811 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
3812 // FIXME: Add a representation for integer constants wider than 64 bits.
3813 if (Init.isInt())
3814 InitExpr =
3815 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
3816 else if (Init.isFloat())
3817 InitExpr = DBuilder.createConstantValueExpression(
3818 Init.getFloat().bitcastToAPInt().getZExtValue());
3819 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003820 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00003821 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00003822 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
3823 Align));
David Blaikiebd483762013-05-20 04:58:53 +00003824}
3825
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003826llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003827 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003828 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003829 llvm::DIScope *Mod = getParentModuleOrNull(D);
3830 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003831}
3832
David Blaikie9f88fe82013-04-22 06:13:21 +00003833void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003834 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003835 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003836 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00003837 if (!NSDecl->isAnonymousNamespace() ||
3838 CGM.getCodeGenOpts().DebugExplicitImport) {
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003839 DBuilder.createImportedModule(
3840 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3841 getOrCreateNameSpace(NSDecl),
3842 getLineNumber(UD.getLocation()));
3843 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003844}
3845
David Blaikiebd483762013-05-20 04:58:53 +00003846void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003847 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003848 return;
3849 assert(UD.shadow_size() &&
3850 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3851 // Emitting one decl is sufficient - debuggers can detect that this is an
3852 // overloaded name & provide lookup for all the overloads.
3853 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00003854
3855 // FIXME: Skip functions with undeduced auto return type for now since we
3856 // don't currently have the plumbing for separate declarations & definitions
3857 // of free functions and mismatched types (auto in the declaration, concrete
3858 // return type in the definition)
3859 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
3860 if (const auto *AT =
3861 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
3862 if (AT->getDeducedType().isNull())
3863 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003864 if (llvm::DINode *Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003865 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003866 DBuilder.createImportedDeclaration(
3867 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3868 getLineNumber(USD.getLocation()));
3869}
3870
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003871void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00003872 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
3873 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00003874 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00003875 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl8a634c12015-12-18 19:44:31 +00003876 DBuilder.createImportedDeclaration(
3877 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
3878 getOrCreateModuleRef(Info, DebugTypeExtRefs),
3879 getLineNumber(ID.getLocation()));
3880 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003881}
3882
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003883llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00003884CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003885 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003886 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003887 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003888 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003889 return cast<llvm::DIImportedEntity>(VH);
3890 llvm::DIImportedEntity *R;
David Majnemer58ed0f32016-07-17 00:39:12 +00003891 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00003892 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3893 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003894 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003895 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3896 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3897 NA.getName());
3898 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003899 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003900 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3901 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3902 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003903 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003904 return R;
3905}
3906
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003907llvm::DINamespace *
Guy Benyei11169dd2012-12-18 14:30:41 +00003908CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003909 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003910 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003911 if (I != NameSpaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003912 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003913
Guy Benyei11169dd2012-12-18 14:30:41 +00003914 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003915 llvm::DIFile *FileD = getOrCreateFile(NSDecl->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003916 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantlbd87eb42016-11-03 19:42:14 +00003917 llvm::DINamespace *NS = DBuilder.createNameSpace(
3918 Context, NSDecl->getName(), FileD, LineNo, NSDecl->isInline());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003919 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003920 return NS;
3921}
3922
Adrian Prantla5206ce2015-09-22 23:26:43 +00003923void CGDebugInfo::setDwoId(uint64_t Signature) {
3924 assert(TheCU && "no main compile unit");
3925 TheCU->setDWOId(Signature);
3926}
3927
3928
Guy Benyei11169dd2012-12-18 14:30:41 +00003929void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003930 // Creating types might create further types - invalidating the current
3931 // element and the size(), so don't cache/reference them.
3932 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3933 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003934 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00003935 ? CreateTypeDefinition(E.Type, E.Unit)
3936 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003937 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00003938 }
3939
David Blaikief427b002014-05-06 03:42:01 +00003940 for (auto p : ReplaceMap) {
3941 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003942 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003943 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003944
David Blaikief427b002014-05-06 03:42:01 +00003945 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003946 assert(it != TypeCache.end());
3947 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003948
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003949 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
3950 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00003951 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003952
Frederic Rissd253ed62014-11-18 03:40:51 +00003953 for (const auto &p : FwdDeclReplaceMap) {
3954 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003955 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003956 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003957
3958 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003959 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003960 // with ourselves, that will destroy the temporary MDNode and
3961 // replace it with a standard one, avoiding leaking memory.
3962 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003963 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003964 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003965 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003966
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003967 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
3968 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003969 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00003970 }
3971
Adrian Prantl73409ce2013-03-11 18:33:46 +00003972 // We keep our own list of retained types, because we need to look
3973 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00003974 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00003975 if (auto MD = TypeCache[RT])
3976 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003977
Guy Benyei11169dd2012-12-18 14:30:41 +00003978 DBuilder.finalize();
3979}
David Blaikie66088d52014-09-24 17:01:27 +00003980
3981void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003982 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00003983 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003984
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003985 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003986 // Don't ignore in case of explicit cast where it is referenced indirectly.
3987 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003988}
Amara Emerson652795d2016-11-10 14:44:30 +00003989
3990llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
3991 if (LexicalBlockStack.empty())
3992 return llvm::DebugLoc();
3993
3994 llvm::MDNode *Scope = LexicalBlockStack.back();
3995 return llvm::DebugLoc::get(
3996 getLineNumber(Loc), getColumnNumber(Loc), Scope);
3997}