blob: 5e829cc1229d5e8b7eb64d6420a1c358aab84663 [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 Majnemerb4b671e2016-06-30 03:01:59 +000016#include "CGRecordLayout.h"
David Blaikie38079fd2013-05-10 21:53:14 +000017#include "CGCXXABI.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000018#include "CGObjCRuntime.h"
19#include "CodeGenFunction.h"
20#include "CodeGenModule.h"
21#include "clang/AST/ASTContext.h"
22#include "clang/AST/DeclFriend.h"
23#include "clang/AST/DeclObjC.h"
24#include "clang/AST/DeclTemplate.h"
25#include "clang/AST/Expr.h"
26#include "clang/AST/RecordLayout.h"
27#include "clang/Basic/FileManager.h"
28#include "clang/Basic/SourceManager.h"
29#include "clang/Basic/Version.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000030#include "clang/Frontend/CodeGenOptions.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000031#include "clang/Lex/HeaderSearchOptions.h"
Adrian Prantl9402cef2015-09-20 16:51:35 +000032#include "clang/Lex/ModuleMap.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000033#include "clang/Lex/PreprocessorOptions.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000034#include "llvm/ADT/SmallVector.h"
35#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000036#include "llvm/IR/Constants.h"
37#include "llvm/IR/DataLayout.h"
38#include "llvm/IR/DerivedTypes.h"
39#include "llvm/IR/Instructions.h"
40#include "llvm/IR/Intrinsics.h"
41#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000042#include "llvm/Support/FileSystem.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000043#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000044using namespace clang;
45using namespace clang::CodeGen;
46
47CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000048 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
Adrian Prantl6b21ab22015-08-27 19:46:20 +000049 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
Eric Christopher324bbbd2013-07-14 21:12:44 +000050 DBuilder(CGM.getModule()) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000051 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
52 DebugPrefixMap[KV.first] = KV.second;
Guy Benyei11169dd2012-12-18 14:30:41 +000053 CreateCompileUnit();
54}
55
56CGDebugInfo::~CGDebugInfo() {
57 assert(LexicalBlockStack.empty() &&
58 "Region stack mismatch, stack not empty!");
59}
60
David Blaikie66e41972015-01-14 07:38:27 +000061ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
David Blaikie835afb22015-01-21 23:08:17 +000062 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000063 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +000064 init(TemporaryLocation);
65}
66
Adrian Prantl39428e72015-02-03 18:40:42 +000067ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000068 bool DefaultToEmpty,
Adrian Prantl39428e72015-02-03 18:40:42 +000069 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000070 : CGF(&CGF) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000071 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000072}
73
74void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Adrian Prantl95b24e92015-02-03 20:00:54 +000075 bool DefaultToEmpty) {
David Blaikied7057d92015-08-12 23:49:57 +000076 auto *DI = CGF->getDebugInfo();
77 if (!DI) {
78 CGF = nullptr;
79 return;
David Blaikie66e41972015-01-14 07:38:27 +000080 }
David Blaikied7057d92015-08-12 23:49:57 +000081
82 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
83 if (TemporaryLocation.isValid()) {
84 DI->EmitLocation(CGF->Builder, TemporaryLocation);
85 return;
86 }
87
88 if (DefaultToEmpty) {
89 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
90 return;
91 }
92
93 // Construct a location that has a valid scope, but no line info.
94 assert(!DI->LexicalBlockStack.empty());
95 CGF->Builder.SetCurrentDebugLocation(
96 llvm::DebugLoc::get(0, 0, DI->LexicalBlockStack.back()));
Adrian Prantl2e0637f2013-07-18 00:28:02 +000097}
98
David Blaikie9b479662015-01-25 01:19:10 +000099ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
David Blaikied7057d92015-08-12 23:49:57 +0000100 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +0000101 init(E->getExprLoc());
102}
103
David Blaikie66e41972015-01-14 07:38:27 +0000104ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
David Blaikied7057d92015-08-12 23:49:57 +0000105 : CGF(&CGF) {
106 if (!CGF.getDebugInfo()) {
107 this->CGF = nullptr;
108 return;
David Blaikie66e41972015-01-14 07:38:27 +0000109 }
David Blaikied7057d92015-08-12 23:49:57 +0000110 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
111 if (Loc)
112 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +0000113}
114
115ApplyDebugLocation::~ApplyDebugLocation() {
116 // Query CGF so the location isn't overwritten when location updates are
117 // temporarily disabled (for C++ default function arguments)
David Blaikied7057d92015-08-12 23:49:57 +0000118 if (CGF)
119 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000120}
121
Guy Benyei11169dd2012-12-18 14:30:41 +0000122void CGDebugInfo::setLocation(SourceLocation Loc) {
123 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000124 if (Loc.isInvalid())
125 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000126
127 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
128
129 // If we've changed files in the middle of a lexical scope go ahead
130 // and create a new lexical scope with file node if it's different
131 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000132 if (LexicalBlockStack.empty())
133 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000134
135 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000136 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000137 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000138
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000139 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000140 return;
141
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000142 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000143 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000144 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
145 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000146 } else if (isa<llvm::DILexicalBlock>(Scope) ||
147 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000148 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000149 LexicalBlockStack.emplace_back(
150 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000151 }
152}
153
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000154llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000155 llvm::DIScope *Mod = getParentModuleOrNull(D);
156 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
157 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000158}
159
160llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
161 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000162 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000163 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000164
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000165 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000166 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000167 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000168 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000169 }
170
171 // Check namespace.
172 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000173 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000174
David Blaikiebfa52742013-04-19 06:56:38 +0000175 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
176 if (!RDecl->isDependentType())
177 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000178 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000179 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000180}
181
Guy Benyei11169dd2012-12-18 14:30:41 +0000182StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000183 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000184 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000185 FunctionTemplateSpecializationInfo *Info =
186 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000187
Reid Kleckner31abd802016-06-30 17:41:31 +0000188 // Emit the unqualified name in normal operation. LLVM and the debugger can
189 // compute the fully qualified name from the scope chain. If we're only
190 // emitting line table info, there won't be any scope chains, so emit the
191 // fully qualified name here so that stack traces are more accurate.
192 // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
193 // evaluating the size impact.
194 bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
195 CGM.getCodeGenOpts().EmitCodeView;
196
197 if (!Info && FII && !UseQualifiedName)
Guy Benyei11169dd2012-12-18 14:30:41 +0000198 return FII->getName();
199
Benjamin Kramer9170e912013-02-22 15:46:01 +0000200 SmallString<128> NS;
201 llvm::raw_svector_ostream OS(NS);
Reid Kleckner60103382015-12-16 02:04:40 +0000202 PrintingPolicy Policy(CGM.getLangOpts());
Reid Kleckner829398e2016-06-17 16:11:20 +0000203 Policy.MSVCFormatting = CGM.getCodeGenOpts().EmitCodeView;
Reid Kleckner31abd802016-06-30 17:41:31 +0000204 if (!UseQualifiedName)
205 FD->printName(OS);
206 else
207 FD->printQualifiedName(OS, Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000208
Reid Kleckner829398e2016-06-17 16:11:20 +0000209 // Add any template specialization args.
210 if (Info) {
211 const TemplateArgumentList *TArgs = Info->TemplateArguments;
212 const TemplateArgument *Args = TArgs->data();
213 unsigned NumArgs = TArgs->size();
214 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
215 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000216 }
217
218 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000219 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000220}
221
222StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
223 SmallString<256> MethodName;
224 llvm::raw_svector_ostream OS(MethodName);
225 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
226 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000227 if (const ObjCImplementationDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000228 dyn_cast<const ObjCImplementationDecl>(DC)) {
229 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000230 } else if (const ObjCInterfaceDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000231 dyn_cast<const ObjCInterfaceDecl>(DC)) {
232 OS << OID->getName();
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000233 } else if (const ObjCCategoryDecl *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
234 if (OC->IsClassExtension()) {
235 OS << OC->getClassInterface()->getName();
236 } else {
237 OS << ((const NamedDecl *)OC)->getIdentifier()->getNameStart() << '('
238 << OC->getIdentifier()->getNameStart() << ')';
239 }
Eric Christopherb2a008c2013-05-16 00:45:12 +0000240 } else if (const ObjCCategoryImplDecl *OCD =
Eric Christophere7b87e52014-10-26 23:40:33 +0000241 dyn_cast<const ObjCCategoryImplDecl>(DC)) {
242 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
243 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000244 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000245 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000246 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000247 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000248 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000249 ClassTy.print(OS, PrintingPolicy(LangOptions()));
250 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000251 }
252 OS << ' ' << OMD->getSelector().getAsString() << ']';
253
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000254 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000255}
256
Guy Benyei11169dd2012-12-18 14:30:41 +0000257StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000258 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000259}
260
Eric Christophere7b87e52014-10-26 23:40:33 +0000261StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Majnemerbc5976a2016-07-01 23:12:54 +0000262 if (isa<ClassTemplateSpecializationDecl>(RD)) {
263 SmallString<128> Name;
David Blaikie65813a32014-04-02 18:21:09 +0000264 llvm::raw_svector_ostream OS(Name);
265 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
266 /*Qualified*/ false);
David Majnemerbc5976a2016-07-01 23:12:54 +0000267
268 // Copy this name on the side and use its reference.
269 return internString(Name);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000270 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000271
David Majnemerbc5976a2016-07-01 23:12:54 +0000272 // quick optimization to avoid having to intern strings that are already
273 // stored reliably elsewhere
274 if (const IdentifierInfo *II = RD->getIdentifier())
275 return II->getName();
276
277 // The CodeView printer in LLVM wants to see the names of unnamed types: it is
278 // used to reconstruct the fully qualified type names.
279 if (CGM.getCodeGenOpts().EmitCodeView) {
280 if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
281 assert(RD->getDeclContext() == D->getDeclContext() &&
282 "Typedef should not be in another decl context!");
283 assert(D->getDeclName().getAsIdentifierInfo() &&
284 "Typedef was not named!");
285 return D->getDeclName().getAsIdentifierInfo()->getName();
286 }
287
288 if (CGM.getLangOpts().CPlusPlus) {
289 StringRef Name;
290
291 ASTContext &Context = CGM.getContext();
292 if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
293 // Anonymous types without a name for linkage purposes have their
294 // declarator mangled in if they have one.
295 Name = DD->getName();
296 else if (const TypedefNameDecl *TND =
297 Context.getTypedefNameForUnnamedTagDecl(RD))
298 // Anonymous types without a name for linkage purposes have their
299 // associate typedef mangled in if they have one.
300 Name = TND->getName();
301
302 if (!Name.empty()) {
303 SmallString<256> UnnamedType("<unnamed-type-");
304 UnnamedType += Name;
305 UnnamedType += '>';
306 return internString(UnnamedType);
307 }
308 }
309 }
310
311 return StringRef();
Guy Benyei11169dd2012-12-18 14:30:41 +0000312}
313
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000314llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000315 if (!Loc.isValid())
316 // If Location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000317 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
318 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000319
320 SourceManager &SM = CGM.getContext().getSourceManager();
321 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
322
323 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
324 // If the location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000325 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
326 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000327
328 // Cache the results.
329 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000330 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000331
332 if (it != DIFileCache.end()) {
333 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000334 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000335 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000336 }
337
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000338 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
339 remapDIPath(getCurrentDirname()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000340
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000341 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000342 return F;
343}
344
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000345llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000346 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
347 remapDIPath(TheCU->getDirectory()));
348}
349
350std::string CGDebugInfo::remapDIPath(StringRef Path) const {
351 for (const auto &Entry : DebugPrefixMap)
352 if (Path.startswith(Entry.first))
353 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
354 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000355}
356
Guy Benyei11169dd2012-12-18 14:30:41 +0000357unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
358 if (Loc.isInvalid() && CurLoc.isInvalid())
359 return 0;
360 SourceManager &SM = CGM.getContext().getSourceManager();
361 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000362 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000363}
364
Adrian Prantlc7822422013-03-12 20:43:25 +0000365unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000366 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000367 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000368 return 0;
369
370 // If the location is invalid then use the current column.
371 if (Loc.isInvalid() && CurLoc.isInvalid())
372 return 0;
373 SourceManager &SM = CGM.getContext().getSourceManager();
374 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000375 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000376}
377
378StringRef CGDebugInfo::getCurrentDirname() {
379 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
380 return CGM.getCodeGenOpts().DebugCompilationDir;
381
382 if (!CWDName.empty())
383 return CWDName;
384 SmallString<256> CWD;
385 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000386 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000387}
388
Guy Benyei11169dd2012-12-18 14:30:41 +0000389void CGDebugInfo::CreateCompileUnit() {
390
David Blaikieaabde052014-05-14 00:29:00 +0000391 // Should we be asking the SourceManager for the main file name, instead of
392 // accepting it as an argument? This just causes the main file name to
393 // mismatch with source locations and create extra lexical scopes or
394 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
395 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
396 // because that's what the SourceManager says)
397
Guy Benyei11169dd2012-12-18 14:30:41 +0000398 // Get absolute path name.
399 SourceManager &SM = CGM.getContext().getSourceManager();
400 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
401 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000402 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000403
404 // The main file name provided via the "-main-file-name" option contains just
405 // the file name itself with no path information. This file name may have had
406 // a relative path, so we look into the actual file entry for the main
407 // file to determine the real absolute path for the file.
408 std::string MainFileDir;
409 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000410 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000411 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000412 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
413 llvm::sys::path::append(MainFileDirSS, MainFileName);
414 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000415 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000416 }
417
Ed Masteda706022014-05-07 12:49:30 +0000418 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000419 const LangOptions &LO = CGM.getLangOpts();
420 if (LO.CPlusPlus) {
421 if (LO.ObjC1)
422 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
423 else
424 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
425 } else if (LO.ObjC1) {
426 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000427 } else if (LO.RenderScript) {
428 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000429 } else if (LO.C99) {
430 LangTag = llvm::dwarf::DW_LANG_C99;
431 } else {
432 LangTag = llvm::dwarf::DW_LANG_C89;
433 }
434
435 std::string Producer = getClangFullVersion();
436
437 // Figure out which version of the ObjC runtime we have.
438 unsigned RuntimeVers = 0;
439 if (LO.ObjC1)
440 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
441
Adrian Prantl826824e2016-04-08 22:43:06 +0000442 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
443 switch (DebugKind) {
444 case codegenoptions::NoDebugInfo:
445 case codegenoptions::LocTrackingOnly:
446 EmissionKind = llvm::DICompileUnit::NoDebug;
447 break;
448 case codegenoptions::DebugLineTablesOnly:
449 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
450 break;
451 case codegenoptions::LimitedDebugInfo:
452 case codegenoptions::FullDebugInfo:
453 EmissionKind = llvm::DICompileUnit::FullDebug;
454 break;
455 }
456
Guy Benyei11169dd2012-12-18 14:30:41 +0000457 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000458 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000459 TheCU = DBuilder.createCompileUnit(
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000460 LangTag, remapDIPath(MainFileName), remapDIPath(getCurrentDirname()),
461 Producer, LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers,
Adrian Prantl826824e2016-04-08 22:43:06 +0000462 CGM.getCodeGenOpts().SplitDwarfFile, EmissionKind, 0 /* DWOid */);
Guy Benyei11169dd2012-12-18 14:30:41 +0000463}
464
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000465llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000466 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000467 StringRef BTName;
468 switch (BT->getKind()) {
469#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000470#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000471#include "clang/AST/BuiltinTypes.def"
472 case BuiltinType::Dependent:
473 llvm_unreachable("Unexpected builtin type");
474 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000475 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000476 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000477 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000478 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000479 if (!ClassTy)
480 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
481 "objc_class", TheCU,
482 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000483 return ClassTy;
484 case BuiltinType::ObjCId: {
485 // typedef struct objc_class *Class;
486 // typedef struct objc_object {
487 // Class isa;
488 // } *id;
489
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000490 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000491 return ObjTy;
492
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000493 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000494 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
495 "objc_class", TheCU,
496 getOrCreateMainFile(), 0);
497
498 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000499
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000500 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000501
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000502 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000503 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000504 0, 0, 0, 0, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000505
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000506 DBuilder.replaceArrays(
507 ObjTy,
508 DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
509 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000510 return ObjTy;
511 }
512 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000513 if (!SelTy)
514 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
515 "objc_selector", TheCU,
516 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000517 return SelTy;
518 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000519
Alexey Bader954ba212016-04-08 13:40:33 +0000520#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
521 case BuiltinType::Id: \
522 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
523 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000524#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000525 case BuiltinType::OCLSampler:
Eric Christophere7b87e52014-10-26 23:40:33 +0000526 return DBuilder.createBasicType(
527 "opencl_sampler_t", CGM.getContext().getTypeSize(BT),
528 CGM.getContext().getTypeAlign(BT), llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000529 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000530 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000531 case BuiltinType::OCLClkEvent:
532 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
533 case BuiltinType::OCLQueue:
534 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
535 case BuiltinType::OCLNDRange:
536 return getOrCreateStructPtrType("opencl_ndrange_t", OCLNDRangeDITy);
537 case BuiltinType::OCLReserveID:
538 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000539
Guy Benyei11169dd2012-12-18 14:30:41 +0000540 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000541 case BuiltinType::Char_U:
542 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
543 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000544 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000545 case BuiltinType::SChar:
546 Encoding = llvm::dwarf::DW_ATE_signed_char;
547 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000548 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000549 case BuiltinType::Char32:
550 Encoding = llvm::dwarf::DW_ATE_UTF;
551 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000552 case BuiltinType::UShort:
553 case BuiltinType::UInt:
554 case BuiltinType::UInt128:
555 case BuiltinType::ULong:
556 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000557 case BuiltinType::ULongLong:
558 Encoding = llvm::dwarf::DW_ATE_unsigned;
559 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000560 case BuiltinType::Short:
561 case BuiltinType::Int:
562 case BuiltinType::Int128:
563 case BuiltinType::Long:
564 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000565 case BuiltinType::LongLong:
566 Encoding = llvm::dwarf::DW_ATE_signed;
567 break;
568 case BuiltinType::Bool:
569 Encoding = llvm::dwarf::DW_ATE_boolean;
570 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000571 case BuiltinType::Half:
572 case BuiltinType::Float:
573 case BuiltinType::LongDouble:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000574 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000575 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000576 // FIXME: For targets where long double and __float128 have the same size,
577 // they are currently indistinguishable in the debugger without some
578 // special treatment. However, there is currently no consensus on encoding
579 // and this should be updated once a DWARF encoding exists for distinct
580 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000581 Encoding = llvm::dwarf::DW_ATE_float;
582 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000583 }
584
585 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000586 case BuiltinType::Long:
587 BTName = "long int";
588 break;
589 case BuiltinType::LongLong:
590 BTName = "long long int";
591 break;
592 case BuiltinType::ULong:
593 BTName = "long unsigned int";
594 break;
595 case BuiltinType::ULongLong:
596 BTName = "long long unsigned int";
597 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000598 default:
599 BTName = BT->getName(CGM.getLangOpts());
600 break;
601 }
602 // Bit size, align and offset of the type.
603 uint64_t Size = CGM.getContext().getTypeSize(BT);
604 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000605 return DBuilder.createBasicType(BTName, Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000606}
607
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000608llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000609 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000610 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000611 if (Ty->isComplexIntegerType())
612 Encoding = llvm::dwarf::DW_ATE_lo_user;
613
614 uint64_t Size = CGM.getContext().getTypeSize(Ty);
615 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000616 return DBuilder.createBasicType("complex", Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000617}
618
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000619llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
620 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000621 QualifierCollector Qc;
622 const Type *T = Qc.strip(Ty);
623
624 // Ignore these qualifiers for now.
625 Qc.removeObjCGCAttr();
626 Qc.removeAddressSpace();
627 Qc.removeObjCLifetime();
628
629 // We will create one Derived type for one qualifier and recurse to handle any
630 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000631 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000632 if (Qc.hasConst()) {
633 Tag = llvm::dwarf::DW_TAG_const_type;
634 Qc.removeConst();
635 } else if (Qc.hasVolatile()) {
636 Tag = llvm::dwarf::DW_TAG_volatile_type;
637 Qc.removeVolatile();
638 } else if (Qc.hasRestrict()) {
639 Tag = llvm::dwarf::DW_TAG_restrict_type;
640 Qc.removeRestrict();
641 } else {
642 assert(Qc.empty() && "Unknown type qualifier for debug info");
643 return getOrCreateType(QualType(T, 0), Unit);
644 }
645
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000646 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000647
648 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
649 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000650 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000651}
652
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000653llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
654 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000655
656 // The frontend treats 'id' as a typedef to an ObjCObjectType,
657 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
658 // debug info, we want to emit 'id' in both cases.
659 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000660 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000661
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000662 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
663 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000664}
665
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000666llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
667 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000668 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000669 Ty->getPointeeType(), Unit);
670}
671
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000672/// \return whether a C++ mangling exists for the type defined by TD.
673static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
674 switch (TheCU->getSourceLanguage()) {
675 case llvm::dwarf::DW_LANG_C_plus_plus:
676 return true;
677 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
678 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
679 default:
680 return false;
681 }
682}
683
Manman Rene0064d82013-08-29 23:19:58 +0000684/// In C++ mode, types have linkage, so we can rely on the ODR and
685/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000686static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
687 CodeGenModule &CGM,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000688 llvm::DICompileUnit *TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000689 SmallString<256> FullName;
Manman Rene0064d82013-08-29 23:19:58 +0000690 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000691
692 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
Manman Rene0064d82013-08-29 23:19:58 +0000693 return FullName;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000694
Manman Rene0064d82013-08-29 23:19:58 +0000695 // TODO: This is using the RTTI name. Is there a better way to get
696 // a unique string for a type?
697 llvm::raw_svector_ostream Out(FullName);
698 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Manman Rene0064d82013-08-29 23:19:58 +0000699 return FullName;
700}
701
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000702/// \return the approproate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000703static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
704 llvm::dwarf::Tag Tag;
705 if (RD->isStruct() || RD->isInterface())
706 Tag = llvm::dwarf::DW_TAG_structure_type;
707 else if (RD->isUnion())
708 Tag = llvm::dwarf::DW_TAG_union_type;
709 else {
710 // FIXME: This could be a struct type giving a default visibility different
711 // than C++ class type, but needs llvm metadata changes first.
712 assert(RD->isClass());
713 Tag = llvm::dwarf::DW_TAG_class_type;
714 }
715 return Tag;
716}
717
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000718llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000719CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000720 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000721 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000722 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
723 return cast<llvm::DICompositeType>(T);
724 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000725 unsigned Line = getLineNumber(RD->getLocation());
726 StringRef RDName = getClassName(RD);
727
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000728 uint64_t Size = 0;
729 uint64_t Align = 0;
730
731 const RecordDecl *D = RD->getDefinition();
732 if (D && D->isCompleteDefinition()) {
733 Size = CGM.getContext().getTypeSize(Ty);
734 Align = CGM.getContext().getTypeAlign(Ty);
735 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000736
737 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000738 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000739 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000740 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000741 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000742 ReplaceMap.emplace_back(
743 std::piecewise_construct, std::make_tuple(Ty),
744 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000745 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000746}
747
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000748llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000749 const Type *Ty,
750 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000751 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000752 // Bit size, align and offset of the type.
753 // Size is always the size of a pointer. We can't use getTypeSize here
754 // because that does not return the correct value for references.
755 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000756 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000757 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
758
Keno Fischer87842f32015-11-16 09:04:13 +0000759 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
760 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
761 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
762 Size, Align);
763 else
764 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
765 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000766}
767
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000768llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
769 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000770 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000771 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000772 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
773 TheCU, getOrCreateMainFile(), 0);
774 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
775 Cache = DBuilder.createPointerType(Cache, Size);
776 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000777}
778
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000779llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
780 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000781 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000782 QualType FType;
783 uint64_t FieldSize, FieldOffset;
784 unsigned FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000785 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000786
787 FieldOffset = 0;
788 FType = CGM.getContext().UnsignedLongTy;
789 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
790 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
791
792 Elements = DBuilder.getOrCreateArray(EltTys);
793 EltTys.clear();
794
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000795 unsigned Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000796 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000797
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000798 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000799 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000800 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000801
802 // Bit size, align and offset of the type.
803 uint64_t Size = CGM.getContext().getTypeSize(Ty);
804
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000805 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000806
807 FieldOffset = 0;
808 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
809 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
810 FType = CGM.getContext().IntTy;
811 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
812 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000813 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000814 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
815
816 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000817 FieldSize = CGM.getContext().getTypeSize(Ty);
818 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Adrian Prantl498fff62015-07-06 21:31:35 +0000819 EltTys.push_back(DBuilder.createMemberType(Unit, "__descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000820 FieldSize, FieldAlign, FieldOffset,
821 0, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000822
823 FieldOffset += FieldSize;
824 Elements = DBuilder.getOrCreateArray(EltTys);
825
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000826 // The __block_literal_generic structs are marked with a special
827 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
828 // the debugger needs to know about. To allow type uniquing, emit
829 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000830 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000831 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000832 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000833
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000834 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000835}
836
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000837llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
838 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000839 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000840 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000841
842 SmallString<128> NS;
843 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000844 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
845 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000846
847 TemplateSpecializationType::PrintTemplateArgumentList(
848 OS, Ty->getArgs(), Ty->getNumArgs(),
849 CGM.getContext().getPrintingPolicy());
850
Eric Christophere7b87e52014-10-26 23:40:33 +0000851 TypeAliasDecl *AliasDecl = cast<TypeAliasTemplateDecl>(
852 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000853
854 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000855 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
856 getLineNumber(Loc),
857 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000858}
859
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000860llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
861 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000862 // We don't set size information, but do specify where the typedef was
863 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +0000864 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000865
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000866 // Typedefs are derived from some other type.
867 return DBuilder.createTypedef(
868 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
869 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +0000870 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000871}
872
Reid Klecknerf00f8032016-06-08 20:41:54 +0000873static unsigned getDwarfCC(CallingConv CC) {
874 switch (CC) {
875 case CC_C:
876 // Avoid emitting DW_AT_calling_convention if the C convention was used.
877 return 0;
878
879 case CC_X86StdCall:
880 return llvm::dwarf::DW_CC_BORLAND_stdcall;
881 case CC_X86FastCall:
882 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
883 case CC_X86ThisCall:
884 return llvm::dwarf::DW_CC_BORLAND_thiscall;
885 case CC_X86VectorCall:
886 return llvm::dwarf::DW_CC_LLVM_vectorcall;
887 case CC_X86Pascal:
888 return llvm::dwarf::DW_CC_BORLAND_pascal;
889
890 // FIXME: Create new DW_CC_ codes for these calling conventions.
891 case CC_X86_64Win64:
892 case CC_X86_64SysV:
893 case CC_AAPCS:
894 case CC_AAPCS_VFP:
895 case CC_IntelOclBicc:
896 case CC_SpirFunction:
Nikolay Haustov8c6538b2016-06-30 09:06:33 +0000897 case CC_OpenCLKernel:
Reid Klecknerf00f8032016-06-08 20:41:54 +0000898 case CC_Swift:
899 case CC_PreserveMost:
900 case CC_PreserveAll:
901 return 0;
902 }
903 return 0;
904}
905
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000906llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
907 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000908 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000909
910 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000911 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000912
913 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000914 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000915 if (isa<FunctionNoProtoType>(Ty))
916 EltTys.push_back(DBuilder.createUnspecifiedParameter());
917 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000918 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
919 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000920 if (FPT->isVariadic())
921 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000922 }
923
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000924 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Reid Klecknerf00f8032016-06-08 20:41:54 +0000925 return DBuilder.createSubroutineType(EltTypeArray, 0,
926 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000927}
928
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000929/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000930/// As an optimization, return 0 if the access specifier equals the
931/// default for the containing type.
932static unsigned getAccessFlag(AccessSpecifier Access, const RecordDecl *RD) {
933 AccessSpecifier Default = clang::AS_none;
934 if (RD && RD->isClass())
935 Default = clang::AS_private;
936 else if (RD && (RD->isStruct() || RD->isUnion()))
937 Default = clang::AS_public;
938
939 if (Access == Default)
940 return 0;
941
Eric Christophere7b87e52014-10-26 23:40:33 +0000942 switch (Access) {
943 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000944 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +0000945 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000946 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +0000947 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000948 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +0000949 case clang::AS_none:
950 return 0;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000951 }
952 llvm_unreachable("unexpected access enumerator");
953}
Guy Benyei11169dd2012-12-18 14:30:41 +0000954
David Majnemerb4b671e2016-06-30 03:01:59 +0000955llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
956 llvm::DIScope *RecordTy,
957 const RecordDecl *RD) {
958 StringRef Name = BitFieldDecl->getName();
959 QualType Ty = BitFieldDecl->getType();
960 SourceLocation Loc = BitFieldDecl->getLocation();
961 llvm::DIFile *VUnit = getOrCreateFile(Loc);
962 llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
963
964 // Get the location for the field.
965 llvm::DIFile *File = getOrCreateFile(Loc);
966 unsigned Line = getLineNumber(Loc);
967
968 const CGBitFieldInfo &BitFieldInfo =
969 CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
970 uint64_t SizeInBits = BitFieldInfo.Size;
971 assert(SizeInBits > 0 && "found named 0-width bitfield");
972 unsigned AlignInBits = CGM.getContext().getTypeAlign(Ty);
973 uint64_t StorageOffsetInBits =
974 CGM.getContext().toBits(BitFieldInfo.StorageOffset);
975 uint64_t OffsetInBits = StorageOffsetInBits + BitFieldInfo.Offset;
976 unsigned Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
977 return DBuilder.createBitFieldMemberType(
978 RecordTy, Name, File, Line, SizeInBits, AlignInBits, OffsetInBits,
979 StorageOffsetInBits, Flags, DebugType);
980}
981
982llvm::DIType *
983CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
984 AccessSpecifier AS, uint64_t offsetInBits,
985 llvm::DIFile *tunit, llvm::DIScope *scope,
986 const RecordDecl *RD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000987 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000988
989 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000990 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000991 unsigned line = getLineNumber(loc);
992
David Majnemer34b57492014-07-30 01:30:47 +0000993 uint64_t SizeInBits = 0;
994 unsigned AlignInBits = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000995 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +0000996 TypeInfo TI = CGM.getContext().getTypeInfo(type);
997 SizeInBits = TI.Width;
998 AlignInBits = TI.Align;
Guy Benyei11169dd2012-12-18 14:30:41 +0000999 }
1000
Adrian Prantl21361fb2014-08-29 22:44:27 +00001001 unsigned flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +00001002 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
1003 AlignInBits, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001004}
1005
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001006void CGDebugInfo::CollectRecordLambdaFields(
1007 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001008 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +00001009 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1010 // has the name and the location of the variable so we should iterate over
1011 // both concurrently.
1012 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1013 RecordDecl::field_iterator Field = CXXDecl->field_begin();
1014 unsigned fieldno = 0;
1015 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001016 E = CXXDecl->captures_end();
1017 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00001018 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +00001019 if (C.capturesVariable()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001020 SourceLocation Loc = C.getLocation();
1021 assert(!Field->isBitField() && "lambdas don't have bitfield members!");
Eric Christopher91a31902013-01-16 01:22:32 +00001022 VarDecl *V = C.getCapturedVar();
Eric Christopher91a31902013-01-16 01:22:32 +00001023 StringRef VName = V->getName();
David Majnemerb4b671e2016-06-30 03:01:59 +00001024 llvm::DIFile *VUnit = getOrCreateFile(Loc);
1025 llvm::DIType *FieldType = createFieldType(
1026 VName, Field->getType(), Loc, Field->getAccess(),
1027 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1028 elements.push_back(FieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00001029 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +00001030 // TODO: Need to handle 'this' in some way by probably renaming the
1031 // this of the lambda class and having a field member of 'this' or
1032 // by using AT_object_pointer for the function and having that be
1033 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +00001034 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001035 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +00001036 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001037 llvm::DIType *fieldType = createFieldType(
David Majnemerb4b671e2016-06-30 03:01:59 +00001038 "this", type, f->getLocation(), f->getAccess(),
Eric Christophere7b87e52014-10-26 23:40:33 +00001039 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +00001040
1041 elements.push_back(fieldType);
1042 }
1043 }
1044}
1045
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001046llvm::DIDerivedType *
1047CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00001048 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001049 // Create the descriptor for the static variable, with or without
1050 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +00001051 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001052 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1053 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +00001054
Eric Christopher91a31902013-01-16 01:22:32 +00001055 unsigned LineNumber = getLineNumber(Var->getLocation());
1056 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +00001057 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +00001058 if (Var->getInit()) {
1059 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +00001060 if (Value) {
1061 if (Value->isInt())
1062 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1063 if (Value->isFloat())
1064 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1065 }
Eric Christopher91a31902013-01-16 01:22:32 +00001066 }
1067
Adrian Prantl21361fb2014-08-29 22:44:27 +00001068 unsigned Flags = getAccessFlag(Var->getAccess(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001069 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
David Blaikieae019462013-08-15 22:50:29 +00001070 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001071 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001072 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001073}
1074
Eric Christophere7b87e52014-10-26 23:40:33 +00001075void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001076 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1077 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001078 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001079 StringRef name = field->getName();
1080 QualType type = field->getType();
1081
1082 // Ignore unnamed fields unless they're anonymous structs/unions.
1083 if (name.empty() && !type->isRecordType())
1084 return;
1085
David Majnemerb4b671e2016-06-30 03:01:59 +00001086 llvm::DIType *FieldType;
Eric Christopher91a31902013-01-16 01:22:32 +00001087 if (field->isBitField()) {
David Majnemerb4b671e2016-06-30 03:01:59 +00001088 FieldType = createBitFieldType(field, RecordTy, RD);
1089 } else {
1090 FieldType =
1091 createFieldType(name, type, field->getLocation(), field->getAccess(),
1092 OffsetInBits, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001093 }
1094
David Majnemerb4b671e2016-06-30 03:01:59 +00001095 elements.push_back(FieldType);
Eric Christopher91a31902013-01-16 01:22:32 +00001096}
1097
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001098void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001099 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001100 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001101 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001102 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1103
Eric Christopher91a31902013-01-16 01:22:32 +00001104 if (CXXDecl && CXXDecl->isLambda())
1105 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1106 else {
1107 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001108
Eric Christopher91a31902013-01-16 01:22:32 +00001109 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001110 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001111
Eric Christopher91a31902013-01-16 01:22:32 +00001112 // Static and non-static members should appear in the same order as
1113 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001114 for (const auto *I : record->decls())
1115 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001116 if (V->hasAttr<NoDebugAttr>())
1117 continue;
David Blaikiece763042013-08-20 21:49:21 +00001118 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001119 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001120 if (MI != StaticDataMemberCache.end()) {
1121 assert(MI->second &&
1122 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001123 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001124 } else {
1125 auto Field = CreateRecordStaticField(V, RecordTy, record);
1126 elements.push_back(Field);
1127 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001128 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001129 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1130 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001131
1132 // Bump field number for next field.
1133 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +00001134 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001135 }
1136}
1137
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001138llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001139CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001140 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001141 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001142 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001143 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001144 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001145 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1146 Func, Unit);
1147}
David Blaikie2aaf0652013-01-07 22:24:59 +00001148
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001149llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1150 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001151 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001152 llvm::DITypeRefArray Args(
1153 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001154 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001155 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001156
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001157 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001158
1159 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001160 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001161
David Blaikie2aaf0652013-01-07 22:24:59 +00001162 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001163 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001164 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1165 // Create pointer type directly in this case.
1166 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1167 QualType PointeeTy = ThisPtrTy->getPointeeType();
1168 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001169 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001170 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001171 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1172 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001173 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001174 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001175 // TODO: This and the artificial type below are misleading, the
1176 // types aren't artificial the argument is, but the current
1177 // metadata doesn't represent that.
1178 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1179 Elts.push_back(ThisPtrType);
1180 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001181 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001182 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001183 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1184 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001185 }
1186
1187 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001188 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1189 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001190
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001191 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001192
Adrian Prantl0630eb72013-12-18 21:48:18 +00001193 unsigned Flags = 0;
1194 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001195 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001196 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001197 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001198
Reid Klecknerf00f8032016-06-08 20:41:54 +00001199 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1200 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001201}
1202
Eric Christopherb2a008c2013-05-16 00:45:12 +00001203/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001204/// inside a function.
1205static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1206 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1207 return isFunctionLocalClass(NRD);
1208 if (isa<FunctionDecl>(RD->getDeclContext()))
1209 return true;
1210 return false;
1211}
1212
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001213llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1214 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001215 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001216 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001217
Guy Benyei11169dd2012-12-18 14:30:41 +00001218 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001219 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001220
1221 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1222 // make sense to give a single ctor/dtor a linkage name.
1223 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001224 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1225 // property to use here. It may've been intended to model "is non-external
1226 // type" but misses cases of non-function-local but non-external classes such
1227 // as those in anonymous namespaces as well as the reverse - external types
1228 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001229 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1230 MethodLinkageName = CGM.getMangledName(Method);
1231
1232 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001233 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001234 unsigned MethodLine = 0;
1235 if (!Method->isImplicit()) {
1236 MethodDefUnit = getOrCreateFile(Method->getLocation());
1237 MethodLine = getLineNumber(Method->getLocation());
1238 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001239
1240 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001241 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001242 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001243 unsigned VIndex = 0;
Reid Klecknerfb727182016-06-17 22:27:59 +00001244 unsigned Flags = 0;
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001245 int ThisAdjustment = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001246
Guy Benyei11169dd2012-12-18 14:30:41 +00001247 if (Method->isVirtual()) {
1248 if (Method->isPure())
1249 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1250 else
1251 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001252
Reid Kleckner216d0a12016-06-16 20:08:51 +00001253 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1254 // It doesn't make sense to give a virtual destructor a vtable index,
1255 // since a single destructor has two entries in the vtable.
1256 if (!isa<CXXDestructorDecl>(Method))
1257 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1258 } else {
1259 // Emit MS ABI vftable information. There is only one entry for the
1260 // deleting dtor.
1261 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1262 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1263 MicrosoftVTableContext::MethodVFTableLocation ML =
1264 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1265 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001266
1267 // CodeView only records the vftable offset in the class that introduces
1268 // the virtual method. This is possible because, unlike Itanium, the MS
1269 // C++ ABI does not include all virtual methods from non-primary bases in
1270 // the vtable for the most derived class. For example, if C inherits from
1271 // A and B, C's primary vftable will not include B's virtual methods.
1272 if (Method->begin_overridden_methods() == Method->end_overridden_methods())
1273 Flags |= llvm::DINode::FlagIntroducedVirtual;
1274
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001275 // The 'this' adjustment accounts for both the virtual and non-virtual
1276 // portions of the adjustment. Presumably the debugger only uses it when
1277 // it knows the dynamic type of an object.
1278 ThisAdjustment = CGM.getCXXABI()
1279 .getVirtualFunctionPrologueThisAdjustment(GD)
1280 .getQuantity();
Reid Kleckner216d0a12016-06-16 20:08:51 +00001281 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001282 ContainingType = RecordTy;
1283 }
1284
Guy Benyei11169dd2012-12-18 14:30:41 +00001285 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001286 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001287 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
Guy Benyei11169dd2012-12-18 14:30:41 +00001288 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1289 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001290 Flags |= llvm::DINode::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001291 } else if (const CXXConversionDecl *CXXC =
Eric Christophere7b87e52014-10-26 23:40:33 +00001292 dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001293 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001294 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001295 }
1296 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001297 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001298 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001299 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001300 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001301 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001302
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001303 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1304 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001305 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
Reid Kleckner0358cbf2016-07-01 02:41:25 +00001306 MethodTy, /*isLocalToUnit=*/false, /*isDefinition=*/false, Virtuality,
1307 VIndex, ThisAdjustment, ContainingType, Flags, CGM.getLangOpts().Optimize,
1308 TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001309
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001310 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001311
1312 return SP;
1313}
1314
Eric Christophere7b87e52014-10-26 23:40:33 +00001315void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001316 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1317 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001318
1319 // Since we want more than just the individual member decls if we
1320 // have templated functions iterate over every declaration to gather
1321 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001322 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001323 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1324 // If the member is implicit, don't add it to the member list. This avoids
1325 // the member being added to type units by LLVM, while still allowing it
1326 // to be emitted into the type declaration/reference inside the compile
1327 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001328 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001329 // FIXME: Handle Using(Shadow?)Decls here to create
1330 // DW_TAG_imported_declarations inside the class for base decls brought into
1331 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1332 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1333 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001334 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001335 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001336
1337 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1338 continue;
1339
David Blaikiefd580722014-10-06 05:18:55 +00001340 // Reuse the existing member function declaration if it exists.
1341 // It may be associated with the declaration of the type & should be
1342 // reused as we're building the definition.
1343 //
1344 // This situation can arise in the vtable-based debug info reduction where
1345 // implicit members are emitted in a non-vtable TU.
1346 auto MI = SPCache.find(Method->getCanonicalDecl());
1347 EltTys.push_back(MI == SPCache.end()
1348 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001349 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001350 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001351}
Guy Benyei11169dd2012-12-18 14:30:41 +00001352
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001353void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001354 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001355 llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001356 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001357 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001358 unsigned BFlags = 0;
1359 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001360
Guy Benyei11169dd2012-12-18 14:30:41 +00001361 const CXXRecordDecl *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001362 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001363
Aaron Ballman574705e2014-03-13 15:41:46 +00001364 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001365 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1366 // virtual base offset offset is -ve. The code generator emits dwarf
1367 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001368 BaseOffset = 0 - CGM.getItaniumVTableContext()
1369 .getVirtualBaseOffsetOffset(RD, Base)
1370 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001371 } else {
1372 // In the MS ABI, store the vbtable offset, which is analogous to the
1373 // vbase offset offset in Itanium.
1374 BaseOffset =
1375 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1376 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001377 BFlags = llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001378 } else
1379 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1380 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1381 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001382
Adrian Prantl21361fb2014-08-29 22:44:27 +00001383 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001384 llvm::DIType *DTy = DBuilder.createInheritance(
Eric Christophere7b87e52014-10-26 23:40:33 +00001385 RecordTy, getOrCreateType(BI.getType(), Unit), BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001386 EltTys.push_back(DTy);
1387 }
1388}
1389
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001390llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001391CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1392 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001393 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001394 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001395 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1396 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001397 StringRef Name;
1398 if (TPList)
1399 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001400 switch (TA.getKind()) {
1401 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001402 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001403 TemplateParams.push_back(
1404 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001405 } break;
1406 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001407 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001408 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1409 TheCU, Name, TTy,
1410 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001411 } break;
1412 case TemplateArgument::Declaration: {
1413 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001414 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001415 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001416 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001417 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001418 // Variable pointer template parameters have a value that is the address
1419 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001420 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001421 V = CGM.GetAddrOfGlobalVar(VD);
1422 // Member function pointers have special support for building them, though
1423 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001424 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001425 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001426 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001427 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001428 // Member data pointers have special handling too to compute the fixed
1429 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001430 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001431 // These five lines (& possibly the above member function pointer
1432 // handling) might be able to be refactored to use similar code in
1433 // CodeGenModule::getMemberPointerConstant
1434 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1435 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001436 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001437 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001438 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001439 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1440 TheCU, Name, TTy,
1441 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001442 } break;
1443 case TemplateArgument::NullPtr: {
1444 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001445 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001446 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001447 // Special case member data pointer null values since they're actually -1
1448 // instead of zero.
1449 if (const MemberPointerType *MPT =
1450 dyn_cast<MemberPointerType>(T.getTypePtr()))
1451 // But treat member function pointers as simple zero integers because
1452 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1453 // CodeGen grows handling for values of non-null member function
1454 // pointers then perhaps we could remove this special case and rely on
1455 // EmitNullMemberPointer for member function pointers.
1456 if (MPT->isMemberDataPointer())
1457 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1458 if (!V)
1459 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001460 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1461 TheCU, Name, TTy, cast<llvm::Constant>(V)));
David Blaikie38079fd2013-05-10 21:53:14 +00001462 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001463 case TemplateArgument::Template:
1464 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001465 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001466 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1467 break;
1468 case TemplateArgument::Pack:
1469 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1470 TheCU, Name, nullptr,
1471 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1472 break;
David Majnemer5559d472013-08-24 08:21:10 +00001473 case TemplateArgument::Expression: {
1474 const Expr *E = TA.getAsExpr();
1475 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001476 if (E->isGLValue())
1477 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001478 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001479 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001480 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001481 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1482 TheCU, Name, TTy, cast<llvm::Constant>(V->stripPointerCasts())));
David Majnemer5559d472013-08-24 08:21:10 +00001483 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001484 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001485 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001486 case TemplateArgument::Null:
1487 llvm_unreachable(
1488 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001489 }
1490 }
1491 return DBuilder.getOrCreateArray(TemplateParams);
1492}
1493
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001494llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001495CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001496 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001497 if (FD->getTemplatedKind() ==
1498 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001499 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1500 ->getTemplate()
1501 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001502 return CollectTemplateParams(
1503 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001504 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001505 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001506}
1507
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001508llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1509 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001510 // Always get the full list of parameters, not just the ones from
1511 // the specialization.
1512 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001513 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001514 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001515 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001516}
1517
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001518llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001519 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001520 return VTablePtrType;
1521
1522 ASTContext &Context = CGM.getContext();
1523
1524 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001525 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001526 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001527 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001528 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001529 llvm::DIType *vtbl_ptr_type =
Eric Christophere7b87e52014-10-26 23:40:33 +00001530 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001531 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1532 return VTablePtrType;
1533}
1534
Guy Benyei11169dd2012-12-18 14:30:41 +00001535StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001536 // Copy the gdb compatible name on the side and use its reference.
1537 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001538}
1539
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001540void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001541 SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001542 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1543
1544 // If there is a primary base then it will hold vtable info.
1545 if (RL.getPrimaryBase())
1546 return;
1547
1548 // If this class is not dynamic then there is not any vtable info to collect.
1549 if (!RD->isDynamicClass())
1550 return;
1551
1552 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001553 llvm::DIType *VPTR = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001554 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001555 llvm::DINode::FlagArtificial, getOrCreateVTablePtrType(Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001556 EltTys.push_back(VPTR);
1557}
1558
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001559llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001560 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001561 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001562 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001563 return T;
1564}
1565
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001566llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001567 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001568 return getOrCreateStandaloneType(D, Loc);
1569}
1570
1571llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1572 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001573 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001574 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001575 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001576 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001577
Adrian Prantl73409ce2013-03-11 18:33:46 +00001578 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001579 return T;
1580}
1581
David Blaikie483a9da2014-05-06 18:35:21 +00001582void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001583 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001584 return;
1585 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001586 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001587 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001588 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001589 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001590 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001591 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001592 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001593}
1594
David Blaikieb2e86eb2013-08-15 20:49:17 +00001595void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001596 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001597 !CGM.getLangOpts().CPlusPlus)
1598 completeRequiredType(RD);
1599}
1600
1601void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001602 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00001603 return;
1604
David Blaikie6943dea2013-08-20 01:28:15 +00001605 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1606 if (CXXDecl->isDynamicClass())
1607 return;
1608
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001609 if (DebugTypeExtRefs && RD->isFromASTFile())
1610 return;
1611
David Blaikieb2e86eb2013-08-15 20:49:17 +00001612 QualType Ty = CGM.getContext().getRecordType(RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001613 llvm::DIType *T = getTypeOrNull(Ty);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001614 if (T && T->isForwardDecl())
David Blaikie6943dea2013-08-20 01:28:15 +00001615 completeClassData(RD);
1616}
1617
1618void CGDebugInfo::completeClassData(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001619 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001620 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001621 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001622 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001623 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001624 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001625 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001626 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001627 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001628 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001629}
1630
David Blaikie0e716b42014-03-03 23:48:23 +00001631static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1632 CXXRecordDecl::method_iterator End) {
1633 for (; I != End; ++I)
1634 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001635 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1636 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001637 return true;
1638 return false;
1639}
1640
Adrian Prantl05fefa42016-04-25 20:52:40 +00001641/// Does a type definition exist in an imported clang module?
1642static bool isDefinedInClangModule(const RecordDecl *RD) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001643 if (!RD || !RD->isFromASTFile())
Adrian Prantl05fefa42016-04-25 20:52:40 +00001644 return false;
1645 if (!RD->isExternallyVisible() && RD->getName().empty())
1646 return false;
Adrian Prantl94913712016-04-26 23:42:43 +00001647 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1648 assert(CXXDecl->isCompleteDefinition() && "incomplete record definition");
Adrian Prantl0dabc2a2016-04-26 23:37:38 +00001649 if (CXXDecl->getTemplateSpecializationKind() != TSK_Undeclared)
1650 // Make sure the instantiation is actually in a module.
1651 if (CXXDecl->field_begin() != CXXDecl->field_end())
1652 return CXXDecl->field_begin()->isFromASTFile();
Adrian Prantl94913712016-04-26 23:42:43 +00001653 }
Adrian Prantl0dabc2a2016-04-26 23:37:38 +00001654
Adrian Prantl05fefa42016-04-25 20:52:40 +00001655 return true;
1656}
1657
Benjamin Kramer8c305922016-02-02 11:06:51 +00001658static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1659 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001660 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001661 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001662 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001663
Benjamin Kramer8c305922016-02-02 11:06:51 +00001664 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001665 return false;
1666
1667 if (!LangOpts.CPlusPlus)
1668 return false;
1669
1670 if (!RD->isCompleteDefinitionRequired())
1671 return true;
1672
1673 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1674
1675 if (!CXXDecl)
1676 return false;
1677
1678 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1679 return true;
1680
1681 TemplateSpecializationKind Spec = TSK_Undeclared;
1682 if (const ClassTemplateSpecializationDecl *SD =
1683 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1684 Spec = SD->getSpecializationKind();
1685
1686 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1687 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1688 CXXDecl->method_end()))
1689 return true;
1690
1691 return false;
1692}
1693
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001694llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001695 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001696 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001697 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1698 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001699 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001700 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001701 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001702 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001703
David Blaikieb2e86eb2013-08-15 20:49:17 +00001704 return CreateTypeDefinition(Ty);
1705}
1706
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001707llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001708 RecordDecl *RD = Ty->getDecl();
1709
Guy Benyei11169dd2012-12-18 14:30:41 +00001710 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001711 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001712
1713 // Records and classes and unions can all be recursive. To handle them, we
1714 // first generate a debug descriptor for the struct as a forward declaration.
1715 // Then (if it is a definition) we go through and get debug info for all of
1716 // its members. Finally, we create a descriptor for the complete type (which
1717 // may refer to the forward decl if the struct is recursive) and replace all
1718 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001719 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001720
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001721 const RecordDecl *D = RD->getDefinition();
1722 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001723 return FwdDecl;
1724
David Blaikieadfbf992013-08-18 16:55:33 +00001725 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1726 CollectContainingType(CXXDecl, FwdDecl);
1727
Guy Benyei11169dd2012-12-18 14:30:41 +00001728 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001729 LexicalBlockStack.emplace_back(&*FwdDecl);
1730 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001731
Guy Benyei11169dd2012-12-18 14:30:41 +00001732 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001733 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001734 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001735
1736 // Note: The split of CXXDecl information here is intentional, the
1737 // gdb tests will depend on a certain ordering at printout. The debug
1738 // information offsets are still correct if we merge them all together
1739 // though.
1740 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1741 if (CXXDecl) {
1742 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1743 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1744 }
1745
Eric Christopher91a31902013-01-16 01:22:32 +00001746 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001747 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001748 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001749 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001750
1751 LexicalBlockStack.pop_back();
1752 RegionMap.erase(Ty->getDecl());
1753
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001754 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001755 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001756
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001757 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001758 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001759 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001760
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001761 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001762 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001763}
1764
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001765llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1766 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001767 // Ignore protocols.
1768 return getOrCreateType(Ty->getBaseType(), Unit);
1769}
1770
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001771/// \return true if Getter has the default name for the property PD.
1772static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1773 const ObjCMethodDecl *Getter) {
1774 assert(PD);
1775 if (!Getter)
1776 return true;
1777
1778 assert(Getter->getDeclName().isObjCZeroArgSelector());
1779 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001780 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001781}
1782
1783/// \return true if Setter has the default name for the property PD.
1784static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1785 const ObjCMethodDecl *Setter) {
1786 assert(PD);
1787 if (!Setter)
1788 return true;
1789
1790 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001791 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001792 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001793}
1794
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001795llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1796 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001797 ObjCInterfaceDecl *ID = Ty->getDecl();
1798 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001799 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001800
Adrian Prantl50fd1a82016-04-20 23:59:32 +00001801 // Return a forward declaration if this type was imported from a clang module,
1802 // and this is not the compile unit with the implementation of the type (which
1803 // may contain hidden ivars).
1804 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
1805 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001806 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1807 ID->getName(),
1808 getDeclContextDescriptor(ID), Unit, 0);
1809
Guy Benyei11169dd2012-12-18 14:30:41 +00001810 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001811 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001812 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001813 auto RuntimeLang =
1814 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00001815
1816 // If this is just a forward declaration return a special forward-declaration
1817 // debug type since we won't be able to lay out the entire type.
1818 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001819 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001820 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001821 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001822 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
1823 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001824 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001825 return FwdDecl;
1826 }
1827
David Blaikieef8a9512014-05-05 23:23:53 +00001828 return CreateTypeDefinition(Ty, Unit);
1829}
1830
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001831llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00001832CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
1833 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00001834 // Use the Module pointer as the key into the cache. This is a
1835 // nullptr if the "Module" is a PCH, which is safe because we don't
1836 // support chained PCH debug info, so there can only be a single PCH.
1837 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001838 auto ModRef = ModuleCache.find(M);
1839 if (ModRef != ModuleCache.end())
1840 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00001841
1842 // Macro definitions that were defined with "-D" on the command line.
1843 SmallString<128> ConfigMacros;
1844 {
1845 llvm::raw_svector_ostream OS(ConfigMacros);
1846 const auto &PPOpts = CGM.getPreprocessorOpts();
1847 unsigned I = 0;
1848 // Translate the macro definitions back into a commmand line.
1849 for (auto &M : PPOpts.Macros) {
1850 if (++I > 1)
1851 OS << " ";
1852 const std::string &Macro = M.first;
1853 bool Undef = M.second;
1854 OS << "\"-" << (Undef ? 'U' : 'D');
1855 for (char c : Macro)
1856 switch (c) {
1857 case '\\' : OS << "\\\\"; break;
1858 case '"' : OS << "\\\""; break;
1859 default: OS << c;
1860 }
1861 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001862 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001863 }
Adrian Prantl66689202015-09-18 23:01:45 +00001864
Adrian Prantl835e6632015-09-24 16:10:10 +00001865 bool IsRootModule = M ? !M->Parent : true;
1866 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00001867 // PCH files don't have a signature field in the control block,
1868 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Adrian Prantl98bfc822016-01-22 19:29:41 +00001869 uint64_t Signature = Mod.getSignature() ? Mod.getSignature() : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00001870 llvm::DIBuilder DIB(CGM.getModule());
Adrian Prantl835e6632015-09-24 16:10:10 +00001871 DIB.createCompileUnit(TheCU->getSourceLanguage(), Mod.getModuleName(),
Adrian Prantl6083b082015-09-24 16:10:00 +00001872 Mod.getPath(), TheCU->getProducer(), true,
1873 StringRef(), 0, Mod.getASTFile(),
Adrian Prantl3563c552016-03-31 23:57:45 +00001874 llvm::DICompileUnit::FullDebug, Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00001875 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00001876 }
Adrian Prantl835e6632015-09-24 16:10:10 +00001877 llvm::DIModule *Parent =
1878 IsRootModule ? nullptr
1879 : getOrCreateModuleRef(
1880 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
1881 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00001882 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00001883 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
1884 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001885 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00001886 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001887}
1888
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001889llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
1890 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00001891 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001892 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00001893 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001894 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001895
1896 // Bit size, align and offset of the type.
1897 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1898 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1899
1900 unsigned Flags = 0;
1901 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001902 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00001903
Adrian Prantlfd696112015-10-01 00:48:51 +00001904 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001905 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00001906 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
1907 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001908
David Blaikieef8a9512014-05-05 23:23:53 +00001909 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001910 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001911
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001912 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001913 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001914 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001915
1916 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001917 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001918
1919 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1920 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001921 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001922 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001923 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001924 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001925
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001926 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00001927 EltTys.push_back(InhTag);
1928 }
1929
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001930 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00001931 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001932 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001933 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001934 unsigned PLine = getLineNumber(Loc);
1935 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1936 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001937 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
1938 PD->getName(), PUnit, PLine,
1939 hasDefaultGetterName(PD, Getter) ? ""
1940 : getSelectorName(PD->getGetterName()),
1941 hasDefaultSetterName(PD, Setter) ? ""
1942 : getSelectorName(PD->getSetterName()),
1943 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001944 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00001945 };
1946 {
1947 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00001948 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00001949 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00001950 PropertySet.insert(PD->getIdentifier());
1951 AddProperty(PD);
1952 }
Manman Renefe1bac2016-01-27 20:00:32 +00001953 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00001954 // Don't emit duplicate metadata for properties that were already in a
1955 // class extension.
1956 if (!PropertySet.insert(PD->getIdentifier()).second)
1957 continue;
1958 AddProperty(PD);
1959 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001960 }
1961
1962 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1963 unsigned FieldNo = 0;
1964 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1965 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001966 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001967 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001968 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001969
Guy Benyei11169dd2012-12-18 14:30:41 +00001970 StringRef FieldName = Field->getName();
1971
1972 // Ignore unnamed fields.
1973 if (FieldName.empty())
1974 continue;
1975
1976 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001977 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001978 unsigned FieldLine = getLineNumber(Field->getLocation());
1979 QualType FType = Field->getType();
1980 uint64_t FieldSize = 0;
1981 unsigned FieldAlign = 0;
1982
1983 if (!FType->isIncompleteArrayType()) {
1984
1985 // Bit size, align and offset of the type.
1986 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001987 ? Field->getBitWidthValue(CGM.getContext())
1988 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001989 FieldAlign = CGM.getContext().getTypeAlign(FType);
1990 }
1991
1992 uint64_t FieldOffset;
1993 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1994 // We don't know the runtime offset of an ivar if we're using the
1995 // non-fragile ABI. For bitfields, use the bit offset into the first
1996 // byte of storage of the bitfield. For other fields, use zero.
1997 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001998 FieldOffset =
1999 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00002000 FieldOffset %= CGM.getContext().getCharWidth();
2001 } else {
2002 FieldOffset = 0;
2003 }
2004 } else {
2005 FieldOffset = RL.getFieldOffset(FieldNo);
2006 }
2007
2008 unsigned Flags = 0;
2009 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002010 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00002011 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002012 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00002013 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002014 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00002015
Craig Topper8a13c412014-05-21 05:09:00 +00002016 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002017 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00002018 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00002019 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002020 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00002021 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002022 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00002023 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002024 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2025 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00002026 PropertyNode = DBuilder.createObjCProperty(
2027 PD->getName(), PUnit, PLine,
2028 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
2029 PD->getGetterName()),
2030 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
2031 PD->getSetterName()),
2032 PD->getPropertyAttributes(),
2033 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00002034 }
2035 }
2036 }
Eric Christophere7b87e52014-10-26 23:40:33 +00002037 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2038 FieldSize, FieldAlign, FieldOffset, Flags,
2039 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00002040 EltTys.push_back(FieldTy);
2041 }
2042
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002043 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002044 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00002045
Guy Benyei11169dd2012-12-18 14:30:41 +00002046 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00002047 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002048}
2049
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002050llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2051 llvm::DIFile *Unit) {
2052 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002053 int64_t Count = Ty->getNumElements();
2054 if (Count == 0)
2055 // If number of elements are not known then this is an unbounded array.
2056 // Use Count == -1 to express such arrays.
2057 Count = -1;
2058
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002059 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002060 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00002061
2062 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2063 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
2064
2065 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2066}
2067
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002068llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002069 uint64_t Size;
2070 uint64_t Align;
2071
2072 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2073 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
2074 Size = 0;
2075 Align =
Eric Christophere7b87e52014-10-26 23:40:33 +00002076 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Guy Benyei11169dd2012-12-18 14:30:41 +00002077 } else if (Ty->isIncompleteArrayType()) {
2078 Size = 0;
2079 if (Ty->getElementType()->isIncompleteType())
2080 Align = 0;
2081 else
2082 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00002083 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002084 Size = 0;
2085 Align = 0;
2086 } else {
2087 // Size and align of the whole array, not the element type.
2088 Size = CGM.getContext().getTypeSize(Ty);
2089 Align = CGM.getContext().getTypeAlign(Ty);
2090 }
2091
2092 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2093 // interior arrays, do we care? Why aren't nested arrays represented the
2094 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002095 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002096 QualType EltTy(Ty, 0);
2097 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2098 // If the number of elements is known, then count is that number. Otherwise,
2099 // it's -1. This allows us to represent a subrange with an array of 0
2100 // elements, like this:
2101 //
2102 // struct foo {
2103 // int x[0];
2104 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002105 int64_t Count = -1; // Count == -1 is an unbounded array.
Guy Benyei11169dd2012-12-18 14:30:41 +00002106 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
2107 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002108
Guy Benyei11169dd2012-12-18 14:30:41 +00002109 // FIXME: Verify this is right for VLAs.
2110 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2111 EltTy = Ty->getElementType();
2112 }
2113
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002114 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002115
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002116 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2117 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002118}
2119
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002120llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2121 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002122 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2123 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002124}
2125
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002126llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2127 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002128 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2129 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002130}
2131
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002132llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2133 llvm::DIFile *U) {
Reid Klecknerfb727182016-06-17 22:27:59 +00002134 unsigned Flags = 0;
2135 uint64_t Size = 0;
2136
2137 if (!Ty->isIncompleteType()) {
2138 Size = CGM.getContext().getTypeSize(Ty);
2139
2140 // Set the MS inheritance model. There is no flag for the unspecified model.
2141 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2142 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2143 case MSInheritanceAttr::Keyword_single_inheritance:
2144 Flags |= llvm::DINode::FlagSingleInheritance;
2145 break;
2146 case MSInheritanceAttr::Keyword_multiple_inheritance:
2147 Flags |= llvm::DINode::FlagMultipleInheritance;
2148 break;
2149 case MSInheritanceAttr::Keyword_virtual_inheritance:
2150 Flags |= llvm::DINode::FlagVirtualInheritance;
2151 break;
2152 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2153 break;
2154 }
2155 }
2156 }
2157
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002158 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002159 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002160 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002161 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2162 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002163
2164 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002165 Ty->getPointeeType()->getAs<FunctionProtoType>();
2166 return DBuilder.createMemberPointerType(
2167 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2168 Ty->getClass(), FPT->getTypeQuals())),
2169 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002170 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002171}
2172
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002173llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002174 // Ignore the atomic wrapping
2175 // FIXME: What is the correct representation?
2176 return getOrCreateType(Ty->getValueType(), U);
2177}
2178
Xiuli Pan9c14e282016-01-09 12:53:17 +00002179llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2180 llvm::DIFile *U) {
2181 return getOrCreateType(Ty->getElementType(), U);
2182}
2183
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002184llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002185 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002186
Guy Benyei11169dd2012-12-18 14:30:41 +00002187 uint64_t Size = 0;
2188 uint64_t Align = 0;
2189 if (!ED->getTypeForDecl()->isIncompleteType()) {
2190 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2191 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2192 }
2193
Manman Rene0064d82013-08-29 23:19:58 +00002194 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2195
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002196 bool isImportedFromModule =
2197 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2198
Guy Benyei11169dd2012-12-18 14:30:41 +00002199 // If this is just a forward declaration, construct an appropriately
2200 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002201 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002202 // Note that it is possible for enums to be created as part of
2203 // their own declcontext. In this case a FwdDecl will be created
2204 // twice. This doesn't cause a problem because both FwdDecls are
2205 // entered into the ReplaceMap: finalize() will replace the first
2206 // FwdDecl with the second and then replace the second with
2207 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002208 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002209 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002210 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2211 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002212
Guy Benyei11169dd2012-12-18 14:30:41 +00002213 unsigned Line = getLineNumber(ED->getLocation());
2214 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002215 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002216 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2217 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Adrian Prantla40030f2016-02-06 01:59:09 +00002218
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002219 ReplaceMap.emplace_back(
2220 std::piecewise_construct, std::make_tuple(Ty),
2221 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002222 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002223 }
2224
David Blaikie483a9da2014-05-06 18:35:21 +00002225 return CreateTypeDefinition(Ty);
2226}
2227
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002228llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002229 const EnumDecl *ED = Ty->getDecl();
2230 uint64_t Size = 0;
2231 uint64_t Align = 0;
2232 if (!ED->getTypeForDecl()->isIncompleteType()) {
2233 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2234 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2235 }
2236
2237 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2238
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002239 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002240 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002241 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002242 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002243 Enumerators.push_back(DBuilder.createEnumerator(
2244 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002245 }
2246
2247 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002248 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002249
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002250 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002251 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002252 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002253 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002254 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2255 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2256 Line, Size, Align, EltArray, ClassTy,
2257 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002258}
2259
David Blaikie05491062013-01-21 04:37:12 +00002260static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2261 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002262 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002263 Qualifiers InnerQuals = T.getLocalQualifiers();
2264 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2265 // that is already there.
2266 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2267 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002268 QualType LastT = T;
2269 switch (T->getTypeClass()) {
2270 default:
David Blaikie05491062013-01-21 04:37:12 +00002271 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002272 case Type::TemplateSpecialization: {
2273 const auto *Spec = cast<TemplateSpecializationType>(T);
2274 if (Spec->isTypeAlias())
2275 return C.getQualifiedType(T.getTypePtr(), Quals);
2276 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002277 break;
2278 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002279 case Type::TypeOfExpr:
2280 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2281 break;
2282 case Type::TypeOf:
2283 T = cast<TypeOfType>(T)->getUnderlyingType();
2284 break;
2285 case Type::Decltype:
2286 T = cast<DecltypeType>(T)->getUnderlyingType();
2287 break;
2288 case Type::UnaryTransform:
2289 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2290 break;
2291 case Type::Attributed:
2292 T = cast<AttributedType>(T)->getEquivalentType();
2293 break;
2294 case Type::Elaborated:
2295 T = cast<ElaboratedType>(T)->getNamedType();
2296 break;
2297 case Type::Paren:
2298 T = cast<ParenType>(T)->getInnerType();
2299 break;
David Blaikie05491062013-01-21 04:37:12 +00002300 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002301 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002302 break;
2303 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002304 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002305 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002306 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002307 break;
2308 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002309
Guy Benyei11169dd2012-12-18 14:30:41 +00002310 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002311 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002312 } while (true);
2313}
2314
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002315llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002316
2317 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002318 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002319
David Blaikief427b002014-05-06 03:42:01 +00002320 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002321 if (it != TypeCache.end()) {
2322 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002323 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002324 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002325 }
2326
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002327 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002328}
2329
David Blaikie0e716b42014-03-03 23:48:23 +00002330void CGDebugInfo::completeTemplateDefinition(
2331 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002332 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002333 return;
2334
David Blaikie0e716b42014-03-03 23:48:23 +00002335 completeClassData(&SD);
2336 // In case this type has no member function definitions being emitted, ensure
2337 // it is retained
2338 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2339}
2340
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002341llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002342 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002343 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002344
2345 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002346 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002347
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002348 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002349 return T;
2350
Adrian Prantlca844182015-09-11 17:23:03 +00002351 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002352 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002353
2354 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002355 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002356
Guy Benyei11169dd2012-12-18 14:30:41 +00002357 return Res;
2358}
2359
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002360llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002361 // A forward declaration inside a module header does not belong to the module.
2362 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2363 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002364 if (DebugTypeExtRefs && D->isFromASTFile()) {
2365 // Record a reference to an imported clang module or precompiled header.
2366 auto *Reader = CGM.getContext().getExternalSource();
2367 auto Idx = D->getOwningModuleID();
2368 auto Info = Reader->getSourceDescriptor(Idx);
2369 if (Info)
2370 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2371 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002372 // We are building a clang module or a precompiled header.
2373 //
2374 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2375 // and it wouldn't be necessary to specify the parent scope
2376 // because the type is already unique by definition (it would look
2377 // like the output of -fno-standalone-debug). On the other hand,
2378 // the parent scope helps a consumer to quickly locate the object
2379 // file where the type's definition is located, so it might be
2380 // best to make this behavior a command line or debugger tuning
2381 // option.
2382 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
2383 if (Module *M = ClangModuleMap->inferModuleFromLocation(Loc)) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002384 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002385 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2386 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002387 } else {
2388 // This the precompiled header being built.
2389 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002390 }
2391 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002392
Adrian Prantl9402cef2015-09-20 16:51:35 +00002393 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002394}
2395
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002396llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002397 // Handle qualifiers, which recursively handles what they refer to.
2398 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002399 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002400
Guy Benyei11169dd2012-12-18 14:30:41 +00002401 // Work out details of type.
2402 switch (Ty->getTypeClass()) {
2403#define TYPE(Class, Base)
2404#define ABSTRACT_TYPE(Class, Base)
2405#define NON_CANONICAL_TYPE(Class, Base)
2406#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2407#include "clang/AST/TypeNodes.def"
2408 llvm_unreachable("Dependent types cannot show up in debug information");
2409
2410 case Type::ExtVector:
2411 case Type::Vector:
2412 return CreateType(cast<VectorType>(Ty), Unit);
2413 case Type::ObjCObjectPointer:
2414 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2415 case Type::ObjCObject:
2416 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2417 case Type::ObjCInterface:
2418 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2419 case Type::Builtin:
2420 return CreateType(cast<BuiltinType>(Ty));
2421 case Type::Complex:
2422 return CreateType(cast<ComplexType>(Ty));
2423 case Type::Pointer:
2424 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002425 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002426 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002427 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002428 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002429 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002430 case Type::BlockPointer:
2431 return CreateType(cast<BlockPointerType>(Ty), Unit);
2432 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002433 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002434 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002435 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002436 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002437 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002438 case Type::FunctionProto:
2439 case Type::FunctionNoProto:
2440 return CreateType(cast<FunctionType>(Ty), Unit);
2441 case Type::ConstantArray:
2442 case Type::VariableArray:
2443 case Type::IncompleteArray:
2444 return CreateType(cast<ArrayType>(Ty), Unit);
2445
2446 case Type::LValueReference:
2447 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2448 case Type::RValueReference:
2449 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2450
2451 case Type::MemberPointer:
2452 return CreateType(cast<MemberPointerType>(Ty), Unit);
2453
2454 case Type::Atomic:
2455 return CreateType(cast<AtomicType>(Ty), Unit);
2456
Xiuli Pan9c14e282016-01-09 12:53:17 +00002457 case Type::Pipe:
2458 return CreateType(cast<PipeType>(Ty), Unit);
2459
Guy Benyei11169dd2012-12-18 14:30:41 +00002460 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002461 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2462
David Blaikie42edade2014-11-11 20:44:45 +00002463 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002464 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002465 case Type::Elaborated:
2466 case Type::Paren:
2467 case Type::SubstTemplateTypeParm:
2468 case Type::TypeOfExpr:
2469 case Type::TypeOf:
2470 case Type::Decltype:
2471 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002472 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002473 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002474 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002475
David Blaikie42edade2014-11-11 20:44:45 +00002476 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002477}
2478
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002479llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2480 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002481 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002482
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002483 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002484
2485 // We may have cached a forward decl when we could have created
2486 // a non-forward decl. Go ahead and create a non-forward decl
2487 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002488 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002489 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002490
2491 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002492 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002493
2494 // Propagate members from the declaration to the definition
2495 // CreateType(const RecordType*) will overwrite this with the members in the
2496 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002497 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002498
Guy Benyei11169dd2012-12-18 14:30:41 +00002499 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002500 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002501 return Res;
2502}
2503
2504// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002505llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002506 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002507
Guy Benyei11169dd2012-12-18 14:30:41 +00002508 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002509 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002510 unsigned Line = getLineNumber(RD->getLocation());
2511 StringRef RDName = getClassName(RD);
2512
Amjad Abouddc4531e2016-04-30 01:44:38 +00002513 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002514
David Blaikied2785892013-08-18 17:36:19 +00002515 // If we ended up creating the type during the context chain construction,
2516 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002517 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002518 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002519 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002520 return T;
David Blaikied2785892013-08-18 17:36:19 +00002521
Adrian Prantl381e7552014-02-04 21:29:50 +00002522 // If this is just a forward or incomplete declaration, construct an
2523 // appropriately marked node and just return it.
2524 const RecordDecl *D = RD->getDefinition();
2525 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002526 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002527
2528 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2529 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002530
Manman Rene0064d82013-08-29 23:19:58 +00002531 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2532
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002533 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002534 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align, 0,
2535 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002536
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002537 // Elements of composite types usually have back to the type, creating
2538 // uniquing cycles. Distinct nodes are more efficient.
2539 switch (RealDecl->getTag()) {
2540 default:
2541 llvm_unreachable("invalid composite type tag");
2542
2543 case llvm::dwarf::DW_TAG_array_type:
2544 case llvm::dwarf::DW_TAG_enumeration_type:
2545 // Array elements and most enumeration elements don't have back references,
2546 // so they don't tend to be involved in uniquing cycles and there is some
2547 // chance of merging them when linking together two modules. Only make
2548 // them distinct if they are ODR-uniqued.
2549 if (FullName.empty())
2550 break;
2551
2552 case llvm::dwarf::DW_TAG_structure_type:
2553 case llvm::dwarf::DW_TAG_union_type:
2554 case llvm::dwarf::DW_TAG_class_type:
2555 // Immediatley resolve to a distinct node.
2556 RealDecl =
2557 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2558 break;
2559 }
2560
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002561 RegionMap[Ty->getDecl()].reset(RealDecl);
2562 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002563
David Blaikieadfbf992013-08-18 16:55:33 +00002564 if (const ClassTemplateSpecializationDecl *TSpecial =
2565 dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002566 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002567 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002568 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002569}
2570
David Blaikieadfbf992013-08-18 16:55:33 +00002571void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002572 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002573 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002574 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002575 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2576 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002577 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002578 while (1) {
2579 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2580 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2581 if (PBT && !BRL.isPrimaryBaseVirtual())
2582 PBase = PBT;
2583 else
2584 break;
2585 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002586 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002587 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2588 getOrCreateFile(RD->getLocation())));
2589 } else if (RD->isDynamicClass())
2590 ContainingType = RealDecl;
2591
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002592 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002593}
2594
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002595llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002596 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002597 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002598 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2599 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002600 llvm::DIType *Ty = DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002601 FieldAlign, *Offset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002602 *Offset += FieldSize;
2603 return Ty;
2604}
2605
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002606void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002607 StringRef &Name,
2608 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002609 llvm::DIScope *&FDContext,
2610 llvm::DINodeArray &TParamsArray,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002611 unsigned &Flags) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002612 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
2613 Name = getFunctionName(FD);
2614 // Use mangled name as linkage name for C/C++ functions.
2615 if (FD->hasPrototype()) {
2616 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002617 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002618 }
2619 // No need to replicate the linkage name if it isn't different from the
2620 // subprogram name, no need to have it at all unless coverage is enabled or
2621 // debug is set to more than just line tables.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002622 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2623 !CGM.getCodeGenOpts().EmitGcovNotes &&
2624 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00002625 LinkageName = StringRef();
2626
Benjamin Kramer8c305922016-02-02 11:06:51 +00002627 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002628 if (const NamespaceDecl *NSDecl =
2629 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2630 FDContext = getOrCreateNameSpace(NSDecl);
2631 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002632 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2633 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2634 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2635 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002636 // Collect template parameters.
2637 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2638 }
2639}
2640
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002641void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002642 unsigned &LineNo, QualType &T,
2643 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002644 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002645 Unit = getOrCreateFile(VD->getLocation());
2646 LineNo = getLineNumber(VD->getLocation());
2647
2648 setLocation(VD->getLocation());
2649
2650 T = VD->getType();
2651 if (T->isIncompleteArrayType()) {
2652 // CodeGen turns int[] into int[1] so we'll do the same here.
2653 llvm::APInt ConstVal(32, 1);
2654 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2655
2656 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2657 ArrayType::Normal, 0);
2658 }
2659
2660 Name = VD->getName();
2661 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2662 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2663 LinkageName = CGM.getMangledName(VD);
2664 if (LinkageName == Name)
2665 LinkageName = StringRef();
2666
2667 // Since we emit declarations (DW_AT_members) for static members, place the
2668 // definition of those static members in the namespace they were declared in
2669 // in the source code (the lexical decl context).
2670 // FIXME: Generalize this for even non-member global variables where the
2671 // declaration and definition may have different lexical decl contexts, once
2672 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002673 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2674 : VD->getDeclContext();
2675 // When a record type contains an in-line initialization of a static data
2676 // member, and the record type is marked as __declspec(dllexport), an implicit
2677 // definition of the member will be created in the record context. DWARF
2678 // doesn't seem to have a nice way to describe this in a form that consumers
2679 // are likely to understand, so fake the "normal" situation of a definition
2680 // outside the class by putting it in the global scope.
2681 if (DC->isRecord())
2682 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002683
Amjad Abouddc4531e2016-04-30 01:44:38 +00002684 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2685 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002686}
2687
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002688llvm::DISubprogram *
Frederic Rissd253ed62014-11-18 03:40:51 +00002689CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002690 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002691 StringRef Name, LinkageName;
2692 unsigned Flags = 0;
2693 SourceLocation Loc = FD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002694 llvm::DIFile *Unit = getOrCreateFile(Loc);
2695 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002696 unsigned Line = getLineNumber(Loc);
2697
2698 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2699 TParamsArray, Flags);
2700 // Build function type.
2701 SmallVector<QualType, 16> ArgTypes;
2702 for (const ParmVarDecl *Parm: FD->parameters())
2703 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00002704 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2705 QualType FnType = CGM.getContext().getFunctionType(
2706 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002707 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002708 DContext, Name, LinkageName, Unit, Line,
2709 getOrCreateFunctionType(FD, FnType, Unit), !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002710 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002711 TParamsArray.get(), getFunctionDeclaration(FD));
Frederic Rissd253ed62014-11-18 03:40:51 +00002712 const FunctionDecl *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002713 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2714 std::make_tuple(CanonDecl),
2715 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002716 return SP;
2717}
2718
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002719llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002720CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2721 QualType T;
2722 StringRef Name, LinkageName;
2723 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002724 llvm::DIFile *Unit = getOrCreateFile(Loc);
2725 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002726 unsigned Line = getLineNumber(Loc);
2727
2728 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002729 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
2730 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
2731 !VD->isExternallyVisible(), nullptr, nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002732 FwdDeclReplaceMap.emplace_back(
2733 std::piecewise_construct,
2734 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2735 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002736 return GV;
2737}
2738
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002739llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002740 // We only need a declaration (not a definition) of the type - so use whatever
2741 // we would otherwise do to get a type for a pointee. (forward declarations in
2742 // limited debug info, full definitions (if the type definition is available)
2743 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002744 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2745 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002746 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002747 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002748
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002749 if (I != DeclCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002750 return dyn_cast_or_null<llvm::DINode>(I->second);
Frederic Rissd253ed62014-11-18 03:40:51 +00002751
2752 // No definition for now. Emit a forward definition that might be
2753 // merged with a potential upcoming definition.
2754 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
2755 return getFunctionForwardDeclaration(FD);
2756 else if (const auto *VD = dyn_cast<VarDecl>(D))
2757 return getGlobalVariableForwardDeclaration(VD);
2758
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002759 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00002760}
2761
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002762llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002763 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002764 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00002765
Guy Benyei11169dd2012-12-18 14:30:41 +00002766 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002767 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002768 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002769
2770 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002771 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00002772
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002773 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002774 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002775 if (const CXXMethodDecl *MD =
2776 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00002777 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002778 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00002779 }
2780 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002781 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002782 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002783 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002784 return SP;
2785 }
2786
Aaron Ballman86c93902014-03-06 23:45:36 +00002787 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002788 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002789 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002790 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002791 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002792 return SP;
2793 }
2794 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002795 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002796}
2797
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002798// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00002799// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002800llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002801 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002802 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002803 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002804 // Create fake but valid subroutine type. Otherwise -verify would fail, and
2805 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00002806 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002807
2808 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2809 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002810
2811 const auto *FTy = FnType->getAs<FunctionType>();
2812 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
2813
Guy Benyei11169dd2012-12-18 14:30:41 +00002814 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2815 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002816 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002817
2818 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002819 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002820
2821 // Replace the instancetype keyword with the actual type.
2822 if (ResultTy == CGM.getContext().getObjCInstanceType())
2823 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002824 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002825
Adrian Prantl7bec9032013-05-10 21:08:31 +00002826 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002827 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002828 QualType SelfDeclTy;
2829 if (auto *SelfDecl = OMethod->getSelfDecl())
2830 SelfDeclTy = SelfDecl->getType();
2831 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
2832 if (FPT->getNumParams() > 1)
2833 SelfDeclTy = FPT->getParamType(0);
2834 if (!SelfDeclTy.isNull())
2835 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002836 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002837 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002838 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002839 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00002840 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00002841 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00002842 // Variadic methods need a special marker at the end of the type list.
2843 if (OMethod->isVariadic())
2844 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00002845
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002846 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002847 return DBuilder.createSubroutineType(EltTypeArray, 0, getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00002848 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002849
Adrian Prantl800faef2014-02-25 23:42:18 +00002850 // Handle variadic function types; they need an additional
2851 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002852 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2853 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002854 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00002855 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2856 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2857 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2858 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2859 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002860 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002861 return DBuilder.createSubroutineType(EltTypeArray, 0, getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00002862 }
2863
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002864 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002865}
2866
Eric Christophere7b87e52014-10-26 23:40:33 +00002867void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
2868 SourceLocation ScopeLoc, QualType FnType,
2869 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002870
2871 StringRef Name;
2872 StringRef LinkageName;
2873
2874 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2875
2876 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002877 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002878
Guy Benyei11169dd2012-12-18 14:30:41 +00002879 unsigned Flags = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002880 llvm::DIFile *Unit = getOrCreateFile(Loc);
2881 llvm::DIScope *FDContext = Unit;
2882 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00002883 if (!HasDecl) {
2884 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002885 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002886 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002887 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002888 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002889 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002890 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002891 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002892 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002893 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002894 return;
2895 }
2896 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002897 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2898 TParamsArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002899 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2900 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002901 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002902 } else {
2903 // Use llvm function name.
2904 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002905 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002906 }
2907 if (!Name.empty() && Name[0] == '\01')
2908 Name = Name.substr(1);
2909
Adrian Prantl42d71b92014-04-10 23:21:53 +00002910 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002911 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002912 // Artificial functions without a location should not silently reuse CurLoc.
2913 if (Loc.isInvalid())
2914 CurLoc = SourceLocation();
2915 }
2916 unsigned LineNo = getLineNumber(Loc);
2917 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002918
Eric Christopher8018e412014-03-27 18:50:35 +00002919 // FIXME: The function declaration we're constructing here is mostly reusing
2920 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2921 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2922 // all subprograms instead of the actual context since subprogram definitions
2923 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002924 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00002925 FDContext, Name, LinkageName, Unit, LineNo,
David Majnemer36a6e002016-07-06 21:07:53 +00002926 getOrCreateFunctionType(D, FnType, Unit), Fn->hasLocalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002927 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002928 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002929 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00002930 // We might get here with a VarDecl in the case we're generating
2931 // code for the initialization of globals. Do not record these decls
2932 // as they will overwrite the actual VarDecl Decl in the cache.
2933 if (HasDecl && isa<FunctionDecl>(D))
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002934 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(SP));
Guy Benyei11169dd2012-12-18 14:30:41 +00002935
Adrian Prantlbebb8932014-03-21 21:01:58 +00002936 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002937 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002938
Guy Benyei11169dd2012-12-18 14:30:41 +00002939 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002940 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002941}
2942
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002943void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
2944 QualType FnType) {
2945 StringRef Name;
2946 StringRef LinkageName;
2947
2948 const Decl *D = GD.getDecl();
2949 if (!D)
2950 return;
2951
2952 unsigned Flags = 0;
2953 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00002954 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002955 llvm::DINodeArray TParamsArray;
2956 if (isa<FunctionDecl>(D)) {
2957 // If there is a DISubprogram for this function available then use it.
2958 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2959 TParamsArray, Flags);
2960 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2961 Name = getObjCMethodName(OMD);
2962 Flags |= llvm::DINode::FlagPrototyped;
2963 } else {
2964 llvm_unreachable("not a function or ObjC method");
2965 }
2966 if (!Name.empty() && Name[0] == '\01')
2967 Name = Name.substr(1);
2968
2969 if (D->isImplicit()) {
2970 Flags |= llvm::DINode::FlagArtificial;
2971 // Artificial functions without a location should not silently reuse CurLoc.
2972 if (Loc.isInvalid())
2973 CurLoc = SourceLocation();
2974 }
2975 unsigned LineNo = getLineNumber(Loc);
2976 unsigned ScopeLine = 0;
2977
Adrian Prantle76bda52016-04-15 15:55:45 +00002978 DBuilder.retainType(DBuilder.createFunction(
2979 FDContext, Name, LinkageName, Unit, LineNo,
2980 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
2981 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
2982 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002983}
2984
David Blaikie835afb22015-01-21 23:08:17 +00002985void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002986 // Update our current location
2987 setLocation(Loc);
2988
Eric Christophere7b87e52014-10-26 23:40:33 +00002989 if (CurLoc.isInvalid() || CurLoc.isMacroID())
2990 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002991
Adrian Prantle83b1302014-01-07 22:05:52 +00002992 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00002993 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00002994 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002995}
2996
Guy Benyei11169dd2012-12-18 14:30:41 +00002997void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002998 llvm::MDNode *Back = nullptr;
2999 if (!LexicalBlockStack.empty())
3000 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003001 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003002 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003003 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00003004}
3005
Eric Christopher0fdcb312013-05-16 00:52:20 +00003006void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
3007 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003008 // Set our current location.
3009 setLocation(Loc);
3010
Guy Benyei11169dd2012-12-18 14:30:41 +00003011 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00003012 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3013 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00003014
Benjamin Kramer8c305922016-02-02 11:06:51 +00003015 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003016 return;
3017
3018 // Create a new lexical block and push it on the stack.
3019 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003020}
3021
Eric Christopher0fdcb312013-05-16 00:52:20 +00003022void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
3023 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003024 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3025
3026 // Provide an entry in the line table for the end of the block.
3027 EmitLocation(Builder, Loc);
3028
Benjamin Kramer8c305922016-02-02 11:06:51 +00003029 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00003030 return;
3031
Guy Benyei11169dd2012-12-18 14:30:41 +00003032 LexicalBlockStack.pop_back();
3033}
3034
Guy Benyei11169dd2012-12-18 14:30:41 +00003035void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
3036 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3037 unsigned RCount = FnBeginRegionCount.back();
3038 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3039
3040 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00003041 while (LexicalBlockStack.size() != RCount) {
3042 // Provide an entry in the line table for the end of the block.
3043 EmitLocation(Builder, CurLoc);
3044 LexicalBlockStack.pop_back();
3045 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003046 FnBeginRegionCount.pop_back();
3047}
3048
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003049llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003050 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003051
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003052 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00003053 QualType FType;
3054 uint64_t FieldSize, FieldOffset;
3055 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003056
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003057 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003058 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00003059
3060 FieldOffset = 0;
3061 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3062 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3063 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3064 FType = CGM.getContext().IntTy;
3065 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3066 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3067
3068 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3069 if (HasCopyAndDispose) {
3070 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003071 EltTys.push_back(
3072 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3073 EltTys.push_back(
3074 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003075 }
3076 bool HasByrefExtendedLayout;
3077 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003078 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3079 HasByrefExtendedLayout) &&
3080 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003081 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003082 EltTys.push_back(
3083 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003084 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003085
Guy Benyei11169dd2012-12-18 14:30:41 +00003086 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3087 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003088 CGM.getTarget().getPointerAlign(0))) {
3089 CharUnits FieldOffsetInBytes =
3090 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003091 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003092 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003093
Guy Benyei11169dd2012-12-18 14:30:41 +00003094 if (NumPaddingBytes.isPositive()) {
3095 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3096 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3097 pad, ArrayType::Normal, 0);
3098 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3099 }
3100 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003101
Guy Benyei11169dd2012-12-18 14:30:41 +00003102 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003103 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003104 FieldSize = CGM.getContext().getTypeSize(FType);
3105 FieldAlign = CGM.getContext().toBits(Align);
3106
Eric Christopherb2a008c2013-05-16 00:45:12 +00003107 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003108 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
3109 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003110 EltTys.push_back(FieldTy);
3111 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003112
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003113 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003114
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003115 unsigned Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003116
Guy Benyei11169dd2012-12-18 14:30:41 +00003117 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003118 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003119}
3120
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003121void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3122 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00003123 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003124 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003125 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003126 if (VD->hasAttr<NoDebugAttr>())
3127 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003128
David Blaikie7fceebf2013-08-19 03:37:48 +00003129 bool Unwritten =
3130 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3131 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003132 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003133 if (!Unwritten)
3134 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003135 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003136 uint64_t XOffset = 0;
3137 if (VD->hasAttr<BlocksAttr>())
3138 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003139 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003140 Ty = getOrCreateType(VD->getType(), Unit);
3141
3142 // If there is no debug info for this type then do not emit debug info
3143 // for this variable.
3144 if (!Ty)
3145 return;
3146
Guy Benyei11169dd2012-12-18 14:30:41 +00003147 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003148 unsigned Line = 0;
3149 unsigned Column = 0;
3150 if (!Unwritten) {
3151 Line = getLineNumber(VD->getLocation());
3152 Column = getColumnNumber(VD->getLocation());
3153 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003154 SmallVector<int64_t, 9> Expr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003155 unsigned Flags = 0;
3156 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003157 Flags |= llvm::DINode::FlagArtificial;
Guy Benyei11169dd2012-12-18 14:30:41 +00003158 // If this is the first argument and it is implicit then
3159 // give it an object pointer flag.
3160 // FIXME: There has to be a better way to do this, but for static
3161 // functions there won't be an implicit param at arg1 and
3162 // otherwise it is 'self' or 'this'.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003163 if (isa<ImplicitParamDecl>(VD) && ArgNo && *ArgNo == 1)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003164 Flags |= llvm::DINode::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00003165 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00003166 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
3167 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003168 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00003169
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003170 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003171
3172 StringRef Name = VD->getName();
3173 if (!Name.empty()) {
3174 if (VD->hasAttr<BlocksAttr>()) {
3175 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003176 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003177 // offset of __forwarding field
3178 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003179 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003180 Expr.push_back(offset.getQuantity());
3181 Expr.push_back(llvm::dwarf::DW_OP_deref);
3182 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003183 // offset of x field
3184 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003185 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003186
3187 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003188 auto *D = ArgNo
3189 ? DBuilder.createParameterVariable(Scope, VD->getName(),
3190 *ArgNo, Unit, Line, Ty)
3191 : DBuilder.createAutoVariable(Scope, VD->getName(), Unit,
3192 Line, Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003193
Guy Benyei11169dd2012-12-18 14:30:41 +00003194 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003195 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3196 llvm::DebugLoc::get(Line, Column, Scope),
3197 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003198 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00003199 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003200 Expr.push_back(llvm::dwarf::DW_OP_deref);
Adrian Prantl0d820892015-04-29 15:05:50 +00003201 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
3202 // If VD is an anonymous union then Storage represents value for
3203 // all union fields.
3204 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
3205 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003206 // GDB has trouble finding local variables in anonymous unions, so we emit
3207 // artifical local variables for each of the members.
3208 //
3209 // FIXME: Remove this code as soon as GDB supports this.
3210 // The debug info verifier in LLVM operates based on the assumption that a
3211 // variable has the same size as its storage and we had to disable the check
3212 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003213 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003214 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003215 StringRef FieldName = Field->getName();
3216
3217 // Ignore unnamed fields. Do not ignore unnamed records.
3218 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3219 continue;
3220
3221 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003222 auto *D = DBuilder.createAutoVariable(
3223 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3224 Flags | llvm::DINode::FlagArtificial);
Adrian Prantl0d820892015-04-29 15:05:50 +00003225
3226 // Insert an llvm.dbg.declare into the current block.
3227 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3228 llvm::DebugLoc::get(Line, Column, Scope),
3229 Builder.GetInsertBlock());
3230 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003231 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003232 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003233
3234 // Create the descriptor for the variable.
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003235 auto *D =
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003236 ArgNo
3237 ? DBuilder.createParameterVariable(Scope, Name, *ArgNo, Unit, Line,
3238 Ty, CGM.getLangOpts().Optimize,
3239 Flags)
3240 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3241 CGM.getLangOpts().Optimize, Flags);
David Blaikiea76a7c92013-01-05 05:58:35 +00003242
3243 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003244 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3245 llvm::DebugLoc::get(Line, Column, Scope),
3246 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003247}
3248
3249void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3250 llvm::Value *Storage,
3251 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003252 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003253 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003254}
3255
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003256llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3257 llvm::DIType *Ty) {
3258 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003259 if (CachedTy)
3260 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003261 return DBuilder.createObjectPointerType(Ty);
3262}
3263
Eric Christophere7b87e52014-10-26 23:40:33 +00003264void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3265 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003266 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003267 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003268 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003269
Craig Topper8a13c412014-05-21 05:09:00 +00003270 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003271 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003272 if (VD->hasAttr<NoDebugAttr>())
3273 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003274
Guy Benyei11169dd2012-12-18 14:30:41 +00003275 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003276
Guy Benyei11169dd2012-12-18 14:30:41 +00003277 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003278 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3279 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003280 if (isByRef)
3281 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003282 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003283 Ty = getOrCreateType(VD->getType(), Unit);
3284
3285 // Self is passed along as an implicit non-arg variable in a
3286 // block. Mark it as the object pointer.
3287 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00003288 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003289
3290 // Get location information.
3291 unsigned Line = getLineNumber(VD->getLocation());
3292 unsigned Column = getColumnNumber(VD->getLocation());
3293
3294 const llvm::DataLayout &target = CGM.getDataLayout();
3295
3296 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003297 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003298 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3299
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003300 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00003301 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003302 addr.push_back(llvm::dwarf::DW_OP_deref);
3303 addr.push_back(llvm::dwarf::DW_OP_plus);
3304 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003305 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003306 addr.push_back(llvm::dwarf::DW_OP_deref);
3307 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003308 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003309 offset =
3310 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003311 addr.push_back(offset.getQuantity());
3312 addr.push_back(llvm::dwarf::DW_OP_deref);
3313 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003314 // offset of x field
3315 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003316 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003317 }
3318
3319 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003320 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003321 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003322 Line, Ty);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003323
Guy Benyei11169dd2012-12-18 14:30:41 +00003324 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003325 auto DL = llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back());
3326 if (InsertPoint)
3327 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3328 InsertPoint);
3329 else
3330 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3331 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003332}
3333
Guy Benyei11169dd2012-12-18 14:30:41 +00003334void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3335 unsigned ArgNo,
3336 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003337 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003338 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003339}
3340
3341namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003342struct BlockLayoutChunk {
3343 uint64_t OffsetInBits;
3344 const BlockDecl::Capture *Capture;
3345};
3346bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3347 return l.OffsetInBits < r.OffsetInBits;
3348}
Guy Benyei11169dd2012-12-18 14:30:41 +00003349}
3350
3351void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003352 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003353 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003354 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003355 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003356 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003357 ASTContext &C = CGM.getContext();
3358 const BlockDecl *blockDecl = block.getBlockDecl();
3359
3360 // Collect some general information about the block's location.
3361 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003362 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003363 unsigned line = getLineNumber(loc);
3364 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003365
Guy Benyei11169dd2012-12-18 14:30:41 +00003366 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003367 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003368
3369 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003370 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003371
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003372 SmallVector<llvm::Metadata *, 16> fields;
David Majnemerb4b671e2016-06-30 03:01:59 +00003373 fields.push_back(createFieldType("__isa", C.VoidPtrTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003374 blockLayout->getElementOffsetInBits(0),
3375 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003376 fields.push_back(createFieldType("__flags", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003377 blockLayout->getElementOffsetInBits(1),
3378 tunit, tunit));
David Majnemerb4b671e2016-06-30 03:01:59 +00003379 fields.push_back(createFieldType("__reserved", C.IntTy, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003380 blockLayout->getElementOffsetInBits(2),
3381 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003382 auto *FnTy = block.getBlockExpr()->getFunctionType();
3383 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
David Majnemerb4b671e2016-06-30 03:01:59 +00003384 fields.push_back(createFieldType("__FuncPtr", FnPtrType, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003385 blockLayout->getElementOffsetInBits(3),
3386 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003387 fields.push_back(createFieldType(
3388 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3389 ? C.getBlockDescriptorExtendedType()
3390 : C.getBlockDescriptorType()),
David Majnemerb4b671e2016-06-30 03:01:59 +00003391 loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003392
3393 // We want to sort the captures by offset, not because DWARF
3394 // requires this, but because we're paranoid about debuggers.
3395 SmallVector<BlockLayoutChunk, 8> chunks;
3396
3397 // 'this' capture.
3398 if (blockDecl->capturesCXXThis()) {
3399 BlockLayoutChunk chunk;
3400 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003401 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003402 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003403 chunks.push_back(chunk);
3404 }
3405
3406 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003407 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003408 const VarDecl *variable = capture.getVariable();
3409 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3410
3411 // Ignore constant captures.
3412 if (captureInfo.isConstant())
3413 continue;
3414
3415 BlockLayoutChunk chunk;
3416 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003417 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003418 chunk.Capture = &capture;
3419 chunks.push_back(chunk);
3420 }
3421
3422 // Sort by offset.
3423 llvm::array_pod_sort(chunks.begin(), chunks.end());
3424
Eric Christophere7b87e52014-10-26 23:40:33 +00003425 for (SmallVectorImpl<BlockLayoutChunk>::iterator i = chunks.begin(),
3426 e = chunks.end();
3427 i != e; ++i) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003428 uint64_t offsetInBits = i->OffsetInBits;
3429 const BlockDecl::Capture *capture = i->Capture;
3430
3431 // If we have a null capture, this must be the C++ 'this' capture.
3432 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003433 QualType type;
3434 if (auto *Method =
3435 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3436 type = Method->getThisType(C);
3437 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3438 type = QualType(RDecl->getTypeForDecl(), 0);
3439 else
3440 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003441
David Majnemerb4b671e2016-06-30 03:01:59 +00003442 fields.push_back(createFieldType("this", type, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003443 offsetInBits, tunit, tunit));
3444 continue;
3445 }
3446
3447 const VarDecl *variable = capture->getVariable();
3448 StringRef name = variable->getName();
3449
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003450 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003451 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003452 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003453
3454 // FIXME: this creates a second copy of this type!
3455 uint64_t xoffset;
3456 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003457 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3458 fieldType =
3459 DBuilder.createMemberType(tunit, name, tunit, line, PtrInfo.Width,
3460 PtrInfo.Align, offsetInBits, 0, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003461 } else {
David Majnemerb4b671e2016-06-30 03:01:59 +00003462 fieldType = createFieldType(name, variable->getType(), loc, AS_public,
Eric Christophere7b87e52014-10-26 23:40:33 +00003463 offsetInBits, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003464 }
3465 fields.push_back(fieldType);
3466 }
3467
3468 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003469 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3470 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003471
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003472 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003473
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003474 llvm::DIType *type = DBuilder.createStructType(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003475 tunit, typeName.str(), tunit, line,
3476 CGM.getContext().toBits(block.BlockSize),
3477 CGM.getContext().toBits(block.BlockAlign), 0, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003478 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3479
3480 // Get overall information about the block.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003481 unsigned flags = llvm::DINode::FlagArtificial;
3482 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003483
3484 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003485 auto *debugVar = DBuilder.createParameterVariable(
3486 scope, Arg->getName(), ArgNo, tunit, line, type,
3487 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003488
Adrian Prantl616bef42013-03-14 21:52:59 +00003489 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003490 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003491 DBuilder.insertDbgValueIntrinsic(
Eric Christophere7b87e52014-10-26 23:40:33 +00003492 LocalAddr, 0, debugVar, DBuilder.createExpression(),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003493 llvm::DebugLoc::get(line, column, scope), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003494 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003495
Adrian Prantl616bef42013-03-14 21:52:59 +00003496 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003497 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
3498 llvm::DebugLoc::get(line, column, scope),
3499 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003500}
3501
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003502llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003503CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3504 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003505 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003506
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003507 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003508 if (MI != StaticDataMemberCache.end()) {
3509 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003510 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003511 }
David Blaikiece763042013-08-20 21:49:21 +00003512
3513 // If the member wasn't found in the cache, lazily construct and add it to the
3514 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003515 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003516 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003517 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003518}
3519
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003520llvm::DIGlobalVariable *CGDebugInfo::CollectAnonRecordDecls(
3521 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3522 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
3523 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003524
3525 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003526 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003527 StringRef FieldName = Field->getName();
3528
3529 // Ignore unnamed fields, but recurse into anonymous records.
3530 if (FieldName.empty()) {
3531 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3532 if (RT)
3533 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3534 Var, DContext);
3535 continue;
3536 }
3537 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003538 GV = DBuilder.createGlobalVariable(DContext, FieldName, LinkageName, Unit,
3539 LineNo, FieldTy,
David Majnemer36a6e002016-07-06 21:07:53 +00003540 Var->hasLocalLinkage(), Var, nullptr);
Eric Christophercab9fae2014-04-10 05:20:00 +00003541 }
3542 return GV;
3543}
3544
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003545void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003546 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003547 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003548 if (D->hasAttr<NoDebugAttr>())
3549 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003550 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003551 llvm::DIFile *Unit = nullptr;
3552 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003553 unsigned LineNo;
3554 StringRef DeclName, LinkageName;
3555 QualType T;
3556 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003557
3558 // Attempt to store one global variable for the declaration - even if we
3559 // emit a lot of fields.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003560 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003561
3562 // If this is an anonymous union then we'll want to emit a global
3563 // variable for each member of the anonymous union so that it's possible
3564 // to find the name of any field in the union.
3565 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003566 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003567 assert(RD->isAnonymousStructOrUnion() &&
3568 "unnamed non-anonymous struct or union?");
Eric Christophercab9fae2014-04-10 05:20:00 +00003569 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3570 } else {
David Blaikie7550b112014-10-20 17:42:23 +00003571 GV = DBuilder.createGlobalVariable(
Eric Christophercab9fae2014-04-10 05:20:00 +00003572 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
David Majnemer36a6e002016-07-06 21:07:53 +00003573 Var->hasLocalLinkage(), Var,
Eric Christophercab9fae2014-04-10 05:20:00 +00003574 getOrCreateStaticDataMemberDeclarationOrNull(D));
3575 }
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003576 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(GV));
Guy Benyei11169dd2012-12-18 14:30:41 +00003577}
3578
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003579void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3580 llvm::Constant *Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003581 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003582 if (VD->hasAttr<NoDebugAttr>())
3583 return;
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003584 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003585 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003586 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003587 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003588 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3589 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3590 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3591 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3592 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003593 // Do not use global variables for enums.
3594 //
3595 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003596 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003597 return;
David Blaikiea15565562014-04-04 20:56:17 +00003598 // Do not emit separate definitions for function local const/statics.
3599 if (isa<FunctionDecl>(VD->getDeclContext()))
3600 return;
David Blaikiebb113912014-04-05 07:23:17 +00003601 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003602 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003603 if (VarD->isStaticDataMember()) {
3604 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003605 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003606 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00003607 //
3608 // FIXME: This is probably unnecessary, since Ty should reference RD
3609 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00003610 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003611 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003612 return;
3613 }
3614
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003615 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003616
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003617 auto &GV = DeclCache[VD];
3618 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003619 return;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003620 GV.reset(DBuilder.createGlobalVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003621 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003622 true, Init, getOrCreateStaticDataMemberDeclarationOrNull(VarD)));
David Blaikiebd483762013-05-20 04:58:53 +00003623}
3624
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003625llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003626 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003627 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003628 llvm::DIScope *Mod = getParentModuleOrNull(D);
3629 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003630}
3631
David Blaikie9f88fe82013-04-22 06:13:21 +00003632void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003633 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003634 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003635 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
Adrian McCarthy743f7f12016-07-06 15:15:38 +00003636 if (!NSDecl->isAnonymousNamespace() ||
3637 CGM.getCodeGenOpts().DebugExplicitImport) {
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003638 DBuilder.createImportedModule(
3639 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3640 getOrCreateNameSpace(NSDecl),
3641 getLineNumber(UD.getLocation()));
3642 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003643}
3644
David Blaikiebd483762013-05-20 04:58:53 +00003645void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003646 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003647 return;
3648 assert(UD.shadow_size() &&
3649 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3650 // Emitting one decl is sufficient - debuggers can detect that this is an
3651 // overloaded name & provide lookup for all the overloads.
3652 const UsingShadowDecl &USD = **UD.shadow_begin();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003653 if (llvm::DINode *Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003654 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003655 DBuilder.createImportedDeclaration(
3656 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3657 getLineNumber(USD.getLocation()));
3658}
3659
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003660void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00003661 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
3662 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00003663 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00003664 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl8a634c12015-12-18 19:44:31 +00003665 DBuilder.createImportedDeclaration(
3666 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
3667 getOrCreateModuleRef(Info, DebugTypeExtRefs),
3668 getLineNumber(ID.getLocation()));
3669 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003670}
3671
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003672llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00003673CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003674 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003675 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003676 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003677 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003678 return cast<llvm::DIImportedEntity>(VH);
3679 llvm::DIImportedEntity *R;
David Blaikief121b932013-05-20 22:50:41 +00003680 if (const NamespaceAliasDecl *Underlying =
3681 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3682 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003683 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003684 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3685 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3686 NA.getName());
3687 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003688 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003689 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3690 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3691 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003692 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003693 return R;
3694}
3695
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003696llvm::DINamespace *
Guy Benyei11169dd2012-12-18 14:30:41 +00003697CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003698 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003699 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003700 if (I != NameSpaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003701 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003702
Guy Benyei11169dd2012-12-18 14:30:41 +00003703 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003704 llvm::DIFile *FileD = getOrCreateFile(NSDecl->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003705 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003706 llvm::DINamespace *NS =
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003707 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003708 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003709 return NS;
3710}
3711
Adrian Prantla5206ce2015-09-22 23:26:43 +00003712void CGDebugInfo::setDwoId(uint64_t Signature) {
3713 assert(TheCU && "no main compile unit");
3714 TheCU->setDWOId(Signature);
3715}
3716
3717
Guy Benyei11169dd2012-12-18 14:30:41 +00003718void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003719 // Creating types might create further types - invalidating the current
3720 // element and the size(), so don't cache/reference them.
3721 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3722 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003723 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00003724 ? CreateTypeDefinition(E.Type, E.Unit)
3725 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003726 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00003727 }
3728
David Blaikief427b002014-05-06 03:42:01 +00003729 for (auto p : ReplaceMap) {
3730 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003731 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003732 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003733
David Blaikief427b002014-05-06 03:42:01 +00003734 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003735 assert(it != TypeCache.end());
3736 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003737
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003738 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
3739 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00003740 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003741
Frederic Rissd253ed62014-11-18 03:40:51 +00003742 for (const auto &p : FwdDeclReplaceMap) {
3743 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003744 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003745 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003746
3747 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003748 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003749 // with ourselves, that will destroy the temporary MDNode and
3750 // replace it with a standard one, avoiding leaking memory.
3751 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003752 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003753 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003754 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003755
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003756 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00003757 }
3758
Adrian Prantl73409ce2013-03-11 18:33:46 +00003759 // We keep our own list of retained types, because we need to look
3760 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00003761 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00003762 if (auto MD = TypeCache[RT])
3763 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003764
Guy Benyei11169dd2012-12-18 14:30:41 +00003765 DBuilder.finalize();
3766}
David Blaikie66088d52014-09-24 17:01:27 +00003767
3768void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003769 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00003770 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003771
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003772 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003773 // Don't ignore in case of explicit cast where it is referenced indirectly.
3774 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003775}