blob: bcd5338ac050f70ecfeec0ebb1970a5e84ae629b [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) {
531 if (LO.ObjC1)
532 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
533 else
534 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
535 } else if (LO.ObjC1) {
536 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;
549 if (LO.ObjC1)
550 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,
584 CGOpts.EnableSplitDwarf ? "" : CGOpts.SplitDwarfFile, EmissionKind,
Peter Collingbourneb52e2362017-09-12 21:50:41 +0000585 0 /* DWOid */, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
David Blaikie9982bb82018-08-16 23:56:32 +0000586 CGM.getTarget().getTriple().isNVPTX()
587 ? llvm::DICompileUnit::DebugNameTableKind::None
David Blaikie65864522018-08-20 20:14:08 +0000588 : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
589 CGOpts.DebugNameTable));
Guy Benyei11169dd2012-12-18 14:30:41 +0000590}
591
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000592llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000593 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000594 StringRef BTName;
595 switch (BT->getKind()) {
596#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000597#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000598#include "clang/AST/BuiltinTypes.def"
599 case BuiltinType::Dependent:
600 llvm_unreachable("Unexpected builtin type");
601 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000602 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000603 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000604 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000605 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000606 if (!ClassTy)
607 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
608 "objc_class", TheCU,
609 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000610 return ClassTy;
611 case BuiltinType::ObjCId: {
612 // typedef struct objc_class *Class;
613 // typedef struct objc_object {
614 // Class isa;
615 // } *id;
616
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000617 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000618 return ObjTy;
619
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000620 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000621 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
622 "objc_class", TheCU,
623 getOrCreateMainFile(), 0);
624
625 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000626
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000627 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000628
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000629 ObjTy = DBuilder.createStructType(
630 TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
631 llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000632
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000633 DBuilder.replaceArrays(
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000634 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
635 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
636 llvm::DINode::FlagZero, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000637 return ObjTy;
638 }
639 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000640 if (!SelTy)
641 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
642 "objc_selector", TheCU,
643 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000644 return SelTy;
645 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000646
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000647#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
648 case BuiltinType::Id: \
649 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
Alexey Bader954ba212016-04-08 13:40:33 +0000650 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000651#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000652 case BuiltinType::OCLSampler:
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000653 return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000654 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000655 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000656 case BuiltinType::OCLClkEvent:
657 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
658 case BuiltinType::OCLQueue:
659 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000660 case BuiltinType::OCLReserveID:
661 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000662
Guy Benyei11169dd2012-12-18 14:30:41 +0000663 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000664 case BuiltinType::Char_U:
665 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
666 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000667 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000668 case BuiltinType::SChar:
669 Encoding = llvm::dwarf::DW_ATE_signed_char;
670 break;
Richard Smith3a8244d2018-05-01 05:02:45 +0000671 case BuiltinType::Char8:
Guy Benyei11169dd2012-12-18 14:30:41 +0000672 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000673 case BuiltinType::Char32:
674 Encoding = llvm::dwarf::DW_ATE_UTF;
675 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000676 case BuiltinType::UShort:
677 case BuiltinType::UInt:
678 case BuiltinType::UInt128:
679 case BuiltinType::ULong:
680 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000681 case BuiltinType::ULongLong:
682 Encoding = llvm::dwarf::DW_ATE_unsigned;
683 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000684 case BuiltinType::Short:
685 case BuiltinType::Int:
686 case BuiltinType::Int128:
687 case BuiltinType::Long:
688 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000689 case BuiltinType::LongLong:
690 Encoding = llvm::dwarf::DW_ATE_signed;
691 break;
692 case BuiltinType::Bool:
693 Encoding = llvm::dwarf::DW_ATE_boolean;
694 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000695 case BuiltinType::Half:
696 case BuiltinType::Float:
697 case BuiltinType::LongDouble:
Sjoerd Meijercc623ad2017-09-08 15:15:00 +0000698 case BuiltinType::Float16:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000699 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000700 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000701 // FIXME: For targets where long double and __float128 have the same size,
702 // they are currently indistinguishable in the debugger without some
703 // special treatment. However, there is currently no consensus on encoding
704 // and this should be updated once a DWARF encoding exists for distinct
705 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000706 Encoding = llvm::dwarf::DW_ATE_float;
707 break;
Leonard Chanf921d852018-06-04 16:07:52 +0000708 case BuiltinType::ShortAccum:
709 case BuiltinType::Accum:
710 case BuiltinType::LongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000711 case BuiltinType::ShortFract:
712 case BuiltinType::Fract:
713 case BuiltinType::LongFract:
714 case BuiltinType::SatShortFract:
715 case BuiltinType::SatFract:
716 case BuiltinType::SatLongFract:
717 case BuiltinType::SatShortAccum:
718 case BuiltinType::SatAccum:
719 case BuiltinType::SatLongAccum:
Leonard Chanf921d852018-06-04 16:07:52 +0000720 Encoding = llvm::dwarf::DW_ATE_signed_fixed;
721 break;
722 case BuiltinType::UShortAccum:
723 case BuiltinType::UAccum:
724 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000725 case BuiltinType::UShortFract:
726 case BuiltinType::UFract:
727 case BuiltinType::ULongFract:
728 case BuiltinType::SatUShortAccum:
729 case BuiltinType::SatUAccum:
730 case BuiltinType::SatULongAccum:
731 case BuiltinType::SatUShortFract:
732 case BuiltinType::SatUFract:
733 case BuiltinType::SatULongFract:
Leonard Chanf921d852018-06-04 16:07:52 +0000734 Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
735 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000736 }
737
738 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000739 case BuiltinType::Long:
740 BTName = "long int";
741 break;
742 case BuiltinType::LongLong:
743 BTName = "long long int";
744 break;
745 case BuiltinType::ULong:
746 BTName = "long unsigned int";
747 break;
748 case BuiltinType::ULongLong:
749 BTName = "long long unsigned int";
750 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000751 default:
752 BTName = BT->getName(CGM.getLangOpts());
753 break;
754 }
Victor Leschuka7ece032016-10-20 00:13:19 +0000755 // Bit size and offset of the type.
Guy Benyei11169dd2012-12-18 14:30:41 +0000756 uint64_t Size = CGM.getContext().getTypeSize(BT);
Victor Leschuka7ece032016-10-20 00:13:19 +0000757 return DBuilder.createBasicType(BTName, Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000758}
759
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000760llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Victor Leschuka7ece032016-10-20 00:13:19 +0000761 // Bit size and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000762 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000763 if (Ty->isComplexIntegerType())
764 Encoding = llvm::dwarf::DW_ATE_lo_user;
765
766 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000767 return DBuilder.createBasicType("complex", Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000768}
769
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000770llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
771 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000772 QualifierCollector Qc;
773 const Type *T = Qc.strip(Ty);
774
775 // Ignore these qualifiers for now.
776 Qc.removeObjCGCAttr();
777 Qc.removeAddressSpace();
778 Qc.removeObjCLifetime();
779
780 // We will create one Derived type for one qualifier and recurse to handle any
781 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000782 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000783 if (Qc.hasConst()) {
784 Tag = llvm::dwarf::DW_TAG_const_type;
785 Qc.removeConst();
786 } else if (Qc.hasVolatile()) {
787 Tag = llvm::dwarf::DW_TAG_volatile_type;
788 Qc.removeVolatile();
789 } else if (Qc.hasRestrict()) {
790 Tag = llvm::dwarf::DW_TAG_restrict_type;
791 Qc.removeRestrict();
792 } else {
793 assert(Qc.empty() && "Unknown type qualifier for debug info");
794 return getOrCreateType(QualType(T, 0), Unit);
795 }
796
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000797 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000798
799 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
800 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000801 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000802}
803
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000804llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
805 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000806
807 // The frontend treats 'id' as a typedef to an ObjCObjectType,
808 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
809 // debug info, we want to emit 'id' in both cases.
810 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000811 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000812
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000813 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
814 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000815}
816
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000817llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
818 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000819 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000820 Ty->getPointeeType(), Unit);
821}
822
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000823/// \return whether a C++ mangling exists for the type defined by TD.
824static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
825 switch (TheCU->getSourceLanguage()) {
826 case llvm::dwarf::DW_LANG_C_plus_plus:
827 return true;
828 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
829 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
830 default:
831 return false;
832 }
833}
834
Reid Kleckner59320fc2018-08-17 20:59:52 +0000835// Determines if the debug info for this tag declaration needs a type
836// identifier. The purpose of the unique identifier is to deduplicate type
837// information for identical types across TUs. Because of the C++ one definition
838// rule (ODR), it is valid to assume that the type is defined the same way in
839// every TU and its debug info is equivalent.
840//
841// C does not have the ODR, and it is common for codebases to contain multiple
842// different definitions of a struct with the same name in different TUs.
843// Therefore, if the type doesn't have a C++ mangling, don't give it an
844// identifer. Type information in C is smaller and simpler than C++ type
845// information, so the increase in debug info size is negligible.
846//
847// If the type is not externally visible, it should be unique to the current TU,
848// and should not need an identifier to participate in type deduplication.
849// However, when emitting CodeView, the format internally uses these
850// unique type name identifers for references between debug info. For example,
851// the method of a class in an anonymous namespace uses the identifer to refer
852// to its parent class. The Microsoft C++ ABI attempts to provide unique names
853// for such types, so when emitting CodeView, always use identifiers for C++
854// types. This may create problems when attempting to emit CodeView when the MS
855// C++ ABI is not in use.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000856static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
Brock Wyma8557ec52018-05-22 12:41:19 +0000857 llvm::DICompileUnit *TheCU) {
858 // We only add a type identifier for types with C++ name mangling.
859 if (!hasCXXMangling(TD, TheCU))
860 return false;
861
Brock Wyma8557ec52018-05-22 12:41:19 +0000862 // Externally visible types with C++ mangling need a type identifier.
863 if (TD->isExternallyVisible())
864 return true;
865
Reid Kleckner59320fc2018-08-17 20:59:52 +0000866 // CodeView types with C++ mangling need a type identifier.
867 if (CGM.getCodeGenOpts().EmitCodeView)
868 return true;
869
Brock Wyma8557ec52018-05-22 12:41:19 +0000870 return false;
871}
872
Reid Kleckner59320fc2018-08-17 20:59:52 +0000873// Returns a unique type identifier string if one exists, or an empty string.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000874static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
Brock Wyma8557ec52018-05-22 12:41:19 +0000875 llvm::DICompileUnit *TheCU) {
876 SmallString<256> Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000877 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000878
Brock Wyma8557ec52018-05-22 12:41:19 +0000879 if (!needsTypeIdentifier(TD, CGM, TheCU))
880 return Identifier;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000881
Manman Rene0064d82013-08-29 23:19:58 +0000882 // TODO: This is using the RTTI name. Is there a better way to get
883 // a unique string for a type?
Brock Wyma8557ec52018-05-22 12:41:19 +0000884 llvm::raw_svector_ostream Out(Identifier);
Manman Rene0064d82013-08-29 23:19:58 +0000885 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Brock Wyma8557ec52018-05-22 12:41:19 +0000886 return Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000887}
888
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000889/// \return the appropriate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000890static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000891 llvm::dwarf::Tag Tag;
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000892 if (RD->isStruct() || RD->isInterface())
893 Tag = llvm::dwarf::DW_TAG_structure_type;
894 else if (RD->isUnion())
895 Tag = llvm::dwarf::DW_TAG_union_type;
896 else {
897 // FIXME: This could be a struct type giving a default visibility different
898 // than C++ class type, but needs llvm metadata changes first.
899 assert(RD->isClass());
900 Tag = llvm::dwarf::DW_TAG_class_type;
901 }
902 return Tag;
903}
904
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000905llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000906CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000907 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000908 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000909 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
910 return cast<llvm::DICompositeType>(T);
911 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000912 unsigned Line = getLineNumber(RD->getLocation());
913 StringRef RDName = getClassName(RD);
914
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000915 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000916 uint32_t Align = 0;
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000917
Guy Benyei11169dd2012-12-18 14:30:41 +0000918 // Create the type.
Brock Wyma8557ec52018-05-22 12:41:19 +0000919 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000920 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000921 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +0000922 llvm::DINode::FlagFwdDecl, Identifier);
Paul Robinson1787f812017-09-28 18:37:02 +0000923 if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
924 if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
925 DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
926 CollectCXXTemplateParams(TSpecial, DefUnit));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000927 ReplaceMap.emplace_back(
928 std::piecewise_construct, std::make_tuple(Ty),
929 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000930 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000931}
932
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000933llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000934 const Type *Ty,
935 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000936 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000937 // Bit size, align and offset of the type.
938 // Size is always the size of a pointer. We can't use getTypeSize here
939 // because that does not return the correct value for references.
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000940 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
941 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
Victor Leschuka7ece032016-10-20 00:13:19 +0000942 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000943 Optional<unsigned> DWARFAddressSpace =
944 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000945
Keno Fischer87842f32015-11-16 09:04:13 +0000946 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
947 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
948 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000949 Size, Align, DWARFAddressSpace);
Keno Fischer87842f32015-11-16 09:04:13 +0000950 else
951 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000952 Align, DWARFAddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000953}
954
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000955llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
956 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000957 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000958 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000959 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
960 TheCU, getOrCreateMainFile(), 0);
961 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
962 Cache = DBuilder.createPointerType(Cache, Size);
963 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000964}
965
Scott Linder58df0e42018-08-08 15:56:12 +0000966uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
967 const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
968 unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000969 QualType FType;
Guy Benyei11169dd2012-12-18 14:30:41 +0000970
Scott Linder58df0e42018-08-08 15:56:12 +0000971 // Advanced by calls to CreateMemberType in increments of FType, then
972 // returned as the overall size of the default elements.
973 uint64_t FieldOffset = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000974
Scott Linder58df0e42018-08-08 15:56:12 +0000975 // Blocks in OpenCL have unique constraints which make the standard fields
976 // redundant while requiring size and align fields for enqueue_kernel. See
977 // initializeForBlockHeader in CGBlocks.cpp
Scott Linder2b5cf042018-07-30 20:31:11 +0000978 if (CGM.getLangOpts().OpenCL) {
979 FType = CGM.getContext().IntTy;
980 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
981 EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
982 } else {
983 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
984 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
985 FType = CGM.getContext().IntTy;
986 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
987 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
988 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
989 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
990 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Scott Linder58df0e42018-08-08 15:56:12 +0000991 uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
992 uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
Scott Linder2b5cf042018-07-30 20:31:11 +0000993 EltTys.push_back(DBuilder.createMemberType(
Scott Linder58df0e42018-08-08 15:56:12 +0000994 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
995 FieldOffset, llvm::DINode::FlagZero, DescTy));
Scott Lindera7c45682018-07-30 22:52:07 +0000996 FieldOffset += FieldSize;
Scott Linder2b5cf042018-07-30 20:31:11 +0000997 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000998
Scott Linder58df0e42018-08-08 15:56:12 +0000999 return FieldOffset;
1000}
1001
1002llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1003 llvm::DIFile *Unit) {
1004 SmallVector<llvm::Metadata *, 8> EltTys;
1005 QualType FType;
1006 uint64_t FieldOffset;
1007 llvm::DINodeArray Elements;
1008
1009 FieldOffset = 0;
1010 FType = CGM.getContext().UnsignedLongTy;
1011 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1012 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1013
1014 Elements = DBuilder.getOrCreateArray(EltTys);
1015 EltTys.clear();
1016
1017 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1018
1019 auto *EltTy =
1020 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1021 FieldOffset, 0, Flags, nullptr, Elements);
1022
1023 // Bit size, align and offset of the type.
1024 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1025
1026 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1027
1028 FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1029 0, EltTys);
1030
Guy Benyei11169dd2012-12-18 14:30:41 +00001031 Elements = DBuilder.getOrCreateArray(EltTys);
1032
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001033 // The __block_literal_generic structs are marked with a special
1034 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1035 // the debugger needs to know about. To allow type uniquing, emit
1036 // them without a name or a location.
Scott Linder58df0e42018-08-08 15:56:12 +00001037 EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001038 Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001039
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001040 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +00001041}
1042
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001043llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1044 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +00001045 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001046 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +00001047
1048 SmallString<128> NS;
1049 llvm::raw_svector_ostream OS(NS);
Serge Pavlov03e672c2017-11-28 16:14:14 +00001050 Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1051 printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
David Blaikief1b382e2014-04-06 17:14:06 +00001052
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001053 auto *AliasDecl =
1054 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1055 ->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +00001056
1057 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +00001058 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1059 getLineNumber(Loc),
1060 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +00001061}
1062
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001063llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1064 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001065 // We don't set size information, but do specify where the typedef was
1066 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +00001067 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001068
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001069 // Typedefs are derived from some other type.
1070 return DBuilder.createTypedef(
1071 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1072 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +00001073 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001074}
1075
Reid Klecknerf00f8032016-06-08 20:41:54 +00001076static unsigned getDwarfCC(CallingConv CC) {
1077 switch (CC) {
1078 case CC_C:
1079 // Avoid emitting DW_AT_calling_convention if the C convention was used.
1080 return 0;
1081
1082 case CC_X86StdCall:
1083 return llvm::dwarf::DW_CC_BORLAND_stdcall;
1084 case CC_X86FastCall:
1085 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1086 case CC_X86ThisCall:
1087 return llvm::dwarf::DW_CC_BORLAND_thiscall;
1088 case CC_X86VectorCall:
1089 return llvm::dwarf::DW_CC_LLVM_vectorcall;
1090 case CC_X86Pascal:
1091 return llvm::dwarf::DW_CC_BORLAND_pascal;
Martin Storsjo022e7822017-07-17 20:49:45 +00001092 case CC_Win64:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001093 return llvm::dwarf::DW_CC_LLVM_Win64;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001094 case CC_X86_64SysV:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001095 return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001096 case CC_AAPCS:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001097 return llvm::dwarf::DW_CC_LLVM_AAPCS;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001098 case CC_AAPCS_VFP:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001099 return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001100 case CC_IntelOclBicc:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001101 return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001102 case CC_SpirFunction:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001103 return llvm::dwarf::DW_CC_LLVM_SpirFunction;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +00001104 case CC_OpenCLKernel:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001105 return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001106 case CC_Swift:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001107 return llvm::dwarf::DW_CC_LLVM_Swift;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001108 case CC_PreserveMost:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001109 return llvm::dwarf::DW_CC_LLVM_PreserveMost;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001110 case CC_PreserveAll:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001111 return llvm::dwarf::DW_CC_LLVM_PreserveAll;
Erich Keane757d3172016-11-02 18:29:35 +00001112 case CC_X86RegCall:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001113 return llvm::dwarf::DW_CC_LLVM_X86RegCall;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001114 }
1115 return 0;
1116}
1117
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001118llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1119 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001120 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001121
1122 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +00001123 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001124
1125 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +00001126 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +00001127 if (isa<FunctionNoProtoType>(Ty))
1128 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +00001129 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1130 for (const QualType &ParamType : FPT->param_types())
1131 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +00001132 if (FPT->isVariadic())
1133 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00001134 }
1135
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001136 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00001137 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +00001138 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001139}
1140
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001141/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +00001142/// As an optimization, return 0 if the access specifier equals the
1143/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +00001144static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1145 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +00001146 AccessSpecifier Default = clang::AS_none;
1147 if (RD && RD->isClass())
1148 Default = clang::AS_private;
1149 else if (RD && (RD->isStruct() || RD->isUnion()))
1150 Default = clang::AS_public;
1151
1152 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +00001153 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001154
Eric Christophere7b87e52014-10-26 23:40:33 +00001155 switch (Access) {
1156 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001157 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +00001158 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001159 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +00001160 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001161 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +00001162 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +00001163 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001164 }
1165 llvm_unreachable("unexpected access enumerator");
1166}
Guy Benyei11169dd2012-12-18 14:30:41 +00001167
David Majnemerb4b671e2016-06-30 03:01:59 +00001168llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1169 llvm::DIScope *RecordTy,
1170 const RecordDecl *RD) {
1171 StringRef Name = BitFieldDecl->getName();
1172 QualType Ty = BitFieldDecl->getType();
1173 SourceLocation Loc = BitFieldDecl->getLocation();
1174 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1175 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1176
1177 // Get the location for the field.
1178 llvm::DIFile *File = getOrCreateFile(Loc);
1179 unsigned Line = getLineNumber(Loc);
1180
1181 const CGBitFieldInfo &BitFieldInfo =
1182 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1183 uint64_t SizeInBits = BitFieldInfo.Size;
1184 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001185 uint64_t StorageOffsetInBits =
1186 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
Reid Kleckner06a4b2a2017-06-12 19:57:56 +00001187 uint64_t Offset = BitFieldInfo.Offset;
1188 // The bit offsets for big endian machines are reversed for big
1189 // endian target, compensate for that as the DIDerivedType requires
1190 // un-reversed offsets.
1191 if (CGM.getDataLayout().isBigEndian())
1192 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1193 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001194 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001195 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001196 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1197 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001198}
1199
1200llvm::DIType *
1201CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1202 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001203 uint32_t AlignInBits, llvm::DIFile *tunit,
1204 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001205 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001206
1207 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001208 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001209 unsigned line = getLineNumber(loc);
1210
David Majnemer34b57492014-07-30 01:30:47 +00001211 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001212 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001213 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001214 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1215 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001216 if (!Align)
1217 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001218 }
1219
Leny Kholodov80c047d2016-09-06 10:48:04 +00001220 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001221 return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1222 offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001223}
1224
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001225void CGDebugInfo::CollectRecordLambdaFields(
1226 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001227 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001228 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1229 // has the name and the location of the variable so we should iterate over
1230 // both concurrently.
1231 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1232 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1233 unsigned fieldno = 0;
1234 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001235 E = CXXDecl->captures_end();
1236 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001237 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001238 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001239 SourceLocation Loc = C.getLocation();
1240 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001241 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001242 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001243 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001244 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001245 llvm::DIType *FieldType = createFieldType(
1246 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001247 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001248 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001249 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001250 // TODO: Need to handle 'this' in some way by probably renaming the
1251 // this of the lambda class and having a field member of 'this' or
1252 // by using AT_object_pointer for the function and having that be
1253 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001254 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001255 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001256 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001257 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001258 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001259 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001260
1261 elements.push_back(fieldType);
1262 }
1263 }
1264}
1265
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001266llvm::DIDerivedType *
1267CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001268 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001269 // Create the descriptor for the static variable, with or without
1270 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001271 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001272 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1273 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001274
Eric Christopher91a31902013-01-16 01:22:32 +00001275 unsigned LineNumber = getLineNumber(Var->getLocation());
1276 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001277 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001278 if (Var->getInit()) {
1279 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001280 if (Value) {
1281 if (Value->isInt())
1282 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1283 if (Value->isFloat())
1284 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1285 }
Eric Christopher91a31902013-01-16 01:22:32 +00001286 }
1287
Leny Kholodov80c047d2016-09-06 10:48:04 +00001288 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001289 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001290 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001291 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001292 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001293 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001294}
1295
Eric Christophere7b87e52014-10-26 23:40:33 +00001296void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001297 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1298 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001299 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001300 StringRef name = field->getName();
1301 QualType type = field->getType();
1302
1303 // Ignore unnamed fields unless they're anonymous structs/unions.
1304 if (name.empty() && !type->isRecordType())
1305 return;
1306
David Majnemerb4b671e2016-06-30 03:01:59 +00001307 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001308 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001309 FieldType = createBitFieldType(field, RecordTy, RD);
1310 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001311 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001312 FieldType =
1313 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001314 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001315 }
1316
David Majnemerb4b671e2016-06-30 03:01:59 +00001317 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001318}
1319
Reid Klecknere2e82062017-08-08 20:30:14 +00001320void CGDebugInfo::CollectRecordNestedType(
1321 const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1322 QualType Ty = CGM.getContext().getTypeDeclType(TD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001323 // Injected class names are not considered nested records.
1324 if (isa<InjectedClassNameType>(Ty))
1325 return;
Reid Klecknere2e82062017-08-08 20:30:14 +00001326 SourceLocation Loc = TD->getLocation();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001327 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1328 elements.push_back(nestedType);
1329}
1330
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001331void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001332 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001333 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001334 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001335 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001336
Eric Christopher91a31902013-01-16 01:22:32 +00001337 if (CXXDecl && CXXDecl->isLambda())
1338 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1339 else {
1340 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001341
Eric Christopher91a31902013-01-16 01:22:32 +00001342 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001343 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001344
Eric Christopher91a31902013-01-16 01:22:32 +00001345 // Static and non-static members should appear in the same order as
1346 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001347 for (const auto *I : record->decls())
1348 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001349 if (V->hasAttr<NoDebugAttr>())
1350 continue;
Reid Kleckner891b2712018-07-20 20:55:00 +00001351
1352 // Skip variable template specializations when emitting CodeView. MSVC
1353 // doesn't emit them.
1354 if (CGM.getCodeGenOpts().EmitCodeView &&
1355 isa<VarTemplateSpecializationDecl>(V))
1356 continue;
1357
David Blaikiece763042013-08-20 21:49:21 +00001358 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001359 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001360 if (MI != StaticDataMemberCache.end()) {
1361 assert(MI->second &&
1362 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001363 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001364 } else {
1365 auto Field = CreateRecordStaticField(V, RecordTy, record);
1366 elements.push_back(Field);
1367 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001368 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001369 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1370 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001371
1372 // Bump field number for next field.
1373 ++fieldNo;
Reid Kleckner891b2712018-07-20 20:55:00 +00001374 } else if (CGM.getCodeGenOpts().EmitCodeView) {
1375 // Debug info for nested types is included in the member list only for
1376 // CodeView.
Reid Klecknere2e82062017-08-08 20:30:14 +00001377 if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1378 if (!nestedType->isImplicit() &&
1379 nestedType->getDeclContext() == record)
1380 CollectRecordNestedType(nestedType, elements);
1381 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001382 }
1383}
1384
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001385llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001386CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001387 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001388 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001389 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001390 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001391 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001392 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1393 Func, Unit);
1394}
David Blaikie2aaf0652013-01-07 22:24:59 +00001395
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001396llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1397 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001398 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001399 llvm::DITypeRefArray Args(
1400 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001401 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001402 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001403
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001404 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001405
1406 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001407 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001408
David Blaikie2aaf0652013-01-07 22:24:59 +00001409 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001410 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001411 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1412 // Create pointer type directly in this case.
1413 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1414 QualType PointeeTy = ThisPtrTy->getPointeeType();
1415 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001416 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001417 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001418 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1419 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001420 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001421 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001422 // TODO: This and the artificial type below are misleading, the
1423 // types aren't artificial the argument is, but the current
1424 // metadata doesn't represent that.
1425 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1426 Elts.push_back(ThisPtrType);
1427 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001428 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001429 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001430 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1431 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001432 }
1433
1434 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001435 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1436 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001437
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001438 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001439
Leny Kholodov80c047d2016-09-06 10:48:04 +00001440 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001441 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001442 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001443 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001444 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001445
Reid Klecknerf00f8032016-06-08 20:41:54 +00001446 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1447 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001448}
1449
Eric Christopherb2a008c2013-05-16 00:45:12 +00001450/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001451/// inside a function.
1452static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001453 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001454 return isFunctionLocalClass(NRD);
1455 if (isa<FunctionDecl>(RD->getDeclContext()))
1456 return true;
1457 return false;
1458}
1459
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001460llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1461 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001462 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001463 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001464
Guy Benyei11169dd2012-12-18 14:30:41 +00001465 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001466 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001467
1468 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1469 // make sense to give a single ctor/dtor a linkage name.
1470 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001471 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1472 // property to use here. It may've been intended to model "is non-external
1473 // type" but misses cases of non-function-local but non-external classes such
1474 // as those in anonymous namespaces as well as the reverse - external types
1475 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001476 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1477 MethodLinkageName = CGM.getMangledName(Method);
1478
1479 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001480 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001481 unsigned MethodLine = 0;
1482 if (!Method->isImplicit()) {
1483 MethodDefUnit = getOrCreateFile(Method->getLocation());
1484 MethodLine = getLineNumber(Method->getLocation());
1485 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001486
1487 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001488 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001489 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001490 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001491 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001492 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001493
Guy Benyei11169dd2012-12-18 14:30:41 +00001494 if (Method->isVirtual()) {
1495 if (Method->isPure())
1496 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1497 else
1498 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001499
Reid Kleckner216d0a12016-06-16 20:08:51 +00001500 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1501 // It doesn't make sense to give a virtual destructor a vtable index,
1502 // since a single destructor has two entries in the vtable.
1503 if (!isa<CXXDestructorDecl>(Method))
1504 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1505 } else {
1506 // Emit MS ABI vftable information. There is only one entry for the
1507 // deleting dtor.
1508 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1509 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
Reid Klecknercbec0262018-04-02 20:00:39 +00001510 MethodVFTableLocation ML =
Reid Kleckner216d0a12016-06-16 20:08:51 +00001511 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1512 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001513
1514 // CodeView only records the vftable offset in the class that introduces
1515 // the virtual method. This is possible because, unlike Itanium, the MS
1516 // C++ ABI does not include all virtual methods from non-primary bases in
1517 // the vtable for the most derived class. For example, if C inherits from
1518 // A and B, C's primary vftable will not include B's virtual methods.
Benjamin Krameracfa3392017-12-17 23:52:45 +00001519 if (Method->size_overridden_methods() == 0)
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001520 Flags |= llvm::DINode::FlagIntroducedVirtual;
1521
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001522 // The 'this' adjustment accounts for both the virtual and non-virtual
1523 // portions of the adjustment. Presumably the debugger only uses it when
1524 // it knows the dynamic type of an object.
1525 ThisAdjustment = CGM.getCXXABI()
1526 .getVirtualFunctionPrologueThisAdjustment(GD)
1527 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001528 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001529 ContainingType = RecordTy;
1530 }
1531
Adrian McCarthyd91bf392017-09-13 20:53:55 +00001532 if (Method->isStatic())
1533 Flags |= llvm::DINode::FlagStaticMember;
Guy Benyei11169dd2012-12-18 14:30:41 +00001534 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001535 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001536 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001537 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001538 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001539 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001540 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001541 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001542 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001543 }
1544 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001545 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001546 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001547 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001548 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001549 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001550
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001551 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1552 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001553 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001554 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1555 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1556 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001557
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001558 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001559
1560 return SP;
1561}
1562
Eric Christophere7b87e52014-10-26 23:40:33 +00001563void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001564 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1565 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001566
1567 // Since we want more than just the individual member decls if we
1568 // have templated functions iterate over every declaration to gather
1569 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001570 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001571 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1572 // If the member is implicit, don't add it to the member list. This avoids
1573 // the member being added to type units by LLVM, while still allowing it
1574 // to be emitted into the type declaration/reference inside the compile
1575 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001576 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001577 // FIXME: Handle Using(Shadow?)Decls here to create
1578 // DW_TAG_imported_declarations inside the class for base decls brought into
1579 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1580 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1581 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001582 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001583 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001584
1585 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1586 continue;
1587
David Blaikiefd580722014-10-06 05:18:55 +00001588 // Reuse the existing member function declaration if it exists.
1589 // It may be associated with the declaration of the type & should be
1590 // reused as we're building the definition.
1591 //
1592 // This situation can arise in the vtable-based debug info reduction where
1593 // implicit members are emitted in a non-vtable TU.
1594 auto MI = SPCache.find(Method->getCanonicalDecl());
1595 EltTys.push_back(MI == SPCache.end()
1596 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001597 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001598 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001599}
Guy Benyei11169dd2012-12-18 14:30:41 +00001600
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001601void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001602 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001603 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001604 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1605 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1606 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001607
Bob Haarmandff36732016-10-25 22:19:32 +00001608 // If we are generating CodeView debug info, we also need to emit records for
1609 // indirect virtual base classes.
1610 if (CGM.getCodeGenOpts().EmitCodeView) {
1611 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1612 llvm::DINode::FlagIndirectVirtualBase);
1613 }
1614}
1615
1616void CGDebugInfo::CollectCXXBasesAux(
1617 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1618 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1619 const CXXRecordDecl::base_class_const_range &Bases,
1620 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1621 llvm::DINode::DIFlags StartingFlags) {
1622 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1623 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001624 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001625 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001626 if (!SeenTypes.insert(Base).second)
1627 continue;
1628 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1629 llvm::DINode::DIFlags BFlags = StartingFlags;
1630 uint64_t BaseOffset;
Brock Wyma3db2b102018-05-14 21:21:22 +00001631 uint32_t VBPtrOffset = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001632
Aaron Ballman574705e2014-03-13 15:41:46 +00001633 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001634 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1635 // virtual base offset offset is -ve. The code generator emits dwarf
1636 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001637 BaseOffset = 0 - CGM.getItaniumVTableContext()
1638 .getVirtualBaseOffsetOffset(RD, Base)
1639 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001640 } else {
1641 // In the MS ABI, store the vbtable offset, which is analogous to the
1642 // vbase offset offset in Itanium.
1643 BaseOffset =
1644 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001645 VBPtrOffset = CGM.getContext()
1646 .getASTRecordLayout(RD)
1647 .getVBPtrOffset()
1648 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001649 }
Bob Haarmandff36732016-10-25 22:19:32 +00001650 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001651 } else
1652 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1653 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1654 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001655
Adrian Prantl21361fb2014-08-29 22:44:27 +00001656 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001657 llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1658 VBPtrOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001659 EltTys.push_back(DTy);
1660 }
1661}
1662
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001663llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001664CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1665 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001666 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001667 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001668 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1669 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001670 StringRef Name;
1671 if (TPList)
1672 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001673 switch (TA.getKind()) {
1674 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001675 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001676 TemplateParams.push_back(
1677 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001678 } break;
1679 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001680 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001681 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1682 TheCU, Name, TTy,
1683 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001684 } break;
1685 case TemplateArgument::Declaration: {
1686 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001687 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001688 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001689 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001690 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001691 // Variable pointer template parameters have a value that is the address
1692 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001693 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001694 V = CGM.GetAddrOfGlobalVar(VD);
1695 // Member function pointers have special support for building them, though
1696 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001697 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001698 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001699 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001700 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001701 // Member data pointers have special handling too to compute the fixed
1702 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001703 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001704 // These five lines (& possibly the above member function pointer
1705 // handling) might be able to be refactored to use similar code in
1706 // CodeGenModule::getMemberPointerConstant
1707 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1708 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001709 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001710 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001711 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001712 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1713 TheCU, Name, TTy,
1714 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001715 } break;
1716 case TemplateArgument::NullPtr: {
1717 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001718 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001719 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001720 // Special case member data pointer null values since they're actually -1
1721 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001722 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001723 // But treat member function pointers as simple zero integers because
1724 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1725 // CodeGen grows handling for values of non-null member function
1726 // pointers then perhaps we could remove this special case and rely on
1727 // EmitNullMemberPointer for member function pointers.
1728 if (MPT->isMemberDataPointer())
1729 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1730 if (!V)
1731 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001732 TemplateParams.push_back(
1733 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001734 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001735 case TemplateArgument::Template:
1736 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001737 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001738 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1739 break;
1740 case TemplateArgument::Pack:
1741 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1742 TheCU, Name, nullptr,
1743 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1744 break;
David Majnemer5559d472013-08-24 08:21:10 +00001745 case TemplateArgument::Expression: {
1746 const Expr *E = TA.getAsExpr();
1747 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001748 if (E->isGLValue())
1749 T = CGM.getContext().getLValueReferenceType(T);
John McCallde0fe072017-08-15 21:42:52 +00001750 llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001751 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001752 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001753 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001754 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001755 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001756 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001757 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001758 case TemplateArgument::Null:
1759 llvm_unreachable(
1760 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001761 }
1762 }
1763 return DBuilder.getOrCreateArray(TemplateParams);
1764}
1765
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001766llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001767CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001768 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001769 if (FD->getTemplatedKind() ==
1770 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001771 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1772 ->getTemplate()
1773 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001774 return CollectTemplateParams(
1775 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001776 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001777 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001778}
1779
Matthew Voss20165362018-10-03 18:45:04 +00001780llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1781 llvm::DIFile *Unit) {
1782 if (auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL)) {
1783 auto T = TS->getSpecializedTemplateOrPartial();
1784 auto TA = TS->getTemplateArgs().asArray();
1785 // Collect parameters for a partial specialization
1786 if (T.is<VarTemplatePartialSpecializationDecl *>()) {
1787 const TemplateParameterList *TList =
1788 T.get<VarTemplatePartialSpecializationDecl *>()
1789 ->getTemplateParameters();
1790 return CollectTemplateParams(TList, TA, Unit);
1791 }
1792
1793 // Collect parameters for an explicit specialization
1794 if (T.is<VarTemplateDecl *>()) {
1795 const TemplateParameterList *TList = T.get<VarTemplateDecl *>()
1796 ->getTemplateParameters();
1797 return CollectTemplateParams(TList, TA, Unit);
1798 }
1799 }
1800 return llvm::DINodeArray();
1801}
1802
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001803llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1804 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001805 // Always get the full list of parameters, not just the ones from
1806 // the specialization.
1807 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001808 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001809 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001810 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001811}
1812
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001813llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001814 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001815 return VTablePtrType;
1816
1817 ASTContext &Context = CGM.getContext();
1818
1819 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001820 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001821 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001822 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001823 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001824 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1825 Optional<unsigned> DWARFAddressSpace =
1826 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1827
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001828 llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1829 SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001830 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1831 return VTablePtrType;
1832}
1833
Guy Benyei11169dd2012-12-18 14:30:41 +00001834StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001835 // Copy the gdb compatible name on the side and use its reference.
1836 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001837}
1838
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001839void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001840 SmallVectorImpl<llvm::Metadata *> &EltTys,
1841 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001842 // If this class is not dynamic then there is not any vtable info to collect.
1843 if (!RD->isDynamicClass())
1844 return;
1845
Reid Kleckner59812422016-08-31 20:35:01 +00001846 // Don't emit any vtable shape or vptr info if this class doesn't have an
1847 // extendable vfptr. This can happen if the class doesn't have virtual
1848 // methods, or in the MS ABI if those virtual methods only come from virtually
1849 // inherited bases.
1850 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1851 if (!RL.hasExtendableVFPtr())
1852 return;
1853
Reid Klecknerdc124992016-08-31 16:11:43 +00001854 // CodeView needs to know how large the vtable of every dynamic class is, so
1855 // emit a special named pointer type into the element list. The vptr type
1856 // points to this type as well.
1857 llvm::DIType *VPtrTy = nullptr;
1858 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1859 CGM.getTarget().getCXXABI().isMicrosoft();
1860 if (NeedVTableShape) {
1861 uint64_t PtrWidth =
1862 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1863 const VTableLayout &VFTLayout =
1864 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1865 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001866 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001867 unsigned VTableWidth = PtrWidth * VSlotCount;
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001868 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1869 Optional<unsigned> DWARFAddressSpace =
1870 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
Reid Klecknerdc124992016-08-31 16:11:43 +00001871
1872 // Create a very wide void* type and insert it directly in the element list.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001873 llvm::DIType *VTableType = DBuilder.createPointerType(
1874 nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
Reid Klecknerdc124992016-08-31 16:11:43 +00001875 EltTys.push_back(VTableType);
1876
1877 // The vptr is a pointer to this special vtable type.
1878 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1879 }
1880
1881 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001882 if (RL.getPrimaryBase())
1883 return;
1884
1885 if (!VPtrTy)
1886 VPtrTy = getOrCreateVTablePtrType(Unit);
1887
Guy Benyei11169dd2012-12-18 14:30:41 +00001888 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001889 llvm::DIType *VPtrMember =
1890 DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1891 llvm::DINode::FlagArtificial, VPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001892 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001893}
1894
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001895llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001896 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001897 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001898 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001899 return T;
1900}
1901
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001902llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001903 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001904 return getOrCreateStandaloneType(D, Loc);
1905}
1906
1907llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1908 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001909 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001910 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001911 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001912 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001913
Adrian Prantl73409ce2013-03-11 18:33:46 +00001914 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001915 return T;
1916}
1917
David Blaikie483a9da2014-05-06 18:35:21 +00001918void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001919 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001920 return;
1921 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001922 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001923 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001924 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001925 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001926 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001927 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001928 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001929}
1930
David Blaikieb2e86eb2013-08-15 20:49:17 +00001931void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001932 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001933 !CGM.getLangOpts().CPlusPlus)
1934 completeRequiredType(RD);
1935}
1936
David Blaikieb11c8732017-01-30 06:36:08 +00001937/// Return true if the class or any of its methods are marked dllimport.
1938static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1939 if (RD->hasAttr<DLLImportAttr>())
1940 return true;
1941 for (const CXXMethodDecl *MD : RD->methods())
1942 if (MD->hasAttr<DLLImportAttr>())
1943 return true;
1944 return false;
1945}
1946
Adrian Prantla43acdc2017-07-24 23:48:51 +00001947/// Does a type definition exist in an imported clang module?
1948static bool isDefinedInClangModule(const RecordDecl *RD) {
1949 // Only definitions that where imported from an AST file come from a module.
1950 if (!RD || !RD->isFromASTFile())
1951 return false;
1952 // Anonymous entities cannot be addressed. Treat them as not from module.
1953 if (!RD->isExternallyVisible() && RD->getName().empty())
1954 return false;
1955 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1956 if (!CXXDecl->isCompleteDefinition())
1957 return false;
1958 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1959 if (TemplateKind != TSK_Undeclared) {
1960 // This is a template, check the origin of the first member.
1961 if (CXXDecl->field_begin() == CXXDecl->field_end())
1962 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1963 if (!CXXDecl->field_begin()->isFromASTFile())
1964 return false;
1965 }
1966 }
1967 return true;
1968}
1969
David Blaikie6943dea2013-08-20 01:28:15 +00001970void CGDebugInfo::completeClassData(const RecordDecl *RD) {
David Blaikieb11c8732017-01-30 06:36:08 +00001971 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1972 if (CXXRD->isDynamicClass() &&
1973 CGM.getVTableLinkage(CXXRD) ==
1974 llvm::GlobalValue::AvailableExternallyLinkage &&
1975 !isClassOrMethodDLLImport(CXXRD))
1976 return;
Adrian Prantla43acdc2017-07-24 23:48:51 +00001977
1978 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1979 return;
1980
David Blaikieb11c8732017-01-30 06:36:08 +00001981 completeClass(RD);
1982}
1983
1984void CGDebugInfo::completeClass(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001985 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001986 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001987 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001988 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001989 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001990 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001991 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001992 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001993 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001994 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001995}
1996
David Blaikie0e716b42014-03-03 23:48:23 +00001997static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1998 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001999 for (CXXMethodDecl *MD : llvm::make_range(I, End))
2000 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00002001 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00002002 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00002003 return true;
2004 return false;
2005}
2006
Benjamin Kramer8c305922016-02-02 11:06:51 +00002007static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2008 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00002009 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00002010 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00002011 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002012
David Blaikie1ac9c982017-04-11 21:13:37 +00002013 if (auto *ES = RD->getASTContext().getExternalSource())
2014 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2015 return true;
2016
Benjamin Kramer8c305922016-02-02 11:06:51 +00002017 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00002018 return false;
2019
2020 if (!LangOpts.CPlusPlus)
2021 return false;
2022
2023 if (!RD->isCompleteDefinitionRequired())
2024 return true;
2025
David Majnemer58ed0f32016-07-17 00:39:12 +00002026 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00002027
2028 if (!CXXDecl)
2029 return false;
2030
Adrian McCarthy99242982016-08-16 22:11:18 +00002031 // Only emit complete debug info for a dynamic class when its vtable is
2032 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00002033 // across DLL boundaries, so skip this optimization if the class or any of its
2034 // methods are marked dllimport. This isn't a complete solution, since objects
2035 // without any dllimport methods can be used in one DLL and constructed in
2036 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00002037 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00002038 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00002039 return true;
2040
2041 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00002042 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00002043 Spec = SD->getSpecializationKind();
2044
2045 if (Spec == TSK_ExplicitInstantiationDeclaration &&
2046 hasExplicitMemberDefinition(CXXDecl->method_begin(),
2047 CXXDecl->method_end()))
2048 return true;
2049
2050 return false;
2051}
2052
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00002053void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2054 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2055 return;
2056
2057 QualType Ty = CGM.getContext().getRecordType(RD);
2058 llvm::DIType *T = getTypeOrNull(Ty);
2059 if (T && T->isForwardDecl())
2060 completeClassData(RD);
2061}
2062
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002063llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002064 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002065 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002066 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2067 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002068 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002069 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002070 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00002071 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002072
David Blaikieb2e86eb2013-08-15 20:49:17 +00002073 return CreateTypeDefinition(Ty);
2074}
2075
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002076llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00002077 RecordDecl *RD = Ty->getDecl();
2078
Guy Benyei11169dd2012-12-18 14:30:41 +00002079 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002080 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002081
2082 // Records and classes and unions can all be recursive. To handle them, we
2083 // first generate a debug descriptor for the struct as a forward declaration.
2084 // Then (if it is a definition) we go through and get debug info for all of
2085 // its members. Finally, we create a descriptor for the complete type (which
2086 // may refer to the forward decl if the struct is recursive) and replace all
2087 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002088 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002089
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002090 const RecordDecl *D = RD->getDefinition();
2091 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002092 return FwdDecl;
2093
David Majnemer58ed0f32016-07-17 00:39:12 +00002094 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00002095 CollectContainingType(CXXDecl, FwdDecl);
2096
Guy Benyei11169dd2012-12-18 14:30:41 +00002097 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002098 LexicalBlockStack.emplace_back(&*FwdDecl);
2099 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002100
Guy Benyei11169dd2012-12-18 14:30:41 +00002101 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002102 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00002103 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00002104
2105 // Note: The split of CXXDecl information here is intentional, the
2106 // gdb tests will depend on a certain ordering at printout. The debug
2107 // information offsets are still correct if we merge them all together
2108 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00002109 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002110 if (CXXDecl) {
2111 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00002112 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002113 }
2114
Eric Christopher91a31902013-01-16 01:22:32 +00002115 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00002116 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00002117 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00002118 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002119
2120 LexicalBlockStack.pop_back();
2121 RegionMap.erase(Ty->getDecl());
2122
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002123 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002124 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002125
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002126 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002127 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002128 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002129
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002130 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002131 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002132}
2133
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002134llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2135 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002136 // Ignore protocols.
2137 return getOrCreateType(Ty->getBaseType(), Unit);
2138}
2139
Manman Rene6be26c2016-09-13 17:25:08 +00002140llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2141 llvm::DIFile *Unit) {
2142 // Ignore protocols.
2143 SourceLocation Loc = Ty->getDecl()->getLocation();
2144
2145 // Use Typedefs to represent ObjCTypeParamType.
2146 return DBuilder.createTypedef(
2147 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2148 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2149 getDeclContextDescriptor(Ty->getDecl()));
2150}
2151
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002152/// \return true if Getter has the default name for the property PD.
2153static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2154 const ObjCMethodDecl *Getter) {
2155 assert(PD);
2156 if (!Getter)
2157 return true;
2158
2159 assert(Getter->getDeclName().isObjCZeroArgSelector());
2160 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002161 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002162}
2163
2164/// \return true if Setter has the default name for the property PD.
2165static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2166 const ObjCMethodDecl *Setter) {
2167 assert(PD);
2168 if (!Setter)
2169 return true;
2170
2171 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00002172 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002173 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002174}
2175
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002176llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2177 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002178 ObjCInterfaceDecl *ID = Ty->getDecl();
2179 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002180 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002181
Adrian Prantl50fd1a82016-04-20 23:59:32 +00002182 // Return a forward declaration if this type was imported from a clang module,
2183 // and this is not the compile unit with the implementation of the type (which
2184 // may contain hidden ivars).
2185 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2186 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002187 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2188 ID->getName(),
2189 getDeclContextDescriptor(ID), Unit, 0);
2190
Guy Benyei11169dd2012-12-18 14:30:41 +00002191 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002192 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002193 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002194 auto RuntimeLang =
2195 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00002196
2197 // If this is just a forward declaration return a special forward-declaration
2198 // debug type since we won't be able to lay out the entire type.
2199 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00002200 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002201 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002202 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002203 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2204 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00002205 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002206 return FwdDecl;
2207 }
2208
David Blaikieef8a9512014-05-05 23:23:53 +00002209 return CreateTypeDefinition(Ty, Unit);
2210}
2211
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002212llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00002213CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2214 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00002215 // Use the Module pointer as the key into the cache. This is a
2216 // nullptr if the "Module" is a PCH, which is safe because we don't
2217 // support chained PCH debug info, so there can only be a single PCH.
2218 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002219 auto ModRef = ModuleCache.find(M);
2220 if (ModRef != ModuleCache.end())
2221 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00002222
2223 // Macro definitions that were defined with "-D" on the command line.
2224 SmallString<128> ConfigMacros;
2225 {
2226 llvm::raw_svector_ostream OS(ConfigMacros);
2227 const auto &PPOpts = CGM.getPreprocessorOpts();
2228 unsigned I = 0;
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002229 // Translate the macro definitions back into a command line.
Adrian Prantl2388ead2015-06-30 18:01:05 +00002230 for (auto &M : PPOpts.Macros) {
2231 if (++I > 1)
2232 OS << " ";
2233 const std::string &Macro = M.first;
2234 bool Undef = M.second;
2235 OS << "\"-" << (Undef ? 'U' : 'D');
2236 for (char c : Macro)
2237 switch (c) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002238 case '\\':
2239 OS << "\\\\";
2240 break;
2241 case '"':
2242 OS << "\\\"";
2243 break;
2244 default:
2245 OS << c;
Adrian Prantl2388ead2015-06-30 18:01:05 +00002246 }
2247 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002248 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002249 }
Adrian Prantl66689202015-09-18 23:01:45 +00002250
Adrian Prantl835e6632015-09-24 16:10:10 +00002251 bool IsRootModule = M ? !M->Parent : true;
2252 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002253 // PCH files don't have a signature field in the control block,
2254 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00002255 // We use the lower 64 bits for debug info.
2256 uint64_t Signature =
2257 Mod.getSignature()
2258 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2259 : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002260 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002261 DIB.createCompileUnit(TheCU->getSourceLanguage(),
Scott Lindera2fbcef2018-02-26 17:32:31 +00002262 // TODO: Support "Source" from external AST providers?
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002263 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2264 TheCU->getProducer(), true, StringRef(), 0,
2265 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2266 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002267 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002268 }
Adrian Prantl835e6632015-09-24 16:10:10 +00002269 llvm::DIModule *Parent =
2270 IsRootModule ? nullptr
2271 : getOrCreateModuleRef(
2272 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2273 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002274 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002275 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2276 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002277 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002278 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002279}
2280
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002281llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2282 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002283 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002284 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002285 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002286 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002287
2288 // Bit size, align and offset of the type.
2289 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002290 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002291
Leny Kholodov80c047d2016-09-06 10:48:04 +00002292 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002293 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002294 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002295
Adrian Prantlfd696112015-10-01 00:48:51 +00002296 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002297 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002298 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2299 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002300
David Blaikieef8a9512014-05-05 23:23:53 +00002301 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002302 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002303
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002304 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002305 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002306 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002307
2308 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002309 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002310
2311 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2312 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002313 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002314 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002315 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002316 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002317
Brock Wyma3db2b102018-05-14 21:21:22 +00002318 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002319 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002320 EltTys.push_back(InhTag);
2321 }
2322
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002323 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002324 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002325 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002326 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002327 unsigned PLine = getLineNumber(Loc);
2328 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2329 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002330 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2331 PD->getName(), PUnit, PLine,
2332 hasDefaultGetterName(PD, Getter) ? ""
2333 : getSelectorName(PD->getGetterName()),
2334 hasDefaultSetterName(PD, Setter) ? ""
2335 : getSelectorName(PD->getSetterName()),
2336 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002337 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002338 };
2339 {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002340 llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002341 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002342 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002343 PropertySet.insert(PD->getIdentifier());
2344 AddProperty(PD);
2345 }
Manman Renefe1bac2016-01-27 20:00:32 +00002346 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002347 // Don't emit duplicate metadata for properties that were already in a
2348 // class extension.
2349 if (!PropertySet.insert(PD->getIdentifier()).second)
2350 continue;
2351 AddProperty(PD);
2352 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002353 }
2354
2355 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2356 unsigned FieldNo = 0;
2357 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2358 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002359 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002360 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002361 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002362
Guy Benyei11169dd2012-12-18 14:30:41 +00002363 StringRef FieldName = Field->getName();
2364
2365 // Ignore unnamed fields.
2366 if (FieldName.empty())
2367 continue;
2368
2369 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002370 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002371 unsigned FieldLine = getLineNumber(Field->getLocation());
2372 QualType FType = Field->getType();
2373 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002374 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002375
2376 if (!FType->isIncompleteArrayType()) {
2377
2378 // Bit size, align and offset of the type.
2379 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002380 ? Field->getBitWidthValue(CGM.getContext())
2381 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002382 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002383 }
2384
2385 uint64_t FieldOffset;
2386 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2387 // We don't know the runtime offset of an ivar if we're using the
2388 // non-fragile ABI. For bitfields, use the bit offset into the first
2389 // byte of storage of the bitfield. For other fields, use zero.
2390 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002391 FieldOffset =
2392 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002393 FieldOffset %= CGM.getContext().getCharWidth();
2394 } else {
2395 FieldOffset = 0;
2396 }
2397 } else {
2398 FieldOffset = RL.getFieldOffset(FieldNo);
2399 }
2400
Leny Kholodov80c047d2016-09-06 10:48:04 +00002401 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002403 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002404 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002405 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002406 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002407 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002408
Craig Topper8a13c412014-05-21 05:09:00 +00002409 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002410 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002411 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002412 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002413 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002414 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002415 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002416 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002417 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2418 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002419 PropertyNode = DBuilder.createObjCProperty(
2420 PD->getName(), PUnit, PLine,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002421 hasDefaultGetterName(PD, Getter)
2422 ? ""
2423 : getSelectorName(PD->getGetterName()),
2424 hasDefaultSetterName(PD, Setter)
2425 ? ""
2426 : getSelectorName(PD->getSetterName()),
Eric Christophere7b87e52014-10-26 23:40:33 +00002427 PD->getPropertyAttributes(),
2428 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002429 }
2430 }
2431 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002432 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2433 FieldSize, FieldAlign, FieldOffset, Flags,
2434 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002435 EltTys.push_back(FieldTy);
2436 }
2437
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002438 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002439 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002440
Guy Benyei11169dd2012-12-18 14:30:41 +00002441 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002442 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002443}
2444
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002445llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2446 llvm::DIFile *Unit) {
2447 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002448 int64_t Count = Ty->getNumElements();
Guy Benyei11169dd2012-12-18 14:30:41 +00002449
Sander de Smalen891af03a2018-02-03 13:55:59 +00002450 llvm::Metadata *Subscript;
2451 QualType QTy(Ty, 0);
2452 auto SizeExpr = SizeExprCache.find(QTy);
2453 if (SizeExpr != SizeExprCache.end())
2454 Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2455 else
2456 Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002457 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002458
2459 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002460 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002461
2462 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2463}
2464
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002465llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002466 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002467 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002468
2469 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002470 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002471 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002472 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2473 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002474 } else if (Ty->isIncompleteArrayType()) {
2475 Size = 0;
2476 if (Ty->getElementType()->isIncompleteType())
2477 Align = 0;
2478 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002479 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002480 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002481 Size = 0;
2482 Align = 0;
2483 } else {
2484 // Size and align of the whole array, not the element type.
2485 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002486 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002487 }
2488
2489 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2490 // interior arrays, do we care? Why aren't nested arrays represented the
2491 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002492 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002493 QualType EltTy(Ty, 0);
2494 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2495 // If the number of elements is known, then count is that number. Otherwise,
2496 // it's -1. This allows us to represent a subrange with an array of 0
2497 // elements, like this:
2498 //
2499 // struct foo {
2500 // int x[0];
2501 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002502 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002503 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002504 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002505 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002506 if (Expr *Size = VAT->getSizeExpr()) {
2507 llvm::APSInt V;
2508 if (Size->EvaluateAsInt(V, CGM.getContext()))
2509 Count = V.getExtValue();
2510 }
David Blaikie87173f12016-08-22 17:49:56 +00002511 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002512
Sander de Smalen891af03a2018-02-03 13:55:59 +00002513 auto SizeNode = SizeExprCache.find(EltTy);
2514 if (SizeNode != SizeExprCache.end())
2515 Subscripts.push_back(
2516 DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2517 else
2518 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
Guy Benyei11169dd2012-12-18 14:30:41 +00002519 EltTy = Ty->getElementType();
2520 }
2521
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002522 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002523
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002524 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2525 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002526}
2527
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002528llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2529 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002530 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2531 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002532}
2533
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002534llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2535 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002536 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2537 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002538}
2539
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002540llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2541 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002542 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002543 uint64_t Size = 0;
2544
2545 if (!Ty->isIncompleteType()) {
2546 Size = CGM.getContext().getTypeSize(Ty);
2547
2548 // Set the MS inheritance model. There is no flag for the unspecified model.
2549 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2550 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2551 case MSInheritanceAttr::Keyword_single_inheritance:
2552 Flags |= llvm::DINode::FlagSingleInheritance;
2553 break;
2554 case MSInheritanceAttr::Keyword_multiple_inheritance:
2555 Flags |= llvm::DINode::FlagMultipleInheritance;
2556 break;
2557 case MSInheritanceAttr::Keyword_virtual_inheritance:
2558 Flags |= llvm::DINode::FlagVirtualInheritance;
2559 break;
2560 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2561 break;
2562 }
2563 }
2564 }
2565
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002566 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002567 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002568 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002569 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2570 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002571
2572 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002573 Ty->getPointeeType()->getAs<FunctionProtoType>();
2574 return DBuilder.createMemberPointerType(
2575 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2576 Ty->getClass(), FPT->getTypeQuals())),
2577 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002578 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002579}
2580
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002581llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002582 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2583 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002584}
2585
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002586llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
Xiuli Pan9c14e282016-01-09 12:53:17 +00002587 return getOrCreateType(Ty->getElementType(), U);
2588}
2589
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002590llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002591 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002592
Guy Benyei11169dd2012-12-18 14:30:41 +00002593 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002594 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002595 if (!ED->getTypeForDecl()->isIncompleteType()) {
2596 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002597 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002598 }
2599
Brock Wyma8557ec52018-05-22 12:41:19 +00002600 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002601
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002602 bool isImportedFromModule =
2603 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2604
Guy Benyei11169dd2012-12-18 14:30:41 +00002605 // If this is just a forward declaration, construct an appropriately
2606 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002607 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002608 // Note that it is possible for enums to be created as part of
2609 // their own declcontext. In this case a FwdDecl will be created
2610 // twice. This doesn't cause a problem because both FwdDecls are
2611 // entered into the ReplaceMap: finalize() will replace the first
2612 // FwdDecl with the second and then replace the second with
2613 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002614 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002615 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002616 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2617 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002618
Guy Benyei11169dd2012-12-18 14:30:41 +00002619 unsigned Line = getLineNumber(ED->getLocation());
2620 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002621 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002622 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
Brock Wyma8557ec52018-05-22 12:41:19 +00002623 0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
Adrian Prantla40030f2016-02-06 01:59:09 +00002624
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002625 ReplaceMap.emplace_back(
2626 std::piecewise_construct, std::make_tuple(Ty),
2627 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002628 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002629 }
2630
David Blaikie483a9da2014-05-06 18:35:21 +00002631 return CreateTypeDefinition(Ty);
2632}
2633
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002634llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002635 const EnumDecl *ED = Ty->getDecl();
2636 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002637 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002638 if (!ED->getTypeForDecl()->isIncompleteType()) {
2639 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002640 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002641 }
2642
Brock Wyma8557ec52018-05-22 12:41:19 +00002643 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
David Blaikie483a9da2014-05-06 18:35:21 +00002644
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002645 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002646 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002647 ED = ED->getDefinition();
Momchil Velikov25f6be52018-02-12 16:12:52 +00002648 bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002649 for (const auto *Enum : ED->enumerators()) {
Momchil Velikov25f6be52018-02-12 16:12:52 +00002650 const auto &InitVal = Enum->getInitVal();
2651 auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2652 Enumerators.push_back(
2653 DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
Guy Benyei11169dd2012-12-18 14:30:41 +00002654 }
2655
2656 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002657 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002658
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002659 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002660 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002661 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Momchil Velikov25f6be52018-02-12 16:12:52 +00002662 llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002663 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2664 Line, Size, Align, EltArray, ClassTy,
Brock Wyma8557ec52018-05-22 12:41:19 +00002665 Identifier, ED->isFixed());
Guy Benyei11169dd2012-12-18 14:30:41 +00002666}
2667
Amjad Aboud546bc112017-02-09 22:07:24 +00002668llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2669 unsigned MType, SourceLocation LineLoc,
2670 StringRef Name, StringRef Value) {
2671 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2672 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2673}
2674
2675llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2676 SourceLocation LineLoc,
2677 SourceLocation FileLoc) {
2678 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2679 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2680 return DBuilder.createTempMacroFile(Parent, Line, FName);
2681}
2682
David Blaikie05491062013-01-21 04:37:12 +00002683static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2684 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002685 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002686 Qualifiers InnerQuals = T.getLocalQualifiers();
2687 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2688 // that is already there.
2689 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2690 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002691 QualType LastT = T;
2692 switch (T->getTypeClass()) {
2693 default:
David Blaikie05491062013-01-21 04:37:12 +00002694 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002695 case Type::TemplateSpecialization: {
2696 const auto *Spec = cast<TemplateSpecializationType>(T);
2697 if (Spec->isTypeAlias())
2698 return C.getQualifiedType(T.getTypePtr(), Quals);
2699 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002700 break;
2701 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002702 case Type::TypeOfExpr:
2703 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2704 break;
2705 case Type::TypeOf:
2706 T = cast<TypeOfType>(T)->getUnderlyingType();
2707 break;
2708 case Type::Decltype:
2709 T = cast<DecltypeType>(T)->getUnderlyingType();
2710 break;
2711 case Type::UnaryTransform:
2712 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2713 break;
2714 case Type::Attributed:
2715 T = cast<AttributedType>(T)->getEquivalentType();
2716 break;
2717 case Type::Elaborated:
2718 T = cast<ElaboratedType>(T)->getNamedType();
2719 break;
2720 case Type::Paren:
2721 T = cast<ParenType>(T)->getInnerType();
2722 break;
David Blaikie05491062013-01-21 04:37:12 +00002723 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002724 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002725 break;
Richard Smitha0abc422017-02-22 00:13:14 +00002726 case Type::Auto:
2727 case Type::DeducedTemplateSpecialization: {
2728 QualType DT = cast<DeducedType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002729 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002730 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002731 break;
2732 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002733 case Type::Adjusted:
2734 case Type::Decayed:
2735 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2736 T = cast<AdjustedType>(T)->getAdjustedType();
2737 break;
2738 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002739
Guy Benyei11169dd2012-12-18 14:30:41 +00002740 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002741 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002742 } while (true);
2743}
2744
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002745llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002746
2747 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002748 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002749
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002750 auto It = TypeCache.find(Ty.getAsOpaquePtr());
2751 if (It != TypeCache.end()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002752 // Verify that the debug info still exists.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002753 if (llvm::Metadata *V = It->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002754 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002755 }
2756
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002757 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002758}
2759
David Blaikie0e716b42014-03-03 23:48:23 +00002760void CGDebugInfo::completeTemplateDefinition(
2761 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002762 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002763 return;
David Blaikie1ac9c982017-04-11 21:13:37 +00002764 completeUnusedClass(SD);
2765}
David Blaikie0856f662014-03-04 22:01:08 +00002766
David Blaikie1ac9c982017-04-11 21:13:37 +00002767void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2768 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2769 return;
2770
2771 completeClassData(&D);
David Blaikie0e716b42014-03-03 23:48:23 +00002772 // In case this type has no member function definitions being emitted, ensure
2773 // it is retained
David Blaikie1ac9c982017-04-11 21:13:37 +00002774 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
David Blaikie0e716b42014-03-03 23:48:23 +00002775}
2776
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002777llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002778 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002779 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002780
2781 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002782 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002783
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002784 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002785 return T;
2786
Adrian Prantlca844182015-09-11 17:23:03 +00002787 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002788 void *TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002789
2790 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002791 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002792
Guy Benyei11169dd2012-12-18 14:30:41 +00002793 return Res;
2794}
2795
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002796llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002797 // A forward declaration inside a module header does not belong to the module.
2798 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2799 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002800 if (DebugTypeExtRefs && D->isFromASTFile()) {
2801 // Record a reference to an imported clang module or precompiled header.
2802 auto *Reader = CGM.getContext().getExternalSource();
2803 auto Idx = D->getOwningModuleID();
2804 auto Info = Reader->getSourceDescriptor(Idx);
2805 if (Info)
2806 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2807 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002808 // We are building a clang module or a precompiled header.
2809 //
2810 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2811 // and it wouldn't be necessary to specify the parent scope
2812 // because the type is already unique by definition (it would look
2813 // like the output of -fno-standalone-debug). On the other hand,
2814 // the parent scope helps a consumer to quickly locate the object
2815 // file where the type's definition is located, so it might be
2816 // best to make this behavior a command line or debugger tuning
2817 // option.
Richard Smith54f04402017-05-18 02:29:20 +00002818 if (Module *M = D->getOwningModule()) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002819 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002820 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2821 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002822 } else {
2823 // This the precompiled header being built.
2824 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002825 }
2826 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002827
Adrian Prantl9402cef2015-09-20 16:51:35 +00002828 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002829}
2830
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002831llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002832 // Handle qualifiers, which recursively handles what they refer to.
2833 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002834 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002835
Guy Benyei11169dd2012-12-18 14:30:41 +00002836 // Work out details of type.
2837 switch (Ty->getTypeClass()) {
2838#define TYPE(Class, Base)
2839#define ABSTRACT_TYPE(Class, Base)
2840#define NON_CANONICAL_TYPE(Class, Base)
2841#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2842#include "clang/AST/TypeNodes.def"
2843 llvm_unreachable("Dependent types cannot show up in debug information");
2844
2845 case Type::ExtVector:
2846 case Type::Vector:
2847 return CreateType(cast<VectorType>(Ty), Unit);
2848 case Type::ObjCObjectPointer:
2849 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2850 case Type::ObjCObject:
2851 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002852 case Type::ObjCTypeParam:
2853 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002854 case Type::ObjCInterface:
2855 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2856 case Type::Builtin:
2857 return CreateType(cast<BuiltinType>(Ty));
2858 case Type::Complex:
2859 return CreateType(cast<ComplexType>(Ty));
2860 case Type::Pointer:
2861 return CreateType(cast<PointerType>(Ty), Unit);
2862 case Type::BlockPointer:
2863 return CreateType(cast<BlockPointerType>(Ty), Unit);
2864 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002865 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002866 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002867 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002868 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002869 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002870 case Type::FunctionProto:
2871 case Type::FunctionNoProto:
2872 return CreateType(cast<FunctionType>(Ty), Unit);
2873 case Type::ConstantArray:
2874 case Type::VariableArray:
2875 case Type::IncompleteArray:
2876 return CreateType(cast<ArrayType>(Ty), Unit);
2877
2878 case Type::LValueReference:
2879 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2880 case Type::RValueReference:
2881 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2882
2883 case Type::MemberPointer:
2884 return CreateType(cast<MemberPointerType>(Ty), Unit);
2885
2886 case Type::Atomic:
2887 return CreateType(cast<AtomicType>(Ty), Unit);
2888
Xiuli Pan9c14e282016-01-09 12:53:17 +00002889 case Type::Pipe:
2890 return CreateType(cast<PipeType>(Ty), Unit);
2891
Guy Benyei11169dd2012-12-18 14:30:41 +00002892 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002893 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2894
David Blaikie42edade2014-11-11 20:44:45 +00002895 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002896 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00002897 case Type::Adjusted:
2898 case Type::Decayed:
Richard Smith600b5262017-01-26 20:40:47 +00002899 case Type::DeducedTemplateSpecialization:
Guy Benyei11169dd2012-12-18 14:30:41 +00002900 case Type::Elaborated:
2901 case Type::Paren:
2902 case Type::SubstTemplateTypeParm:
2903 case Type::TypeOfExpr:
2904 case Type::TypeOf:
2905 case Type::Decltype:
2906 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002907 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002908 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002909 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002910
David Blaikie42edade2014-11-11 20:44:45 +00002911 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002912}
2913
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002914llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2915 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002916 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002917
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002918 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002919
2920 // We may have cached a forward decl when we could have created
2921 // a non-forward decl. Go ahead and create a non-forward decl
2922 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002923 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002924 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002925
2926 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002927 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002928
2929 // Propagate members from the declaration to the definition
2930 // CreateType(const RecordType*) will overwrite this with the members in the
2931 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002932 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002933
Guy Benyei11169dd2012-12-18 14:30:41 +00002934 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002935 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002936 return Res;
2937}
2938
2939// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002940llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002941 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002942
Guy Benyei11169dd2012-12-18 14:30:41 +00002943 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002944 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002945 unsigned Line = getLineNumber(RD->getLocation());
2946 StringRef RDName = getClassName(RD);
2947
Amjad Abouddc4531e2016-04-30 01:44:38 +00002948 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002949
David Blaikied2785892013-08-18 17:36:19 +00002950 // If we ended up creating the type during the context chain construction,
2951 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002952 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002953 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002954 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002955 return T;
David Blaikied2785892013-08-18 17:36:19 +00002956
Adrian Prantl381e7552014-02-04 21:29:50 +00002957 // If this is just a forward or incomplete declaration, construct an
2958 // appropriately marked node and just return it.
2959 const RecordDecl *D = RD->getDefinition();
2960 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002961 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002962
2963 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002964 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002965
Brock Wyma8557ec52018-05-22 12:41:19 +00002966 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002967
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00002968 // Explicitly record the calling convention for C++ records.
2969 auto Flags = llvm::DINode::FlagZero;
2970 if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
2971 if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
2972 Flags |= llvm::DINode::FlagTypePassByReference;
2973 else
2974 Flags |= llvm::DINode::FlagTypePassByValue;
Aaron Smith044326c2018-07-23 20:49:07 +00002975
2976 // Record if a C++ record is trivial type.
2977 if (CXXRD->isTrivial())
2978 Flags |= llvm::DINode::FlagTrivial;
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00002979 }
2980
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002981 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00002982 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +00002983 Flags, Identifier);
Guy Benyei11169dd2012-12-18 14:30:41 +00002984
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002985 // Elements of composite types usually have back to the type, creating
2986 // uniquing cycles. Distinct nodes are more efficient.
2987 switch (RealDecl->getTag()) {
2988 default:
2989 llvm_unreachable("invalid composite type tag");
2990
2991 case llvm::dwarf::DW_TAG_array_type:
2992 case llvm::dwarf::DW_TAG_enumeration_type:
2993 // Array elements and most enumeration elements don't have back references,
2994 // so they don't tend to be involved in uniquing cycles and there is some
2995 // chance of merging them when linking together two modules. Only make
2996 // them distinct if they are ODR-uniqued.
Brock Wyma8557ec52018-05-22 12:41:19 +00002997 if (Identifier.empty())
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002998 break;
Galina Kistanova0872d6c2017-06-03 06:30:46 +00002999 LLVM_FALLTHROUGH;
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003000
3001 case llvm::dwarf::DW_TAG_structure_type:
3002 case llvm::dwarf::DW_TAG_union_type:
3003 case llvm::dwarf::DW_TAG_class_type:
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003004 // Immediately resolve to a distinct node.
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003005 RealDecl =
3006 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3007 break;
3008 }
3009
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003010 RegionMap[Ty->getDecl()].reset(RealDecl);
3011 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003012
David Majnemer58ed0f32016-07-17 00:39:12 +00003013 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003014 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00003015 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00003016 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00003017}
3018
David Blaikieadfbf992013-08-18 16:55:33 +00003019void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003020 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00003021 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003022 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00003023 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3024 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00003025 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00003026 while (1) {
3027 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3028 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3029 if (PBT && !BRL.isPrimaryBaseVirtual())
3030 PBase = PBT;
3031 else
3032 break;
3033 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003034 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00003035 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3036 getOrCreateFile(RD->getLocation())));
3037 } else if (RD->isDynamicClass())
3038 ContainingType = RealDecl;
3039
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00003040 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00003041}
3042
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003043llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003044 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003045 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003046 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00003047 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003048 llvm::DIType *Ty =
3049 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3050 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003051 *Offset += FieldSize;
3052 return Ty;
3053}
3054
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003055void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00003056 StringRef &Name,
3057 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003058 llvm::DIScope *&FDContext,
3059 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003060 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003061 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00003062 Name = getFunctionName(FD);
3063 // Use mangled name as linkage name for C/C++ functions.
3064 if (FD->hasPrototype()) {
3065 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003066 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00003067 }
3068 // No need to replicate the linkage name if it isn't different from the
3069 // subprogram name, no need to have it at all unless coverage is enabled or
Dehao Chenb3a70de2017-01-19 00:44:21 +00003070 // debug is set to more than just line tables or extra debug info is needed.
Benjamin Kramer8c305922016-02-02 11:06:51 +00003071 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3072 !CGM.getCodeGenOpts().EmitGcovNotes &&
Dehao Chenb3a70de2017-01-19 00:44:21 +00003073 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
Benjamin Kramer8c305922016-02-02 11:06:51 +00003074 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00003075 LinkageName = StringRef();
3076
Benjamin Kramer8c305922016-02-02 11:06:51 +00003077 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003078 if (const NamespaceDecl *NSDecl =
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003079 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Adrian Prantlddb8e062017-05-12 16:23:53 +00003080 FDContext = getOrCreateNamespace(NSDecl);
Frederic Riss9db79f12014-11-18 03:40:46 +00003081 else if (const RecordDecl *RDecl =
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003082 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003083 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3084 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3085 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00003086 // Check if it is a noreturn-marked function
3087 if (FD->isNoReturn())
3088 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00003089 // Collect template parameters.
3090 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3091 }
3092}
3093
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003094void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00003095 unsigned &LineNo, QualType &T,
3096 StringRef &Name, StringRef &LinkageName,
Matthew Voss20165362018-10-03 18:45:04 +00003097 llvm::MDTuple *&TemplateParameters,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003098 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003099 Unit = getOrCreateFile(VD->getLocation());
3100 LineNo = getLineNumber(VD->getLocation());
3101
3102 setLocation(VD->getLocation());
3103
3104 T = VD->getType();
3105 if (T->isIncompleteArrayType()) {
3106 // CodeGen turns int[] into int[1] so we'll do the same here.
3107 llvm::APInt ConstVal(32, 1);
3108 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3109
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003110 T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3111 0);
Frederic Riss9db79f12014-11-18 03:40:46 +00003112 }
3113
3114 Name = VD->getName();
3115 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3116 !isa<ObjCMethodDecl>(VD->getDeclContext()))
3117 LinkageName = CGM.getMangledName(VD);
3118 if (LinkageName == Name)
3119 LinkageName = StringRef();
3120
Matthew Voss20165362018-10-03 18:45:04 +00003121 if (isa<VarTemplateSpecializationDecl>(VD)) {
3122 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3123 TemplateParameters = parameterNodes.get();
3124 } else {
3125 TemplateParameters = nullptr;
3126 }
3127
Frederic Riss9db79f12014-11-18 03:40:46 +00003128 // Since we emit declarations (DW_AT_members) for static members, place the
3129 // definition of those static members in the namespace they were declared in
3130 // in the source code (the lexical decl context).
3131 // FIXME: Generalize this for even non-member global variables where the
3132 // declaration and definition may have different lexical decl contexts, once
3133 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003134 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3135 : VD->getDeclContext();
3136 // When a record type contains an in-line initialization of a static data
3137 // member, and the record type is marked as __declspec(dllexport), an implicit
3138 // definition of the member will be created in the record context. DWARF
3139 // doesn't seem to have a nice way to describe this in a form that consumers
3140 // are likely to understand, so fake the "normal" situation of a definition
3141 // outside the class by putting it in the global scope.
3142 if (DC->isRecord())
3143 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003144
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003145 llvm::DIScope *Mod = getParentModuleOrNull(VD);
3146 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00003147}
3148
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003149llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3150 bool Stub) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003151 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00003152 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003153 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003154 SourceLocation Loc = GD.getDecl()->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003155 llvm::DIFile *Unit = getOrCreateFile(Loc);
3156 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003157 unsigned Line = getLineNumber(Loc);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003158 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3159 Flags);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003160 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3161
Frederic Rissd253ed62014-11-18 03:40:51 +00003162 // Build function type.
3163 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003164 if (FD)
3165 for (const ParmVarDecl *Parm : FD->parameters())
3166 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00003167 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3168 QualType FnType = CGM.getContext().getFunctionType(
3169 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003170 if (Stub) {
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003171 Flags |= getCallSiteRelatedAttrs();
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003172 return DBuilder.createFunction(
3173 DContext, Name, LinkageName, Unit, Line,
3174 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
3175 !FD->isExternallyVisible(),
3176 /* isDefinition = */ true, 0, Flags, CGM.getLangOpts().Optimize,
3177 TParamsArray.get(), getFunctionDeclaration(FD));
3178 }
3179
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003180 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003181 DContext, Name, LinkageName, Unit, Line,
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003182 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
3183 !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003184 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003185 TParamsArray.get(), getFunctionDeclaration(FD));
George Burgess IV00f70bd2018-03-01 05:43:23 +00003186 const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003187 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3188 std::make_tuple(CanonDecl),
3189 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00003190 return SP;
3191}
3192
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003193llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003194 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3195}
3196
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003197llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003198 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3199}
3200
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003201llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00003202CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3203 QualType T;
3204 StringRef Name, LinkageName;
3205 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003206 llvm::DIFile *Unit = getOrCreateFile(Loc);
3207 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003208 unsigned Line = getLineNumber(Loc);
Matthew Voss20165362018-10-03 18:45:04 +00003209 llvm::MDTuple *TemplateParameters = nullptr;
Frederic Rissd253ed62014-11-18 03:40:51 +00003210
Matthew Voss20165362018-10-03 18:45:04 +00003211 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3212 DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00003213 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003214 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3215 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Matthew Voss20165362018-10-03 18:45:04 +00003216 !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003217 FwdDeclReplaceMap.emplace_back(
3218 std::piecewise_construct,
3219 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3220 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003221 return GV;
3222}
3223
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003224llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003225 // We only need a declaration (not a definition) of the type - so use whatever
3226 // we would otherwise do to get a type for a pointee. (forward declarations in
3227 // limited debug info, full definitions (if the type definition is available)
3228 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00003229 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00003230 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00003231 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003232 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00003233
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003234 if (I != DeclCache.end()) {
3235 auto N = I->second;
3236 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3237 return GVE->getVariable();
3238 return dyn_cast_or_null<llvm::DINode>(N);
3239 }
Frederic Rissd253ed62014-11-18 03:40:51 +00003240
3241 // No definition for now. Emit a forward definition that might be
3242 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00003243 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00003244 return getFunctionForwardDeclaration(FD);
3245 else if (const auto *VD = dyn_cast<VarDecl>(D))
3246 return getGlobalVariableForwardDeclaration(VD);
3247
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003248 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00003249}
3250
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003251llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003252 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003253 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00003254
David Majnemer58ed0f32016-07-17 00:39:12 +00003255 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00003256 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003257 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003258
3259 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003260 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003261
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003262 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00003263 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003264 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003265 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003266 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00003267 }
3268 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003269 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003270 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003271 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003272 return SP;
3273 }
3274
Aaron Ballman86c93902014-03-06 23:45:36 +00003275 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003276 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003277 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003278 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003279 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003280 return SP;
3281 }
3282 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003283 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003284}
3285
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003286// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00003287// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003288llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003289 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003290 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003291 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003292 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3293 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00003294 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00003295
David Majnemer58ed0f32016-07-17 00:39:12 +00003296 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00003297 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00003298
3299 const auto *FTy = FnType->getAs<FunctionType>();
3300 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3301
David Majnemer58ed0f32016-07-17 00:39:12 +00003302 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003303 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003304 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00003305
3306 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00003307 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00003308
3309 // Replace the instancetype keyword with the actual type.
3310 if (ResultTy == CGM.getContext().getObjCInstanceType())
3311 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00003312 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00003313
Adrian Prantl7bec9032013-05-10 21:08:31 +00003314 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003315 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003316 QualType SelfDeclTy;
3317 if (auto *SelfDecl = OMethod->getSelfDecl())
3318 SelfDeclTy = SelfDecl->getType();
3319 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3320 if (FPT->getNumParams() > 1)
3321 SelfDeclTy = FPT->getParamType(0);
3322 if (!SelfDeclTy.isNull())
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003323 Elts.push_back(
3324 CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003325 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003326 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003327 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003328 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003329 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003330 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003331 // Variadic methods need a special marker at the end of the type list.
3332 if (OMethod->isVariadic())
3333 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003334
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003335 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003336 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3337 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003338 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003339
Adrian Prantl800faef2014-02-25 23:42:18 +00003340 // Handle variadic function types; they need an additional
3341 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003342 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003343 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003344 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003345 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003346 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3347 for (QualType ParamType : FPT->param_types())
3348 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003349 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003350 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003351 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3352 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003353 }
3354
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003355 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003356}
3357
Eric Christophere7b87e52014-10-26 23:40:33 +00003358void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3359 SourceLocation ScopeLoc, QualType FnType,
Brock Wyma94ece8f2018-04-16 16:53:57 +00003360 llvm::Function *Fn, bool CurFuncIsThunk,
3361 CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003362
3363 StringRef Name;
3364 StringRef LinkageName;
3365
3366 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3367
3368 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003369 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003370
Leny Kholodov80c047d2016-09-06 10:48:04 +00003371 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003372 llvm::DIFile *Unit = getOrCreateFile(Loc);
3373 llvm::DIScope *FDContext = Unit;
3374 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003375 if (!HasDecl) {
3376 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003377 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003378 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003379 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003380 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003381 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003382 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003383 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003384 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003385 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003386 return;
3387 }
3388 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003389 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3390 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003391 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003392 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003393 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003394 } else {
3395 // Use llvm function name.
3396 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003397 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003398 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003399 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003400 Name = Name.substr(1);
3401
Erich Keane293a0552018-02-14 00:14:07 +00003402 if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003403 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003404 // Artificial functions should not silently reuse CurLoc.
3405 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003406 }
Brock Wyma94ece8f2018-04-16 16:53:57 +00003407
3408 if (CurFuncIsThunk)
3409 Flags |= llvm::DINode::FlagThunk;
3410
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003411 llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
3412
Adrian Prantl42d71b92014-04-10 23:21:53 +00003413 unsigned LineNo = getLineNumber(Loc);
3414 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003415
Eric Christopher8018e412014-03-27 18:50:35 +00003416 // FIXME: The function declaration we're constructing here is mostly reusing
3417 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3418 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3419 // all subprograms instead of the actual context since subprogram definitions
3420 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003421 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003422 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00003423 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003424 true /*definition*/, ScopeLine, FlagsForDef, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003425 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003426 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003427 // We might get here with a VarDecl in the case we're generating
3428 // code for the initialization of globals. Do not record these decls
3429 // as they will overwrite the actual VarDecl Decl in the cache.
3430 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003431 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003432
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00003433 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3434 // Starting with DWARF V5 method declarations are emitted as children of
3435 // the interface type.
3436 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3437 const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3438 QualType QTy(ID->getTypeForDecl(), 0);
3439 auto It = TypeCache.find(QTy.getAsOpaquePtr());
3440 if (It != TypeCache.end()) {
3441 llvm::DICompositeType *InterfaceDecl =
3442 cast<llvm::DICompositeType>(It->second);
3443 llvm::DISubprogram *FD = DBuilder.createFunction(
3444 InterfaceDecl, Name, LinkageName, Unit, LineNo,
3445 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
3446 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3447 TParamsArray.get());
3448 DBuilder.finalizeSubprogram(FD);
3449 ObjCMethodCache[ID].push_back(FD);
3450 }
3451 }
3452 }
3453
Adrian Prantlbebb8932014-03-21 21:01:58 +00003454 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003455 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003456
Guy Benyei11169dd2012-12-18 14:30:41 +00003457 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003458 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003459}
3460
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003461void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3462 QualType FnType) {
3463 StringRef Name;
3464 StringRef LinkageName;
3465
3466 const Decl *D = GD.getDecl();
3467 if (!D)
3468 return;
3469
Leny Kholodov80c047d2016-09-06 10:48:04 +00003470 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003471 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003472 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003473 llvm::DINodeArray TParamsArray;
3474 if (isa<FunctionDecl>(D)) {
3475 // If there is a DISubprogram for this function available then use it.
3476 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3477 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003478 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003479 Name = getObjCMethodName(OMD);
3480 Flags |= llvm::DINode::FlagPrototyped;
3481 } else {
3482 llvm_unreachable("not a function or ObjC method");
3483 }
3484 if (!Name.empty() && Name[0] == '\01')
3485 Name = Name.substr(1);
3486
3487 if (D->isImplicit()) {
3488 Flags |= llvm::DINode::FlagArtificial;
3489 // Artificial functions without a location should not silently reuse CurLoc.
3490 if (Loc.isInvalid())
3491 CurLoc = SourceLocation();
3492 }
3493 unsigned LineNo = getLineNumber(Loc);
3494 unsigned ScopeLine = 0;
3495
Adrian Prantle76bda52016-04-15 15:55:45 +00003496 DBuilder.retainType(DBuilder.createFunction(
3497 FDContext, Name, LinkageName, Unit, LineNo,
3498 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3499 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3500 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003501}
3502
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003503void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3504 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3505 // If there is a subprogram for this function available then use it.
3506 auto FI = SPCache.find(FD->getCanonicalDecl());
3507 llvm::DISubprogram *SP = nullptr;
3508 if (FI != SPCache.end())
3509 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Adrian Prantl8040a212017-08-23 21:24:12 +00003510 if (!SP || !SP->isDefinition())
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003511 SP = getFunctionStub(GD);
3512 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3513 LexicalBlockStack.emplace_back(SP);
3514 setInlinedAt(Builder.getCurrentDebugLocation());
3515 EmitLocation(Builder, FD->getLocation());
3516}
3517
3518void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3519 assert(CurInlinedAt && "unbalanced inline scope stack");
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003520 EmitFunctionEnd(Builder, nullptr);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003521 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3522}
3523
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003524void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003525 // Update our current location
3526 setLocation(Loc);
3527
Eric Christophere7b87e52014-10-26 23:40:33 +00003528 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3529 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003530
Adrian Prantle83b1302014-01-07 22:05:52 +00003531 llvm::MDNode *Scope = LexicalBlockStack.back();
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003532 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3533 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
Guy Benyei11169dd2012-12-18 14:30:41 +00003534}
3535
Guy Benyei11169dd2012-12-18 14:30:41 +00003536void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003537 llvm::MDNode *Back = nullptr;
3538 if (!LexicalBlockStack.empty())
3539 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003540 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003541 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003542 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003543}
3544
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003545void CGDebugInfo::AppendAddressSpaceXDeref(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003546 unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003547 Optional<unsigned> DWARFAddressSpace =
3548 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3549 if (!DWARFAddressSpace)
3550 return;
3551
3552 Expr.push_back(llvm::dwarf::DW_OP_constu);
3553 Expr.push_back(DWARFAddressSpace.getValue());
3554 Expr.push_back(llvm::dwarf::DW_OP_swap);
3555 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3556}
3557
Eric Christopher0fdcb312013-05-16 00:52:20 +00003558void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3559 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003560 // Set our current location.
3561 setLocation(Loc);
3562
Guy Benyei11169dd2012-12-18 14:30:41 +00003563 // Emit a line table change for the current location inside the new scope.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003564 Builder.SetCurrentDebugLocation(
3565 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3566 LexicalBlockStack.back(), CurInlinedAt));
David Blaikie60a877b2014-10-22 19:34:33 +00003567
Benjamin Kramer8c305922016-02-02 11:06:51 +00003568 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003569 return;
3570
3571 // Create a new lexical block and push it on the stack.
3572 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003573}
3574
Eric Christopher0fdcb312013-05-16 00:52:20 +00003575void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3576 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003577 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3578
3579 // Provide an entry in the line table for the end of the block.
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003580 EmitLocation(Builder, Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003581
Benjamin Kramer8c305922016-02-02 11:06:51 +00003582 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003583 return;
3584
Guy Benyei11169dd2012-12-18 14:30:41 +00003585 LexicalBlockStack.pop_back();
3586}
3587
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003588void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003589 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3590 unsigned RCount = FnBeginRegionCount.back();
3591 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3592
3593 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003594 while (LexicalBlockStack.size() != RCount) {
3595 // Provide an entry in the line table for the end of the block.
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003596 EmitLocation(Builder, CurLoc);
David Blaikie60a877b2014-10-22 19:34:33 +00003597 LexicalBlockStack.pop_back();
3598 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003599 FnBeginRegionCount.pop_back();
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003600
3601 if (Fn && Fn->getSubprogram())
3602 DBuilder.finalizeSubprogram(Fn->getSubprogram());
Guy Benyei11169dd2012-12-18 14:30:41 +00003603}
3604
Adrian Prantl05a623e2018-09-10 16:14:28 +00003605CGDebugInfo::BlockByRefType
3606CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3607 uint64_t *XOffset) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003608 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003609 QualType FType;
3610 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003611 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003612
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003613 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003614 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003615
3616 FieldOffset = 0;
3617 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3618 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3619 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3620 FType = CGM.getContext().IntTy;
3621 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3622 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3623
3624 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3625 if (HasCopyAndDispose) {
3626 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003627 EltTys.push_back(
3628 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3629 EltTys.push_back(
3630 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003631 }
3632 bool HasByrefExtendedLayout;
3633 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003634 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3635 HasByrefExtendedLayout) &&
3636 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003637 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003638 EltTys.push_back(
3639 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003640 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003641
Guy Benyei11169dd2012-12-18 14:30:41 +00003642 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3643 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003644 CGM.getTarget().getPointerAlign(0))) {
3645 CharUnits FieldOffsetInBytes =
3646 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003647 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003648 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003649
Guy Benyei11169dd2012-12-18 14:30:41 +00003650 if (NumPaddingBytes.isPositive()) {
3651 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3652 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3653 pad, ArrayType::Normal, 0);
3654 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3655 }
3656 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003657
Guy Benyei11169dd2012-12-18 14:30:41 +00003658 FType = Type;
Adrian Prantl05a623e2018-09-10 16:14:28 +00003659 llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003660 FieldSize = CGM.getContext().getTypeSize(FType);
3661 FieldAlign = CGM.getContext().toBits(Align);
3662
Eric Christopherb2a008c2013-05-16 00:45:12 +00003663 *XOffset = FieldOffset;
Adrian Prantl05a623e2018-09-10 16:14:28 +00003664 llvm::DIType *FieldTy = DBuilder.createMemberType(
3665 Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3666 llvm::DINode::FlagZero, WrappedTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003667 EltTys.push_back(FieldTy);
3668 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003669
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003670 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Adrian Prantl05a623e2018-09-10 16:14:28 +00003671 return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3672 llvm::DINode::FlagZero, nullptr, Elements),
3673 WrappedTy};
Guy Benyei11169dd2012-12-18 14:30:41 +00003674}
3675
Sander de Smalen891af03a2018-02-03 13:55:59 +00003676llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3677 llvm::Value *Storage,
3678 llvm::Optional<unsigned> ArgNo,
3679 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003680 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003681 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003682 if (VD->hasAttr<NoDebugAttr>())
Sander de Smalen891af03a2018-02-03 13:55:59 +00003683 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003684
David Blaikie7fceebf2013-08-19 03:37:48 +00003685 bool Unwritten =
3686 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3687 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003688 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003689 if (!Unwritten)
3690 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003691 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003692 uint64_t XOffset = 0;
3693 if (VD->hasAttr<BlocksAttr>())
Adrian Prantl05a623e2018-09-10 16:14:28 +00003694 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003695 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003696 Ty = getOrCreateType(VD->getType(), Unit);
3697
3698 // If there is no debug info for this type then do not emit debug info
3699 // for this variable.
3700 if (!Ty)
Sander de Smalen891af03a2018-02-03 13:55:59 +00003701 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003702
Guy Benyei11169dd2012-12-18 14:30:41 +00003703 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003704 unsigned Line = 0;
3705 unsigned Column = 0;
3706 if (!Unwritten) {
3707 Line = getLineNumber(VD->getLocation());
3708 Column = getColumnNumber(VD->getLocation());
3709 }
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003710 SmallVector<int64_t, 13> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003711 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003712 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003713 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003714
3715 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3716
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003717 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3718 AppendAddressSpaceXDeref(AddressSpace, Expr);
3719
Alexey Bataev24f710182017-06-09 13:55:08 +00003720 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3721 // object pointer flag.
Alexey Bataev56223232017-06-09 13:40:18 +00003722 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3723 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3724 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3725 Flags |= llvm::DINode::FlagObjectPointer;
3726 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003727
Adrian Prantlc3782a12017-04-18 01:22:01 +00003728 // Note: Older versions of clang used to emit byval references with an extra
3729 // DW_OP_deref, because they referenced the IR arg directly instead of
3730 // referencing an alloca. Newer versions of LLVM don't treat allocas
3731 // differently from other function arguments when used in a dbg.declare.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003732 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003733 StringRef Name = VD->getName();
3734 if (!Name.empty()) {
3735 if (VD->hasAttr<BlocksAttr>()) {
Adrian Prantlc3782a12017-04-18 01:22:01 +00003736 // Here, we need an offset *into* the alloca.
Guy Benyei11169dd2012-12-18 14:30:41 +00003737 CharUnits offset = CharUnits::fromQuantity(32);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003738 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003739 // offset of __forwarding field
3740 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003741 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003742 Expr.push_back(offset.getQuantity());
3743 Expr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003744 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003745 // offset of x field
3746 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003747 Expr.push_back(offset.getQuantity());
Adrian Prantlc3782a12017-04-18 01:22:01 +00003748 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003749 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003750 // If VD is an anonymous union then Storage represents value for
3751 // all union fields.
George Burgess IV00f70bd2018-03-01 05:43:23 +00003752 const RecordDecl *RD = RT->getDecl();
Adrian Prantl0d820892015-04-29 15:05:50 +00003753 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003754 // GDB has trouble finding local variables in anonymous unions, so we emit
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003755 // artificial local variables for each of the members.
Adrian Prantl00820ab2015-04-29 16:52:31 +00003756 //
3757 // FIXME: Remove this code as soon as GDB supports this.
3758 // The debug info verifier in LLVM operates based on the assumption that a
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003759 // variable has the same size as its storage and we had to disable the
3760 // check for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003761 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003762 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003763 StringRef FieldName = Field->getName();
3764
3765 // Ignore unnamed fields. Do not ignore unnamed records.
3766 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3767 continue;
3768
3769 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003770 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003771 auto *D = DBuilder.createAutoVariable(
3772 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003773 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003774
3775 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003776 DBuilder.insertDeclare(
3777 Storage, D, DBuilder.createExpression(Expr),
3778 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3779 Builder.GetInsertBlock());
Adrian Prantl0d820892015-04-29 15:05:50 +00003780 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003781 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003782 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003783
3784 // Create the descriptor for the variable.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003785 auto *D = ArgNo ? DBuilder.createParameterVariable(
3786 Scope, Name, *ArgNo, Unit, Line, Ty,
3787 CGM.getLangOpts().Optimize, Flags)
3788 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3789 CGM.getLangOpts().Optimize,
3790 Flags, Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003791
3792 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003793 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003794 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003795 Builder.GetInsertBlock());
Sander de Smalen891af03a2018-02-03 13:55:59 +00003796
3797 return D;
Guy Benyei11169dd2012-12-18 14:30:41 +00003798}
3799
Sander de Smalen891af03a2018-02-03 13:55:59 +00003800llvm::DILocalVariable *
3801CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
3802 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003803 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Sander de Smalen891af03a2018-02-03 13:55:59 +00003804 return EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003805}
3806
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003807llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3808 llvm::DIType *Ty) {
3809 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003810 if (CachedTy)
3811 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003812 return DBuilder.createObjectPointerType(Ty);
3813}
3814
Eric Christophere7b87e52014-10-26 23:40:33 +00003815void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3816 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003817 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003818 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003819 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003820
Craig Topper8a13c412014-05-21 05:09:00 +00003821 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003822 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003823 if (VD->hasAttr<NoDebugAttr>())
3824 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003825
Guy Benyei11169dd2012-12-18 14:30:41 +00003826 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003827
Guy Benyei11169dd2012-12-18 14:30:41 +00003828 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003829 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3830 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003831 if (isByRef)
Adrian Prantl05a623e2018-09-10 16:14:28 +00003832 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003833 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003834 Ty = getOrCreateType(VD->getType(), Unit);
3835
3836 // Self is passed along as an implicit non-arg variable in a
3837 // block. Mark it as the object pointer.
Alexey Bataev56223232017-06-09 13:40:18 +00003838 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3839 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3840 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003841
3842 // Get location information.
3843 unsigned Line = getLineNumber(VD->getLocation());
3844 unsigned Column = getColumnNumber(VD->getLocation());
3845
3846 const llvm::DataLayout &target = CGM.getDataLayout();
3847
3848 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003849 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003850 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3851
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003852 SmallVector<int64_t, 9> addr;
Adrian Prantlc3782a12017-04-18 01:22:01 +00003853 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003854 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003855 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003856 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003857 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003858 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003859 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003860 offset =
3861 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003862 addr.push_back(offset.getQuantity());
3863 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003864 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003865 // offset of x field
3866 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003867 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003868 }
3869
3870 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003871 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003872 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003873 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003874 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003875
Guy Benyei11169dd2012-12-18 14:30:41 +00003876 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003877 auto DL =
3878 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
Adrian Prantlc3782a12017-04-18 01:22:01 +00003879 auto *Expr = DBuilder.createExpression(addr);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003880 if (InsertPoint)
Adrian Prantlc3782a12017-04-18 01:22:01 +00003881 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003882 else
Adrian Prantlc3782a12017-04-18 01:22:01 +00003883 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003884}
3885
Guy Benyei11169dd2012-12-18 14:30:41 +00003886void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3887 unsigned ArgNo,
3888 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003889 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003890 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003891}
3892
3893namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003894struct BlockLayoutChunk {
3895 uint64_t OffsetInBits;
3896 const BlockDecl::Capture *Capture;
3897};
3898bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3899 return l.OffsetInBits < r.OffsetInBits;
3900}
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003901} // namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00003902
Scott Linder58df0e42018-08-08 15:56:12 +00003903void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
3904 const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
3905 const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
3906 SmallVectorImpl<llvm::Metadata *> &Fields) {
3907 // Blocks in OpenCL have unique constraints which make the standard fields
3908 // redundant while requiring size and align fields for enqueue_kernel. See
3909 // initializeForBlockHeader in CGBlocks.cpp
3910 if (CGM.getLangOpts().OpenCL) {
3911 Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
3912 BlockLayout.getElementOffsetInBits(0),
3913 Unit, Unit));
3914 Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
3915 BlockLayout.getElementOffsetInBits(1),
3916 Unit, Unit));
3917 } else {
3918 Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
3919 BlockLayout.getElementOffsetInBits(0),
3920 Unit, Unit));
3921 Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
3922 BlockLayout.getElementOffsetInBits(1),
3923 Unit, Unit));
3924 Fields.push_back(
3925 createFieldType("__reserved", Context.IntTy, Loc, AS_public,
3926 BlockLayout.getElementOffsetInBits(2), Unit, Unit));
3927 auto *FnTy = Block.getBlockExpr()->getFunctionType();
3928 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3929 Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
3930 BlockLayout.getElementOffsetInBits(3),
3931 Unit, Unit));
3932 Fields.push_back(createFieldType(
3933 "__descriptor",
3934 Context.getPointerType(Block.NeedsCopyDispose
3935 ? Context.getBlockDescriptorExtendedType()
3936 : Context.getBlockDescriptorType()),
3937 Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
3938 }
3939}
3940
Guy Benyei11169dd2012-12-18 14:30:41 +00003941void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl356347b2017-10-26 20:08:52 +00003942 StringRef Name,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003943 unsigned ArgNo,
Adrian Prantl356347b2017-10-26 20:08:52 +00003944 llvm::AllocaInst *Alloca,
Guy Benyei11169dd2012-12-18 14:30:41 +00003945 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003946 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003947 ASTContext &C = CGM.getContext();
3948 const BlockDecl *blockDecl = block.getBlockDecl();
3949
3950 // Collect some general information about the block's location.
3951 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003952 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003953 unsigned line = getLineNumber(loc);
3954 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003955
Guy Benyei11169dd2012-12-18 14:30:41 +00003956 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003957 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003958
3959 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003960 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003961
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003962 SmallVector<llvm::Metadata *, 16> fields;
Scott Linder58df0e42018-08-08 15:56:12 +00003963 collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
3964 fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003965
3966 // We want to sort the captures by offset, not because DWARF
3967 // requires this, but because we're paranoid about debuggers.
3968 SmallVector<BlockLayoutChunk, 8> chunks;
3969
3970 // 'this' capture.
3971 if (blockDecl->capturesCXXThis()) {
3972 BlockLayoutChunk chunk;
3973 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003974 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003975 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003976 chunks.push_back(chunk);
3977 }
3978
3979 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003980 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003981 const VarDecl *variable = capture.getVariable();
3982 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3983
3984 // Ignore constant captures.
3985 if (captureInfo.isConstant())
3986 continue;
3987
3988 BlockLayoutChunk chunk;
3989 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003990 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003991 chunk.Capture = &capture;
3992 chunks.push_back(chunk);
3993 }
3994
3995 // Sort by offset.
3996 llvm::array_pod_sort(chunks.begin(), chunks.end());
3997
David Majnemer58ed0f32016-07-17 00:39:12 +00003998 for (const BlockLayoutChunk &Chunk : chunks) {
3999 uint64_t offsetInBits = Chunk.OffsetInBits;
4000 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00004001
4002 // If we have a null capture, this must be the C++ 'this' capture.
4003 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00004004 QualType type;
4005 if (auto *Method =
4006 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
4007 type = Method->getThisType(C);
4008 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4009 type = QualType(RDecl->getTypeForDecl(), 0);
4010 else
4011 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00004012
David Majnemerb4b671e2016-06-30 03:01:59 +00004013 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00004014 offsetInBits, tunit, tunit));
4015 continue;
4016 }
4017
4018 const VarDecl *variable = capture->getVariable();
4019 StringRef name = variable->getName();
4020
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004021 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00004022 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00004023 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00004024 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Adrian Prantl05a623e2018-09-10 16:14:28 +00004025 // FIXME: This recomputes the layout of the BlockByRefWrapper.
Guy Benyei11169dd2012-12-18 14:30:41 +00004026 uint64_t xoffset;
Adrian Prantl05a623e2018-09-10 16:14:28 +00004027 fieldType =
4028 EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
David Majnemer34b57492014-07-30 01:30:47 +00004029 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00004030 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4031 PtrInfo.Width, Align, offsetInBits,
4032 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00004033 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004034 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00004035 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00004036 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00004037 }
4038 fields.push_back(fieldType);
4039 }
4040
4041 SmallString<36> typeName;
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004042 llvm::raw_svector_ostream(typeName)
4043 << "__block_literal_" << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00004044
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004045 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00004046
Leny Kholodovdf050fd2016-09-06 17:06:14 +00004047 llvm::DIType *type =
4048 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00004049 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00004050 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00004051 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4052
4053 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00004054 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004055 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00004056
4057 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00004058 auto *debugVar = DBuilder.createParameterVariable(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004059 scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00004060
Adrian Prantl616bef42013-03-14 21:52:59 +00004061 // Insert an llvm.dbg.declare into the current block.
Adrian Prantl356347b2017-10-26 20:08:52 +00004062 DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00004063 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00004064 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00004065}
4066
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004067llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00004068CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4069 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00004070 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00004071
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004072 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00004073 if (MI != StaticDataMemberCache.end()) {
4074 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00004075 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00004076 }
David Blaikiece763042013-08-20 21:49:21 +00004077
4078 // If the member wasn't found in the cache, lazily construct and add it to the
4079 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00004080 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004081 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00004082 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00004083}
4084
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004085llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004086 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4087 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004088 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004089
4090 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004091 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00004092 StringRef FieldName = Field->getName();
4093
4094 // Ignore unnamed fields, but recurse into anonymous records.
4095 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00004096 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004097 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004098 Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004099 continue;
4100 }
4101 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004102 GVE = DBuilder.createGlobalVariableExpression(
4103 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4104 Var->hasLocalLinkage());
4105 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004106 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004107 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00004108}
4109
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004110void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00004111 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004112 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004113 if (D->hasAttr<NoDebugAttr>())
4114 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004115
4116 // If we already created a DIGlobalVariable for this declaration, just attach
4117 // it to the llvm::GlobalVariable.
4118 auto Cached = DeclCache.find(D->getCanonicalDecl());
4119 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004120 return Var->addDebugInfo(
4121 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004122
Guy Benyei11169dd2012-12-18 14:30:41 +00004123 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004124 llvm::DIFile *Unit = nullptr;
4125 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00004126 unsigned LineNo;
4127 StringRef DeclName, LinkageName;
4128 QualType T;
Matthew Voss20165362018-10-03 18:45:04 +00004129 llvm::MDTuple *TemplateParameters = nullptr;
4130 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4131 TemplateParameters, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004132
4133 // Attempt to store one global variable for the declaration - even if we
4134 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004135 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004136
4137 // If this is an anonymous union then we'll want to emit a global
4138 // variable for each member of the anonymous union so that it's possible
4139 // to find the name of any field in the union.
4140 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00004141 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00004142 assert(RD->isAnonymousStructOrUnion() &&
4143 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004144 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004145 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004146 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004147
4148 SmallVector<int64_t, 4> Expr;
4149 unsigned AddressSpace =
4150 CGM.getContext().getTargetAddressSpace(D->getType());
4151 AppendAddressSpaceXDeref(AddressSpace, Expr);
4152
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004153 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00004154 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004155 Var->hasLocalLinkage(),
4156 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
Matthew Voss20165362018-10-03 18:45:04 +00004157 getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4158 Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004159 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004160 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004161 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00004162}
4163
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004164void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004165 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004166 if (VD->hasAttr<NoDebugAttr>())
4167 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00004168 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004169 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004170 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004171 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004172 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00004173 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4174 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004175 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4176 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
4177 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004178 // Do not use global variables for enums.
4179 //
4180 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004181 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004182 return;
David Blaikiea15565562014-04-04 20:56:17 +00004183 // Do not emit separate definitions for function local const/statics.
4184 if (isa<FunctionDecl>(VD->getDeclContext()))
4185 return;
David Blaikiebb113912014-04-05 07:23:17 +00004186 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00004187 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004188 if (VarD->isStaticDataMember()) {
4189 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004190 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00004191 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00004192 //
4193 // FIXME: This is probably unnecessary, since Ty should reference RD
4194 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00004195 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00004196 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00004197 return;
4198 }
4199
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004200 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004201
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004202 auto &GV = DeclCache[VD];
4203 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00004204 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004205 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00004206 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4207 // FIXME: Add a representation for integer constants wider than 64 bits.
4208 if (Init.isInt())
4209 InitExpr =
4210 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4211 else if (Init.isFloat())
4212 InitExpr = DBuilder.createConstantValueExpression(
4213 Init.getFloat().bitcastToAPInt().getZExtValue());
4214 }
Matthew Voss20165362018-10-03 18:45:04 +00004215
4216 llvm::MDTuple *TemplateParameters = nullptr;
4217
4218 if (isa<VarTemplateSpecializationDecl>(VD))
4219 if (VarD) {
4220 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4221 TemplateParameters = parameterNodes.get();
4222 }
4223
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004224 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00004225 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00004226 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
Matthew Voss20165362018-10-03 18:45:04 +00004227 TemplateParameters, Align));
David Blaikiebd483762013-05-20 04:58:53 +00004228}
4229
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004230llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00004231 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00004232 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00004233 llvm::DIScope *Mod = getParentModuleOrNull(D);
4234 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004235}
4236
David Blaikie9f88fe82013-04-22 06:13:21 +00004237void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004238 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004239 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004240 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00004241 if (!NSDecl->isAnonymousNamespace() ||
4242 CGM.getCodeGenOpts().DebugExplicitImport) {
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004243 auto Loc = UD.getLocation();
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004244 DBuilder.createImportedModule(
4245 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004246 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004247 }
David Blaikie9f88fe82013-04-22 06:13:21 +00004248}
4249
David Blaikiebd483762013-05-20 04:58:53 +00004250void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004251 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004252 return;
4253 assert(UD.shadow_size() &&
4254 "We shouldn't be codegening an invalid UsingDecl containing no decls");
4255 // Emitting one decl is sufficient - debuggers can detect that this is an
4256 // overloaded name & provide lookup for all the overloads.
4257 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00004258
4259 // FIXME: Skip functions with undeduced auto return type for now since we
4260 // don't currently have the plumbing for separate declarations & definitions
4261 // of free functions and mismatched types (auto in the declaration, concrete
4262 // return type in the definition)
4263 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4264 if (const auto *AT =
4265 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4266 if (AT->getDeducedType().isNull())
4267 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004268 if (llvm::DINode *Target =
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004269 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4270 auto Loc = USD.getLocation();
David Blaikiebd483762013-05-20 04:58:53 +00004271 DBuilder.createImportedDeclaration(
4272 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004273 getOrCreateFile(Loc), getLineNumber(Loc));
4274 }
David Blaikiebd483762013-05-20 04:58:53 +00004275}
4276
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004277void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00004278 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4279 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00004280 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00004281 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004282 auto Loc = ID.getLocation();
Adrian Prantl8a634c12015-12-18 19:44:31 +00004283 DBuilder.createImportedDeclaration(
4284 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004285 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4286 getLineNumber(Loc));
Adrian Prantl8a634c12015-12-18 19:44:31 +00004287 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004288}
4289
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004290llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00004291CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004292 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004293 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004294 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00004295 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004296 return cast<llvm::DIImportedEntity>(VH);
4297 llvm::DIImportedEntity *R;
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004298 auto Loc = NA.getLocation();
David Majnemer58ed0f32016-07-17 00:39:12 +00004299 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00004300 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4301 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00004302 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004303 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004304 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4305 getLineNumber(Loc), NA.getName());
David Blaikief121b932013-05-20 22:50:41 +00004306 else
David Blaikie551fb0a2014-04-06 06:30:03 +00004307 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004308 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantlddb8e062017-05-12 16:23:53 +00004309 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004310 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004311 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00004312 return R;
4313}
4314
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004315llvm::DINamespace *
Adrian Prantlddb8e062017-05-12 16:23:53 +00004316CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4317 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4318 // if necessary, and this way multiple declarations of the same namespace in
4319 // different parent modules stay distinct.
4320 auto I = NamespaceCache.find(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004321 if (I != NamespaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004322 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00004323
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004324 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004325 // Don't trust the context if it is a DIModule (see comment above).
Adrian Prantlddb8e062017-05-12 16:23:53 +00004326 llvm::DINamespace *NS =
4327 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4328 NamespaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00004329 return NS;
4330}
4331
Adrian Prantla5206ce2015-09-22 23:26:43 +00004332void CGDebugInfo::setDwoId(uint64_t Signature) {
4333 assert(TheCU && "no main compile unit");
4334 TheCU->setDWOId(Signature);
4335}
4336
Guy Benyei11169dd2012-12-18 14:30:41 +00004337void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00004338 // Creating types might create further types - invalidating the current
4339 // element and the size(), so don't cache/reference them.
4340 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4341 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004342 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00004343 ? CreateTypeDefinition(E.Type, E.Unit)
4344 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004345 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00004346 }
4347
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004348 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4349 // Add methods to interface.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004350 for (const auto &P : ObjCMethodCache) {
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004351 if (P.second.empty())
4352 continue;
4353
4354 QualType QTy(P.first->getTypeForDecl(), 0);
4355 auto It = TypeCache.find(QTy.getAsOpaquePtr());
4356 assert(It != TypeCache.end());
4357
4358 llvm::DICompositeType *InterfaceDecl =
4359 cast<llvm::DICompositeType>(It->second);
4360
4361 SmallVector<llvm::Metadata *, 16> EltTys;
4362 auto CurrenetElts = InterfaceDecl->getElements();
4363 EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4364 for (auto &MD : P.second)
4365 EltTys.push_back(MD);
4366 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4367 DBuilder.replaceArrays(InterfaceDecl, Elements);
4368 }
4369 }
4370
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004371 for (const auto &P : ReplaceMap) {
4372 assert(P.second);
4373 auto *Ty = cast<llvm::DIType>(P.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004374 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00004375
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004376 auto It = TypeCache.find(P.first);
4377 assert(It != TypeCache.end());
4378 assert(It->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00004379
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004380 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004381 cast<llvm::DIType>(It->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00004382 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00004383
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004384 for (const auto &P : FwdDeclReplaceMap) {
4385 assert(P.second);
4386 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004387 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00004388
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004389 auto It = DeclCache.find(P.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00004390 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00004391 // with ourselves, that will destroy the temporary MDNode and
4392 // replace it with a standard one, avoiding leaking memory.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004393 if (It == DeclCache.end())
4394 Repl = P.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00004395 else
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004396 Repl = It->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00004397
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004398 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4399 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004400 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00004401 }
4402
Adrian Prantl73409ce2013-03-11 18:33:46 +00004403 // We keep our own list of retained types, because we need to look
4404 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00004405 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00004406 if (auto MD = TypeCache[RT])
4407 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00004408
Guy Benyei11169dd2012-12-18 14:30:41 +00004409 DBuilder.finalize();
4410}
David Blaikie66088d52014-09-24 17:01:27 +00004411
4412void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004413 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00004414 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004415
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00004416 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004417 // Don't ignore in case of explicit cast where it is referenced indirectly.
4418 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00004419}
Amara Emerson652795d2016-11-10 14:44:30 +00004420
4421llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4422 if (LexicalBlockStack.empty())
4423 return llvm::DebugLoc();
4424
4425 llvm::MDNode *Scope = LexicalBlockStack.back();
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004426 return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
Amara Emerson652795d2016-11-10 14:44:30 +00004427}
Vedant Kumar5931b4e2018-10-05 20:37:17 +00004428
4429llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4430 // Call site-related attributes are only useful in optimized programs, and
4431 // when there's a possibility of debugging backtraces.
4432 if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4433 DebugKind == codegenoptions::LocTrackingOnly)
4434 return llvm::DINode::FlagZero;
4435
4436 // Call site-related attributes are available in DWARF v5. Some debuggers,
4437 // while not fully DWARF v5-compliant, may accept these attributes as if they
4438 // were part of DWARF v4.
4439 bool SupportsDWARFv4Ext =
4440 CGM.getCodeGenOpts().DwarfVersion == 4 &&
4441 CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB;
4442 if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4443 return llvm::DINode::FlagZero;
4444
4445 return llvm::DINode::FlagAllCallsDescribed;
4446}