blob: 89c053f4b2905dc01d2f404ab9c97b5076c72294 [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Guy Benyei11169dd2012-12-18 14:30:41 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This coordinates the debug information generation while generating code.
10//
11//===----------------------------------------------------------------------===//
12
13#include "CGDebugInfo.h"
14#include "CGBlocks.h"
David Blaikie38079fd2013-05-10 21:53:14 +000015#include "CGCXXABI.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000016#include "CGObjCRuntime.h"
Bob Haarmandff36732016-10-25 22:19:32 +000017#include "CGRecordLayout.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000018#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
John McCallde0fe072017-08-15 21:42:52 +000020#include "ConstantEmitter.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000021#include "clang/AST/ASTContext.h"
22#include "clang/AST/DeclFriend.h"
23#include "clang/AST/DeclObjC.h"
24#include "clang/AST/DeclTemplate.h"
25#include "clang/AST/Expr.h"
26#include "clang/AST/RecordLayout.h"
Richard Trieu63688182018-12-11 03:18:39 +000027#include "clang/Basic/CodeGenOptions.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000028#include "clang/Basic/FileManager.h"
29#include "clang/Basic/SourceManager.h"
30#include "clang/Basic/Version.h"
Taewook Oh0fb5b782017-08-16 19:36:24 +000031#include "clang/Frontend/FrontendOptions.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000032#include "clang/Lex/HeaderSearchOptions.h"
Adrian Prantl9402cef2015-09-20 16:51:35 +000033#include "clang/Lex/ModuleMap.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000034#include "clang/Lex/PreprocessorOptions.h"
Bob Haarmandff36732016-10-25 22:19:32 +000035#include "llvm/ADT/DenseSet.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000036#include "llvm/ADT/SmallVector.h"
37#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000038#include "llvm/IR/Constants.h"
39#include "llvm/IR/DataLayout.h"
40#include "llvm/IR/DerivedTypes.h"
41#include "llvm/IR/Instructions.h"
42#include "llvm/IR/Intrinsics.h"
Matthew Voss20165362018-10-03 18:45:04 +000043#include "llvm/IR/Metadata.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000044#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000045#include "llvm/Support/FileSystem.h"
Amjad Aboude2aab8c2016-12-25 10:12:27 +000046#include "llvm/Support/MD5.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000047#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000048using namespace clang;
49using namespace clang::CodeGen;
50
Victor Leschuka7ece032016-10-20 00:13:19 +000051static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
52 auto TI = Ctx.getTypeInfo(Ty);
53 return TI.AlignIsRequired ? TI.Align : 0;
54}
55
56static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
57 return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
58}
59
60static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
61 return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
62}
63
Guy Benyei11169dd2012-12-18 14:30:41 +000064CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000065 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
Adrian Prantl6b21ab22015-08-27 19:46:20 +000066 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
Eric Christopher324bbbd2013-07-14 21:12:44 +000067 DBuilder(CGM.getModule()) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000068 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
69 DebugPrefixMap[KV.first] = KV.second;
Guy Benyei11169dd2012-12-18 14:30:41 +000070 CreateCompileUnit();
71}
72
73CGDebugInfo::~CGDebugInfo() {
74 assert(LexicalBlockStack.empty() &&
75 "Region stack mismatch, stack not empty!");
76}
77
David Blaikie66e41972015-01-14 07:38:27 +000078ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Calixte Denizetfcd661d2018-09-24 18:24:18 +000079 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000080 : CGF(&CGF) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +000081 init(TemporaryLocation);
David Blaikie9b479662015-01-25 01:19:10 +000082}
83
Adrian Prantl39428e72015-02-03 18:40:42 +000084ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000085 bool DefaultToEmpty,
Calixte Denizetfcd661d2018-09-24 18:24:18 +000086 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000087 : CGF(&CGF) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +000088 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000089}
90
91void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Calixte Denizetfcd661d2018-09-24 18:24:18 +000092 bool DefaultToEmpty) {
David Blaikied7057d92015-08-12 23:49:57 +000093 auto *DI = CGF->getDebugInfo();
94 if (!DI) {
95 CGF = nullptr;
96 return;
David Blaikie66e41972015-01-14 07:38:27 +000097 }
David Blaikied7057d92015-08-12 23:49:57 +000098
99 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
Bob Haarmanc6c9b8f2017-09-11 22:11:57 +0000100
101 if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
102 return;
103
David Blaikied7057d92015-08-12 23:49:57 +0000104 if (TemporaryLocation.isValid()) {
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000105 DI->EmitLocation(CGF->Builder, TemporaryLocation);
David Blaikied7057d92015-08-12 23:49:57 +0000106 return;
107 }
108
109 if (DefaultToEmpty) {
110 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
111 return;
112 }
113
114 // Construct a location that has a valid scope, but no line info.
115 assert(!DI->LexicalBlockStack.empty());
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000116 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
117 0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000118}
119
David Blaikie9b479662015-01-25 01:19:10 +0000120ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
David Blaikied7057d92015-08-12 23:49:57 +0000121 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +0000122 init(E->getExprLoc());
123}
124
David Blaikie66e41972015-01-14 07:38:27 +0000125ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
David Blaikied7057d92015-08-12 23:49:57 +0000126 : CGF(&CGF) {
127 if (!CGF.getDebugInfo()) {
128 this->CGF = nullptr;
129 return;
David Blaikie66e41972015-01-14 07:38:27 +0000130 }
David Blaikied7057d92015-08-12 23:49:57 +0000131 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
132 if (Loc)
133 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +0000134}
135
136ApplyDebugLocation::~ApplyDebugLocation() {
137 // Query CGF so the location isn't overwritten when location updates are
138 // temporarily disabled (for C++ default function arguments)
David Blaikied7057d92015-08-12 23:49:57 +0000139 if (CGF)
140 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000141}
142
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000143ApplyInlineDebugLocation::ApplyInlineDebugLocation(CodeGenFunction &CGF,
144 GlobalDecl InlinedFn)
145 : CGF(&CGF) {
146 if (!CGF.getDebugInfo()) {
147 this->CGF = nullptr;
148 return;
149 }
150 auto &DI = *CGF.getDebugInfo();
151 SavedLocation = DI.getLocation();
152 assert((DI.getInlinedAt() ==
153 CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
154 "CGDebugInfo and IRBuilder are out of sync");
155
156 DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
157}
158
159ApplyInlineDebugLocation::~ApplyInlineDebugLocation() {
160 if (!CGF)
161 return;
162 auto &DI = *CGF->getDebugInfo();
163 DI.EmitInlineFunctionEnd(CGF->Builder);
164 DI.EmitLocation(CGF->Builder, SavedLocation);
165}
166
Guy Benyei11169dd2012-12-18 14:30:41 +0000167void CGDebugInfo::setLocation(SourceLocation Loc) {
168 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000169 if (Loc.isInvalid())
170 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000171
172 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
173
174 // If we've changed files in the middle of a lexical scope go ahead
175 // and create a new lexical scope with file node if it's different
176 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000177 if (LexicalBlockStack.empty())
178 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000179
180 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000181 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000182 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Adrian Prantl212c1042018-12-06 18:44:50 +0000183 if (PCLoc.isInvalid() || Scope->getFile() == getOrCreateFile(CurLoc))
Guy Benyei11169dd2012-12-18 14:30:41 +0000184 return;
185
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000186 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000187 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000188 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
189 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000190 } else if (isa<llvm::DILexicalBlock>(Scope) ||
191 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000192 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000193 LexicalBlockStack.emplace_back(
194 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000195 }
196}
197
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000198llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000199 llvm::DIScope *Mod = getParentModuleOrNull(D);
200 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
201 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000202}
203
204llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
205 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000206 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000207 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000208
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000209 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000210 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000211 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000212 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000213 }
214
215 // Check namespace.
Adrian Prantlddb8e062017-05-12 16:23:53 +0000216 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
217 return getOrCreateNamespace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000218
David Majnemer58ed0f32016-07-17 00:39:12 +0000219 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000220 if (!RDecl->isDependentType())
221 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000222 TheCU->getFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000223 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000224}
225
Reid Kleckner59d12202017-08-08 01:33:53 +0000226PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
227 PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
228
229 // If we're emitting codeview, it's important to try to match MSVC's naming so
230 // that visualizers written for MSVC will trigger for our class names. In
231 // particular, we can't have spaces between arguments of standard templates
232 // like basic_string and vector.
233 if (CGM.getCodeGenOpts().EmitCodeView)
234 PP.MSVCFormatting = true;
235
Adrian Prantl56acd5a2018-12-05 18:37:44 +0000236 // Apply -fdebug-prefix-map.
237 PP.RemapFilePaths = true;
238 PP.remapPath = [this](StringRef Path) { return remapDIPath(Path); };
Reid Kleckner59d12202017-08-08 01:33:53 +0000239 return PP;
240}
241
Guy Benyei11169dd2012-12-18 14:30:41 +0000242StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000243 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000244 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000245 FunctionTemplateSpecializationInfo *Info =
246 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000247
Reid Kleckner31abd802016-06-30 17:41:31 +0000248 // Emit the unqualified name in normal operation. LLVM and the debugger can
249 // compute the fully qualified name from the scope chain. If we're only
250 // emitting line table info, there won't be any scope chains, so emit the
251 // fully qualified name here so that stack traces are more accurate.
252 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
253 // evaluating the size impact.
254 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
255 CGM.getCodeGenOpts().EmitCodeView;
256
257 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000258 return FII->getName();
259
Benjamin Kramer9170e912013-02-22 15:46:01 +0000260 SmallString<128> NS;
261 llvm::raw_svector_ostream OS(NS);
Reid Kleckner31abd802016-06-30 17:41:31 +0000262 if (!UseQualifiedName)
263 FD->printName(OS);
264 else
Reid Kleckner59d12202017-08-08 01:33:53 +0000265 FD->printQualifiedName(OS, getPrintingPolicy());
Guy Benyei11169dd2012-12-18 14:30:41 +0000266
Reid Kleckner829398e2016-06-17 16:11:20 +0000267 // Add any template specialization args.
268 if (Info) {
269 const TemplateArgumentList *TArgs = Info->TemplateArguments;
Serge Pavlov03e672c2017-11-28 16:14:14 +0000270 printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
Guy Benyei11169dd2012-12-18 14:30:41 +0000271 }
272
273 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000274 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000275}
276
277StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
278 SmallString<256> MethodName;
279 llvm::raw_svector_ostream OS(MethodName);
280 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
281 const DeclContext *DC = OMD->getDeclContext();
David Majnemer58ed0f32016-07-17 00:39:12 +0000282 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000283 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000284 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000285 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000286 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000287 if (OC->IsClassExtension()) {
288 OS << OC->getClassInterface()->getName();
289 } else {
David Majnemer58ed0f32016-07-17 00:39:12 +0000290 OS << OC->getIdentifier()->getNameStart() << '('
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000291 << OC->getIdentifier()->getNameStart() << ')';
292 }
David Majnemer58ed0f32016-07-17 00:39:12 +0000293 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000294 OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000295 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000296 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000297 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000298 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000299 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000300 ClassTy.print(OS, PrintingPolicy(LangOptions()));
301 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000302 }
303 OS << ' ' << OMD->getSelector().getAsString() << ']';
304
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000305 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000306}
307
Guy Benyei11169dd2012-12-18 14:30:41 +0000308StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000309 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000310}
311
Eric Christophere7b87e52014-10-26 23:40:33 +0000312StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000313 if (isa<ClassTemplateSpecializationDecl>(RD)) {
314 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000315 llvm::raw_svector_ostream OS(Name);
Reid Kleckner59d12202017-08-08 01:33:53 +0000316 RD->getNameForDiagnostic(OS, getPrintingPolicy(),
David Blaikie65813a32014-04-02 18:21:09 +0000317 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000318
319 // Copy this name on the side and use its reference.
320 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000321 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000322
David Majnemerbc5976a2016-07-01 23:12:54 +0000323 // quick optimization to avoid having to intern strings that are already
324 // stored reliably elsewhere
325 if (const IdentifierInfo *II = RD->getIdentifier())
326 return II->getName();
327
328 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
329 // used to reconstruct the fully qualified type names.
330 if (CGM.getCodeGenOpts().EmitCodeView) {
331 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
332 assert(RD->getDeclContext() == D->getDeclContext() &&
333 "Typedef should not be in another decl context!");
334 assert(D->getDeclName().getAsIdentifierInfo() &&
335 "Typedef was not named!");
336 return D->getDeclName().getAsIdentifierInfo()->getName();
337 }
338
339 if (CGM.getLangOpts().CPlusPlus) {
340 StringRef Name;
341
342 ASTContext &Context = CGM.getContext();
343 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
344 // Anonymous types without a name for linkage purposes have their
345 // declarator mangled in if they have one.
346 Name = DD->getName();
347 else if (const TypedefNameDecl *TND =
348 Context.getTypedefNameForUnnamedTagDecl(RD))
349 // Anonymous types without a name for linkage purposes have their
350 // associate typedef mangled in if they have one.
351 Name = TND->getName();
352
353 if (!Name.empty()) {
354 SmallString<256> UnnamedType("<unnamed-type-");
355 UnnamedType += Name;
356 UnnamedType += '>';
357 return internString(UnnamedType);
358 }
359 }
360 }
361
362 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000363}
364
Scott Linder94834f12018-02-12 19:47:05 +0000365Optional<llvm::DIFile::ChecksumKind>
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000366CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
367 Checksum.clear();
368
Paul Robinson76178632018-05-25 22:35:59 +0000369 if (!CGM.getCodeGenOpts().EmitCodeView &&
370 CGM.getCodeGenOpts().DwarfVersion < 5)
Scott Linder94834f12018-02-12 19:47:05 +0000371 return None;
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000372
373 SourceManager &SM = CGM.getContext().getSourceManager();
374 bool Invalid;
Nico Weber04347d82019-04-04 21:06:41 +0000375 const llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
Paul Robinson76178632018-05-25 22:35:59 +0000376 if (Invalid)
Scott Linder94834f12018-02-12 19:47:05 +0000377 return None;
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000378
379 llvm::MD5 Hash;
380 llvm::MD5::MD5Result Result;
381
382 Hash.update(MemBuffer->getBuffer());
383 Hash.final(Result);
384
385 Hash.stringifyResult(Result, Checksum);
386 return llvm::DIFile::CSK_MD5;
387}
388
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000389Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
390 FileID FID) {
Scott Lindera2fbcef2018-02-26 17:32:31 +0000391 if (!CGM.getCodeGenOpts().EmbedSource)
392 return None;
393
394 bool SourceInvalid = false;
395 StringRef Source = SM.getBufferData(FID, &SourceInvalid);
396
397 if (SourceInvalid)
398 return None;
399
400 return Source;
401}
402
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000403llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000404 if (!Loc.isValid())
405 // If Location is not valid then use main input file.
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000406 return TheCU->getFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000407
408 SourceManager &SM = CGM.getContext().getSourceManager();
409 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
410
Adrian Prantl212c1042018-12-06 18:44:50 +0000411 StringRef FileName = PLoc.getFilename();
412 if (PLoc.isInvalid() || FileName.empty())
Guy Benyei11169dd2012-12-18 14:30:41 +0000413 // If the location is not valid then use main input file.
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000414 return TheCU->getFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000415
416 // Cache the results.
Adrian Prantl212c1042018-12-06 18:44:50 +0000417 auto It = DIFileCache.find(FileName.data());
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;
Alexandre Ganea047e65d2019-05-21 19:40:28 +0000425
426 // Compute the checksum if possible. If the location is affected by a #line
427 // directive that refers to a file, PLoc will have an invalid FileID, and we
428 // will correctly get no checksum.
Scott Linder94834f12018-02-12 19:47:05 +0000429 Optional<llvm::DIFile::ChecksumKind> CSKind =
Alexandre Ganea047e65d2019-05-21 19:40:28 +0000430 computeChecksum(PLoc.getFileID(), Checksum);
Scott Linder94834f12018-02-12 19:47:05 +0000431 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
432 if (CSKind)
433 CSInfo.emplace(*CSKind, Checksum);
Adrian Prantlaa5bad42018-12-11 16:58:43 +0000434 return createFile(FileName, CSInfo, getSource(SM, SM.getFileID(Loc)));
435}
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000436
Adrian Prantlaa5bad42018-12-11 16:58:43 +0000437llvm::DIFile *
438CGDebugInfo::createFile(StringRef FileName,
439 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
440 Optional<StringRef> Source) {
Adrian Prantl212c1042018-12-06 18:44:50 +0000441 StringRef Dir;
442 StringRef File;
443 std::string RemappedFile = remapDIPath(FileName);
444 std::string CurDir = remapDIPath(getCurrentDirname());
445 SmallString<128> DirBuf;
446 SmallString<128> FileBuf;
447 if (llvm::sys::path::is_absolute(RemappedFile)) {
448 // Strip the common prefix (if it is more than just "/") from current
449 // directory and FileName for a more space-efficient encoding.
450 auto FileIt = llvm::sys::path::begin(RemappedFile);
451 auto FileE = llvm::sys::path::end(RemappedFile);
452 auto CurDirIt = llvm::sys::path::begin(CurDir);
453 auto CurDirE = llvm::sys::path::end(CurDir);
454 for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
455 llvm::sys::path::append(DirBuf, *CurDirIt);
456 if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
Adrian Prantl0feb7b72019-02-05 21:21:01 +0000457 // Don't strip the common prefix if it is only the root "/"
458 // since that would make LLVM diagnostic locations confusing.
Adrian Prantl212c1042018-12-06 18:44:50 +0000459 Dir = {};
460 File = RemappedFile;
461 } else {
462 for (; FileIt != FileE; ++FileIt)
463 llvm::sys::path::append(FileBuf, *FileIt);
464 Dir = DirBuf;
465 File = FileBuf;
466 }
467 } else {
468 Dir = CurDir;
469 File = RemappedFile;
470 }
Adrian Prantlaa5bad42018-12-11 16:58:43 +0000471 llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
Adrian Prantl212c1042018-12-06 18:44:50 +0000472 DIFileCache[FileName.data()].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000473 return F;
474}
475
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000476std::string CGDebugInfo::remapDIPath(StringRef Path) const {
477 for (const auto &Entry : DebugPrefixMap)
478 if (Path.startswith(Entry.first))
479 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
480 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000481}
482
Guy Benyei11169dd2012-12-18 14:30:41 +0000483unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
484 if (Loc.isInvalid() && CurLoc.isInvalid())
485 return 0;
486 SourceManager &SM = CGM.getContext().getSourceManager();
487 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000488 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000489}
490
Adrian Prantlc7822422013-03-12 20:43:25 +0000491unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000492 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000493 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000494 return 0;
495
496 // If the location is invalid then use the current column.
497 if (Loc.isInvalid() && CurLoc.isInvalid())
498 return 0;
499 SourceManager &SM = CGM.getContext().getSourceManager();
500 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000501 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000502}
503
504StringRef CGDebugInfo::getCurrentDirname() {
505 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
506 return CGM.getCodeGenOpts().DebugCompilationDir;
507
508 if (!CWDName.empty())
509 return CWDName;
510 SmallString<256> CWD;
511 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000512 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000513}
514
Guy Benyei11169dd2012-12-18 14:30:41 +0000515void CGDebugInfo::CreateCompileUnit() {
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000516 SmallString<32> Checksum;
Scott Linder94834f12018-02-12 19:47:05 +0000517 Optional<llvm::DIFile::ChecksumKind> CSKind;
518 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
Guy Benyei11169dd2012-12-18 14:30:41 +0000519
David Blaikieaabde052014-05-14 00:29:00 +0000520 // Should we be asking the SourceManager for the main file name, instead of
521 // accepting it as an argument? This just causes the main file name to
522 // mismatch with source locations and create extra lexical scopes or
523 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
524 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
525 // because that's what the SourceManager says)
526
Guy Benyei11169dd2012-12-18 14:30:41 +0000527 // Get absolute path name.
528 SourceManager &SM = CGM.getContext().getSourceManager();
529 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
530 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000531 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000532
533 // The main file name provided via the "-main-file-name" option contains just
534 // the file name itself with no path information. This file name may have had
535 // a relative path, so we look into the actual file entry for the main
536 // file to determine the real absolute path for the file.
537 std::string MainFileDir;
538 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000539 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000540 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000541 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
542 llvm::sys::path::append(MainFileDirSS, MainFileName);
543 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000544 }
Taewook Oh0fb5b782017-08-16 19:36:24 +0000545 // If the main file name provided is identical to the input file name, and
546 // if the input file is a preprocessed source, use the module name for
547 // debug info. The module name comes from the name specified in the first
548 // linemarker if the input is a preprocessed source.
549 if (MainFile->getName() == MainFileName &&
550 FrontendOptions::getInputKindForExtension(
551 MainFile->getName().rsplit('.').second)
552 .isPreprocessed())
553 MainFileName = CGM.getModule().getName().str();
554
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000555 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000556 }
557
Ed Masteda706022014-05-07 12:49:30 +0000558 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000559 const LangOptions &LO = CGM.getLangOpts();
560 if (LO.CPlusPlus) {
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000561 if (LO.ObjC)
Guy Benyei11169dd2012-12-18 14:30:41 +0000562 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
563 else
564 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000565 } else if (LO.ObjC) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000566 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000567 } else if (LO.RenderScript) {
568 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000569 } else if (LO.C99) {
570 LangTag = llvm::dwarf::DW_LANG_C99;
571 } else {
572 LangTag = llvm::dwarf::DW_LANG_C89;
573 }
574
575 std::string Producer = getClangFullVersion();
576
577 // Figure out which version of the ObjC runtime we have.
578 unsigned RuntimeVers = 0;
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000579 if (LO.ObjC)
Guy Benyei11169dd2012-12-18 14:30:41 +0000580 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
581
Adrian Prantl826824e2016-04-08 22:43:06 +0000582 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
583 switch (DebugKind) {
584 case codegenoptions::NoDebugInfo:
585 case codegenoptions::LocTrackingOnly:
586 EmissionKind = llvm::DICompileUnit::NoDebug;
587 break;
588 case codegenoptions::DebugLineTablesOnly:
589 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
590 break;
Alexey Bataev80e1b5e2018-08-31 13:56:14 +0000591 case codegenoptions::DebugDirectivesOnly:
592 EmissionKind = llvm::DICompileUnit::DebugDirectivesOnly;
593 break;
Adrian Prantl826824e2016-04-08 22:43:06 +0000594 case codegenoptions::LimitedDebugInfo:
595 case codegenoptions::FullDebugInfo:
596 EmissionKind = llvm::DICompileUnit::FullDebug;
597 break;
598 }
599
Adrian Prantl046d1002018-12-13 17:53:29 +0000600 uint64_t DwoId = 0;
601 auto &CGOpts = CGM.getCodeGenOpts();
602 // The DIFile used by the CU is distinct from the main source
603 // file. Its directory part specifies what becomes the
604 // DW_AT_comp_dir (the compilation directory), even if the source
605 // file was specified with an absolute path.
Scott Linder94834f12018-02-12 19:47:05 +0000606 if (CSKind)
607 CSInfo.emplace(*CSKind, Checksum);
Adrian Prantl046d1002018-12-13 17:53:29 +0000608 llvm::DIFile *CUFile = DBuilder.createFile(
609 remapDIPath(MainFileName), remapDIPath(getCurrentDirname()), CSInfo,
610 getSource(SM, SM.getMainFileID()));
Scott Linder94834f12018-02-12 19:47:05 +0000611
Guy Benyei11169dd2012-12-18 14:30:41 +0000612 // Create new compile unit.
Eric Christophere4200a22014-02-27 01:25:08 +0000613 TheCU = DBuilder.createCompileUnit(
Adrian Prantl046d1002018-12-13 17:53:29 +0000614 LangTag, CUFile, CGOpts.EmitVersionIdentMetadata ? Producer : "",
Tobias Edler von Koch7609cb82018-06-22 20:23:21 +0000615 LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
Adrian Prantlb4423022017-08-04 23:08:57 +0000616 CGOpts.DwarfDebugFlags, RuntimeVers,
George Rimar91829ee2018-11-14 09:22:16 +0000617 (CGOpts.getSplitDwarfMode() != CodeGenOptions::NoFission)
618 ? ""
619 : CGOpts.SplitDwarfFile,
Adrian Prantl046d1002018-12-13 17:53:29 +0000620 EmissionKind, DwoId, CGOpts.SplitDwarfInlining,
George Rimar91829ee2018-11-14 09:22:16 +0000621 CGOpts.DebugInfoForProfiling,
David Blaikie9982bb82018-08-16 23:56:32 +0000622 CGM.getTarget().getTriple().isNVPTX()
623 ? llvm::DICompileUnit::DebugNameTableKind::None
David Blaikie65864522018-08-20 20:14:08 +0000624 : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
David Blaikie27692de2018-11-13 20:08:13 +0000625 CGOpts.DebugNameTable),
626 CGOpts.DebugRangesBaseAddress);
Guy Benyei11169dd2012-12-18 14:30:41 +0000627}
628
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000629llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000630 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000631 StringRef BTName;
632 switch (BT->getKind()) {
633#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000634#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000635#include "clang/AST/BuiltinTypes.def"
636 case BuiltinType::Dependent:
637 llvm_unreachable("Unexpected builtin type");
638 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000639 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000640 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000641 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000642 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000643 if (!ClassTy)
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000644 ClassTy =
645 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
646 "objc_class", TheCU, TheCU->getFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000647 return ClassTy;
648 case BuiltinType::ObjCId: {
649 // typedef struct objc_class *Class;
650 // typedef struct objc_object {
651 // Class isa;
652 // } *id;
653
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000654 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000655 return ObjTy;
656
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000657 if (!ClassTy)
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000658 ClassTy =
659 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
660 "objc_class", TheCU, TheCU->getFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000661
662 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000663
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000664 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000665
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000666 ObjTy = DBuilder.createStructType(TheCU, "objc_object", TheCU->getFile(), 0,
667 0, 0, llvm::DINode::FlagZero, nullptr,
668 llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000669
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000670 DBuilder.replaceArrays(
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000671 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000672 ObjTy, "isa", TheCU->getFile(), 0, Size, 0, 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000673 llvm::DINode::FlagZero, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000674 return ObjTy;
675 }
676 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000677 if (!SelTy)
678 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
679 "objc_selector", TheCU,
Adrian Prantlc2a44ec2018-12-11 16:58:46 +0000680 TheCU->getFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000681 return SelTy;
682 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000683
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000684#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
685 case BuiltinType::Id: \
686 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
Alexey Bader954ba212016-04-08 13:40:33 +0000687 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000688#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000689 case BuiltinType::OCLSampler:
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000690 return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000691 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000692 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000693 case BuiltinType::OCLClkEvent:
694 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
695 case BuiltinType::OCLQueue:
696 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000697 case BuiltinType::OCLReserveID:
698 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Andrew Savonichev3fee3512018-11-08 11:25:41 +0000699#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
700 case BuiltinType::Id: \
701 return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
702#include "clang/Basic/OpenCLExtensionTypes.def"
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000703
Guy Benyei11169dd2012-12-18 14:30:41 +0000704 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000705 case BuiltinType::Char_U:
706 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
707 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000708 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000709 case BuiltinType::SChar:
710 Encoding = llvm::dwarf::DW_ATE_signed_char;
711 break;
Richard Smith3a8244d2018-05-01 05:02:45 +0000712 case BuiltinType::Char8:
Guy Benyei11169dd2012-12-18 14:30:41 +0000713 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000714 case BuiltinType::Char32:
715 Encoding = llvm::dwarf::DW_ATE_UTF;
716 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000717 case BuiltinType::UShort:
718 case BuiltinType::UInt:
719 case BuiltinType::UInt128:
720 case BuiltinType::ULong:
721 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000722 case BuiltinType::ULongLong:
723 Encoding = llvm::dwarf::DW_ATE_unsigned;
724 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000725 case BuiltinType::Short:
726 case BuiltinType::Int:
727 case BuiltinType::Int128:
728 case BuiltinType::Long:
729 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000730 case BuiltinType::LongLong:
731 Encoding = llvm::dwarf::DW_ATE_signed;
732 break;
733 case BuiltinType::Bool:
734 Encoding = llvm::dwarf::DW_ATE_boolean;
735 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000736 case BuiltinType::Half:
737 case BuiltinType::Float:
738 case BuiltinType::LongDouble:
Sjoerd Meijercc623ad2017-09-08 15:15:00 +0000739 case BuiltinType::Float16:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000740 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000741 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000742 // FIXME: For targets where long double and __float128 have the same size,
743 // they are currently indistinguishable in the debugger without some
744 // special treatment. However, there is currently no consensus on encoding
745 // and this should be updated once a DWARF encoding exists for distinct
746 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000747 Encoding = llvm::dwarf::DW_ATE_float;
748 break;
Leonard Chanf921d852018-06-04 16:07:52 +0000749 case BuiltinType::ShortAccum:
750 case BuiltinType::Accum:
751 case BuiltinType::LongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000752 case BuiltinType::ShortFract:
753 case BuiltinType::Fract:
754 case BuiltinType::LongFract:
755 case BuiltinType::SatShortFract:
756 case BuiltinType::SatFract:
757 case BuiltinType::SatLongFract:
758 case BuiltinType::SatShortAccum:
759 case BuiltinType::SatAccum:
760 case BuiltinType::SatLongAccum:
Leonard Chanf921d852018-06-04 16:07:52 +0000761 Encoding = llvm::dwarf::DW_ATE_signed_fixed;
762 break;
763 case BuiltinType::UShortAccum:
764 case BuiltinType::UAccum:
765 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000766 case BuiltinType::UShortFract:
767 case BuiltinType::UFract:
768 case BuiltinType::ULongFract:
769 case BuiltinType::SatUShortAccum:
770 case BuiltinType::SatUAccum:
771 case BuiltinType::SatULongAccum:
772 case BuiltinType::SatUShortFract:
773 case BuiltinType::SatUFract:
774 case BuiltinType::SatULongFract:
Leonard Chanf921d852018-06-04 16:07:52 +0000775 Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
776 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000777 }
778
779 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000780 case BuiltinType::Long:
781 BTName = "long int";
782 break;
783 case BuiltinType::LongLong:
784 BTName = "long long int";
785 break;
786 case BuiltinType::ULong:
787 BTName = "long unsigned int";
788 break;
789 case BuiltinType::ULongLong:
790 BTName = "long long unsigned int";
791 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000792 default:
793 BTName = BT->getName(CGM.getLangOpts());
794 break;
795 }
Victor Leschuka7ece032016-10-20 00:13:19 +0000796 // Bit size and offset of the type.
Guy Benyei11169dd2012-12-18 14:30:41 +0000797 uint64_t Size = CGM.getContext().getTypeSize(BT);
Victor Leschuka7ece032016-10-20 00:13:19 +0000798 return DBuilder.createBasicType(BTName, Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000799}
800
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000801llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Victor Leschuka7ece032016-10-20 00:13:19 +0000802 // Bit size and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000803 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000804 if (Ty->isComplexIntegerType())
805 Encoding = llvm::dwarf::DW_ATE_lo_user;
806
807 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000808 return DBuilder.createBasicType("complex", Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000809}
810
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000811llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
812 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000813 QualifierCollector Qc;
814 const Type *T = Qc.strip(Ty);
815
816 // Ignore these qualifiers for now.
817 Qc.removeObjCGCAttr();
818 Qc.removeAddressSpace();
819 Qc.removeObjCLifetime();
820
821 // We will create one Derived type for one qualifier and recurse to handle any
822 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000823 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000824 if (Qc.hasConst()) {
825 Tag = llvm::dwarf::DW_TAG_const_type;
826 Qc.removeConst();
827 } else if (Qc.hasVolatile()) {
828 Tag = llvm::dwarf::DW_TAG_volatile_type;
829 Qc.removeVolatile();
830 } else if (Qc.hasRestrict()) {
831 Tag = llvm::dwarf::DW_TAG_restrict_type;
832 Qc.removeRestrict();
833 } else {
834 assert(Qc.empty() && "Unknown type qualifier for debug info");
835 return getOrCreateType(QualType(T, 0), Unit);
836 }
837
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000838 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000839
840 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
841 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000842 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000843}
844
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000845llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
846 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000847
848 // The frontend treats 'id' as a typedef to an ObjCObjectType,
849 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
850 // debug info, we want to emit 'id' in both cases.
851 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000852 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000853
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000854 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
855 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000856}
857
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000858llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
859 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000860 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000861 Ty->getPointeeType(), Unit);
862}
863
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000864/// \return whether a C++ mangling exists for the type defined by TD.
865static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
866 switch (TheCU->getSourceLanguage()) {
867 case llvm::dwarf::DW_LANG_C_plus_plus:
868 return true;
869 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
870 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
871 default:
872 return false;
873 }
874}
875
Reid Kleckner59320fc2018-08-17 20:59:52 +0000876// Determines if the debug info for this tag declaration needs a type
877// identifier. The purpose of the unique identifier is to deduplicate type
878// information for identical types across TUs. Because of the C++ one definition
879// rule (ODR), it is valid to assume that the type is defined the same way in
880// every TU and its debug info is equivalent.
881//
882// C does not have the ODR, and it is common for codebases to contain multiple
883// different definitions of a struct with the same name in different TUs.
884// Therefore, if the type doesn't have a C++ mangling, don't give it an
885// identifer. Type information in C is smaller and simpler than C++ type
886// information, so the increase in debug info size is negligible.
887//
888// If the type is not externally visible, it should be unique to the current TU,
889// and should not need an identifier to participate in type deduplication.
890// However, when emitting CodeView, the format internally uses these
891// unique type name identifers for references between debug info. For example,
892// the method of a class in an anonymous namespace uses the identifer to refer
893// to its parent class. The Microsoft C++ ABI attempts to provide unique names
894// for such types, so when emitting CodeView, always use identifiers for C++
895// types. This may create problems when attempting to emit CodeView when the MS
896// C++ ABI is not in use.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000897static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
Brock Wyma8557ec52018-05-22 12:41:19 +0000898 llvm::DICompileUnit *TheCU) {
899 // We only add a type identifier for types with C++ name mangling.
900 if (!hasCXXMangling(TD, TheCU))
901 return false;
902
Brock Wyma8557ec52018-05-22 12:41:19 +0000903 // Externally visible types with C++ mangling need a type identifier.
904 if (TD->isExternallyVisible())
905 return true;
906
Reid Kleckner59320fc2018-08-17 20:59:52 +0000907 // CodeView types with C++ mangling need a type identifier.
908 if (CGM.getCodeGenOpts().EmitCodeView)
909 return true;
910
Brock Wyma8557ec52018-05-22 12:41:19 +0000911 return false;
912}
913
Reid Kleckner59320fc2018-08-17 20:59:52 +0000914// Returns a unique type identifier string if one exists, or an empty string.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000915static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
Brock Wyma8557ec52018-05-22 12:41:19 +0000916 llvm::DICompileUnit *TheCU) {
917 SmallString<256> Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000918 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000919
Brock Wyma8557ec52018-05-22 12:41:19 +0000920 if (!needsTypeIdentifier(TD, CGM, TheCU))
921 return Identifier;
David Blaikief0d66552019-04-25 20:05:47 +0000922 if (const auto *RD = dyn_cast<CXXRecordDecl>(TD))
923 if (RD->getDefinition())
924 if (RD->isDynamicClass() &&
925 CGM.getVTableLinkage(RD) == llvm::GlobalValue::ExternalLinkage)
926 return Identifier;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000927
Manman Rene0064d82013-08-29 23:19:58 +0000928 // TODO: This is using the RTTI name. Is there a better way to get
929 // a unique string for a type?
Brock Wyma8557ec52018-05-22 12:41:19 +0000930 llvm::raw_svector_ostream Out(Identifier);
Manman Rene0064d82013-08-29 23:19:58 +0000931 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Brock Wyma8557ec52018-05-22 12:41:19 +0000932 return Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000933}
934
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000935/// \return the appropriate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000936static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +0000937 llvm::dwarf::Tag Tag;
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000938 if (RD->isStruct() || RD->isInterface())
939 Tag = llvm::dwarf::DW_TAG_structure_type;
940 else if (RD->isUnion())
941 Tag = llvm::dwarf::DW_TAG_union_type;
942 else {
943 // FIXME: This could be a struct type giving a default visibility different
944 // than C++ class type, but needs llvm metadata changes first.
945 assert(RD->isClass());
946 Tag = llvm::dwarf::DW_TAG_class_type;
947 }
948 return Tag;
949}
950
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000951llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000952CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000953 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000954 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000955 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
956 return cast<llvm::DICompositeType>(T);
957 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000958 unsigned Line = getLineNumber(RD->getLocation());
959 StringRef RDName = getClassName(RD);
960
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000961 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000962 uint32_t Align = 0;
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000963
Guy Benyei11169dd2012-12-18 14:30:41 +0000964 // Create the type.
Brock Wyma8557ec52018-05-22 12:41:19 +0000965 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000966 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000967 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +0000968 llvm::DINode::FlagFwdDecl, Identifier);
Paul Robinson1787f812017-09-28 18:37:02 +0000969 if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
970 if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
971 DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
972 CollectCXXTemplateParams(TSpecial, DefUnit));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000973 ReplaceMap.emplace_back(
974 std::piecewise_construct, std::make_tuple(Ty),
975 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000976 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000977}
978
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000979llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000980 const Type *Ty,
981 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000982 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000983 // Bit size, align and offset of the type.
984 // Size is always the size of a pointer. We can't use getTypeSize here
985 // because that does not return the correct value for references.
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000986 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
987 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
Victor Leschuka7ece032016-10-20 00:13:19 +0000988 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000989 Optional<unsigned> DWARFAddressSpace =
990 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000991
Keno Fischer87842f32015-11-16 09:04:13 +0000992 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
993 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
994 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000995 Size, Align, DWARFAddressSpace);
Keno Fischer87842f32015-11-16 09:04:13 +0000996 else
997 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000998 Align, DWARFAddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000999}
1000
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001001llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
1002 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +00001003 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +00001004 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +00001005 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
Adrian Prantlc2a44ec2018-12-11 16:58:46 +00001006 TheCU, TheCU->getFile(), 0);
David Blaikiefefc7f72013-05-21 17:58:54 +00001007 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1008 Cache = DBuilder.createPointerType(Cache, Size);
1009 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +00001010}
1011
Scott Linder58df0e42018-08-08 15:56:12 +00001012uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
1013 const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
1014 unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001015 QualType FType;
Guy Benyei11169dd2012-12-18 14:30:41 +00001016
Scott Linder58df0e42018-08-08 15:56:12 +00001017 // Advanced by calls to CreateMemberType in increments of FType, then
1018 // returned as the overall size of the default elements.
1019 uint64_t FieldOffset = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001020
Scott Linder58df0e42018-08-08 15:56:12 +00001021 // Blocks in OpenCL have unique constraints which make the standard fields
1022 // redundant while requiring size and align fields for enqueue_kernel. See
1023 // initializeForBlockHeader in CGBlocks.cpp
Scott Linder2b5cf042018-07-30 20:31:11 +00001024 if (CGM.getLangOpts().OpenCL) {
1025 FType = CGM.getContext().IntTy;
1026 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
1027 EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
1028 } else {
1029 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1030 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
1031 FType = CGM.getContext().IntTy;
1032 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
1033 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
1034 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
1035 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
1036 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Scott Linder58df0e42018-08-08 15:56:12 +00001037 uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
1038 uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
Scott Linder2b5cf042018-07-30 20:31:11 +00001039 EltTys.push_back(DBuilder.createMemberType(
Scott Linder58df0e42018-08-08 15:56:12 +00001040 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
1041 FieldOffset, llvm::DINode::FlagZero, DescTy));
Scott Lindera7c45682018-07-30 22:52:07 +00001042 FieldOffset += FieldSize;
Scott Linder2b5cf042018-07-30 20:31:11 +00001043 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001044
Scott Linder58df0e42018-08-08 15:56:12 +00001045 return FieldOffset;
1046}
1047
1048llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1049 llvm::DIFile *Unit) {
1050 SmallVector<llvm::Metadata *, 8> EltTys;
1051 QualType FType;
1052 uint64_t FieldOffset;
1053 llvm::DINodeArray Elements;
1054
1055 FieldOffset = 0;
1056 FType = CGM.getContext().UnsignedLongTy;
1057 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1058 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1059
1060 Elements = DBuilder.getOrCreateArray(EltTys);
1061 EltTys.clear();
1062
1063 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1064
1065 auto *EltTy =
1066 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1067 FieldOffset, 0, Flags, nullptr, Elements);
1068
1069 // Bit size, align and offset of the type.
1070 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1071
1072 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1073
1074 FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1075 0, EltTys);
1076
Guy Benyei11169dd2012-12-18 14:30:41 +00001077 Elements = DBuilder.getOrCreateArray(EltTys);
1078
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001079 // The __block_literal_generic structs are marked with a special
1080 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1081 // the debugger needs to know about. To allow type uniquing, emit
1082 // them without a name or a location.
Scott Linder58df0e42018-08-08 15:56:12 +00001083 EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001084 Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001085
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001086 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +00001087}
1088
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001089llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1090 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +00001091 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001092 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +00001093
1094 SmallString<128> NS;
1095 llvm::raw_svector_ostream OS(NS);
Serge Pavlov03e672c2017-11-28 16:14:14 +00001096 Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1097 printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
David Blaikief1b382e2014-04-06 17:14:06 +00001098
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001099 auto *AliasDecl =
1100 cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1101 ->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +00001102
1103 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +00001104 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1105 getLineNumber(Loc),
1106 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +00001107}
1108
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001109llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1110 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001111 // We don't set size information, but do specify where the typedef was
1112 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +00001113 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001114
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001115 // Typedefs are derived from some other type.
1116 return DBuilder.createTypedef(
1117 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1118 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +00001119 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001120}
1121
Reid Klecknerf00f8032016-06-08 20:41:54 +00001122static unsigned getDwarfCC(CallingConv CC) {
1123 switch (CC) {
1124 case CC_C:
1125 // Avoid emitting DW_AT_calling_convention if the C convention was used.
1126 return 0;
1127
1128 case CC_X86StdCall:
1129 return llvm::dwarf::DW_CC_BORLAND_stdcall;
1130 case CC_X86FastCall:
1131 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1132 case CC_X86ThisCall:
1133 return llvm::dwarf::DW_CC_BORLAND_thiscall;
1134 case CC_X86VectorCall:
1135 return llvm::dwarf::DW_CC_LLVM_vectorcall;
1136 case CC_X86Pascal:
1137 return llvm::dwarf::DW_CC_BORLAND_pascal;
Martin Storsjo022e7822017-07-17 20:49:45 +00001138 case CC_Win64:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001139 return llvm::dwarf::DW_CC_LLVM_Win64;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001140 case CC_X86_64SysV:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001141 return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001142 case CC_AAPCS:
Sander de Smalen44a22532018-11-26 16:38:37 +00001143 case CC_AArch64VectorCall:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001144 return llvm::dwarf::DW_CC_LLVM_AAPCS;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001145 case CC_AAPCS_VFP:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001146 return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001147 case CC_IntelOclBicc:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001148 return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001149 case CC_SpirFunction:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001150 return llvm::dwarf::DW_CC_LLVM_SpirFunction;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +00001151 case CC_OpenCLKernel:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001152 return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001153 case CC_Swift:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001154 return llvm::dwarf::DW_CC_LLVM_Swift;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001155 case CC_PreserveMost:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001156 return llvm::dwarf::DW_CC_LLVM_PreserveMost;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001157 case CC_PreserveAll:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001158 return llvm::dwarf::DW_CC_LLVM_PreserveAll;
Erich Keane757d3172016-11-02 18:29:35 +00001159 case CC_X86RegCall:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001160 return llvm::dwarf::DW_CC_LLVM_X86RegCall;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001161 }
1162 return 0;
1163}
1164
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001165llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1166 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001167 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001168
1169 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +00001170 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001171
1172 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +00001173 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +00001174 if (isa<FunctionNoProtoType>(Ty))
1175 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +00001176 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1177 for (const QualType &ParamType : FPT->param_types())
1178 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +00001179 if (FPT->isVariadic())
1180 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00001181 }
1182
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001183 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00001184 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +00001185 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001186}
1187
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001188/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +00001189/// As an optimization, return 0 if the access specifier equals the
1190/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +00001191static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1192 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +00001193 AccessSpecifier Default = clang::AS_none;
1194 if (RD && RD->isClass())
1195 Default = clang::AS_private;
1196 else if (RD && (RD->isStruct() || RD->isUnion()))
1197 Default = clang::AS_public;
1198
1199 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +00001200 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001201
Eric Christophere7b87e52014-10-26 23:40:33 +00001202 switch (Access) {
1203 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001204 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +00001205 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001206 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +00001207 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001208 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +00001209 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +00001210 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001211 }
1212 llvm_unreachable("unexpected access enumerator");
1213}
Guy Benyei11169dd2012-12-18 14:30:41 +00001214
David Majnemerb4b671e2016-06-30 03:01:59 +00001215llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1216 llvm::DIScope *RecordTy,
1217 const RecordDecl *RD) {
1218 StringRef Name = BitFieldDecl->getName();
1219 QualType Ty = BitFieldDecl->getType();
1220 SourceLocation Loc = BitFieldDecl->getLocation();
1221 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1222 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1223
1224 // Get the location for the field.
1225 llvm::DIFile *File = getOrCreateFile(Loc);
1226 unsigned Line = getLineNumber(Loc);
1227
1228 const CGBitFieldInfo &BitFieldInfo =
1229 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1230 uint64_t SizeInBits = BitFieldInfo.Size;
1231 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001232 uint64_t StorageOffsetInBits =
1233 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
Reid Kleckner06a4b2a2017-06-12 19:57:56 +00001234 uint64_t Offset = BitFieldInfo.Offset;
1235 // The bit offsets for big endian machines are reversed for big
1236 // endian target, compensate for that as the DIDerivedType requires
1237 // un-reversed offsets.
1238 if (CGM.getDataLayout().isBigEndian())
1239 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1240 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001241 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001242 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001243 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1244 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001245}
1246
1247llvm::DIType *
1248CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1249 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001250 uint32_t AlignInBits, llvm::DIFile *tunit,
1251 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001252 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001253
1254 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001255 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001256 unsigned line = getLineNumber(loc);
1257
David Majnemer34b57492014-07-30 01:30:47 +00001258 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001259 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001260 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001261 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1262 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001263 if (!Align)
1264 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001265 }
1266
Leny Kholodov80c047d2016-09-06 10:48:04 +00001267 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001268 return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1269 offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001270}
1271
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001272void CGDebugInfo::CollectRecordLambdaFields(
1273 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001274 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001275 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1276 // has the name and the location of the variable so we should iterate over
1277 // both concurrently.
1278 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1279 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1280 unsigned fieldno = 0;
1281 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001282 E = CXXDecl->captures_end();
1283 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001284 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001285 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001286 SourceLocation Loc = C.getLocation();
1287 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001288 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001289 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001290 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001291 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001292 llvm::DIType *FieldType = createFieldType(
1293 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001294 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001295 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001296 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001297 // TODO: Need to handle 'this' in some way by probably renaming the
1298 // this of the lambda class and having a field member of 'this' or
1299 // by using AT_object_pointer for the function and having that be
1300 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001301 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001302 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001303 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001304 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001305 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001306 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001307
1308 elements.push_back(fieldType);
1309 }
1310 }
1311}
1312
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001313llvm::DIDerivedType *
1314CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001315 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001316 // Create the descriptor for the static variable, with or without
1317 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001318 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001319 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1320 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001321
Eric Christopher91a31902013-01-16 01:22:32 +00001322 unsigned LineNumber = getLineNumber(Var->getLocation());
1323 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001324 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001325 if (Var->getInit()) {
1326 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001327 if (Value) {
1328 if (Value->isInt())
1329 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1330 if (Value->isFloat())
1331 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1332 }
Eric Christopher91a31902013-01-16 01:22:32 +00001333 }
1334
Leny Kholodov80c047d2016-09-06 10:48:04 +00001335 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001336 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001337 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001338 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001339 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001340 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001341}
1342
Eric Christophere7b87e52014-10-26 23:40:33 +00001343void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001344 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1345 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001346 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001347 StringRef name = field->getName();
1348 QualType type = field->getType();
1349
1350 // Ignore unnamed fields unless they're anonymous structs/unions.
1351 if (name.empty() && !type->isRecordType())
1352 return;
1353
David Majnemerb4b671e2016-06-30 03:01:59 +00001354 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001355 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001356 FieldType = createBitFieldType(field, RecordTy, RD);
1357 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001358 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001359 FieldType =
1360 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001361 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001362 }
1363
David Majnemerb4b671e2016-06-30 03:01:59 +00001364 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001365}
1366
Reid Klecknere2e82062017-08-08 20:30:14 +00001367void CGDebugInfo::CollectRecordNestedType(
1368 const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1369 QualType Ty = CGM.getContext().getTypeDeclType(TD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001370 // Injected class names are not considered nested records.
1371 if (isa<InjectedClassNameType>(Ty))
1372 return;
Reid Klecknere2e82062017-08-08 20:30:14 +00001373 SourceLocation Loc = TD->getLocation();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001374 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1375 elements.push_back(nestedType);
1376}
1377
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001378void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001379 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001380 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001381 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001382 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001383
Eric Christopher91a31902013-01-16 01:22:32 +00001384 if (CXXDecl && CXXDecl->isLambda())
1385 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1386 else {
1387 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001388
Eric Christopher91a31902013-01-16 01:22:32 +00001389 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001390 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001391
Eric Christopher91a31902013-01-16 01:22:32 +00001392 // Static and non-static members should appear in the same order as
1393 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001394 for (const auto *I : record->decls())
1395 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001396 if (V->hasAttr<NoDebugAttr>())
1397 continue;
Reid Kleckner891b2712018-07-20 20:55:00 +00001398
1399 // Skip variable template specializations when emitting CodeView. MSVC
1400 // doesn't emit them.
1401 if (CGM.getCodeGenOpts().EmitCodeView &&
1402 isa<VarTemplateSpecializationDecl>(V))
1403 continue;
1404
David Blaikiece763042013-08-20 21:49:21 +00001405 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001406 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001407 if (MI != StaticDataMemberCache.end()) {
1408 assert(MI->second &&
1409 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001410 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001411 } else {
1412 auto Field = CreateRecordStaticField(V, RecordTy, record);
1413 elements.push_back(Field);
1414 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001415 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001416 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1417 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001418
1419 // Bump field number for next field.
1420 ++fieldNo;
Reid Kleckner891b2712018-07-20 20:55:00 +00001421 } else if (CGM.getCodeGenOpts().EmitCodeView) {
1422 // Debug info for nested types is included in the member list only for
1423 // CodeView.
Reid Klecknere2e82062017-08-08 20:30:14 +00001424 if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1425 if (!nestedType->isImplicit() &&
1426 nestedType->getDeclContext() == record)
1427 CollectRecordNestedType(nestedType, elements);
1428 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001429 }
1430}
1431
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001432llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001433CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001434 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001435 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001436 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001437 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001438 getOrCreateType(QualType(Func, 0), Unit));
Brian Gesiak5488ab42019-01-11 01:54:53 +00001439 return getOrCreateInstanceMethodType(Method->getThisType(), Func, Unit);
David Blaikie7eb06852013-01-07 23:06:35 +00001440}
David Blaikie2aaf0652013-01-07 22:24:59 +00001441
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001442llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1443 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001444 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001445 llvm::DITypeRefArray Args(
1446 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001447 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001448 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001449
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001450 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001451
1452 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001453 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001454
David Blaikie2aaf0652013-01-07 22:24:59 +00001455 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001456 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001457 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1458 // Create pointer type directly in this case.
1459 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1460 QualType PointeeTy = ThisPtrTy->getPointeeType();
1461 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001462 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001463 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001464 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1465 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001466 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001467 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001468 // TODO: This and the artificial type below are misleading, the
1469 // types aren't artificial the argument is, but the current
1470 // metadata doesn't represent that.
1471 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1472 Elts.push_back(ThisPtrType);
1473 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001474 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001475 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001476 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1477 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001478 }
1479
1480 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001481 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1482 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001483
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001484 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001485
Leny Kholodov80c047d2016-09-06 10:48:04 +00001486 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001487 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001488 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001489 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001490 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001491
Reid Klecknerf00f8032016-06-08 20:41:54 +00001492 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1493 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001494}
1495
Eric Christopherb2a008c2013-05-16 00:45:12 +00001496/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001497/// inside a function.
1498static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001499 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001500 return isFunctionLocalClass(NRD);
1501 if (isa<FunctionDecl>(RD->getDeclContext()))
1502 return true;
1503 return false;
1504}
1505
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001506llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1507 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001508 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001509 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001510
Guy Benyei11169dd2012-12-18 14:30:41 +00001511 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001512 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001513
1514 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1515 // make sense to give a single ctor/dtor a linkage name.
1516 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001517 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1518 // property to use here. It may've been intended to model "is non-external
1519 // type" but misses cases of non-function-local but non-external classes such
1520 // as those in anonymous namespaces as well as the reverse - external types
1521 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001522 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1523 MethodLinkageName = CGM.getMangledName(Method);
1524
1525 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001526 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001527 unsigned MethodLine = 0;
1528 if (!Method->isImplicit()) {
1529 MethodDefUnit = getOrCreateFile(Method->getLocation());
1530 MethodLine = getLineNumber(Method->getLocation());
1531 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001532
1533 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001534 llvm::DIType *ContainingType = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001535 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001536 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Paul Robinsoncda54212018-11-19 18:29:28 +00001537 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001538 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001539
Guy Benyei11169dd2012-12-18 14:30:41 +00001540 if (Method->isVirtual()) {
1541 if (Method->isPure())
Paul Robinsoncda54212018-11-19 18:29:28 +00001542 SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001543 else
Paul Robinsoncda54212018-11-19 18:29:28 +00001544 SPFlags |= llvm::DISubprogram::SPFlagVirtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001545
Reid Kleckner216d0a12016-06-16 20:08:51 +00001546 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1547 // It doesn't make sense to give a virtual destructor a vtable index,
1548 // since a single destructor has two entries in the vtable.
1549 if (!isa<CXXDestructorDecl>(Method))
1550 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1551 } else {
1552 // Emit MS ABI vftable information. There is only one entry for the
1553 // deleting dtor.
1554 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1555 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
Reid Klecknercbec0262018-04-02 20:00:39 +00001556 MethodVFTableLocation ML =
Reid Kleckner216d0a12016-06-16 20:08:51 +00001557 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1558 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001559
1560 // CodeView only records the vftable offset in the class that introduces
1561 // the virtual method. This is possible because, unlike Itanium, the MS
1562 // C++ ABI does not include all virtual methods from non-primary bases in
1563 // the vtable for the most derived class. For example, if C inherits from
1564 // A and B, C's primary vftable will not include B's virtual methods.
Benjamin Krameracfa3392017-12-17 23:52:45 +00001565 if (Method->size_overridden_methods() == 0)
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001566 Flags |= llvm::DINode::FlagIntroducedVirtual;
1567
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001568 // The 'this' adjustment accounts for both the virtual and non-virtual
1569 // portions of the adjustment. Presumably the debugger only uses it when
1570 // it knows the dynamic type of an object.
1571 ThisAdjustment = CGM.getCXXABI()
1572 .getVirtualFunctionPrologueThisAdjustment(GD)
1573 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001574 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001575 ContainingType = RecordTy;
1576 }
1577
Adrian McCarthyd91bf392017-09-13 20:53:55 +00001578 if (Method->isStatic())
1579 Flags |= llvm::DINode::FlagStaticMember;
Guy Benyei11169dd2012-12-18 14:30:41 +00001580 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001581 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001582 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001583 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001584 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001585 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001586 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001587 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001588 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001589 }
1590 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001591 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001592 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001593 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001594 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001595 Flags |= llvm::DINode::FlagRValueReference;
Paul Robinsoncda54212018-11-19 18:29:28 +00001596 if (CGM.getLangOpts().Optimize)
1597 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
Guy Benyei11169dd2012-12-18 14:30:41 +00001598
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001599 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1600 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001601 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Paul Robinsoncda54212018-11-19 18:29:28 +00001602 MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001603 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001604
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001605 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001606
1607 return SP;
1608}
1609
Eric Christophere7b87e52014-10-26 23:40:33 +00001610void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001611 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1612 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001613
1614 // Since we want more than just the individual member decls if we
1615 // have templated functions iterate over every declaration to gather
1616 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001617 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001618 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1619 // If the member is implicit, don't add it to the member list. This avoids
1620 // the member being added to type units by LLVM, while still allowing it
1621 // to be emitted into the type declaration/reference inside the compile
1622 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001623 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001624 // FIXME: Handle Using(Shadow?)Decls here to create
1625 // DW_TAG_imported_declarations inside the class for base decls brought into
1626 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1627 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1628 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001629 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001630 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001631
1632 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1633 continue;
1634
David Blaikiefd580722014-10-06 05:18:55 +00001635 // Reuse the existing member function declaration if it exists.
1636 // It may be associated with the declaration of the type & should be
1637 // reused as we're building the definition.
1638 //
1639 // This situation can arise in the vtable-based debug info reduction where
1640 // implicit members are emitted in a non-vtable TU.
1641 auto MI = SPCache.find(Method->getCanonicalDecl());
1642 EltTys.push_back(MI == SPCache.end()
1643 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001644 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001645 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001646}
Guy Benyei11169dd2012-12-18 14:30:41 +00001647
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001648void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001649 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001650 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001651 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1652 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1653 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001654
Bob Haarmandff36732016-10-25 22:19:32 +00001655 // If we are generating CodeView debug info, we also need to emit records for
1656 // indirect virtual base classes.
1657 if (CGM.getCodeGenOpts().EmitCodeView) {
1658 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1659 llvm::DINode::FlagIndirectVirtualBase);
1660 }
1661}
1662
1663void CGDebugInfo::CollectCXXBasesAux(
1664 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1665 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1666 const CXXRecordDecl::base_class_const_range &Bases,
1667 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1668 llvm::DINode::DIFlags StartingFlags) {
1669 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1670 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001671 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001672 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001673 if (!SeenTypes.insert(Base).second)
1674 continue;
1675 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1676 llvm::DINode::DIFlags BFlags = StartingFlags;
1677 uint64_t BaseOffset;
Brock Wyma3db2b102018-05-14 21:21:22 +00001678 uint32_t VBPtrOffset = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001679
Aaron Ballman574705e2014-03-13 15:41:46 +00001680 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001681 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1682 // virtual base offset offset is -ve. The code generator emits dwarf
1683 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001684 BaseOffset = 0 - CGM.getItaniumVTableContext()
1685 .getVirtualBaseOffsetOffset(RD, Base)
1686 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001687 } else {
1688 // In the MS ABI, store the vbtable offset, which is analogous to the
1689 // vbase offset offset in Itanium.
1690 BaseOffset =
1691 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001692 VBPtrOffset = CGM.getContext()
1693 .getASTRecordLayout(RD)
1694 .getVBPtrOffset()
1695 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001696 }
Bob Haarmandff36732016-10-25 22:19:32 +00001697 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001698 } else
1699 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1700 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1701 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001702
Adrian Prantl21361fb2014-08-29 22:44:27 +00001703 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001704 llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1705 VBPtrOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001706 EltTys.push_back(DTy);
1707 }
1708}
1709
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001710llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001711CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1712 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001713 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001714 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001715 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1716 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001717 StringRef Name;
1718 if (TPList)
1719 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001720 switch (TA.getKind()) {
1721 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001722 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001723 TemplateParams.push_back(
1724 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001725 } break;
1726 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001727 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001728 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1729 TheCU, Name, TTy,
1730 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001731 } break;
1732 case TemplateArgument::Declaration: {
1733 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001734 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001735 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001736 llvm::Constant *V = nullptr;
Michael Liao982cbb62019-03-06 21:16:27 +00001737 // Skip retrieve the value if that template parameter has cuda device
1738 // attribute, i.e. that value is not available at the host side.
1739 if (!CGM.getLangOpts().CUDA || CGM.getLangOpts().CUDAIsDevice ||
1740 !D->hasAttr<CUDADeviceAttr>()) {
1741 const CXXMethodDecl *MD;
1742 // Variable pointer template parameters have a value that is the address
1743 // of the variable.
1744 if (const auto *VD = dyn_cast<VarDecl>(D))
1745 V = CGM.GetAddrOfGlobalVar(VD);
1746 // Member function pointers have special support for building them,
1747 // though this is currently unsupported in LLVM CodeGen.
1748 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1749 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1750 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1751 V = CGM.GetAddrOfFunction(FD);
1752 // Member data pointers have special handling too to compute the fixed
1753 // offset within the object.
1754 else if (const auto *MPT =
1755 dyn_cast<MemberPointerType>(T.getTypePtr())) {
1756 // These five lines (& possibly the above member function pointer
1757 // handling) might be able to be refactored to use similar code in
1758 // CodeGenModule::getMemberPointerConstant
1759 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1760 CharUnits chars =
1761 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1762 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1763 }
1764 V = V->stripPointerCasts();
David Blaikie38079fd2013-05-10 21:53:14 +00001765 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001766 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
Michael Liao982cbb62019-03-06 21:16:27 +00001767 TheCU, Name, TTy, cast_or_null<llvm::Constant>(V)));
David Blaikie38079fd2013-05-10 21:53:14 +00001768 } break;
1769 case TemplateArgument::NullPtr: {
1770 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001771 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001772 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001773 // Special case member data pointer null values since they're actually -1
1774 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001775 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001776 // But treat member function pointers as simple zero integers because
1777 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1778 // CodeGen grows handling for values of non-null member function
1779 // pointers then perhaps we could remove this special case and rely on
1780 // EmitNullMemberPointer for member function pointers.
1781 if (MPT->isMemberDataPointer())
1782 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1783 if (!V)
1784 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001785 TemplateParams.push_back(
1786 DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001787 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001788 case TemplateArgument::Template:
1789 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001790 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001791 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1792 break;
1793 case TemplateArgument::Pack:
1794 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1795 TheCU, Name, nullptr,
1796 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1797 break;
David Majnemer5559d472013-08-24 08:21:10 +00001798 case TemplateArgument::Expression: {
1799 const Expr *E = TA.getAsExpr();
1800 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001801 if (E->isGLValue())
1802 T = CGM.getContext().getLValueReferenceType(T);
John McCallde0fe072017-08-15 21:42:52 +00001803 llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001804 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001805 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001806 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001807 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001808 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001809 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001810 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001811 case TemplateArgument::Null:
1812 llvm_unreachable(
1813 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001814 }
1815 }
1816 return DBuilder.getOrCreateArray(TemplateParams);
1817}
1818
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001819llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001820CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001821 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001822 if (FD->getTemplatedKind() ==
1823 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001824 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1825 ->getTemplate()
1826 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001827 return CollectTemplateParams(
1828 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001829 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001830 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001831}
1832
Matthew Voss20165362018-10-03 18:45:04 +00001833llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
Reid Kleckner2dbd5d82019-05-02 17:45:54 +00001834 llvm::DIFile *Unit) {
1835 // Always get the full list of parameters, not just the ones from the
1836 // specialization. A partial specialization may have fewer parameters than
1837 // there are arguments.
1838 auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL);
1839 if (!TS)
1840 return llvm::DINodeArray();
1841 VarTemplateDecl *T = TS->getSpecializedTemplate();
1842 const TemplateParameterList *TList = T->getTemplateParameters();
1843 auto TA = TS->getTemplateArgs().asArray();
1844 return CollectTemplateParams(TList, TA, Unit);
Matthew Voss20165362018-10-03 18:45:04 +00001845}
1846
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001847llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1848 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Reid Kleckner2dbd5d82019-05-02 17:45:54 +00001849 // Always get the full list of parameters, not just the ones from the
1850 // specialization. A partial specialization may have fewer parameters than
1851 // there are arguments.
Adrian Prantl649f0302014-04-17 01:04:01 +00001852 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001853 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001854 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001855 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001856}
1857
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001858llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001859 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001860 return VTablePtrType;
1861
1862 ASTContext &Context = CGM.getContext();
1863
1864 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001865 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001866 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001867 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001868 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001869 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1870 Optional<unsigned> DWARFAddressSpace =
1871 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1872
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001873 llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1874 SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001875 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1876 return VTablePtrType;
1877}
1878
Guy Benyei11169dd2012-12-18 14:30:41 +00001879StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001880 // Copy the gdb compatible name on the side and use its reference.
1881 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001882}
1883
Reid Kleckner105c5652019-04-24 22:45:44 +00001884StringRef CGDebugInfo::getDynamicInitializerName(const VarDecl *VD,
1885 DynamicInitKind StubKind,
1886 llvm::Function *InitFn) {
1887 // If we're not emitting codeview, use the mangled name. For Itanium, this is
1888 // arbitrary.
1889 if (!CGM.getCodeGenOpts().EmitCodeView)
1890 return InitFn->getName();
1891
1892 // Print the normal qualified name for the variable, then break off the last
1893 // NNS, and add the appropriate other text. Clang always prints the global
1894 // variable name without template arguments, so we can use rsplit("::") and
1895 // then recombine the pieces.
1896 SmallString<128> QualifiedGV;
1897 StringRef Quals;
1898 StringRef GVName;
1899 {
1900 llvm::raw_svector_ostream OS(QualifiedGV);
1901 VD->printQualifiedName(OS, getPrintingPolicy());
1902 std::tie(Quals, GVName) = OS.str().rsplit("::");
1903 if (GVName.empty())
1904 std::swap(Quals, GVName);
1905 }
1906
1907 SmallString<128> InitName;
1908 llvm::raw_svector_ostream OS(InitName);
1909 if (!Quals.empty())
1910 OS << Quals << "::";
1911
1912 switch (StubKind) {
1913 case DynamicInitKind::NoStub:
1914 llvm_unreachable("not an initializer");
1915 case DynamicInitKind::Initializer:
1916 OS << "`dynamic initializer for '";
1917 break;
1918 case DynamicInitKind::AtExit:
1919 OS << "`dynamic atexit destructor for '";
1920 break;
1921 }
1922
1923 OS << GVName;
1924
1925 // Add any template specialization args.
1926 if (const auto *VTpl = dyn_cast<VarTemplateSpecializationDecl>(VD)) {
1927 printTemplateArgumentList(OS, VTpl->getTemplateArgs().asArray(),
1928 getPrintingPolicy());
1929 }
1930
1931 OS << '\'';
1932
1933 return internString(OS.str());
1934}
1935
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001936void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001937 SmallVectorImpl<llvm::Metadata *> &EltTys,
1938 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001939 // If this class is not dynamic then there is not any vtable info to collect.
1940 if (!RD->isDynamicClass())
1941 return;
1942
Reid Kleckner59812422016-08-31 20:35:01 +00001943 // Don't emit any vtable shape or vptr info if this class doesn't have an
1944 // extendable vfptr. This can happen if the class doesn't have virtual
1945 // methods, or in the MS ABI if those virtual methods only come from virtually
1946 // inherited bases.
1947 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1948 if (!RL.hasExtendableVFPtr())
1949 return;
1950
Reid Klecknerdc124992016-08-31 16:11:43 +00001951 // CodeView needs to know how large the vtable of every dynamic class is, so
1952 // emit a special named pointer type into the element list. The vptr type
1953 // points to this type as well.
1954 llvm::DIType *VPtrTy = nullptr;
1955 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1956 CGM.getTarget().getCXXABI().isMicrosoft();
1957 if (NeedVTableShape) {
1958 uint64_t PtrWidth =
1959 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1960 const VTableLayout &VFTLayout =
1961 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1962 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001963 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001964 unsigned VTableWidth = PtrWidth * VSlotCount;
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001965 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1966 Optional<unsigned> DWARFAddressSpace =
1967 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
Reid Klecknerdc124992016-08-31 16:11:43 +00001968
1969 // Create a very wide void* type and insert it directly in the element list.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001970 llvm::DIType *VTableType = DBuilder.createPointerType(
1971 nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
Reid Klecknerdc124992016-08-31 16:11:43 +00001972 EltTys.push_back(VTableType);
1973
1974 // The vptr is a pointer to this special vtable type.
1975 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1976 }
1977
1978 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001979 if (RL.getPrimaryBase())
1980 return;
1981
1982 if (!VPtrTy)
1983 VPtrTy = getOrCreateVTablePtrType(Unit);
1984
Guy Benyei11169dd2012-12-18 14:30:41 +00001985 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00001986 llvm::DIType *VPtrMember =
1987 DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1988 llvm::DINode::FlagArtificial, VPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001989 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001990}
1991
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001992llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001993 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001994 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001995 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001996 return T;
1997}
1998
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001999llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002000 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00002001 return getOrCreateStandaloneType(D, Loc);
2002}
2003
2004llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
2005 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002006 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00002007 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002008 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00002009 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00002010
Adrian Prantl73409ce2013-03-11 18:33:46 +00002011 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002012 return T;
2013}
2014
Amy Huang0d0334f2019-04-12 20:25:30 +00002015void CGDebugInfo::addHeapAllocSiteMetadata(llvm::Instruction *CI,
2016 QualType D,
2017 SourceLocation Loc) {
2018 llvm::MDNode *node;
2019 if (D.getTypePtr()->isVoidPointerType()) {
2020 node = llvm::MDNode::get(CGM.getLLVMContext(), None);
2021 } else {
2022 QualType PointeeTy = D.getTypePtr()->getPointeeType();
2023 node = getOrCreateType(PointeeTy, getOrCreateFile(Loc));
2024 }
Amy Huangfc79ab92019-04-23 21:12:58 +00002025
Amy Huang0d0334f2019-04-12 20:25:30 +00002026 CI->setMetadata("heapallocsite", node);
2027}
2028
David Blaikie483a9da2014-05-06 18:35:21 +00002029void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002030 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00002031 return;
2032 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00002033 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00002034 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002035 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00002036 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002037 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002038 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002039 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00002040}
2041
David Blaikieb2e86eb2013-08-15 20:49:17 +00002042void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002043 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00002044 !CGM.getLangOpts().CPlusPlus)
2045 completeRequiredType(RD);
2046}
2047
David Blaikieb11c8732017-01-30 06:36:08 +00002048/// Return true if the class or any of its methods are marked dllimport.
2049static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
2050 if (RD->hasAttr<DLLImportAttr>())
2051 return true;
2052 for (const CXXMethodDecl *MD : RD->methods())
2053 if (MD->hasAttr<DLLImportAttr>())
2054 return true;
2055 return false;
2056}
2057
Adrian Prantla43acdc2017-07-24 23:48:51 +00002058/// Does a type definition exist in an imported clang module?
2059static bool isDefinedInClangModule(const RecordDecl *RD) {
2060 // Only definitions that where imported from an AST file come from a module.
2061 if (!RD || !RD->isFromASTFile())
2062 return false;
2063 // Anonymous entities cannot be addressed. Treat them as not from module.
2064 if (!RD->isExternallyVisible() && RD->getName().empty())
2065 return false;
2066 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
2067 if (!CXXDecl->isCompleteDefinition())
2068 return false;
Adrian Prantlba6fdc52018-10-24 00:06:02 +00002069 // Check wether RD is a template.
Adrian Prantla43acdc2017-07-24 23:48:51 +00002070 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
2071 if (TemplateKind != TSK_Undeclared) {
Adrian Prantlba6fdc52018-10-24 00:06:02 +00002072 // Unfortunately getOwningModule() isn't accurate enough to find the
2073 // owning module of a ClassTemplateSpecializationDecl that is inside a
2074 // namespace spanning multiple modules.
2075 bool Explicit = false;
2076 if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
2077 Explicit = TD->isExplicitInstantiationOrSpecialization();
2078 if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
2079 return false;
Adrian Prantla43acdc2017-07-24 23:48:51 +00002080 // This is a template, check the origin of the first member.
2081 if (CXXDecl->field_begin() == CXXDecl->field_end())
2082 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
2083 if (!CXXDecl->field_begin()->isFromASTFile())
2084 return false;
2085 }
2086 }
2087 return true;
2088}
2089
David Blaikie6943dea2013-08-20 01:28:15 +00002090void CGDebugInfo::completeClassData(const RecordDecl *RD) {
David Blaikieb11c8732017-01-30 06:36:08 +00002091 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
2092 if (CXXRD->isDynamicClass() &&
2093 CGM.getVTableLinkage(CXXRD) ==
2094 llvm::GlobalValue::AvailableExternallyLinkage &&
2095 !isClassOrMethodDLLImport(CXXRD))
2096 return;
Adrian Prantla43acdc2017-07-24 23:48:51 +00002097
2098 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2099 return;
2100
David Blaikieb11c8732017-01-30 06:36:08 +00002101 completeClass(RD);
2102}
2103
2104void CGDebugInfo::completeClass(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002105 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00002106 return;
David Blaikie6943dea2013-08-20 01:28:15 +00002107 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00002108 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00002109 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002110 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00002111 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002112 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002113 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002114 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00002115}
2116
David Blaikie0e716b42014-03-03 23:48:23 +00002117static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
2118 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002119 for (CXXMethodDecl *MD : llvm::make_range(I, End))
2120 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00002121 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00002122 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00002123 return true;
2124 return false;
2125}
2126
Benjamin Kramer8c305922016-02-02 11:06:51 +00002127static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
2128 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00002129 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00002130 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00002131 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002132
David Blaikie1ac9c982017-04-11 21:13:37 +00002133 if (auto *ES = RD->getASTContext().getExternalSource())
2134 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2135 return true;
2136
Benjamin Kramer8c305922016-02-02 11:06:51 +00002137 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00002138 return false;
2139
2140 if (!LangOpts.CPlusPlus)
2141 return false;
2142
2143 if (!RD->isCompleteDefinitionRequired())
2144 return true;
2145
David Majnemer58ed0f32016-07-17 00:39:12 +00002146 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00002147
2148 if (!CXXDecl)
2149 return false;
2150
Adrian McCarthy99242982016-08-16 22:11:18 +00002151 // Only emit complete debug info for a dynamic class when its vtable is
2152 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00002153 // across DLL boundaries, so skip this optimization if the class or any of its
2154 // methods are marked dllimport. This isn't a complete solution, since objects
2155 // without any dllimport methods can be used in one DLL and constructed in
2156 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00002157 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00002158 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00002159 return true;
2160
2161 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00002162 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00002163 Spec = SD->getSpecializationKind();
2164
2165 if (Spec == TSK_ExplicitInstantiationDeclaration &&
2166 hasExplicitMemberDefinition(CXXDecl->method_begin(),
2167 CXXDecl->method_end()))
2168 return true;
2169
2170 return false;
2171}
2172
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00002173void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
2174 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2175 return;
2176
2177 QualType Ty = CGM.getContext().getRecordType(RD);
2178 llvm::DIType *T = getTypeOrNull(Ty);
2179 if (T && T->isForwardDecl())
2180 completeClassData(RD);
2181}
2182
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002183llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002184 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002185 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002186 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2187 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002188 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002189 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002190 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00002191 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002192
David Blaikieb2e86eb2013-08-15 20:49:17 +00002193 return CreateTypeDefinition(Ty);
2194}
2195
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002196llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00002197 RecordDecl *RD = Ty->getDecl();
2198
Guy Benyei11169dd2012-12-18 14:30:41 +00002199 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002200 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002201
2202 // Records and classes and unions can all be recursive. To handle them, we
2203 // first generate a debug descriptor for the struct as a forward declaration.
2204 // Then (if it is a definition) we go through and get debug info for all of
2205 // its members. Finally, we create a descriptor for the complete type (which
2206 // may refer to the forward decl if the struct is recursive) and replace all
2207 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002208 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002209
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002210 const RecordDecl *D = RD->getDefinition();
2211 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002212 return FwdDecl;
2213
David Majnemer58ed0f32016-07-17 00:39:12 +00002214 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00002215 CollectContainingType(CXXDecl, FwdDecl);
2216
Guy Benyei11169dd2012-12-18 14:30:41 +00002217 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002218 LexicalBlockStack.emplace_back(&*FwdDecl);
2219 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002220
Guy Benyei11169dd2012-12-18 14:30:41 +00002221 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002222 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00002223 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00002224
2225 // Note: The split of CXXDecl information here is intentional, the
2226 // gdb tests will depend on a certain ordering at printout. The debug
2227 // information offsets are still correct if we merge them all together
2228 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00002229 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002230 if (CXXDecl) {
2231 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00002232 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002233 }
2234
Eric Christopher91a31902013-01-16 01:22:32 +00002235 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00002236 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00002237 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00002238 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002239
2240 LexicalBlockStack.pop_back();
2241 RegionMap.erase(Ty->getDecl());
2242
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002243 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002244 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002245
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002246 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002247 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002248 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002249
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002250 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002251 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002252}
2253
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002254llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2255 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002256 // Ignore protocols.
2257 return getOrCreateType(Ty->getBaseType(), Unit);
2258}
2259
Manman Rene6be26c2016-09-13 17:25:08 +00002260llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2261 llvm::DIFile *Unit) {
2262 // Ignore protocols.
2263 SourceLocation Loc = Ty->getDecl()->getLocation();
2264
2265 // Use Typedefs to represent ObjCTypeParamType.
2266 return DBuilder.createTypedef(
2267 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2268 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2269 getDeclContextDescriptor(Ty->getDecl()));
2270}
2271
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002272/// \return true if Getter has the default name for the property PD.
2273static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2274 const ObjCMethodDecl *Getter) {
2275 assert(PD);
2276 if (!Getter)
2277 return true;
2278
2279 assert(Getter->getDeclName().isObjCZeroArgSelector());
2280 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002281 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002282}
2283
2284/// \return true if Setter has the default name for the property PD.
2285static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2286 const ObjCMethodDecl *Setter) {
2287 assert(PD);
2288 if (!Setter)
2289 return true;
2290
2291 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00002292 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002293 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002294}
2295
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002296llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2297 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002298 ObjCInterfaceDecl *ID = Ty->getDecl();
2299 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002300 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002301
Adrian Prantl50fd1a82016-04-20 23:59:32 +00002302 // Return a forward declaration if this type was imported from a clang module,
2303 // and this is not the compile unit with the implementation of the type (which
2304 // may contain hidden ivars).
2305 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2306 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002307 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2308 ID->getName(),
2309 getDeclContextDescriptor(ID), Unit, 0);
2310
Guy Benyei11169dd2012-12-18 14:30:41 +00002311 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002312 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002313 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002314 auto RuntimeLang =
2315 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00002316
2317 // If this is just a forward declaration return a special forward-declaration
2318 // debug type since we won't be able to lay out the entire type.
2319 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00002320 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002321 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002322 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002323 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2324 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00002325 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002326 return FwdDecl;
2327 }
2328
David Blaikieef8a9512014-05-05 23:23:53 +00002329 return CreateTypeDefinition(Ty, Unit);
2330}
2331
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002332llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00002333CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2334 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00002335 // Use the Module pointer as the key into the cache. This is a
2336 // nullptr if the "Module" is a PCH, which is safe because we don't
2337 // support chained PCH debug info, so there can only be a single PCH.
2338 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002339 auto ModRef = ModuleCache.find(M);
2340 if (ModRef != ModuleCache.end())
2341 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00002342
2343 // Macro definitions that were defined with "-D" on the command line.
2344 SmallString<128> ConfigMacros;
2345 {
2346 llvm::raw_svector_ostream OS(ConfigMacros);
2347 const auto &PPOpts = CGM.getPreprocessorOpts();
2348 unsigned I = 0;
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002349 // Translate the macro definitions back into a command line.
Adrian Prantl2388ead2015-06-30 18:01:05 +00002350 for (auto &M : PPOpts.Macros) {
2351 if (++I > 1)
2352 OS << " ";
2353 const std::string &Macro = M.first;
2354 bool Undef = M.second;
2355 OS << "\"-" << (Undef ? 'U' : 'D');
2356 for (char c : Macro)
2357 switch (c) {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002358 case '\\':
2359 OS << "\\\\";
2360 break;
2361 case '"':
2362 OS << "\\\"";
2363 break;
2364 default:
2365 OS << c;
Adrian Prantl2388ead2015-06-30 18:01:05 +00002366 }
2367 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002368 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002369 }
Adrian Prantl66689202015-09-18 23:01:45 +00002370
Adrian Prantl835e6632015-09-24 16:10:10 +00002371 bool IsRootModule = M ? !M->Parent : true;
Adrian Prantl7b6b9a12019-02-08 23:15:42 +00002372 // When a module name is specified as -fmodule-name, that module gets a
2373 // clang::Module object, but it won't actually be built or imported; it will
2374 // be textual.
Adrian Prantle308e422019-02-15 20:24:26 +00002375 if (CreateSkeletonCU && IsRootModule && Mod.getASTFile().empty() && M)
2376 assert(StringRef(M->Name).startswith(CGM.getLangOpts().ModuleName) &&
Adrian Prantl7b6b9a12019-02-08 23:15:42 +00002377 "clang module without ASTFile must be specified by -fmodule-name");
2378
2379 if (CreateSkeletonCU && IsRootModule && !Mod.getASTFile().empty()) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002380 // PCH files don't have a signature field in the control block,
2381 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00002382 // We use the lower 64 bits for debug info.
2383 uint64_t Signature =
2384 Mod.getSignature()
2385 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2386 : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002387 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002388 DIB.createCompileUnit(TheCU->getSourceLanguage(),
Scott Lindera2fbcef2018-02-26 17:32:31 +00002389 // TODO: Support "Source" from external AST providers?
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002390 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2391 TheCU->getProducer(), true, StringRef(), 0,
2392 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2393 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002394 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002395 }
Adrian Prantl7b6b9a12019-02-08 23:15:42 +00002396
Adrian Prantl835e6632015-09-24 16:10:10 +00002397 llvm::DIModule *Parent =
2398 IsRootModule ? nullptr
2399 : getOrCreateModuleRef(
2400 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2401 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002402 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002403 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2404 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002405 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002406 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002407}
2408
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002409llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2410 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002411 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002412 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002413 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002414 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002415
2416 // Bit size, align and offset of the type.
2417 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002418 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002419
Leny Kholodov80c047d2016-09-06 10:48:04 +00002420 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002421 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002422 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002423
Adrian Prantlfd696112015-10-01 00:48:51 +00002424 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002425 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002426 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2427 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002428
David Blaikieef8a9512014-05-05 23:23:53 +00002429 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002430 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002431
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002432 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002433 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002434 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002435
2436 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002437 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002438
2439 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2440 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002441 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002442 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002443 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002444 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002445
Brock Wyma3db2b102018-05-14 21:21:22 +00002446 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002447 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002448 EltTys.push_back(InhTag);
2449 }
2450
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002451 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002452 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002453 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002454 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002455 unsigned PLine = getLineNumber(Loc);
2456 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2457 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002458 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2459 PD->getName(), PUnit, PLine,
2460 hasDefaultGetterName(PD, Getter) ? ""
2461 : getSelectorName(PD->getGetterName()),
2462 hasDefaultSetterName(PD, Setter) ? ""
2463 : getSelectorName(PD->getSetterName()),
2464 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002465 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002466 };
2467 {
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002468 llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002469 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002470 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002471 PropertySet.insert(PD->getIdentifier());
2472 AddProperty(PD);
2473 }
Manman Renefe1bac2016-01-27 20:00:32 +00002474 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002475 // Don't emit duplicate metadata for properties that were already in a
2476 // class extension.
2477 if (!PropertySet.insert(PD->getIdentifier()).second)
2478 continue;
2479 AddProperty(PD);
2480 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002481 }
2482
2483 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2484 unsigned FieldNo = 0;
2485 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2486 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002487 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002488 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002489 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002490
Guy Benyei11169dd2012-12-18 14:30:41 +00002491 StringRef FieldName = Field->getName();
2492
2493 // Ignore unnamed fields.
2494 if (FieldName.empty())
2495 continue;
2496
2497 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002498 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002499 unsigned FieldLine = getLineNumber(Field->getLocation());
2500 QualType FType = Field->getType();
2501 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002502 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002503
2504 if (!FType->isIncompleteArrayType()) {
2505
2506 // Bit size, align and offset of the type.
2507 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002508 ? Field->getBitWidthValue(CGM.getContext())
2509 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002510 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002511 }
2512
2513 uint64_t FieldOffset;
2514 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2515 // We don't know the runtime offset of an ivar if we're using the
2516 // non-fragile ABI. For bitfields, use the bit offset into the first
2517 // byte of storage of the bitfield. For other fields, use zero.
2518 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002519 FieldOffset =
2520 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002521 FieldOffset %= CGM.getContext().getCharWidth();
2522 } else {
2523 FieldOffset = 0;
2524 }
2525 } else {
2526 FieldOffset = RL.getFieldOffset(FieldNo);
2527 }
2528
Leny Kholodov80c047d2016-09-06 10:48:04 +00002529 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002530 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002531 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002532 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002533 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002534 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002535 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002536
Craig Topper8a13c412014-05-21 05:09:00 +00002537 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002539 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002540 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002541 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002542 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002543 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002544 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002545 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2546 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002547 PropertyNode = DBuilder.createObjCProperty(
2548 PD->getName(), PUnit, PLine,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002549 hasDefaultGetterName(PD, Getter)
2550 ? ""
2551 : getSelectorName(PD->getGetterName()),
2552 hasDefaultSetterName(PD, Setter)
2553 ? ""
2554 : getSelectorName(PD->getSetterName()),
Eric Christophere7b87e52014-10-26 23:40:33 +00002555 PD->getPropertyAttributes(),
2556 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002557 }
2558 }
2559 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002560 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2561 FieldSize, FieldAlign, FieldOffset, Flags,
2562 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002563 EltTys.push_back(FieldTy);
2564 }
2565
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002566 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002567 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002568
Guy Benyei11169dd2012-12-18 14:30:41 +00002569 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002570 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002571}
2572
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002573llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2574 llvm::DIFile *Unit) {
2575 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002576 int64_t Count = Ty->getNumElements();
Guy Benyei11169dd2012-12-18 14:30:41 +00002577
Sander de Smalen891af03a2018-02-03 13:55:59 +00002578 llvm::Metadata *Subscript;
2579 QualType QTy(Ty, 0);
2580 auto SizeExpr = SizeExprCache.find(QTy);
2581 if (SizeExpr != SizeExprCache.end())
2582 Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2583 else
2584 Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002585 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002586
2587 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002588 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002589
2590 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2591}
2592
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002593llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002594 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002595 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002596
2597 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002598 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002599 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002600 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2601 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002602 } else if (Ty->isIncompleteArrayType()) {
2603 Size = 0;
2604 if (Ty->getElementType()->isIncompleteType())
2605 Align = 0;
2606 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002607 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002608 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002609 Size = 0;
2610 Align = 0;
2611 } else {
2612 // Size and align of the whole array, not the element type.
2613 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002614 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002615 }
2616
2617 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2618 // interior arrays, do we care? Why aren't nested arrays represented the
2619 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002620 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002621 QualType EltTy(Ty, 0);
2622 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2623 // If the number of elements is known, then count is that number. Otherwise,
2624 // it's -1. This allows us to represent a subrange with an array of 0
2625 // elements, like this:
2626 //
2627 // struct foo {
2628 // int x[0];
2629 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002630 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002631 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002632 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002633 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002634 if (Expr *Size = VAT->getSizeExpr()) {
Fangrui Song407659a2018-11-30 23:41:18 +00002635 Expr::EvalResult Result;
2636 if (Size->EvaluateAsInt(Result, CGM.getContext()))
2637 Count = Result.Val.getInt().getExtValue();
Eli Friedman01d6b962016-10-19 22:16:32 +00002638 }
David Blaikie87173f12016-08-22 17:49:56 +00002639 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002640
Sander de Smalen891af03a2018-02-03 13:55:59 +00002641 auto SizeNode = SizeExprCache.find(EltTy);
2642 if (SizeNode != SizeExprCache.end())
2643 Subscripts.push_back(
2644 DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2645 else
2646 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
Guy Benyei11169dd2012-12-18 14:30:41 +00002647 EltTy = Ty->getElementType();
2648 }
2649
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002650 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002651
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002652 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2653 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002654}
2655
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002656llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2657 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002658 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2659 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002660}
2661
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002662llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2663 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002664 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2665 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002666}
2667
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002668llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2669 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002670 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002671 uint64_t Size = 0;
2672
2673 if (!Ty->isIncompleteType()) {
2674 Size = CGM.getContext().getTypeSize(Ty);
2675
2676 // Set the MS inheritance model. There is no flag for the unspecified model.
2677 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2678 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2679 case MSInheritanceAttr::Keyword_single_inheritance:
2680 Flags |= llvm::DINode::FlagSingleInheritance;
2681 break;
2682 case MSInheritanceAttr::Keyword_multiple_inheritance:
2683 Flags |= llvm::DINode::FlagMultipleInheritance;
2684 break;
2685 case MSInheritanceAttr::Keyword_virtual_inheritance:
2686 Flags |= llvm::DINode::FlagVirtualInheritance;
2687 break;
2688 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2689 break;
2690 }
2691 }
2692 }
2693
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002694 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002695 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002696 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002697 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2698 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002699
2700 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002701 Ty->getPointeeType()->getAs<FunctionProtoType>();
2702 return DBuilder.createMemberPointerType(
Mikael Nilsson9d2872d2018-12-13 10:15:27 +00002703 getOrCreateInstanceMethodType(
2704 CXXMethodDecl::getThisType(FPT, Ty->getMostRecentCXXRecordDecl()),
2705 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002706 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002707}
2708
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002709llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002710 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2711 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002712}
2713
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002714llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
Xiuli Pan9c14e282016-01-09 12:53:17 +00002715 return getOrCreateType(Ty->getElementType(), U);
2716}
2717
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002718llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002719 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002720
Guy Benyei11169dd2012-12-18 14:30:41 +00002721 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002722 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002723 if (!ED->getTypeForDecl()->isIncompleteType()) {
2724 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002725 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002726 }
2727
Brock Wyma8557ec52018-05-22 12:41:19 +00002728 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002729
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002730 bool isImportedFromModule =
2731 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2732
Guy Benyei11169dd2012-12-18 14:30:41 +00002733 // If this is just a forward declaration, construct an appropriately
2734 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002735 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002736 // Note that it is possible for enums to be created as part of
2737 // their own declcontext. In this case a FwdDecl will be created
2738 // twice. This doesn't cause a problem because both FwdDecls are
2739 // entered into the ReplaceMap: finalize() will replace the first
2740 // FwdDecl with the second and then replace the second with
2741 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002742 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002743 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002744 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2745 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002746
Guy Benyei11169dd2012-12-18 14:30:41 +00002747 unsigned Line = getLineNumber(ED->getLocation());
2748 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002749 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002750 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
Brock Wyma8557ec52018-05-22 12:41:19 +00002751 0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
Adrian Prantla40030f2016-02-06 01:59:09 +00002752
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002753 ReplaceMap.emplace_back(
2754 std::piecewise_construct, std::make_tuple(Ty),
2755 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002756 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002757 }
2758
David Blaikie483a9da2014-05-06 18:35:21 +00002759 return CreateTypeDefinition(Ty);
2760}
2761
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002762llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002763 const EnumDecl *ED = Ty->getDecl();
2764 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002765 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002766 if (!ED->getTypeForDecl()->isIncompleteType()) {
2767 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002768 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002769 }
2770
Brock Wyma8557ec52018-05-22 12:41:19 +00002771 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
David Blaikie483a9da2014-05-06 18:35:21 +00002772
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002773 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002774 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002775 ED = ED->getDefinition();
Momchil Velikov25f6be52018-02-12 16:12:52 +00002776 bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002777 for (const auto *Enum : ED->enumerators()) {
Momchil Velikov25f6be52018-02-12 16:12:52 +00002778 const auto &InitVal = Enum->getInitVal();
2779 auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2780 Enumerators.push_back(
2781 DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
Guy Benyei11169dd2012-12-18 14:30:41 +00002782 }
2783
2784 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002785 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002786
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002787 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002788 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002789 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Momchil Velikov25f6be52018-02-12 16:12:52 +00002790 llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002791 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2792 Line, Size, Align, EltArray, ClassTy,
Paul Robinsonb1ce7c82019-01-08 16:28:11 +00002793 Identifier, ED->isScoped());
Guy Benyei11169dd2012-12-18 14:30:41 +00002794}
2795
Amjad Aboud546bc112017-02-09 22:07:24 +00002796llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2797 unsigned MType, SourceLocation LineLoc,
2798 StringRef Name, StringRef Value) {
2799 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2800 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2801}
2802
2803llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2804 SourceLocation LineLoc,
2805 SourceLocation FileLoc) {
2806 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2807 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2808 return DBuilder.createTempMacroFile(Parent, Line, FName);
2809}
2810
David Blaikie05491062013-01-21 04:37:12 +00002811static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2812 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002813 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002814 Qualifiers InnerQuals = T.getLocalQualifiers();
2815 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2816 // that is already there.
2817 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2818 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002819 QualType LastT = T;
2820 switch (T->getTypeClass()) {
2821 default:
David Blaikie05491062013-01-21 04:37:12 +00002822 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002823 case Type::TemplateSpecialization: {
2824 const auto *Spec = cast<TemplateSpecializationType>(T);
2825 if (Spec->isTypeAlias())
2826 return C.getQualifiedType(T.getTypePtr(), Quals);
2827 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002828 break;
2829 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002830 case Type::TypeOfExpr:
2831 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2832 break;
2833 case Type::TypeOf:
2834 T = cast<TypeOfType>(T)->getUnderlyingType();
2835 break;
2836 case Type::Decltype:
2837 T = cast<DecltypeType>(T)->getUnderlyingType();
2838 break;
2839 case Type::UnaryTransform:
2840 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2841 break;
2842 case Type::Attributed:
2843 T = cast<AttributedType>(T)->getEquivalentType();
2844 break;
2845 case Type::Elaborated:
2846 T = cast<ElaboratedType>(T)->getNamedType();
2847 break;
2848 case Type::Paren:
2849 T = cast<ParenType>(T)->getInnerType();
2850 break;
Leonard Chanc72aaf62019-05-07 03:20:17 +00002851 case Type::MacroQualified:
2852 T = cast<MacroQualifiedType>(T)->getUnderlyingType();
2853 break;
David Blaikie05491062013-01-21 04:37:12 +00002854 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002855 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002856 break;
Richard Smitha0abc422017-02-22 00:13:14 +00002857 case Type::Auto:
2858 case Type::DeducedTemplateSpecialization: {
2859 QualType DT = cast<DeducedType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002860 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002861 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002862 break;
2863 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002864 case Type::Adjusted:
2865 case Type::Decayed:
2866 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2867 T = cast<AdjustedType>(T)->getAdjustedType();
2868 break;
2869 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002870
Guy Benyei11169dd2012-12-18 14:30:41 +00002871 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002872 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002873 } while (true);
2874}
2875
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002876llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002877
2878 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002879 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002880
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002881 auto It = TypeCache.find(Ty.getAsOpaquePtr());
2882 if (It != TypeCache.end()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002883 // Verify that the debug info still exists.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002884 if (llvm::Metadata *V = It->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002885 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002886 }
2887
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002888 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002889}
2890
David Blaikie0e716b42014-03-03 23:48:23 +00002891void CGDebugInfo::completeTemplateDefinition(
2892 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002893 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002894 return;
David Blaikie1ac9c982017-04-11 21:13:37 +00002895 completeUnusedClass(SD);
2896}
David Blaikie0856f662014-03-04 22:01:08 +00002897
David Blaikie1ac9c982017-04-11 21:13:37 +00002898void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2899 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2900 return;
2901
2902 completeClassData(&D);
David Blaikie0e716b42014-03-03 23:48:23 +00002903 // In case this type has no member function definitions being emitted, ensure
2904 // it is retained
David Blaikie1ac9c982017-04-11 21:13:37 +00002905 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
David Blaikie0e716b42014-03-03 23:48:23 +00002906}
2907
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002908llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002909 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002910 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002911
2912 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002913 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002914
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002915 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002916 return T;
2917
Adrian Prantlca844182015-09-11 17:23:03 +00002918 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00002919 void *TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002920
2921 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002922 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002923
Guy Benyei11169dd2012-12-18 14:30:41 +00002924 return Res;
2925}
2926
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002927llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002928 // A forward declaration inside a module header does not belong to the module.
2929 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2930 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002931 if (DebugTypeExtRefs && D->isFromASTFile()) {
2932 // Record a reference to an imported clang module or precompiled header.
2933 auto *Reader = CGM.getContext().getExternalSource();
2934 auto Idx = D->getOwningModuleID();
2935 auto Info = Reader->getSourceDescriptor(Idx);
2936 if (Info)
2937 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2938 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002939 // We are building a clang module or a precompiled header.
2940 //
2941 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2942 // and it wouldn't be necessary to specify the parent scope
2943 // because the type is already unique by definition (it would look
2944 // like the output of -fno-standalone-debug). On the other hand,
2945 // the parent scope helps a consumer to quickly locate the object
2946 // file where the type's definition is located, so it might be
2947 // best to make this behavior a command line or debugger tuning
2948 // option.
Richard Smith54f04402017-05-18 02:29:20 +00002949 if (Module *M = D->getOwningModule()) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002950 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002951 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2952 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002953 } else {
2954 // This the precompiled header being built.
2955 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002956 }
2957 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002958
Adrian Prantl9402cef2015-09-20 16:51:35 +00002959 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002960}
2961
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002962llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002963 // Handle qualifiers, which recursively handles what they refer to.
2964 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002965 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002966
Guy Benyei11169dd2012-12-18 14:30:41 +00002967 // Work out details of type.
2968 switch (Ty->getTypeClass()) {
2969#define TYPE(Class, Base)
2970#define ABSTRACT_TYPE(Class, Base)
2971#define NON_CANONICAL_TYPE(Class, Base)
2972#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2973#include "clang/AST/TypeNodes.def"
2974 llvm_unreachable("Dependent types cannot show up in debug information");
2975
2976 case Type::ExtVector:
2977 case Type::Vector:
2978 return CreateType(cast<VectorType>(Ty), Unit);
2979 case Type::ObjCObjectPointer:
2980 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2981 case Type::ObjCObject:
2982 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002983 case Type::ObjCTypeParam:
2984 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002985 case Type::ObjCInterface:
2986 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2987 case Type::Builtin:
2988 return CreateType(cast<BuiltinType>(Ty));
2989 case Type::Complex:
2990 return CreateType(cast<ComplexType>(Ty));
2991 case Type::Pointer:
2992 return CreateType(cast<PointerType>(Ty), Unit);
2993 case Type::BlockPointer:
2994 return CreateType(cast<BlockPointerType>(Ty), Unit);
2995 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002996 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002997 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002998 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002999 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00003000 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00003001 case Type::FunctionProto:
3002 case Type::FunctionNoProto:
3003 return CreateType(cast<FunctionType>(Ty), Unit);
3004 case Type::ConstantArray:
3005 case Type::VariableArray:
3006 case Type::IncompleteArray:
3007 return CreateType(cast<ArrayType>(Ty), Unit);
3008
3009 case Type::LValueReference:
3010 return CreateType(cast<LValueReferenceType>(Ty), Unit);
3011 case Type::RValueReference:
3012 return CreateType(cast<RValueReferenceType>(Ty), Unit);
3013
3014 case Type::MemberPointer:
3015 return CreateType(cast<MemberPointerType>(Ty), Unit);
3016
3017 case Type::Atomic:
3018 return CreateType(cast<AtomicType>(Ty), Unit);
3019
Xiuli Pan9c14e282016-01-09 12:53:17 +00003020 case Type::Pipe:
3021 return CreateType(cast<PipeType>(Ty), Unit);
3022
Guy Benyei11169dd2012-12-18 14:30:41 +00003023 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00003024 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
3025
David Blaikie42edade2014-11-11 20:44:45 +00003026 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00003027 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00003028 case Type::Adjusted:
3029 case Type::Decayed:
Richard Smith600b5262017-01-26 20:40:47 +00003030 case Type::DeducedTemplateSpecialization:
Guy Benyei11169dd2012-12-18 14:30:41 +00003031 case Type::Elaborated:
3032 case Type::Paren:
Leonard Chanc72aaf62019-05-07 03:20:17 +00003033 case Type::MacroQualified:
Guy Benyei11169dd2012-12-18 14:30:41 +00003034 case Type::SubstTemplateTypeParm:
3035 case Type::TypeOfExpr:
3036 case Type::TypeOf:
3037 case Type::Decltype:
3038 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00003039 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00003040 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00003041 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003042
David Blaikie42edade2014-11-11 20:44:45 +00003043 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00003044}
3045
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00003046llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
3047 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00003048 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00003049
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00003050 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00003051
3052 // We may have cached a forward decl when we could have created
3053 // a non-forward decl. Go ahead and create a non-forward decl
3054 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003055 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00003056 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00003057
3058 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003059 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00003060
3061 // Propagate members from the declaration to the definition
3062 // CreateType(const RecordType*) will overwrite this with the members in the
3063 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003064 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00003065
Guy Benyei11169dd2012-12-18 14:30:41 +00003066 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003067 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00003068 return Res;
3069}
3070
3071// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003072llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003073 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003074
Guy Benyei11169dd2012-12-18 14:30:41 +00003075 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003076 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00003077 unsigned Line = getLineNumber(RD->getLocation());
3078 StringRef RDName = getClassName(RD);
3079
Amjad Abouddc4531e2016-04-30 01:44:38 +00003080 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003081
David Blaikied2785892013-08-18 17:36:19 +00003082 // If we ended up creating the type during the context chain construction,
3083 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003084 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00003085 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003086 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00003087 return T;
David Blaikied2785892013-08-18 17:36:19 +00003088
Adrian Prantl381e7552014-02-04 21:29:50 +00003089 // If this is just a forward or incomplete declaration, construct an
3090 // appropriately marked node and just return it.
3091 const RecordDecl *D = RD->getDefinition();
3092 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00003093 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00003094
3095 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00003096 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003097
Brock Wyma8557ec52018-05-22 12:41:19 +00003098 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00003099
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00003100 // Explicitly record the calling convention for C++ records.
3101 auto Flags = llvm::DINode::FlagZero;
3102 if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
3103 if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
3104 Flags |= llvm::DINode::FlagTypePassByReference;
3105 else
3106 Flags |= llvm::DINode::FlagTypePassByValue;
Aaron Smith044326c2018-07-23 20:49:07 +00003107
Aaron Smithfa7745b2019-04-11 20:24:54 +00003108 // Record if a C++ record is non-trivial type.
3109 if (!CXXRD->isTrivial())
Aaron Smithf0d27332019-02-26 03:49:05 +00003110 Flags |= llvm::DINode::FlagNonTrivial;
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00003111 }
3112
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003113 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00003114 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +00003115 Flags, Identifier);
Guy Benyei11169dd2012-12-18 14:30:41 +00003116
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003117 // Elements of composite types usually have back to the type, creating
3118 // uniquing cycles. Distinct nodes are more efficient.
3119 switch (RealDecl->getTag()) {
3120 default:
3121 llvm_unreachable("invalid composite type tag");
3122
3123 case llvm::dwarf::DW_TAG_array_type:
3124 case llvm::dwarf::DW_TAG_enumeration_type:
3125 // Array elements and most enumeration elements don't have back references,
3126 // so they don't tend to be involved in uniquing cycles and there is some
3127 // chance of merging them when linking together two modules. Only make
3128 // them distinct if they are ODR-uniqued.
Brock Wyma8557ec52018-05-22 12:41:19 +00003129 if (Identifier.empty())
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003130 break;
Galina Kistanova0872d6c2017-06-03 06:30:46 +00003131 LLVM_FALLTHROUGH;
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003132
3133 case llvm::dwarf::DW_TAG_structure_type:
3134 case llvm::dwarf::DW_TAG_union_type:
3135 case llvm::dwarf::DW_TAG_class_type:
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003136 // Immediately resolve to a distinct node.
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00003137 RealDecl =
3138 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3139 break;
3140 }
3141
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003142 RegionMap[Ty->getDecl()].reset(RealDecl);
3143 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003144
David Majnemer58ed0f32016-07-17 00:39:12 +00003145 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003146 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00003147 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00003148 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00003149}
3150
David Blaikieadfbf992013-08-18 16:55:33 +00003151void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003152 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00003153 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003154 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00003155 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3156 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00003157 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00003158 while (1) {
3159 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3160 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3161 if (PBT && !BRL.isPrimaryBaseVirtual())
3162 PBase = PBT;
3163 else
3164 break;
3165 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003166 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00003167 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3168 getOrCreateFile(RD->getLocation())));
3169 } else if (RD->isDynamicClass())
3170 ContainingType = RealDecl;
3171
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00003172 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00003173}
3174
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003175llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003176 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003177 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003178 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00003179 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003180 llvm::DIType *Ty =
3181 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3182 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003183 *Offset += FieldSize;
3184 return Ty;
3185}
3186
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003187void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00003188 StringRef &Name,
3189 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003190 llvm::DIScope *&FDContext,
3191 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003192 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003193 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00003194 Name = getFunctionName(FD);
3195 // Use mangled name as linkage name for C/C++ functions.
3196 if (FD->hasPrototype()) {
3197 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003198 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00003199 }
3200 // No need to replicate the linkage name if it isn't different from the
3201 // subprogram name, no need to have it at all unless coverage is enabled or
Dehao Chenb3a70de2017-01-19 00:44:21 +00003202 // debug is set to more than just line tables or extra debug info is needed.
Benjamin Kramer8c305922016-02-02 11:06:51 +00003203 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3204 !CGM.getCodeGenOpts().EmitGcovNotes &&
Dehao Chenb3a70de2017-01-19 00:44:21 +00003205 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
Benjamin Kramer8c305922016-02-02 11:06:51 +00003206 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00003207 LinkageName = StringRef();
3208
Benjamin Kramer8c305922016-02-02 11:06:51 +00003209 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003210 if (const NamespaceDecl *NSDecl =
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003211 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Adrian Prantlddb8e062017-05-12 16:23:53 +00003212 FDContext = getOrCreateNamespace(NSDecl);
Frederic Riss9db79f12014-11-18 03:40:46 +00003213 else if (const RecordDecl *RDecl =
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003214 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003215 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3216 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3217 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00003218 // Check if it is a noreturn-marked function
3219 if (FD->isNoReturn())
3220 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00003221 // Collect template parameters.
3222 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3223 }
3224}
3225
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003226void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00003227 unsigned &LineNo, QualType &T,
3228 StringRef &Name, StringRef &LinkageName,
Matthew Voss20165362018-10-03 18:45:04 +00003229 llvm::MDTuple *&TemplateParameters,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003230 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003231 Unit = getOrCreateFile(VD->getLocation());
3232 LineNo = getLineNumber(VD->getLocation());
3233
3234 setLocation(VD->getLocation());
3235
3236 T = VD->getType();
3237 if (T->isIncompleteArrayType()) {
3238 // CodeGen turns int[] into int[1] so we'll do the same here.
3239 llvm::APInt ConstVal(32, 1);
3240 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3241
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003242 T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3243 0);
Frederic Riss9db79f12014-11-18 03:40:46 +00003244 }
3245
3246 Name = VD->getName();
3247 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3248 !isa<ObjCMethodDecl>(VD->getDeclContext()))
3249 LinkageName = CGM.getMangledName(VD);
3250 if (LinkageName == Name)
3251 LinkageName = StringRef();
3252
Matthew Voss20165362018-10-03 18:45:04 +00003253 if (isa<VarTemplateSpecializationDecl>(VD)) {
3254 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3255 TemplateParameters = parameterNodes.get();
3256 } else {
3257 TemplateParameters = nullptr;
3258 }
3259
Frederic Riss9db79f12014-11-18 03:40:46 +00003260 // Since we emit declarations (DW_AT_members) for static members, place the
3261 // definition of those static members in the namespace they were declared in
3262 // in the source code (the lexical decl context).
3263 // FIXME: Generalize this for even non-member global variables where the
3264 // declaration and definition may have different lexical decl contexts, once
3265 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003266 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3267 : VD->getDeclContext();
3268 // When a record type contains an in-line initialization of a static data
3269 // member, and the record type is marked as __declspec(dllexport), an implicit
3270 // definition of the member will be created in the record context. DWARF
3271 // doesn't seem to have a nice way to describe this in a form that consumers
3272 // are likely to understand, so fake the "normal" situation of a definition
3273 // outside the class by putting it in the global scope.
3274 if (DC->isRecord())
3275 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003276
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003277 llvm::DIScope *Mod = getParentModuleOrNull(VD);
3278 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00003279}
3280
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003281llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3282 bool Stub) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003283 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00003284 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003285 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Paul Robinsoncda54212018-11-19 18:29:28 +00003286 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003287 SourceLocation Loc = GD.getDecl()->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003288 llvm::DIFile *Unit = getOrCreateFile(Loc);
3289 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003290 unsigned Line = getLineNumber(Loc);
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003291 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3292 Flags);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003293 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3294
Frederic Rissd253ed62014-11-18 03:40:51 +00003295 // Build function type.
3296 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003297 if (FD)
3298 for (const ParmVarDecl *Parm : FD->parameters())
3299 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00003300 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3301 QualType FnType = CGM.getContext().getFunctionType(
3302 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Paul Robinsoncda54212018-11-19 18:29:28 +00003303 if (!FD->isExternallyVisible())
3304 SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3305 if (CGM.getLangOpts().Optimize)
3306 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3307
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003308 if (Stub) {
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003309 Flags |= getCallSiteRelatedAttrs();
Paul Robinsoncda54212018-11-19 18:29:28 +00003310 SPFlags |= llvm::DISubprogram::SPFlagDefinition;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003311 return DBuilder.createFunction(
3312 DContext, Name, LinkageName, Unit, Line,
Paul Robinsoncda54212018-11-19 18:29:28 +00003313 getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003314 TParamsArray.get(), getFunctionDeclaration(FD));
3315 }
3316
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003317 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003318 DContext, Name, LinkageName, Unit, Line,
Paul Robinsoncda54212018-11-19 18:29:28 +00003319 getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003320 TParamsArray.get(), getFunctionDeclaration(FD));
George Burgess IV00f70bd2018-03-01 05:43:23 +00003321 const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003322 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3323 std::make_tuple(CanonDecl),
3324 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00003325 return SP;
3326}
3327
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003328llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003329 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3330}
3331
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003332llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003333 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3334}
3335
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003336llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00003337CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3338 QualType T;
3339 StringRef Name, LinkageName;
3340 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003341 llvm::DIFile *Unit = getOrCreateFile(Loc);
3342 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003343 unsigned Line = getLineNumber(Loc);
Matthew Voss20165362018-10-03 18:45:04 +00003344 llvm::MDTuple *TemplateParameters = nullptr;
Frederic Rissd253ed62014-11-18 03:40:51 +00003345
Matthew Voss20165362018-10-03 18:45:04 +00003346 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3347 DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00003348 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003349 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3350 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Matthew Voss20165362018-10-03 18:45:04 +00003351 !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003352 FwdDeclReplaceMap.emplace_back(
3353 std::piecewise_construct,
3354 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3355 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003356 return GV;
3357}
3358
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003359llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003360 // We only need a declaration (not a definition) of the type - so use whatever
3361 // we would otherwise do to get a type for a pointee. (forward declarations in
3362 // limited debug info, full definitions (if the type definition is available)
3363 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00003364 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00003365 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00003366 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003367 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00003368
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003369 if (I != DeclCache.end()) {
3370 auto N = I->second;
3371 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3372 return GVE->getVariable();
3373 return dyn_cast_or_null<llvm::DINode>(N);
3374 }
Frederic Rissd253ed62014-11-18 03:40:51 +00003375
3376 // No definition for now. Emit a forward definition that might be
3377 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00003378 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00003379 return getFunctionForwardDeclaration(FD);
3380 else if (const auto *VD = dyn_cast<VarDecl>(D))
3381 return getGlobalVariableForwardDeclaration(VD);
3382
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003383 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00003384}
3385
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003386llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003387 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003388 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00003389
David Majnemer58ed0f32016-07-17 00:39:12 +00003390 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00003391 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003392 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003393
3394 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003395 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003396
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003397 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00003398 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003399 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003400 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003401 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00003402 }
3403 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003404 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003405 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003406 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003407 return SP;
3408 }
3409
Aaron Ballman86c93902014-03-06 23:45:36 +00003410 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003411 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003412 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003413 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003414 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003415 return SP;
3416 }
3417 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003418 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003419}
3420
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003421// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00003422// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003423llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003424 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003425 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003426 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003427 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3428 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00003429 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00003430
David Majnemer58ed0f32016-07-17 00:39:12 +00003431 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00003432 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00003433
3434 const auto *FTy = FnType->getAs<FunctionType>();
3435 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3436
David Majnemer58ed0f32016-07-17 00:39:12 +00003437 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003438 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003439 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00003440
3441 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00003442 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00003443
3444 // Replace the instancetype keyword with the actual type.
3445 if (ResultTy == CGM.getContext().getObjCInstanceType())
3446 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00003447 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00003448
Adrian Prantl7bec9032013-05-10 21:08:31 +00003449 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003450 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003451 QualType SelfDeclTy;
3452 if (auto *SelfDecl = OMethod->getSelfDecl())
3453 SelfDeclTy = SelfDecl->getType();
3454 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3455 if (FPT->getNumParams() > 1)
3456 SelfDeclTy = FPT->getParamType(0);
3457 if (!SelfDeclTy.isNull())
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003458 Elts.push_back(
3459 CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003460 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003461 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003462 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003463 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003464 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003465 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003466 // Variadic methods need a special marker at the end of the type list.
3467 if (OMethod->isVariadic())
3468 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003469
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003470 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003471 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3472 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003473 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003474
Adrian Prantl800faef2014-02-25 23:42:18 +00003475 // Handle variadic function types; they need an additional
3476 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003477 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003478 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003479 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003480 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003481 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3482 for (QualType ParamType : FPT->param_types())
3483 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003484 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003485 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003486 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3487 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003488 }
3489
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003490 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003491}
3492
Eric Christophere7b87e52014-10-26 23:40:33 +00003493void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3494 SourceLocation ScopeLoc, QualType FnType,
Brock Wyma94ece8f2018-04-16 16:53:57 +00003495 llvm::Function *Fn, bool CurFuncIsThunk,
3496 CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003497
3498 StringRef Name;
3499 StringRef LinkageName;
3500
3501 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3502
3503 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003504 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003505
Leny Kholodov80c047d2016-09-06 10:48:04 +00003506 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Paul Robinsoncda54212018-11-19 18:29:28 +00003507 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003508 llvm::DIFile *Unit = getOrCreateFile(Loc);
3509 llvm::DIScope *FDContext = Unit;
3510 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003511 if (!HasDecl) {
3512 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003513 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003514 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003515 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003516 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003517 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003518 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003519 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003520 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003521 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003522 return;
3523 }
3524 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003525 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3526 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003527 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003528 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003529 Flags |= llvm::DINode::FlagPrototyped;
Reid Kleckner105c5652019-04-24 22:45:44 +00003530 } else if (isa<VarDecl>(D) &&
3531 GD.getDynamicInitKind() != DynamicInitKind::NoStub) {
3532 // This is a global initializer or atexit destructor for a global variable.
3533 Name = getDynamicInitializerName(cast<VarDecl>(D), GD.getDynamicInitKind(),
3534 Fn);
Guy Benyei11169dd2012-12-18 14:30:41 +00003535 } else {
3536 // Use llvm function name.
3537 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003538 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003539 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003540 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003541 Name = Name.substr(1);
3542
Erich Keane293a0552018-02-14 00:14:07 +00003543 if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003544 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003545 // Artificial functions should not silently reuse CurLoc.
3546 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003547 }
Brock Wyma94ece8f2018-04-16 16:53:57 +00003548
3549 if (CurFuncIsThunk)
3550 Flags |= llvm::DINode::FlagThunk;
3551
Paul Robinsoncda54212018-11-19 18:29:28 +00003552 if (Fn->hasLocalLinkage())
3553 SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3554 if (CGM.getLangOpts().Optimize)
3555 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3556
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003557 llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
Paul Robinsoncda54212018-11-19 18:29:28 +00003558 llvm::DISubprogram::DISPFlags SPFlagsForDef =
3559 SPFlags | llvm::DISubprogram::SPFlagDefinition;
Vedant Kumar5931b4e2018-10-05 20:37:17 +00003560
Adrian Prantl42d71b92014-04-10 23:21:53 +00003561 unsigned LineNo = getLineNumber(Loc);
3562 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003563
Eric Christopher8018e412014-03-27 18:50:35 +00003564 // FIXME: The function declaration we're constructing here is mostly reusing
3565 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3566 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3567 // all subprograms instead of the actual context since subprogram definitions
3568 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003569 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003570 FDContext, Name, LinkageName, Unit, LineNo,
Paul Robinsoncda54212018-11-19 18:29:28 +00003571 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, FlagsForDef,
3572 SPFlagsForDef, TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003573 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003574 // We might get here with a VarDecl in the case we're generating
3575 // code for the initialization of globals. Do not record these decls
3576 // as they will overwrite the actual VarDecl Decl in the cache.
3577 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003578 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003579
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00003580 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3581 // Starting with DWARF V5 method declarations are emitted as children of
3582 // the interface type.
3583 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3584 const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3585 QualType QTy(ID->getTypeForDecl(), 0);
3586 auto It = TypeCache.find(QTy.getAsOpaquePtr());
3587 if (It != TypeCache.end()) {
3588 llvm::DICompositeType *InterfaceDecl =
3589 cast<llvm::DICompositeType>(It->second);
3590 llvm::DISubprogram *FD = DBuilder.createFunction(
3591 InterfaceDecl, Name, LinkageName, Unit, LineNo,
Paul Robinsoncda54212018-11-19 18:29:28 +00003592 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00003593 TParamsArray.get());
3594 DBuilder.finalizeSubprogram(FD);
3595 ObjCMethodCache[ID].push_back(FD);
3596 }
3597 }
3598 }
3599
Adrian Prantlbebb8932014-03-21 21:01:58 +00003600 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003601 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003602
Guy Benyei11169dd2012-12-18 14:30:41 +00003603 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003604 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003605}
3606
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003607void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3608 QualType FnType) {
3609 StringRef Name;
3610 StringRef LinkageName;
3611
3612 const Decl *D = GD.getDecl();
3613 if (!D)
3614 return;
3615
Leny Kholodov80c047d2016-09-06 10:48:04 +00003616 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003617 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003618 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003619 llvm::DINodeArray TParamsArray;
3620 if (isa<FunctionDecl>(D)) {
3621 // If there is a DISubprogram for this function available then use it.
3622 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3623 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003624 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003625 Name = getObjCMethodName(OMD);
3626 Flags |= llvm::DINode::FlagPrototyped;
3627 } else {
3628 llvm_unreachable("not a function or ObjC method");
3629 }
3630 if (!Name.empty() && Name[0] == '\01')
3631 Name = Name.substr(1);
3632
3633 if (D->isImplicit()) {
3634 Flags |= llvm::DINode::FlagArtificial;
3635 // Artificial functions without a location should not silently reuse CurLoc.
3636 if (Loc.isInvalid())
3637 CurLoc = SourceLocation();
3638 }
3639 unsigned LineNo = getLineNumber(Loc);
3640 unsigned ScopeLine = 0;
Paul Robinsoncda54212018-11-19 18:29:28 +00003641 llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3642 if (CGM.getLangOpts().Optimize)
3643 SPFlags |= llvm::DISubprogram::SPFlagOptimized;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003644
Adrian Prantle76bda52016-04-15 15:55:45 +00003645 DBuilder.retainType(DBuilder.createFunction(
3646 FDContext, Name, LinkageName, Unit, LineNo,
Paul Robinsoncda54212018-11-19 18:29:28 +00003647 getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
Adrian Prantle76bda52016-04-15 15:55:45 +00003648 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003649}
3650
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003651void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3652 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3653 // If there is a subprogram for this function available then use it.
3654 auto FI = SPCache.find(FD->getCanonicalDecl());
3655 llvm::DISubprogram *SP = nullptr;
3656 if (FI != SPCache.end())
3657 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Adrian Prantl8040a212017-08-23 21:24:12 +00003658 if (!SP || !SP->isDefinition())
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003659 SP = getFunctionStub(GD);
3660 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3661 LexicalBlockStack.emplace_back(SP);
3662 setInlinedAt(Builder.getCurrentDebugLocation());
3663 EmitLocation(Builder, FD->getLocation());
3664}
3665
3666void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3667 assert(CurInlinedAt && "unbalanced inline scope stack");
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003668 EmitFunctionEnd(Builder, nullptr);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003669 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3670}
3671
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003672void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003673 // Update our current location
3674 setLocation(Loc);
3675
Adrian Prantl42ab39f2018-11-09 21:17:38 +00003676 if (CurLoc.isInvalid() || CurLoc.isMacroID() || LexicalBlockStack.empty())
Eric Christophere7b87e52014-10-26 23:40:33 +00003677 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003678
Adrian Prantle83b1302014-01-07 22:05:52 +00003679 llvm::MDNode *Scope = LexicalBlockStack.back();
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003680 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3681 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
Guy Benyei11169dd2012-12-18 14:30:41 +00003682}
3683
Guy Benyei11169dd2012-12-18 14:30:41 +00003684void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003685 llvm::MDNode *Back = nullptr;
3686 if (!LexicalBlockStack.empty())
3687 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003688 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003689 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003690 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003691}
3692
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003693void CGDebugInfo::AppendAddressSpaceXDeref(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003694 unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003695 Optional<unsigned> DWARFAddressSpace =
3696 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3697 if (!DWARFAddressSpace)
3698 return;
3699
3700 Expr.push_back(llvm::dwarf::DW_OP_constu);
3701 Expr.push_back(DWARFAddressSpace.getValue());
3702 Expr.push_back(llvm::dwarf::DW_OP_swap);
3703 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3704}
3705
Eric Christopher0fdcb312013-05-16 00:52:20 +00003706void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3707 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003708 // Set our current location.
3709 setLocation(Loc);
3710
Guy Benyei11169dd2012-12-18 14:30:41 +00003711 // Emit a line table change for the current location inside the new scope.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003712 Builder.SetCurrentDebugLocation(
3713 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3714 LexicalBlockStack.back(), CurInlinedAt));
David Blaikie60a877b2014-10-22 19:34:33 +00003715
Benjamin Kramer8c305922016-02-02 11:06:51 +00003716 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003717 return;
3718
3719 // Create a new lexical block and push it on the stack.
3720 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003721}
3722
Eric Christopher0fdcb312013-05-16 00:52:20 +00003723void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3724 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003725 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3726
3727 // Provide an entry in the line table for the end of the block.
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003728 EmitLocation(Builder, Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003729
Benjamin Kramer8c305922016-02-02 11:06:51 +00003730 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003731 return;
3732
Guy Benyei11169dd2012-12-18 14:30:41 +00003733 LexicalBlockStack.pop_back();
3734}
3735
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003736void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003737 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3738 unsigned RCount = FnBeginRegionCount.back();
3739 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3740
3741 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003742 while (LexicalBlockStack.size() != RCount) {
3743 // Provide an entry in the line table for the end of the block.
Calixte Denizetfcd661d2018-09-24 18:24:18 +00003744 EmitLocation(Builder, CurLoc);
David Blaikie60a877b2014-10-22 19:34:33 +00003745 LexicalBlockStack.pop_back();
3746 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003747 FnBeginRegionCount.pop_back();
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003748
3749 if (Fn && Fn->getSubprogram())
3750 DBuilder.finalizeSubprogram(Fn->getSubprogram());
Guy Benyei11169dd2012-12-18 14:30:41 +00003751}
3752
Adrian Prantl05a623e2018-09-10 16:14:28 +00003753CGDebugInfo::BlockByRefType
3754CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3755 uint64_t *XOffset) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003756 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003757 QualType FType;
3758 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003759 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003760
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003761 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003762 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003763
3764 FieldOffset = 0;
3765 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3766 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3767 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3768 FType = CGM.getContext().IntTy;
3769 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3770 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3771
3772 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3773 if (HasCopyAndDispose) {
3774 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003775 EltTys.push_back(
3776 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3777 EltTys.push_back(
3778 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003779 }
3780 bool HasByrefExtendedLayout;
3781 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003782 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3783 HasByrefExtendedLayout) &&
3784 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003785 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003786 EltTys.push_back(
3787 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003788 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003789
Guy Benyei11169dd2012-12-18 14:30:41 +00003790 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3791 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003792 CGM.getTarget().getPointerAlign(0))) {
3793 CharUnits FieldOffsetInBytes =
3794 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003795 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003796 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003797
Guy Benyei11169dd2012-12-18 14:30:41 +00003798 if (NumPaddingBytes.isPositive()) {
3799 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3800 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3801 pad, ArrayType::Normal, 0);
3802 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3803 }
3804 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003805
Guy Benyei11169dd2012-12-18 14:30:41 +00003806 FType = Type;
Adrian Prantl05a623e2018-09-10 16:14:28 +00003807 llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003808 FieldSize = CGM.getContext().getTypeSize(FType);
3809 FieldAlign = CGM.getContext().toBits(Align);
3810
Eric Christopherb2a008c2013-05-16 00:45:12 +00003811 *XOffset = FieldOffset;
Adrian Prantl05a623e2018-09-10 16:14:28 +00003812 llvm::DIType *FieldTy = DBuilder.createMemberType(
3813 Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3814 llvm::DINode::FlagZero, WrappedTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003815 EltTys.push_back(FieldTy);
3816 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003817
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003818 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Adrian Prantl05a623e2018-09-10 16:14:28 +00003819 return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3820 llvm::DINode::FlagZero, nullptr, Elements),
3821 WrappedTy};
Guy Benyei11169dd2012-12-18 14:30:41 +00003822}
3823
Sander de Smalen891af03a2018-02-03 13:55:59 +00003824llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3825 llvm::Value *Storage,
3826 llvm::Optional<unsigned> ArgNo,
3827 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003828 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003829 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003830 if (VD->hasAttr<NoDebugAttr>())
Sander de Smalen891af03a2018-02-03 13:55:59 +00003831 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003832
David Blaikie7fceebf2013-08-19 03:37:48 +00003833 bool Unwritten =
3834 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3835 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003836 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003837 if (!Unwritten)
3838 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003839 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003840 uint64_t XOffset = 0;
3841 if (VD->hasAttr<BlocksAttr>())
Adrian Prantl05a623e2018-09-10 16:14:28 +00003842 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003843 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003844 Ty = getOrCreateType(VD->getType(), Unit);
3845
3846 // If there is no debug info for this type then do not emit debug info
3847 // for this variable.
3848 if (!Ty)
Sander de Smalen891af03a2018-02-03 13:55:59 +00003849 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003850
Guy Benyei11169dd2012-12-18 14:30:41 +00003851 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003852 unsigned Line = 0;
3853 unsigned Column = 0;
3854 if (!Unwritten) {
3855 Line = getLineNumber(VD->getLocation());
3856 Column = getColumnNumber(VD->getLocation());
3857 }
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003858 SmallVector<int64_t, 13> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003859 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003860 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003861 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003862
3863 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3864
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003865 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3866 AppendAddressSpaceXDeref(AddressSpace, Expr);
3867
Alexey Bataev24f710182017-06-09 13:55:08 +00003868 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3869 // object pointer flag.
Alexey Bataev56223232017-06-09 13:40:18 +00003870 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3871 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3872 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3873 Flags |= llvm::DINode::FlagObjectPointer;
3874 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003875
Adrian Prantlc3782a12017-04-18 01:22:01 +00003876 // Note: Older versions of clang used to emit byval references with an extra
3877 // DW_OP_deref, because they referenced the IR arg directly instead of
3878 // referencing an alloca. Newer versions of LLVM don't treat allocas
3879 // differently from other function arguments when used in a dbg.declare.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003880 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003881 StringRef Name = VD->getName();
3882 if (!Name.empty()) {
3883 if (VD->hasAttr<BlocksAttr>()) {
Adrian Prantlc3782a12017-04-18 01:22:01 +00003884 // Here, we need an offset *into* the alloca.
Guy Benyei11169dd2012-12-18 14:30:41 +00003885 CharUnits offset = CharUnits::fromQuantity(32);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003886 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003887 // offset of __forwarding field
3888 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003889 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003890 Expr.push_back(offset.getQuantity());
3891 Expr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003892 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003893 // offset of x field
3894 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003895 Expr.push_back(offset.getQuantity());
Adrian Prantlc3782a12017-04-18 01:22:01 +00003896 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003897 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003898 // If VD is an anonymous union then Storage represents value for
3899 // all union fields.
George Burgess IV00f70bd2018-03-01 05:43:23 +00003900 const RecordDecl *RD = RT->getDecl();
Adrian Prantl0d820892015-04-29 15:05:50 +00003901 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003902 // GDB has trouble finding local variables in anonymous unions, so we emit
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003903 // artificial local variables for each of the members.
Adrian Prantl00820ab2015-04-29 16:52:31 +00003904 //
3905 // FIXME: Remove this code as soon as GDB supports this.
3906 // The debug info verifier in LLVM operates based on the assumption that a
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003907 // variable has the same size as its storage and we had to disable the
3908 // check for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003909 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003910 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003911 StringRef FieldName = Field->getName();
3912
3913 // Ignore unnamed fields. Do not ignore unnamed records.
3914 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3915 continue;
3916
3917 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003918 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003919 auto *D = DBuilder.createAutoVariable(
3920 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003921 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003922
3923 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003924 DBuilder.insertDeclare(
3925 Storage, D, DBuilder.createExpression(Expr),
3926 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3927 Builder.GetInsertBlock());
Adrian Prantl0d820892015-04-29 15:05:50 +00003928 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003929 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003930 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003931
3932 // Create the descriptor for the variable.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00003933 auto *D = ArgNo ? DBuilder.createParameterVariable(
3934 Scope, Name, *ArgNo, Unit, Line, Ty,
3935 CGM.getLangOpts().Optimize, Flags)
3936 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3937 CGM.getLangOpts().Optimize,
3938 Flags, Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003939
3940 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003941 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003942 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003943 Builder.GetInsertBlock());
Sander de Smalen891af03a2018-02-03 13:55:59 +00003944
3945 return D;
Guy Benyei11169dd2012-12-18 14:30:41 +00003946}
3947
Sander de Smalen891af03a2018-02-03 13:55:59 +00003948llvm::DILocalVariable *
3949CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
3950 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003951 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Sander de Smalen891af03a2018-02-03 13:55:59 +00003952 return EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003953}
3954
Hsiangkai Wang35751492019-01-24 05:34:29 +00003955void CGDebugInfo::EmitLabel(const LabelDecl *D, CGBuilderTy &Builder) {
3956 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3957 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3958
3959 if (D->hasAttr<NoDebugAttr>())
3960 return;
3961
3962 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3963 llvm::DIFile *Unit = getOrCreateFile(D->getLocation());
3964
3965 // Get location information.
3966 unsigned Line = getLineNumber(D->getLocation());
3967 unsigned Column = getColumnNumber(D->getLocation());
3968
3969 StringRef Name = D->getName();
3970
3971 // Create the descriptor for the label.
3972 auto *L =
3973 DBuilder.createLabel(Scope, Name, Unit, Line, CGM.getLangOpts().Optimize);
3974
3975 // Insert an llvm.dbg.label into the current block.
3976 DBuilder.insertLabel(L,
3977 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3978 Builder.GetInsertBlock());
3979}
3980
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003981llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3982 llvm::DIType *Ty) {
3983 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003984 if (CachedTy)
3985 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003986 return DBuilder.createObjectPointerType(Ty);
3987}
3988
Eric Christophere7b87e52014-10-26 23:40:33 +00003989void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3990 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003991 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003992 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003993 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003994
Craig Topper8a13c412014-05-21 05:09:00 +00003995 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003996 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003997 if (VD->hasAttr<NoDebugAttr>())
3998 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003999
Guy Benyei11169dd2012-12-18 14:30:41 +00004000 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00004001
Guy Benyei11169dd2012-12-18 14:30:41 +00004002 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004003 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4004 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00004005 if (isByRef)
Adrian Prantl05a623e2018-09-10 16:14:28 +00004006 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00004007 else
Guy Benyei11169dd2012-12-18 14:30:41 +00004008 Ty = getOrCreateType(VD->getType(), Unit);
4009
4010 // Self is passed along as an implicit non-arg variable in a
4011 // block. Mark it as the object pointer.
Alexey Bataev56223232017-06-09 13:40:18 +00004012 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
4013 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
4014 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00004015
4016 // Get location information.
4017 unsigned Line = getLineNumber(VD->getLocation());
4018 unsigned Column = getColumnNumber(VD->getLocation());
4019
4020 const llvm::DataLayout &target = CGM.getDataLayout();
4021
4022 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00004023 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00004024 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
4025
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00004026 SmallVector<int64_t, 9> addr;
Adrian Prantlc3782a12017-04-18 01:22:01 +00004027 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00004028 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00004029 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00004030 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00004031 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00004032 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00004033 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00004034 offset =
4035 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00004036 addr.push_back(offset.getQuantity());
4037 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00004038 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00004039 // offset of x field
4040 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00004041 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00004042 }
4043
4044 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00004045 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00004046 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004047 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00004048 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00004049
Guy Benyei11169dd2012-12-18 14:30:41 +00004050 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00004051 auto DL =
4052 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
Adrian Prantlc3782a12017-04-18 01:22:01 +00004053 auto *Expr = DBuilder.createExpression(addr);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00004054 if (InsertPoint)
Adrian Prantlc3782a12017-04-18 01:22:01 +00004055 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00004056 else
Adrian Prantlc3782a12017-04-18 01:22:01 +00004057 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00004058}
4059
Guy Benyei11169dd2012-12-18 14:30:41 +00004060void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
4061 unsigned ArgNo,
4062 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004063 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00004064 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00004065}
4066
4067namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00004068struct BlockLayoutChunk {
4069 uint64_t OffsetInBits;
4070 const BlockDecl::Capture *Capture;
4071};
4072bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
4073 return l.OffsetInBits < r.OffsetInBits;
4074}
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004075} // namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00004076
Scott Linder58df0e42018-08-08 15:56:12 +00004077void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
4078 const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
4079 const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
4080 SmallVectorImpl<llvm::Metadata *> &Fields) {
4081 // Blocks in OpenCL have unique constraints which make the standard fields
4082 // redundant while requiring size and align fields for enqueue_kernel. See
4083 // initializeForBlockHeader in CGBlocks.cpp
4084 if (CGM.getLangOpts().OpenCL) {
4085 Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
4086 BlockLayout.getElementOffsetInBits(0),
4087 Unit, Unit));
4088 Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
4089 BlockLayout.getElementOffsetInBits(1),
4090 Unit, Unit));
4091 } else {
4092 Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
4093 BlockLayout.getElementOffsetInBits(0),
4094 Unit, Unit));
4095 Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
4096 BlockLayout.getElementOffsetInBits(1),
4097 Unit, Unit));
4098 Fields.push_back(
4099 createFieldType("__reserved", Context.IntTy, Loc, AS_public,
4100 BlockLayout.getElementOffsetInBits(2), Unit, Unit));
4101 auto *FnTy = Block.getBlockExpr()->getFunctionType();
4102 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
4103 Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
4104 BlockLayout.getElementOffsetInBits(3),
4105 Unit, Unit));
4106 Fields.push_back(createFieldType(
4107 "__descriptor",
4108 Context.getPointerType(Block.NeedsCopyDispose
4109 ? Context.getBlockDescriptorExtendedType()
4110 : Context.getBlockDescriptorType()),
4111 Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
4112 }
4113}
4114
Guy Benyei11169dd2012-12-18 14:30:41 +00004115void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl356347b2017-10-26 20:08:52 +00004116 StringRef Name,
David Blaikie77bbb5f2014-08-08 17:10:14 +00004117 unsigned ArgNo,
Adrian Prantl356347b2017-10-26 20:08:52 +00004118 llvm::AllocaInst *Alloca,
Guy Benyei11169dd2012-12-18 14:30:41 +00004119 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004120 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00004121 ASTContext &C = CGM.getContext();
4122 const BlockDecl *blockDecl = block.getBlockDecl();
4123
4124 // Collect some general information about the block's location.
4125 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004126 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00004127 unsigned line = getLineNumber(loc);
4128 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00004129
Guy Benyei11169dd2012-12-18 14:30:41 +00004130 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004131 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00004132
4133 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00004134 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00004135
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004136 SmallVector<llvm::Metadata *, 16> fields;
Scott Linder58df0e42018-08-08 15:56:12 +00004137 collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
4138 fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00004139
4140 // We want to sort the captures by offset, not because DWARF
4141 // requires this, but because we're paranoid about debuggers.
4142 SmallVector<BlockLayoutChunk, 8> chunks;
4143
4144 // 'this' capture.
4145 if (blockDecl->capturesCXXThis()) {
4146 BlockLayoutChunk chunk;
4147 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00004148 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00004149 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004150 chunks.push_back(chunk);
4151 }
4152
4153 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00004154 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004155 const VarDecl *variable = capture.getVariable();
4156 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
4157
4158 // Ignore constant captures.
4159 if (captureInfo.isConstant())
4160 continue;
4161
4162 BlockLayoutChunk chunk;
4163 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00004164 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00004165 chunk.Capture = &capture;
4166 chunks.push_back(chunk);
4167 }
4168
4169 // Sort by offset.
4170 llvm::array_pod_sort(chunks.begin(), chunks.end());
4171
David Majnemer58ed0f32016-07-17 00:39:12 +00004172 for (const BlockLayoutChunk &Chunk : chunks) {
4173 uint64_t offsetInBits = Chunk.OffsetInBits;
4174 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00004175
4176 // If we have a null capture, this must be the C++ 'this' capture.
4177 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00004178 QualType type;
4179 if (auto *Method =
4180 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
Brian Gesiak5488ab42019-01-11 01:54:53 +00004181 type = Method->getThisType();
Adrian Prantl2526fca2016-04-18 23:48:16 +00004182 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4183 type = QualType(RDecl->getTypeForDecl(), 0);
4184 else
4185 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00004186
David Majnemerb4b671e2016-06-30 03:01:59 +00004187 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00004188 offsetInBits, tunit, tunit));
4189 continue;
4190 }
4191
4192 const VarDecl *variable = capture->getVariable();
4193 StringRef name = variable->getName();
4194
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004195 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00004196 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00004197 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00004198 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Adrian Prantl05a623e2018-09-10 16:14:28 +00004199 // FIXME: This recomputes the layout of the BlockByRefWrapper.
Guy Benyei11169dd2012-12-18 14:30:41 +00004200 uint64_t xoffset;
Adrian Prantl05a623e2018-09-10 16:14:28 +00004201 fieldType =
4202 EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
David Majnemer34b57492014-07-30 01:30:47 +00004203 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00004204 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4205 PtrInfo.Width, Align, offsetInBits,
4206 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00004207 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004208 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00004209 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00004210 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00004211 }
4212 fields.push_back(fieldType);
4213 }
4214
4215 SmallString<36> typeName;
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004216 llvm::raw_svector_ostream(typeName)
4217 << "__block_literal_" << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00004218
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004219 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00004220
Leny Kholodovdf050fd2016-09-06 17:06:14 +00004221 llvm::DIType *type =
4222 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00004223 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00004224 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00004225 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4226
4227 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00004228 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004229 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00004230
4231 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00004232 auto *debugVar = DBuilder.createParameterVariable(
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004233 scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00004234
Adrian Prantl616bef42013-03-14 21:52:59 +00004235 // Insert an llvm.dbg.declare into the current block.
Adrian Prantl356347b2017-10-26 20:08:52 +00004236 DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00004237 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00004238 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00004239}
4240
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004241llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00004242CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4243 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00004244 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00004245
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004246 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00004247 if (MI != StaticDataMemberCache.end()) {
4248 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00004249 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00004250 }
David Blaikiece763042013-08-20 21:49:21 +00004251
4252 // If the member wasn't found in the cache, lazily construct and add it to the
4253 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00004254 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004255 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00004256 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00004257}
4258
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004259llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004260 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4261 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004262 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004263
4264 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004265 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00004266 StringRef FieldName = Field->getName();
4267
4268 // Ignore unnamed fields, but recurse into anonymous records.
4269 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00004270 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004271 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004272 Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004273 continue;
4274 }
4275 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004276 GVE = DBuilder.createGlobalVariableExpression(
4277 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4278 Var->hasLocalLinkage());
4279 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004280 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004281 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00004282}
4283
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004284void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00004285 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004286 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004287 if (D->hasAttr<NoDebugAttr>())
4288 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004289
4290 // If we already created a DIGlobalVariable for this declaration, just attach
4291 // it to the llvm::GlobalVariable.
4292 auto Cached = DeclCache.find(D->getCanonicalDecl());
4293 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004294 return Var->addDebugInfo(
4295 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004296
Guy Benyei11169dd2012-12-18 14:30:41 +00004297 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004298 llvm::DIFile *Unit = nullptr;
4299 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00004300 unsigned LineNo;
4301 StringRef DeclName, LinkageName;
4302 QualType T;
Matthew Voss20165362018-10-03 18:45:04 +00004303 llvm::MDTuple *TemplateParameters = nullptr;
4304 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4305 TemplateParameters, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004306
4307 // Attempt to store one global variable for the declaration - even if we
4308 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004309 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004310
4311 // If this is an anonymous union then we'll want to emit a global
4312 // variable for each member of the anonymous union so that it's possible
4313 // to find the name of any field in the union.
4314 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00004315 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00004316 assert(RD->isAnonymousStructOrUnion() &&
4317 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004318 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004319 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004320 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004321
4322 SmallVector<int64_t, 4> Expr;
4323 unsigned AddressSpace =
4324 CGM.getContext().getTargetAddressSpace(D->getType());
Alexey Bataev1a9e05d2019-02-05 19:45:57 +00004325 if (CGM.getLangOpts().CUDA && CGM.getLangOpts().CUDAIsDevice) {
4326 if (D->hasAttr<CUDASharedAttr>())
4327 AddressSpace =
4328 CGM.getContext().getTargetAddressSpace(LangAS::cuda_shared);
4329 else if (D->hasAttr<CUDAConstantAttr>())
4330 AddressSpace =
4331 CGM.getContext().getTargetAddressSpace(LangAS::cuda_constant);
4332 }
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004333 AppendAddressSpaceXDeref(AddressSpace, Expr);
4334
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004335 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00004336 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004337 Var->hasLocalLinkage(),
4338 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
Matthew Voss20165362018-10-03 18:45:04 +00004339 getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4340 Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004341 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004342 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004343 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00004344}
4345
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004346void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004347 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004348 if (VD->hasAttr<NoDebugAttr>())
4349 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00004350 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004351 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004352 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004353 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004354 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
Amy Huang63305c82019-05-22 15:48:59 +00004355
4356 // Do not use global variables for enums.
David Majnemer58ed0f32016-07-17 00:39:12 +00004357 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4358 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004359 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
Dmitri Gribenkob4175132019-05-22 17:45:24 +00004360 (void)ED;
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004361 return;
Amy Huang63305c82019-05-22 15:48:59 +00004362 }
4363
David Blaikiea15565562014-04-04 20:56:17 +00004364 // Do not emit separate definitions for function local const/statics.
4365 if (isa<FunctionDecl>(VD->getDeclContext()))
4366 return;
David Blaikiebb113912014-04-05 07:23:17 +00004367 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00004368 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004369 if (VarD->isStaticDataMember()) {
4370 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004371 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00004372 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00004373 //
4374 // FIXME: This is probably unnecessary, since Ty should reference RD
4375 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00004376 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00004377 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00004378 return;
4379 }
4380
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004381 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004382
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004383 auto &GV = DeclCache[VD];
4384 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00004385 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004386 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00004387 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4388 // FIXME: Add a representation for integer constants wider than 64 bits.
4389 if (Init.isInt())
4390 InitExpr =
4391 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4392 else if (Init.isFloat())
4393 InitExpr = DBuilder.createConstantValueExpression(
4394 Init.getFloat().bitcastToAPInt().getZExtValue());
4395 }
Matthew Voss20165362018-10-03 18:45:04 +00004396
4397 llvm::MDTuple *TemplateParameters = nullptr;
4398
4399 if (isa<VarTemplateSpecializationDecl>(VD))
4400 if (VarD) {
4401 llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4402 TemplateParameters = parameterNodes.get();
4403 }
4404
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004405 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00004406 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00004407 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
Matthew Voss20165362018-10-03 18:45:04 +00004408 TemplateParameters, Align));
David Blaikiebd483762013-05-20 04:58:53 +00004409}
4410
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004411llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00004412 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00004413 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00004414 llvm::DIScope *Mod = getParentModuleOrNull(D);
4415 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004416}
4417
David Blaikie9f88fe82013-04-22 06:13:21 +00004418void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004419 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004420 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004421 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00004422 if (!NSDecl->isAnonymousNamespace() ||
4423 CGM.getCodeGenOpts().DebugExplicitImport) {
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004424 auto Loc = UD.getLocation();
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004425 DBuilder.createImportedModule(
4426 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004427 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004428 }
David Blaikie9f88fe82013-04-22 06:13:21 +00004429}
4430
David Blaikiebd483762013-05-20 04:58:53 +00004431void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004432 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004433 return;
4434 assert(UD.shadow_size() &&
4435 "We shouldn't be codegening an invalid UsingDecl containing no decls");
4436 // Emitting one decl is sufficient - debuggers can detect that this is an
4437 // overloaded name & provide lookup for all the overloads.
4438 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00004439
4440 // FIXME: Skip functions with undeduced auto return type for now since we
4441 // don't currently have the plumbing for separate declarations & definitions
4442 // of free functions and mismatched types (auto in the declaration, concrete
4443 // return type in the definition)
4444 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4445 if (const auto *AT =
4446 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4447 if (AT->getDeducedType().isNull())
4448 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004449 if (llvm::DINode *Target =
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004450 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4451 auto Loc = USD.getLocation();
David Blaikiebd483762013-05-20 04:58:53 +00004452 DBuilder.createImportedDeclaration(
4453 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004454 getOrCreateFile(Loc), getLineNumber(Loc));
4455 }
David Blaikiebd483762013-05-20 04:58:53 +00004456}
4457
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004458void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00004459 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4460 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00004461 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00004462 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004463 auto Loc = ID.getLocation();
Adrian Prantl8a634c12015-12-18 19:44:31 +00004464 DBuilder.createImportedDeclaration(
4465 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004466 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4467 getLineNumber(Loc));
Adrian Prantl8a634c12015-12-18 19:44:31 +00004468 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004469}
4470
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004471llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00004472CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004473 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004474 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004475 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00004476 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004477 return cast<llvm::DIImportedEntity>(VH);
4478 llvm::DIImportedEntity *R;
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004479 auto Loc = NA.getLocation();
David Majnemer58ed0f32016-07-17 00:39:12 +00004480 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00004481 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4482 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00004483 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004484 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004485 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4486 getLineNumber(Loc), NA.getName());
David Blaikief121b932013-05-20 22:50:41 +00004487 else
David Blaikie551fb0a2014-04-06 06:30:03 +00004488 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004489 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantlddb8e062017-05-12 16:23:53 +00004490 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004491 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004492 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00004493 return R;
4494}
4495
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004496llvm::DINamespace *
Adrian Prantlddb8e062017-05-12 16:23:53 +00004497CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4498 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4499 // if necessary, and this way multiple declarations of the same namespace in
4500 // different parent modules stay distinct.
4501 auto I = NamespaceCache.find(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004502 if (I != NamespaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004503 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00004504
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004505 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004506 // Don't trust the context if it is a DIModule (see comment above).
Adrian Prantlddb8e062017-05-12 16:23:53 +00004507 llvm::DINamespace *NS =
4508 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4509 NamespaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00004510 return NS;
4511}
4512
Adrian Prantla5206ce2015-09-22 23:26:43 +00004513void CGDebugInfo::setDwoId(uint64_t Signature) {
4514 assert(TheCU && "no main compile unit");
4515 TheCU->setDWOId(Signature);
4516}
4517
Guy Benyei11169dd2012-12-18 14:30:41 +00004518void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00004519 // Creating types might create further types - invalidating the current
4520 // element and the size(), so don't cache/reference them.
4521 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4522 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004523 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00004524 ? CreateTypeDefinition(E.Type, E.Unit)
4525 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004526 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00004527 }
4528
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004529 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4530 // Add methods to interface.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004531 for (const auto &P : ObjCMethodCache) {
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004532 if (P.second.empty())
4533 continue;
4534
4535 QualType QTy(P.first->getTypeForDecl(), 0);
4536 auto It = TypeCache.find(QTy.getAsOpaquePtr());
4537 assert(It != TypeCache.end());
4538
4539 llvm::DICompositeType *InterfaceDecl =
4540 cast<llvm::DICompositeType>(It->second);
4541
4542 SmallVector<llvm::Metadata *, 16> EltTys;
4543 auto CurrenetElts = InterfaceDecl->getElements();
4544 EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4545 for (auto &MD : P.second)
4546 EltTys.push_back(MD);
4547 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4548 DBuilder.replaceArrays(InterfaceDecl, Elements);
4549 }
4550 }
4551
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004552 for (const auto &P : ReplaceMap) {
4553 assert(P.second);
4554 auto *Ty = cast<llvm::DIType>(P.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004555 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00004556
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004557 auto It = TypeCache.find(P.first);
4558 assert(It != TypeCache.end());
4559 assert(It->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00004560
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004561 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004562 cast<llvm::DIType>(It->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00004563 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00004564
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004565 for (const auto &P : FwdDeclReplaceMap) {
4566 assert(P.second);
4567 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004568 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00004569
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004570 auto It = DeclCache.find(P.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00004571 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00004572 // with ourselves, that will destroy the temporary MDNode and
4573 // replace it with a standard one, avoiding leaking memory.
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004574 if (It == DeclCache.end())
4575 Repl = P.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00004576 else
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004577 Repl = It->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00004578
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004579 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4580 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004581 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00004582 }
4583
Adrian Prantl73409ce2013-03-11 18:33:46 +00004584 // We keep our own list of retained types, because we need to look
4585 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00004586 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00004587 if (auto MD = TypeCache[RT])
4588 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00004589
Guy Benyei11169dd2012-12-18 14:30:41 +00004590 DBuilder.finalize();
4591}
David Blaikie66088d52014-09-24 17:01:27 +00004592
4593void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004594 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00004595 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004596
Adrian Prantlc2a44ec2018-12-11 16:58:46 +00004597 if (auto *DieTy = getOrCreateType(Ty, TheCU->getFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004598 // Don't ignore in case of explicit cast where it is referenced indirectly.
4599 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00004600}
Amara Emerson652795d2016-11-10 14:44:30 +00004601
4602llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4603 if (LexicalBlockStack.empty())
4604 return llvm::DebugLoc();
4605
4606 llvm::MDNode *Scope = LexicalBlockStack.back();
Jonas Devlieghere9ef49652018-06-28 10:56:40 +00004607 return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
Amara Emerson652795d2016-11-10 14:44:30 +00004608}
Vedant Kumar5931b4e2018-10-05 20:37:17 +00004609
4610llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4611 // Call site-related attributes are only useful in optimized programs, and
4612 // when there's a possibility of debugging backtraces.
4613 if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4614 DebugKind == codegenoptions::LocTrackingOnly)
4615 return llvm::DINode::FlagZero;
4616
4617 // Call site-related attributes are available in DWARF v5. Some debuggers,
4618 // while not fully DWARF v5-compliant, may accept these attributes as if they
4619 // were part of DWARF v4.
4620 bool SupportsDWARFv4Ext =
4621 CGM.getCodeGenOpts().DwarfVersion == 4 &&
4622 CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB;
4623 if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4624 return llvm::DINode::FlagZero;
4625
4626 return llvm::DINode::FlagAllCallsDescribed;
4627}