blob: dbceaa7aa86b391849fd3d65d89436712f4d932c [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"
John McCallde0fe072017-08-15 21:42:52 +000021#include "ConstantEmitter.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000022#include "clang/AST/ASTContext.h"
23#include "clang/AST/DeclFriend.h"
24#include "clang/AST/DeclObjC.h"
25#include "clang/AST/DeclTemplate.h"
26#include "clang/AST/Expr.h"
27#include "clang/AST/RecordLayout.h"
28#include "clang/Basic/FileManager.h"
29#include "clang/Basic/SourceManager.h"
30#include "clang/Basic/Version.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000031#include "clang/Frontend/CodeGenOptions.h"
Taewook Oh0fb5b782017-08-16 19:36:24 +000032#include "clang/Frontend/FrontendOptions.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000033#include "clang/Lex/HeaderSearchOptions.h"
Adrian Prantl9402cef2015-09-20 16:51:35 +000034#include "clang/Lex/ModuleMap.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000035#include "clang/Lex/PreprocessorOptions.h"
Bob Haarmandff36732016-10-25 22:19:32 +000036#include "llvm/ADT/DenseSet.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000037#include "llvm/ADT/SmallVector.h"
38#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000039#include "llvm/IR/Constants.h"
40#include "llvm/IR/DataLayout.h"
41#include "llvm/IR/DerivedTypes.h"
42#include "llvm/IR/Instructions.h"
43#include "llvm/IR/Intrinsics.h"
Matthew Voss20165362018-10-03 18:45:04 +000044#include "llvm/IR/Metadata.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000045#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000046#include "llvm/Support/FileSystem.h"
Amjad Aboude2aab8c2016-12-25 10:12:27 +000047#include "llvm/Support/MD5.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000048#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000049using namespace clang;
50using namespace clang::CodeGen;
51
Victor Leschuka7ece032016-10-20 00:13:19 +000052static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
53 auto TI = Ctx.getTypeInfo(Ty);
54 return TI.AlignIsRequired ? TI.Align : 0;
55}
56
57static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
58 return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
59}
60
61static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
62 return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
63}
64
Guy Benyei11169dd2012-12-18 14:30:41 +000065CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000066 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
Adrian Prantl6b21ab22015-08-27 19:46:20 +000067 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
Eric Christopher324bbbd2013-07-14 21:12:44 +000068 DBuilder(CGM.getModule()) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000069 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
70 DebugPrefixMap[KV.first] = KV.second;
Guy Benyei11169dd2012-12-18 14:30:41 +000071 CreateCompileUnit();
72}
73
74CGDebugInfo::~CGDebugInfo() {
75 assert(LexicalBlockStack.empty() &&
76 "Region stack mismatch, stack not empty!");
77}
78
David Blaikie66e41972015-01-14 07:38:27 +000079ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Calixte Denizetfcd661d2018-09-24 18:24:18 +000080 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000081 : CGF(&CGF) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +000082 init(TemporaryLocation);
David Blaikie9b479662015-01-25 01:19:10 +000083}
84
Adrian Prantl39428e72015-02-03 18:40:42 +000085ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000086 bool DefaultToEmpty,
Calixte Denizetfcd661d2018-09-24 18:24:18 +000087 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000088 : CGF(&CGF) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +000089 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000090}
91
92void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Calixte Denizetfcd661d2018-09-24 18:24:18 +000093 bool DefaultToEmpty) {
David Blaikied7057d92015-08-12 23:49:57 +000094 auto *DI = CGF->getDebugInfo();
95 if (!DI) {
96 CGF = nullptr;
97 return;
David Blaikie66e41972015-01-14 07:38:27 +000098 }
David Blaikied7057d92015-08-12 23:49:57 +000099
100 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
Bob Haarmanc6c9b8f2017-09-11 22:11:57 +0000101
102 if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
103 return;
104
David Blaikied7057d92015-08-12 23:49:57 +0000105 if (TemporaryLocation.isValid()) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000106 DI->EmitLocation(CGF->Builder, TemporaryLocation);
David Blaikied7057d92015-08-12 23:49:57 +0000107 return;
108 }
109
110 if (DefaultToEmpty) {
111 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
112 return;
113 }
114
115 // Construct a location that has a valid scope, but no line info.
116 assert(!DI->LexicalBlockStack.empty());
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000117 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
118 0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000119}
120
David Blaikie9b479662015-01-25 01:19:10 +0000121ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
David Blaikied7057d92015-08-12 23:49:57 +0000122 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +0000123 init(E->getExprLoc());
124}
125
David Blaikie66e41972015-01-14 07:38:27 +0000126ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
David Blaikied7057d92015-08-12 23:49:57 +0000127 : CGF(&CGF) {
128 if (!CGF.getDebugInfo()) {
129 this->CGF = nullptr;
130 return;
David Blaikie66e41972015-01-14 07:38:27 +0000131 }
David Blaikied7057d92015-08-12 23:49:57 +0000132 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
133 if (Loc)
134 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +0000135}
136
137ApplyDebugLocation::~ApplyDebugLocation() {
138 // Query CGF so the location isn't overwritten when location updates are
139 // temporarily disabled (for C++ default function arguments)
David Blaikied7057d92015-08-12 23:49:57 +0000140 if (CGF)
141 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000142}
143
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000144ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
145 GlobalDecl InlinedFn)
146 : CGF(&CGF) {
147 if (!CGF.getDebugInfo()) {
148 this->CGF = nullptr;
149 return;
150 }
151 auto &DI = *CGF.getDebugInfo();
152 SavedLocation = DI.getLocation();
153 assert((DI.getInlinedAt() ==
154 CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
155 "CGDebugInfo and IRBuilder are out of sync");
156
157 DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
158}
159
160ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
161 if (!CGF)
162 return;
163 auto &DI = *CGF->getDebugInfo();
164 DI.EmitInlineFunctionEnd(CGF->Builder);
165 DI.EmitLocation(CGF->Builder, SavedLocation);
166}
167
Guy Benyei11169dd2012-12-18 14:30:41 +0000168void CGDebugInfo::setLocation(SourceLocation Loc) {
169 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000170 if (Loc.isInvalid())
171 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000172
173 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
174
175 // If we've changed files in the middle of a lexical scope go ahead
176 // and create a new lexical scope with file node if it's different
177 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000178 if (LexicalBlockStack.empty())
179 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000180
181 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000182 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000183 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000184
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000185 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000186 return;
187
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000188 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000189 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000190 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
191 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000192 } else if (isa<llvm::DILexicalBlock>(Scope) ||
193 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000194 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000195 LexicalBlockStack.emplace_back(
196 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000197 }
198}
199
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000200llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000201 llvm::DIScope *Mod = getParentModuleOrNull(D);
202 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
203 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000204}
205
206llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
207 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000208 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000209 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000210
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000211 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000212 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000213 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000214 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000215 }
216
217 // Check namespace.
Adrian Prantlddb8e062017-05-12 16:23:53 +0000218 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
219 return getOrCreateNamespace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000220
David Majnemer58ed0f32016-07-17 00:39:12 +0000221 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000222 if (!RDecl->isDependentType())
223 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000224 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000225 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000226}
227
Reid Kleckner59d12202017-08-08 01:33:53 +0000228PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
229 PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
230
231 // If we're emitting codeview, it's important to try to match MSVC's naming so
232 // that visualizers written for MSVC will trigger for our class names. In
233 // particular, we can't have spaces between arguments of standard templates
234 // like basic_string and vector.
235 if (CGM.getCodeGenOpts().EmitCodeView)
236 PP.MSVCFormatting = true;
237
238 return PP;
239}
240
Guy Benyei11169dd2012-12-18 14:30:41 +0000241StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000242 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000243 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000244 FunctionTemplateSpecializationInfo *Info =
245 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000246
Reid Kleckner31abd802016-06-30 17:41:31 +0000247 // Emit the unqualified name in normal operation. LLVM and the debugger can
248 // compute the fully qualified name from the scope chain. If we're only
249 // emitting line table info, there won't be any scope chains, so emit the
250 // fully qualified name here so that stack traces are more accurate.
251 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
252 // evaluating the size impact.
253 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
254 CGM.getCodeGenOpts().EmitCodeView;
255
256 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000257 return FII->getName();
258
Benjamin Kramer9170e912013-02-22 15:46:01 +0000259 SmallString<128> NS;
260 llvm::raw_svector_ostream OS(NS);
Reid Kleckner31abd802016-06-30 17:41:31 +0000261 if (!UseQualifiedName)
262 FD->printName(OS);
263 else
Reid Kleckner59d12202017-08-08 01:33:53 +0000264 FD->printQualifiedName(OS, getPrintingPolicy());
Guy Benyei11169dd2012-12-18 14:30:41 +0000265
Reid Kleckner829398e2016-06-17 16:11:20 +0000266 // Add any template specialization args.
267 if (Info) {
268 const TemplateArgumentList *TArgs = Info->TemplateArguments;
Serge Pavlov03e672c2017-11-28 16:14:14 +0000269 printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
Guy Benyei11169dd2012-12-18 14:30:41 +0000270 }
271
272 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000273 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000274}
275
276StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
277 SmallString<256> MethodName;
278 llvm::raw_svector_ostream OS(MethodName);
279 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
280 const DeclContext *DC = OMD->getDeclContext();
David Majnemer58ed0f32016-07-17 00:39:12 +0000281 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000282 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000283 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000284 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000285 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000286 if (OC->IsClassExtension()) {
287 OS << OC->getClassInterface()->getName();
288 } else {
David Majnemer58ed0f32016-07-17 00:39:12 +0000289 OS << OC->getIdentifier()->getNameStart() << '('
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000290 << OC->getIdentifier()->getNameStart() << ')';
291 }
David Majnemer58ed0f32016-07-17 00:39:12 +0000292 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000293 OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000294 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000295 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000296 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000297 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000298 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000299 ClassTy.print(OS, PrintingPolicy(LangOptions()));
300 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000301 }
302 OS << ' ' << OMD->getSelector().getAsString() << ']';
303
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000304 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000305}
306
Guy Benyei11169dd2012-12-18 14:30:41 +0000307StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000308 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000309}
310
Eric Christophere7b87e52014-10-26 23:40:33 +0000311StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000312 if (isa<ClassTemplateSpecializationDecl>(RD)) {
313 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000314 llvm::raw_svector_ostream OS(Name);
Reid Kleckner59d12202017-08-08 01:33:53 +0000315 RD->getNameForDiagnostic(OS, getPrintingPolicy(),
David Blaikie65813a32014-04-02 18:21:09 +0000316 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000317
318 // Copy this name on the side and use its reference.
319 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000320 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000321
David Majnemerbc5976a2016-07-01 23:12:54 +0000322 // quick optimization to avoid having to intern strings that are already
323 // stored reliably elsewhere
324 if (const IdentifierInfo *II = RD->getIdentifier())
325 return II->getName();
326
327 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
328 // used to reconstruct the fully qualified type names.
329 if (CGM.getCodeGenOpts().EmitCodeView) {
330 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
331 assert(RD->getDeclContext() == D->getDeclContext() &&
332 "Typedef should not be in another decl context!");
333 assert(D->getDeclName().getAsIdentifierInfo() &&
334 "Typedef was not named!");
335 return D->getDeclName().getAsIdentifierInfo()->getName();
336 }
337
338 if (CGM.getLangOpts().CPlusPlus) {
339 StringRef Name;
340
341 ASTContext &Context = CGM.getContext();
342 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
343 // Anonymous types without a name for linkage purposes have their
344 // declarator mangled in if they have one.
345 Name = DD->getName();
346 else if (const TypedefNameDecl *TND =
347 Context.getTypedefNameForUnnamedTagDecl(RD))
348 // Anonymous types without a name for linkage purposes have their
349 // associate typedef mangled in if they have one.
350 Name = TND->getName();
351
352 if (!Name.empty()) {
353 SmallString<256> UnnamedType("<unnamed-type-");
354 UnnamedType += Name;
355 UnnamedType += '>';
356 return internString(UnnamedType);
357 }
358 }
359 }
360
361 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000362}
363
Scott Linder94834f12018-02-12 19:47:05 +0000364Optional<llvm::DIFile::ChecksumKind>
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000365CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
366 Checksum.clear();
367
Paul Robinson76178632018-05-25 22:35:59 +0000368 if (!CGM.getCodeGenOpts().EmitCodeView &&
369 CGM.getCodeGenOpts().DwarfVersion < 5)
Scott Linder94834f12018-02-12 19:47:05 +0000370 return None;
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000371
372 SourceManager &SM = CGM.getContext().getSourceManager();
373 bool Invalid;
Paul Robinson76178632018-05-25 22:35:59 +0000374 llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
375 if (Invalid)
Scott Linder94834f12018-02-12 19:47:05 +0000376 return None;
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000377
378 llvm::MD5 Hash;
379 llvm::MD5::MD5Result Result;
380
381 Hash.update(MemBuffer->getBuffer());
382 Hash.final(Result);
383
384 Hash.stringifyResult(Result, Checksum);
385 return llvm::DIFile::CSK_MD5;
386}
387
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000388Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
389 FileID FID) {
Scott Lindera2fbcef2018-02-26 17:32:31 +0000390 if (!CGM.getCodeGenOpts().EmbedSource)
391 return None;
392
393 bool SourceInvalid = false;
394 StringRef Source = SM.getBufferData(FID, &SourceInvalid);
395
396 if (SourceInvalid)
397 return None;
398
399 return Source;
400}
401
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000402llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000403 if (!Loc.isValid())
404 // If Location is not valid then use main input file.
Scott Linder39ceac12018-02-26 16:31:08 +0000405 return getOrCreateMainFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000406
407 SourceManager &SM = CGM.getContext().getSourceManager();
408 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
409
410 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
411 // If the location is not valid then use main input file.
Scott Linder39ceac12018-02-26 16:31:08 +0000412 return getOrCreateMainFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000413
414 // Cache the results.
415 const char *fname = PLoc.getFilename();
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000416 auto It = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000417
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000418 if (It != DIFileCache.end()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000419 // Verify that the information still exists.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000420 if (llvm::Metadata *V = It->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000421 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000422 }
423
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000424 SmallString<32> Checksum;
Scott Linder94834f12018-02-12 19:47:05 +0000425 Optional<llvm::DIFile::ChecksumKind> CSKind =
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000426 computeChecksum(SM.getFileID(Loc), Checksum);
Scott Linder94834f12018-02-12 19:47:05 +0000427 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
428 if (CSKind)
429 CSInfo.emplace(*CSKind, Checksum);
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000430
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000431 llvm::DIFile *F = DBuilder.createFile(
432 remapDIPath(PLoc.getFilename()), remapDIPath(getCurrentDirname()), CSInfo,
433 getSource(SM, SM.getFileID(Loc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000434
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000435 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 return F;
437}
438
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000439llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Scott Lindera2fbcef2018-02-26 17:32:31 +0000440 return DBuilder.createFile(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000441 remapDIPath(TheCU->getFilename()), remapDIPath(TheCU->getDirectory()),
Scott Lindera2fbcef2018-02-26 17:32:31 +0000442 TheCU->getFile()->getChecksum(),
443 CGM.getCodeGenOpts().EmbedSource ? TheCU->getSource() : None);
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000444}
445
446std::string CGDebugInfo::remapDIPath(StringRef Path) const {
447 for (const auto &Entry : DebugPrefixMap)
448 if (Path.startswith(Entry.first))
449 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
450 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000451}
452
Guy Benyei11169dd2012-12-18 14:30:41 +0000453unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
454 if (Loc.isInvalid() && CurLoc.isInvalid())
455 return 0;
456 SourceManager &SM = CGM.getContext().getSourceManager();
457 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000458 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000459}
460
Adrian Prantlc7822422013-03-12 20:43:25 +0000461unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000462 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000463 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000464 return 0;
465
466 // If the location is invalid then use the current column.
467 if (Loc.isInvalid() && CurLoc.isInvalid())
468 return 0;
469 SourceManager &SM = CGM.getContext().getSourceManager();
470 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000471 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000472}
473
474StringRef CGDebugInfo::getCurrentDirname() {
475 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
476 return CGM.getCodeGenOpts().DebugCompilationDir;
477
478 if (!CWDName.empty())
479 return CWDName;
480 SmallString<256> CWD;
481 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000482 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000483}
484
Guy Benyei11169dd2012-12-18 14:30:41 +0000485void CGDebugInfo::CreateCompileUnit() {
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000486 SmallString<32> Checksum;
Scott Linder94834f12018-02-12 19:47:05 +0000487 Optional<llvm::DIFile::ChecksumKind> CSKind;
488 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
Guy Benyei11169dd2012-12-18 14:30:41 +0000489
David Blaikieaabde052014-05-14 00:29:00 +0000490 // Should we be asking the SourceManager for the main file name, instead of
491 // accepting it as an argument? This just causes the main file name to
492 // mismatch with source locations and create extra lexical scopes or
493 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
494 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
495 // because that's what the SourceManager says)
496
Guy Benyei11169dd2012-12-18 14:30:41 +0000497 // Get absolute path name.
498 SourceManager &SM = CGM.getContext().getSourceManager();
499 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
500 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000501 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000502
503 // The main file name provided via the "-main-file-name" option contains just
504 // the file name itself with no path information. This file name may have had
505 // a relative path, so we look into the actual file entry for the main
506 // file to determine the real absolute path for the file.
507 std::string MainFileDir;
508 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000509 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000510 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000511 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
512 llvm::sys::path::append(MainFileDirSS, MainFileName);
513 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000514 }
Taewook Oh0fb5b782017-08-16 19:36:24 +0000515 // If the main file name provided is identical to the input file name, and
516 // if the input file is a preprocessed source, use the module name for
517 // debug info. The module name comes from the name specified in the first
518 // linemarker if the input is a preprocessed source.
519 if (MainFile->getName() == MainFileName &&
520 FrontendOptions::getInputKindForExtension(
521 MainFile->getName().rsplit('.').second)
522 .isPreprocessed())
523 MainFileName = CGM.getModule().getName().str();
524
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000525 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000526 }
527
Ed Masteda706022014-05-07 12:49:30 +0000528 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000529 const LangOptions &LO = CGM.getLangOpts();
530 if (LO.CPlusPlus) {
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000531 if (LO.ObjC)
Guy Benyei11169dd2012-12-18 14:30:41 +0000532 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
533 else
534 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000535 } else if (LO.ObjC) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000536 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000537 } else if (LO.RenderScript) {
538 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000539 } else if (LO.C99) {
540 LangTag = llvm::dwarf::DW_LANG_C99;
541 } else {
542 LangTag = llvm::dwarf::DW_LANG_C89;
543 }
544
545 std::string Producer = getClangFullVersion();
546
547 // Figure out which version of the ObjC runtime we have.
548 unsigned RuntimeVers = 0;
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000549 if (LO.ObjC)
Guy Benyei11169dd2012-12-18 14:30:41 +0000550 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
551
Adrian Prantl826824e2016-04-08 22:43:06 +0000552 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
553 switch (DebugKind) {
554 case codegenoptions::NoDebugInfo:
555 case codegenoptions::LocTrackingOnly:
556 EmissionKind = llvm::DICompileUnit::NoDebug;
557 break;
558 case codegenoptions::DebugLineTablesOnly:
559 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
560 break;
Alexey Bataev80e1b5e2018-08-31 13:56:14 +0000561 case codegenoptions::DebugDirectivesOnly:
562 EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
563 break;
Adrian Prantl826824e2016-04-08 22:43:06 +0000564 case codegenoptions::LimitedDebugInfo:
565 case codegenoptions::FullDebugInfo:
566 EmissionKind = llvm::DICompileUnit::FullDebug;
567 break;
568 }
569
Scott Linder94834f12018-02-12 19:47:05 +0000570 if (CSKind)
571 CSInfo.emplace(*CSKind, Checksum);
572
Guy Benyei11169dd2012-12-18 14:30:41 +0000573 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000574 // FIXME - Eliminate TheCU.
Adrian Prantlb4423022017-08-04 23:08:57 +0000575 auto &CGOpts = CGM.getCodeGenOpts();
Eric Christophere4200a22014-02-27 01:25:08 +0000576 TheCU = DBuilder.createCompileUnit(
David Blaikie81503552017-04-21 23:35:36 +0000577 LangTag,
578 DBuilder.createFile(remapDIPath(MainFileName),
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000579 remapDIPath(getCurrentDirname()), CSInfo,
Scott Lindera2fbcef2018-02-26 17:32:31 +0000580 getSource(SM, SM.getMainFileID())),
Mikhail Maltsev4a4e7a32018-04-23 10:08:46 +0000581 CGOpts.EmitVersionIdentMetadata ? Producer : "",
Tobias Edler von Koch7609cb82018-06-22 20:23:21 +0000582 LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
Adrian Prantlb4423022017-08-04 23:08:57 +0000583 CGOpts.DwarfDebugFlags, RuntimeVers,
George Rimar91829ee2018-11-14 09:22:16 +0000584 (CGOpts.getSplitDwarfMode() != CodeGenOptions::NoFission)
585 ? ""
586 : CGOpts.SplitDwarfFile,
587 EmissionKind, 0 /* DWOid */, CGOpts.SplitDwarfInlining,
588 CGOpts.DebugInfoForProfiling,
David Blaikie9982bb82018-08-16 23:56:32 +0000589 CGM.getTarget().getTriple().isNVPTX()
590 ? llvm::DICompileUnit::DebugNameTableKind::None
David Blaikie65864522018-08-20 20:14:08 +0000591 : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
David Blaikie27692de2018-11-13 20:08:13 +0000592 CGOpts.DebugNameTable),
593 CGOpts.DebugRangesBaseAddress);
Guy Benyei11169dd2012-12-18 14:30:41 +0000594}
595
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000596llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000597 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000598 StringRef BTName;
599 switch (BT->getKind()) {
600#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000601#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000602#include "clang/AST/BuiltinTypes.def"
603 case BuiltinType::Dependent:
604 llvm_unreachable("Unexpected builtin type");
605 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000606 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000607 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000608 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000609 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000610 if (!ClassTy)
611 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
612 "objc_class", TheCU,
613 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000614 return ClassTy;
615 case BuiltinType::ObjCId: {
616 // typedef struct objc_class *Class;
617 // typedef struct objc_object {
618 // Class isa;
619 // } *id;
620
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000621 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000622 return ObjTy;
623
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000624 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000625 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
626 "objc_class", TheCU,
627 getOrCreateMainFile(), 0);
628
629 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000630
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000631 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000632
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000633 ObjTy = DBuilder.createStructType(
634 TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
635 llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000636
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000637 DBuilder.replaceArrays(
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000638 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
639 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
640 llvm::DINode::FlagZero, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000641 return ObjTy;
642 }
643 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000644 if (!SelTy)
645 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
646 "objc_selector", TheCU,
647 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000648 return SelTy;
649 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000650
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000651#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
652 case BuiltinType::Id: \
653 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
Alexey Bader954ba212016-04-08 13:40:33 +0000654 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000655#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000656 case BuiltinType::OCLSampler:
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000657 return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000658 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000659 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000660 case BuiltinType::OCLClkEvent:
661 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
662 case BuiltinType::OCLQueue:
663 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000664 case BuiltinType::OCLReserveID:
665 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Andrew Savonichev3fee3512018-11-08 11:25:41 +0000666#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
667 case BuiltinType::Id: \
668 return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
669#include "clang/Basic/OpenCLExtensionTypes.def"
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000670
Guy Benyei11169dd2012-12-18 14:30:41 +0000671 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000672 case BuiltinType::Char_U:
673 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
674 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000675 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000676 case BuiltinType::SChar:
677 Encoding = llvm::dwarf::DW_ATE_signed_char;
678 break;
Richard Smith3a8244d2018-05-01 05:02:45 +0000679 case BuiltinType::Char8:
Guy Benyei11169dd2012-12-18 14:30:41 +0000680 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000681 case BuiltinType::Char32:
682 Encoding = llvm::dwarf::DW_ATE_UTF;
683 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000684 case BuiltinType::UShort:
685 case BuiltinType::UInt:
686 case BuiltinType::UInt128:
687 case BuiltinType::ULong:
688 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000689 case BuiltinType::ULongLong:
690 Encoding = llvm::dwarf::DW_ATE_unsigned;
691 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000692 case BuiltinType::Short:
693 case BuiltinType::Int:
694 case BuiltinType::Int128:
695 case BuiltinType::Long:
696 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000697 case BuiltinType::LongLong:
698 Encoding = llvm::dwarf::DW_ATE_signed;
699 break;
700 case BuiltinType::Bool:
701 Encoding = llvm::dwarf::DW_ATE_boolean;
702 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000703 case BuiltinType::Half:
704 case BuiltinType::Float:
705 case BuiltinType::LongDouble:
Sjoerd Meijercc623ad2017-09-08 15:15:00 +0000706 case BuiltinType::Float16:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000707 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000708 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000709 // FIXME: For targets where long double and __float128 have the same size,
710 // they are currently indistinguishable in the debugger without some
711 // special treatment. However, there is currently no consensus on encoding
712 // and this should be updated once a DWARF encoding exists for distinct
713 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000714 Encoding = llvm::dwarf::DW_ATE_float;
715 break;
Leonard Chanf921d852018-06-04 16:07:52 +0000716 case BuiltinType::ShortAccum:
717 case BuiltinType::Accum:
718 case BuiltinType::LongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000719 case BuiltinType::ShortFract:
720 case BuiltinType::Fract:
721 case BuiltinType::LongFract:
722 case BuiltinType::SatShortFract:
723 case BuiltinType::SatFract:
724 case BuiltinType::SatLongFract:
725 case BuiltinType::SatShortAccum:
726 case BuiltinType::SatAccum:
727 case BuiltinType::SatLongAccum:
Leonard Chanf921d852018-06-04 16:07:52 +0000728 Encoding = llvm::dwarf::DW_ATE_signed_fixed;
729 break;
730 case BuiltinType::UShortAccum:
731 case BuiltinType::UAccum:
732 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000733 case BuiltinType::UShortFract:
734 case BuiltinType::UFract:
735 case BuiltinType::ULongFract:
736 case BuiltinType::SatUShortAccum:
737 case BuiltinType::SatUAccum:
738 case BuiltinType::SatULongAccum:
739 case BuiltinType::SatUShortFract:
740 case BuiltinType::SatUFract:
741 case BuiltinType::SatULongFract:
Leonard Chanf921d852018-06-04 16:07:52 +0000742 Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
743 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000744 }
745
746 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000747 case BuiltinType::Long:
748 BTName = "long int";
749 break;
750 case BuiltinType::LongLong:
751 BTName = "long long int";
752 break;
753 case BuiltinType::ULong:
754 BTName = "long unsigned int";
755 break;
756 case BuiltinType::ULongLong:
757 BTName = "long long unsigned int";
758 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000759 default:
760 BTName = BT->getName(CGM.getLangOpts());
761 break;
762 }
Victor Leschuka7ece032016-10-20 00:13:19 +0000763 // Bit size and offset of the type.
Guy Benyei11169dd2012-12-18 14:30:41 +0000764 uint64_t Size = CGM.getContext().getTypeSize(BT);
Victor Leschuka7ece032016-10-20 00:13:19 +0000765 return DBuilder.createBasicType(BTName, Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000766}
767
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000768llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Victor Leschuka7ece032016-10-20 00:13:19 +0000769 // Bit size and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000770 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000771 if (Ty->isComplexIntegerType())
772 Encoding = llvm::dwarf::DW_ATE_lo_user;
773
774 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000775 return DBuilder.createBasicType("complex", Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000776}
777
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000778llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
779 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000780 QualifierCollector Qc;
781 const Type *T = Qc.strip(Ty);
782
783 // Ignore these qualifiers for now.
784 Qc.removeObjCGCAttr();
785 Qc.removeAddressSpace();
786 Qc.removeObjCLifetime();
787
788 // We will create one Derived type for one qualifier and recurse to handle any
789 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000790 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000791 if (Qc.hasConst()) {
792 Tag = llvm::dwarf::DW_TAG_const_type;
793 Qc.removeConst();
794 } else if (Qc.hasVolatile()) {
795 Tag = llvm::dwarf::DW_TAG_volatile_type;
796 Qc.removeVolatile();
797 } else if (Qc.hasRestrict()) {
798 Tag = llvm::dwarf::DW_TAG_restrict_type;
799 Qc.removeRestrict();
800 } else {
801 assert(Qc.empty() && "Unknown type qualifier for debug info");
802 return getOrCreateType(QualType(T, 0), Unit);
803 }
804
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000805 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000806
807 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
808 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000809 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000810}
811
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000812llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
813 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000814
815 // The frontend treats 'id' as a typedef to an ObjCObjectType,
816 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
817 // debug info, we want to emit 'id' in both cases.
818 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000819 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000820
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000821 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
822 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000823}
824
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000825llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
826 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000827 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000828 Ty->getPointeeType(), Unit);
829}
830
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000831/// \return whether a C++ mangling exists for the type defined by TD.
832static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
833 switch (TheCU->getSourceLanguage()) {
834 case llvm::dwarf::DW_LANG_C_plus_plus:
835 return true;
836 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
837 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
838 default:
839 return false;
840 }
841}
842
Reid Kleckner59320fc2018-08-17 20:59:52 +0000843// Determines if the debug info for this tag declaration needs a type
844// identifier. The purpose of the unique identifier is to deduplicate type
845// information for identical types across TUs. Because of the C++ one definition
846// rule (ODR), it is valid to assume that the type is defined the same way in
847// every TU and its debug info is equivalent.
848//
849// C does not have the ODR, and it is common for codebases to contain multiple
850// different definitions of a struct with the same name in different TUs.
851// Therefore, if the type doesn't have a C++ mangling, don't give it an
852// identifer. Type information in C is smaller and simpler than C++ type
853// information, so the increase in debug info size is negligible.
854//
855// If the type is not externally visible, it should be unique to the current TU,
856// and should not need an identifier to participate in type deduplication.
857// However, when emitting CodeView, the format internally uses these
858// unique type name identifers for references between debug info. For example,
859// the method of a class in an anonymous namespace uses the identifer to refer
860// to its parent class. The Microsoft C++ ABI attempts to provide unique names
861// for such types, so when emitting CodeView, always use identifiers for C++
862// types. This may create problems when attempting to emit CodeView when the MS
863// C++ ABI is not in use.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000864static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
Brock Wyma8557ec52018-05-22 12:41:19 +0000865 llvm::DICompileUnit *TheCU) {
866 // We only add a type identifier for types with C++ name mangling.
867 if (!hasCXXMangling(TD, TheCU))
868 return false;
869
Brock Wyma8557ec52018-05-22 12:41:19 +0000870 // Externally visible types with C++ mangling need a type identifier.
871 if (TD->isExternallyVisible())
872 return true;
873
Reid Kleckner59320fc2018-08-17 20:59:52 +0000874 // CodeView types with C++ mangling need a type identifier.
875 if (CGM.getCodeGenOpts().EmitCodeView)
876 return true;
877
Brock Wyma8557ec52018-05-22 12:41:19 +0000878 return false;
879}
880
Reid Kleckner59320fc2018-08-17 20:59:52 +0000881// Returns a unique type identifier string if one exists, or an empty string.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000882static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
Brock Wyma8557ec52018-05-22 12:41:19 +0000883 llvm::DICompileUnit *TheCU) {
884 SmallString<256> Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000885 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000886
Brock Wyma8557ec52018-05-22 12:41:19 +0000887 if (!needsTypeIdentifier(TD, CGM, TheCU))
888 return Identifier;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000889
Manman Rene0064d82013-08-29 23:19:58 +0000890 // TODO: This is using the RTTI name. Is there a better way to get
891 // a unique string for a type?
Brock Wyma8557ec52018-05-22 12:41:19 +0000892 llvm::raw_svector_ostream Out(Identifier);
Manman Rene0064d82013-08-29 23:19:58 +0000893 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Brock Wyma8557ec52018-05-22 12:41:19 +0000894 return Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000895}
896
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000897/// \return the appropriate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000898static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000899 llvm::dwarf::Tag Tag;
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000900 if (RD->isStruct() || RD->isInterface())
901 Tag = llvm::dwarf::DW_TAG_structure_type;
902 else if (RD->isUnion())
903 Tag = llvm::dwarf::DW_TAG_union_type;
904 else {
905 // FIXME: This could be a struct type giving a default visibility different
906 // than C++ class type, but needs llvm metadata changes first.
907 assert(RD->isClass());
908 Tag = llvm::dwarf::DW_TAG_class_type;
909 }
910 return Tag;
911}
912
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000913llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000914CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000915 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000916 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000917 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
918 return cast<llvm::DICompositeType>(T);
919 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000920 unsigned Line = getLineNumber(RD->getLocation());
921 StringRef RDName = getClassName(RD);
922
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000923 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000924 uint32_t Align = 0;
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000925
Guy Benyei11169dd2012-12-18 14:30:41 +0000926 // Create the type.
Brock Wyma8557ec52018-05-22 12:41:19 +0000927 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000928 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000929 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +0000930 llvm::DINode::FlagFwdDecl, Identifier);
Paul Robinson1787f812017-09-28 18:37:02 +0000931 if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
932 if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
933 DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
934 CollectCXXTemplateParams(TSpecial, DefUnit));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000935 ReplaceMap.emplace_back(
936 std::piecewise_construct, std::make_tuple(Ty),
937 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000938 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000939}
940
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000941llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000942 const Type *Ty,
943 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000944 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000945 // Bit size, align and offset of the type.
946 // Size is always the size of a pointer. We can't use getTypeSize here
947 // because that does not return the correct value for references.
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000948 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
949 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
Victor Leschuka7ece032016-10-20 00:13:19 +0000950 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000951 Optional<unsigned> DWARFAddressSpace =
952 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000953
Keno Fischer87842f32015-11-16 09:04:13 +0000954 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
955 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
956 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000957 Size, Align, DWARFAddressSpace);
Keno Fischer87842f32015-11-16 09:04:13 +0000958 else
959 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000960 Align, DWARFAddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000961}
962
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000963llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
964 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000965 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000966 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000967 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
968 TheCU, getOrCreateMainFile(), 0);
969 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
970 Cache = DBuilder.createPointerType(Cache, Size);
971 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000972}
973
Scott Linder58df0e42018-08-08 15:56:12 +0000974uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
975 const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
976 unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000977 QualType FType;
Guy Benyei11169dd2012-12-18 14:30:41 +0000978
Scott Linder58df0e42018-08-08 15:56:12 +0000979 // Advanced by calls to CreateMemberType in increments of FType, then
980 // returned as the overall size of the default elements.
981 uint64_t FieldOffset = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000982
Scott Linder58df0e42018-08-08 15:56:12 +0000983 // Blocks in OpenCL have unique constraints which make the standard fields
984 // redundant while requiring size and align fields for enqueue_kernel. See
985 // initializeForBlockHeader in CGBlocks.cpp
Scott Linder2b5cf042018-07-30 20:31:11 +0000986 if (CGM.getLangOpts().OpenCL) {
987 FType = CGM.getContext().IntTy;
988 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
989 EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
990 } else {
991 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
992 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
993 FType = CGM.getContext().IntTy;
994 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
995 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
996 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
997 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
998 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Scott Linder58df0e42018-08-08 15:56:12 +0000999 uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
1000 uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
Scott Linder2b5cf042018-07-30 20:31:11 +00001001 EltTys.push_back(DBuilder.createMemberType(
Scott Linder58df0e42018-08-08 15:56:12 +00001002 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
1003 FieldOffset, llvm::DINode::FlagZero, DescTy));
Scott Lindera7c45682018-07-30 22:52:07 +00001004 FieldOffset += FieldSize;
Scott Linder2b5cf042018-07-30 20:31:11 +00001005 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001006
Scott Linder58df0e42018-08-08 15:56:12 +00001007 return FieldOffset;
1008}
1009
1010llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1011 llvm::DIFile *Unit) {
1012 SmallVector<llvm::Metadata *, 8> EltTys;
1013 QualType FType;
1014 uint64_t FieldOffset;
1015 llvm::DINodeArray Elements;
1016
1017 FieldOffset = 0;
1018 FType = CGM.getContext().UnsignedLongTy;
1019 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1020 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1021
1022 Elements = DBuilder.getOrCreateArray(EltTys);
1023 EltTys.clear();
1024
1025 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1026
1027 auto *EltTy =
1028 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1029 FieldOffset, 0, Flags, nullptr, Elements);
1030
1031 // Bit size, align and offset of the type.
1032 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1033
1034 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1035
1036 FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1037 0, EltTys);
1038
Guy Benyei11169dd2012-12-18 14:30:41 +00001039 Elements = DBuilder.getOrCreateArray(EltTys);
1040
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001041 // The __block_literal_generic structs are marked with a special
1042 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1043 // the debugger needs to know about. To allow type uniquing, emit
1044 // them without a name or a location.
Scott Linder58df0e42018-08-08 15:56:12 +00001045 EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001046 Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001047
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001048 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +00001049}
1050
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001051llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1052 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +00001053 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001054 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +00001055
1056 SmallString<128> NS;
1057 llvm::raw_svector_ostream OS(NS);
Serge Pavlov03e672c2017-11-28 16:14:14 +00001058 Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1059 printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
David Blaikief1b382e2014-04-06 17:14:06 +00001060
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001061 auto *AliasDecl =
1062 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1063 ->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +00001064
1065 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +00001066 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1067 getLineNumber(Loc),
1068 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +00001069}
1070
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001071llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1072 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001073 // We don't set size information, but do specify where the typedef was
1074 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +00001075 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001076
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001077 // Typedefs are derived from some other type.
1078 return DBuilder.createTypedef(
1079 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1080 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +00001081 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001082}
1083
Reid Klecknerf00f8032016-06-08 20:41:54 +00001084static unsigned getDwarfCC(CallingConv CC) {
1085 switch (CC) {
1086 case CC_C:
1087 // Avoid emitting DW_AT_calling_convention if the C convention was used.
1088 return 0;
1089
1090 case CC_X86StdCall:
1091 return llvm::dwarf::DW_CC_BORLAND_stdcall;
1092 case CC_X86FastCall:
1093 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1094 case CC_X86ThisCall:
1095 return llvm::dwarf::DW_CC_BORLAND_thiscall;
1096 case CC_X86VectorCall:
1097 return llvm::dwarf::DW_CC_LLVM_vectorcall;
1098 case CC_X86Pascal:
1099 return llvm::dwarf::DW_CC_BORLAND_pascal;
Martin Storsjo022e7822017-07-17 20:49:45 +00001100 case CC_Win64:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001101 return llvm::dwarf::DW_CC_LLVM_Win64;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001102 case CC_X86_64SysV:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001103 return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001104 case CC_AAPCS:
Sander de Smalen44a22532018-11-26 16:38:37 +00001105 case CC_AArch64VectorCall:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001106 return llvm::dwarf::DW_CC_LLVM_AAPCS;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001107 case CC_AAPCS_VFP:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001108 return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001109 case CC_IntelOclBicc:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001110 return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001111 case CC_SpirFunction:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001112 return llvm::dwarf::DW_CC_LLVM_SpirFunction;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +00001113 case CC_OpenCLKernel:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001114 return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001115 case CC_Swift:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001116 return llvm::dwarf::DW_CC_LLVM_Swift;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001117 case CC_PreserveMost:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001118 return llvm::dwarf::DW_CC_LLVM_PreserveMost;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001119 case CC_PreserveAll:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001120 return llvm::dwarf::DW_CC_LLVM_PreserveAll;
Erich Keane757d3172016-11-02 18:29:35 +00001121 case CC_X86RegCall:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001122 return llvm::dwarf::DW_CC_LLVM_X86RegCall;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001123 }
1124 return 0;
1125}
1126
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001127llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1128 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001129 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001130
1131 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +00001132 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001133
1134 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +00001135 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +00001136 if (isa<FunctionNoProtoType>(Ty))
1137 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +00001138 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1139 for (const QualType &ParamType : FPT->param_types())
1140 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +00001141 if (FPT->isVariadic())
1142 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00001143 }
1144
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001145 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00001146 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +00001147 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001148}
1149
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001150/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +00001151/// As an optimization, return 0 if the access specifier equals the
1152/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +00001153static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1154 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +00001155 AccessSpecifier Default = clang::AS_none;
1156 if (RD && RD->isClass())
1157 Default = clang::AS_private;
1158 else if (RD && (RD->isStruct() || RD->isUnion()))
1159 Default = clang::AS_public;
1160
1161 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +00001162 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001163
Eric Christophere7b87e52014-10-26 23:40:33 +00001164 switch (Access) {
1165 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001166 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +00001167 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001168 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +00001169 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001170 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +00001171 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +00001172 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001173 }
1174 llvm_unreachable("unexpected access enumerator");
1175}
Guy Benyei11169dd2012-12-18 14:30:41 +00001176
David Majnemerb4b671e2016-06-30 03:01:59 +00001177llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1178 llvm::DIScope *RecordTy,
1179 const RecordDecl *RD) {
1180 StringRef Name = BitFieldDecl->getName();
1181 QualType Ty = BitFieldDecl->getType();
1182 SourceLocation Loc = BitFieldDecl->getLocation();
1183 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1184 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1185
1186 // Get the location for the field.
1187 llvm::DIFile *File = getOrCreateFile(Loc);
1188 unsigned Line = getLineNumber(Loc);
1189
1190 const CGBitFieldInfo &BitFieldInfo =
1191 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1192 uint64_t SizeInBits = BitFieldInfo.Size;
1193 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001194 uint64_t StorageOffsetInBits =
1195 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
Reid Kleckner06a4b2a2017-06-12 19:57:56 +00001196 uint64_t Offset = BitFieldInfo.Offset;
1197 // The bit offsets for big endian machines are reversed for big
1198 // endian target, compensate for that as the DIDerivedType requires
1199 // un-reversed offsets.
1200 if (CGM.getDataLayout().isBigEndian())
1201 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1202 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001203 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001204 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001205 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1206 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001207}
1208
1209llvm::DIType *
1210CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1211 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001212 uint32_t AlignInBits, llvm::DIFile *tunit,
1213 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001214 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001215
1216 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001217 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001218 unsigned line = getLineNumber(loc);
1219
David Majnemer34b57492014-07-30 01:30:47 +00001220 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001221 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001222 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001223 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1224 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001225 if (!Align)
1226 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001227 }
1228
Leny Kholodov80c047d2016-09-06 10:48:04 +00001229 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001230 return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1231 offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001232}
1233
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001234void CGDebugInfo::CollectRecordLambdaFields(
1235 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001236 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001237 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1238 // has the name and the location of the variable so we should iterate over
1239 // both concurrently.
1240 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1241 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1242 unsigned fieldno = 0;
1243 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001244 E = CXXDecl->captures_end();
1245 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001246 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001247 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001248 SourceLocation Loc = C.getLocation();
1249 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001250 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001251 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001252 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001253 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001254 llvm::DIType *FieldType = createFieldType(
1255 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001256 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001257 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001258 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001259 // TODO: Need to handle 'this' in some way by probably renaming the
1260 // this of the lambda class and having a field member of 'this' or
1261 // by using AT_object_pointer for the function and having that be
1262 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001263 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001264 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001265 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001266 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001267 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001268 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001269
1270 elements.push_back(fieldType);
1271 }
1272 }
1273}
1274
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001275llvm::DIDerivedType *
1276CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001277 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001278 // Create the descriptor for the static variable, with or without
1279 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001280 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001281 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1282 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001283
Eric Christopher91a31902013-01-16 01:22:32 +00001284 unsigned LineNumber = getLineNumber(Var->getLocation());
1285 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001286 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001287 if (Var->getInit()) {
1288 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001289 if (Value) {
1290 if (Value->isInt())
1291 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1292 if (Value->isFloat())
1293 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1294 }
Eric Christopher91a31902013-01-16 01:22:32 +00001295 }
1296
Leny Kholodov80c047d2016-09-06 10:48:04 +00001297 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001298 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001299 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001300 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001301 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001302 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001303}
1304
Eric Christophere7b87e52014-10-26 23:40:33 +00001305void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001306 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1307 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001308 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001309 StringRef name = field->getName();
1310 QualType type = field->getType();
1311
1312 // Ignore unnamed fields unless they're anonymous structs/unions.
1313 if (name.empty() && !type->isRecordType())
1314 return;
1315
David Majnemerb4b671e2016-06-30 03:01:59 +00001316 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001317 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001318 FieldType = createBitFieldType(field, RecordTy, RD);
1319 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001320 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001321 FieldType =
1322 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001323 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001324 }
1325
David Majnemerb4b671e2016-06-30 03:01:59 +00001326 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001327}
1328
Reid Klecknere2e82062017-08-08 20:30:14 +00001329void CGDebugInfo::CollectRecordNestedType(
1330 const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1331 QualType Ty = CGM.getContext().getTypeDeclType(TD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001332 // Injected class names are not considered nested records.
1333 if (isa<InjectedClassNameType>(Ty))
1334 return;
Reid Klecknere2e82062017-08-08 20:30:14 +00001335 SourceLocation Loc = TD->getLocation();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001336 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1337 elements.push_back(nestedType);
1338}
1339
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001340void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001341 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001342 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001343 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001344 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001345
Eric Christopher91a31902013-01-16 01:22:32 +00001346 if (CXXDecl && CXXDecl->isLambda())
1347 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1348 else {
1349 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001350
Eric Christopher91a31902013-01-16 01:22:32 +00001351 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001352 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001353
Eric Christopher91a31902013-01-16 01:22:32 +00001354 // Static and non-static members should appear in the same order as
1355 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001356 for (const auto *I : record->decls())
1357 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001358 if (V->hasAttr<NoDebugAttr>())
1359 continue;
Reid Kleckner891b2712018-07-20 20:55:00 +00001360
1361 // Skip variable template specializations when emitting CodeView. MSVC
1362 // doesn't emit them.
1363 if (CGM.getCodeGenOpts().EmitCodeView &&
1364 isa<VarTemplateSpecializationDecl>(V))
1365 continue;
1366
David Blaikiece763042013-08-20 21:49:21 +00001367 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001368 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001369 if (MI != StaticDataMemberCache.end()) {
1370 assert(MI->second &&
1371 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001372 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001373 } else {
1374 auto Field = CreateRecordStaticField(V, RecordTy, record);
1375 elements.push_back(Field);
1376 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001377 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001378 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1379 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001380
1381 // Bump field number for next field.
1382 ++fieldNo;
Reid Kleckner891b2712018-07-20 20:55:00 +00001383 } else if (CGM.getCodeGenOpts().EmitCodeView) {
1384 // Debug info for nested types is included in the member list only for
1385 // CodeView.
Reid Klecknere2e82062017-08-08 20:30:14 +00001386 if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1387 if (!nestedType->isImplicit() &&
1388 nestedType->getDeclContext() == record)
1389 CollectRecordNestedType(nestedType, elements);
1390 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001391 }
1392}
1393
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001394llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001395CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001396 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001397 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001398 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001399 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001400 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001401 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1402 Func, Unit);
1403}
David Blaikie2aaf0652013-01-07 22:24:59 +00001404
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001405llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1406 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001407 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001408 llvm::DITypeRefArray Args(
1409 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001410 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001411 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001412
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001413 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001414
1415 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001416 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001417
David Blaikie2aaf0652013-01-07 22:24:59 +00001418 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001419 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001420 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1421 // Create pointer type directly in this case.
1422 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1423 QualType PointeeTy = ThisPtrTy->getPointeeType();
1424 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001425 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001426 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001427 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1428 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001429 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001430 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001431 // TODO: This and the artificial type below are misleading, the
1432 // types aren't artificial the argument is, but the current
1433 // metadata doesn't represent that.
1434 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1435 Elts.push_back(ThisPtrType);
1436 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001437 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001438 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001439 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1440 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001441 }
1442
1443 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001444 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1445 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001446
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001447 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001448
Leny Kholodov80c047d2016-09-06 10:48:04 +00001449 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001450 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001451 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001452 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001453 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001454
Reid Klecknerf00f8032016-06-08 20:41:54 +00001455 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1456 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001457}
1458
Eric Christopherb2a008c2013-05-16 00:45:12 +00001459/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001460/// inside a function.
1461static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001462 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001463 return isFunctionLocalClass(NRD);
1464 if (isa<FunctionDecl>(RD->getDeclContext()))
1465 return true;
1466 return false;
1467}
1468
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001469llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1470 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001471 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001472 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001473
Guy Benyei11169dd2012-12-18 14:30:41 +00001474 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001475 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001476
1477 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1478 // make sense to give a single ctor/dtor a linkage name.
1479 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001480 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1481 // property to use here. It may've been intended to model "is non-external
1482 // type" but misses cases of non-function-local but non-external classes such
1483 // as those in anonymous namespaces as well as the reverse - external types
1484 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001485 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1486 MethodLinkageName = CGM.getMangledName(Method);
1487
1488 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001489 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001490 unsigned MethodLine = 0;
1491 if (!Method->isImplicit()) {
1492 MethodDefUnit = getOrCreateFile(Method->getLocation());
1493 MethodLine = getLineNumber(Method->getLocation());
1494 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001495
1496 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001497 llvm::DIType *ContainingType = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001498 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001499 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Paul Robinsoncda54212018-11-19 18:29:28 +00001500 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001501 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001502
Guy Benyei11169dd2012-12-18 14:30:41 +00001503 if (Method->isVirtual()) {
1504 if (Method->isPure())
Paul Robinsoncda54212018-11-19 18:29:28 +00001505 SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001506 else
Paul Robinsoncda54212018-11-19 18:29:28 +00001507 SPFlags |= llvm::DISubprogram::SPFlagVirtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001508
Reid Kleckner216d0a12016-06-16 20:08:51 +00001509 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1510 // It doesn't make sense to give a virtual destructor a vtable index,
1511 // since a single destructor has two entries in the vtable.
1512 if (!isa<CXXDestructorDecl>(Method))
1513 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1514 } else {
1515 // Emit MS ABI vftable information. There is only one entry for the
1516 // deleting dtor.
1517 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1518 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
Reid Klecknercbec0262018-04-02 20:00:39 +00001519 MethodVFTableLocation ML =
Reid Kleckner216d0a12016-06-16 20:08:51 +00001520 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1521 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001522
1523 // CodeView only records the vftable offset in the class that introduces
1524 // the virtual method. This is possible because, unlike Itanium, the MS
1525 // C++ ABI does not include all virtual methods from non-primary bases in
1526 // the vtable for the most derived class. For example, if C inherits from
1527 // A and B, C's primary vftable will not include B's virtual methods.
Benjamin Krameracfa3392017-12-17 23:52:45 +00001528 if (Method->size_overridden_methods() == 0)
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001529 Flags |= llvm::DINode::FlagIntroducedVirtual;
1530
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001531 // The 'this' adjustment accounts for both the virtual and non-virtual
1532 // portions of the adjustment. Presumably the debugger only uses it when
1533 // it knows the dynamic type of an object.
1534 ThisAdjustment = CGM.getCXXABI()
1535 .getVirtualFunctionPrologueThisAdjustment(GD)
1536 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001537 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001538 ContainingType = RecordTy;
1539 }
1540
Adrian McCarthyd91bf392017-09-13 20:53:55 +00001541 if (Method->isStatic())
1542 Flags |= llvm::DINode::FlagStaticMember;
Guy Benyei11169dd2012-12-18 14:30:41 +00001543 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001544 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001545 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001546 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001547 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001548 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001549 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001550 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001551 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001552 }
1553 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001554 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001555 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001556 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001557 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001558 Flags |= llvm::DINode::FlagRValueReference;
Paul Robinsoncda54212018-11-19 18:29:28 +00001559 if (CGM.getLangOpts().Optimize)
1560 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
Guy Benyei11169dd2012-12-18 14:30:41 +00001561
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001562 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1563 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001564 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Paul Robinsoncda54212018-11-19 18:29:28 +00001565 MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001566 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001567
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001568 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001569
1570 return SP;
1571}
1572
Eric Christophere7b87e52014-10-26 23:40:33 +00001573void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001574 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1575 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001576
1577 // Since we want more than just the individual member decls if we
1578 // have templated functions iterate over every declaration to gather
1579 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001580 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001581 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1582 // If the member is implicit, don't add it to the member list. This avoids
1583 // the member being added to type units by LLVM, while still allowing it
1584 // to be emitted into the type declaration/reference inside the compile
1585 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001586 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001587 // FIXME: Handle Using(Shadow?)Decls here to create
1588 // DW_TAG_imported_declarations inside the class for base decls brought into
1589 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1590 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1591 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001592 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001593 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001594
1595 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1596 continue;
1597
David Blaikiefd580722014-10-06 05:18:55 +00001598 // Reuse the existing member function declaration if it exists.
1599 // It may be associated with the declaration of the type & should be
1600 // reused as we're building the definition.
1601 //
1602 // This situation can arise in the vtable-based debug info reduction where
1603 // implicit members are emitted in a non-vtable TU.
1604 auto MI = SPCache.find(Method->getCanonicalDecl());
1605 EltTys.push_back(MI == SPCache.end()
1606 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001607 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001608 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001609}
Guy Benyei11169dd2012-12-18 14:30:41 +00001610
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001611void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001612 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001613 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001614 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1615 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1616 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001617
Bob Haarmandff36732016-10-25 22:19:32 +00001618 // If we are generating CodeView debug info, we also need to emit records for
1619 // indirect virtual base classes.
1620 if (CGM.getCodeGenOpts().EmitCodeView) {
1621 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1622 llvm::DINode::FlagIndirectVirtualBase);
1623 }
1624}
1625
1626void CGDebugInfo::CollectCXXBasesAux(
1627 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1628 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1629 const CXXRecordDecl::base_class_const_range &Bases,
1630 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1631 llvm::DINode::DIFlags StartingFlags) {
1632 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1633 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001634 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001635 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001636 if (!SeenTypes.insert(Base).second)
1637 continue;
1638 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1639 llvm::DINode::DIFlags BFlags = StartingFlags;
1640 uint64_t BaseOffset;
Brock Wyma3db2b102018-05-14 21:21:22 +00001641 uint32_t VBPtrOffset = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001642
Aaron Ballman574705e2014-03-13 15:41:46 +00001643 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001644 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1645 // virtual base offset offset is -ve. The code generator emits dwarf
1646 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001647 BaseOffset = 0 - CGM.getItaniumVTableContext()
1648 .getVirtualBaseOffsetOffset(RD, Base)
1649 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001650 } else {
1651 // In the MS ABI, store the vbtable offset, which is analogous to the
1652 // vbase offset offset in Itanium.
1653 BaseOffset =
1654 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001655 VBPtrOffset = CGM.getContext()
1656 .getASTRecordLayout(RD)
1657 .getVBPtrOffset()
1658 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001659 }
Bob Haarmandff36732016-10-25 22:19:32 +00001660 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001661 } else
1662 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1663 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1664 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001665
Adrian Prantl21361fb2014-08-29 22:44:27 +00001666 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001667 llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1668 VBPtrOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001669 EltTys.push_back(DTy);
1670 }
1671}
1672
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001673llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001674CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1675 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001676 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001677 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001678 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1679 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001680 StringRef Name;
1681 if (TPList)
1682 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001683 switch (TA.getKind()) {
1684 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001685 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001686 TemplateParams.push_back(
1687 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001688 } break;
1689 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001690 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001691 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1692 TheCU, Name, TTy,
1693 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001694 } break;
1695 case TemplateArgument::Declaration: {
1696 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001697 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001698 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001699 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001700 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001701 // Variable pointer template parameters have a value that is the address
1702 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001703 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001704 V = CGM.GetAddrOfGlobalVar(VD);
1705 // Member function pointers have special support for building them, though
1706 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001707 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001708 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001709 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001710 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001711 // Member data pointers have special handling too to compute the fixed
1712 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001713 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001714 // These five lines (& possibly the above member function pointer
1715 // handling) might be able to be refactored to use similar code in
1716 // CodeGenModule::getMemberPointerConstant
1717 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1718 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001719 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001720 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001721 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001722 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1723 TheCU, Name, TTy,
1724 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001725 } break;
1726 case TemplateArgument::NullPtr: {
1727 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001728 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001729 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001730 // Special case member data pointer null values since they're actually -1
1731 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001732 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001733 // But treat member function pointers as simple zero integers because
1734 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1735 // CodeGen grows handling for values of non-null member function
1736 // pointers then perhaps we could remove this special case and rely on
1737 // EmitNullMemberPointer for member function pointers.
1738 if (MPT->isMemberDataPointer())
1739 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1740 if (!V)
1741 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001742 TemplateParams.push_back(
1743 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001744 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001745 case TemplateArgument::Template:
1746 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001747 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001748 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1749 break;
1750 case TemplateArgument::Pack:
1751 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1752 TheCU, Name, nullptr,
1753 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1754 break;
David Majnemer5559d472013-08-24 08:21:10 +00001755 case TemplateArgument::Expression: {
1756 const Expr *E = TA.getAsExpr();
1757 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001758 if (E->isGLValue())
1759 T = CGM.getContext().getLValueReferenceType(T);
John McCallde0fe072017-08-15 21:42:52 +00001760 llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001761 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001762 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001763 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001764 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001765 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001766 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001767 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001768 case TemplateArgument::Null:
1769 llvm_unreachable(
1770 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001771 }
1772 }
1773 return DBuilder.getOrCreateArray(TemplateParams);
1774}
1775
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001776llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001777CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001778 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001779 if (FD->getTemplatedKind() ==
1780 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001781 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1782 ->getTemplate()
1783 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001784 return CollectTemplateParams(
1785 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001786 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001787 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001788}
1789
Matthew Voss20165362018-10-03 18:45:04 +00001790llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1791 llvm::DIFile *Unit) {
1792 if (auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL)) {
1793 auto T = TS->getSpecializedTemplateOrPartial();
1794 auto TA = TS->getTemplateArgs().asArray();
1795 // Collect parameters for a partial specialization
1796 if (T.is<VarTemplatePartialSpecializationDecl *>()) {
1797 const TemplateParameterList *TList =
1798 T.get<VarTemplatePartialSpecializationDecl *>()
1799 ->getTemplateParameters();
1800 return CollectTemplateParams(TList, TA, Unit);
1801 }
1802
1803 // Collect parameters for an explicit specialization
1804 if (T.is<VarTemplateDecl *>()) {
1805 const TemplateParameterList *TList = T.get<VarTemplateDecl *>()
1806 ->getTemplateParameters();
1807 return CollectTemplateParams(TList, TA, Unit);
1808 }
1809 }
1810 return llvm::DINodeArray();
1811}
1812
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001813llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1814 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001815 // Always get the full list of parameters, not just the ones from
1816 // the specialization.
1817 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001818 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001819 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001820 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001821}
1822
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001823llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001824 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001825 return VTablePtrType;
1826
1827 ASTContext &Context = CGM.getContext();
1828
1829 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001830 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001831 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001832 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001833 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001834 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1835 Optional<unsigned> DWARFAddressSpace =
1836 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1837
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001838 llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1839 SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001840 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1841 return VTablePtrType;
1842}
1843
Guy Benyei11169dd2012-12-18 14:30:41 +00001844StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001845 // Copy the gdb compatible name on the side and use its reference.
1846 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001847}
1848
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001849void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001850 SmallVectorImpl<llvm::Metadata *> &EltTys,
1851 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001852 // If this class is not dynamic then there is not any vtable info to collect.
1853 if (!RD->isDynamicClass())
1854 return;
1855
Reid Kleckner59812422016-08-31 20:35:01 +00001856 // Don't emit any vtable shape or vptr info if this class doesn't have an
1857 // extendable vfptr. This can happen if the class doesn't have virtual
1858 // methods, or in the MS ABI if those virtual methods only come from virtually
1859 // inherited bases.
1860 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1861 if (!RL.hasExtendableVFPtr())
1862 return;
1863
Reid Klecknerdc124992016-08-31 16:11:43 +00001864 // CodeView needs to know how large the vtable of every dynamic class is, so
1865 // emit a special named pointer type into the element list. The vptr type
1866 // points to this type as well.
1867 llvm::DIType *VPtrTy = nullptr;
1868 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1869 CGM.getTarget().getCXXABI().isMicrosoft();
1870 if (NeedVTableShape) {
1871 uint64_t PtrWidth =
1872 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1873 const VTableLayout &VFTLayout =
1874 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1875 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001876 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001877 unsigned VTableWidth = PtrWidth * VSlotCount;
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001878 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1879 Optional<unsigned> DWARFAddressSpace =
1880 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
Reid Klecknerdc124992016-08-31 16:11:43 +00001881
1882 // Create a very wide void* type and insert it directly in the element list.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001883 llvm::DIType *VTableType = DBuilder.createPointerType(
1884 nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
Reid Klecknerdc124992016-08-31 16:11:43 +00001885 EltTys.push_back(VTableType);
1886
1887 // The vptr is a pointer to this special vtable type.
1888 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1889 }
1890
1891 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001892 if (RL.getPrimaryBase())
1893 return;
1894
1895 if (!VPtrTy)
1896 VPtrTy = getOrCreateVTablePtrType(Unit);
1897
Guy Benyei11169dd2012-12-18 14:30:41 +00001898 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001899 llvm::DIType *VPtrMember =
1900 DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1901 llvm::DINode::FlagArtificial, VPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001902 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001903}
1904
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001905llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001906 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001907 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001908 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001909 return T;
1910}
1911
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001912llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001913 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001914 return getOrCreateStandaloneType(D, Loc);
1915}
1916
1917llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1918 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001919 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001920 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001921 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001922 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001923
Adrian Prantl73409ce2013-03-11 18:33:46 +00001924 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001925 return T;
1926}
1927
David Blaikie483a9da2014-05-06 18:35:21 +00001928void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001929 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001930 return;
1931 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001932 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001933 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001934 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001935 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001936 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001937 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001938 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001939}
1940
David Blaikieb2e86eb2013-08-15 20:49:17 +00001941void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001942 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001943 !CGM.getLangOpts().CPlusPlus)
1944 completeRequiredType(RD);
1945}
1946
David Blaikieb11c8732017-01-30 06:36:08 +00001947/// Return true if the class or any of its methods are marked dllimport.
1948static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1949 if (RD->hasAttr<DLLImportAttr>())
1950 return true;
1951 for (const CXXMethodDecl *MD : RD->methods())
1952 if (MD->hasAttr<DLLImportAttr>())
1953 return true;
1954 return false;
1955}
1956
Adrian Prantla43acdc2017-07-24 23:48:51 +00001957/// Does a type definition exist in an imported clang module?
1958static bool isDefinedInClangModule(const RecordDecl *RD) {
1959 // Only definitions that where imported from an AST file come from a module.
1960 if (!RD || !RD->isFromASTFile())
1961 return false;
1962 // Anonymous entities cannot be addressed. Treat them as not from module.
1963 if (!RD->isExternallyVisible() && RD->getName().empty())
1964 return false;
1965 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1966 if (!CXXDecl->isCompleteDefinition())
1967 return false;
Adrian Prantlba6fdc52018-10-24 00:06:02 +00001968 // Check wether RD is a template.
Adrian Prantla43acdc2017-07-24 23:48:51 +00001969 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1970 if (TemplateKind != TSK_Undeclared) {
Adrian Prantlba6fdc52018-10-24 00:06:02 +00001971 // Unfortunately getOwningModule() isn't accurate enough to find the
1972 // owning module of a ClassTemplateSpecializationDecl that is inside a
1973 // namespace spanning multiple modules.
1974 bool Explicit = false;
1975 if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
1976 Explicit = TD->isExplicitInstantiationOrSpecialization();
1977 if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
1978 return false;
Adrian Prantla43acdc2017-07-24 23:48:51 +00001979 // This is a template, check the origin of the first member.
1980 if (CXXDecl->field_begin() == CXXDecl->field_end())
1981 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1982 if (!CXXDecl->field_begin()->isFromASTFile())
1983 return false;
1984 }
1985 }
1986 return true;
1987}
1988
David Blaikie6943dea2013-08-20 01:28:15 +00001989void CGDebugInfo::completeClassData(const RecordDecl *RD) {
David Blaikieb11c8732017-01-30 06:36:08 +00001990 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1991 if (CXXRD->isDynamicClass() &&
1992 CGM.getVTableLinkage(CXXRD) ==
1993 llvm::GlobalValue::AvailableExternallyLinkage &&
1994 !isClassOrMethodDLLImport(CXXRD))
1995 return;
Adrian Prantla43acdc2017-07-24 23:48:51 +00001996
1997 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1998 return;
1999
David Blaikieb11c8732017-01-30 06:36:08 +00002000 completeClass(RD);
2001}
2002
2003void CGDebugInfo::completeClass(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002004 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00002005 return;
David Blaikie6943dea2013-08-20 01:28:15 +00002006 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00002007 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00002008 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002009 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00002010 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002011 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002012 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002013 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00002014}
2015
David Blaikie0e716b42014-03-03 23:48:23 +00002016static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
2017 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002018 for (CXXMethodDecl *MD : llvm::make_range(I, End))
2019 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00002020 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00002021 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00002022 return true;
2023 return false;
2024}
2025
Benjamin Kramer8c305922016-02-02 11:06:51 +00002026static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2027 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00002028 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00002029 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00002030 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002031
David Blaikie1ac9c982017-04-11 21:13:37 +00002032 if (auto *ES = RD->getASTContext().getExternalSource())
2033 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2034 return true;
2035
Benjamin Kramer8c305922016-02-02 11:06:51 +00002036 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00002037 return false;
2038
2039 if (!LangOpts.CPlusPlus)
2040 return false;
2041
2042 if (!RD->isCompleteDefinitionRequired())
2043 return true;
2044
David Majnemer58ed0f32016-07-17 00:39:12 +00002045 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00002046
2047 if (!CXXDecl)
2048 return false;
2049
Adrian McCarthy99242982016-08-16 22:11:18 +00002050 // Only emit complete debug info for a dynamic class when its vtable is
2051 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00002052 // across DLL boundaries, so skip this optimization if the class or any of its
2053 // methods are marked dllimport. This isn't a complete solution, since objects
2054 // without any dllimport methods can be used in one DLL and constructed in
2055 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00002056 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00002057 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00002058 return true;
2059
2060 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00002061 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00002062 Spec = SD->getSpecializationKind();
2063
2064 if (Spec == TSK_ExplicitInstantiationDeclaration &&
2065 hasExplicitMemberDefinition(CXXDecl->method_begin(),
2066 CXXDecl->method_end()))
2067 return true;
2068
2069 return false;
2070}
2071
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00002072void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2073 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2074 return;
2075
2076 QualType Ty = CGM.getContext().getRecordType(RD);
2077 llvm::DIType *T = getTypeOrNull(Ty);
2078 if (T && T->isForwardDecl())
2079 completeClassData(RD);
2080}
2081
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002082llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002083 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002084 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002085 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2086 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002087 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002088 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002089 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00002090 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002091
David Blaikieb2e86eb2013-08-15 20:49:17 +00002092 return CreateTypeDefinition(Ty);
2093}
2094
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002095llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00002096 RecordDecl *RD = Ty->getDecl();
2097
Guy Benyei11169dd2012-12-18 14:30:41 +00002098 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002099 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002100
2101 // Records and classes and unions can all be recursive. To handle them, we
2102 // first generate a debug descriptor for the struct as a forward declaration.
2103 // Then (if it is a definition) we go through and get debug info for all of
2104 // its members. Finally, we create a descriptor for the complete type (which
2105 // may refer to the forward decl if the struct is recursive) and replace all
2106 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002107 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002108
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002109 const RecordDecl *D = RD->getDefinition();
2110 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002111 return FwdDecl;
2112
David Majnemer58ed0f32016-07-17 00:39:12 +00002113 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00002114 CollectContainingType(CXXDecl, FwdDecl);
2115
Guy Benyei11169dd2012-12-18 14:30:41 +00002116 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002117 LexicalBlockStack.emplace_back(&*FwdDecl);
2118 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002119
Guy Benyei11169dd2012-12-18 14:30:41 +00002120 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002121 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00002122 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00002123
2124 // Note: The split of CXXDecl information here is intentional, the
2125 // gdb tests will depend on a certain ordering at printout. The debug
2126 // information offsets are still correct if we merge them all together
2127 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00002128 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002129 if (CXXDecl) {
2130 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00002131 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002132 }
2133
Eric Christopher91a31902013-01-16 01:22:32 +00002134 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00002135 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00002136 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00002137 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002138
2139 LexicalBlockStack.pop_back();
2140 RegionMap.erase(Ty->getDecl());
2141
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002142 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002143 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002144
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002145 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002146 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002147 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002148
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002149 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002150 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002151}
2152
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002153llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2154 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002155 // Ignore protocols.
2156 return getOrCreateType(Ty->getBaseType(), Unit);
2157}
2158
Manman Rene6be26c2016-09-13 17:25:08 +00002159llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2160 llvm::DIFile *Unit) {
2161 // Ignore protocols.
2162 SourceLocation Loc = Ty->getDecl()->getLocation();
2163
2164 // Use Typedefs to represent ObjCTypeParamType.
2165 return DBuilder.createTypedef(
2166 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2167 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2168 getDeclContextDescriptor(Ty->getDecl()));
2169}
2170
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002171/// \return true if Getter has the default name for the property PD.
2172static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2173 const ObjCMethodDecl *Getter) {
2174 assert(PD);
2175 if (!Getter)
2176 return true;
2177
2178 assert(Getter->getDeclName().isObjCZeroArgSelector());
2179 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002180 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002181}
2182
2183/// \return true if Setter has the default name for the property PD.
2184static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2185 const ObjCMethodDecl *Setter) {
2186 assert(PD);
2187 if (!Setter)
2188 return true;
2189
2190 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00002191 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002192 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002193}
2194
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002195llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2196 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002197 ObjCInterfaceDecl *ID = Ty->getDecl();
2198 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002199 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002200
Adrian Prantl50fd1a82016-04-20 23:59:32 +00002201 // Return a forward declaration if this type was imported from a clang module,
2202 // and this is not the compile unit with the implementation of the type (which
2203 // may contain hidden ivars).
2204 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2205 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002206 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2207 ID->getName(),
2208 getDeclContextDescriptor(ID), Unit, 0);
2209
Guy Benyei11169dd2012-12-18 14:30:41 +00002210 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002211 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002212 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002213 auto RuntimeLang =
2214 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00002215
2216 // If this is just a forward declaration return a special forward-declaration
2217 // debug type since we won't be able to lay out the entire type.
2218 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00002219 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002220 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002221 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002222 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2223 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00002224 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002225 return FwdDecl;
2226 }
2227
David Blaikieef8a9512014-05-05 23:23:53 +00002228 return CreateTypeDefinition(Ty, Unit);
2229}
2230
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002231llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00002232CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2233 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00002234 // Use the Module pointer as the key into the cache. This is a
2235 // nullptr if the "Module" is a PCH, which is safe because we don't
2236 // support chained PCH debug info, so there can only be a single PCH.
2237 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002238 auto ModRef = ModuleCache.find(M);
2239 if (ModRef != ModuleCache.end())
2240 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00002241
2242 // Macro definitions that were defined with "-D" on the command line.
2243 SmallString<128> ConfigMacros;
2244 {
2245 llvm::raw_svector_ostream OS(ConfigMacros);
2246 const auto &PPOpts = CGM.getPreprocessorOpts();
2247 unsigned I = 0;
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002248 // Translate the macro definitions back into a command line.
Adrian Prantl2388ead2015-06-30 18:01:05 +00002249 for (auto &M : PPOpts.Macros) {
2250 if (++I > 1)
2251 OS << " ";
2252 const std::string &Macro = M.first;
2253 bool Undef = M.second;
2254 OS << "\"-" << (Undef ? 'U' : 'D');
2255 for (char c : Macro)
2256 switch (c) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002257 case '\\':
2258 OS << "\\\\";
2259 break;
2260 case '"':
2261 OS << "\\\"";
2262 break;
2263 default:
2264 OS << c;
Adrian Prantl2388ead2015-06-30 18:01:05 +00002265 }
2266 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002267 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002268 }
Adrian Prantl66689202015-09-18 23:01:45 +00002269
Adrian Prantl835e6632015-09-24 16:10:10 +00002270 bool IsRootModule = M ? !M->Parent : true;
2271 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002272 // PCH files don't have a signature field in the control block,
2273 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00002274 // We use the lower 64 bits for debug info.
2275 uint64_t Signature =
2276 Mod.getSignature()
2277 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2278 : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002279 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002280 DIB.createCompileUnit(TheCU->getSourceLanguage(),
Scott Lindera2fbcef2018-02-26 17:32:31 +00002281 // TODO: Support "Source" from external AST providers?
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002282 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2283 TheCU->getProducer(), true, StringRef(), 0,
2284 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2285 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002286 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002287 }
Adrian Prantl835e6632015-09-24 16:10:10 +00002288 llvm::DIModule *Parent =
2289 IsRootModule ? nullptr
2290 : getOrCreateModuleRef(
2291 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2292 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002293 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002294 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2295 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002296 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002297 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002298}
2299
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002300llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2301 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002302 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002303 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002304 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002305 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002306
2307 // Bit size, align and offset of the type.
2308 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002309 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002310
Leny Kholodov80c047d2016-09-06 10:48:04 +00002311 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002312 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002313 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002314
Adrian Prantlfd696112015-10-01 00:48:51 +00002315 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002316 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002317 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2318 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002319
David Blaikieef8a9512014-05-05 23:23:53 +00002320 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002321 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002322
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002323 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002324 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002325 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002326
2327 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002328 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002329
2330 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2331 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002332 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002333 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002334 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002335 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002336
Brock Wyma3db2b102018-05-14 21:21:22 +00002337 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002338 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002339 EltTys.push_back(InhTag);
2340 }
2341
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002342 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002343 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002344 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002345 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002346 unsigned PLine = getLineNumber(Loc);
2347 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2348 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002349 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2350 PD->getName(), PUnit, PLine,
2351 hasDefaultGetterName(PD, Getter) ? ""
2352 : getSelectorName(PD->getGetterName()),
2353 hasDefaultSetterName(PD, Setter) ? ""
2354 : getSelectorName(PD->getSetterName()),
2355 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002356 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002357 };
2358 {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002359 llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002360 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002361 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002362 PropertySet.insert(PD->getIdentifier());
2363 AddProperty(PD);
2364 }
Manman Renefe1bac2016-01-27 20:00:32 +00002365 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002366 // Don't emit duplicate metadata for properties that were already in a
2367 // class extension.
2368 if (!PropertySet.insert(PD->getIdentifier()).second)
2369 continue;
2370 AddProperty(PD);
2371 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002372 }
2373
2374 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2375 unsigned FieldNo = 0;
2376 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2377 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002378 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002379 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002380 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002381
Guy Benyei11169dd2012-12-18 14:30:41 +00002382 StringRef FieldName = Field->getName();
2383
2384 // Ignore unnamed fields.
2385 if (FieldName.empty())
2386 continue;
2387
2388 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002389 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002390 unsigned FieldLine = getLineNumber(Field->getLocation());
2391 QualType FType = Field->getType();
2392 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002393 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002394
2395 if (!FType->isIncompleteArrayType()) {
2396
2397 // Bit size, align and offset of the type.
2398 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002399 ? Field->getBitWidthValue(CGM.getContext())
2400 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002401 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 }
2403
2404 uint64_t FieldOffset;
2405 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2406 // We don't know the runtime offset of an ivar if we're using the
2407 // non-fragile ABI. For bitfields, use the bit offset into the first
2408 // byte of storage of the bitfield. For other fields, use zero.
2409 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002410 FieldOffset =
2411 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002412 FieldOffset %= CGM.getContext().getCharWidth();
2413 } else {
2414 FieldOffset = 0;
2415 }
2416 } else {
2417 FieldOffset = RL.getFieldOffset(FieldNo);
2418 }
2419
Leny Kholodov80c047d2016-09-06 10:48:04 +00002420 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002421 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002422 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002423 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002424 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002425 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002426 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002427
Craig Topper8a13c412014-05-21 05:09:00 +00002428 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002429 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002430 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002431 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002432 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002433 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002434 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002435 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002436 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2437 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002438 PropertyNode = DBuilder.createObjCProperty(
2439 PD->getName(), PUnit, PLine,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002440 hasDefaultGetterName(PD, Getter)
2441 ? ""
2442 : getSelectorName(PD->getGetterName()),
2443 hasDefaultSetterName(PD, Setter)
2444 ? ""
2445 : getSelectorName(PD->getSetterName()),
Eric Christophere7b87e52014-10-26 23:40:33 +00002446 PD->getPropertyAttributes(),
2447 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002448 }
2449 }
2450 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002451 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2452 FieldSize, FieldAlign, FieldOffset, Flags,
2453 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002454 EltTys.push_back(FieldTy);
2455 }
2456
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002457 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002458 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002459
Guy Benyei11169dd2012-12-18 14:30:41 +00002460 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002461 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002462}
2463
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002464llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2465 llvm::DIFile *Unit) {
2466 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002467 int64_t Count = Ty->getNumElements();
Guy Benyei11169dd2012-12-18 14:30:41 +00002468
Sander de Smalen891af03a2018-02-03 13:55:59 +00002469 llvm::Metadata *Subscript;
2470 QualType QTy(Ty, 0);
2471 auto SizeExpr = SizeExprCache.find(QTy);
2472 if (SizeExpr != SizeExprCache.end())
2473 Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2474 else
2475 Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002476 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002477
2478 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002479 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002480
2481 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2482}
2483
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002484llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002485 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002486 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002487
2488 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002489 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002490 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002491 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2492 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002493 } else if (Ty->isIncompleteArrayType()) {
2494 Size = 0;
2495 if (Ty->getElementType()->isIncompleteType())
2496 Align = 0;
2497 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002498 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002499 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002500 Size = 0;
2501 Align = 0;
2502 } else {
2503 // Size and align of the whole array, not the element type.
2504 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002505 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002506 }
2507
2508 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2509 // interior arrays, do we care? Why aren't nested arrays represented the
2510 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002511 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002512 QualType EltTy(Ty, 0);
2513 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2514 // If the number of elements is known, then count is that number. Otherwise,
2515 // it's -1. This allows us to represent a subrange with an array of 0
2516 // elements, like this:
2517 //
2518 // struct foo {
2519 // int x[0];
2520 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002521 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002522 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002523 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002524 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002525 if (Expr *Size = VAT->getSizeExpr()) {
Fangrui Song407659a2018-11-30 23:41:18 +00002526 Expr::EvalResult Result;
2527 if (Size->EvaluateAsInt(Result, CGM.getContext()))
2528 Count = Result.Val.getInt().getExtValue();
Eli Friedman01d6b962016-10-19 22:16:32 +00002529 }
David Blaikie87173f12016-08-22 17:49:56 +00002530 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002531
Sander de Smalen891af03a2018-02-03 13:55:59 +00002532 auto SizeNode = SizeExprCache.find(EltTy);
2533 if (SizeNode != SizeExprCache.end())
2534 Subscripts.push_back(
2535 DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2536 else
2537 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 EltTy = Ty->getElementType();
2539 }
2540
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002541 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002542
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002543 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2544 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002545}
2546
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002547llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2548 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002549 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2550 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002551}
2552
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002553llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2554 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002555 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2556 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002557}
2558
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002559llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2560 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002561 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002562 uint64_t Size = 0;
2563
2564 if (!Ty->isIncompleteType()) {
2565 Size = CGM.getContext().getTypeSize(Ty);
2566
2567 // Set the MS inheritance model. There is no flag for the unspecified model.
2568 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2569 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2570 case MSInheritanceAttr::Keyword_single_inheritance:
2571 Flags |= llvm::DINode::FlagSingleInheritance;
2572 break;
2573 case MSInheritanceAttr::Keyword_multiple_inheritance:
2574 Flags |= llvm::DINode::FlagMultipleInheritance;
2575 break;
2576 case MSInheritanceAttr::Keyword_virtual_inheritance:
2577 Flags |= llvm::DINode::FlagVirtualInheritance;
2578 break;
2579 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2580 break;
2581 }
2582 }
2583 }
2584
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002585 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002586 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002587 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002588 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2589 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002590
2591 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002592 Ty->getPointeeType()->getAs<FunctionProtoType>();
2593 return DBuilder.createMemberPointerType(
2594 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2595 Ty->getClass(), FPT->getTypeQuals())),
2596 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002597 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002598}
2599
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002600llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002601 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2602 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002603}
2604
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002605llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
Xiuli Pan9c14e282016-01-09 12:53:17 +00002606 return getOrCreateType(Ty->getElementType(), U);
2607}
2608
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002609llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002610 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002611
Guy Benyei11169dd2012-12-18 14:30:41 +00002612 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002613 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002614 if (!ED->getTypeForDecl()->isIncompleteType()) {
2615 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002616 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002617 }
2618
Brock Wyma8557ec52018-05-22 12:41:19 +00002619 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002620
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002621 bool isImportedFromModule =
2622 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2623
Guy Benyei11169dd2012-12-18 14:30:41 +00002624 // If this is just a forward declaration, construct an appropriately
2625 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002626 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002627 // Note that it is possible for enums to be created as part of
2628 // their own declcontext. In this case a FwdDecl will be created
2629 // twice. This doesn't cause a problem because both FwdDecls are
2630 // entered into the ReplaceMap: finalize() will replace the first
2631 // FwdDecl with the second and then replace the second with
2632 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002633 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002634 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002635 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2636 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002637
Guy Benyei11169dd2012-12-18 14:30:41 +00002638 unsigned Line = getLineNumber(ED->getLocation());
2639 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002640 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002641 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
Brock Wyma8557ec52018-05-22 12:41:19 +00002642 0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
Adrian Prantla40030f2016-02-06 01:59:09 +00002643
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002644 ReplaceMap.emplace_back(
2645 std::piecewise_construct, std::make_tuple(Ty),
2646 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002647 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002648 }
2649
David Blaikie483a9da2014-05-06 18:35:21 +00002650 return CreateTypeDefinition(Ty);
2651}
2652
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002653llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002654 const EnumDecl *ED = Ty->getDecl();
2655 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002656 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002657 if (!ED->getTypeForDecl()->isIncompleteType()) {
2658 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002659 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002660 }
2661
Brock Wyma8557ec52018-05-22 12:41:19 +00002662 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
David Blaikie483a9da2014-05-06 18:35:21 +00002663
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002664 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002665 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002666 ED = ED->getDefinition();
Momchil Velikov25f6be52018-02-12 16:12:52 +00002667 bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002668 for (const auto *Enum : ED->enumerators()) {
Momchil Velikov25f6be52018-02-12 16:12:52 +00002669 const auto &InitVal = Enum->getInitVal();
2670 auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2671 Enumerators.push_back(
2672 DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
Guy Benyei11169dd2012-12-18 14:30:41 +00002673 }
2674
2675 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002676 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002677
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002678 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002679 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002680 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Momchil Velikov25f6be52018-02-12 16:12:52 +00002681 llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002682 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2683 Line, Size, Align, EltArray, ClassTy,
Brock Wyma8557ec52018-05-22 12:41:19 +00002684 Identifier, ED->isFixed());
Guy Benyei11169dd2012-12-18 14:30:41 +00002685}
2686
Amjad Aboud546bc112017-02-09 22:07:24 +00002687llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2688 unsigned MType, SourceLocation LineLoc,
2689 StringRef Name, StringRef Value) {
2690 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2691 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2692}
2693
2694llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2695 SourceLocation LineLoc,
2696 SourceLocation FileLoc) {
2697 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2698 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2699 return DBuilder.createTempMacroFile(Parent, Line, FName);
2700}
2701
David Blaikie05491062013-01-21 04:37:12 +00002702static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2703 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002704 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002705 Qualifiers InnerQuals = T.getLocalQualifiers();
2706 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2707 // that is already there.
2708 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2709 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002710 QualType LastT = T;
2711 switch (T->getTypeClass()) {
2712 default:
David Blaikie05491062013-01-21 04:37:12 +00002713 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002714 case Type::TemplateSpecialization: {
2715 const auto *Spec = cast<TemplateSpecializationType>(T);
2716 if (Spec->isTypeAlias())
2717 return C.getQualifiedType(T.getTypePtr(), Quals);
2718 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002719 break;
2720 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002721 case Type::TypeOfExpr:
2722 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2723 break;
2724 case Type::TypeOf:
2725 T = cast<TypeOfType>(T)->getUnderlyingType();
2726 break;
2727 case Type::Decltype:
2728 T = cast<DecltypeType>(T)->getUnderlyingType();
2729 break;
2730 case Type::UnaryTransform:
2731 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2732 break;
2733 case Type::Attributed:
2734 T = cast<AttributedType>(T)->getEquivalentType();
2735 break;
2736 case Type::Elaborated:
2737 T = cast<ElaboratedType>(T)->getNamedType();
2738 break;
2739 case Type::Paren:
2740 T = cast<ParenType>(T)->getInnerType();
2741 break;
David Blaikie05491062013-01-21 04:37:12 +00002742 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002743 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002744 break;
Richard Smitha0abc422017-02-22 00:13:14 +00002745 case Type::Auto:
2746 case Type::DeducedTemplateSpecialization: {
2747 QualType DT = cast<DeducedType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002748 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002749 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002750 break;
2751 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002752 case Type::Adjusted:
2753 case Type::Decayed:
2754 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2755 T = cast<AdjustedType>(T)->getAdjustedType();
2756 break;
2757 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002758
Guy Benyei11169dd2012-12-18 14:30:41 +00002759 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002760 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002761 } while (true);
2762}
2763
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002764llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002765
2766 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002767 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002768
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002769 auto It = TypeCache.find(Ty.getAsOpaquePtr());
2770 if (It != TypeCache.end()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002771 // Verify that the debug info still exists.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002772 if (llvm::Metadata *V = It->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002773 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002774 }
2775
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002776 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002777}
2778
David Blaikie0e716b42014-03-03 23:48:23 +00002779void CGDebugInfo::completeTemplateDefinition(
2780 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002781 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002782 return;
David Blaikie1ac9c982017-04-11 21:13:37 +00002783 completeUnusedClass(SD);
2784}
David Blaikie0856f662014-03-04 22:01:08 +00002785
David Blaikie1ac9c982017-04-11 21:13:37 +00002786void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2787 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2788 return;
2789
2790 completeClassData(&D);
David Blaikie0e716b42014-03-03 23:48:23 +00002791 // In case this type has no member function definitions being emitted, ensure
2792 // it is retained
David Blaikie1ac9c982017-04-11 21:13:37 +00002793 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
David Blaikie0e716b42014-03-03 23:48:23 +00002794}
2795
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002796llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002797 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002798 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002799
2800 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002801 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002802
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002803 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002804 return T;
2805
Adrian Prantlca844182015-09-11 17:23:03 +00002806 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002807 void *TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002808
2809 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002810 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002811
Guy Benyei11169dd2012-12-18 14:30:41 +00002812 return Res;
2813}
2814
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002815llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002816 // A forward declaration inside a module header does not belong to the module.
2817 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2818 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002819 if (DebugTypeExtRefs && D->isFromASTFile()) {
2820 // Record a reference to an imported clang module or precompiled header.
2821 auto *Reader = CGM.getContext().getExternalSource();
2822 auto Idx = D->getOwningModuleID();
2823 auto Info = Reader->getSourceDescriptor(Idx);
2824 if (Info)
2825 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2826 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002827 // We are building a clang module or a precompiled header.
2828 //
2829 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2830 // and it wouldn't be necessary to specify the parent scope
2831 // because the type is already unique by definition (it would look
2832 // like the output of -fno-standalone-debug). On the other hand,
2833 // the parent scope helps a consumer to quickly locate the object
2834 // file where the type's definition is located, so it might be
2835 // best to make this behavior a command line or debugger tuning
2836 // option.
Richard Smith54f04402017-05-18 02:29:20 +00002837 if (Module *M = D->getOwningModule()) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002838 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002839 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2840 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002841 } else {
2842 // This the precompiled header being built.
2843 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002844 }
2845 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002846
Adrian Prantl9402cef2015-09-20 16:51:35 +00002847 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002848}
2849
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002850llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002851 // Handle qualifiers, which recursively handles what they refer to.
2852 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002853 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002854
Guy Benyei11169dd2012-12-18 14:30:41 +00002855 // Work out details of type.
2856 switch (Ty->getTypeClass()) {
2857#define TYPE(Class, Base)
2858#define ABSTRACT_TYPE(Class, Base)
2859#define NON_CANONICAL_TYPE(Class, Base)
2860#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2861#include "clang/AST/TypeNodes.def"
2862 llvm_unreachable("Dependent types cannot show up in debug information");
2863
2864 case Type::ExtVector:
2865 case Type::Vector:
2866 return CreateType(cast<VectorType>(Ty), Unit);
2867 case Type::ObjCObjectPointer:
2868 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2869 case Type::ObjCObject:
2870 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002871 case Type::ObjCTypeParam:
2872 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002873 case Type::ObjCInterface:
2874 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2875 case Type::Builtin:
2876 return CreateType(cast<BuiltinType>(Ty));
2877 case Type::Complex:
2878 return CreateType(cast<ComplexType>(Ty));
2879 case Type::Pointer:
2880 return CreateType(cast<PointerType>(Ty), Unit);
2881 case Type::BlockPointer:
2882 return CreateType(cast<BlockPointerType>(Ty), Unit);
2883 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002884 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002885 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002886 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002887 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002888 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002889 case Type::FunctionProto:
2890 case Type::FunctionNoProto:
2891 return CreateType(cast<FunctionType>(Ty), Unit);
2892 case Type::ConstantArray:
2893 case Type::VariableArray:
2894 case Type::IncompleteArray:
2895 return CreateType(cast<ArrayType>(Ty), Unit);
2896
2897 case Type::LValueReference:
2898 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2899 case Type::RValueReference:
2900 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2901
2902 case Type::MemberPointer:
2903 return CreateType(cast<MemberPointerType>(Ty), Unit);
2904
2905 case Type::Atomic:
2906 return CreateType(cast<AtomicType>(Ty), Unit);
2907
Xiuli Pan9c14e282016-01-09 12:53:17 +00002908 case Type::Pipe:
2909 return CreateType(cast<PipeType>(Ty), Unit);
2910
Guy Benyei11169dd2012-12-18 14:30:41 +00002911 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002912 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2913
David Blaikie42edade2014-11-11 20:44:45 +00002914 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002915 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00002916 case Type::Adjusted:
2917 case Type::Decayed:
Richard Smith600b5262017-01-26 20:40:47 +00002918 case Type::DeducedTemplateSpecialization:
Guy Benyei11169dd2012-12-18 14:30:41 +00002919 case Type::Elaborated:
2920 case Type::Paren:
2921 case Type::SubstTemplateTypeParm:
2922 case Type::TypeOfExpr:
2923 case Type::TypeOf:
2924 case Type::Decltype:
2925 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002926 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002927 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002928 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002929
David Blaikie42edade2014-11-11 20:44:45 +00002930 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002931}
2932
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002933llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2934 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002935 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002936
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002937 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002938
2939 // We may have cached a forward decl when we could have created
2940 // a non-forward decl. Go ahead and create a non-forward decl
2941 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002942 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002943 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002944
2945 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002946 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002947
2948 // Propagate members from the declaration to the definition
2949 // CreateType(const RecordType*) will overwrite this with the members in the
2950 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002951 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002952
Guy Benyei11169dd2012-12-18 14:30:41 +00002953 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002954 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002955 return Res;
2956}
2957
2958// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002959llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002960 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002961
Guy Benyei11169dd2012-12-18 14:30:41 +00002962 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002963 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002964 unsigned Line = getLineNumber(RD->getLocation());
2965 StringRef RDName = getClassName(RD);
2966
Amjad Abouddc4531e2016-04-30 01:44:38 +00002967 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002968
David Blaikied2785892013-08-18 17:36:19 +00002969 // If we ended up creating the type during the context chain construction,
2970 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002971 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002972 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002973 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002974 return T;
David Blaikied2785892013-08-18 17:36:19 +00002975
Adrian Prantl381e7552014-02-04 21:29:50 +00002976 // If this is just a forward or incomplete declaration, construct an
2977 // appropriately marked node and just return it.
2978 const RecordDecl *D = RD->getDefinition();
2979 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002980 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002981
2982 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002983 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002984
Brock Wyma8557ec52018-05-22 12:41:19 +00002985 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002986
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00002987 // Explicitly record the calling convention for C++ records.
2988 auto Flags = llvm::DINode::FlagZero;
2989 if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
2990 if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
2991 Flags |= llvm::DINode::FlagTypePassByReference;
2992 else
2993 Flags |= llvm::DINode::FlagTypePassByValue;
Aaron Smith044326c2018-07-23 20:49:07 +00002994
2995 // Record if a C++ record is trivial type.
2996 if (CXXRD->isTrivial())
2997 Flags |= llvm::DINode::FlagTrivial;
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00002998 }
2999
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003000 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00003001 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +00003002 Flags, Identifier);
Guy Benyei11169dd2012-12-18 14:30:41 +00003003
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003004 // Elements of composite types usually have back to the type, creating
3005 // uniquing cycles. Distinct nodes are more efficient.
3006 switch (RealDecl->getTag()) {
3007 default:
3008 llvm_unreachable("invalid composite type tag");
3009
3010 case llvm::dwarf::DW_TAG_array_type:
3011 case llvm::dwarf::DW_TAG_enumeration_type:
3012 // Array elements and most enumeration elements don't have back references,
3013 // so they don't tend to be involved in uniquing cycles and there is some
3014 // chance of merging them when linking together two modules. Only make
3015 // them distinct if they are ODR-uniqued.
Brock Wyma8557ec52018-05-22 12:41:19 +00003016 if (Identifier.empty())
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003017 break;
Galina Kistanova0872d6c2017-06-03 06:30:46 +00003018 LLVM_FALLTHROUGH;
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003019
3020 case llvm::dwarf::DW_TAG_structure_type:
3021 case llvm::dwarf::DW_TAG_union_type:
3022 case llvm::dwarf::DW_TAG_class_type:
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003023 // Immediately resolve to a distinct node.
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003024 RealDecl =
3025 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3026 break;
3027 }
3028
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003029 RegionMap[Ty->getDecl()].reset(RealDecl);
3030 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003031
David Majnemer58ed0f32016-07-17 00:39:12 +00003032 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003033 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00003034 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00003035 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00003036}
3037
David Blaikieadfbf992013-08-18 16:55:33 +00003038void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003039 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00003040 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003041 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00003042 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3043 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00003044 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00003045 while (1) {
3046 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3047 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3048 if (PBT && !BRL.isPrimaryBaseVirtual())
3049 PBase = PBT;
3050 else
3051 break;
3052 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003053 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00003054 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3055 getOrCreateFile(RD->getLocation())));
3056 } else if (RD->isDynamicClass())
3057 ContainingType = RealDecl;
3058
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00003059 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00003060}
3061
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003062llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003063 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003064 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003065 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00003066 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003067 llvm::DIType *Ty =
3068 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3069 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003070 *Offset += FieldSize;
3071 return Ty;
3072}
3073
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003074void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00003075 StringRef &Name,
3076 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003077 llvm::DIScope *&FDContext,
3078 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003079 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003080 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00003081 Name = getFunctionName(FD);
3082 // Use mangled name as linkage name for C/C++ functions.
3083 if (FD->hasPrototype()) {
3084 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003085 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00003086 }
3087 // No need to replicate the linkage name if it isn't different from the
3088 // subprogram name, no need to have it at all unless coverage is enabled or
Dehao Chenb3a70de2017-01-19 00:44:21 +00003089 // debug is set to more than just line tables or extra debug info is needed.
Benjamin Kramer8c305922016-02-02 11:06:51 +00003090 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3091 !CGM.getCodeGenOpts().EmitGcovNotes &&
Dehao Chenb3a70de2017-01-19 00:44:21 +00003092 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
Benjamin Kramer8c305922016-02-02 11:06:51 +00003093 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00003094 LinkageName = StringRef();
3095
Benjamin Kramer8c305922016-02-02 11:06:51 +00003096 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003097 if (const NamespaceDecl *NSDecl =
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003098 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Adrian Prantlddb8e062017-05-12 16:23:53 +00003099 FDContext = getOrCreateNamespace(NSDecl);
Frederic Riss9db79f12014-11-18 03:40:46 +00003100 else if (const RecordDecl *RDecl =
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003101 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003102 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3103 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3104 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00003105 // Check if it is a noreturn-marked function
3106 if (FD->isNoReturn())
3107 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00003108 // Collect template parameters.
3109 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3110 }
3111}
3112
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003113void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00003114 unsigned &LineNo, QualType &T,
3115 StringRef &Name, StringRef &LinkageName,
Matthew Voss20165362018-10-03 18:45:04 +00003116 llvm::MDTuple *&TemplateParameters,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003117 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003118 Unit = getOrCreateFile(VD->getLocation());
3119 LineNo = getLineNumber(VD->getLocation());
3120
3121 setLocation(VD->getLocation());
3122
3123 T = VD->getType();
3124 if (T->isIncompleteArrayType()) {
3125 // CodeGen turns int[] into int[1] so we'll do the same here.
3126 llvm::APInt ConstVal(32, 1);
3127 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3128
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003129 T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3130 0);
Frederic Riss9db79f12014-11-18 03:40:46 +00003131 }
3132
3133 Name = VD->getName();
3134 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3135 !isa<ObjCMethodDecl>(VD->getDeclContext()))
3136 LinkageName = CGM.getMangledName(VD);
3137 if (LinkageName == Name)
3138 LinkageName = StringRef();
3139
Matthew Voss20165362018-10-03 18:45:04 +00003140 if (isa<VarTemplateSpecializationDecl>(VD)) {
3141 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3142 TemplateParameters = parameterNodes.get();
3143 } else {
3144 TemplateParameters = nullptr;
3145 }
3146
Frederic Riss9db79f12014-11-18 03:40:46 +00003147 // Since we emit declarations (DW_AT_members) for static members, place the
3148 // definition of those static members in the namespace they were declared in
3149 // in the source code (the lexical decl context).
3150 // FIXME: Generalize this for even non-member global variables where the
3151 // declaration and definition may have different lexical decl contexts, once
3152 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003153 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3154 : VD->getDeclContext();
3155 // When a record type contains an in-line initialization of a static data
3156 // member, and the record type is marked as __declspec(dllexport), an implicit
3157 // definition of the member will be created in the record context. DWARF
3158 // doesn't seem to have a nice way to describe this in a form that consumers
3159 // are likely to understand, so fake the "normal" situation of a definition
3160 // outside the class by putting it in the global scope.
3161 if (DC->isRecord())
3162 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003163
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003164 llvm::DIScope *Mod = getParentModuleOrNull(VD);
3165 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00003166}
3167
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003168llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3169 bool Stub) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003170 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00003171 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003172 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Paul Robinsoncda54212018-11-19 18:29:28 +00003173 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003174 SourceLocation Loc = GD.getDecl()->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003175 llvm::DIFile *Unit = getOrCreateFile(Loc);
3176 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003177 unsigned Line = getLineNumber(Loc);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003178 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3179 Flags);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003180 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3181
Frederic Rissd253ed62014-11-18 03:40:51 +00003182 // Build function type.
3183 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003184 if (FD)
3185 for (const ParmVarDecl *Parm : FD->parameters())
3186 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00003187 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3188 QualType FnType = CGM.getContext().getFunctionType(
3189 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Paul Robinsoncda54212018-11-19 18:29:28 +00003190 if (!FD->isExternallyVisible())
3191 SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3192 if (CGM.getLangOpts().Optimize)
3193 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3194
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003195 if (Stub) {
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003196 Flags |= getCallSiteRelatedAttrs();
Paul Robinsoncda54212018-11-19 18:29:28 +00003197 SPFlags |= llvm::DISubprogram::SPFlagDefinition;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003198 return DBuilder.createFunction(
3199 DContext, Name, LinkageName, Unit, Line,
Paul Robinsoncda54212018-11-19 18:29:28 +00003200 getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003201 TParamsArray.get(), getFunctionDeclaration(FD));
3202 }
3203
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003204 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003205 DContext, Name, LinkageName, Unit, Line,
Paul Robinsoncda54212018-11-19 18:29:28 +00003206 getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003207 TParamsArray.get(), getFunctionDeclaration(FD));
George Burgess IV00f70bd2018-03-01 05:43:23 +00003208 const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003209 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3210 std::make_tuple(CanonDecl),
3211 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00003212 return SP;
3213}
3214
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003215llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003216 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3217}
3218
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003219llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003220 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3221}
3222
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003223llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00003224CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3225 QualType T;
3226 StringRef Name, LinkageName;
3227 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003228 llvm::DIFile *Unit = getOrCreateFile(Loc);
3229 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003230 unsigned Line = getLineNumber(Loc);
Matthew Voss20165362018-10-03 18:45:04 +00003231 llvm::MDTuple *TemplateParameters = nullptr;
Frederic Rissd253ed62014-11-18 03:40:51 +00003232
Matthew Voss20165362018-10-03 18:45:04 +00003233 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3234 DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00003235 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003236 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3237 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Matthew Voss20165362018-10-03 18:45:04 +00003238 !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003239 FwdDeclReplaceMap.emplace_back(
3240 std::piecewise_construct,
3241 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3242 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003243 return GV;
3244}
3245
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003246llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003247 // We only need a declaration (not a definition) of the type - so use whatever
3248 // we would otherwise do to get a type for a pointee. (forward declarations in
3249 // limited debug info, full definitions (if the type definition is available)
3250 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00003251 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00003252 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00003253 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003254 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00003255
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003256 if (I != DeclCache.end()) {
3257 auto N = I->second;
3258 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3259 return GVE->getVariable();
3260 return dyn_cast_or_null<llvm::DINode>(N);
3261 }
Frederic Rissd253ed62014-11-18 03:40:51 +00003262
3263 // No definition for now. Emit a forward definition that might be
3264 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00003265 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00003266 return getFunctionForwardDeclaration(FD);
3267 else if (const auto *VD = dyn_cast<VarDecl>(D))
3268 return getGlobalVariableForwardDeclaration(VD);
3269
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003270 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00003271}
3272
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003273llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003274 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003275 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00003276
David Majnemer58ed0f32016-07-17 00:39:12 +00003277 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00003278 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003279 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003280
3281 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003282 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003283
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003284 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00003285 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003286 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003287 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003288 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00003289 }
3290 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003291 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003292 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003293 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003294 return SP;
3295 }
3296
Aaron Ballman86c93902014-03-06 23:45:36 +00003297 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003298 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003299 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003300 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003301 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003302 return SP;
3303 }
3304 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003305 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003306}
3307
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003308// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00003309// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003310llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003311 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003312 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003313 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003314 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3315 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00003316 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00003317
David Majnemer58ed0f32016-07-17 00:39:12 +00003318 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00003319 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00003320
3321 const auto *FTy = FnType->getAs<FunctionType>();
3322 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3323
David Majnemer58ed0f32016-07-17 00:39:12 +00003324 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003325 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003326 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00003327
3328 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00003329 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00003330
3331 // Replace the instancetype keyword with the actual type.
3332 if (ResultTy == CGM.getContext().getObjCInstanceType())
3333 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00003334 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00003335
Adrian Prantl7bec9032013-05-10 21:08:31 +00003336 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003337 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003338 QualType SelfDeclTy;
3339 if (auto *SelfDecl = OMethod->getSelfDecl())
3340 SelfDeclTy = SelfDecl->getType();
3341 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3342 if (FPT->getNumParams() > 1)
3343 SelfDeclTy = FPT->getParamType(0);
3344 if (!SelfDeclTy.isNull())
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003345 Elts.push_back(
3346 CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003347 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003348 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003349 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003350 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003351 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003352 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003353 // Variadic methods need a special marker at the end of the type list.
3354 if (OMethod->isVariadic())
3355 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003356
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003357 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003358 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3359 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003360 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003361
Adrian Prantl800faef2014-02-25 23:42:18 +00003362 // Handle variadic function types; they need an additional
3363 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003364 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003365 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003366 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003367 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003368 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3369 for (QualType ParamType : FPT->param_types())
3370 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003371 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003372 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003373 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3374 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003375 }
3376
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003377 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003378}
3379
Eric Christophere7b87e52014-10-26 23:40:33 +00003380void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3381 SourceLocation ScopeLoc, QualType FnType,
Brock Wyma94ece8f2018-04-16 16:53:57 +00003382 llvm::Function *Fn, bool CurFuncIsThunk,
3383 CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003384
3385 StringRef Name;
3386 StringRef LinkageName;
3387
3388 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3389
3390 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003391 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003392
Leny Kholodov80c047d2016-09-06 10:48:04 +00003393 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Paul Robinsoncda54212018-11-19 18:29:28 +00003394 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003395 llvm::DIFile *Unit = getOrCreateFile(Loc);
3396 llvm::DIScope *FDContext = Unit;
3397 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003398 if (!HasDecl) {
3399 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003400 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003401 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003402 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003403 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003404 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003405 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003406 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003407 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003408 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003409 return;
3410 }
3411 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003412 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3413 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003414 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003415 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003416 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003417 } else {
3418 // Use llvm function name.
3419 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003420 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003421 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003422 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003423 Name = Name.substr(1);
3424
Erich Keane293a0552018-02-14 00:14:07 +00003425 if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003426 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003427 // Artificial functions should not silently reuse CurLoc.
3428 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003429 }
Brock Wyma94ece8f2018-04-16 16:53:57 +00003430
3431 if (CurFuncIsThunk)
3432 Flags |= llvm::DINode::FlagThunk;
3433
Paul Robinsoncda54212018-11-19 18:29:28 +00003434 if (Fn->hasLocalLinkage())
3435 SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3436 if (CGM.getLangOpts().Optimize)
3437 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3438
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003439 llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
Paul Robinsoncda54212018-11-19 18:29:28 +00003440 llvm::DISubprogram::DISPFlags SPFlagsForDef =
3441 SPFlags | llvm::DISubprogram::SPFlagDefinition;
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003442
Adrian Prantl42d71b92014-04-10 23:21:53 +00003443 unsigned LineNo = getLineNumber(Loc);
3444 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003445
Eric Christopher8018e412014-03-27 18:50:35 +00003446 // FIXME: The function declaration we're constructing here is mostly reusing
3447 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3448 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3449 // all subprograms instead of the actual context since subprogram definitions
3450 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003451 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003452 FDContext, Name, LinkageName, Unit, LineNo,
Paul Robinsoncda54212018-11-19 18:29:28 +00003453 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, FlagsForDef,
3454 SPFlagsForDef, TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003455 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003456 // We might get here with a VarDecl in the case we're generating
3457 // code for the initialization of globals. Do not record these decls
3458 // as they will overwrite the actual VarDecl Decl in the cache.
3459 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003460 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003461
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00003462 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3463 // Starting with DWARF V5 method declarations are emitted as children of
3464 // the interface type.
3465 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3466 const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3467 QualType QTy(ID->getTypeForDecl(), 0);
3468 auto It = TypeCache.find(QTy.getAsOpaquePtr());
3469 if (It != TypeCache.end()) {
3470 llvm::DICompositeType *InterfaceDecl =
3471 cast<llvm::DICompositeType>(It->second);
3472 llvm::DISubprogram *FD = DBuilder.createFunction(
3473 InterfaceDecl, Name, LinkageName, Unit, LineNo,
Paul Robinsoncda54212018-11-19 18:29:28 +00003474 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00003475 TParamsArray.get());
3476 DBuilder.finalizeSubprogram(FD);
3477 ObjCMethodCache[ID].push_back(FD);
3478 }
3479 }
3480 }
3481
Adrian Prantlbebb8932014-03-21 21:01:58 +00003482 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003483 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003484
Guy Benyei11169dd2012-12-18 14:30:41 +00003485 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003486 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003487}
3488
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003489void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3490 QualType FnType) {
3491 StringRef Name;
3492 StringRef LinkageName;
3493
3494 const Decl *D = GD.getDecl();
3495 if (!D)
3496 return;
3497
Leny Kholodov80c047d2016-09-06 10:48:04 +00003498 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003499 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003500 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003501 llvm::DINodeArray TParamsArray;
3502 if (isa<FunctionDecl>(D)) {
3503 // If there is a DISubprogram for this function available then use it.
3504 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3505 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003506 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003507 Name = getObjCMethodName(OMD);
3508 Flags |= llvm::DINode::FlagPrototyped;
3509 } else {
3510 llvm_unreachable("not a function or ObjC method");
3511 }
3512 if (!Name.empty() && Name[0] == '\01')
3513 Name = Name.substr(1);
3514
3515 if (D->isImplicit()) {
3516 Flags |= llvm::DINode::FlagArtificial;
3517 // Artificial functions without a location should not silently reuse CurLoc.
3518 if (Loc.isInvalid())
3519 CurLoc = SourceLocation();
3520 }
3521 unsigned LineNo = getLineNumber(Loc);
3522 unsigned ScopeLine = 0;
Paul Robinsoncda54212018-11-19 18:29:28 +00003523 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3524 if (CGM.getLangOpts().Optimize)
3525 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003526
Adrian Prantle76bda52016-04-15 15:55:45 +00003527 DBuilder.retainType(DBuilder.createFunction(
3528 FDContext, Name, LinkageName, Unit, LineNo,
Paul Robinsoncda54212018-11-19 18:29:28 +00003529 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
Adrian Prantle76bda52016-04-15 15:55:45 +00003530 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003531}
3532
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003533void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3534 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3535 // If there is a subprogram for this function available then use it.
3536 auto FI = SPCache.find(FD->getCanonicalDecl());
3537 llvm::DISubprogram *SP = nullptr;
3538 if (FI != SPCache.end())
3539 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Adrian Prantl8040a212017-08-23 21:24:12 +00003540 if (!SP || !SP->isDefinition())
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003541 SP = getFunctionStub(GD);
3542 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3543 LexicalBlockStack.emplace_back(SP);
3544 setInlinedAt(Builder.getCurrentDebugLocation());
3545 EmitLocation(Builder, FD->getLocation());
3546}
3547
3548void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3549 assert(CurInlinedAt && "unbalanced inline scope stack");
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003550 EmitFunctionEnd(Builder, nullptr);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003551 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3552}
3553
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003554void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003555 // Update our current location
3556 setLocation(Loc);
3557
Adrian Prantl42ab39f2018-11-09 21:17:38 +00003558 if (CurLoc.isInvalid() || CurLoc.isMacroID() || LexicalBlockStack.empty())
Eric Christophere7b87e52014-10-26 23:40:33 +00003559 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003560
Adrian Prantle83b1302014-01-07 22:05:52 +00003561 llvm::MDNode *Scope = LexicalBlockStack.back();
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003562 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3563 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
Guy Benyei11169dd2012-12-18 14:30:41 +00003564}
3565
Guy Benyei11169dd2012-12-18 14:30:41 +00003566void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003567 llvm::MDNode *Back = nullptr;
3568 if (!LexicalBlockStack.empty())
3569 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003570 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003571 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003572 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003573}
3574
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003575void CGDebugInfo::AppendAddressSpaceXDeref(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003576 unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003577 Optional<unsigned> DWARFAddressSpace =
3578 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3579 if (!DWARFAddressSpace)
3580 return;
3581
3582 Expr.push_back(llvm::dwarf::DW_OP_constu);
3583 Expr.push_back(DWARFAddressSpace.getValue());
3584 Expr.push_back(llvm::dwarf::DW_OP_swap);
3585 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3586}
3587
Eric Christopher0fdcb312013-05-16 00:52:20 +00003588void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3589 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003590 // Set our current location.
3591 setLocation(Loc);
3592
Guy Benyei11169dd2012-12-18 14:30:41 +00003593 // Emit a line table change for the current location inside the new scope.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003594 Builder.SetCurrentDebugLocation(
3595 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3596 LexicalBlockStack.back(), CurInlinedAt));
David Blaikie60a877b2014-10-22 19:34:33 +00003597
Benjamin Kramer8c305922016-02-02 11:06:51 +00003598 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003599 return;
3600
3601 // Create a new lexical block and push it on the stack.
3602 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003603}
3604
Eric Christopher0fdcb312013-05-16 00:52:20 +00003605void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3606 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003607 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3608
3609 // Provide an entry in the line table for the end of the block.
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003610 EmitLocation(Builder, Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003611
Benjamin Kramer8c305922016-02-02 11:06:51 +00003612 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003613 return;
3614
Guy Benyei11169dd2012-12-18 14:30:41 +00003615 LexicalBlockStack.pop_back();
3616}
3617
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003618void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003619 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3620 unsigned RCount = FnBeginRegionCount.back();
3621 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3622
3623 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003624 while (LexicalBlockStack.size() != RCount) {
3625 // Provide an entry in the line table for the end of the block.
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003626 EmitLocation(Builder, CurLoc);
David Blaikie60a877b2014-10-22 19:34:33 +00003627 LexicalBlockStack.pop_back();
3628 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003629 FnBeginRegionCount.pop_back();
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003630
3631 if (Fn && Fn->getSubprogram())
3632 DBuilder.finalizeSubprogram(Fn->getSubprogram());
Guy Benyei11169dd2012-12-18 14:30:41 +00003633}
3634
Adrian Prantl05a623e2018-09-10 16:14:28 +00003635CGDebugInfo::BlockByRefType
3636CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3637 uint64_t *XOffset) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003638 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003639 QualType FType;
3640 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003641 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003642
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003643 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003644 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003645
3646 FieldOffset = 0;
3647 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3648 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3649 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3650 FType = CGM.getContext().IntTy;
3651 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3652 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3653
3654 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3655 if (HasCopyAndDispose) {
3656 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003657 EltTys.push_back(
3658 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3659 EltTys.push_back(
3660 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003661 }
3662 bool HasByrefExtendedLayout;
3663 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003664 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3665 HasByrefExtendedLayout) &&
3666 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003667 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003668 EltTys.push_back(
3669 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003670 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003671
Guy Benyei11169dd2012-12-18 14:30:41 +00003672 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3673 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003674 CGM.getTarget().getPointerAlign(0))) {
3675 CharUnits FieldOffsetInBytes =
3676 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003677 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003678 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003679
Guy Benyei11169dd2012-12-18 14:30:41 +00003680 if (NumPaddingBytes.isPositive()) {
3681 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3682 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3683 pad, ArrayType::Normal, 0);
3684 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3685 }
3686 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003687
Guy Benyei11169dd2012-12-18 14:30:41 +00003688 FType = Type;
Adrian Prantl05a623e2018-09-10 16:14:28 +00003689 llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003690 FieldSize = CGM.getContext().getTypeSize(FType);
3691 FieldAlign = CGM.getContext().toBits(Align);
3692
Eric Christopherb2a008c2013-05-16 00:45:12 +00003693 *XOffset = FieldOffset;
Adrian Prantl05a623e2018-09-10 16:14:28 +00003694 llvm::DIType *FieldTy = DBuilder.createMemberType(
3695 Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3696 llvm::DINode::FlagZero, WrappedTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003697 EltTys.push_back(FieldTy);
3698 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003699
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003700 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Adrian Prantl05a623e2018-09-10 16:14:28 +00003701 return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3702 llvm::DINode::FlagZero, nullptr, Elements),
3703 WrappedTy};
Guy Benyei11169dd2012-12-18 14:30:41 +00003704}
3705
Sander de Smalen891af03a2018-02-03 13:55:59 +00003706llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3707 llvm::Value *Storage,
3708 llvm::Optional<unsigned> ArgNo,
3709 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003710 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003711 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003712 if (VD->hasAttr<NoDebugAttr>())
Sander de Smalen891af03a2018-02-03 13:55:59 +00003713 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003714
David Blaikie7fceebf2013-08-19 03:37:48 +00003715 bool Unwritten =
3716 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3717 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003718 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003719 if (!Unwritten)
3720 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003721 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003722 uint64_t XOffset = 0;
3723 if (VD->hasAttr<BlocksAttr>())
Adrian Prantl05a623e2018-09-10 16:14:28 +00003724 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003725 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003726 Ty = getOrCreateType(VD->getType(), Unit);
3727
3728 // If there is no debug info for this type then do not emit debug info
3729 // for this variable.
3730 if (!Ty)
Sander de Smalen891af03a2018-02-03 13:55:59 +00003731 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003732
Guy Benyei11169dd2012-12-18 14:30:41 +00003733 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003734 unsigned Line = 0;
3735 unsigned Column = 0;
3736 if (!Unwritten) {
3737 Line = getLineNumber(VD->getLocation());
3738 Column = getColumnNumber(VD->getLocation());
3739 }
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003740 SmallVector<int64_t, 13> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003741 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003742 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003743 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003744
3745 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3746
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003747 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3748 AppendAddressSpaceXDeref(AddressSpace, Expr);
3749
Alexey Bataev24f710182017-06-09 13:55:08 +00003750 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3751 // object pointer flag.
Alexey Bataev56223232017-06-09 13:40:18 +00003752 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3753 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3754 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3755 Flags |= llvm::DINode::FlagObjectPointer;
3756 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003757
Adrian Prantlc3782a12017-04-18 01:22:01 +00003758 // Note: Older versions of clang used to emit byval references with an extra
3759 // DW_OP_deref, because they referenced the IR arg directly instead of
3760 // referencing an alloca. Newer versions of LLVM don't treat allocas
3761 // differently from other function arguments when used in a dbg.declare.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003762 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003763 StringRef Name = VD->getName();
3764 if (!Name.empty()) {
3765 if (VD->hasAttr<BlocksAttr>()) {
Adrian Prantlc3782a12017-04-18 01:22:01 +00003766 // Here, we need an offset *into* the alloca.
Guy Benyei11169dd2012-12-18 14:30:41 +00003767 CharUnits offset = CharUnits::fromQuantity(32);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003768 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003769 // offset of __forwarding field
3770 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003771 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003772 Expr.push_back(offset.getQuantity());
3773 Expr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003774 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003775 // offset of x field
3776 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003777 Expr.push_back(offset.getQuantity());
Adrian Prantlc3782a12017-04-18 01:22:01 +00003778 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003779 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003780 // If VD is an anonymous union then Storage represents value for
3781 // all union fields.
George Burgess IV00f70bd2018-03-01 05:43:23 +00003782 const RecordDecl *RD = RT->getDecl();
Adrian Prantl0d820892015-04-29 15:05:50 +00003783 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003784 // GDB has trouble finding local variables in anonymous unions, so we emit
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003785 // artificial local variables for each of the members.
Adrian Prantl00820ab2015-04-29 16:52:31 +00003786 //
3787 // FIXME: Remove this code as soon as GDB supports this.
3788 // The debug info verifier in LLVM operates based on the assumption that a
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003789 // variable has the same size as its storage and we had to disable the
3790 // check for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003791 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003792 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003793 StringRef FieldName = Field->getName();
3794
3795 // Ignore unnamed fields. Do not ignore unnamed records.
3796 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3797 continue;
3798
3799 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003800 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003801 auto *D = DBuilder.createAutoVariable(
3802 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003803 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003804
3805 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003806 DBuilder.insertDeclare(
3807 Storage, D, DBuilder.createExpression(Expr),
3808 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3809 Builder.GetInsertBlock());
Adrian Prantl0d820892015-04-29 15:05:50 +00003810 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003811 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003812 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003813
3814 // Create the descriptor for the variable.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003815 auto *D = ArgNo ? DBuilder.createParameterVariable(
3816 Scope, Name, *ArgNo, Unit, Line, Ty,
3817 CGM.getLangOpts().Optimize, Flags)
3818 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3819 CGM.getLangOpts().Optimize,
3820 Flags, Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003821
3822 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003823 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003824 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003825 Builder.GetInsertBlock());
Sander de Smalen891af03a2018-02-03 13:55:59 +00003826
3827 return D;
Guy Benyei11169dd2012-12-18 14:30:41 +00003828}
3829
Sander de Smalen891af03a2018-02-03 13:55:59 +00003830llvm::DILocalVariable *
3831CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
3832 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003833 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Sander de Smalen891af03a2018-02-03 13:55:59 +00003834 return EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003835}
3836
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003837llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3838 llvm::DIType *Ty) {
3839 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003840 if (CachedTy)
3841 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003842 return DBuilder.createObjectPointerType(Ty);
3843}
3844
Eric Christophere7b87e52014-10-26 23:40:33 +00003845void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3846 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003847 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003848 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003849 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003850
Craig Topper8a13c412014-05-21 05:09:00 +00003851 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003852 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003853 if (VD->hasAttr<NoDebugAttr>())
3854 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003855
Guy Benyei11169dd2012-12-18 14:30:41 +00003856 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003857
Guy Benyei11169dd2012-12-18 14:30:41 +00003858 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003859 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3860 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003861 if (isByRef)
Adrian Prantl05a623e2018-09-10 16:14:28 +00003862 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003863 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003864 Ty = getOrCreateType(VD->getType(), Unit);
3865
3866 // Self is passed along as an implicit non-arg variable in a
3867 // block. Mark it as the object pointer.
Alexey Bataev56223232017-06-09 13:40:18 +00003868 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3869 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3870 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003871
3872 // Get location information.
3873 unsigned Line = getLineNumber(VD->getLocation());
3874 unsigned Column = getColumnNumber(VD->getLocation());
3875
3876 const llvm::DataLayout &target = CGM.getDataLayout();
3877
3878 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003879 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003880 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3881
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003882 SmallVector<int64_t, 9> addr;
Adrian Prantlc3782a12017-04-18 01:22:01 +00003883 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003884 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003885 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003886 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003887 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003888 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003889 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003890 offset =
3891 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003892 addr.push_back(offset.getQuantity());
3893 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003894 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003895 // offset of x field
3896 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003897 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003898 }
3899
3900 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003901 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003902 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003903 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003904 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003905
Guy Benyei11169dd2012-12-18 14:30:41 +00003906 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003907 auto DL =
3908 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
Adrian Prantlc3782a12017-04-18 01:22:01 +00003909 auto *Expr = DBuilder.createExpression(addr);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003910 if (InsertPoint)
Adrian Prantlc3782a12017-04-18 01:22:01 +00003911 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003912 else
Adrian Prantlc3782a12017-04-18 01:22:01 +00003913 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003914}
3915
Guy Benyei11169dd2012-12-18 14:30:41 +00003916void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3917 unsigned ArgNo,
3918 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003919 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003920 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003921}
3922
3923namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003924struct BlockLayoutChunk {
3925 uint64_t OffsetInBits;
3926 const BlockDecl::Capture *Capture;
3927};
3928bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3929 return l.OffsetInBits < r.OffsetInBits;
3930}
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003931} // namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00003932
Scott Linder58df0e42018-08-08 15:56:12 +00003933void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
3934 const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
3935 const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
3936 SmallVectorImpl<llvm::Metadata *> &Fields) {
3937 // Blocks in OpenCL have unique constraints which make the standard fields
3938 // redundant while requiring size and align fields for enqueue_kernel. See
3939 // initializeForBlockHeader in CGBlocks.cpp
3940 if (CGM.getLangOpts().OpenCL) {
3941 Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
3942 BlockLayout.getElementOffsetInBits(0),
3943 Unit, Unit));
3944 Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
3945 BlockLayout.getElementOffsetInBits(1),
3946 Unit, Unit));
3947 } else {
3948 Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
3949 BlockLayout.getElementOffsetInBits(0),
3950 Unit, Unit));
3951 Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
3952 BlockLayout.getElementOffsetInBits(1),
3953 Unit, Unit));
3954 Fields.push_back(
3955 createFieldType("__reserved", Context.IntTy, Loc, AS_public,
3956 BlockLayout.getElementOffsetInBits(2), Unit, Unit));
3957 auto *FnTy = Block.getBlockExpr()->getFunctionType();
3958 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3959 Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
3960 BlockLayout.getElementOffsetInBits(3),
3961 Unit, Unit));
3962 Fields.push_back(createFieldType(
3963 "__descriptor",
3964 Context.getPointerType(Block.NeedsCopyDispose
3965 ? Context.getBlockDescriptorExtendedType()
3966 : Context.getBlockDescriptorType()),
3967 Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
3968 }
3969}
3970
Guy Benyei11169dd2012-12-18 14:30:41 +00003971void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl356347b2017-10-26 20:08:52 +00003972 StringRef Name,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003973 unsigned ArgNo,
Adrian Prantl356347b2017-10-26 20:08:52 +00003974 llvm::AllocaInst *Alloca,
Guy Benyei11169dd2012-12-18 14:30:41 +00003975 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003976 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003977 ASTContext &C = CGM.getContext();
3978 const BlockDecl *blockDecl = block.getBlockDecl();
3979
3980 // Collect some general information about the block's location.
3981 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003982 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003983 unsigned line = getLineNumber(loc);
3984 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003985
Guy Benyei11169dd2012-12-18 14:30:41 +00003986 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003987 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003988
3989 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003990 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003991
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003992 SmallVector<llvm::Metadata *, 16> fields;
Scott Linder58df0e42018-08-08 15:56:12 +00003993 collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
3994 fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003995
3996 // We want to sort the captures by offset, not because DWARF
3997 // requires this, but because we're paranoid about debuggers.
3998 SmallVector<BlockLayoutChunk, 8> chunks;
3999
4000 // 'this' capture.
4001 if (blockDecl->capturesCXXThis()) {
4002 BlockLayoutChunk chunk;
4003 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00004004 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00004005 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004006 chunks.push_back(chunk);
4007 }
4008
4009 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00004010 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004011 const VarDecl *variable = capture.getVariable();
4012 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
4013
4014 // Ignore constant captures.
4015 if (captureInfo.isConstant())
4016 continue;
4017
4018 BlockLayoutChunk chunk;
4019 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00004020 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00004021 chunk.Capture = &capture;
4022 chunks.push_back(chunk);
4023 }
4024
4025 // Sort by offset.
4026 llvm::array_pod_sort(chunks.begin(), chunks.end());
4027
David Majnemer58ed0f32016-07-17 00:39:12 +00004028 for (const BlockLayoutChunk &Chunk : chunks) {
4029 uint64_t offsetInBits = Chunk.OffsetInBits;
4030 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00004031
4032 // If we have a null capture, this must be the C++ 'this' capture.
4033 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00004034 QualType type;
4035 if (auto *Method =
4036 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
4037 type = Method->getThisType(C);
4038 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4039 type = QualType(RDecl->getTypeForDecl(), 0);
4040 else
4041 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00004042
David Majnemerb4b671e2016-06-30 03:01:59 +00004043 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00004044 offsetInBits, tunit, tunit));
4045 continue;
4046 }
4047
4048 const VarDecl *variable = capture->getVariable();
4049 StringRef name = variable->getName();
4050
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004051 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00004052 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00004053 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00004054 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Adrian Prantl05a623e2018-09-10 16:14:28 +00004055 // FIXME: This recomputes the layout of the BlockByRefWrapper.
Guy Benyei11169dd2012-12-18 14:30:41 +00004056 uint64_t xoffset;
Adrian Prantl05a623e2018-09-10 16:14:28 +00004057 fieldType =
4058 EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
David Majnemer34b57492014-07-30 01:30:47 +00004059 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00004060 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4061 PtrInfo.Width, Align, offsetInBits,
4062 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00004063 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004064 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00004065 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00004066 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00004067 }
4068 fields.push_back(fieldType);
4069 }
4070
4071 SmallString<36> typeName;
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004072 llvm::raw_svector_ostream(typeName)
4073 << "__block_literal_" << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00004074
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004075 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00004076
Leny Kholodovdf050fd2016-09-06 17:06:14 +00004077 llvm::DIType *type =
4078 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00004079 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00004080 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00004081 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4082
4083 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00004084 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004085 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00004086
4087 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00004088 auto *debugVar = DBuilder.createParameterVariable(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004089 scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00004090
Adrian Prantl616bef42013-03-14 21:52:59 +00004091 // Insert an llvm.dbg.declare into the current block.
Adrian Prantl356347b2017-10-26 20:08:52 +00004092 DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00004093 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00004094 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00004095}
4096
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004097llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00004098CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4099 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00004100 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00004101
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004102 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00004103 if (MI != StaticDataMemberCache.end()) {
4104 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00004105 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00004106 }
David Blaikiece763042013-08-20 21:49:21 +00004107
4108 // If the member wasn't found in the cache, lazily construct and add it to the
4109 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00004110 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004111 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00004112 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00004113}
4114
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004115llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004116 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4117 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004118 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004119
4120 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004121 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00004122 StringRef FieldName = Field->getName();
4123
4124 // Ignore unnamed fields, but recurse into anonymous records.
4125 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00004126 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004127 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004128 Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004129 continue;
4130 }
4131 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004132 GVE = DBuilder.createGlobalVariableExpression(
4133 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4134 Var->hasLocalLinkage());
4135 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004136 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004137 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00004138}
4139
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004140void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00004141 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004142 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004143 if (D->hasAttr<NoDebugAttr>())
4144 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004145
4146 // If we already created a DIGlobalVariable for this declaration, just attach
4147 // it to the llvm::GlobalVariable.
4148 auto Cached = DeclCache.find(D->getCanonicalDecl());
4149 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004150 return Var->addDebugInfo(
4151 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004152
Guy Benyei11169dd2012-12-18 14:30:41 +00004153 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004154 llvm::DIFile *Unit = nullptr;
4155 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00004156 unsigned LineNo;
4157 StringRef DeclName, LinkageName;
4158 QualType T;
Matthew Voss20165362018-10-03 18:45:04 +00004159 llvm::MDTuple *TemplateParameters = nullptr;
4160 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4161 TemplateParameters, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004162
4163 // Attempt to store one global variable for the declaration - even if we
4164 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004165 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004166
4167 // If this is an anonymous union then we'll want to emit a global
4168 // variable for each member of the anonymous union so that it's possible
4169 // to find the name of any field in the union.
4170 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00004171 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00004172 assert(RD->isAnonymousStructOrUnion() &&
4173 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004174 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004175 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004176 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004177
4178 SmallVector<int64_t, 4> Expr;
4179 unsigned AddressSpace =
4180 CGM.getContext().getTargetAddressSpace(D->getType());
4181 AppendAddressSpaceXDeref(AddressSpace, Expr);
4182
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004183 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00004184 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004185 Var->hasLocalLinkage(),
4186 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
Matthew Voss20165362018-10-03 18:45:04 +00004187 getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4188 Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004189 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004190 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004191 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00004192}
4193
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004194void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004195 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004196 if (VD->hasAttr<NoDebugAttr>())
4197 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00004198 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004199 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004200 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004201 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004202 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00004203 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4204 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004205 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4206 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
4207 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004208 // Do not use global variables for enums.
4209 //
4210 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004211 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004212 return;
David Blaikiea15565562014-04-04 20:56:17 +00004213 // Do not emit separate definitions for function local const/statics.
4214 if (isa<FunctionDecl>(VD->getDeclContext()))
4215 return;
David Blaikiebb113912014-04-05 07:23:17 +00004216 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00004217 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004218 if (VarD->isStaticDataMember()) {
4219 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004220 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00004221 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00004222 //
4223 // FIXME: This is probably unnecessary, since Ty should reference RD
4224 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00004225 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00004226 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00004227 return;
4228 }
4229
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004230 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004231
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004232 auto &GV = DeclCache[VD];
4233 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00004234 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004235 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00004236 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4237 // FIXME: Add a representation for integer constants wider than 64 bits.
4238 if (Init.isInt())
4239 InitExpr =
4240 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4241 else if (Init.isFloat())
4242 InitExpr = DBuilder.createConstantValueExpression(
4243 Init.getFloat().bitcastToAPInt().getZExtValue());
4244 }
Matthew Voss20165362018-10-03 18:45:04 +00004245
4246 llvm::MDTuple *TemplateParameters = nullptr;
4247
4248 if (isa<VarTemplateSpecializationDecl>(VD))
4249 if (VarD) {
4250 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4251 TemplateParameters = parameterNodes.get();
4252 }
4253
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004254 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00004255 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00004256 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
Matthew Voss20165362018-10-03 18:45:04 +00004257 TemplateParameters, Align));
David Blaikiebd483762013-05-20 04:58:53 +00004258}
4259
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004260llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00004261 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00004262 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00004263 llvm::DIScope *Mod = getParentModuleOrNull(D);
4264 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004265}
4266
David Blaikie9f88fe82013-04-22 06:13:21 +00004267void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004268 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004269 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004270 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00004271 if (!NSDecl->isAnonymousNamespace() ||
4272 CGM.getCodeGenOpts().DebugExplicitImport) {
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004273 auto Loc = UD.getLocation();
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004274 DBuilder.createImportedModule(
4275 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004276 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004277 }
David Blaikie9f88fe82013-04-22 06:13:21 +00004278}
4279
David Blaikiebd483762013-05-20 04:58:53 +00004280void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004281 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004282 return;
4283 assert(UD.shadow_size() &&
4284 "We shouldn't be codegening an invalid UsingDecl containing no decls");
4285 // Emitting one decl is sufficient - debuggers can detect that this is an
4286 // overloaded name & provide lookup for all the overloads.
4287 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00004288
4289 // FIXME: Skip functions with undeduced auto return type for now since we
4290 // don't currently have the plumbing for separate declarations & definitions
4291 // of free functions and mismatched types (auto in the declaration, concrete
4292 // return type in the definition)
4293 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4294 if (const auto *AT =
4295 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4296 if (AT->getDeducedType().isNull())
4297 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004298 if (llvm::DINode *Target =
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004299 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4300 auto Loc = USD.getLocation();
David Blaikiebd483762013-05-20 04:58:53 +00004301 DBuilder.createImportedDeclaration(
4302 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004303 getOrCreateFile(Loc), getLineNumber(Loc));
4304 }
David Blaikiebd483762013-05-20 04:58:53 +00004305}
4306
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004307void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00004308 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4309 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00004310 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00004311 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004312 auto Loc = ID.getLocation();
Adrian Prantl8a634c12015-12-18 19:44:31 +00004313 DBuilder.createImportedDeclaration(
4314 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004315 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4316 getLineNumber(Loc));
Adrian Prantl8a634c12015-12-18 19:44:31 +00004317 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004318}
4319
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004320llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00004321CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004322 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004323 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004324 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00004325 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004326 return cast<llvm::DIImportedEntity>(VH);
4327 llvm::DIImportedEntity *R;
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004328 auto Loc = NA.getLocation();
David Majnemer58ed0f32016-07-17 00:39:12 +00004329 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00004330 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4331 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00004332 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004333 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004334 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4335 getLineNumber(Loc), NA.getName());
David Blaikief121b932013-05-20 22:50:41 +00004336 else
David Blaikie551fb0a2014-04-06 06:30:03 +00004337 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004338 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantlddb8e062017-05-12 16:23:53 +00004339 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004340 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004341 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00004342 return R;
4343}
4344
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004345llvm::DINamespace *
Adrian Prantlddb8e062017-05-12 16:23:53 +00004346CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4347 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4348 // if necessary, and this way multiple declarations of the same namespace in
4349 // different parent modules stay distinct.
4350 auto I = NamespaceCache.find(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004351 if (I != NamespaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004352 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00004353
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004354 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004355 // Don't trust the context if it is a DIModule (see comment above).
Adrian Prantlddb8e062017-05-12 16:23:53 +00004356 llvm::DINamespace *NS =
4357 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4358 NamespaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00004359 return NS;
4360}
4361
Adrian Prantla5206ce2015-09-22 23:26:43 +00004362void CGDebugInfo::setDwoId(uint64_t Signature) {
4363 assert(TheCU && "no main compile unit");
4364 TheCU->setDWOId(Signature);
4365}
4366
Guy Benyei11169dd2012-12-18 14:30:41 +00004367void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00004368 // Creating types might create further types - invalidating the current
4369 // element and the size(), so don't cache/reference them.
4370 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4371 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004372 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00004373 ? CreateTypeDefinition(E.Type, E.Unit)
4374 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004375 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00004376 }
4377
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004378 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4379 // Add methods to interface.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004380 for (const auto &P : ObjCMethodCache) {
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004381 if (P.second.empty())
4382 continue;
4383
4384 QualType QTy(P.first->getTypeForDecl(), 0);
4385 auto It = TypeCache.find(QTy.getAsOpaquePtr());
4386 assert(It != TypeCache.end());
4387
4388 llvm::DICompositeType *InterfaceDecl =
4389 cast<llvm::DICompositeType>(It->second);
4390
4391 SmallVector<llvm::Metadata *, 16> EltTys;
4392 auto CurrenetElts = InterfaceDecl->getElements();
4393 EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4394 for (auto &MD : P.second)
4395 EltTys.push_back(MD);
4396 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4397 DBuilder.replaceArrays(InterfaceDecl, Elements);
4398 }
4399 }
4400
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004401 for (const auto &P : ReplaceMap) {
4402 assert(P.second);
4403 auto *Ty = cast<llvm::DIType>(P.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004404 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00004405
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004406 auto It = TypeCache.find(P.first);
4407 assert(It != TypeCache.end());
4408 assert(It->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00004409
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004410 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004411 cast<llvm::DIType>(It->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00004412 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00004413
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004414 for (const auto &P : FwdDeclReplaceMap) {
4415 assert(P.second);
4416 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004417 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00004418
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004419 auto It = DeclCache.find(P.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00004420 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00004421 // with ourselves, that will destroy the temporary MDNode and
4422 // replace it with a standard one, avoiding leaking memory.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004423 if (It == DeclCache.end())
4424 Repl = P.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00004425 else
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004426 Repl = It->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00004427
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004428 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4429 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004430 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00004431 }
4432
Adrian Prantl73409ce2013-03-11 18:33:46 +00004433 // We keep our own list of retained types, because we need to look
4434 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00004435 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00004436 if (auto MD = TypeCache[RT])
4437 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00004438
Guy Benyei11169dd2012-12-18 14:30:41 +00004439 DBuilder.finalize();
4440}
David Blaikie66088d52014-09-24 17:01:27 +00004441
4442void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004443 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00004444 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004445
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00004446 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004447 // Don't ignore in case of explicit cast where it is referenced indirectly.
4448 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00004449}
Amara Emerson652795d2016-11-10 14:44:30 +00004450
4451llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4452 if (LexicalBlockStack.empty())
4453 return llvm::DebugLoc();
4454
4455 llvm::MDNode *Scope = LexicalBlockStack.back();
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004456 return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
Amara Emerson652795d2016-11-10 14:44:30 +00004457}
Vedant Kumar5931b4e2018-10-05 20:37:17 +00004458
4459llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4460 // Call site-related attributes are only useful in optimized programs, and
4461 // when there's a possibility of debugging backtraces.
4462 if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4463 DebugKind == codegenoptions::LocTrackingOnly)
4464 return llvm::DINode::FlagZero;
4465
4466 // Call site-related attributes are available in DWARF v5. Some debuggers,
4467 // while not fully DWARF v5-compliant, may accept these attributes as if they
4468 // were part of DWARF v4.
4469 bool SupportsDWARFv4Ext =
4470 CGM.getCodeGenOpts().DwarfVersion == 4 &&
4471 CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB;
4472 if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4473 return llvm::DINode::FlagZero;
4474
4475 return llvm::DINode::FlagAllCallsDescribed;
4476}