blob: 5a527cbde3768808807b50aa02a081647bb5807c [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This coordinates the debug information generation while generating code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGDebugInfo.h"
15#include "CGBlocks.h"
David Blaikie38079fd2013-05-10 21:53:14 +000016#include "CGCXXABI.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000017#include "CGObjCRuntime.h"
Bob Haarmandff36732016-10-25 22:19:32 +000018#include "CGRecordLayout.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000019#include "CodeGenFunction.h"
20#include "CodeGenModule.h"
John McCallde0fe072017-08-15 21:42:52 +000021#include "ConstantEmitter.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000022#include "clang/AST/ASTContext.h"
23#include "clang/AST/DeclFriend.h"
24#include "clang/AST/DeclObjC.h"
25#include "clang/AST/DeclTemplate.h"
26#include "clang/AST/Expr.h"
27#include "clang/AST/RecordLayout.h"
28#include "clang/Basic/FileManager.h"
29#include "clang/Basic/SourceManager.h"
30#include "clang/Basic/Version.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000031#include "clang/Frontend/CodeGenOptions.h"
Taewook Oh0fb5b782017-08-16 19:36:24 +000032#include "clang/Frontend/FrontendOptions.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000033#include "clang/Lex/HeaderSearchOptions.h"
Adrian Prantl9402cef2015-09-20 16:51:35 +000034#include "clang/Lex/ModuleMap.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000035#include "clang/Lex/PreprocessorOptions.h"
Bob Haarmandff36732016-10-25 22:19:32 +000036#include "llvm/ADT/DenseSet.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000037#include "llvm/ADT/SmallVector.h"
38#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000039#include "llvm/IR/Constants.h"
40#include "llvm/IR/DataLayout.h"
41#include "llvm/IR/DerivedTypes.h"
42#include "llvm/IR/Instructions.h"
43#include "llvm/IR/Intrinsics.h"
44#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,
David Blaikie835afb22015-01-21 23:08:17 +000079 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000080 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +000081 init(TemporaryLocation);
82}
83
Adrian Prantl39428e72015-02-03 18:40:42 +000084ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000085 bool DefaultToEmpty,
Adrian Prantl39428e72015-02-03 18:40:42 +000086 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000087 : CGF(&CGF) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000088 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000089}
90
91void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Adrian Prantl95b24e92015-02-03 20:00:54 +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()) {
105 DI->EmitLocation(CGF->Builder, TemporaryLocation);
106 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);
Guy Benyei11169dd2012-12-18 14:30:41 +0000183
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000184 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000185 return;
186
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000187 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000188 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000189 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
190 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000191 } else if (isa<llvm::DILexicalBlock>(Scope) ||
192 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000193 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000194 LexicalBlockStack.emplace_back(
195 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000196 }
197}
198
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000199llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000200 llvm::DIScope *Mod = getParentModuleOrNull(D);
201 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
202 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000203}
204
205llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
206 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000207 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000208 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000209
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000210 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000211 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000212 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000213 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000214 }
215
216 // Check namespace.
Adrian Prantlddb8e062017-05-12 16:23:53 +0000217 if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
218 return getOrCreateNamespace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000219
David Majnemer58ed0f32016-07-17 00:39:12 +0000220 if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000221 if (!RDecl->isDependentType())
222 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000223 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000224 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000225}
226
Reid Kleckner59d12202017-08-08 01:33:53 +0000227PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
228 PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
229
230 // If we're emitting codeview, it's important to try to match MSVC's naming so
231 // that visualizers written for MSVC will trigger for our class names. In
232 // particular, we can't have spaces between arguments of standard templates
233 // like basic_string and vector.
234 if (CGM.getCodeGenOpts().EmitCodeView)
235 PP.MSVCFormatting = true;
236
237 return PP;
238}
239
Guy Benyei11169dd2012-12-18 14:30:41 +0000240StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000241 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000242 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000243 FunctionTemplateSpecializationInfo *Info =
244 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000245
Reid Kleckner31abd802016-06-30 17:41:31 +0000246 // Emit the unqualified name in normal operation. LLVM and the debugger can
247 // compute the fully qualified name from the scope chain. If we're only
248 // emitting line table info, there won't be any scope chains, so emit the
249 // fully qualified name here so that stack traces are more accurate.
250 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
251 // evaluating the size impact.
252 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
253 CGM.getCodeGenOpts().EmitCodeView;
254
255 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000256 return FII->getName();
257
Benjamin Kramer9170e912013-02-22 15:46:01 +0000258 SmallString<128> NS;
259 llvm::raw_svector_ostream OS(NS);
Reid Kleckner31abd802016-06-30 17:41:31 +0000260 if (!UseQualifiedName)
261 FD->printName(OS);
262 else
Reid Kleckner59d12202017-08-08 01:33:53 +0000263 FD->printQualifiedName(OS, getPrintingPolicy());
Guy Benyei11169dd2012-12-18 14:30:41 +0000264
Reid Kleckner829398e2016-06-17 16:11:20 +0000265 // Add any template specialization args.
266 if (Info) {
267 const TemplateArgumentList *TArgs = Info->TemplateArguments;
Serge Pavlov03e672c2017-11-28 16:14:14 +0000268 printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
Guy Benyei11169dd2012-12-18 14:30:41 +0000269 }
270
271 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000272 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000273}
274
275StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
276 SmallString<256> MethodName;
277 llvm::raw_svector_ostream OS(MethodName);
278 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
279 const DeclContext *DC = OMD->getDeclContext();
David Majnemer58ed0f32016-07-17 00:39:12 +0000280 if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000281 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000282 } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000283 OS << OID->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +0000284 } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000285 if (OC->IsClassExtension()) {
286 OS << OC->getClassInterface()->getName();
287 } else {
David Majnemer58ed0f32016-07-17 00:39:12 +0000288 OS << OC->getIdentifier()->getNameStart() << '('
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000289 << OC->getIdentifier()->getNameStart() << ')';
290 }
David Majnemer58ed0f32016-07-17 00:39:12 +0000291 } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
Argyrios Kyrtzidisa166a2b2017-03-07 09:26:07 +0000292 OS << OCD->getClassInterface()->getName() << '('
293 << OCD->getName() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000294 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000295 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000296 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000297 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000298 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000299 ClassTy.print(OS, PrintingPolicy(LangOptions()));
300 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000301 }
302 OS << ' ' << OMD->getSelector().getAsString() << ']';
303
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000304 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000305}
306
Guy Benyei11169dd2012-12-18 14:30:41 +0000307StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000308 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000309}
310
Eric Christophere7b87e52014-10-26 23:40:33 +0000311StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000312 if (isa<ClassTemplateSpecializationDecl>(RD)) {
313 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000314 llvm::raw_svector_ostream OS(Name);
Reid Kleckner59d12202017-08-08 01:33:53 +0000315 RD->getNameForDiagnostic(OS, getPrintingPolicy(),
David Blaikie65813a32014-04-02 18:21:09 +0000316 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000317
318 // Copy this name on the side and use its reference.
319 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000320 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000321
David Majnemerbc5976a2016-07-01 23:12:54 +0000322 // quick optimization to avoid having to intern strings that are already
323 // stored reliably elsewhere
324 if (const IdentifierInfo *II = RD->getIdentifier())
325 return II->getName();
326
327 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
328 // used to reconstruct the fully qualified type names.
329 if (CGM.getCodeGenOpts().EmitCodeView) {
330 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
331 assert(RD->getDeclContext() == D->getDeclContext() &&
332 "Typedef should not be in another decl context!");
333 assert(D->getDeclName().getAsIdentifierInfo() &&
334 "Typedef was not named!");
335 return D->getDeclName().getAsIdentifierInfo()->getName();
336 }
337
338 if (CGM.getLangOpts().CPlusPlus) {
339 StringRef Name;
340
341 ASTContext &Context = CGM.getContext();
342 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
343 // Anonymous types without a name for linkage purposes have their
344 // declarator mangled in if they have one.
345 Name = DD->getName();
346 else if (const TypedefNameDecl *TND =
347 Context.getTypedefNameForUnnamedTagDecl(RD))
348 // Anonymous types without a name for linkage purposes have their
349 // associate typedef mangled in if they have one.
350 Name = TND->getName();
351
352 if (!Name.empty()) {
353 SmallString<256> UnnamedType("<unnamed-type-");
354 UnnamedType += Name;
355 UnnamedType += '>';
356 return internString(UnnamedType);
357 }
358 }
359 }
360
361 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000362}
363
Scott Linder94834f12018-02-12 19:47:05 +0000364Optional<llvm::DIFile::ChecksumKind>
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000365CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
366 Checksum.clear();
367
Paul Robinson76178632018-05-25 22:35:59 +0000368 if (!CGM.getCodeGenOpts().EmitCodeView &&
369 CGM.getCodeGenOpts().DwarfVersion < 5)
Scott Linder94834f12018-02-12 19:47:05 +0000370 return None;
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000371
372 SourceManager &SM = CGM.getContext().getSourceManager();
373 bool Invalid;
Paul Robinson76178632018-05-25 22:35:59 +0000374 llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
375 if (Invalid)
Scott Linder94834f12018-02-12 19:47:05 +0000376 return None;
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000377
378 llvm::MD5 Hash;
379 llvm::MD5::MD5Result Result;
380
381 Hash.update(MemBuffer->getBuffer());
382 Hash.final(Result);
383
384 Hash.stringifyResult(Result, Checksum);
385 return llvm::DIFile::CSK_MD5;
386}
387
Scott Lindera2fbcef2018-02-26 17:32:31 +0000388Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM, FileID FID) {
389 if (!CGM.getCodeGenOpts().EmbedSource)
390 return None;
391
392 bool SourceInvalid = false;
393 StringRef Source = SM.getBufferData(FID, &SourceInvalid);
394
395 if (SourceInvalid)
396 return None;
397
398 return Source;
399}
400
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000401llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000402 if (!Loc.isValid())
403 // If Location is not valid then use main input file.
Scott Linder39ceac12018-02-26 16:31:08 +0000404 return getOrCreateMainFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000405
406 SourceManager &SM = CGM.getContext().getSourceManager();
407 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
408
409 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
410 // If the location is not valid then use main input file.
Scott Linder39ceac12018-02-26 16:31:08 +0000411 return getOrCreateMainFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000412
413 // Cache the results.
414 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000415 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000416
417 if (it != DIFileCache.end()) {
418 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000419 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000420 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000421 }
422
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000423 SmallString<32> Checksum;
Scott Linder94834f12018-02-12 19:47:05 +0000424 Optional<llvm::DIFile::ChecksumKind> CSKind =
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000425 computeChecksum(SM.getFileID(Loc), Checksum);
Scott Linder94834f12018-02-12 19:47:05 +0000426 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
427 if (CSKind)
428 CSInfo.emplace(*CSKind, Checksum);
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000429
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000430 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000431 remapDIPath(getCurrentDirname()),
Scott Lindera2fbcef2018-02-26 17:32:31 +0000432 CSInfo,
433 getSource(SM, SM.getFileID(Loc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000434
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000435 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 return F;
437}
438
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000439llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Scott Lindera2fbcef2018-02-26 17:32:31 +0000440 return DBuilder.createFile(
441 remapDIPath(TheCU->getFilename()),
442 remapDIPath(TheCU->getDirectory()),
443 TheCU->getFile()->getChecksum(),
444 CGM.getCodeGenOpts().EmbedSource ? TheCU->getSource() : None);
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000445}
446
447std::string CGDebugInfo::remapDIPath(StringRef Path) const {
448 for (const auto &Entry : DebugPrefixMap)
449 if (Path.startswith(Entry.first))
450 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
451 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000452}
453
Guy Benyei11169dd2012-12-18 14:30:41 +0000454unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
455 if (Loc.isInvalid() && CurLoc.isInvalid())
456 return 0;
457 SourceManager &SM = CGM.getContext().getSourceManager();
458 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000459 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000460}
461
Adrian Prantlc7822422013-03-12 20:43:25 +0000462unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000464 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000465 return 0;
466
467 // If the location is invalid then use the current column.
468 if (Loc.isInvalid() && CurLoc.isInvalid())
469 return 0;
470 SourceManager &SM = CGM.getContext().getSourceManager();
471 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000472 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000473}
474
475StringRef CGDebugInfo::getCurrentDirname() {
476 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
477 return CGM.getCodeGenOpts().DebugCompilationDir;
478
479 if (!CWDName.empty())
480 return CWDName;
481 SmallString<256> CWD;
482 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000483 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000484}
485
Guy Benyei11169dd2012-12-18 14:30:41 +0000486void CGDebugInfo::CreateCompileUnit() {
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000487 SmallString<32> Checksum;
Scott Linder94834f12018-02-12 19:47:05 +0000488 Optional<llvm::DIFile::ChecksumKind> CSKind;
489 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo;
Guy Benyei11169dd2012-12-18 14:30:41 +0000490
David Blaikieaabde052014-05-14 00:29:00 +0000491 // Should we be asking the SourceManager for the main file name, instead of
492 // accepting it as an argument? This just causes the main file name to
493 // mismatch with source locations and create extra lexical scopes or
494 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
495 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
496 // because that's what the SourceManager says)
497
Guy Benyei11169dd2012-12-18 14:30:41 +0000498 // Get absolute path name.
499 SourceManager &SM = CGM.getContext().getSourceManager();
500 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
501 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000502 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000503
504 // The main file name provided via the "-main-file-name" option contains just
505 // the file name itself with no path information. This file name may have had
506 // a relative path, so we look into the actual file entry for the main
507 // file to determine the real absolute path for the file.
508 std::string MainFileDir;
509 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000510 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000511 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000512 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
513 llvm::sys::path::append(MainFileDirSS, MainFileName);
514 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000515 }
Taewook Oh0fb5b782017-08-16 19:36:24 +0000516 // If the main file name provided is identical to the input file name, and
517 // if the input file is a preprocessed source, use the module name for
518 // debug info. The module name comes from the name specified in the first
519 // linemarker if the input is a preprocessed source.
520 if (MainFile->getName() == MainFileName &&
521 FrontendOptions::getInputKindForExtension(
522 MainFile->getName().rsplit('.').second)
523 .isPreprocessed())
524 MainFileName = CGM.getModule().getName().str();
525
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000526 CSKind = computeChecksum(SM.getMainFileID(), Checksum);
Guy Benyei11169dd2012-12-18 14:30:41 +0000527 }
528
Ed Masteda706022014-05-07 12:49:30 +0000529 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000530 const LangOptions &LO = CGM.getLangOpts();
531 if (LO.CPlusPlus) {
532 if (LO.ObjC1)
533 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
534 else
535 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
536 } else if (LO.ObjC1) {
537 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000538 } else if (LO.RenderScript) {
539 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000540 } else if (LO.C99) {
541 LangTag = llvm::dwarf::DW_LANG_C99;
542 } else {
543 LangTag = llvm::dwarf::DW_LANG_C89;
544 }
545
546 std::string Producer = getClangFullVersion();
547
548 // Figure out which version of the ObjC runtime we have.
549 unsigned RuntimeVers = 0;
550 if (LO.ObjC1)
551 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
552
Adrian Prantl826824e2016-04-08 22:43:06 +0000553 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
554 switch (DebugKind) {
555 case codegenoptions::NoDebugInfo:
556 case codegenoptions::LocTrackingOnly:
557 EmissionKind = llvm::DICompileUnit::NoDebug;
558 break;
559 case codegenoptions::DebugLineTablesOnly:
560 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
561 break;
562 case codegenoptions::LimitedDebugInfo:
563 case codegenoptions::FullDebugInfo:
564 EmissionKind = llvm::DICompileUnit::FullDebug;
565 break;
566 }
567
Scott Linder94834f12018-02-12 19:47:05 +0000568 if (CSKind)
569 CSInfo.emplace(*CSKind, Checksum);
570
Guy Benyei11169dd2012-12-18 14:30:41 +0000571 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000572 // FIXME - Eliminate TheCU.
Adrian Prantlb4423022017-08-04 23:08:57 +0000573 auto &CGOpts = CGM.getCodeGenOpts();
Eric Christophere4200a22014-02-27 01:25:08 +0000574 TheCU = DBuilder.createCompileUnit(
David Blaikie81503552017-04-21 23:35:36 +0000575 LangTag,
576 DBuilder.createFile(remapDIPath(MainFileName),
Scott Lindera2fbcef2018-02-26 17:32:31 +0000577 remapDIPath(getCurrentDirname()),
578 CSInfo,
579 getSource(SM, SM.getMainFileID())),
Mikhail Maltsev4a4e7a32018-04-23 10:08:46 +0000580 CGOpts.EmitVersionIdentMetadata ? Producer : "",
Tobias Edler von Koch7609cb82018-06-22 20:23:21 +0000581 LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
Adrian Prantlb4423022017-08-04 23:08:57 +0000582 CGOpts.DwarfDebugFlags, RuntimeVers,
583 CGOpts.EnableSplitDwarf ? "" : CGOpts.SplitDwarfFile, EmissionKind,
Peter Collingbourneb52e2362017-09-12 21:50:41 +0000584 0 /* DWOid */, CGOpts.SplitDwarfInlining, CGOpts.DebugInfoForProfiling,
585 CGOpts.GnuPubnames);
Guy Benyei11169dd2012-12-18 14:30:41 +0000586}
587
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000588llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000589 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000590 StringRef BTName;
591 switch (BT->getKind()) {
592#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000593#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000594#include "clang/AST/BuiltinTypes.def"
595 case BuiltinType::Dependent:
596 llvm_unreachable("Unexpected builtin type");
597 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000598 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000599 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000600 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000601 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000602 if (!ClassTy)
603 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
604 "objc_class", TheCU,
605 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000606 return ClassTy;
607 case BuiltinType::ObjCId: {
608 // typedef struct objc_class *Class;
609 // typedef struct objc_object {
610 // Class isa;
611 // } *id;
612
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000613 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000614 return ObjTy;
615
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000616 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000617 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
618 "objc_class", TheCU,
619 getOrCreateMainFile(), 0);
620
621 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000622
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000623 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000624
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000625 ObjTy = DBuilder.createStructType(
626 TheCU, "objc_object", getOrCreateMainFile(), 0, 0, 0,
627 llvm::DINode::FlagZero, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000628
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000629 DBuilder.replaceArrays(
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000630 ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
631 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0,
632 llvm::DINode::FlagZero, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000633 return ObjTy;
634 }
635 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000636 if (!SelTy)
637 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
638 "objc_selector", TheCU,
639 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000640 return SelTy;
641 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000642
Alexey Bader954ba212016-04-08 13:40:33 +0000643#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
644 case BuiltinType::Id: \
645 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
646 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000647#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000648 case BuiltinType::OCLSampler:
Yaxun Liu0bc4b2d2016-07-28 19:26:30 +0000649 return getOrCreateStructPtrType("opencl_sampler_t",
650 OCLSamplerDITy);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000651 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000652 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000653 case BuiltinType::OCLClkEvent:
654 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
655 case BuiltinType::OCLQueue:
656 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000657 case BuiltinType::OCLReserveID:
658 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000659
Guy Benyei11169dd2012-12-18 14:30:41 +0000660 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000661 case BuiltinType::Char_U:
662 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
663 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000664 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000665 case BuiltinType::SChar:
666 Encoding = llvm::dwarf::DW_ATE_signed_char;
667 break;
Richard Smith3a8244d2018-05-01 05:02:45 +0000668 case BuiltinType::Char8:
Guy Benyei11169dd2012-12-18 14:30:41 +0000669 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000670 case BuiltinType::Char32:
671 Encoding = llvm::dwarf::DW_ATE_UTF;
672 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000673 case BuiltinType::UShort:
674 case BuiltinType::UInt:
675 case BuiltinType::UInt128:
676 case BuiltinType::ULong:
677 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000678 case BuiltinType::ULongLong:
679 Encoding = llvm::dwarf::DW_ATE_unsigned;
680 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000681 case BuiltinType::Short:
682 case BuiltinType::Int:
683 case BuiltinType::Int128:
684 case BuiltinType::Long:
685 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000686 case BuiltinType::LongLong:
687 Encoding = llvm::dwarf::DW_ATE_signed;
688 break;
689 case BuiltinType::Bool:
690 Encoding = llvm::dwarf::DW_ATE_boolean;
691 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000692 case BuiltinType::Half:
693 case BuiltinType::Float:
694 case BuiltinType::LongDouble:
Sjoerd Meijercc623ad2017-09-08 15:15:00 +0000695 case BuiltinType::Float16:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000696 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000697 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000698 // FIXME: For targets where long double and __float128 have the same size,
699 // they are currently indistinguishable in the debugger without some
700 // special treatment. However, there is currently no consensus on encoding
701 // and this should be updated once a DWARF encoding exists for distinct
702 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000703 Encoding = llvm::dwarf::DW_ATE_float;
704 break;
Leonard Chanf921d852018-06-04 16:07:52 +0000705 case BuiltinType::ShortAccum:
706 case BuiltinType::Accum:
707 case BuiltinType::LongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000708 case BuiltinType::ShortFract:
709 case BuiltinType::Fract:
710 case BuiltinType::LongFract:
711 case BuiltinType::SatShortFract:
712 case BuiltinType::SatFract:
713 case BuiltinType::SatLongFract:
714 case BuiltinType::SatShortAccum:
715 case BuiltinType::SatAccum:
716 case BuiltinType::SatLongAccum:
Leonard Chanf921d852018-06-04 16:07:52 +0000717 Encoding = llvm::dwarf::DW_ATE_signed_fixed;
718 break;
719 case BuiltinType::UShortAccum:
720 case BuiltinType::UAccum:
721 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +0000722 case BuiltinType::UShortFract:
723 case BuiltinType::UFract:
724 case BuiltinType::ULongFract:
725 case BuiltinType::SatUShortAccum:
726 case BuiltinType::SatUAccum:
727 case BuiltinType::SatULongAccum:
728 case BuiltinType::SatUShortFract:
729 case BuiltinType::SatUFract:
730 case BuiltinType::SatULongFract:
Leonard Chanf921d852018-06-04 16:07:52 +0000731 Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
732 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000733 }
734
735 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000736 case BuiltinType::Long:
737 BTName = "long int";
738 break;
739 case BuiltinType::LongLong:
740 BTName = "long long int";
741 break;
742 case BuiltinType::ULong:
743 BTName = "long unsigned int";
744 break;
745 case BuiltinType::ULongLong:
746 BTName = "long long unsigned int";
747 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000748 default:
749 BTName = BT->getName(CGM.getLangOpts());
750 break;
751 }
Victor Leschuka7ece032016-10-20 00:13:19 +0000752 // Bit size and offset of the type.
Guy Benyei11169dd2012-12-18 14:30:41 +0000753 uint64_t Size = CGM.getContext().getTypeSize(BT);
Victor Leschuka7ece032016-10-20 00:13:19 +0000754 return DBuilder.createBasicType(BTName, Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000755}
756
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000757llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Victor Leschuka7ece032016-10-20 00:13:19 +0000758 // Bit size and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000759 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000760 if (Ty->isComplexIntegerType())
761 Encoding = llvm::dwarf::DW_ATE_lo_user;
762
763 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +0000764 return DBuilder.createBasicType("complex", Size, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000765}
766
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000767llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
768 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000769 QualifierCollector Qc;
770 const Type *T = Qc.strip(Ty);
771
772 // Ignore these qualifiers for now.
773 Qc.removeObjCGCAttr();
774 Qc.removeAddressSpace();
775 Qc.removeObjCLifetime();
776
777 // We will create one Derived type for one qualifier and recurse to handle any
778 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000779 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000780 if (Qc.hasConst()) {
781 Tag = llvm::dwarf::DW_TAG_const_type;
782 Qc.removeConst();
783 } else if (Qc.hasVolatile()) {
784 Tag = llvm::dwarf::DW_TAG_volatile_type;
785 Qc.removeVolatile();
786 } else if (Qc.hasRestrict()) {
787 Tag = llvm::dwarf::DW_TAG_restrict_type;
788 Qc.removeRestrict();
789 } else {
790 assert(Qc.empty() && "Unknown type qualifier for debug info");
791 return getOrCreateType(QualType(T, 0), Unit);
792 }
793
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000794 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000795
796 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
797 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000798 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000799}
800
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000801llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
802 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000803
804 // The frontend treats 'id' as a typedef to an ObjCObjectType,
805 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
806 // debug info, we want to emit 'id' in both cases.
807 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000808 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000809
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000810 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
811 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000812}
813
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000814llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
815 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000816 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000817 Ty->getPointeeType(), Unit);
818}
819
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000820/// \return whether a C++ mangling exists for the type defined by TD.
821static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
822 switch (TheCU->getSourceLanguage()) {
823 case llvm::dwarf::DW_LANG_C_plus_plus:
824 return true;
825 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
826 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
827 default:
828 return false;
829 }
830}
831
Brock Wyma8557ec52018-05-22 12:41:19 +0000832// Determines if the tag declaration will require a type identifier.
833static bool needsTypeIdentifier(const TagDecl *TD,
834 CodeGenModule& CGM,
835 llvm::DICompileUnit *TheCU) {
836 // We only add a type identifier for types with C++ name mangling.
837 if (!hasCXXMangling(TD, TheCU))
838 return false;
839
840 // CodeView types with C++ mangling need a type identifier.
841 if (CGM.getCodeGenOpts().EmitCodeView)
842 return true;
843
844 // Externally visible types with C++ mangling need a type identifier.
845 if (TD->isExternallyVisible())
846 return true;
847
848 return false;
849}
850
851// When emitting CodeView debug information we need to produce a type
852// identifier for all types which have a C++ mangling. Until a GUID is added
853// to the identifier (not currently implemented) the result will not be unique
854// across compilation units.
855// When emitting DWARF debug information, we need to produce a type identifier
856// for all externally visible types with C++ name mangling. This identifier
857// should be unique across ODR-compliant compilation units.
858static SmallString<256> getTypeIdentifier(const TagType *Ty,
859 CodeGenModule &CGM,
860 llvm::DICompileUnit *TheCU) {
861 SmallString<256> Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000862 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000863
Brock Wyma8557ec52018-05-22 12:41:19 +0000864 if (!needsTypeIdentifier(TD, CGM, TheCU))
865 return Identifier;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000866
Manman Rene0064d82013-08-29 23:19:58 +0000867 // TODO: This is using the RTTI name. Is there a better way to get
868 // a unique string for a type?
Brock Wyma8557ec52018-05-22 12:41:19 +0000869 llvm::raw_svector_ostream Out(Identifier);
Manman Rene0064d82013-08-29 23:19:58 +0000870 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Brock Wyma8557ec52018-05-22 12:41:19 +0000871 return Identifier;
Manman Rene0064d82013-08-29 23:19:58 +0000872}
873
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000874/// \return the appropriate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000875static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
876 llvm::dwarf::Tag Tag;
877 if (RD->isStruct() || RD->isInterface())
878 Tag = llvm::dwarf::DW_TAG_structure_type;
879 else if (RD->isUnion())
880 Tag = llvm::dwarf::DW_TAG_union_type;
881 else {
882 // FIXME: This could be a struct type giving a default visibility different
883 // than C++ class type, but needs llvm metadata changes first.
884 assert(RD->isClass());
885 Tag = llvm::dwarf::DW_TAG_class_type;
886 }
887 return Tag;
888}
889
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000890llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000891CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000892 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000893 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000894 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
895 return cast<llvm::DICompositeType>(T);
896 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000897 unsigned Line = getLineNumber(RD->getLocation());
898 StringRef RDName = getClassName(RD);
899
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000900 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000901 uint32_t Align = 0;
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000902
Guy Benyei11169dd2012-12-18 14:30:41 +0000903 // Create the type.
Brock Wyma8557ec52018-05-22 12:41:19 +0000904 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000905 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000906 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +0000907 llvm::DINode::FlagFwdDecl, Identifier);
Paul Robinson1787f812017-09-28 18:37:02 +0000908 if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
909 if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
910 DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
911 CollectCXXTemplateParams(TSpecial, DefUnit));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000912 ReplaceMap.emplace_back(
913 std::piecewise_construct, std::make_tuple(Ty),
914 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000915 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000916}
917
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000918llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000919 const Type *Ty,
920 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000921 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000922 // Bit size, align and offset of the type.
923 // Size is always the size of a pointer. We can't use getTypeSize here
924 // because that does not return the correct value for references.
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000925 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
926 uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
Victor Leschuka7ece032016-10-20 00:13:19 +0000927 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000928 Optional<unsigned> DWARFAddressSpace =
929 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000930
Keno Fischer87842f32015-11-16 09:04:13 +0000931 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
932 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
933 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000934 Size, Align, DWARFAddressSpace);
Keno Fischer87842f32015-11-16 09:04:13 +0000935 else
936 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +0000937 Align, DWARFAddressSpace);
Guy Benyei11169dd2012-12-18 14:30:41 +0000938}
939
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000940llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
941 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000942 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000943 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000944 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
945 TheCU, getOrCreateMainFile(), 0);
946 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
947 Cache = DBuilder.createPointerType(Cache, Size);
948 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000949}
950
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000951llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
952 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000953 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000954 QualType FType;
955 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +0000956 uint32_t FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000957 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000958
959 FieldOffset = 0;
960 FType = CGM.getContext().UnsignedLongTy;
961 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
962 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
963
964 Elements = DBuilder.getOrCreateArray(EltTys);
965 EltTys.clear();
966
Leny Kholodov80c047d2016-09-06 10:48:04 +0000967 llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000968 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000969
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000970 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000971 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000972 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000973
974 // Bit size, align and offset of the type.
975 uint64_t Size = CGM.getContext().getTypeSize(Ty);
976
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000977 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000978
979 FieldOffset = 0;
980 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
981 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
982 FType = CGM.getContext().IntTy;
983 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
984 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000985 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000986 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
987
988 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000989 FieldSize = CGM.getContext().getTypeSize(Ty);
990 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Leny Kholodovdf050fd2016-09-06 17:06:14 +0000991 EltTys.push_back(DBuilder.createMemberType(
992 Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign, FieldOffset,
993 llvm::DINode::FlagZero, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000994
995 FieldOffset += FieldSize;
996 Elements = DBuilder.getOrCreateArray(EltTys);
997
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000998 // The __block_literal_generic structs are marked with a special
999 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1000 // the debugger needs to know about. To allow type uniquing, emit
1001 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001002 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001003 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001004 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001005
Adrian Prantl3d2c0512015-07-07 00:49:35 +00001006 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +00001007}
1008
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001009llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1010 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +00001011 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001012 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +00001013
1014 SmallString<128> NS;
1015 llvm::raw_svector_ostream OS(NS);
Serge Pavlov03e672c2017-11-28 16:14:14 +00001016 Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1017 printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
David Blaikief1b382e2014-04-06 17:14:06 +00001018
David Majnemer58ed0f32016-07-17 00:39:12 +00001019 auto *AliasDecl = cast<TypeAliasTemplateDecl>(
Eric Christophere7b87e52014-10-26 23:40:33 +00001020 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +00001021
1022 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +00001023 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1024 getLineNumber(Loc),
1025 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +00001026}
1027
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001028llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1029 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001030 // We don't set size information, but do specify where the typedef was
1031 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +00001032 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001033
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001034 // Typedefs are derived from some other type.
1035 return DBuilder.createTypedef(
1036 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1037 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +00001038 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001039}
1040
Reid Klecknerf00f8032016-06-08 20:41:54 +00001041static unsigned getDwarfCC(CallingConv CC) {
1042 switch (CC) {
1043 case CC_C:
1044 // Avoid emitting DW_AT_calling_convention if the C convention was used.
1045 return 0;
1046
1047 case CC_X86StdCall:
1048 return llvm::dwarf::DW_CC_BORLAND_stdcall;
1049 case CC_X86FastCall:
1050 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1051 case CC_X86ThisCall:
1052 return llvm::dwarf::DW_CC_BORLAND_thiscall;
1053 case CC_X86VectorCall:
1054 return llvm::dwarf::DW_CC_LLVM_vectorcall;
1055 case CC_X86Pascal:
1056 return llvm::dwarf::DW_CC_BORLAND_pascal;
Martin Storsjo022e7822017-07-17 20:49:45 +00001057 case CC_Win64:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001058 return llvm::dwarf::DW_CC_LLVM_Win64;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001059 case CC_X86_64SysV:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001060 return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001061 case CC_AAPCS:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001062 return llvm::dwarf::DW_CC_LLVM_AAPCS;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001063 case CC_AAPCS_VFP:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001064 return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001065 case CC_IntelOclBicc:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001066 return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001067 case CC_SpirFunction:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001068 return llvm::dwarf::DW_CC_LLVM_SpirFunction;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +00001069 case CC_OpenCLKernel:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001070 return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001071 case CC_Swift:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001072 return llvm::dwarf::DW_CC_LLVM_Swift;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001073 case CC_PreserveMost:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001074 return llvm::dwarf::DW_CC_LLVM_PreserveMost;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001075 case CC_PreserveAll:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001076 return llvm::dwarf::DW_CC_LLVM_PreserveAll;
Erich Keane757d3172016-11-02 18:29:35 +00001077 case CC_X86RegCall:
Jonas Devliegheref0702682018-03-22 13:53:30 +00001078 return llvm::dwarf::DW_CC_LLVM_X86RegCall;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001079 }
1080 return 0;
1081}
1082
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001083llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1084 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001085 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001086
1087 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +00001088 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001089
1090 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +00001091 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +00001092 if (isa<FunctionNoProtoType>(Ty))
1093 EltTys.push_back(DBuilder.createUnspecifiedParameter());
David Majnemer58ed0f32016-07-17 00:39:12 +00001094 else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1095 for (const QualType &ParamType : FPT->param_types())
1096 EltTys.push_back(getOrCreateType(ParamType, Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +00001097 if (FPT->isVariadic())
1098 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00001099 }
1100
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001101 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00001102 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
Reid Klecknerf00f8032016-06-08 20:41:54 +00001103 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001104}
1105
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001106/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +00001107/// As an optimization, return 0 if the access specifier equals the
1108/// default for the containing type.
Leny Kholodovdf050fd2016-09-06 17:06:14 +00001109static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1110 const RecordDecl *RD) {
Adrian Prantl21361fb2014-08-29 22:44:27 +00001111 AccessSpecifier Default = clang::AS_none;
1112 if (RD && RD->isClass())
1113 Default = clang::AS_private;
1114 else if (RD && (RD->isStruct() || RD->isUnion()))
1115 Default = clang::AS_public;
1116
1117 if (Access == Default)
Leny Kholodov80c047d2016-09-06 10:48:04 +00001118 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001119
Eric Christophere7b87e52014-10-26 23:40:33 +00001120 switch (Access) {
1121 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001122 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +00001123 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001124 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +00001125 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001126 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +00001127 case clang::AS_none:
Leny Kholodov80c047d2016-09-06 10:48:04 +00001128 return llvm::DINode::FlagZero;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001129 }
1130 llvm_unreachable("unexpected access enumerator");
1131}
Guy Benyei11169dd2012-12-18 14:30:41 +00001132
David Majnemerb4b671e2016-06-30 03:01:59 +00001133llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1134 llvm::DIScope *RecordTy,
1135 const RecordDecl *RD) {
1136 StringRef Name = BitFieldDecl->getName();
1137 QualType Ty = BitFieldDecl->getType();
1138 SourceLocation Loc = BitFieldDecl->getLocation();
1139 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1140 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1141
1142 // Get the location for the field.
1143 llvm::DIFile *File = getOrCreateFile(Loc);
1144 unsigned Line = getLineNumber(Loc);
1145
1146 const CGBitFieldInfo &BitFieldInfo =
1147 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1148 uint64_t SizeInBits = BitFieldInfo.Size;
1149 assert(SizeInBits > 0 && "found named 0-width bitfield");
David Majnemerb4b671e2016-06-30 03:01:59 +00001150 uint64_t StorageOffsetInBits =
1151 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
Reid Kleckner06a4b2a2017-06-12 19:57:56 +00001152 uint64_t Offset = BitFieldInfo.Offset;
1153 // The bit offsets for big endian machines are reversed for big
1154 // endian target, compensate for that as the DIDerivedType requires
1155 // un-reversed offsets.
1156 if (CGM.getDataLayout().isBigEndian())
1157 Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1158 uint64_t OffsetInBits = StorageOffsetInBits + Offset;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001159 llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
David Majnemerb4b671e2016-06-30 03:01:59 +00001160 return DBuilder.createBitFieldMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001161 RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1162 Flags, DebugType);
David Majnemerb4b671e2016-06-30 03:01:59 +00001163}
1164
1165llvm::DIType *
1166CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1167 AccessSpecifier AS, uint64_t offsetInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001168 uint32_t AlignInBits, llvm::DIFile *tunit,
1169 llvm::DIScope *scope, const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001170 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001171
1172 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001173 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001174 unsigned line = getLineNumber(loc);
1175
David Majnemer34b57492014-07-30 01:30:47 +00001176 uint64_t SizeInBits = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00001177 auto Align = AlignInBits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001178 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +00001179 TypeInfo TI = CGM.getContext().getTypeInfo(type);
1180 SizeInBits = TI.Width;
Victor Leschuka7ece032016-10-20 00:13:19 +00001181 if (!Align)
1182 Align = getTypeAlignIfRequired(type, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001183 }
1184
Leny Kholodov80c047d2016-09-06 10:48:04 +00001185 llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +00001186 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
Victor Leschuka7ece032016-10-20 00:13:19 +00001187 Align, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001188}
1189
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001190void CGDebugInfo::CollectRecordLambdaFields(
1191 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001192 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001193 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1194 // has the name and the location of the variable so we should iterate over
1195 // both concurrently.
1196 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1197 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1198 unsigned fieldno = 0;
1199 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001200 E = CXXDecl->captures_end();
1201 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001202 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001203 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001204 SourceLocation Loc = C.getLocation();
1205 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001206 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001207 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001208 llvm::DIFile *VUnit = getOrCreateFile(Loc);
Victor Leschuka7ece032016-10-20 00:13:19 +00001209 auto Align = getDeclAlignIfRequired(V, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001210 llvm::DIType *FieldType = createFieldType(
1211 VName, Field->getType(), Loc, Field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001212 layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
David Majnemerb4b671e2016-06-30 03:01:59 +00001213 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001214 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001215 // TODO: Need to handle 'this' in some way by probably renaming the
1216 // this of the lambda class and having a field member of 'this' or
1217 // by using AT_object_pointer for the function and having that be
1218 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001219 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001220 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001221 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001222 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001223 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001224 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001225
1226 elements.push_back(fieldType);
1227 }
1228 }
1229}
1230
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001231llvm::DIDerivedType *
1232CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001233 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001234 // Create the descriptor for the static variable, with or without
1235 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001236 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001237 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1238 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001239
Eric Christopher91a31902013-01-16 01:22:32 +00001240 unsigned LineNumber = getLineNumber(Var->getLocation());
1241 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001242 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001243 if (Var->getInit()) {
1244 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001245 if (Value) {
1246 if (Value->isInt())
1247 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1248 if (Value->isFloat())
1249 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1250 }
Eric Christopher91a31902013-01-16 01:22:32 +00001251 }
1252
Leny Kholodov80c047d2016-09-06 10:48:04 +00001253 llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
Victor Leschuka7ece032016-10-20 00:13:19 +00001254 auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001255 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
Victor Leschuka7ece032016-10-20 00:13:19 +00001256 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001257 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001258 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001259}
1260
Eric Christophere7b87e52014-10-26 23:40:33 +00001261void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001262 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1263 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001264 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001265 StringRef name = field->getName();
1266 QualType type = field->getType();
1267
1268 // Ignore unnamed fields unless they're anonymous structs/unions.
1269 if (name.empty() && !type->isRecordType())
1270 return;
1271
David Majnemerb4b671e2016-06-30 03:01:59 +00001272 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001273 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001274 FieldType = createBitFieldType(field, RecordTy, RD);
1275 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00001276 auto Align = getDeclAlignIfRequired(field, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00001277 FieldType =
1278 createFieldType(name, type, field->getLocation(), field->getAccess(),
Victor Leschuka7ece032016-10-20 00:13:19 +00001279 OffsetInBits, Align, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001280 }
1281
David Majnemerb4b671e2016-06-30 03:01:59 +00001282 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001283}
1284
Reid Klecknere2e82062017-08-08 20:30:14 +00001285void CGDebugInfo::CollectRecordNestedType(
1286 const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1287 QualType Ty = CGM.getContext().getTypeDeclType(TD);
Reid Kleckner755220b2016-08-01 18:56:13 +00001288 // Injected class names are not considered nested records.
1289 if (isa<InjectedClassNameType>(Ty))
1290 return;
Reid Klecknere2e82062017-08-08 20:30:14 +00001291 SourceLocation Loc = TD->getLocation();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001292 llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1293 elements.push_back(nestedType);
1294}
1295
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001296void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001297 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001298 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001299 llvm::DICompositeType *RecordTy) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001300 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001301
Eric Christopher91a31902013-01-16 01:22:32 +00001302 if (CXXDecl && CXXDecl->isLambda())
1303 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1304 else {
1305 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001306
Reid Klecknere2e82062017-08-08 20:30:14 +00001307 // Debug info for nested types is included in the member list only for
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001308 // CodeView.
Reid Klecknere2e82062017-08-08 20:30:14 +00001309 bool IncludeNestedTypes = CGM.getCodeGenOpts().EmitCodeView;
Adrian McCarthyab1e7862016-07-21 18:43:20 +00001310
Eric Christopher91a31902013-01-16 01:22:32 +00001311 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001312 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001313
Eric Christopher91a31902013-01-16 01:22:32 +00001314 // Static and non-static members should appear in the same order as
1315 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001316 for (const auto *I : record->decls())
1317 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001318 if (V->hasAttr<NoDebugAttr>())
1319 continue;
David Blaikiece763042013-08-20 21:49:21 +00001320 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001321 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001322 if (MI != StaticDataMemberCache.end()) {
1323 assert(MI->second &&
1324 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001325 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001326 } else {
1327 auto Field = CreateRecordStaticField(V, RecordTy, record);
1328 elements.push_back(Field);
1329 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001330 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001331 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1332 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001333
1334 // Bump field number for next field.
1335 ++fieldNo;
Reid Klecknere2e82062017-08-08 20:30:14 +00001336 } else if (IncludeNestedTypes) {
1337 if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1338 if (!nestedType->isImplicit() &&
1339 nestedType->getDeclContext() == record)
1340 CollectRecordNestedType(nestedType, elements);
1341 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001342 }
1343}
1344
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001345llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001346CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001347 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001348 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001349 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001350 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001351 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001352 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1353 Func, Unit);
1354}
David Blaikie2aaf0652013-01-07 22:24:59 +00001355
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001356llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1357 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001358 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001359 llvm::DITypeRefArray Args(
1360 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001361 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001362 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001363
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001364 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001365
1366 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001367 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001368
David Blaikie2aaf0652013-01-07 22:24:59 +00001369 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001370 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001371 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1372 // Create pointer type directly in this case.
1373 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1374 QualType PointeeTy = ThisPtrTy->getPointeeType();
1375 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001376 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Victor Leschuka7ece032016-10-20 00:13:19 +00001377 auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001378 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1379 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001380 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001381 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001382 // TODO: This and the artificial type below are misleading, the
1383 // types aren't artificial the argument is, but the current
1384 // metadata doesn't represent that.
1385 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1386 Elts.push_back(ThisPtrType);
1387 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001388 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001389 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001390 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1391 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001392 }
1393
1394 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001395 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1396 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001397
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001398 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001399
Leny Kholodov80c047d2016-09-06 10:48:04 +00001400 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001401 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001402 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001403 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001404 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001405
Reid Klecknerf00f8032016-06-08 20:41:54 +00001406 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1407 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001408}
1409
Eric Christopherb2a008c2013-05-16 00:45:12 +00001410/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001411/// inside a function.
1412static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001413 if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001414 return isFunctionLocalClass(NRD);
1415 if (isa<FunctionDecl>(RD->getDeclContext()))
1416 return true;
1417 return false;
1418}
1419
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001420llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1421 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001422 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001423 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001424
Guy Benyei11169dd2012-12-18 14:30:41 +00001425 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001426 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001427
1428 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1429 // make sense to give a single ctor/dtor a linkage name.
1430 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001431 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1432 // property to use here. It may've been intended to model "is non-external
1433 // type" but misses cases of non-function-local but non-external classes such
1434 // as those in anonymous namespaces as well as the reverse - external types
1435 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001436 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1437 MethodLinkageName = CGM.getMangledName(Method);
1438
1439 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001440 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001441 unsigned MethodLine = 0;
1442 if (!Method->isImplicit()) {
1443 MethodDefUnit = getOrCreateFile(Method->getLocation());
1444 MethodLine = getLineNumber(Method->getLocation());
1445 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001446
1447 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001448 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001449 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001450 unsigned VIndex = 0;
Leny Kholodov80c047d2016-09-06 10:48:04 +00001451 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001452 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001453
Guy Benyei11169dd2012-12-18 14:30:41 +00001454 if (Method->isVirtual()) {
1455 if (Method->isPure())
1456 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1457 else
1458 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001459
Reid Kleckner216d0a12016-06-16 20:08:51 +00001460 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1461 // It doesn't make sense to give a virtual destructor a vtable index,
1462 // since a single destructor has two entries in the vtable.
1463 if (!isa<CXXDestructorDecl>(Method))
1464 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1465 } else {
1466 // Emit MS ABI vftable information. There is only one entry for the
1467 // deleting dtor.
1468 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1469 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
Reid Klecknercbec0262018-04-02 20:00:39 +00001470 MethodVFTableLocation ML =
Reid Kleckner216d0a12016-06-16 20:08:51 +00001471 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1472 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001473
1474 // CodeView only records the vftable offset in the class that introduces
1475 // the virtual method. This is possible because, unlike Itanium, the MS
1476 // C++ ABI does not include all virtual methods from non-primary bases in
1477 // the vtable for the most derived class. For example, if C inherits from
1478 // A and B, C's primary vftable will not include B's virtual methods.
Benjamin Krameracfa3392017-12-17 23:52:45 +00001479 if (Method->size_overridden_methods() == 0)
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001480 Flags |= llvm::DINode::FlagIntroducedVirtual;
1481
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001482 // The 'this' adjustment accounts for both the virtual and non-virtual
1483 // portions of the adjustment. Presumably the debugger only uses it when
1484 // it knows the dynamic type of an object.
1485 ThisAdjustment = CGM.getCXXABI()
1486 .getVirtualFunctionPrologueThisAdjustment(GD)
1487 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001488 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001489 ContainingType = RecordTy;
1490 }
1491
Adrian McCarthyd91bf392017-09-13 20:53:55 +00001492 if (Method->isStatic())
1493 Flags |= llvm::DINode::FlagStaticMember;
Guy Benyei11169dd2012-12-18 14:30:41 +00001494 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001495 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001496 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
David Majnemer58ed0f32016-07-17 00:39:12 +00001497 if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001498 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001499 Flags |= llvm::DINode::FlagExplicit;
David Majnemer58ed0f32016-07-17 00:39:12 +00001500 } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001501 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001502 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001503 }
1504 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001505 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001506 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001507 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001508 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001509 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001510
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001511 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1512 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001513 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001514 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1515 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1516 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001517
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001518 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001519
1520 return SP;
1521}
1522
Eric Christophere7b87e52014-10-26 23:40:33 +00001523void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001524 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1525 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001526
1527 // Since we want more than just the individual member decls if we
1528 // have templated functions iterate over every declaration to gather
1529 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001530 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001531 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1532 // If the member is implicit, don't add it to the member list. This avoids
1533 // the member being added to type units by LLVM, while still allowing it
1534 // to be emitted into the type declaration/reference inside the compile
1535 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001536 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001537 // FIXME: Handle Using(Shadow?)Decls here to create
1538 // DW_TAG_imported_declarations inside the class for base decls brought into
1539 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1540 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1541 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001542 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001543 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001544
1545 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1546 continue;
1547
David Blaikiefd580722014-10-06 05:18:55 +00001548 // Reuse the existing member function declaration if it exists.
1549 // It may be associated with the declaration of the type & should be
1550 // reused as we're building the definition.
1551 //
1552 // This situation can arise in the vtable-based debug info reduction where
1553 // implicit members are emitted in a non-vtable TU.
1554 auto MI = SPCache.find(Method->getCanonicalDecl());
1555 EltTys.push_back(MI == SPCache.end()
1556 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001557 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001558 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001559}
Guy Benyei11169dd2012-12-18 14:30:41 +00001560
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001561void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001562 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001563 llvm::DIType *RecordTy) {
Bob Haarmandff36732016-10-25 22:19:32 +00001564 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> SeenTypes;
1565 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1566 llvm::DINode::FlagZero);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001567
Bob Haarmandff36732016-10-25 22:19:32 +00001568 // If we are generating CodeView debug info, we also need to emit records for
1569 // indirect virtual base classes.
1570 if (CGM.getCodeGenOpts().EmitCodeView) {
1571 CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1572 llvm::DINode::FlagIndirectVirtualBase);
1573 }
1574}
1575
1576void CGDebugInfo::CollectCXXBasesAux(
1577 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1578 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1579 const CXXRecordDecl::base_class_const_range &Bases,
1580 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
1581 llvm::DINode::DIFlags StartingFlags) {
1582 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1583 for (const auto &BI : Bases) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001584 const auto *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001585 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Bob Haarmandff36732016-10-25 22:19:32 +00001586 if (!SeenTypes.insert(Base).second)
1587 continue;
1588 auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1589 llvm::DINode::DIFlags BFlags = StartingFlags;
1590 uint64_t BaseOffset;
Brock Wyma3db2b102018-05-14 21:21:22 +00001591 uint32_t VBPtrOffset = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001592
Aaron Ballman574705e2014-03-13 15:41:46 +00001593 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001594 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1595 // virtual base offset offset is -ve. The code generator emits dwarf
1596 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001597 BaseOffset = 0 - CGM.getItaniumVTableContext()
1598 .getVirtualBaseOffsetOffset(RD, Base)
1599 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001600 } else {
1601 // In the MS ABI, store the vbtable offset, which is analogous to the
1602 // vbase offset offset in Itanium.
1603 BaseOffset =
1604 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
Brock Wyma3db2b102018-05-14 21:21:22 +00001605 VBPtrOffset = CGM.getContext().getASTRecordLayout(RD).getVBPtrOffset()
1606 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001607 }
Bob Haarmandff36732016-10-25 22:19:32 +00001608 BFlags |= llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001609 } else
1610 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1611 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1612 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001613
Adrian Prantl21361fb2014-08-29 22:44:27 +00001614 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Bob Haarmandff36732016-10-25 22:19:32 +00001615 llvm::DIType *DTy =
Brock Wyma3db2b102018-05-14 21:21:22 +00001616 DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset, VBPtrOffset,
1617 BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001618 EltTys.push_back(DTy);
1619 }
1620}
1621
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001622llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001623CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1624 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001625 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001626 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001627 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1628 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001629 StringRef Name;
1630 if (TPList)
1631 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001632 switch (TA.getKind()) {
1633 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001634 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001635 TemplateParams.push_back(
1636 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001637 } break;
1638 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001639 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001640 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1641 TheCU, Name, TTy,
1642 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001643 } break;
1644 case TemplateArgument::Declaration: {
1645 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001646 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001647 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001648 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001649 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001650 // Variable pointer template parameters have a value that is the address
1651 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001652 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001653 V = CGM.GetAddrOfGlobalVar(VD);
1654 // Member function pointers have special support for building them, though
1655 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001656 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001657 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001658 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001659 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001660 // Member data pointers have special handling too to compute the fixed
1661 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001662 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001663 // These five lines (& possibly the above member function pointer
1664 // handling) might be able to be refactored to use similar code in
1665 // CodeGenModule::getMemberPointerConstant
1666 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1667 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001668 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001669 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001670 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001671 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1672 TheCU, Name, TTy,
1673 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001674 } break;
1675 case TemplateArgument::NullPtr: {
1676 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001677 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001678 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001679 // Special case member data pointer null values since they're actually -1
1680 // instead of zero.
David Majnemer58ed0f32016-07-17 00:39:12 +00001681 if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
David Blaikie38079fd2013-05-10 21:53:14 +00001682 // But treat member function pointers as simple zero integers because
1683 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1684 // CodeGen grows handling for values of non-null member function
1685 // pointers then perhaps we could remove this special case and rely on
1686 // EmitNullMemberPointer for member function pointers.
1687 if (MPT->isMemberDataPointer())
1688 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1689 if (!V)
1690 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001691 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001692 TheCU, Name, TTy, V));
David Blaikie38079fd2013-05-10 21:53:14 +00001693 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001694 case TemplateArgument::Template:
1695 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001696 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001697 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1698 break;
1699 case TemplateArgument::Pack:
1700 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1701 TheCU, Name, nullptr,
1702 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1703 break;
David Majnemer5559d472013-08-24 08:21:10 +00001704 case TemplateArgument::Expression: {
1705 const Expr *E = TA.getAsExpr();
1706 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001707 if (E->isGLValue())
1708 T = CGM.getContext().getLValueReferenceType(T);
John McCallde0fe072017-08-15 21:42:52 +00001709 llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001710 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001711 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001712 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
David Majnemer58ed0f32016-07-17 00:39:12 +00001713 TheCU, Name, TTy, V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001714 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001715 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001716 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001717 case TemplateArgument::Null:
1718 llvm_unreachable(
1719 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001720 }
1721 }
1722 return DBuilder.getOrCreateArray(TemplateParams);
1723}
1724
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001725llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001726CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001727 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001728 if (FD->getTemplatedKind() ==
1729 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001730 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1731 ->getTemplate()
1732 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001733 return CollectTemplateParams(
1734 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001735 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001736 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001737}
1738
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001739llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1740 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001741 // Always get the full list of parameters, not just the ones from
1742 // the specialization.
1743 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001744 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001745 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001746 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001747}
1748
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001749llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001750 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001751 return VTablePtrType;
1752
1753 ASTContext &Context = CGM.getContext();
1754
1755 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001756 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001757 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001758 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001759 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001760 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1761 Optional<unsigned> DWARFAddressSpace =
1762 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1763
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001764 llvm::DIType *vtbl_ptr_type =
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001765 DBuilder.createPointerType(SubTy, Size, 0, DWARFAddressSpace,
1766 "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001767 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1768 return VTablePtrType;
1769}
1770
Guy Benyei11169dd2012-12-18 14:30:41 +00001771StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001772 // Copy the gdb compatible name on the side and use its reference.
1773 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001774}
1775
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001776void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Reid Klecknerdc124992016-08-31 16:11:43 +00001777 SmallVectorImpl<llvm::Metadata *> &EltTys,
1778 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001779 // If this class is not dynamic then there is not any vtable info to collect.
1780 if (!RD->isDynamicClass())
1781 return;
1782
Reid Kleckner59812422016-08-31 20:35:01 +00001783 // Don't emit any vtable shape or vptr info if this class doesn't have an
1784 // extendable vfptr. This can happen if the class doesn't have virtual
1785 // methods, or in the MS ABI if those virtual methods only come from virtually
1786 // inherited bases.
1787 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1788 if (!RL.hasExtendableVFPtr())
1789 return;
1790
Reid Klecknerdc124992016-08-31 16:11:43 +00001791 // CodeView needs to know how large the vtable of every dynamic class is, so
1792 // emit a special named pointer type into the element list. The vptr type
1793 // points to this type as well.
1794 llvm::DIType *VPtrTy = nullptr;
1795 bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1796 CGM.getTarget().getCXXABI().isMicrosoft();
1797 if (NeedVTableShape) {
1798 uint64_t PtrWidth =
1799 CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1800 const VTableLayout &VFTLayout =
1801 CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1802 unsigned VSlotCount =
Peter Collingbournee53683f2016-09-08 01:14:39 +00001803 VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
Reid Klecknerdc124992016-08-31 16:11:43 +00001804 unsigned VTableWidth = PtrWidth * VSlotCount;
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001805 unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1806 Optional<unsigned> DWARFAddressSpace =
1807 CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
Reid Klecknerdc124992016-08-31 16:11:43 +00001808
1809 // Create a very wide void* type and insert it directly in the element list.
1810 llvm::DIType *VTableType =
Konstantin Zhuravlyovd1ba16e2017-03-08 23:56:48 +00001811 DBuilder.createPointerType(nullptr, VTableWidth, 0, DWARFAddressSpace,
1812 "__vtbl_ptr_type");
Reid Klecknerdc124992016-08-31 16:11:43 +00001813 EltTys.push_back(VTableType);
1814
1815 // The vptr is a pointer to this special vtable type.
1816 VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1817 }
1818
1819 // If there is a primary base then the artificial vptr member lives there.
Reid Klecknerdc124992016-08-31 16:11:43 +00001820 if (RL.getPrimaryBase())
1821 return;
1822
1823 if (!VPtrTy)
1824 VPtrTy = getOrCreateVTablePtrType(Unit);
1825
Guy Benyei11169dd2012-12-18 14:30:41 +00001826 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Reid Klecknerdc124992016-08-31 16:11:43 +00001827 llvm::DIType *VPtrMember = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001828 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Reid Klecknerdc124992016-08-31 16:11:43 +00001829 llvm::DINode::FlagArtificial, VPtrTy);
1830 EltTys.push_back(VPtrMember);
Guy Benyei11169dd2012-12-18 14:30:41 +00001831}
1832
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001833llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001834 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001835 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001836 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001837 return T;
1838}
1839
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001840llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001841 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001842 return getOrCreateStandaloneType(D, Loc);
1843}
1844
1845llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1846 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001847 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001848 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001849 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001850 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001851
Adrian Prantl73409ce2013-03-11 18:33:46 +00001852 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001853 return T;
1854}
1855
David Blaikie483a9da2014-05-06 18:35:21 +00001856void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001857 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001858 return;
1859 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001860 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001861 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001862 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001863 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001864 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001865 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001866 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001867}
1868
David Blaikieb2e86eb2013-08-15 20:49:17 +00001869void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001870 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001871 !CGM.getLangOpts().CPlusPlus)
1872 completeRequiredType(RD);
1873}
1874
David Blaikieb11c8732017-01-30 06:36:08 +00001875/// Return true if the class or any of its methods are marked dllimport.
1876static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1877 if (RD->hasAttr<DLLImportAttr>())
1878 return true;
1879 for (const CXXMethodDecl *MD : RD->methods())
1880 if (MD->hasAttr<DLLImportAttr>())
1881 return true;
1882 return false;
1883}
1884
Adrian Prantla43acdc2017-07-24 23:48:51 +00001885/// Does a type definition exist in an imported clang module?
1886static bool isDefinedInClangModule(const RecordDecl *RD) {
1887 // Only definitions that where imported from an AST file come from a module.
1888 if (!RD || !RD->isFromASTFile())
1889 return false;
1890 // Anonymous entities cannot be addressed. Treat them as not from module.
1891 if (!RD->isExternallyVisible() && RD->getName().empty())
1892 return false;
1893 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1894 if (!CXXDecl->isCompleteDefinition())
1895 return false;
1896 auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
1897 if (TemplateKind != TSK_Undeclared) {
1898 // This is a template, check the origin of the first member.
1899 if (CXXDecl->field_begin() == CXXDecl->field_end())
1900 return TemplateKind == TSK_ExplicitInstantiationDeclaration;
1901 if (!CXXDecl->field_begin()->isFromASTFile())
1902 return false;
1903 }
1904 }
1905 return true;
1906}
1907
David Blaikie6943dea2013-08-20 01:28:15 +00001908void CGDebugInfo::completeClassData(const RecordDecl *RD) {
David Blaikieb11c8732017-01-30 06:36:08 +00001909 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1910 if (CXXRD->isDynamicClass() &&
1911 CGM.getVTableLinkage(CXXRD) ==
1912 llvm::GlobalValue::AvailableExternallyLinkage &&
1913 !isClassOrMethodDLLImport(CXXRD))
1914 return;
Adrian Prantla43acdc2017-07-24 23:48:51 +00001915
1916 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
1917 return;
1918
David Blaikieb11c8732017-01-30 06:36:08 +00001919 completeClass(RD);
1920}
1921
1922void CGDebugInfo::completeClass(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001923 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001924 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001925 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001926 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001927 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001928 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001929 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001930 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001931 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001932 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001933}
1934
David Blaikie0e716b42014-03-03 23:48:23 +00001935static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1936 CXXRecordDecl::method_iterator End) {
David Majnemer58ed0f32016-07-17 00:39:12 +00001937 for (CXXMethodDecl *MD : llvm::make_range(I, End))
1938 if (FunctionDecl *Tmpl = MD->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001939 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
David Majnemer58ed0f32016-07-17 00:39:12 +00001940 !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001941 return true;
1942 return false;
1943}
1944
Benjamin Kramer8c305922016-02-02 11:06:51 +00001945static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1946 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001947 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001948 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001949 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001950
David Blaikie1ac9c982017-04-11 21:13:37 +00001951 if (auto *ES = RD->getASTContext().getExternalSource())
1952 if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
1953 return true;
1954
Benjamin Kramer8c305922016-02-02 11:06:51 +00001955 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001956 return false;
1957
1958 if (!LangOpts.CPlusPlus)
1959 return false;
1960
1961 if (!RD->isCompleteDefinitionRequired())
1962 return true;
1963
David Majnemer58ed0f32016-07-17 00:39:12 +00001964 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie0e716b42014-03-03 23:48:23 +00001965
1966 if (!CXXDecl)
1967 return false;
1968
Adrian McCarthy99242982016-08-16 22:11:18 +00001969 // Only emit complete debug info for a dynamic class when its vtable is
1970 // emitted. However, Microsoft debuggers don't resolve type information
Reid Klecknerc9404e12016-09-09 16:27:04 +00001971 // across DLL boundaries, so skip this optimization if the class or any of its
1972 // methods are marked dllimport. This isn't a complete solution, since objects
1973 // without any dllimport methods can be used in one DLL and constructed in
1974 // another, but it is the current behavior of LimitedDebugInfo.
Adrian McCarthy99242982016-08-16 22:11:18 +00001975 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
Reid Klecknerc9404e12016-09-09 16:27:04 +00001976 !isClassOrMethodDLLImport(CXXDecl))
David Blaikie0e716b42014-03-03 23:48:23 +00001977 return true;
1978
1979 TemplateSpecializationKind Spec = TSK_Undeclared;
David Majnemer58ed0f32016-07-17 00:39:12 +00001980 if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
David Blaikie0e716b42014-03-03 23:48:23 +00001981 Spec = SD->getSpecializationKind();
1982
1983 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1984 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1985 CXXDecl->method_end()))
1986 return true;
1987
1988 return false;
1989}
1990
Reid Kleckner6c7b1c62016-09-13 00:01:23 +00001991void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
1992 if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
1993 return;
1994
1995 QualType Ty = CGM.getContext().getRecordType(RD);
1996 llvm::DIType *T = getTypeOrNull(Ty);
1997 if (T && T->isForwardDecl())
1998 completeClassData(RD);
1999}
2000
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002001llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002002 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002003 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002004 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2005 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002006 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002007 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00002008 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00002009 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002010
David Blaikieb2e86eb2013-08-15 20:49:17 +00002011 return CreateTypeDefinition(Ty);
2012}
2013
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002014llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00002015 RecordDecl *RD = Ty->getDecl();
2016
Guy Benyei11169dd2012-12-18 14:30:41 +00002017 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002018 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002019
2020 // Records and classes and unions can all be recursive. To handle them, we
2021 // first generate a debug descriptor for the struct as a forward declaration.
2022 // Then (if it is a definition) we go through and get debug info for all of
2023 // its members. Finally, we create a descriptor for the complete type (which
2024 // may refer to the forward decl if the struct is recursive) and replace all
2025 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002026 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002027
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002028 const RecordDecl *D = RD->getDefinition();
2029 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002030 return FwdDecl;
2031
David Majnemer58ed0f32016-07-17 00:39:12 +00002032 if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
David Blaikieadfbf992013-08-18 16:55:33 +00002033 CollectContainingType(CXXDecl, FwdDecl);
2034
Guy Benyei11169dd2012-12-18 14:30:41 +00002035 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002036 LexicalBlockStack.emplace_back(&*FwdDecl);
2037 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002038
Guy Benyei11169dd2012-12-18 14:30:41 +00002039 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002040 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00002041 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00002042
2043 // Note: The split of CXXDecl information here is intentional, the
2044 // gdb tests will depend on a certain ordering at printout. The debug
2045 // information offsets are still correct if we merge them all together
2046 // though.
David Majnemer58ed0f32016-07-17 00:39:12 +00002047 const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002048 if (CXXDecl) {
2049 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
Reid Klecknerdc124992016-08-31 16:11:43 +00002050 CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002051 }
2052
Eric Christopher91a31902013-01-16 01:22:32 +00002053 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00002054 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00002055 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00002056 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002057
2058 LexicalBlockStack.pop_back();
2059 RegionMap.erase(Ty->getDecl());
2060
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002061 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002062 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002063
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002064 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002065 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002066 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002067
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002068 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002069 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002070}
2071
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002072llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2073 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002074 // Ignore protocols.
2075 return getOrCreateType(Ty->getBaseType(), Unit);
2076}
2077
Manman Rene6be26c2016-09-13 17:25:08 +00002078llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2079 llvm::DIFile *Unit) {
2080 // Ignore protocols.
2081 SourceLocation Loc = Ty->getDecl()->getLocation();
2082
2083 // Use Typedefs to represent ObjCTypeParamType.
2084 return DBuilder.createTypedef(
2085 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2086 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2087 getDeclContextDescriptor(Ty->getDecl()));
2088}
2089
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002090/// \return true if Getter has the default name for the property PD.
2091static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
2092 const ObjCMethodDecl *Getter) {
2093 assert(PD);
2094 if (!Getter)
2095 return true;
2096
2097 assert(Getter->getDeclName().isObjCZeroArgSelector());
2098 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002099 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002100}
2101
2102/// \return true if Setter has the default name for the property PD.
2103static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
2104 const ObjCMethodDecl *Setter) {
2105 assert(PD);
2106 if (!Setter)
2107 return true;
2108
2109 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00002110 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00002111 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00002112}
2113
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002114llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2115 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002116 ObjCInterfaceDecl *ID = Ty->getDecl();
2117 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002118 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002119
Adrian Prantl50fd1a82016-04-20 23:59:32 +00002120 // Return a forward declaration if this type was imported from a clang module,
2121 // and this is not the compile unit with the implementation of the type (which
2122 // may contain hidden ivars).
2123 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2124 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002125 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2126 ID->getName(),
2127 getDeclContextDescriptor(ID), Unit, 0);
2128
Guy Benyei11169dd2012-12-18 14:30:41 +00002129 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002130 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002131 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002132 auto RuntimeLang =
2133 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00002134
2135 // If this is just a forward declaration return a special forward-declaration
2136 // debug type since we won't be able to lay out the entire type.
2137 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00002138 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002139 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002140 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00002141 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2142 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00002143 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002144 return FwdDecl;
2145 }
2146
David Blaikieef8a9512014-05-05 23:23:53 +00002147 return CreateTypeDefinition(Ty, Unit);
2148}
2149
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002150llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00002151CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2152 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00002153 // Use the Module pointer as the key into the cache. This is a
2154 // nullptr if the "Module" is a PCH, which is safe because we don't
2155 // support chained PCH debug info, so there can only be a single PCH.
2156 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002157 auto ModRef = ModuleCache.find(M);
2158 if (ModRef != ModuleCache.end())
2159 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00002160
2161 // Macro definitions that were defined with "-D" on the command line.
2162 SmallString<128> ConfigMacros;
2163 {
2164 llvm::raw_svector_ostream OS(ConfigMacros);
2165 const auto &PPOpts = CGM.getPreprocessorOpts();
2166 unsigned I = 0;
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002167 // Translate the macro definitions back into a command line.
Adrian Prantl2388ead2015-06-30 18:01:05 +00002168 for (auto &M : PPOpts.Macros) {
2169 if (++I > 1)
2170 OS << " ";
2171 const std::string &Macro = M.first;
2172 bool Undef = M.second;
2173 OS << "\"-" << (Undef ? 'U' : 'D');
2174 for (char c : Macro)
2175 switch (c) {
2176 case '\\' : OS << "\\\\"; break;
2177 case '"' : OS << "\\\""; break;
2178 default: OS << c;
2179 }
2180 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002181 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002182 }
Adrian Prantl66689202015-09-18 23:01:45 +00002183
Adrian Prantl835e6632015-09-24 16:10:10 +00002184 bool IsRootModule = M ? !M->Parent : true;
2185 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00002186 // PCH files don't have a signature field in the control block,
2187 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00002188 // We use the lower 64 bits for debug info.
2189 uint64_t Signature =
2190 Mod.getSignature()
2191 ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2192 : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00002193 llvm::DIBuilder DIB(CGM.getModule());
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002194 DIB.createCompileUnit(TheCU->getSourceLanguage(),
Scott Lindera2fbcef2018-02-26 17:32:31 +00002195 // TODO: Support "Source" from external AST providers?
Amjad Aboudfa9a17e2016-12-14 20:24:40 +00002196 DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2197 TheCU->getProducer(), true, StringRef(), 0,
2198 Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2199 Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00002200 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00002201 }
Adrian Prantl835e6632015-09-24 16:10:10 +00002202 llvm::DIModule *Parent =
2203 IsRootModule ? nullptr
2204 : getOrCreateModuleRef(
2205 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
2206 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00002207 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00002208 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2209 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00002210 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00002211 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00002212}
2213
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002214llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2215 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00002216 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002217 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00002218 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00002219 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00002220
2221 // Bit size, align and offset of the type.
2222 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002223 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002224
Leny Kholodov80c047d2016-09-06 10:48:04 +00002225 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002226 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002227 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00002228
Adrian Prantlfd696112015-10-01 00:48:51 +00002229 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002230 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00002231 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2232 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00002233
David Blaikieef8a9512014-05-05 23:23:53 +00002234 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002235 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002236
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002237 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002238 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002239 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002240
2241 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002242 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002243
2244 ObjCInterfaceDecl *SClass = ID->getSuperClass();
2245 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002246 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00002247 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002248 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002249 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002250
Brock Wyma3db2b102018-05-14 21:21:22 +00002251 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002252 llvm::DINode::FlagZero);
Guy Benyei11169dd2012-12-18 14:30:41 +00002253 EltTys.push_back(InhTag);
2254 }
2255
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002256 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00002257 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002258 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002259 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002260 unsigned PLine = getLineNumber(Loc);
2261 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2262 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002263 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2264 PD->getName(), PUnit, PLine,
2265 hasDefaultGetterName(PD, Getter) ? ""
2266 : getSelectorName(PD->getGetterName()),
2267 hasDefaultSetterName(PD, Setter) ? ""
2268 : getSelectorName(PD->getSetterName()),
2269 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002270 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00002271 };
2272 {
2273 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00002274 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00002275 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00002276 PropertySet.insert(PD->getIdentifier());
2277 AddProperty(PD);
2278 }
Manman Renefe1bac2016-01-27 20:00:32 +00002279 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00002280 // Don't emit duplicate metadata for properties that were already in a
2281 // class extension.
2282 if (!PropertySet.insert(PD->getIdentifier()).second)
2283 continue;
2284 AddProperty(PD);
2285 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002286 }
2287
2288 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2289 unsigned FieldNo = 0;
2290 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2291 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002292 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00002293 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002294 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002295
Guy Benyei11169dd2012-12-18 14:30:41 +00002296 StringRef FieldName = Field->getName();
2297
2298 // Ignore unnamed fields.
2299 if (FieldName.empty())
2300 continue;
2301
2302 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002303 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002304 unsigned FieldLine = getLineNumber(Field->getLocation());
2305 QualType FType = Field->getType();
2306 uint64_t FieldSize = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002307 uint32_t FieldAlign = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002308
2309 if (!FType->isIncompleteArrayType()) {
2310
2311 // Bit size, align and offset of the type.
2312 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00002313 ? Field->getBitWidthValue(CGM.getContext())
2314 : CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002315 FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002316 }
2317
2318 uint64_t FieldOffset;
2319 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2320 // We don't know the runtime offset of an ivar if we're using the
2321 // non-fragile ABI. For bitfields, use the bit offset into the first
2322 // byte of storage of the bitfield. For other fields, use zero.
2323 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002324 FieldOffset =
2325 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002326 FieldOffset %= CGM.getContext().getCharWidth();
2327 } else {
2328 FieldOffset = 0;
2329 }
2330 } else {
2331 FieldOffset = RL.getFieldOffset(FieldNo);
2332 }
2333
Leny Kholodov80c047d2016-09-06 10:48:04 +00002334 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00002335 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002336 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002337 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002338 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002339 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002340 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002341
Craig Topper8a13c412014-05-21 05:09:00 +00002342 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002343 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002344 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002345 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002346 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002347 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002348 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002349 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002350 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2351 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002352 PropertyNode = DBuilder.createObjCProperty(
2353 PD->getName(), PUnit, PLine,
2354 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2355 PD->getGetterName()),
2356 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2357 PD->getSetterName()),
2358 PD->getPropertyAttributes(),
2359 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002360 }
2361 }
2362 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002363 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2364 FieldSize, FieldAlign, FieldOffset, Flags,
2365 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002366 EltTys.push_back(FieldTy);
2367 }
2368
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002369 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002370 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002371
Guy Benyei11169dd2012-12-18 14:30:41 +00002372 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002373 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002374}
2375
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002376llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2377 llvm::DIFile *Unit) {
2378 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002379 int64_t Count = Ty->getNumElements();
Guy Benyei11169dd2012-12-18 14:30:41 +00002380
Sander de Smalen891af03a2018-02-03 13:55:59 +00002381 llvm::Metadata *Subscript;
2382 QualType QTy(Ty, 0);
2383 auto SizeExpr = SizeExprCache.find(QTy);
2384 if (SizeExpr != SizeExprCache.end())
2385 Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2386 else
2387 Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002388 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002389
2390 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002391 auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002392
2393 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2394}
2395
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002396llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002397 uint64_t Size;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002398 uint32_t Align;
Guy Benyei11169dd2012-12-18 14:30:41 +00002399
2400 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
David Majnemer58ed0f32016-07-17 00:39:12 +00002401 if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 Size = 0;
Victor Leschuka7ece032016-10-20 00:13:19 +00002403 Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2404 CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002405 } else if (Ty->isIncompleteArrayType()) {
2406 Size = 0;
2407 if (Ty->getElementType()->isIncompleteType())
2408 Align = 0;
2409 else
Victor Leschuka7ece032016-10-20 00:13:19 +00002410 Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
David Blaikief03b2e82013-05-09 20:48:12 +00002411 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002412 Size = 0;
2413 Align = 0;
2414 } else {
2415 // Size and align of the whole array, not the element type.
2416 Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002417 Align = getTypeAlignIfRequired(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002418 }
2419
2420 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2421 // interior arrays, do we care? Why aren't nested arrays represented the
2422 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002423 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002424 QualType EltTy(Ty, 0);
2425 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2426 // If the number of elements is known, then count is that number. Otherwise,
2427 // it's -1. This allows us to represent a subrange with an array of 0
2428 // elements, like this:
2429 //
2430 // struct foo {
2431 // int x[0];
2432 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002433 int64_t Count = -1; // Count == -1 is an unbounded array.
David Majnemer58ed0f32016-07-17 00:39:12 +00002434 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002435 Count = CAT->getSize().getZExtValue();
David Blaikie87173f12016-08-22 17:49:56 +00002436 else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
Eli Friedman01d6b962016-10-19 22:16:32 +00002437 if (Expr *Size = VAT->getSizeExpr()) {
2438 llvm::APSInt V;
2439 if (Size->EvaluateAsInt(V, CGM.getContext()))
2440 Count = V.getExtValue();
2441 }
David Blaikie87173f12016-08-22 17:49:56 +00002442 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002443
Sander de Smalen891af03a2018-02-03 13:55:59 +00002444 auto SizeNode = SizeExprCache.find(EltTy);
2445 if (SizeNode != SizeExprCache.end())
2446 Subscripts.push_back(
2447 DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2448 else
2449 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
Guy Benyei11169dd2012-12-18 14:30:41 +00002450 EltTy = Ty->getElementType();
2451 }
2452
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002453 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002454
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002455 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2456 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002457}
2458
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002459llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2460 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002461 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2462 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002463}
2464
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002465llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2466 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002467 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2468 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002469}
2470
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002471llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2472 llvm::DIFile *U) {
Leny Kholodov80c047d2016-09-06 10:48:04 +00002473 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Reid Klecknerfb727182016-06-17 22:27:59 +00002474 uint64_t Size = 0;
2475
2476 if (!Ty->isIncompleteType()) {
2477 Size = CGM.getContext().getTypeSize(Ty);
2478
2479 // Set the MS inheritance model. There is no flag for the unspecified model.
2480 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2481 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2482 case MSInheritanceAttr::Keyword_single_inheritance:
2483 Flags |= llvm::DINode::FlagSingleInheritance;
2484 break;
2485 case MSInheritanceAttr::Keyword_multiple_inheritance:
2486 Flags |= llvm::DINode::FlagMultipleInheritance;
2487 break;
2488 case MSInheritanceAttr::Keyword_virtual_inheritance:
2489 Flags |= llvm::DINode::FlagVirtualInheritance;
2490 break;
2491 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2492 break;
2493 }
2494 }
2495 }
2496
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002497 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002498 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002499 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002500 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2501 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002502
2503 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002504 Ty->getPointeeType()->getAs<FunctionProtoType>();
2505 return DBuilder.createMemberPointerType(
2506 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2507 Ty->getClass(), FPT->getTypeQuals())),
2508 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002509 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002510}
2511
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002512llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Victor Leschuk0df190372016-10-31 19:09:47 +00002513 auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2514 return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002515}
2516
Xiuli Pan9c14e282016-01-09 12:53:17 +00002517llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2518 llvm::DIFile *U) {
2519 return getOrCreateType(Ty->getElementType(), U);
2520}
2521
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002522llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002523 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002524
Guy Benyei11169dd2012-12-18 14:30:41 +00002525 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002526 uint32_t Align = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00002527 if (!ED->getTypeForDecl()->isIncompleteType()) {
2528 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002529 Align = getDeclAlignIfRequired(ED, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002530 }
2531
Brock Wyma8557ec52018-05-22 12:41:19 +00002532 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002533
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002534 bool isImportedFromModule =
2535 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2536
Guy Benyei11169dd2012-12-18 14:30:41 +00002537 // If this is just a forward declaration, construct an appropriately
2538 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002539 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002540 // Note that it is possible for enums to be created as part of
2541 // their own declcontext. In this case a FwdDecl will be created
2542 // twice. This doesn't cause a problem because both FwdDecls are
2543 // entered into the ReplaceMap: finalize() will replace the first
2544 // FwdDecl with the second and then replace the second with
2545 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002546 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002547 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002548 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2549 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002550
Guy Benyei11169dd2012-12-18 14:30:41 +00002551 unsigned Line = getLineNumber(ED->getLocation());
2552 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002553 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002554 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
Brock Wyma8557ec52018-05-22 12:41:19 +00002555 0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
Adrian Prantla40030f2016-02-06 01:59:09 +00002556
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002557 ReplaceMap.emplace_back(
2558 std::piecewise_construct, std::make_tuple(Ty),
2559 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002560 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002561 }
2562
David Blaikie483a9da2014-05-06 18:35:21 +00002563 return CreateTypeDefinition(Ty);
2564}
2565
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002566llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002567 const EnumDecl *ED = Ty->getDecl();
2568 uint64_t Size = 0;
Victor Leschuk802e4a52016-10-19 22:11:07 +00002569 uint32_t Align = 0;
David Blaikie483a9da2014-05-06 18:35:21 +00002570 if (!ED->getTypeForDecl()->isIncompleteType()) {
2571 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
Victor Leschuka7ece032016-10-20 00:13:19 +00002572 Align = getDeclAlignIfRequired(ED, CGM.getContext());
David Blaikie483a9da2014-05-06 18:35:21 +00002573 }
2574
Brock Wyma8557ec52018-05-22 12:41:19 +00002575 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
David Blaikie483a9da2014-05-06 18:35:21 +00002576
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002577 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002578 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002579 ED = ED->getDefinition();
Momchil Velikov25f6be52018-02-12 16:12:52 +00002580 bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002581 for (const auto *Enum : ED->enumerators()) {
Momchil Velikov25f6be52018-02-12 16:12:52 +00002582 const auto &InitVal = Enum->getInitVal();
2583 auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2584 Enumerators.push_back(
2585 DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
Guy Benyei11169dd2012-12-18 14:30:41 +00002586 }
2587
2588 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002589 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002590
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002591 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002592 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002593 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Momchil Velikov25f6be52018-02-12 16:12:52 +00002594 llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002595 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2596 Line, Size, Align, EltArray, ClassTy,
Brock Wyma8557ec52018-05-22 12:41:19 +00002597 Identifier, ED->isFixed());
Guy Benyei11169dd2012-12-18 14:30:41 +00002598}
2599
Amjad Aboud546bc112017-02-09 22:07:24 +00002600llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2601 unsigned MType, SourceLocation LineLoc,
2602 StringRef Name, StringRef Value) {
2603 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2604 return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2605}
2606
2607llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2608 SourceLocation LineLoc,
2609 SourceLocation FileLoc) {
2610 llvm::DIFile *FName = getOrCreateFile(FileLoc);
2611 unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2612 return DBuilder.createTempMacroFile(Parent, Line, FName);
2613}
2614
David Blaikie05491062013-01-21 04:37:12 +00002615static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2616 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002617 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002618 Qualifiers InnerQuals = T.getLocalQualifiers();
2619 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2620 // that is already there.
2621 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2622 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002623 QualType LastT = T;
2624 switch (T->getTypeClass()) {
2625 default:
David Blaikie05491062013-01-21 04:37:12 +00002626 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002627 case Type::TemplateSpecialization: {
2628 const auto *Spec = cast<TemplateSpecializationType>(T);
2629 if (Spec->isTypeAlias())
2630 return C.getQualifiedType(T.getTypePtr(), Quals);
2631 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002632 break;
2633 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002634 case Type::TypeOfExpr:
2635 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2636 break;
2637 case Type::TypeOf:
2638 T = cast<TypeOfType>(T)->getUnderlyingType();
2639 break;
2640 case Type::Decltype:
2641 T = cast<DecltypeType>(T)->getUnderlyingType();
2642 break;
2643 case Type::UnaryTransform:
2644 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2645 break;
2646 case Type::Attributed:
2647 T = cast<AttributedType>(T)->getEquivalentType();
2648 break;
2649 case Type::Elaborated:
2650 T = cast<ElaboratedType>(T)->getNamedType();
2651 break;
2652 case Type::Paren:
2653 T = cast<ParenType>(T)->getInnerType();
2654 break;
David Blaikie05491062013-01-21 04:37:12 +00002655 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002656 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002657 break;
Richard Smitha0abc422017-02-22 00:13:14 +00002658 case Type::Auto:
2659 case Type::DeducedTemplateSpecialization: {
2660 QualType DT = cast<DeducedType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002661 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002662 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002663 break;
2664 }
Jordan Rose303e2f12016-11-10 23:28:17 +00002665 case Type::Adjusted:
2666 case Type::Decayed:
2667 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2668 T = cast<AdjustedType>(T)->getAdjustedType();
2669 break;
2670 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002671
Guy Benyei11169dd2012-12-18 14:30:41 +00002672 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002673 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002674 } while (true);
2675}
2676
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002677llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002678
2679 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002680 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002681
David Blaikief427b002014-05-06 03:42:01 +00002682 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002683 if (it != TypeCache.end()) {
2684 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002685 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002686 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002687 }
2688
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002689 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002690}
2691
David Blaikie0e716b42014-03-03 23:48:23 +00002692void CGDebugInfo::completeTemplateDefinition(
2693 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002694 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002695 return;
David Blaikie1ac9c982017-04-11 21:13:37 +00002696 completeUnusedClass(SD);
2697}
David Blaikie0856f662014-03-04 22:01:08 +00002698
David Blaikie1ac9c982017-04-11 21:13:37 +00002699void CGDebugInfo::completeUnusedClass(const CXXRecordDecl &D) {
2700 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2701 return;
2702
2703 completeClassData(&D);
David Blaikie0e716b42014-03-03 23:48:23 +00002704 // In case this type has no member function definitions being emitted, ensure
2705 // it is retained
David Blaikie1ac9c982017-04-11 21:13:37 +00002706 RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
David Blaikie0e716b42014-03-03 23:48:23 +00002707}
2708
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002709llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002710 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002711 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002712
2713 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002714 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002715
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002716 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002717 return T;
2718
Adrian Prantlca844182015-09-11 17:23:03 +00002719 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002720 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002721
2722 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002723 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002724
Guy Benyei11169dd2012-12-18 14:30:41 +00002725 return Res;
2726}
2727
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002728llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002729 // A forward declaration inside a module header does not belong to the module.
2730 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2731 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002732 if (DebugTypeExtRefs && D->isFromASTFile()) {
2733 // Record a reference to an imported clang module or precompiled header.
2734 auto *Reader = CGM.getContext().getExternalSource();
2735 auto Idx = D->getOwningModuleID();
2736 auto Info = Reader->getSourceDescriptor(Idx);
2737 if (Info)
2738 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2739 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002740 // We are building a clang module or a precompiled header.
2741 //
2742 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2743 // and it wouldn't be necessary to specify the parent scope
2744 // because the type is already unique by definition (it would look
2745 // like the output of -fno-standalone-debug). On the other hand,
2746 // the parent scope helps a consumer to quickly locate the object
2747 // file where the type's definition is located, so it might be
2748 // best to make this behavior a command line or debugger tuning
2749 // option.
Richard Smith54f04402017-05-18 02:29:20 +00002750 if (Module *M = D->getOwningModule()) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002751 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002752 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2753 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002754 } else {
2755 // This the precompiled header being built.
2756 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002757 }
2758 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002759
Adrian Prantl9402cef2015-09-20 16:51:35 +00002760 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002761}
2762
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002763llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002764 // Handle qualifiers, which recursively handles what they refer to.
2765 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002766 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002767
Guy Benyei11169dd2012-12-18 14:30:41 +00002768 // Work out details of type.
2769 switch (Ty->getTypeClass()) {
2770#define TYPE(Class, Base)
2771#define ABSTRACT_TYPE(Class, Base)
2772#define NON_CANONICAL_TYPE(Class, Base)
2773#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2774#include "clang/AST/TypeNodes.def"
2775 llvm_unreachable("Dependent types cannot show up in debug information");
2776
2777 case Type::ExtVector:
2778 case Type::Vector:
2779 return CreateType(cast<VectorType>(Ty), Unit);
2780 case Type::ObjCObjectPointer:
2781 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2782 case Type::ObjCObject:
2783 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Manman Rene6be26c2016-09-13 17:25:08 +00002784 case Type::ObjCTypeParam:
2785 return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002786 case Type::ObjCInterface:
2787 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2788 case Type::Builtin:
2789 return CreateType(cast<BuiltinType>(Ty));
2790 case Type::Complex:
2791 return CreateType(cast<ComplexType>(Ty));
2792 case Type::Pointer:
2793 return CreateType(cast<PointerType>(Ty), Unit);
2794 case Type::BlockPointer:
2795 return CreateType(cast<BlockPointerType>(Ty), Unit);
2796 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002797 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002798 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002799 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002800 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002801 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002802 case Type::FunctionProto:
2803 case Type::FunctionNoProto:
2804 return CreateType(cast<FunctionType>(Ty), Unit);
2805 case Type::ConstantArray:
2806 case Type::VariableArray:
2807 case Type::IncompleteArray:
2808 return CreateType(cast<ArrayType>(Ty), Unit);
2809
2810 case Type::LValueReference:
2811 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2812 case Type::RValueReference:
2813 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2814
2815 case Type::MemberPointer:
2816 return CreateType(cast<MemberPointerType>(Ty), Unit);
2817
2818 case Type::Atomic:
2819 return CreateType(cast<AtomicType>(Ty), Unit);
2820
Xiuli Pan9c14e282016-01-09 12:53:17 +00002821 case Type::Pipe:
2822 return CreateType(cast<PipeType>(Ty), Unit);
2823
Guy Benyei11169dd2012-12-18 14:30:41 +00002824 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002825 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2826
David Blaikie42edade2014-11-11 20:44:45 +00002827 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002828 case Type::Attributed:
Jordan Rose303e2f12016-11-10 23:28:17 +00002829 case Type::Adjusted:
2830 case Type::Decayed:
Richard Smith600b5262017-01-26 20:40:47 +00002831 case Type::DeducedTemplateSpecialization:
Guy Benyei11169dd2012-12-18 14:30:41 +00002832 case Type::Elaborated:
2833 case Type::Paren:
2834 case Type::SubstTemplateTypeParm:
2835 case Type::TypeOfExpr:
2836 case Type::TypeOf:
2837 case Type::Decltype:
2838 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002839 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002840 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002841 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002842
David Blaikie42edade2014-11-11 20:44:45 +00002843 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002844}
2845
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002846llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2847 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002848 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002849
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002850 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002851
2852 // We may have cached a forward decl when we could have created
2853 // a non-forward decl. Go ahead and create a non-forward decl
2854 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002855 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002856 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002857
2858 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002859 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002860
2861 // Propagate members from the declaration to the definition
2862 // CreateType(const RecordType*) will overwrite this with the members in the
2863 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002864 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002865
Guy Benyei11169dd2012-12-18 14:30:41 +00002866 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002867 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002868 return Res;
2869}
2870
2871// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002872llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002873 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002874
Guy Benyei11169dd2012-12-18 14:30:41 +00002875 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002876 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002877 unsigned Line = getLineNumber(RD->getLocation());
2878 StringRef RDName = getClassName(RD);
2879
Amjad Abouddc4531e2016-04-30 01:44:38 +00002880 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002881
David Blaikied2785892013-08-18 17:36:19 +00002882 // If we ended up creating the type during the context chain construction,
2883 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002884 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002885 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002886 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002887 return T;
David Blaikied2785892013-08-18 17:36:19 +00002888
Adrian Prantl381e7552014-02-04 21:29:50 +00002889 // If this is just a forward or incomplete declaration, construct an
2890 // appropriately marked node and just return it.
2891 const RecordDecl *D = RD->getDefinition();
2892 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002893 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002894
2895 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Victor Leschuka7ece032016-10-20 00:13:19 +00002896 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002897
Brock Wyma8557ec52018-05-22 12:41:19 +00002898 SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
Manman Rene0064d82013-08-29 23:19:58 +00002899
Adrian Prantl6c5f03a2018-01-05 01:13:52 +00002900 // Explicitly record the calling convention for C++ records.
2901 auto Flags = llvm::DINode::FlagZero;
2902 if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
2903 if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
2904 Flags |= llvm::DINode::FlagTypePassByReference;
2905 else
2906 Flags |= llvm::DINode::FlagTypePassByValue;
2907 }
2908
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002909 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Leny Kholodov80c047d2016-09-06 10:48:04 +00002910 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
Brock Wyma8557ec52018-05-22 12:41:19 +00002911 Flags, Identifier);
Guy Benyei11169dd2012-12-18 14:30:41 +00002912
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002913 // Elements of composite types usually have back to the type, creating
2914 // uniquing cycles. Distinct nodes are more efficient.
2915 switch (RealDecl->getTag()) {
2916 default:
2917 llvm_unreachable("invalid composite type tag");
2918
2919 case llvm::dwarf::DW_TAG_array_type:
2920 case llvm::dwarf::DW_TAG_enumeration_type:
2921 // Array elements and most enumeration elements don't have back references,
2922 // so they don't tend to be involved in uniquing cycles and there is some
2923 // chance of merging them when linking together two modules. Only make
2924 // them distinct if they are ODR-uniqued.
Brock Wyma8557ec52018-05-22 12:41:19 +00002925 if (Identifier.empty())
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002926 break;
Galina Kistanova0872d6c2017-06-03 06:30:46 +00002927 LLVM_FALLTHROUGH;
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002928
2929 case llvm::dwarf::DW_TAG_structure_type:
2930 case llvm::dwarf::DW_TAG_union_type:
2931 case llvm::dwarf::DW_TAG_class_type:
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002932 // Immediately resolve to a distinct node.
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002933 RealDecl =
2934 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2935 break;
2936 }
2937
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002938 RegionMap[Ty->getDecl()].reset(RealDecl);
2939 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002940
David Majnemer58ed0f32016-07-17 00:39:12 +00002941 if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002942 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002943 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002944 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002945}
2946
David Blaikieadfbf992013-08-18 16:55:33 +00002947void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002948 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002949 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002950 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002951 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2952 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002953 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002954 while (1) {
2955 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2956 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2957 if (PBT && !BRL.isPrimaryBaseVirtual())
2958 PBase = PBT;
2959 else
2960 break;
2961 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002962 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002963 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2964 getOrCreateFile(RD->getLocation())));
2965 } else if (RD->isDynamicClass())
2966 ContainingType = RealDecl;
2967
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002968 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002969}
2970
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002971llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002972 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002973 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002974 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
Victor Leschuka7ece032016-10-20 00:13:19 +00002975 auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
Leny Kholodovdf050fd2016-09-06 17:06:14 +00002976 llvm::DIType *Ty =
2977 DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
2978 *Offset, llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002979 *Offset += FieldSize;
2980 return Ty;
2981}
2982
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002983void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002984 StringRef &Name,
2985 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002986 llvm::DIScope *&FDContext,
2987 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +00002988 llvm::DINode::DIFlags &Flags) {
David Majnemer58ed0f32016-07-17 00:39:12 +00002989 const auto *FD = cast<FunctionDecl>(GD.getDecl());
Frederic Riss9db79f12014-11-18 03:40:46 +00002990 Name = getFunctionName(FD);
2991 // Use mangled name as linkage name for C/C++ functions.
2992 if (FD->hasPrototype()) {
2993 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002994 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002995 }
2996 // No need to replicate the linkage name if it isn't different from the
2997 // subprogram name, no need to have it at all unless coverage is enabled or
Dehao Chenb3a70de2017-01-19 00:44:21 +00002998 // debug is set to more than just line tables or extra debug info is needed.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002999 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3000 !CGM.getCodeGenOpts().EmitGcovNotes &&
Dehao Chenb3a70de2017-01-19 00:44:21 +00003001 !CGM.getCodeGenOpts().DebugInfoForProfiling &&
Benjamin Kramer8c305922016-02-02 11:06:51 +00003002 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00003003 LinkageName = StringRef();
3004
Benjamin Kramer8c305922016-02-02 11:06:51 +00003005 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003006 if (const NamespaceDecl *NSDecl =
Adrian Prantl6fc88752017-05-16 23:46:10 +00003007 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Adrian Prantlddb8e062017-05-12 16:23:53 +00003008 FDContext = getOrCreateNamespace(NSDecl);
Frederic Riss9db79f12014-11-18 03:40:46 +00003009 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003010 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
3011 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3012 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3013 }
Adrian Prantlfd5ac8a2016-08-17 16:20:32 +00003014 // Check if it is a noreturn-marked function
3015 if (FD->isNoReturn())
3016 Flags |= llvm::DINode::FlagNoReturn;
Frederic Riss9db79f12014-11-18 03:40:46 +00003017 // Collect template parameters.
3018 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3019 }
3020}
3021
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003022void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00003023 unsigned &LineNo, QualType &T,
3024 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003025 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00003026 Unit = getOrCreateFile(VD->getLocation());
3027 LineNo = getLineNumber(VD->getLocation());
3028
3029 setLocation(VD->getLocation());
3030
3031 T = VD->getType();
3032 if (T->isIncompleteArrayType()) {
3033 // CodeGen turns int[] into int[1] so we'll do the same here.
3034 llvm::APInt ConstVal(32, 1);
3035 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3036
3037 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3038 ArrayType::Normal, 0);
3039 }
3040
3041 Name = VD->getName();
3042 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3043 !isa<ObjCMethodDecl>(VD->getDeclContext()))
3044 LinkageName = CGM.getMangledName(VD);
3045 if (LinkageName == Name)
3046 LinkageName = StringRef();
3047
3048 // Since we emit declarations (DW_AT_members) for static members, place the
3049 // definition of those static members in the namespace they were declared in
3050 // in the source code (the lexical decl context).
3051 // FIXME: Generalize this for even non-member global variables where the
3052 // declaration and definition may have different lexical decl contexts, once
3053 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003054 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3055 : VD->getDeclContext();
3056 // When a record type contains an in-line initialization of a static data
3057 // member, and the record type is marked as __declspec(dllexport), an implicit
3058 // definition of the member will be created in the record context. DWARF
3059 // doesn't seem to have a nice way to describe this in a form that consumers
3060 // are likely to understand, so fake the "normal" situation of a definition
3061 // outside the class by putting it in the global scope.
3062 if (DC->isRecord())
3063 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003064
Amjad Abouddc4531e2016-04-30 01:44:38 +00003065 llvm::DIScope *Mod = getParentModuleOrNull(VD);
3066 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00003067}
3068
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003069llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3070 bool Stub) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003071 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00003072 StringRef Name, LinkageName;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003073 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003074 SourceLocation Loc = GD.getDecl()->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003075 llvm::DIFile *Unit = getOrCreateFile(Loc);
3076 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003077 unsigned Line = getLineNumber(Loc);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003078 collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext,
Frederic Rissd253ed62014-11-18 03:40:51 +00003079 TParamsArray, Flags);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003080 auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3081
Frederic Rissd253ed62014-11-18 03:40:51 +00003082 // Build function type.
3083 SmallVector<QualType, 16> ArgTypes;
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003084 if (FD)
3085 for (const ParmVarDecl *Parm : FD->parameters())
3086 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00003087 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3088 QualType FnType = CGM.getContext().getFunctionType(
3089 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003090 if (Stub) {
3091 return DBuilder.createFunction(
3092 DContext, Name, LinkageName, Unit, Line,
3093 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
3094 !FD->isExternallyVisible(),
3095 /* isDefinition = */ true, 0, Flags, CGM.getLangOpts().Optimize,
3096 TParamsArray.get(), getFunctionDeclaration(FD));
3097 }
3098
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003099 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003100 DContext, Name, LinkageName, Unit, Line,
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003101 getOrCreateFunctionType(GD.getDecl(), FnType, Unit),
3102 !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003103 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003104 TParamsArray.get(), getFunctionDeclaration(FD));
George Burgess IV00f70bd2018-03-01 05:43:23 +00003105 const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003106 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3107 std::make_tuple(CanonDecl),
3108 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00003109 return SP;
3110}
3111
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003112llvm::DISubprogram *
3113CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3114 return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3115}
3116
3117llvm::DISubprogram *
3118CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3119 return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3120}
3121
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003122llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00003123CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3124 QualType T;
3125 StringRef Name, LinkageName;
3126 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003127 llvm::DIFile *Unit = getOrCreateFile(Loc);
3128 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00003129 unsigned Line = getLineNumber(Loc);
3130
3131 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Victor Leschuka7ece032016-10-20 00:13:19 +00003132 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003133 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3134 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003135 !VD->isExternallyVisible(), nullptr, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003136 FwdDeclReplaceMap.emplace_back(
3137 std::piecewise_construct,
3138 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3139 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003140 return GV;
3141}
3142
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003143llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003144 // We only need a declaration (not a definition) of the type - so use whatever
3145 // we would otherwise do to get a type for a pointee. (forward declarations in
3146 // limited debug info, full definitions (if the type definition is available)
3147 // in unlimited debug info)
David Majnemer58ed0f32016-07-17 00:39:12 +00003148 if (const auto *TD = dyn_cast<TypeDecl>(D))
David Blaikie6b7d060c2013-08-12 23:14:36 +00003149 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00003150 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003151 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00003152
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003153 if (I != DeclCache.end()) {
3154 auto N = I->second;
3155 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3156 return GVE->getVariable();
3157 return dyn_cast_or_null<llvm::DINode>(N);
3158 }
Frederic Rissd253ed62014-11-18 03:40:51 +00003159
3160 // No definition for now. Emit a forward definition that might be
3161 // merged with a potential upcoming definition.
David Majnemer58ed0f32016-07-17 00:39:12 +00003162 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Frederic Rissd253ed62014-11-18 03:40:51 +00003163 return getFunctionForwardDeclaration(FD);
3164 else if (const auto *VD = dyn_cast<VarDecl>(D))
3165 return getGlobalVariableForwardDeclaration(VD);
3166
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003167 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00003168}
3169
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003170llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003171 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003172 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00003173
David Majnemer58ed0f32016-07-17 00:39:12 +00003174 const auto *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00003175 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003176 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003177
3178 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003179 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003180
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003181 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00003182 if (MI == SPCache.end()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003183 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003184 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003185 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00003186 }
3187 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003188 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003189 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003190 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003191 return SP;
3192 }
3193
Aaron Ballman86c93902014-03-06 23:45:36 +00003194 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003195 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003196 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003197 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003198 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00003199 return SP;
3200 }
3201 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003202 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003203}
3204
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003205// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00003206// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003207llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003208 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003209 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003210 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003211 // Create fake but valid subroutine type. Otherwise -verify would fail, and
3212 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00003213 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00003214
David Majnemer58ed0f32016-07-17 00:39:12 +00003215 if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00003216 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00003217
3218 const auto *FTy = FnType->getAs<FunctionType>();
3219 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3220
David Majnemer58ed0f32016-07-17 00:39:12 +00003221 if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003222 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003223 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00003224
3225 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00003226 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00003227
3228 // Replace the instancetype keyword with the actual type.
3229 if (ResultTy == CGM.getContext().getObjCInstanceType())
3230 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00003231 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00003232
Adrian Prantl7bec9032013-05-10 21:08:31 +00003233 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003234 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003235 QualType SelfDeclTy;
3236 if (auto *SelfDecl = OMethod->getSelfDecl())
3237 SelfDeclTy = SelfDecl->getType();
3238 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3239 if (FPT->getNumParams() > 1)
3240 SelfDeclTy = FPT->getParamType(0);
3241 if (!SelfDeclTy.isNull())
3242 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003243 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003244 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003245 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003246 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00003247 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00003248 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00003249 // Variadic methods need a special marker at the end of the type list.
3250 if (OMethod->isVariadic())
3251 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00003252
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003253 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003254 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3255 getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00003256 }
Adrian Prantld45ba252014-02-25 19:38:11 +00003257
Adrian Prantl800faef2014-02-25 23:42:18 +00003258 // Handle variadic function types; they need an additional
3259 // unspecified parameter.
David Majnemer58ed0f32016-07-17 00:39:12 +00003260 if (const auto *FD = dyn_cast<FunctionDecl>(D))
Adrian Prantld45ba252014-02-25 19:38:11 +00003261 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003262 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00003263 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
David Majnemer58ed0f32016-07-17 00:39:12 +00003264 if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3265 for (QualType ParamType : FPT->param_types())
3266 EltTys.push_back(getOrCreateType(ParamType, F));
Adrian Prantld45ba252014-02-25 19:38:11 +00003267 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003268 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Leny Kholodov80c047d2016-09-06 10:48:04 +00003269 return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3270 getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00003271 }
3272
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003273 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00003274}
3275
Eric Christophere7b87e52014-10-26 23:40:33 +00003276void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
3277 SourceLocation ScopeLoc, QualType FnType,
Brock Wyma94ece8f2018-04-16 16:53:57 +00003278 llvm::Function *Fn, bool CurFuncIsThunk,
3279 CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003280
3281 StringRef Name;
3282 StringRef LinkageName;
3283
3284 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3285
3286 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00003287 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00003288
Leny Kholodov80c047d2016-09-06 10:48:04 +00003289 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003290 llvm::DIFile *Unit = getOrCreateFile(Loc);
3291 llvm::DIScope *FDContext = Unit;
3292 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00003293 if (!HasDecl) {
3294 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00003295 LinkageName = Fn->getName();
David Majnemer58ed0f32016-07-17 00:39:12 +00003296 } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003297 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003298 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00003299 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003300 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00003301 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003302 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003303 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003304 return;
3305 }
3306 }
Frederic Riss9db79f12014-11-18 03:40:46 +00003307 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3308 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003309 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003310 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003311 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003312 } else {
3313 // Use llvm function name.
3314 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003315 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00003316 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003317 if (Name.startswith("\01"))
Guy Benyei11169dd2012-12-18 14:30:41 +00003318 Name = Name.substr(1);
3319
Erich Keane293a0552018-02-14 00:14:07 +00003320 if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003321 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantldb763572016-11-09 21:43:51 +00003322 // Artificial functions should not silently reuse CurLoc.
3323 CurLoc = SourceLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00003324 }
Brock Wyma94ece8f2018-04-16 16:53:57 +00003325
3326 if (CurFuncIsThunk)
3327 Flags |= llvm::DINode::FlagThunk;
3328
Adrian Prantl42d71b92014-04-10 23:21:53 +00003329 unsigned LineNo = getLineNumber(Loc);
3330 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003331
Eric Christopher8018e412014-03-27 18:50:35 +00003332 // FIXME: The function declaration we're constructing here is mostly reusing
3333 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3334 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3335 // all subprograms instead of the actual context since subprogram definitions
3336 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003337 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00003338 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00003339 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003340 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00003341 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00003342 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00003343 // We might get here with a VarDecl in the case we're generating
3344 // code for the initialization of globals. Do not record these decls
3345 // as they will overwrite the actual VarDecl Decl in the cache.
3346 if (HasDecl && isa<FunctionDecl>(D))
David Majnemer58ed0f32016-07-17 00:39:12 +00003347 DeclCache[D->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003348
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00003349 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3350 // Starting with DWARF V5 method declarations are emitted as children of
3351 // the interface type.
3352 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3353 const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3354 QualType QTy(ID->getTypeForDecl(), 0);
3355 auto It = TypeCache.find(QTy.getAsOpaquePtr());
3356 if (It != TypeCache.end()) {
3357 llvm::DICompositeType *InterfaceDecl =
3358 cast<llvm::DICompositeType>(It->second);
3359 llvm::DISubprogram *FD = DBuilder.createFunction(
3360 InterfaceDecl, Name, LinkageName, Unit, LineNo,
3361 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
3362 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3363 TParamsArray.get());
3364 DBuilder.finalizeSubprogram(FD);
3365 ObjCMethodCache[ID].push_back(FD);
3366 }
3367 }
3368 }
3369
Adrian Prantlbebb8932014-03-21 21:01:58 +00003370 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003371 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00003372
Guy Benyei11169dd2012-12-18 14:30:41 +00003373 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003374 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00003375}
3376
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003377void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
3378 QualType FnType) {
3379 StringRef Name;
3380 StringRef LinkageName;
3381
3382 const Decl *D = GD.getDecl();
3383 if (!D)
3384 return;
3385
Leny Kholodov80c047d2016-09-06 10:48:04 +00003386 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003387 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00003388 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003389 llvm::DINodeArray TParamsArray;
3390 if (isa<FunctionDecl>(D)) {
3391 // If there is a DISubprogram for this function available then use it.
3392 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3393 TParamsArray, Flags);
David Majnemer58ed0f32016-07-17 00:39:12 +00003394 } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003395 Name = getObjCMethodName(OMD);
3396 Flags |= llvm::DINode::FlagPrototyped;
3397 } else {
3398 llvm_unreachable("not a function or ObjC method");
3399 }
3400 if (!Name.empty() && Name[0] == '\01')
3401 Name = Name.substr(1);
3402
3403 if (D->isImplicit()) {
3404 Flags |= llvm::DINode::FlagArtificial;
3405 // Artificial functions without a location should not silently reuse CurLoc.
3406 if (Loc.isInvalid())
3407 CurLoc = SourceLocation();
3408 }
3409 unsigned LineNo = getLineNumber(Loc);
3410 unsigned ScopeLine = 0;
3411
Adrian Prantle76bda52016-04-15 15:55:45 +00003412 DBuilder.retainType(DBuilder.createFunction(
3413 FDContext, Name, LinkageName, Unit, LineNo,
3414 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
3415 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
3416 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00003417}
3418
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003419void CGDebugInfo::EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD) {
3420 const auto *FD = cast<FunctionDecl>(GD.getDecl());
3421 // If there is a subprogram for this function available then use it.
3422 auto FI = SPCache.find(FD->getCanonicalDecl());
3423 llvm::DISubprogram *SP = nullptr;
3424 if (FI != SPCache.end())
3425 SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Adrian Prantl8040a212017-08-23 21:24:12 +00003426 if (!SP || !SP->isDefinition())
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003427 SP = getFunctionStub(GD);
3428 FnBeginRegionCount.push_back(LexicalBlockStack.size());
3429 LexicalBlockStack.emplace_back(SP);
3430 setInlinedAt(Builder.getCurrentDebugLocation());
3431 EmitLocation(Builder, FD->getLocation());
3432}
3433
3434void CGDebugInfo::EmitInlineFunctionEnd(CGBuilderTy &Builder) {
3435 assert(CurInlinedAt && "unbalanced inline scope stack");
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003436 EmitFunctionEnd(Builder, nullptr);
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003437 setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3438}
3439
David Blaikie835afb22015-01-21 23:08:17 +00003440void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003441 // Update our current location
3442 setLocation(Loc);
3443
Eric Christophere7b87e52014-10-26 23:40:33 +00003444 if (CurLoc.isInvalid() || CurLoc.isMacroID())
3445 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003446
Adrian Prantle83b1302014-01-07 22:05:52 +00003447 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00003448 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003449 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
Guy Benyei11169dd2012-12-18 14:30:41 +00003450}
3451
Guy Benyei11169dd2012-12-18 14:30:41 +00003452void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00003453 llvm::MDNode *Back = nullptr;
3454 if (!LexicalBlockStack.empty())
3455 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003456 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003457 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003458 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003459}
3460
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003461void CGDebugInfo::AppendAddressSpaceXDeref(
3462 unsigned AddressSpace,
3463 SmallVectorImpl<int64_t> &Expr) const {
3464 Optional<unsigned> DWARFAddressSpace =
3465 CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3466 if (!DWARFAddressSpace)
3467 return;
3468
3469 Expr.push_back(llvm::dwarf::DW_OP_constu);
3470 Expr.push_back(DWARFAddressSpace.getValue());
3471 Expr.push_back(llvm::dwarf::DW_OP_swap);
3472 Expr.push_back(llvm::dwarf::DW_OP_xderef);
3473}
3474
Eric Christopher0fdcb312013-05-16 00:52:20 +00003475void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3476 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003477 // Set our current location.
3478 setLocation(Loc);
3479
Guy Benyei11169dd2012-12-18 14:30:41 +00003480 // Emit a line table change for the current location inside the new scope.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003481 Builder.SetCurrentDebugLocation(
3482 llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3483 LexicalBlockStack.back(), CurInlinedAt));
David Blaikie60a877b2014-10-22 19:34:33 +00003484
Benjamin Kramer8c305922016-02-02 11:06:51 +00003485 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003486 return;
3487
3488 // Create a new lexical block and push it on the stack.
3489 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003490}
3491
Eric Christopher0fdcb312013-05-16 00:52:20 +00003492void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3493 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003494 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3495
3496 // Provide an entry in the line table for the end of the block.
3497 EmitLocation(Builder, Loc);
3498
Benjamin Kramer8c305922016-02-02 11:06:51 +00003499 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003500 return;
3501
Guy Benyei11169dd2012-12-18 14:30:41 +00003502 LexicalBlockStack.pop_back();
3503}
3504
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003505void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003506 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3507 unsigned RCount = FnBeginRegionCount.back();
3508 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3509
3510 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003511 while (LexicalBlockStack.size() != RCount) {
3512 // Provide an entry in the line table for the end of the block.
3513 EmitLocation(Builder, CurLoc);
3514 LexicalBlockStack.pop_back();
3515 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003516 FnBeginRegionCount.pop_back();
Keno Fischer41d4b4e2017-06-01 21:14:03 +00003517
3518 if (Fn && Fn->getSubprogram())
3519 DBuilder.finalizeSubprogram(Fn->getSubprogram());
Guy Benyei11169dd2012-12-18 14:30:41 +00003520}
3521
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003522llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003523 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003524
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003525 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003526 QualType FType;
3527 uint64_t FieldSize, FieldOffset;
Victor Leschuk802e4a52016-10-19 22:11:07 +00003528 uint32_t FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003529
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003530 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003531 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003532
3533 FieldOffset = 0;
3534 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3535 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3536 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3537 FType = CGM.getContext().IntTy;
3538 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3539 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3540
3541 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3542 if (HasCopyAndDispose) {
3543 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003544 EltTys.push_back(
3545 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3546 EltTys.push_back(
3547 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003548 }
3549 bool HasByrefExtendedLayout;
3550 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003551 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3552 HasByrefExtendedLayout) &&
3553 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003554 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003555 EltTys.push_back(
3556 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003557 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003558
Guy Benyei11169dd2012-12-18 14:30:41 +00003559 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3560 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003561 CGM.getTarget().getPointerAlign(0))) {
3562 CharUnits FieldOffsetInBytes =
3563 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003564 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003565 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003566
Guy Benyei11169dd2012-12-18 14:30:41 +00003567 if (NumPaddingBytes.isPositive()) {
3568 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3569 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3570 pad, ArrayType::Normal, 0);
3571 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3572 }
3573 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003574
Guy Benyei11169dd2012-12-18 14:30:41 +00003575 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003576 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003577 FieldSize = CGM.getContext().getTypeSize(FType);
3578 FieldAlign = CGM.getContext().toBits(Align);
3579
Eric Christopherb2a008c2013-05-16 00:45:12 +00003580 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003581 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
Leny Kholodov80c047d2016-09-06 10:48:04 +00003582 FieldAlign, FieldOffset,
3583 llvm::DINode::FlagZero, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003584 EltTys.push_back(FieldTy);
3585 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003586
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003587 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003588
Leny Kholodov80c047d2016-09-06 10:48:04 +00003589 llvm::DINode::DIFlags Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003590
Guy Benyei11169dd2012-12-18 14:30:41 +00003591 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003592 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003593}
3594
Sander de Smalen891af03a2018-02-03 13:55:59 +00003595llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3596 llvm::Value *Storage,
3597 llvm::Optional<unsigned> ArgNo,
3598 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003599 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003600 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003601 if (VD->hasAttr<NoDebugAttr>())
Sander de Smalen891af03a2018-02-03 13:55:59 +00003602 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003603
David Blaikie7fceebf2013-08-19 03:37:48 +00003604 bool Unwritten =
3605 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3606 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003607 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003608 if (!Unwritten)
3609 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003610 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003611 uint64_t XOffset = 0;
3612 if (VD->hasAttr<BlocksAttr>())
3613 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003614 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003615 Ty = getOrCreateType(VD->getType(), Unit);
3616
3617 // If there is no debug info for this type then do not emit debug info
3618 // for this variable.
3619 if (!Ty)
Sander de Smalen891af03a2018-02-03 13:55:59 +00003620 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003621
Guy Benyei11169dd2012-12-18 14:30:41 +00003622 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003623 unsigned Line = 0;
3624 unsigned Column = 0;
3625 if (!Unwritten) {
3626 Line = getLineNumber(VD->getLocation());
3627 Column = getColumnNumber(VD->getLocation());
3628 }
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003629 SmallVector<int64_t, 13> Expr;
Leny Kholodov80c047d2016-09-06 10:48:04 +00003630 llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
Guy Benyei11169dd2012-12-18 14:30:41 +00003631 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003632 Flags |= llvm::DINode::FlagArtificial;
Victor Leschuka7ece032016-10-20 00:13:19 +00003633
3634 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3635
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00003636 unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3637 AppendAddressSpaceXDeref(AddressSpace, Expr);
3638
Alexey Bataev24f710182017-06-09 13:55:08 +00003639 // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3640 // object pointer flag.
Alexey Bataev56223232017-06-09 13:40:18 +00003641 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3642 if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3643 IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3644 Flags |= llvm::DINode::FlagObjectPointer;
3645 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003646
Adrian Prantlc3782a12017-04-18 01:22:01 +00003647 // Note: Older versions of clang used to emit byval references with an extra
3648 // DW_OP_deref, because they referenced the IR arg directly instead of
3649 // referencing an alloca. Newer versions of LLVM don't treat allocas
3650 // differently from other function arguments when used in a dbg.declare.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003651 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003652 StringRef Name = VD->getName();
3653 if (!Name.empty()) {
3654 if (VD->hasAttr<BlocksAttr>()) {
Adrian Prantlc3782a12017-04-18 01:22:01 +00003655 // Here, we need an offset *into* the alloca.
Guy Benyei11169dd2012-12-18 14:30:41 +00003656 CharUnits offset = CharUnits::fromQuantity(32);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003657 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003658 // offset of __forwarding field
3659 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003660 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003661 Expr.push_back(offset.getQuantity());
3662 Expr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003663 Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003664 // offset of x field
3665 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003666 Expr.push_back(offset.getQuantity());
Adrian Prantlc3782a12017-04-18 01:22:01 +00003667 }
David Majnemer58ed0f32016-07-17 00:39:12 +00003668 } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
Adrian Prantl0d820892015-04-29 15:05:50 +00003669 // If VD is an anonymous union then Storage represents value for
3670 // all union fields.
George Burgess IV00f70bd2018-03-01 05:43:23 +00003671 const RecordDecl *RD = RT->getDecl();
Adrian Prantl0d820892015-04-29 15:05:50 +00003672 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003673 // GDB has trouble finding local variables in anonymous unions, so we emit
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003674 // artificial local variables for each of the members.
Adrian Prantl00820ab2015-04-29 16:52:31 +00003675 //
3676 // FIXME: Remove this code as soon as GDB supports this.
3677 // The debug info verifier in LLVM operates based on the assumption that a
3678 // variable has the same size as its storage and we had to disable the check
3679 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003680 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003681 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003682 StringRef FieldName = Field->getName();
3683
3684 // Ignore unnamed fields. Do not ignore unnamed records.
3685 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3686 continue;
3687
3688 // Use VarDecl's Tag, Scope and Line number.
Victor Leschuka7ece032016-10-20 00:13:19 +00003689 auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003690 auto *D = DBuilder.createAutoVariable(
3691 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
Victor Leschuka7ece032016-10-20 00:13:19 +00003692 Flags | llvm::DINode::FlagArtificial, FieldAlign);
Adrian Prantl0d820892015-04-29 15:05:50 +00003693
3694 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003695 DBuilder.insertDeclare(
3696 Storage, D, DBuilder.createExpression(Expr),
3697 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3698 Builder.GetInsertBlock());
Adrian Prantl0d820892015-04-29 15:05:50 +00003699 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003700 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003701 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003702
3703 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003704 auto *D = ArgNo
3705 ? DBuilder.createParameterVariable(
3706 Scope, Name, *ArgNo, Unit, Line, Ty,
3707 CGM.getLangOpts().Optimize, Flags)
3708 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3709 CGM.getLangOpts().Optimize, Flags,
3710 Align);
David Blaikiea76a7c92013-01-05 05:58:35 +00003711
3712 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003713 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003714 llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003715 Builder.GetInsertBlock());
Sander de Smalen891af03a2018-02-03 13:55:59 +00003716
3717 return D;
Guy Benyei11169dd2012-12-18 14:30:41 +00003718}
3719
Sander de Smalen891af03a2018-02-03 13:55:59 +00003720llvm::DILocalVariable *
3721CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD, llvm::Value *Storage,
3722 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003723 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Sander de Smalen891af03a2018-02-03 13:55:59 +00003724 return EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003725}
3726
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003727llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3728 llvm::DIType *Ty) {
3729 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003730 if (CachedTy)
3731 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003732 return DBuilder.createObjectPointerType(Ty);
3733}
3734
Eric Christophere7b87e52014-10-26 23:40:33 +00003735void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3736 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003737 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003738 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003739 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003740
Craig Topper8a13c412014-05-21 05:09:00 +00003741 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003742 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003743 if (VD->hasAttr<NoDebugAttr>())
3744 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003745
Guy Benyei11169dd2012-12-18 14:30:41 +00003746 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003747
Guy Benyei11169dd2012-12-18 14:30:41 +00003748 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003749 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3750 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003751 if (isByRef)
3752 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003753 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003754 Ty = getOrCreateType(VD->getType(), Unit);
3755
3756 // Self is passed along as an implicit non-arg variable in a
3757 // block. Mark it as the object pointer.
Alexey Bataev56223232017-06-09 13:40:18 +00003758 if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3759 if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3760 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003761
3762 // Get location information.
3763 unsigned Line = getLineNumber(VD->getLocation());
3764 unsigned Column = getColumnNumber(VD->getLocation());
3765
3766 const llvm::DataLayout &target = CGM.getDataLayout();
3767
3768 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003769 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003770 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3771
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003772 SmallVector<int64_t, 9> addr;
Adrian Prantlc3782a12017-04-18 01:22:01 +00003773 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003774 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003775 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003776 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003777 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003778 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003779 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003780 offset =
3781 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003782 addr.push_back(offset.getQuantity());
3783 addr.push_back(llvm::dwarf::DW_OP_deref);
Florian Hahn3dbcced2017-06-13 18:06:15 +00003784 addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Guy Benyei11169dd2012-12-18 14:30:41 +00003785 // offset of x field
3786 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003787 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003788 }
3789
3790 // Create the descriptor for the variable.
Victor Leschuka7ece032016-10-20 00:13:19 +00003791 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003792 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003793 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Victor Leschuka7ece032016-10-20 00:13:19 +00003794 Line, Ty, false, llvm::DINode::FlagZero, Align);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003795
Guy Benyei11169dd2012-12-18 14:30:41 +00003796 // Insert an llvm.dbg.declare into the current block.
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003797 auto DL =
3798 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
Adrian Prantlc3782a12017-04-18 01:22:01 +00003799 auto *Expr = DBuilder.createExpression(addr);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003800 if (InsertPoint)
Adrian Prantlc3782a12017-04-18 01:22:01 +00003801 DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003802 else
Adrian Prantlc3782a12017-04-18 01:22:01 +00003803 DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003804}
3805
Guy Benyei11169dd2012-12-18 14:30:41 +00003806void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3807 unsigned ArgNo,
3808 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003809 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003810 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003811}
3812
3813namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003814struct BlockLayoutChunk {
3815 uint64_t OffsetInBits;
3816 const BlockDecl::Capture *Capture;
3817};
3818bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3819 return l.OffsetInBits < r.OffsetInBits;
3820}
Guy Benyei11169dd2012-12-18 14:30:41 +00003821}
3822
3823void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl356347b2017-10-26 20:08:52 +00003824 StringRef Name,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003825 unsigned ArgNo,
Adrian Prantl356347b2017-10-26 20:08:52 +00003826 llvm::AllocaInst *Alloca,
Guy Benyei11169dd2012-12-18 14:30:41 +00003827 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003828 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003829 ASTContext &C = CGM.getContext();
3830 const BlockDecl *blockDecl = block.getBlockDecl();
3831
3832 // Collect some general information about the block's location.
3833 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003834 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003835 unsigned line = getLineNumber(loc);
3836 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003837
Guy Benyei11169dd2012-12-18 14:30:41 +00003838 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003839 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003840
3841 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003842 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003843
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003844 SmallVector<llvm::Metadata *, 16> fields;
David Majnemerb4b671e2016-06-30 03:01:59 +00003845 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003846 blockLayout->getElementOffsetInBits(0),
3847 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003848 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003849 blockLayout->getElementOffsetInBits(1),
3850 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003851 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003852 blockLayout->getElementOffsetInBits(2),
3853 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003854 auto *FnTy = block.getBlockExpr()->getFunctionType();
3855 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
David Majnemerb4b671e2016-06-30 03:01:59 +00003856 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003857 blockLayout->getElementOffsetInBits(3),
3858 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003859 fields.push_back(createFieldType(
3860 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3861 ? C.getBlockDescriptorExtendedType()
3862 : C.getBlockDescriptorType()),
David Majnemerb4b671e2016-06-30 03:01:59 +00003863 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003864
3865 // We want to sort the captures by offset, not because DWARF
3866 // requires this, but because we're paranoid about debuggers.
3867 SmallVector<BlockLayoutChunk, 8> chunks;
3868
3869 // 'this' capture.
3870 if (blockDecl->capturesCXXThis()) {
3871 BlockLayoutChunk chunk;
3872 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003873 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003874 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003875 chunks.push_back(chunk);
3876 }
3877
3878 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003879 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003880 const VarDecl *variable = capture.getVariable();
3881 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3882
3883 // Ignore constant captures.
3884 if (captureInfo.isConstant())
3885 continue;
3886
3887 BlockLayoutChunk chunk;
3888 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003889 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003890 chunk.Capture = &capture;
3891 chunks.push_back(chunk);
3892 }
3893
3894 // Sort by offset.
3895 llvm::array_pod_sort(chunks.begin(), chunks.end());
3896
David Majnemer58ed0f32016-07-17 00:39:12 +00003897 for (const BlockLayoutChunk &Chunk : chunks) {
3898 uint64_t offsetInBits = Chunk.OffsetInBits;
3899 const BlockDecl::Capture *capture = Chunk.Capture;
Guy Benyei11169dd2012-12-18 14:30:41 +00003900
3901 // If we have a null capture, this must be the C++ 'this' capture.
3902 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003903 QualType type;
3904 if (auto *Method =
3905 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3906 type = Method->getThisType(C);
3907 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3908 type = QualType(RDecl->getTypeForDecl(), 0);
3909 else
3910 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003911
David Majnemerb4b671e2016-06-30 03:01:59 +00003912 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003913 offsetInBits, tunit, tunit));
3914 continue;
3915 }
3916
3917 const VarDecl *variable = capture->getVariable();
3918 StringRef name = variable->getName();
3919
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003920 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003921 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003922 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Victor Leschuka7ece032016-10-20 00:13:19 +00003923 auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00003924
3925 // FIXME: this creates a second copy of this type!
3926 uint64_t xoffset;
3927 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003928 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
Victor Leschuka7ece032016-10-20 00:13:19 +00003929 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
3930 PtrInfo.Width, Align, offsetInBits,
3931 llvm::DINode::FlagZero, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003932 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00003933 auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
David Majnemerb4b671e2016-06-30 03:01:59 +00003934 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Victor Leschuka7ece032016-10-20 00:13:19 +00003935 offsetInBits, Align, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003936 }
3937 fields.push_back(fieldType);
3938 }
3939
3940 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003941 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3942 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003943
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003944 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003945
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003946 llvm::DIType *type =
3947 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
Victor Leschuka7ece032016-10-20 00:13:19 +00003948 CGM.getContext().toBits(block.BlockSize), 0,
Leny Kholodovdf050fd2016-09-06 17:06:14 +00003949 llvm::DINode::FlagZero, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003950 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3951
3952 // Get overall information about the block.
Leny Kholodov80c047d2016-09-06 10:48:04 +00003953 llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003954 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003955
3956 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003957 auto *debugVar = DBuilder.createParameterVariable(
Adrian Prantl356347b2017-10-26 20:08:52 +00003958 scope, Name, ArgNo, tunit, line, type,
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003959 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003960
Adrian Prantl616bef42013-03-14 21:52:59 +00003961 // Insert an llvm.dbg.declare into the current block.
Adrian Prantl356347b2017-10-26 20:08:52 +00003962 DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
Adrian Prantlb7acfc02017-02-27 21:30:05 +00003963 llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003964 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003965}
3966
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003967llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003968CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3969 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003970 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003971
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003972 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003973 if (MI != StaticDataMemberCache.end()) {
3974 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003975 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003976 }
David Blaikiece763042013-08-20 21:49:21 +00003977
3978 // If the member wasn't found in the cache, lazily construct and add it to the
3979 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003980 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003981 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003982 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003983}
3984
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003985llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003986 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3987 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003988 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003989
3990 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003991 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003992 StringRef FieldName = Field->getName();
3993
3994 // Ignore unnamed fields, but recurse into anonymous records.
3995 if (FieldName.empty()) {
David Majnemer58ed0f32016-07-17 00:39:12 +00003996 if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
Adrian Prantl5f4740d2016-12-20 02:10:02 +00003997 GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
Eric Christophercab9fae2014-04-10 05:20:00 +00003998 Var, DContext);
3999 continue;
4000 }
4001 // Use VarDecl's Tag, Scope and Line number.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004002 GVE = DBuilder.createGlobalVariableExpression(
4003 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4004 Var->hasLocalLinkage());
4005 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004006 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004007 return GVE;
Eric Christophercab9fae2014-04-10 05:20:00 +00004008}
4009
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004010void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00004011 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004012 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004013 if (D->hasAttr<NoDebugAttr>())
4014 return;
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004015
4016 // If we already created a DIGlobalVariable for this declaration, just attach
4017 // it to the llvm::GlobalVariable.
4018 auto Cached = DeclCache.find(D->getCanonicalDecl());
4019 if (Cached != DeclCache.end())
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004020 return Var->addDebugInfo(
4021 cast<llvm::DIGlobalVariableExpression>(Cached->second));
Adrian Prantl338ef7a2016-11-09 00:42:03 +00004022
Guy Benyei11169dd2012-12-18 14:30:41 +00004023 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004024 llvm::DIFile *Unit = nullptr;
4025 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00004026 unsigned LineNo;
4027 StringRef DeclName, LinkageName;
4028 QualType T;
4029 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004030
4031 // Attempt to store one global variable for the declaration - even if we
4032 // emit a lot of fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004033 llvm::DIGlobalVariableExpression *GVE = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00004034
4035 // If this is an anonymous union then we'll want to emit a global
4036 // variable for each member of the anonymous union so that it's possible
4037 // to find the name of any field in the union.
4038 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00004039 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00004040 assert(RD->isAnonymousStructOrUnion() &&
4041 "unnamed non-anonymous struct or union?");
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004042 GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00004043 } else {
Victor Leschuka7ece032016-10-20 00:13:19 +00004044 auto Align = getDeclAlignIfRequired(D, CGM.getContext());
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004045
4046 SmallVector<int64_t, 4> Expr;
4047 unsigned AddressSpace =
4048 CGM.getContext().getTargetAddressSpace(D->getType());
4049 AppendAddressSpaceXDeref(AddressSpace, Expr);
4050
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004051 GVE = DBuilder.createGlobalVariableExpression(
Eric Christophercab9fae2014-04-10 05:20:00 +00004052 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +00004053 Var->hasLocalLinkage(),
4054 Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
Victor Leschuka7ece032016-10-20 00:13:19 +00004055 getOrCreateStaticDataMemberDeclarationOrNull(D), Align);
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004056 Var->addDebugInfo(GVE);
Eric Christophercab9fae2014-04-10 05:20:00 +00004057 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004058 DeclCache[D->getCanonicalDecl()].reset(GVE);
Guy Benyei11169dd2012-12-18 14:30:41 +00004059}
4060
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004061void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004062 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00004063 if (VD->hasAttr<NoDebugAttr>())
4064 return;
Victor Leschuka7ece032016-10-20 00:13:19 +00004065 auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004066 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004067 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004068 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004069 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
David Majnemer58ed0f32016-07-17 00:39:12 +00004070 if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4071 const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004072 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4073 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
4074 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004075 // Do not use global variables for enums.
4076 //
4077 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004078 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00004079 return;
David Blaikiea15565562014-04-04 20:56:17 +00004080 // Do not emit separate definitions for function local const/statics.
4081 if (isa<FunctionDecl>(VD->getDeclContext()))
4082 return;
David Blaikiebb113912014-04-05 07:23:17 +00004083 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00004084 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004085 if (VarD->isStaticDataMember()) {
4086 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004087 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00004088 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00004089 //
4090 // FIXME: This is probably unnecessary, since Ty should reference RD
4091 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00004092 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00004093 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00004094 return;
4095 }
4096
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004097 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00004098
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004099 auto &GV = DeclCache[VD];
4100 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00004101 return;
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00004102 llvm::DIExpression *InitExpr = nullptr;
Peter Collingbourneb7013632016-12-16 22:10:52 +00004103 if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4104 // FIXME: Add a representation for integer constants wider than 64 bits.
4105 if (Init.isInt())
4106 InitExpr =
4107 DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4108 else if (Init.isFloat())
4109 InitExpr = DBuilder.createConstantValueExpression(
4110 Init.getFloat().bitcastToAPInt().getZExtValue());
4111 }
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004112 GV.reset(DBuilder.createGlobalVariableExpression(
David Blaikie506a7452014-04-05 07:46:57 +00004113 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Victor Leschuka7ece032016-10-20 00:13:19 +00004114 true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
4115 Align));
David Blaikiebd483762013-05-20 04:58:53 +00004116}
4117
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004118llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00004119 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00004120 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00004121 llvm::DIScope *Mod = getParentModuleOrNull(D);
4122 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004123}
4124
David Blaikie9f88fe82013-04-22 06:13:21 +00004125void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004126 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004127 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004128 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthyab1e7862016-07-21 18:43:20 +00004129 if (!NSDecl->isAnonymousNamespace() ||
4130 CGM.getCodeGenOpts().DebugExplicitImport) {
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004131 auto Loc = UD.getLocation();
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004132 DBuilder.createImportedModule(
4133 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004134 getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00004135 }
David Blaikie9f88fe82013-04-22 06:13:21 +00004136}
4137
David Blaikiebd483762013-05-20 04:58:53 +00004138void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004139 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00004140 return;
4141 assert(UD.shadow_size() &&
4142 "We shouldn't be codegening an invalid UsingDecl containing no decls");
4143 // Emitting one decl is sufficient - debuggers can detect that this is an
4144 // overloaded name & provide lookup for all the overloads.
4145 const UsingShadowDecl &USD = **UD.shadow_begin();
David Blaikie2a58a182016-08-05 19:03:01 +00004146
4147 // FIXME: Skip functions with undeduced auto return type for now since we
4148 // don't currently have the plumbing for separate declarations & definitions
4149 // of free functions and mismatched types (auto in the declaration, concrete
4150 // return type in the definition)
4151 if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4152 if (const auto *AT =
4153 FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4154 if (AT->getDeducedType().isNull())
4155 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004156 if (llvm::DINode *Target =
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004157 getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4158 auto Loc = USD.getLocation();
David Blaikiebd483762013-05-20 04:58:53 +00004159 DBuilder.createImportedDeclaration(
4160 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004161 getOrCreateFile(Loc), getLineNumber(Loc));
4162 }
David Blaikiebd483762013-05-20 04:58:53 +00004163}
4164
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004165void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00004166 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4167 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00004168 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00004169 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004170 auto Loc = ID.getLocation();
Adrian Prantl8a634c12015-12-18 19:44:31 +00004171 DBuilder.createImportedDeclaration(
4172 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004173 getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4174 getLineNumber(Loc));
Adrian Prantl8a634c12015-12-18 19:44:31 +00004175 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00004176}
4177
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004178llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00004179CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004180 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00004181 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004182 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00004183 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004184 return cast<llvm::DIImportedEntity>(VH);
4185 llvm::DIImportedEntity *R;
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004186 auto Loc = NA.getLocation();
David Majnemer58ed0f32016-07-17 00:39:12 +00004187 if (const auto *Underlying =
David Blaikief121b932013-05-20 22:50:41 +00004188 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4189 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00004190 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004191 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004192 EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4193 getLineNumber(Loc), NA.getName());
David Blaikief121b932013-05-20 22:50:41 +00004194 else
David Blaikie551fb0a2014-04-06 06:30:03 +00004195 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00004196 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
Adrian Prantlddb8e062017-05-12 16:23:53 +00004197 getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
Adrian Prantl5649b0e2017-07-19 00:09:58 +00004198 getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004199 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00004200 return R;
4201}
4202
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004203llvm::DINamespace *
Adrian Prantlddb8e062017-05-12 16:23:53 +00004204CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4205 // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4206 // if necessary, and this way multiple declarations of the same namespace in
4207 // different parent modules stay distinct.
4208 auto I = NamespaceCache.find(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004209 if (I != NamespaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004210 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00004211
Adrian Prantl6ec370a2015-09-10 18:39:45 +00004212 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Adrian Prantld8870552017-05-11 22:59:19 +00004213 // Don't trust the context if it is a DIModule (see comment above).
Adrian Prantlddb8e062017-05-12 16:23:53 +00004214 llvm::DINamespace *NS =
4215 DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4216 NamespaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00004217 return NS;
4218}
4219
Adrian Prantla5206ce2015-09-22 23:26:43 +00004220void CGDebugInfo::setDwoId(uint64_t Signature) {
4221 assert(TheCU && "no main compile unit");
4222 TheCU->setDWOId(Signature);
4223}
4224
4225
Guy Benyei11169dd2012-12-18 14:30:41 +00004226void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00004227 // Creating types might create further types - invalidating the current
4228 // element and the size(), so don't cache/reference them.
4229 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4230 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004231 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00004232 ? CreateTypeDefinition(E.Type, E.Unit)
4233 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004234 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00004235 }
4236
Jonas Devlieghered8ba8ae2018-06-27 17:31:59 +00004237 if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4238 // Add methods to interface.
4239 for (auto P : ObjCMethodCache) {
4240 if (P.second.empty())
4241 continue;
4242
4243 QualType QTy(P.first->getTypeForDecl(), 0);
4244 auto It = TypeCache.find(QTy.getAsOpaquePtr());
4245 assert(It != TypeCache.end());
4246
4247 llvm::DICompositeType *InterfaceDecl =
4248 cast<llvm::DICompositeType>(It->second);
4249
4250 SmallVector<llvm::Metadata *, 16> EltTys;
4251 auto CurrenetElts = InterfaceDecl->getElements();
4252 EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4253 for (auto &MD : P.second)
4254 EltTys.push_back(MD);
4255 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4256 DBuilder.replaceArrays(InterfaceDecl, Elements);
4257 }
4258 }
4259
David Blaikief427b002014-05-06 03:42:01 +00004260 for (auto p : ReplaceMap) {
4261 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004262 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00004263 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00004264
David Blaikief427b002014-05-06 03:42:01 +00004265 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00004266 assert(it != TypeCache.end());
4267 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00004268
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00004269 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4270 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00004271 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00004272
Frederic Rissd253ed62014-11-18 03:40:51 +00004273 for (const auto &p : FwdDeclReplaceMap) {
4274 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004275 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004276 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00004277
4278 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00004279 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00004280 // with ourselves, that will destroy the temporary MDNode and
4281 // replace it with a standard one, avoiding leaking memory.
4282 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004283 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00004284 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004285 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00004286
Adrian Prantl5f4740d2016-12-20 02:10:02 +00004287 if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4288 Repl = GVE->getVariable();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00004289 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00004290 }
4291
Adrian Prantl73409ce2013-03-11 18:33:46 +00004292 // We keep our own list of retained types, because we need to look
4293 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00004294 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00004295 if (auto MD = TypeCache[RT])
4296 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00004297
Guy Benyei11169dd2012-12-18 14:30:41 +00004298 DBuilder.finalize();
4299}
David Blaikie66088d52014-09-24 17:01:27 +00004300
4301void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00004302 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00004303 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004304
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00004305 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00004306 // Don't ignore in case of explicit cast where it is referenced indirectly.
4307 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00004308}
Amara Emerson652795d2016-11-10 14:44:30 +00004309
4310llvm::DebugLoc CGDebugInfo::SourceLocToDebugLoc(SourceLocation Loc) {
4311 if (LexicalBlockStack.empty())
4312 return llvm::DebugLoc();
4313
4314 llvm::MDNode *Scope = LexicalBlockStack.back();
4315 return llvm::DebugLoc::get(
4316 getLineNumber(Loc), getColumnNumber(Loc), Scope);
4317}