blob: bfd9e8d3ba551df3c600774ad104d685f8d82d1f [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This coordinates the debug information generation while generating code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGDebugInfo.h"
15#include "CGBlocks.h"
David Blaikie38079fd2013-05-10 21:53:14 +000016#include "CGCXXABI.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000017#include "CGObjCRuntime.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
20#include "clang/AST/ASTContext.h"
21#include "clang/AST/DeclFriend.h"
22#include "clang/AST/DeclObjC.h"
23#include "clang/AST/DeclTemplate.h"
24#include "clang/AST/Expr.h"
25#include "clang/AST/RecordLayout.h"
26#include "clang/Basic/FileManager.h"
27#include "clang/Basic/SourceManager.h"
28#include "clang/Basic/Version.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000029#include "clang/Frontend/CodeGenOptions.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000030#include "clang/Lex/HeaderSearchOptions.h"
Adrian Prantl9402cef2015-09-20 16:51:35 +000031#include "clang/Lex/ModuleMap.h"
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000032#include "clang/Lex/PreprocessorOptions.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000033#include "llvm/ADT/SmallVector.h"
34#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/Constants.h"
36#include "llvm/IR/DataLayout.h"
37#include "llvm/IR/DerivedTypes.h"
38#include "llvm/IR/Instructions.h"
39#include "llvm/IR/Intrinsics.h"
40#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000041#include "llvm/Support/FileSystem.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000042#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000043using namespace clang;
44using namespace clang::CodeGen;
45
46CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000047 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
Adrian Prantl6b21ab22015-08-27 19:46:20 +000048 DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
Eric Christopher324bbbd2013-07-14 21:12:44 +000049 DBuilder(CGM.getModule()) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000050 for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
51 DebugPrefixMap[KV.first] = KV.second;
Guy Benyei11169dd2012-12-18 14:30:41 +000052 CreateCompileUnit();
53}
54
55CGDebugInfo::~CGDebugInfo() {
56 assert(LexicalBlockStack.empty() &&
57 "Region stack mismatch, stack not empty!");
58}
59
David Blaikie66e41972015-01-14 07:38:27 +000060ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
David Blaikie835afb22015-01-21 23:08:17 +000061 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000062 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +000063 init(TemporaryLocation);
64}
65
Adrian Prantl39428e72015-02-03 18:40:42 +000066ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000067 bool DefaultToEmpty,
Adrian Prantl39428e72015-02-03 18:40:42 +000068 SourceLocation TemporaryLocation)
David Blaikied7057d92015-08-12 23:49:57 +000069 : CGF(&CGF) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000070 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000071}
72
73void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Adrian Prantl95b24e92015-02-03 20:00:54 +000074 bool DefaultToEmpty) {
David Blaikied7057d92015-08-12 23:49:57 +000075 auto *DI = CGF->getDebugInfo();
76 if (!DI) {
77 CGF = nullptr;
78 return;
David Blaikie66e41972015-01-14 07:38:27 +000079 }
David Blaikied7057d92015-08-12 23:49:57 +000080
81 OriginalLocation = CGF->Builder.getCurrentDebugLocation();
82 if (TemporaryLocation.isValid()) {
83 DI->EmitLocation(CGF->Builder, TemporaryLocation);
84 return;
85 }
86
87 if (DefaultToEmpty) {
88 CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
89 return;
90 }
91
92 // Construct a location that has a valid scope, but no line info.
93 assert(!DI->LexicalBlockStack.empty());
94 CGF->Builder.SetCurrentDebugLocation(
95 llvm::DebugLoc::get(0, 0, DI->LexicalBlockStack.back()));
Adrian Prantl2e0637f2013-07-18 00:28:02 +000096}
97
David Blaikie9b479662015-01-25 01:19:10 +000098ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
David Blaikied7057d92015-08-12 23:49:57 +000099 : CGF(&CGF) {
David Blaikie9b479662015-01-25 01:19:10 +0000100 init(E->getExprLoc());
101}
102
David Blaikie66e41972015-01-14 07:38:27 +0000103ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
David Blaikied7057d92015-08-12 23:49:57 +0000104 : CGF(&CGF) {
105 if (!CGF.getDebugInfo()) {
106 this->CGF = nullptr;
107 return;
David Blaikie66e41972015-01-14 07:38:27 +0000108 }
David Blaikied7057d92015-08-12 23:49:57 +0000109 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
110 if (Loc)
111 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +0000112}
113
114ApplyDebugLocation::~ApplyDebugLocation() {
115 // Query CGF so the location isn't overwritten when location updates are
116 // temporarily disabled (for C++ default function arguments)
David Blaikied7057d92015-08-12 23:49:57 +0000117 if (CGF)
118 CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000119}
120
Guy Benyei11169dd2012-12-18 14:30:41 +0000121void CGDebugInfo::setLocation(SourceLocation Loc) {
122 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000123 if (Loc.isInvalid())
124 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000125
126 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
127
128 // If we've changed files in the middle of a lexical scope go ahead
129 // and create a new lexical scope with file node if it's different
130 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000131 if (LexicalBlockStack.empty())
132 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000133
134 SourceManager &SM = CGM.getContext().getSourceManager();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000135 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000136 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000137
Duncan P. N. Exon Smith373ee852015-04-16 01:36:36 +0000138 if (PCLoc.isInvalid() || Scope->getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000139 return;
140
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000141 if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000142 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000143 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
144 LBF->getScope(), getOrCreateFile(CurLoc)));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000145 } else if (isa<llvm::DILexicalBlock>(Scope) ||
146 isa<llvm::DISubprogram>(Scope)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000147 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +0000148 LexicalBlockStack.emplace_back(
149 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000150 }
151}
152
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000153llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000154 llvm::DIScope *Mod = getParentModuleOrNull(D);
155 return getContextDescriptor(cast<Decl>(D->getDeclContext()),
156 Mod ? Mod : TheCU);
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000157}
158
159llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
160 llvm::DIScope *Default) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000161 if (!Context)
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000162 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000163
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000164 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000165 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000166 llvm::Metadata *V = I->second;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000167 return dyn_cast_or_null<llvm::DIScope>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000168 }
169
170 // Check namespace.
171 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000172 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000173
David Blaikiebfa52742013-04-19 06:56:38 +0000174 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
175 if (!RDecl->isDependentType())
176 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000177 getOrCreateMainFile());
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000178 return Default;
Guy Benyei11169dd2012-12-18 14:30:41 +0000179}
180
Guy Benyei11169dd2012-12-18 14:30:41 +0000181StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000182 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000183 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000184 FunctionTemplateSpecializationInfo *Info =
185 FD->getTemplateSpecializationInfo();
Reid Kleckner60103382015-12-16 02:04:40 +0000186
Reid Kleckner829398e2016-06-17 16:11:20 +0000187 if (!Info && FII)
Guy Benyei11169dd2012-12-18 14:30:41 +0000188 return FII->getName();
189
190 // Otherwise construct human readable name for debug info.
Benjamin Kramer9170e912013-02-22 15:46:01 +0000191 SmallString<128> NS;
192 llvm::raw_svector_ostream OS(NS);
Reid Kleckner60103382015-12-16 02:04:40 +0000193 PrintingPolicy Policy(CGM.getLangOpts());
Reid Kleckner829398e2016-06-17 16:11:20 +0000194 Policy.MSVCFormatting = CGM.getCodeGenOpts().EmitCodeView;
Guy Benyei11169dd2012-12-18 14:30:41 +0000195
Reid Kleckner829398e2016-06-17 16:11:20 +0000196 // Print the unqualified name with some template arguments.
197 FD->printName(OS);
198 // Add any template specialization args.
199 if (Info) {
200 const TemplateArgumentList *TArgs = Info->TemplateArguments;
201 const TemplateArgument *Args = TArgs->data();
202 unsigned NumArgs = TArgs->size();
203 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
204 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000205 }
206
207 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000208 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000209}
210
211StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
212 SmallString<256> MethodName;
213 llvm::raw_svector_ostream OS(MethodName);
214 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
215 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000216 if (const ObjCImplementationDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000217 dyn_cast<const ObjCImplementationDecl>(DC)) {
218 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000219 } else if (const ObjCInterfaceDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000220 dyn_cast<const ObjCInterfaceDecl>(DC)) {
221 OS << OID->getName();
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000222 } else if (const ObjCCategoryDecl *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
223 if (OC->IsClassExtension()) {
224 OS << OC->getClassInterface()->getName();
225 } else {
226 OS << ((const NamedDecl *)OC)->getIdentifier()->getNameStart() << '('
227 << OC->getIdentifier()->getNameStart() << ')';
228 }
Eric Christopherb2a008c2013-05-16 00:45:12 +0000229 } else if (const ObjCCategoryImplDecl *OCD =
Eric Christophere7b87e52014-10-26 23:40:33 +0000230 dyn_cast<const ObjCCategoryImplDecl>(DC)) {
231 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
232 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000233 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000234 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000235 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000236 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000237 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000238 ClassTy.print(OS, PrintingPolicy(LangOptions()));
239 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000240 }
241 OS << ' ' << OMD->getSelector().getAsString() << ']';
242
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000243 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000244}
245
Guy Benyei11169dd2012-12-18 14:30:41 +0000246StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000247 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000248}
249
Eric Christophere7b87e52014-10-26 23:40:33 +0000250StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Blaikie65813a32014-04-02 18:21:09 +0000251 // quick optimization to avoid having to intern strings that are already
252 // stored reliably elsewhere
253 if (!isa<ClassTemplateSpecializationDecl>(RD))
Guy Benyei11169dd2012-12-18 14:30:41 +0000254 return RD->getName();
255
David Blaikie65813a32014-04-02 18:21:09 +0000256 SmallString<128> Name;
Benjamin Kramer9170e912013-02-22 15:46:01 +0000257 {
David Blaikie65813a32014-04-02 18:21:09 +0000258 llvm::raw_svector_ostream OS(Name);
259 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
260 /*Qualified*/ false);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000261 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000262
263 // Copy this name on the side and use its reference.
David Blaikie65813a32014-04-02 18:21:09 +0000264 return internString(Name);
Guy Benyei11169dd2012-12-18 14:30:41 +0000265}
266
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000267llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000268 if (!Loc.isValid())
269 // If Location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000270 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
271 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000272
273 SourceManager &SM = CGM.getContext().getSourceManager();
274 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
275
276 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
277 // If the location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000278 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
279 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000280
281 // Cache the results.
282 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000283 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000284
285 if (it != DIFileCache.end()) {
286 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000287 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000288 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000289 }
290
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000291 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
292 remapDIPath(getCurrentDirname()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000293
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000294 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000295 return F;
296}
297
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000298llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000299 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
300 remapDIPath(TheCU->getDirectory()));
301}
302
303std::string CGDebugInfo::remapDIPath(StringRef Path) const {
304 for (const auto &Entry : DebugPrefixMap)
305 if (Path.startswith(Entry.first))
306 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
307 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000308}
309
Guy Benyei11169dd2012-12-18 14:30:41 +0000310unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
311 if (Loc.isInvalid() && CurLoc.isInvalid())
312 return 0;
313 SourceManager &SM = CGM.getContext().getSourceManager();
314 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000315 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000316}
317
Adrian Prantlc7822422013-03-12 20:43:25 +0000318unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000319 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000320 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000321 return 0;
322
323 // If the location is invalid then use the current column.
324 if (Loc.isInvalid() && CurLoc.isInvalid())
325 return 0;
326 SourceManager &SM = CGM.getContext().getSourceManager();
327 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000328 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000329}
330
331StringRef CGDebugInfo::getCurrentDirname() {
332 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
333 return CGM.getCodeGenOpts().DebugCompilationDir;
334
335 if (!CWDName.empty())
336 return CWDName;
337 SmallString<256> CWD;
338 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000339 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000340}
341
Guy Benyei11169dd2012-12-18 14:30:41 +0000342void CGDebugInfo::CreateCompileUnit() {
343
David Blaikieaabde052014-05-14 00:29:00 +0000344 // Should we be asking the SourceManager for the main file name, instead of
345 // accepting it as an argument? This just causes the main file name to
346 // mismatch with source locations and create extra lexical scopes or
347 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
348 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
349 // because that's what the SourceManager says)
350
Guy Benyei11169dd2012-12-18 14:30:41 +0000351 // Get absolute path name.
352 SourceManager &SM = CGM.getContext().getSourceManager();
353 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
354 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000355 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000356
357 // The main file name provided via the "-main-file-name" option contains just
358 // the file name itself with no path information. This file name may have had
359 // a relative path, so we look into the actual file entry for the main
360 // file to determine the real absolute path for the file.
361 std::string MainFileDir;
362 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000363 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000364 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000365 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
366 llvm::sys::path::append(MainFileDirSS, MainFileName);
367 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000368 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000369 }
370
Ed Masteda706022014-05-07 12:49:30 +0000371 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000372 const LangOptions &LO = CGM.getLangOpts();
373 if (LO.CPlusPlus) {
374 if (LO.ObjC1)
375 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
376 else
377 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
378 } else if (LO.ObjC1) {
379 LangTag = llvm::dwarf::DW_LANG_ObjC;
Pirama Arumuga Nainara7484c92016-06-21 21:35:11 +0000380 } else if (LO.RenderScript) {
381 LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
Guy Benyei11169dd2012-12-18 14:30:41 +0000382 } else if (LO.C99) {
383 LangTag = llvm::dwarf::DW_LANG_C99;
384 } else {
385 LangTag = llvm::dwarf::DW_LANG_C89;
386 }
387
388 std::string Producer = getClangFullVersion();
389
390 // Figure out which version of the ObjC runtime we have.
391 unsigned RuntimeVers = 0;
392 if (LO.ObjC1)
393 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
394
Adrian Prantl826824e2016-04-08 22:43:06 +0000395 llvm::DICompileUnit::DebugEmissionKind EmissionKind;
396 switch (DebugKind) {
397 case codegenoptions::NoDebugInfo:
398 case codegenoptions::LocTrackingOnly:
399 EmissionKind = llvm::DICompileUnit::NoDebug;
400 break;
401 case codegenoptions::DebugLineTablesOnly:
402 EmissionKind = llvm::DICompileUnit::LineTablesOnly;
403 break;
404 case codegenoptions::LimitedDebugInfo:
405 case codegenoptions::FullDebugInfo:
406 EmissionKind = llvm::DICompileUnit::FullDebug;
407 break;
408 }
409
Guy Benyei11169dd2012-12-18 14:30:41 +0000410 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000411 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000412 TheCU = DBuilder.createCompileUnit(
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000413 LangTag, remapDIPath(MainFileName), remapDIPath(getCurrentDirname()),
414 Producer, LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers,
Adrian Prantl826824e2016-04-08 22:43:06 +0000415 CGM.getCodeGenOpts().SplitDwarfFile, EmissionKind, 0 /* DWOid */);
Guy Benyei11169dd2012-12-18 14:30:41 +0000416}
417
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000418llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000419 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000420 StringRef BTName;
421 switch (BT->getKind()) {
422#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000423#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000424#include "clang/AST/BuiltinTypes.def"
425 case BuiltinType::Dependent:
426 llvm_unreachable("Unexpected builtin type");
427 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000428 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000429 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000430 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000431 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000432 if (!ClassTy)
433 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
434 "objc_class", TheCU,
435 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 return ClassTy;
437 case BuiltinType::ObjCId: {
438 // typedef struct objc_class *Class;
439 // typedef struct objc_object {
440 // Class isa;
441 // } *id;
442
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000443 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000444 return ObjTy;
445
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000446 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000447 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
448 "objc_class", TheCU,
449 getOrCreateMainFile(), 0);
450
451 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000452
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000453 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000454
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000455 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000456 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000457 0, 0, 0, 0, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000458
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000459 DBuilder.replaceArrays(
460 ObjTy,
461 DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
462 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 return ObjTy;
464 }
465 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000466 if (!SelTy)
467 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
468 "objc_selector", TheCU,
469 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000470 return SelTy;
471 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000472
Alexey Bader954ba212016-04-08 13:40:33 +0000473#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
474 case BuiltinType::Id: \
475 return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
476 SingletonId);
Alexey Baderb62f1442016-04-13 08:33:41 +0000477#include "clang/Basic/OpenCLImageTypes.def"
Guy Benyei61054192013-02-07 10:55:47 +0000478 case BuiltinType::OCLSampler:
Eric Christophere7b87e52014-10-26 23:40:33 +0000479 return DBuilder.createBasicType(
480 "opencl_sampler_t", CGM.getContext().getTypeSize(BT),
481 CGM.getContext().getTypeAlign(BT), llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000482 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000483 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000484 case BuiltinType::OCLClkEvent:
485 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
486 case BuiltinType::OCLQueue:
487 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
488 case BuiltinType::OCLNDRange:
489 return getOrCreateStructPtrType("opencl_ndrange_t", OCLNDRangeDITy);
490 case BuiltinType::OCLReserveID:
491 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000492
Guy Benyei11169dd2012-12-18 14:30:41 +0000493 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000494 case BuiltinType::Char_U:
495 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
496 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000497 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000498 case BuiltinType::SChar:
499 Encoding = llvm::dwarf::DW_ATE_signed_char;
500 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000501 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000502 case BuiltinType::Char32:
503 Encoding = llvm::dwarf::DW_ATE_UTF;
504 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000505 case BuiltinType::UShort:
506 case BuiltinType::UInt:
507 case BuiltinType::UInt128:
508 case BuiltinType::ULong:
509 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000510 case BuiltinType::ULongLong:
511 Encoding = llvm::dwarf::DW_ATE_unsigned;
512 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000513 case BuiltinType::Short:
514 case BuiltinType::Int:
515 case BuiltinType::Int128:
516 case BuiltinType::Long:
517 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000518 case BuiltinType::LongLong:
519 Encoding = llvm::dwarf::DW_ATE_signed;
520 break;
521 case BuiltinType::Bool:
522 Encoding = llvm::dwarf::DW_ATE_boolean;
523 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000524 case BuiltinType::Half:
525 case BuiltinType::Float:
526 case BuiltinType::LongDouble:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000527 case BuiltinType::Float128:
Eric Christophere7b87e52014-10-26 23:40:33 +0000528 case BuiltinType::Double:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +0000529 // FIXME: For targets where long double and __float128 have the same size,
530 // they are currently indistinguishable in the debugger without some
531 // special treatment. However, there is currently no consensus on encoding
532 // and this should be updated once a DWARF encoding exists for distinct
533 // floating point types of the same size.
Eric Christophere7b87e52014-10-26 23:40:33 +0000534 Encoding = llvm::dwarf::DW_ATE_float;
535 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000536 }
537
538 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000539 case BuiltinType::Long:
540 BTName = "long int";
541 break;
542 case BuiltinType::LongLong:
543 BTName = "long long int";
544 break;
545 case BuiltinType::ULong:
546 BTName = "long unsigned int";
547 break;
548 case BuiltinType::ULongLong:
549 BTName = "long long unsigned int";
550 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000551 default:
552 BTName = BT->getName(CGM.getLangOpts());
553 break;
554 }
555 // Bit size, align and offset of the type.
556 uint64_t Size = CGM.getContext().getTypeSize(BT);
557 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000558 return DBuilder.createBasicType(BTName, Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000559}
560
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000561llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000562 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000563 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000564 if (Ty->isComplexIntegerType())
565 Encoding = llvm::dwarf::DW_ATE_lo_user;
566
567 uint64_t Size = CGM.getContext().getTypeSize(Ty);
568 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000569 return DBuilder.createBasicType("complex", Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000570}
571
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000572llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
573 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000574 QualifierCollector Qc;
575 const Type *T = Qc.strip(Ty);
576
577 // Ignore these qualifiers for now.
578 Qc.removeObjCGCAttr();
579 Qc.removeAddressSpace();
580 Qc.removeObjCLifetime();
581
582 // We will create one Derived type for one qualifier and recurse to handle any
583 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000584 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000585 if (Qc.hasConst()) {
586 Tag = llvm::dwarf::DW_TAG_const_type;
587 Qc.removeConst();
588 } else if (Qc.hasVolatile()) {
589 Tag = llvm::dwarf::DW_TAG_volatile_type;
590 Qc.removeVolatile();
591 } else if (Qc.hasRestrict()) {
592 Tag = llvm::dwarf::DW_TAG_restrict_type;
593 Qc.removeRestrict();
594 } else {
595 assert(Qc.empty() && "Unknown type qualifier for debug info");
596 return getOrCreateType(QualType(T, 0), Unit);
597 }
598
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000599 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000600
601 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
602 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000603 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000604}
605
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000606llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
607 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000608
609 // The frontend treats 'id' as a typedef to an ObjCObjectType,
610 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
611 // debug info, we want to emit 'id' in both cases.
612 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000613 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000614
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000615 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
616 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000617}
618
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000619llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
620 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000621 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000622 Ty->getPointeeType(), Unit);
623}
624
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000625/// \return whether a C++ mangling exists for the type defined by TD.
626static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
627 switch (TheCU->getSourceLanguage()) {
628 case llvm::dwarf::DW_LANG_C_plus_plus:
629 return true;
630 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
631 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
632 default:
633 return false;
634 }
635}
636
Manman Rene0064d82013-08-29 23:19:58 +0000637/// In C++ mode, types have linkage, so we can rely on the ODR and
638/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000639static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
640 CodeGenModule &CGM,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000641 llvm::DICompileUnit *TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000642 SmallString<256> FullName;
Manman Rene0064d82013-08-29 23:19:58 +0000643 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000644
645 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
Manman Rene0064d82013-08-29 23:19:58 +0000646 return FullName;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000647
Manman Rene0064d82013-08-29 23:19:58 +0000648 // TODO: This is using the RTTI name. Is there a better way to get
649 // a unique string for a type?
650 llvm::raw_svector_ostream Out(FullName);
651 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Manman Rene0064d82013-08-29 23:19:58 +0000652 return FullName;
653}
654
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000655/// \return the approproate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000656static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
657 llvm::dwarf::Tag Tag;
658 if (RD->isStruct() || RD->isInterface())
659 Tag = llvm::dwarf::DW_TAG_structure_type;
660 else if (RD->isUnion())
661 Tag = llvm::dwarf::DW_TAG_union_type;
662 else {
663 // FIXME: This could be a struct type giving a default visibility different
664 // than C++ class type, but needs llvm metadata changes first.
665 assert(RD->isClass());
666 Tag = llvm::dwarf::DW_TAG_class_type;
667 }
668 return Tag;
669}
670
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000671llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000672CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000673 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000674 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000675 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
676 return cast<llvm::DICompositeType>(T);
677 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000678 unsigned Line = getLineNumber(RD->getLocation());
679 StringRef RDName = getClassName(RD);
680
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000681 uint64_t Size = 0;
682 uint64_t Align = 0;
683
684 const RecordDecl *D = RD->getDefinition();
685 if (D && D->isCompleteDefinition()) {
686 Size = CGM.getContext().getTypeSize(Ty);
687 Align = CGM.getContext().getTypeAlign(Ty);
688 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000689
690 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000691 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000692 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000693 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000694 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000695 ReplaceMap.emplace_back(
696 std::piecewise_construct, std::make_tuple(Ty),
697 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000698 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000699}
700
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000701llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000702 const Type *Ty,
703 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000704 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000705 // Bit size, align and offset of the type.
706 // Size is always the size of a pointer. We can't use getTypeSize here
707 // because that does not return the correct value for references.
708 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000709 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000710 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
711
Keno Fischer87842f32015-11-16 09:04:13 +0000712 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
713 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
714 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
715 Size, Align);
716 else
717 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
718 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000719}
720
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000721llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
722 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000723 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000724 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000725 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
726 TheCU, getOrCreateMainFile(), 0);
727 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
728 Cache = DBuilder.createPointerType(Cache, Size);
729 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000730}
731
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000732llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
733 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000734 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000735 QualType FType;
736 uint64_t FieldSize, FieldOffset;
737 unsigned FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000738 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000739
740 FieldOffset = 0;
741 FType = CGM.getContext().UnsignedLongTy;
742 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
743 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
744
745 Elements = DBuilder.getOrCreateArray(EltTys);
746 EltTys.clear();
747
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000748 unsigned Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000749 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000750
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000751 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000752 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000753 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000754
755 // Bit size, align and offset of the type.
756 uint64_t Size = CGM.getContext().getTypeSize(Ty);
757
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000758 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000759
760 FieldOffset = 0;
761 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
762 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
763 FType = CGM.getContext().IntTy;
764 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
765 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000766 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000767 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
768
769 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000770 FieldSize = CGM.getContext().getTypeSize(Ty);
771 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Adrian Prantl498fff62015-07-06 21:31:35 +0000772 EltTys.push_back(DBuilder.createMemberType(Unit, "__descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000773 FieldSize, FieldAlign, FieldOffset,
774 0, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000775
776 FieldOffset += FieldSize;
777 Elements = DBuilder.getOrCreateArray(EltTys);
778
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000779 // The __block_literal_generic structs are marked with a special
780 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
781 // the debugger needs to know about. To allow type uniquing, emit
782 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000783 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000784 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000785 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000786
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000787 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000788}
789
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000790llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
791 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000792 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000793 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000794
795 SmallString<128> NS;
796 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000797 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
798 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000799
800 TemplateSpecializationType::PrintTemplateArgumentList(
801 OS, Ty->getArgs(), Ty->getNumArgs(),
802 CGM.getContext().getPrintingPolicy());
803
Eric Christophere7b87e52014-10-26 23:40:33 +0000804 TypeAliasDecl *AliasDecl = cast<TypeAliasTemplateDecl>(
805 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000806
807 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000808 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
809 getLineNumber(Loc),
810 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000811}
812
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000813llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
814 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000815 // We don't set size information, but do specify where the typedef was
816 // declared.
Amjad Abouddc4531e2016-04-30 01:44:38 +0000817 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000818
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000819 // Typedefs are derived from some other type.
820 return DBuilder.createTypedef(
821 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
822 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Amjad Abouddc4531e2016-04-30 01:44:38 +0000823 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000824}
825
Reid Klecknerf00f8032016-06-08 20:41:54 +0000826static unsigned getDwarfCC(CallingConv CC) {
827 switch (CC) {
828 case CC_C:
829 // Avoid emitting DW_AT_calling_convention if the C convention was used.
830 return 0;
831
832 case CC_X86StdCall:
833 return llvm::dwarf::DW_CC_BORLAND_stdcall;
834 case CC_X86FastCall:
835 return llvm::dwarf::DW_CC_BORLAND_msfastcall;
836 case CC_X86ThisCall:
837 return llvm::dwarf::DW_CC_BORLAND_thiscall;
838 case CC_X86VectorCall:
839 return llvm::dwarf::DW_CC_LLVM_vectorcall;
840 case CC_X86Pascal:
841 return llvm::dwarf::DW_CC_BORLAND_pascal;
842
843 // FIXME: Create new DW_CC_ codes for these calling conventions.
844 case CC_X86_64Win64:
845 case CC_X86_64SysV:
846 case CC_AAPCS:
847 case CC_AAPCS_VFP:
848 case CC_IntelOclBicc:
849 case CC_SpirFunction:
850 case CC_SpirKernel:
851 case CC_Swift:
852 case CC_PreserveMost:
853 case CC_PreserveAll:
854 return 0;
855 }
856 return 0;
857}
858
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000859llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
860 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000861 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000862
863 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000864 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000865
866 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000867 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000868 if (isa<FunctionNoProtoType>(Ty))
869 EltTys.push_back(DBuilder.createUnspecifiedParameter());
870 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000871 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
872 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000873 if (FPT->isVariadic())
874 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000875 }
876
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000877 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Reid Klecknerf00f8032016-06-08 20:41:54 +0000878 return DBuilder.createSubroutineType(EltTypeArray, 0,
879 getDwarfCC(Ty->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000880}
881
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000882/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000883/// As an optimization, return 0 if the access specifier equals the
884/// default for the containing type.
885static unsigned getAccessFlag(AccessSpecifier Access, const RecordDecl *RD) {
886 AccessSpecifier Default = clang::AS_none;
887 if (RD && RD->isClass())
888 Default = clang::AS_private;
889 else if (RD && (RD->isStruct() || RD->isUnion()))
890 Default = clang::AS_public;
891
892 if (Access == Default)
893 return 0;
894
Eric Christophere7b87e52014-10-26 23:40:33 +0000895 switch (Access) {
896 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000897 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +0000898 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000899 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +0000900 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000901 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +0000902 case clang::AS_none:
903 return 0;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000904 }
905 llvm_unreachable("unexpected access enumerator");
906}
Guy Benyei11169dd2012-12-18 14:30:41 +0000907
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000908llvm::DIType *CGDebugInfo::createFieldType(
Eric Christophere7b87e52014-10-26 23:40:33 +0000909 StringRef name, QualType type, uint64_t sizeInBitsOverride,
910 SourceLocation loc, AccessSpecifier AS, uint64_t offsetInBits,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000911 llvm::DIFile *tunit, llvm::DIScope *scope, const RecordDecl *RD) {
912 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000913
914 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000915 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000916 unsigned line = getLineNumber(loc);
917
David Majnemer34b57492014-07-30 01:30:47 +0000918 uint64_t SizeInBits = 0;
919 unsigned AlignInBits = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000920 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +0000921 TypeInfo TI = CGM.getContext().getTypeInfo(type);
922 SizeInBits = TI.Width;
923 AlignInBits = TI.Align;
Guy Benyei11169dd2012-12-18 14:30:41 +0000924
925 if (sizeInBitsOverride)
David Majnemer34b57492014-07-30 01:30:47 +0000926 SizeInBits = sizeInBitsOverride;
Guy Benyei11169dd2012-12-18 14:30:41 +0000927 }
928
Adrian Prantl21361fb2014-08-29 22:44:27 +0000929 unsigned flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +0000930 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
931 AlignInBits, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +0000932}
933
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000934void CGDebugInfo::CollectRecordLambdaFields(
935 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000936 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000937 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
938 // has the name and the location of the variable so we should iterate over
939 // both concurrently.
940 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
941 RecordDecl::field_iterator Field = CXXDecl->field_begin();
942 unsigned fieldno = 0;
943 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +0000944 E = CXXDecl->captures_end();
945 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +0000946 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +0000947 if (C.capturesVariable()) {
948 VarDecl *V = C.getCapturedVar();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000949 llvm::DIFile *VUnit = getOrCreateFile(C.getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +0000950 StringRef VName = V->getName();
951 uint64_t SizeInBitsOverride = 0;
952 if (Field->isBitField()) {
953 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
954 assert(SizeInBitsOverride && "found named 0-width bitfield");
955 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000956 llvm::DIType *fieldType = createFieldType(
Eric Christophere7b87e52014-10-26 23:40:33 +0000957 VName, Field->getType(), SizeInBitsOverride, C.getLocation(),
958 Field->getAccess(), layout.getFieldOffset(fieldno), VUnit, RecordTy,
959 CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000960 elements.push_back(fieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +0000961 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +0000962 // TODO: Need to handle 'this' in some way by probably renaming the
963 // this of the lambda class and having a field member of 'this' or
964 // by using AT_object_pointer for the function and having that be
965 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +0000966 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000967 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +0000968 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000969 llvm::DIType *fieldType = createFieldType(
Eric Christophere7b87e52014-10-26 23:40:33 +0000970 "this", type, 0, f->getLocation(), f->getAccess(),
971 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000972
973 elements.push_back(fieldType);
974 }
975 }
976}
977
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000978llvm::DIDerivedType *
979CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +0000980 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000981 // Create the descriptor for the static variable, with or without
982 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +0000983 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000984 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
985 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +0000986
Eric Christopher91a31902013-01-16 01:22:32 +0000987 unsigned LineNumber = getLineNumber(Var->getLocation());
988 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +0000989 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +0000990 if (Var->getInit()) {
991 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000992 if (Value) {
993 if (Value->isInt())
994 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
995 if (Value->isFloat())
996 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
997 }
Eric Christopher91a31902013-01-16 01:22:32 +0000998 }
999
Adrian Prantl21361fb2014-08-29 22:44:27 +00001000 unsigned Flags = getAccessFlag(Var->getAccess(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001001 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
David Blaikieae019462013-08-15 22:50:29 +00001002 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001003 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +00001004 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +00001005}
1006
Eric Christophere7b87e52014-10-26 23:40:33 +00001007void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001008 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1009 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +00001010 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +00001011 StringRef name = field->getName();
1012 QualType type = field->getType();
1013
1014 // Ignore unnamed fields unless they're anonymous structs/unions.
1015 if (name.empty() && !type->isRecordType())
1016 return;
1017
1018 uint64_t SizeInBitsOverride = 0;
1019 if (field->isBitField()) {
1020 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
1021 assert(SizeInBitsOverride && "found named 0-width bitfield");
1022 }
1023
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001024 llvm::DIType *fieldType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001025 createFieldType(name, type, SizeInBitsOverride, field->getLocation(),
1026 field->getAccess(), OffsetInBits, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001027
1028 elements.push_back(fieldType);
1029}
1030
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001031void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001032 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001033 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001034 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001035 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1036
Eric Christopher91a31902013-01-16 01:22:32 +00001037 if (CXXDecl && CXXDecl->isLambda())
1038 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1039 else {
1040 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001041
Eric Christopher91a31902013-01-16 01:22:32 +00001042 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001043 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001044
Eric Christopher91a31902013-01-16 01:22:32 +00001045 // Static and non-static members should appear in the same order as
1046 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001047 for (const auto *I : record->decls())
1048 if (const auto *V = dyn_cast<VarDecl>(I)) {
Paul Robinsonb17327d2016-04-27 17:37:12 +00001049 if (V->hasAttr<NoDebugAttr>())
1050 continue;
David Blaikiece763042013-08-20 21:49:21 +00001051 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001052 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001053 if (MI != StaticDataMemberCache.end()) {
1054 assert(MI->second &&
1055 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001056 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001057 } else {
1058 auto Field = CreateRecordStaticField(V, RecordTy, record);
1059 elements.push_back(Field);
1060 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001061 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001062 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1063 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001064
1065 // Bump field number for next field.
1066 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +00001067 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001068 }
1069}
1070
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001071llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001072CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001073 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001074 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001075 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001076 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001077 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001078 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1079 Func, Unit);
1080}
David Blaikie2aaf0652013-01-07 22:24:59 +00001081
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001082llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1083 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001084 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001085 llvm::DITypeRefArray Args(
1086 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001087 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001088 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001089
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001090 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001091
1092 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001093 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001094
David Blaikie2aaf0652013-01-07 22:24:59 +00001095 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001096 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001097 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1098 // Create pointer type directly in this case.
1099 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1100 QualType PointeeTy = ThisPtrTy->getPointeeType();
1101 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001102 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001103 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001104 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1105 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001106 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001107 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001108 // TODO: This and the artificial type below are misleading, the
1109 // types aren't artificial the argument is, but the current
1110 // metadata doesn't represent that.
1111 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1112 Elts.push_back(ThisPtrType);
1113 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001114 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001115 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001116 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1117 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001118 }
1119
1120 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001121 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1122 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001123
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001124 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001125
Adrian Prantl0630eb72013-12-18 21:48:18 +00001126 unsigned Flags = 0;
1127 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001128 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001129 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001130 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001131
Reid Klecknerf00f8032016-06-08 20:41:54 +00001132 return DBuilder.createSubroutineType(EltTypeArray, Flags,
1133 getDwarfCC(Func->getCallConv()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001134}
1135
Eric Christopherb2a008c2013-05-16 00:45:12 +00001136/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001137/// inside a function.
1138static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1139 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1140 return isFunctionLocalClass(NRD);
1141 if (isa<FunctionDecl>(RD->getDeclContext()))
1142 return true;
1143 return false;
1144}
1145
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001146llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1147 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001148 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001149 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001150
Guy Benyei11169dd2012-12-18 14:30:41 +00001151 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001152 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001153
1154 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1155 // make sense to give a single ctor/dtor a linkage name.
1156 StringRef MethodLinkageName;
David Blaikie71647672016-04-12 21:22:48 +00001157 // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1158 // property to use here. It may've been intended to model "is non-external
1159 // type" but misses cases of non-function-local but non-external classes such
1160 // as those in anonymous namespaces as well as the reverse - external types
1161 // that are function local, such as those in (non-local) inline functions.
Guy Benyei11169dd2012-12-18 14:30:41 +00001162 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1163 MethodLinkageName = CGM.getMangledName(Method);
1164
1165 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001166 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001167 unsigned MethodLine = 0;
1168 if (!Method->isImplicit()) {
1169 MethodDefUnit = getOrCreateFile(Method->getLocation());
1170 MethodLine = getLineNumber(Method->getLocation());
1171 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001172
1173 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001174 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001175 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001176 unsigned VIndex = 0;
Reid Klecknerfb727182016-06-17 22:27:59 +00001177 unsigned Flags = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001178
Guy Benyei11169dd2012-12-18 14:30:41 +00001179 if (Method->isVirtual()) {
1180 if (Method->isPure())
1181 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1182 else
1183 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001184
Reid Kleckner216d0a12016-06-16 20:08:51 +00001185 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1186 // It doesn't make sense to give a virtual destructor a vtable index,
1187 // since a single destructor has two entries in the vtable.
1188 if (!isa<CXXDestructorDecl>(Method))
1189 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1190 } else {
1191 // Emit MS ABI vftable information. There is only one entry for the
1192 // deleting dtor.
1193 const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1194 GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1195 MicrosoftVTableContext::MethodVFTableLocation ML =
1196 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1197 VIndex = ML.Index;
Reid Klecknerc4871ed2016-06-22 18:34:45 +00001198
1199 // CodeView only records the vftable offset in the class that introduces
1200 // the virtual method. This is possible because, unlike Itanium, the MS
1201 // C++ ABI does not include all virtual methods from non-primary bases in
1202 // the vtable for the most derived class. For example, if C inherits from
1203 // A and B, C's primary vftable will not include B's virtual methods.
1204 if (Method->begin_overridden_methods() == Method->end_overridden_methods())
1205 Flags |= llvm::DINode::FlagIntroducedVirtual;
1206
Reid Kleckner216d0a12016-06-16 20:08:51 +00001207 // FIXME: Pass down ML.VFPtrOffset and ML.VBTableIndex. The debugger needs
1208 // these to synthesize a call to a virtual method in a complex inheritance
1209 // hierarchy.
1210 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001211 ContainingType = RecordTy;
1212 }
1213
Guy Benyei11169dd2012-12-18 14:30:41 +00001214 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001215 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001216 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
Guy Benyei11169dd2012-12-18 14:30:41 +00001217 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1218 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001219 Flags |= llvm::DINode::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001220 } else if (const CXXConversionDecl *CXXC =
Eric Christophere7b87e52014-10-26 23:40:33 +00001221 dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001222 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001223 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001224 }
1225 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001226 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001227 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001228 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001229 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001230 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001231
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001232 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1233 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001234 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1235 MethodTy, /*isLocalToUnit=*/false,
1236 /* isDefinition=*/false, Virtuality, VIndex, ContainingType, Flags,
Peter Collingbourne0900fe02015-11-05 22:04:14 +00001237 CGM.getLangOpts().Optimize, TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001238
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001239 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001240
1241 return SP;
1242}
1243
Eric Christophere7b87e52014-10-26 23:40:33 +00001244void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001245 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1246 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001247
1248 // Since we want more than just the individual member decls if we
1249 // have templated functions iterate over every declaration to gather
1250 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001251 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001252 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1253 // If the member is implicit, don't add it to the member list. This avoids
1254 // the member being added to type units by LLVM, while still allowing it
1255 // to be emitted into the type declaration/reference inside the compile
1256 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001257 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001258 // FIXME: Handle Using(Shadow?)Decls here to create
1259 // DW_TAG_imported_declarations inside the class for base decls brought into
1260 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1261 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1262 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001263 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001264 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001265
1266 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1267 continue;
1268
David Blaikiefd580722014-10-06 05:18:55 +00001269 // Reuse the existing member function declaration if it exists.
1270 // It may be associated with the declaration of the type & should be
1271 // reused as we're building the definition.
1272 //
1273 // This situation can arise in the vtable-based debug info reduction where
1274 // implicit members are emitted in a non-vtable TU.
1275 auto MI = SPCache.find(Method->getCanonicalDecl());
1276 EltTys.push_back(MI == SPCache.end()
1277 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001278 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001279 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001280}
Guy Benyei11169dd2012-12-18 14:30:41 +00001281
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001282void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001283 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001284 llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001285 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001286 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001287 unsigned BFlags = 0;
1288 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001289
Guy Benyei11169dd2012-12-18 14:30:41 +00001290 const CXXRecordDecl *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001291 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001292
Aaron Ballman574705e2014-03-13 15:41:46 +00001293 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001294 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1295 // virtual base offset offset is -ve. The code generator emits dwarf
1296 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001297 BaseOffset = 0 - CGM.getItaniumVTableContext()
1298 .getVirtualBaseOffsetOffset(RD, Base)
1299 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001300 } else {
1301 // In the MS ABI, store the vbtable offset, which is analogous to the
1302 // vbase offset offset in Itanium.
1303 BaseOffset =
1304 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1305 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001306 BFlags = llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001307 } else
1308 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1309 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1310 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001311
Adrian Prantl21361fb2014-08-29 22:44:27 +00001312 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001313 llvm::DIType *DTy = DBuilder.createInheritance(
Eric Christophere7b87e52014-10-26 23:40:33 +00001314 RecordTy, getOrCreateType(BI.getType(), Unit), BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001315 EltTys.push_back(DTy);
1316 }
1317}
1318
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001319llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001320CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1321 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001322 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001323 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001324 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1325 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001326 StringRef Name;
1327 if (TPList)
1328 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001329 switch (TA.getKind()) {
1330 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001331 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001332 TemplateParams.push_back(
1333 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001334 } break;
1335 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001336 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001337 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1338 TheCU, Name, TTy,
1339 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001340 } break;
1341 case TemplateArgument::Declaration: {
1342 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001343 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001344 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001345 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001346 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001347 // Variable pointer template parameters have a value that is the address
1348 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001349 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001350 V = CGM.GetAddrOfGlobalVar(VD);
1351 // Member function pointers have special support for building them, though
1352 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001353 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001354 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001355 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001356 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001357 // Member data pointers have special handling too to compute the fixed
1358 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001359 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001360 // These five lines (& possibly the above member function pointer
1361 // handling) might be able to be refactored to use similar code in
1362 // CodeGenModule::getMemberPointerConstant
1363 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1364 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001365 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001366 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001367 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001368 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1369 TheCU, Name, TTy,
1370 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001371 } break;
1372 case TemplateArgument::NullPtr: {
1373 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001374 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001375 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001376 // Special case member data pointer null values since they're actually -1
1377 // instead of zero.
1378 if (const MemberPointerType *MPT =
1379 dyn_cast<MemberPointerType>(T.getTypePtr()))
1380 // But treat member function pointers as simple zero integers because
1381 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1382 // CodeGen grows handling for values of non-null member function
1383 // pointers then perhaps we could remove this special case and rely on
1384 // EmitNullMemberPointer for member function pointers.
1385 if (MPT->isMemberDataPointer())
1386 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1387 if (!V)
1388 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001389 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1390 TheCU, Name, TTy, cast<llvm::Constant>(V)));
David Blaikie38079fd2013-05-10 21:53:14 +00001391 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001392 case TemplateArgument::Template:
1393 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001394 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001395 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1396 break;
1397 case TemplateArgument::Pack:
1398 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1399 TheCU, Name, nullptr,
1400 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1401 break;
David Majnemer5559d472013-08-24 08:21:10 +00001402 case TemplateArgument::Expression: {
1403 const Expr *E = TA.getAsExpr();
1404 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001405 if (E->isGLValue())
1406 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001407 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001408 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001409 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001410 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1411 TheCU, Name, TTy, cast<llvm::Constant>(V->stripPointerCasts())));
David Majnemer5559d472013-08-24 08:21:10 +00001412 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001413 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001414 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001415 case TemplateArgument::Null:
1416 llvm_unreachable(
1417 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001418 }
1419 }
1420 return DBuilder.getOrCreateArray(TemplateParams);
1421}
1422
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001423llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001424CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001425 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001426 if (FD->getTemplatedKind() ==
1427 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001428 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1429 ->getTemplate()
1430 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001431 return CollectTemplateParams(
1432 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001433 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001434 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001435}
1436
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001437llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1438 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001439 // Always get the full list of parameters, not just the ones from
1440 // the specialization.
1441 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001442 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001443 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001444 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001445}
1446
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001447llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001448 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001449 return VTablePtrType;
1450
1451 ASTContext &Context = CGM.getContext();
1452
1453 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001454 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001455 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001456 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001457 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001458 llvm::DIType *vtbl_ptr_type =
Eric Christophere7b87e52014-10-26 23:40:33 +00001459 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001460 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1461 return VTablePtrType;
1462}
1463
Guy Benyei11169dd2012-12-18 14:30:41 +00001464StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001465 // Copy the gdb compatible name on the side and use its reference.
1466 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001467}
1468
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001469void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001470 SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001471 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1472
1473 // If there is a primary base then it will hold vtable info.
1474 if (RL.getPrimaryBase())
1475 return;
1476
1477 // If this class is not dynamic then there is not any vtable info to collect.
1478 if (!RD->isDynamicClass())
1479 return;
1480
1481 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001482 llvm::DIType *VPTR = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001483 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001484 llvm::DINode::FlagArtificial, getOrCreateVTablePtrType(Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001485 EltTys.push_back(VPTR);
1486}
1487
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001488llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001489 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001490 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001491 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001492 return T;
1493}
1494
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001495llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001496 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001497 return getOrCreateStandaloneType(D, Loc);
1498}
1499
1500llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1501 SourceLocation Loc) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001502 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001503 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001504 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001505 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001506
Adrian Prantl73409ce2013-03-11 18:33:46 +00001507 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001508 return T;
1509}
1510
David Blaikie483a9da2014-05-06 18:35:21 +00001511void CGDebugInfo::completeType(const EnumDecl *ED) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001512 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie483a9da2014-05-06 18:35:21 +00001513 return;
1514 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001515 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001516 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001517 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001518 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001519 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001520 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001521 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001522}
1523
David Blaikieb2e86eb2013-08-15 20:49:17 +00001524void CGDebugInfo::completeType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001525 if (DebugKind > codegenoptions::LimitedDebugInfo ||
David Blaikieb2e86eb2013-08-15 20:49:17 +00001526 !CGM.getLangOpts().CPlusPlus)
1527 completeRequiredType(RD);
1528}
1529
1530void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001531 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00001532 return;
1533
David Blaikie6943dea2013-08-20 01:28:15 +00001534 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1535 if (CXXDecl->isDynamicClass())
1536 return;
1537
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001538 if (DebugTypeExtRefs && RD->isFromASTFile())
1539 return;
1540
David Blaikieb2e86eb2013-08-15 20:49:17 +00001541 QualType Ty = CGM.getContext().getRecordType(RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001542 llvm::DIType *T = getTypeOrNull(Ty);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001543 if (T && T->isForwardDecl())
David Blaikie6943dea2013-08-20 01:28:15 +00001544 completeClassData(RD);
1545}
1546
1547void CGDebugInfo::completeClassData(const RecordDecl *RD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00001548 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001549 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001550 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001551 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001552 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001553 if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001554 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001555 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001556 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001557 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001558}
1559
David Blaikie0e716b42014-03-03 23:48:23 +00001560static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1561 CXXRecordDecl::method_iterator End) {
1562 for (; I != End; ++I)
1563 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001564 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1565 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001566 return true;
1567 return false;
1568}
1569
Adrian Prantl05fefa42016-04-25 20:52:40 +00001570/// Does a type definition exist in an imported clang module?
1571static bool isDefinedInClangModule(const RecordDecl *RD) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001572 if (!RD || !RD->isFromASTFile())
Adrian Prantl05fefa42016-04-25 20:52:40 +00001573 return false;
1574 if (!RD->isExternallyVisible() && RD->getName().empty())
1575 return false;
Adrian Prantl94913712016-04-26 23:42:43 +00001576 if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
1577 assert(CXXDecl->isCompleteDefinition() && "incomplete record definition");
Adrian Prantl0dabc2a2016-04-26 23:37:38 +00001578 if (CXXDecl->getTemplateSpecializationKind() != TSK_Undeclared)
1579 // Make sure the instantiation is actually in a module.
1580 if (CXXDecl->field_begin() != CXXDecl->field_end())
1581 return CXXDecl->field_begin()->isFromASTFile();
Adrian Prantl94913712016-04-26 23:42:43 +00001582 }
Adrian Prantl0dabc2a2016-04-26 23:37:38 +00001583
Adrian Prantl05fefa42016-04-25 20:52:40 +00001584 return true;
1585}
1586
Benjamin Kramer8c305922016-02-02 11:06:51 +00001587static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind,
1588 bool DebugTypeExtRefs, const RecordDecl *RD,
David Blaikie0e716b42014-03-03 23:48:23 +00001589 const LangOptions &LangOpts) {
Adrian Prantl88d79172016-04-26 21:58:18 +00001590 if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
Adrian Prantl43e00812016-01-19 23:42:53 +00001591 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001592
Benjamin Kramer8c305922016-02-02 11:06:51 +00001593 if (DebugKind > codegenoptions::LimitedDebugInfo)
David Blaikie0e716b42014-03-03 23:48:23 +00001594 return false;
1595
1596 if (!LangOpts.CPlusPlus)
1597 return false;
1598
1599 if (!RD->isCompleteDefinitionRequired())
1600 return true;
1601
1602 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1603
1604 if (!CXXDecl)
1605 return false;
1606
1607 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1608 return true;
1609
1610 TemplateSpecializationKind Spec = TSK_Undeclared;
1611 if (const ClassTemplateSpecializationDecl *SD =
1612 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1613 Spec = SD->getSpecializationKind();
1614
1615 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1616 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1617 CXXDecl->method_end()))
1618 return true;
1619
1620 return false;
1621}
1622
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001623llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001624 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001625 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001626 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1627 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001628 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001629 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001630 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001631 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001632
David Blaikieb2e86eb2013-08-15 20:49:17 +00001633 return CreateTypeDefinition(Ty);
1634}
1635
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001636llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001637 RecordDecl *RD = Ty->getDecl();
1638
Guy Benyei11169dd2012-12-18 14:30:41 +00001639 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001640 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001641
1642 // Records and classes and unions can all be recursive. To handle them, we
1643 // first generate a debug descriptor for the struct as a forward declaration.
1644 // Then (if it is a definition) we go through and get debug info for all of
1645 // its members. Finally, we create a descriptor for the complete type (which
1646 // may refer to the forward decl if the struct is recursive) and replace all
1647 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001648 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001649
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001650 const RecordDecl *D = RD->getDefinition();
1651 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001652 return FwdDecl;
1653
David Blaikieadfbf992013-08-18 16:55:33 +00001654 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1655 CollectContainingType(CXXDecl, FwdDecl);
1656
Guy Benyei11169dd2012-12-18 14:30:41 +00001657 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001658 LexicalBlockStack.emplace_back(&*FwdDecl);
1659 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001660
Guy Benyei11169dd2012-12-18 14:30:41 +00001661 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001662 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001663 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001664
1665 // Note: The split of CXXDecl information here is intentional, the
1666 // gdb tests will depend on a certain ordering at printout. The debug
1667 // information offsets are still correct if we merge them all together
1668 // though.
1669 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1670 if (CXXDecl) {
1671 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1672 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1673 }
1674
Eric Christopher91a31902013-01-16 01:22:32 +00001675 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001676 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001677 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001678 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001679
1680 LexicalBlockStack.pop_back();
1681 RegionMap.erase(Ty->getDecl());
1682
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001683 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001684 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001685
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001686 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001687 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001688 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001689
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001690 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001691 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001692}
1693
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001694llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1695 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001696 // Ignore protocols.
1697 return getOrCreateType(Ty->getBaseType(), Unit);
1698}
1699
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001700/// \return true if Getter has the default name for the property PD.
1701static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1702 const ObjCMethodDecl *Getter) {
1703 assert(PD);
1704 if (!Getter)
1705 return true;
1706
1707 assert(Getter->getDeclName().isObjCZeroArgSelector());
1708 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001709 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001710}
1711
1712/// \return true if Setter has the default name for the property PD.
1713static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1714 const ObjCMethodDecl *Setter) {
1715 assert(PD);
1716 if (!Setter)
1717 return true;
1718
1719 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001720 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001721 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001722}
1723
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001724llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1725 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001726 ObjCInterfaceDecl *ID = Ty->getDecl();
1727 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001728 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001729
Adrian Prantl50fd1a82016-04-20 23:59:32 +00001730 // Return a forward declaration if this type was imported from a clang module,
1731 // and this is not the compile unit with the implementation of the type (which
1732 // may contain hidden ivars).
1733 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
1734 !ID->getImplementation())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001735 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1736 ID->getName(),
1737 getDeclContextDescriptor(ID), Unit, 0);
1738
Guy Benyei11169dd2012-12-18 14:30:41 +00001739 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001740 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001741 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001742 auto RuntimeLang =
1743 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00001744
1745 // If this is just a forward declaration return a special forward-declaration
1746 // debug type since we won't be able to lay out the entire type.
1747 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001748 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001749 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001750 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001751 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
1752 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001753 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001754 return FwdDecl;
1755 }
1756
David Blaikieef8a9512014-05-05 23:23:53 +00001757 return CreateTypeDefinition(Ty, Unit);
1758}
1759
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001760llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00001761CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
1762 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00001763 // Use the Module pointer as the key into the cache. This is a
1764 // nullptr if the "Module" is a PCH, which is safe because we don't
1765 // support chained PCH debug info, so there can only be a single PCH.
1766 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001767 auto ModRef = ModuleCache.find(M);
1768 if (ModRef != ModuleCache.end())
1769 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00001770
1771 // Macro definitions that were defined with "-D" on the command line.
1772 SmallString<128> ConfigMacros;
1773 {
1774 llvm::raw_svector_ostream OS(ConfigMacros);
1775 const auto &PPOpts = CGM.getPreprocessorOpts();
1776 unsigned I = 0;
1777 // Translate the macro definitions back into a commmand line.
1778 for (auto &M : PPOpts.Macros) {
1779 if (++I > 1)
1780 OS << " ";
1781 const std::string &Macro = M.first;
1782 bool Undef = M.second;
1783 OS << "\"-" << (Undef ? 'U' : 'D');
1784 for (char c : Macro)
1785 switch (c) {
1786 case '\\' : OS << "\\\\"; break;
1787 case '"' : OS << "\\\""; break;
1788 default: OS << c;
1789 }
1790 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001791 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001792 }
Adrian Prantl66689202015-09-18 23:01:45 +00001793
Adrian Prantl835e6632015-09-24 16:10:10 +00001794 bool IsRootModule = M ? !M->Parent : true;
1795 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantlc96da8f2016-01-22 17:43:43 +00001796 // PCH files don't have a signature field in the control block,
1797 // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
Adrian Prantl98bfc822016-01-22 19:29:41 +00001798 uint64_t Signature = Mod.getSignature() ? Mod.getSignature() : ~1ULL;
Adrian Prantl66689202015-09-18 23:01:45 +00001799 llvm::DIBuilder DIB(CGM.getModule());
Adrian Prantl835e6632015-09-24 16:10:10 +00001800 DIB.createCompileUnit(TheCU->getSourceLanguage(), Mod.getModuleName(),
Adrian Prantl6083b082015-09-24 16:10:00 +00001801 Mod.getPath(), TheCU->getProducer(), true,
1802 StringRef(), 0, Mod.getASTFile(),
Adrian Prantl3563c552016-03-31 23:57:45 +00001803 llvm::DICompileUnit::FullDebug, Signature);
Adrian Prantl66689202015-09-18 23:01:45 +00001804 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00001805 }
Adrian Prantl835e6632015-09-24 16:10:10 +00001806 llvm::DIModule *Parent =
1807 IsRootModule ? nullptr
1808 : getOrCreateModuleRef(
1809 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
1810 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00001811 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00001812 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
1813 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001814 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00001815 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001816}
1817
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001818llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
1819 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00001820 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001821 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00001822 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001823 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001824
1825 // Bit size, align and offset of the type.
1826 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1827 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1828
1829 unsigned Flags = 0;
1830 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001831 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00001832
Adrian Prantlfd696112015-10-01 00:48:51 +00001833 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001834 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00001835 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
1836 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001837
David Blaikieef8a9512014-05-05 23:23:53 +00001838 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001839 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001840
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001841 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001842 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001843 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001844
1845 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001846 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001847
1848 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1849 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001850 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001851 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001852 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001853 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001854
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001855 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00001856 EltTys.push_back(InhTag);
1857 }
1858
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001859 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00001860 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001861 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001862 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001863 unsigned PLine = getLineNumber(Loc);
1864 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1865 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001866 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
1867 PD->getName(), PUnit, PLine,
1868 hasDefaultGetterName(PD, Getter) ? ""
1869 : getSelectorName(PD->getGetterName()),
1870 hasDefaultSetterName(PD, Setter) ? ""
1871 : getSelectorName(PD->getSetterName()),
1872 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001873 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00001874 };
1875 {
1876 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00001877 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
Manman Renefe1bac2016-01-27 20:00:32 +00001878 for (auto *PD : ClassExt->properties()) {
Nico Weberde059e12015-12-04 19:35:45 +00001879 PropertySet.insert(PD->getIdentifier());
1880 AddProperty(PD);
1881 }
Manman Renefe1bac2016-01-27 20:00:32 +00001882 for (const auto *PD : ID->properties()) {
Nico Weber7123bca2015-12-04 19:14:14 +00001883 // Don't emit duplicate metadata for properties that were already in a
1884 // class extension.
1885 if (!PropertySet.insert(PD->getIdentifier()).second)
1886 continue;
1887 AddProperty(PD);
1888 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001889 }
1890
1891 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1892 unsigned FieldNo = 0;
1893 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1894 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001895 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001896 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001897 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001898
Guy Benyei11169dd2012-12-18 14:30:41 +00001899 StringRef FieldName = Field->getName();
1900
1901 // Ignore unnamed fields.
1902 if (FieldName.empty())
1903 continue;
1904
1905 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001906 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001907 unsigned FieldLine = getLineNumber(Field->getLocation());
1908 QualType FType = Field->getType();
1909 uint64_t FieldSize = 0;
1910 unsigned FieldAlign = 0;
1911
1912 if (!FType->isIncompleteArrayType()) {
1913
1914 // Bit size, align and offset of the type.
1915 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001916 ? Field->getBitWidthValue(CGM.getContext())
1917 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001918 FieldAlign = CGM.getContext().getTypeAlign(FType);
1919 }
1920
1921 uint64_t FieldOffset;
1922 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1923 // We don't know the runtime offset of an ivar if we're using the
1924 // non-fragile ABI. For bitfields, use the bit offset into the first
1925 // byte of storage of the bitfield. For other fields, use zero.
1926 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001927 FieldOffset =
1928 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00001929 FieldOffset %= CGM.getContext().getCharWidth();
1930 } else {
1931 FieldOffset = 0;
1932 }
1933 } else {
1934 FieldOffset = RL.getFieldOffset(FieldNo);
1935 }
1936
1937 unsigned Flags = 0;
1938 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001939 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00001940 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001941 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001942 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001943 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00001944
Craig Topper8a13c412014-05-21 05:09:00 +00001945 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001946 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001947 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00001948 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001949 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001950 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001951 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00001952 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001953 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1954 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001955 PropertyNode = DBuilder.createObjCProperty(
1956 PD->getName(), PUnit, PLine,
1957 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
1958 PD->getGetterName()),
1959 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
1960 PD->getSetterName()),
1961 PD->getPropertyAttributes(),
1962 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001963 }
1964 }
1965 }
Eric Christophere7b87e52014-10-26 23:40:33 +00001966 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
1967 FieldSize, FieldAlign, FieldOffset, Flags,
1968 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00001969 EltTys.push_back(FieldTy);
1970 }
1971
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001972 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001973 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001974
Guy Benyei11169dd2012-12-18 14:30:41 +00001975 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001976 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001977}
1978
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001979llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
1980 llvm::DIFile *Unit) {
1981 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001982 int64_t Count = Ty->getNumElements();
1983 if (Count == 0)
1984 // If number of elements are not known then this is an unbounded array.
1985 // Use Count == -1 to express such arrays.
1986 Count = -1;
1987
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001988 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001989 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00001990
1991 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1992 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1993
1994 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1995}
1996
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001997llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001998 uint64_t Size;
1999 uint64_t Align;
2000
2001 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2002 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
2003 Size = 0;
2004 Align =
Eric Christophere7b87e52014-10-26 23:40:33 +00002005 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Guy Benyei11169dd2012-12-18 14:30:41 +00002006 } else if (Ty->isIncompleteArrayType()) {
2007 Size = 0;
2008 if (Ty->getElementType()->isIncompleteType())
2009 Align = 0;
2010 else
2011 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00002012 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002013 Size = 0;
2014 Align = 0;
2015 } else {
2016 // Size and align of the whole array, not the element type.
2017 Size = CGM.getContext().getTypeSize(Ty);
2018 Align = CGM.getContext().getTypeAlign(Ty);
2019 }
2020
2021 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2022 // interior arrays, do we care? Why aren't nested arrays represented the
2023 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002024 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002025 QualType EltTy(Ty, 0);
2026 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2027 // If the number of elements is known, then count is that number. Otherwise,
2028 // it's -1. This allows us to represent a subrange with an array of 0
2029 // elements, like this:
2030 //
2031 // struct foo {
2032 // int x[0];
2033 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00002034 int64_t Count = -1; // Count == -1 is an unbounded array.
Guy Benyei11169dd2012-12-18 14:30:41 +00002035 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
2036 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002037
Guy Benyei11169dd2012-12-18 14:30:41 +00002038 // FIXME: Verify this is right for VLAs.
2039 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2040 EltTy = Ty->getElementType();
2041 }
2042
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002043 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002044
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002045 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2046 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002047}
2048
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002049llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2050 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002051 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2052 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002053}
2054
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002055llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2056 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002057 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2058 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002059}
2060
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002061llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2062 llvm::DIFile *U) {
Reid Klecknerfb727182016-06-17 22:27:59 +00002063 unsigned Flags = 0;
2064 uint64_t Size = 0;
2065
2066 if (!Ty->isIncompleteType()) {
2067 Size = CGM.getContext().getTypeSize(Ty);
2068
2069 // Set the MS inheritance model. There is no flag for the unspecified model.
2070 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2071 switch (Ty->getMostRecentCXXRecordDecl()->getMSInheritanceModel()) {
2072 case MSInheritanceAttr::Keyword_single_inheritance:
2073 Flags |= llvm::DINode::FlagSingleInheritance;
2074 break;
2075 case MSInheritanceAttr::Keyword_multiple_inheritance:
2076 Flags |= llvm::DINode::FlagMultipleInheritance;
2077 break;
2078 case MSInheritanceAttr::Keyword_virtual_inheritance:
2079 Flags |= llvm::DINode::FlagVirtualInheritance;
2080 break;
2081 case MSInheritanceAttr::Keyword_unspecified_inheritance:
2082 break;
2083 }
2084 }
2085 }
2086
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002087 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002088 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002089 return DBuilder.createMemberPointerType(
Reid Klecknerfb727182016-06-17 22:27:59 +00002090 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2091 Flags);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002092
2093 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002094 Ty->getPointeeType()->getAs<FunctionProtoType>();
2095 return DBuilder.createMemberPointerType(
2096 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2097 Ty->getClass(), FPT->getTypeQuals())),
2098 FPT, U),
Reid Klecknerfb727182016-06-17 22:27:59 +00002099 ClassType, Size, /*Align=*/0, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002100}
2101
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002102llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002103 // Ignore the atomic wrapping
2104 // FIXME: What is the correct representation?
2105 return getOrCreateType(Ty->getValueType(), U);
2106}
2107
Xiuli Pan9c14e282016-01-09 12:53:17 +00002108llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2109 llvm::DIFile *U) {
2110 return getOrCreateType(Ty->getElementType(), U);
2111}
2112
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002113llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002114 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002115
Guy Benyei11169dd2012-12-18 14:30:41 +00002116 uint64_t Size = 0;
2117 uint64_t Align = 0;
2118 if (!ED->getTypeForDecl()->isIncompleteType()) {
2119 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2120 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2121 }
2122
Manman Rene0064d82013-08-29 23:19:58 +00002123 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2124
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002125 bool isImportedFromModule =
2126 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2127
Guy Benyei11169dd2012-12-18 14:30:41 +00002128 // If this is just a forward declaration, construct an appropriately
2129 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002130 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl45946062016-02-23 19:30:08 +00002131 // Note that it is possible for enums to be created as part of
2132 // their own declcontext. In this case a FwdDecl will be created
2133 // twice. This doesn't cause a problem because both FwdDecls are
2134 // entered into the ReplaceMap: finalize() will replace the first
2135 // FwdDecl with the second and then replace the second with
2136 // complete type.
Amjad Abouddc4531e2016-04-30 01:44:38 +00002137 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002138 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Adrian Prantlff9d83c2016-02-08 17:03:28 +00002139 llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2140 llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
Adrian Prantla40030f2016-02-06 01:59:09 +00002141
Guy Benyei11169dd2012-12-18 14:30:41 +00002142 unsigned Line = getLineNumber(ED->getLocation());
2143 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002144 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
Adrian Prantl45946062016-02-23 19:30:08 +00002145 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2146 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Adrian Prantla40030f2016-02-06 01:59:09 +00002147
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002148 ReplaceMap.emplace_back(
2149 std::piecewise_construct, std::make_tuple(Ty),
2150 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002151 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002152 }
2153
David Blaikie483a9da2014-05-06 18:35:21 +00002154 return CreateTypeDefinition(Ty);
2155}
2156
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002157llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002158 const EnumDecl *ED = Ty->getDecl();
2159 uint64_t Size = 0;
2160 uint64_t Align = 0;
2161 if (!ED->getTypeForDecl()->isIncompleteType()) {
2162 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2163 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2164 }
2165
2166 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2167
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002168 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002169 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002170 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002171 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002172 Enumerators.push_back(DBuilder.createEnumerator(
2173 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002174 }
2175
2176 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002177 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002178
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002179 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002180 unsigned Line = getLineNumber(ED->getLocation());
Amjad Abouddc4531e2016-04-30 01:44:38 +00002181 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002182 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002183 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2184 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2185 Line, Size, Align, EltArray, ClassTy,
2186 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002187}
2188
David Blaikie05491062013-01-21 04:37:12 +00002189static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2190 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002191 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002192 Qualifiers InnerQuals = T.getLocalQualifiers();
2193 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2194 // that is already there.
2195 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2196 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002197 QualType LastT = T;
2198 switch (T->getTypeClass()) {
2199 default:
David Blaikie05491062013-01-21 04:37:12 +00002200 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002201 case Type::TemplateSpecialization: {
2202 const auto *Spec = cast<TemplateSpecializationType>(T);
2203 if (Spec->isTypeAlias())
2204 return C.getQualifiedType(T.getTypePtr(), Quals);
2205 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002206 break;
2207 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002208 case Type::TypeOfExpr:
2209 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2210 break;
2211 case Type::TypeOf:
2212 T = cast<TypeOfType>(T)->getUnderlyingType();
2213 break;
2214 case Type::Decltype:
2215 T = cast<DecltypeType>(T)->getUnderlyingType();
2216 break;
2217 case Type::UnaryTransform:
2218 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2219 break;
2220 case Type::Attributed:
2221 T = cast<AttributedType>(T)->getEquivalentType();
2222 break;
2223 case Type::Elaborated:
2224 T = cast<ElaboratedType>(T)->getNamedType();
2225 break;
2226 case Type::Paren:
2227 T = cast<ParenType>(T)->getInnerType();
2228 break;
David Blaikie05491062013-01-21 04:37:12 +00002229 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002230 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002231 break;
2232 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002233 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002234 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002235 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002236 break;
2237 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002238
Guy Benyei11169dd2012-12-18 14:30:41 +00002239 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002240 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002241 } while (true);
2242}
2243
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002244llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002245
2246 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002247 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002248
David Blaikief427b002014-05-06 03:42:01 +00002249 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002250 if (it != TypeCache.end()) {
2251 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002252 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002253 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002254 }
2255
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002256 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002257}
2258
David Blaikie0e716b42014-03-03 23:48:23 +00002259void CGDebugInfo::completeTemplateDefinition(
2260 const ClassTemplateSpecializationDecl &SD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002261 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie0856f662014-03-04 22:01:08 +00002262 return;
2263
David Blaikie0e716b42014-03-03 23:48:23 +00002264 completeClassData(&SD);
2265 // In case this type has no member function definitions being emitted, ensure
2266 // it is retained
2267 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2268}
2269
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002270llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002271 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002272 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002273
2274 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002275 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002276
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002277 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002278 return T;
2279
Adrian Prantlca844182015-09-11 17:23:03 +00002280 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002281 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002282
2283 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002284 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002285
Guy Benyei11169dd2012-12-18 14:30:41 +00002286 return Res;
2287}
2288
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002289llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002290 // A forward declaration inside a module header does not belong to the module.
2291 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2292 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002293 if (DebugTypeExtRefs && D->isFromASTFile()) {
2294 // Record a reference to an imported clang module or precompiled header.
2295 auto *Reader = CGM.getContext().getExternalSource();
2296 auto Idx = D->getOwningModuleID();
2297 auto Info = Reader->getSourceDescriptor(Idx);
2298 if (Info)
2299 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2300 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002301 // We are building a clang module or a precompiled header.
2302 //
2303 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2304 // and it wouldn't be necessary to specify the parent scope
2305 // because the type is already unique by definition (it would look
2306 // like the output of -fno-standalone-debug). On the other hand,
2307 // the parent scope helps a consumer to quickly locate the object
2308 // file where the type's definition is located, so it might be
2309 // best to make this behavior a command line or debugger tuning
2310 // option.
2311 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
2312 if (Module *M = ClangModuleMap->inferModuleFromLocation(Loc)) {
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002313 // This is a (sub-)module.
Adrian Prantl9402cef2015-09-20 16:51:35 +00002314 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2315 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
Adrian Prantlaa5d08d2016-01-22 21:14:41 +00002316 } else {
2317 // This the precompiled header being built.
2318 return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
Adrian Prantl9402cef2015-09-20 16:51:35 +00002319 }
2320 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002321
Adrian Prantl9402cef2015-09-20 16:51:35 +00002322 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002323}
2324
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002325llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002326 // Handle qualifiers, which recursively handles what they refer to.
2327 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002328 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002329
Guy Benyei11169dd2012-12-18 14:30:41 +00002330 // Work out details of type.
2331 switch (Ty->getTypeClass()) {
2332#define TYPE(Class, Base)
2333#define ABSTRACT_TYPE(Class, Base)
2334#define NON_CANONICAL_TYPE(Class, Base)
2335#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2336#include "clang/AST/TypeNodes.def"
2337 llvm_unreachable("Dependent types cannot show up in debug information");
2338
2339 case Type::ExtVector:
2340 case Type::Vector:
2341 return CreateType(cast<VectorType>(Ty), Unit);
2342 case Type::ObjCObjectPointer:
2343 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2344 case Type::ObjCObject:
2345 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2346 case Type::ObjCInterface:
2347 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2348 case Type::Builtin:
2349 return CreateType(cast<BuiltinType>(Ty));
2350 case Type::Complex:
2351 return CreateType(cast<ComplexType>(Ty));
2352 case Type::Pointer:
2353 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002354 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002355 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002356 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002357 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002358 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002359 case Type::BlockPointer:
2360 return CreateType(cast<BlockPointerType>(Ty), Unit);
2361 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002362 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002363 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002364 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002365 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002366 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002367 case Type::FunctionProto:
2368 case Type::FunctionNoProto:
2369 return CreateType(cast<FunctionType>(Ty), Unit);
2370 case Type::ConstantArray:
2371 case Type::VariableArray:
2372 case Type::IncompleteArray:
2373 return CreateType(cast<ArrayType>(Ty), Unit);
2374
2375 case Type::LValueReference:
2376 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2377 case Type::RValueReference:
2378 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2379
2380 case Type::MemberPointer:
2381 return CreateType(cast<MemberPointerType>(Ty), Unit);
2382
2383 case Type::Atomic:
2384 return CreateType(cast<AtomicType>(Ty), Unit);
2385
Xiuli Pan9c14e282016-01-09 12:53:17 +00002386 case Type::Pipe:
2387 return CreateType(cast<PipeType>(Ty), Unit);
2388
Guy Benyei11169dd2012-12-18 14:30:41 +00002389 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002390 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2391
David Blaikie42edade2014-11-11 20:44:45 +00002392 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002393 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002394 case Type::Elaborated:
2395 case Type::Paren:
2396 case Type::SubstTemplateTypeParm:
2397 case Type::TypeOfExpr:
2398 case Type::TypeOf:
2399 case Type::Decltype:
2400 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002401 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002402 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002403 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002404
David Blaikie42edade2014-11-11 20:44:45 +00002405 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002406}
2407
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002408llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2409 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002410 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002411
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002412 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002413
2414 // We may have cached a forward decl when we could have created
2415 // a non-forward decl. Go ahead and create a non-forward decl
2416 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002417 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002418 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002419
2420 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002421 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002422
2423 // Propagate members from the declaration to the definition
2424 // CreateType(const RecordType*) will overwrite this with the members in the
2425 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002426 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002427
Guy Benyei11169dd2012-12-18 14:30:41 +00002428 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002429 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002430 return Res;
2431}
2432
2433// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002434llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002435 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002436
Guy Benyei11169dd2012-12-18 14:30:41 +00002437 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002438 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002439 unsigned Line = getLineNumber(RD->getLocation());
2440 StringRef RDName = getClassName(RD);
2441
Amjad Abouddc4531e2016-04-30 01:44:38 +00002442 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002443
David Blaikied2785892013-08-18 17:36:19 +00002444 // If we ended up creating the type during the context chain construction,
2445 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002446 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002447 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002448 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002449 return T;
David Blaikied2785892013-08-18 17:36:19 +00002450
Adrian Prantl381e7552014-02-04 21:29:50 +00002451 // If this is just a forward or incomplete declaration, construct an
2452 // appropriately marked node and just return it.
2453 const RecordDecl *D = RD->getDefinition();
2454 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002455 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002456
2457 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2458 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002459
Manman Rene0064d82013-08-29 23:19:58 +00002460 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2461
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002462 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002463 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align, 0,
2464 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002465
Duncan P. N. Exon Smithf9521b02016-04-17 07:45:08 +00002466 // Elements of composite types usually have back to the type, creating
2467 // uniquing cycles. Distinct nodes are more efficient.
2468 switch (RealDecl->getTag()) {
2469 default:
2470 llvm_unreachable("invalid composite type tag");
2471
2472 case llvm::dwarf::DW_TAG_array_type:
2473 case llvm::dwarf::DW_TAG_enumeration_type:
2474 // Array elements and most enumeration elements don't have back references,
2475 // so they don't tend to be involved in uniquing cycles and there is some
2476 // chance of merging them when linking together two modules. Only make
2477 // them distinct if they are ODR-uniqued.
2478 if (FullName.empty())
2479 break;
2480
2481 case llvm::dwarf::DW_TAG_structure_type:
2482 case llvm::dwarf::DW_TAG_union_type:
2483 case llvm::dwarf::DW_TAG_class_type:
2484 // Immediatley resolve to a distinct node.
2485 RealDecl =
2486 llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
2487 break;
2488 }
2489
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002490 RegionMap[Ty->getDecl()].reset(RealDecl);
2491 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002492
David Blaikieadfbf992013-08-18 16:55:33 +00002493 if (const ClassTemplateSpecializationDecl *TSpecial =
2494 dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002495 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002496 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002497 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002498}
2499
David Blaikieadfbf992013-08-18 16:55:33 +00002500void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002501 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002502 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002503 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002504 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2505 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002506 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002507 while (1) {
2508 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2509 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2510 if (PBT && !BRL.isPrimaryBaseVirtual())
2511 PBase = PBT;
2512 else
2513 break;
2514 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002515 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002516 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2517 getOrCreateFile(RD->getLocation())));
2518 } else if (RD->isDynamicClass())
2519 ContainingType = RealDecl;
2520
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002521 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002522}
2523
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002524llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002525 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002526 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002527 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2528 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002529 llvm::DIType *Ty = DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002530 FieldAlign, *Offset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002531 *Offset += FieldSize;
2532 return Ty;
2533}
2534
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002535void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002536 StringRef &Name,
2537 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002538 llvm::DIScope *&FDContext,
2539 llvm::DINodeArray &TParamsArray,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002540 unsigned &Flags) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002541 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
2542 Name = getFunctionName(FD);
2543 // Use mangled name as linkage name for C/C++ functions.
2544 if (FD->hasPrototype()) {
2545 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002546 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002547 }
2548 // No need to replicate the linkage name if it isn't different from the
2549 // subprogram name, no need to have it at all unless coverage is enabled or
2550 // debug is set to more than just line tables.
Benjamin Kramer8c305922016-02-02 11:06:51 +00002551 if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
2552 !CGM.getCodeGenOpts().EmitGcovNotes &&
2553 DebugKind <= codegenoptions::DebugLineTablesOnly))
Frederic Riss9db79f12014-11-18 03:40:46 +00002554 LinkageName = StringRef();
2555
Benjamin Kramer8c305922016-02-02 11:06:51 +00002556 if (DebugKind >= codegenoptions::LimitedDebugInfo) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002557 if (const NamespaceDecl *NSDecl =
2558 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2559 FDContext = getOrCreateNameSpace(NSDecl);
2560 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002561 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2562 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2563 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2564 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002565 // Collect template parameters.
2566 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2567 }
2568}
2569
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002570void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002571 unsigned &LineNo, QualType &T,
2572 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002573 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002574 Unit = getOrCreateFile(VD->getLocation());
2575 LineNo = getLineNumber(VD->getLocation());
2576
2577 setLocation(VD->getLocation());
2578
2579 T = VD->getType();
2580 if (T->isIncompleteArrayType()) {
2581 // CodeGen turns int[] into int[1] so we'll do the same here.
2582 llvm::APInt ConstVal(32, 1);
2583 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2584
2585 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2586 ArrayType::Normal, 0);
2587 }
2588
2589 Name = VD->getName();
2590 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2591 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2592 LinkageName = CGM.getMangledName(VD);
2593 if (LinkageName == Name)
2594 LinkageName = StringRef();
2595
2596 // Since we emit declarations (DW_AT_members) for static members, place the
2597 // definition of those static members in the namespace they were declared in
2598 // in the source code (the lexical decl context).
2599 // FIXME: Generalize this for even non-member global variables where the
2600 // declaration and definition may have different lexical decl contexts, once
2601 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002602 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2603 : VD->getDeclContext();
2604 // When a record type contains an in-line initialization of a static data
2605 // member, and the record type is marked as __declspec(dllexport), an implicit
2606 // definition of the member will be created in the record context. DWARF
2607 // doesn't seem to have a nice way to describe this in a form that consumers
2608 // are likely to understand, so fake the "normal" situation of a definition
2609 // outside the class by putting it in the global scope.
2610 if (DC->isRecord())
2611 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002612
Amjad Abouddc4531e2016-04-30 01:44:38 +00002613 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2614 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002615}
2616
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002617llvm::DISubprogram *
Frederic Rissd253ed62014-11-18 03:40:51 +00002618CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002619 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002620 StringRef Name, LinkageName;
2621 unsigned Flags = 0;
2622 SourceLocation Loc = FD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002623 llvm::DIFile *Unit = getOrCreateFile(Loc);
2624 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002625 unsigned Line = getLineNumber(Loc);
2626
2627 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2628 TParamsArray, Flags);
2629 // Build function type.
2630 SmallVector<QualType, 16> ArgTypes;
2631 for (const ParmVarDecl *Parm: FD->parameters())
2632 ArgTypes.push_back(Parm->getType());
Reid Klecknerf00f8032016-06-08 20:41:54 +00002633 CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
2634 QualType FnType = CGM.getContext().getFunctionType(
2635 FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002636 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002637 DContext, Name, LinkageName, Unit, Line,
2638 getOrCreateFunctionType(FD, FnType, Unit), !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002639 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002640 TParamsArray.get(), getFunctionDeclaration(FD));
Frederic Rissd253ed62014-11-18 03:40:51 +00002641 const FunctionDecl *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002642 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2643 std::make_tuple(CanonDecl),
2644 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002645 return SP;
2646}
2647
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002648llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002649CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2650 QualType T;
2651 StringRef Name, LinkageName;
2652 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002653 llvm::DIFile *Unit = getOrCreateFile(Loc);
2654 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002655 unsigned Line = getLineNumber(Loc);
2656
2657 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002658 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
2659 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
2660 !VD->isExternallyVisible(), nullptr, nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002661 FwdDeclReplaceMap.emplace_back(
2662 std::piecewise_construct,
2663 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2664 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002665 return GV;
2666}
2667
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002668llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002669 // We only need a declaration (not a definition) of the type - so use whatever
2670 // we would otherwise do to get a type for a pointee. (forward declarations in
2671 // limited debug info, full definitions (if the type definition is available)
2672 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002673 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2674 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002675 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002676 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002677
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002678 if (I != DeclCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002679 return dyn_cast_or_null<llvm::DINode>(I->second);
Frederic Rissd253ed62014-11-18 03:40:51 +00002680
2681 // No definition for now. Emit a forward definition that might be
2682 // merged with a potential upcoming definition.
2683 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
2684 return getFunctionForwardDeclaration(FD);
2685 else if (const auto *VD = dyn_cast<VarDecl>(D))
2686 return getGlobalVariableForwardDeclaration(VD);
2687
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002688 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00002689}
2690
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002691llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002692 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002693 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00002694
Guy Benyei11169dd2012-12-18 14:30:41 +00002695 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002696 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002697 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002698
2699 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002700 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00002701
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002702 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002703 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002704 if (const CXXMethodDecl *MD =
2705 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00002706 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002707 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00002708 }
2709 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002710 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002711 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002712 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002713 return SP;
2714 }
2715
Aaron Ballman86c93902014-03-06 23:45:36 +00002716 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002717 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002718 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002719 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002720 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002721 return SP;
2722 }
2723 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002724 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002725}
2726
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002727// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00002728// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002729llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002730 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002731 llvm::DIFile *F) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00002732 if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002733 // Create fake but valid subroutine type. Otherwise -verify would fail, and
2734 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00002735 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002736
2737 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2738 return getOrCreateMethodType(Method, F);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002739
2740 const auto *FTy = FnType->getAs<FunctionType>();
2741 CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
2742
Guy Benyei11169dd2012-12-18 14:30:41 +00002743 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2744 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002745 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002746
2747 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002748 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002749
2750 // Replace the instancetype keyword with the actual type.
2751 if (ResultTy == CGM.getContext().getObjCInstanceType())
2752 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002753 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002754
Adrian Prantl7bec9032013-05-10 21:08:31 +00002755 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002756 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002757 QualType SelfDeclTy;
2758 if (auto *SelfDecl = OMethod->getSelfDecl())
2759 SelfDeclTy = SelfDecl->getType();
2760 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
2761 if (FPT->getNumParams() > 1)
2762 SelfDeclTy = FPT->getParamType(0);
2763 if (!SelfDeclTy.isNull())
2764 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002765 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002766 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002767 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002768 // Get rest of the arguments.
David Majnemer59f77922016-06-24 04:05:48 +00002769 for (const auto *PI : OMethod->parameters())
Aaron Ballman43b68be2014-03-07 17:50:17 +00002770 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00002771 // Variadic methods need a special marker at the end of the type list.
2772 if (OMethod->isVariadic())
2773 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00002774
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002775 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002776 return DBuilder.createSubroutineType(EltTypeArray, 0, getDwarfCC(CC));
Guy Benyei11169dd2012-12-18 14:30:41 +00002777 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002778
Adrian Prantl800faef2014-02-25 23:42:18 +00002779 // Handle variadic function types; they need an additional
2780 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002781 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2782 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002783 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00002784 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2785 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2786 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2787 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2788 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002789 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Reid Klecknerf00f8032016-06-08 20:41:54 +00002790 return DBuilder.createSubroutineType(EltTypeArray, 0, getDwarfCC(CC));
Adrian Prantld45ba252014-02-25 19:38:11 +00002791 }
2792
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002793 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002794}
2795
Eric Christophere7b87e52014-10-26 23:40:33 +00002796void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
2797 SourceLocation ScopeLoc, QualType FnType,
2798 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002799
2800 StringRef Name;
2801 StringRef LinkageName;
2802
2803 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2804
2805 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002806 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002807
Guy Benyei11169dd2012-12-18 14:30:41 +00002808 unsigned Flags = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002809 llvm::DIFile *Unit = getOrCreateFile(Loc);
2810 llvm::DIScope *FDContext = Unit;
2811 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00002812 if (!HasDecl) {
2813 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002814 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002815 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002816 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002817 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002818 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002819 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002820 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002821 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002822 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002823 return;
2824 }
2825 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002826 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2827 TParamsArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002828 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2829 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002830 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002831 } else {
2832 // Use llvm function name.
2833 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002834 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002835 }
2836 if (!Name.empty() && Name[0] == '\01')
2837 Name = Name.substr(1);
2838
Adrian Prantl42d71b92014-04-10 23:21:53 +00002839 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002840 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002841 // Artificial functions without a location should not silently reuse CurLoc.
2842 if (Loc.isInvalid())
2843 CurLoc = SourceLocation();
2844 }
2845 unsigned LineNo = getLineNumber(Loc);
2846 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002847
Eric Christopher8018e412014-03-27 18:50:35 +00002848 // FIXME: The function declaration we're constructing here is mostly reusing
2849 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2850 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2851 // all subprograms instead of the actual context since subprogram definitions
2852 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002853 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00002854 FDContext, Name, LinkageName, Unit, LineNo,
2855 getOrCreateFunctionType(D, FnType, Unit), Fn->hasInternalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002856 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002857 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002858 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00002859 // We might get here with a VarDecl in the case we're generating
2860 // code for the initialization of globals. Do not record these decls
2861 // as they will overwrite the actual VarDecl Decl in the cache.
2862 if (HasDecl && isa<FunctionDecl>(D))
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002863 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(SP));
Guy Benyei11169dd2012-12-18 14:30:41 +00002864
Adrian Prantlbebb8932014-03-21 21:01:58 +00002865 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002866 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002867
Guy Benyei11169dd2012-12-18 14:30:41 +00002868 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002869 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002870}
2871
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002872void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
2873 QualType FnType) {
2874 StringRef Name;
2875 StringRef LinkageName;
2876
2877 const Decl *D = GD.getDecl();
2878 if (!D)
2879 return;
2880
2881 unsigned Flags = 0;
2882 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00002883 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002884 llvm::DINodeArray TParamsArray;
2885 if (isa<FunctionDecl>(D)) {
2886 // If there is a DISubprogram for this function available then use it.
2887 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2888 TParamsArray, Flags);
2889 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2890 Name = getObjCMethodName(OMD);
2891 Flags |= llvm::DINode::FlagPrototyped;
2892 } else {
2893 llvm_unreachable("not a function or ObjC method");
2894 }
2895 if (!Name.empty() && Name[0] == '\01')
2896 Name = Name.substr(1);
2897
2898 if (D->isImplicit()) {
2899 Flags |= llvm::DINode::FlagArtificial;
2900 // Artificial functions without a location should not silently reuse CurLoc.
2901 if (Loc.isInvalid())
2902 CurLoc = SourceLocation();
2903 }
2904 unsigned LineNo = getLineNumber(Loc);
2905 unsigned ScopeLine = 0;
2906
Adrian Prantle76bda52016-04-15 15:55:45 +00002907 DBuilder.retainType(DBuilder.createFunction(
2908 FDContext, Name, LinkageName, Unit, LineNo,
2909 getOrCreateFunctionType(D, FnType, Unit), false /*internalLinkage*/,
2910 false /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
2911 TParamsArray.get(), getFunctionDeclaration(D)));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002912}
2913
David Blaikie835afb22015-01-21 23:08:17 +00002914void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002915 // Update our current location
2916 setLocation(Loc);
2917
Eric Christophere7b87e52014-10-26 23:40:33 +00002918 if (CurLoc.isInvalid() || CurLoc.isMacroID())
2919 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002920
Adrian Prantle83b1302014-01-07 22:05:52 +00002921 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00002922 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00002923 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002924}
2925
Guy Benyei11169dd2012-12-18 14:30:41 +00002926void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002927 llvm::MDNode *Back = nullptr;
2928 if (!LexicalBlockStack.empty())
2929 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002930 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002931 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002932 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002933}
2934
Eric Christopher0fdcb312013-05-16 00:52:20 +00002935void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2936 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002937 // Set our current location.
2938 setLocation(Loc);
2939
Guy Benyei11169dd2012-12-18 14:30:41 +00002940 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00002941 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
2942 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00002943
Benjamin Kramer8c305922016-02-02 11:06:51 +00002944 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00002945 return;
2946
2947 // Create a new lexical block and push it on the stack.
2948 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002949}
2950
Eric Christopher0fdcb312013-05-16 00:52:20 +00002951void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2952 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002953 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2954
2955 // Provide an entry in the line table for the end of the block.
2956 EmitLocation(Builder, Loc);
2957
Benjamin Kramer8c305922016-02-02 11:06:51 +00002958 if (DebugKind <= codegenoptions::DebugLineTablesOnly)
David Blaikie60a877b2014-10-22 19:34:33 +00002959 return;
2960
Guy Benyei11169dd2012-12-18 14:30:41 +00002961 LexicalBlockStack.pop_back();
2962}
2963
Guy Benyei11169dd2012-12-18 14:30:41 +00002964void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2965 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2966 unsigned RCount = FnBeginRegionCount.back();
2967 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2968
2969 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00002970 while (LexicalBlockStack.size() != RCount) {
2971 // Provide an entry in the line table for the end of the block.
2972 EmitLocation(Builder, CurLoc);
2973 LexicalBlockStack.pop_back();
2974 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002975 FnBeginRegionCount.pop_back();
2976}
2977
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002978llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002979 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002980
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002981 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002982 QualType FType;
2983 uint64_t FieldSize, FieldOffset;
2984 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002985
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002986 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002987 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002988
2989 FieldOffset = 0;
2990 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2991 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2992 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2993 FType = CGM.getContext().IntTy;
2994 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2995 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2996
2997 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2998 if (HasCopyAndDispose) {
2999 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003000 EltTys.push_back(
3001 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3002 EltTys.push_back(
3003 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00003004 }
3005 bool HasByrefExtendedLayout;
3006 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00003007 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3008 HasByrefExtendedLayout) &&
3009 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00003010 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003011 EltTys.push_back(
3012 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00003013 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003014
Guy Benyei11169dd2012-12-18 14:30:41 +00003015 CharUnits Align = CGM.getContext().getDeclAlign(VD);
3016 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003017 CGM.getTarget().getPointerAlign(0))) {
3018 CharUnits FieldOffsetInBytes =
3019 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00003020 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00003021 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003022
Guy Benyei11169dd2012-12-18 14:30:41 +00003023 if (NumPaddingBytes.isPositive()) {
3024 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3025 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3026 pad, ArrayType::Normal, 0);
3027 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3028 }
3029 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00003030
Guy Benyei11169dd2012-12-18 14:30:41 +00003031 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003032 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003033 FieldSize = CGM.getContext().getTypeSize(FType);
3034 FieldAlign = CGM.getContext().toBits(Align);
3035
Eric Christopherb2a008c2013-05-16 00:45:12 +00003036 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00003037 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
3038 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003039 EltTys.push_back(FieldTy);
3040 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003041
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003042 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003043
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003044 unsigned Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003045
Guy Benyei11169dd2012-12-18 14:30:41 +00003046 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003047 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00003048}
3049
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003050void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
3051 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00003052 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003053 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003054 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003055 if (VD->hasAttr<NoDebugAttr>())
3056 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003057
David Blaikie7fceebf2013-08-19 03:37:48 +00003058 bool Unwritten =
3059 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3060 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003061 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00003062 if (!Unwritten)
3063 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003064 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003065 uint64_t XOffset = 0;
3066 if (VD->hasAttr<BlocksAttr>())
3067 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003068 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003069 Ty = getOrCreateType(VD->getType(), Unit);
3070
3071 // If there is no debug info for this type then do not emit debug info
3072 // for this variable.
3073 if (!Ty)
3074 return;
3075
Guy Benyei11169dd2012-12-18 14:30:41 +00003076 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00003077 unsigned Line = 0;
3078 unsigned Column = 0;
3079 if (!Unwritten) {
3080 Line = getLineNumber(VD->getLocation());
3081 Column = getColumnNumber(VD->getLocation());
3082 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003083 SmallVector<int64_t, 9> Expr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003084 unsigned Flags = 0;
3085 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003086 Flags |= llvm::DINode::FlagArtificial;
Guy Benyei11169dd2012-12-18 14:30:41 +00003087 // If this is the first argument and it is implicit then
3088 // give it an object pointer flag.
3089 // FIXME: There has to be a better way to do this, but for static
3090 // functions there won't be an implicit param at arg1 and
3091 // otherwise it is 'self' or 'this'.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003092 if (isa<ImplicitParamDecl>(VD) && ArgNo && *ArgNo == 1)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003093 Flags |= llvm::DINode::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00003094 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00003095 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
3096 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003097 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00003098
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003099 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003100
3101 StringRef Name = VD->getName();
3102 if (!Name.empty()) {
3103 if (VD->hasAttr<BlocksAttr>()) {
3104 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003105 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003106 // offset of __forwarding field
3107 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00003108 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003109 Expr.push_back(offset.getQuantity());
3110 Expr.push_back(llvm::dwarf::DW_OP_deref);
3111 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003112 // offset of x field
3113 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003114 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003115
3116 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003117 auto *D = ArgNo
3118 ? DBuilder.createParameterVariable(Scope, VD->getName(),
3119 *ArgNo, Unit, Line, Ty)
3120 : DBuilder.createAutoVariable(Scope, VD->getName(), Unit,
3121 Line, Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003122
Guy Benyei11169dd2012-12-18 14:30:41 +00003123 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003124 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3125 llvm::DebugLoc::get(Line, Column, Scope),
3126 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003127 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00003128 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003129 Expr.push_back(llvm::dwarf::DW_OP_deref);
Adrian Prantl0d820892015-04-29 15:05:50 +00003130 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
3131 // If VD is an anonymous union then Storage represents value for
3132 // all union fields.
3133 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
3134 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003135 // GDB has trouble finding local variables in anonymous unions, so we emit
3136 // artifical local variables for each of the members.
3137 //
3138 // FIXME: Remove this code as soon as GDB supports this.
3139 // The debug info verifier in LLVM operates based on the assumption that a
3140 // variable has the same size as its storage and we had to disable the check
3141 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003142 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003143 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003144 StringRef FieldName = Field->getName();
3145
3146 // Ignore unnamed fields. Do not ignore unnamed records.
3147 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3148 continue;
3149
3150 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003151 auto *D = DBuilder.createAutoVariable(
3152 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3153 Flags | llvm::DINode::FlagArtificial);
Adrian Prantl0d820892015-04-29 15:05:50 +00003154
3155 // Insert an llvm.dbg.declare into the current block.
3156 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3157 llvm::DebugLoc::get(Line, Column, Scope),
3158 Builder.GetInsertBlock());
3159 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003160 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003161 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003162
3163 // Create the descriptor for the variable.
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003164 auto *D =
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003165 ArgNo
3166 ? DBuilder.createParameterVariable(Scope, Name, *ArgNo, Unit, Line,
3167 Ty, CGM.getLangOpts().Optimize,
3168 Flags)
3169 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3170 CGM.getLangOpts().Optimize, Flags);
David Blaikiea76a7c92013-01-05 05:58:35 +00003171
3172 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003173 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3174 llvm::DebugLoc::get(Line, Column, Scope),
3175 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003176}
3177
3178void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3179 llvm::Value *Storage,
3180 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003181 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003182 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003183}
3184
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003185llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3186 llvm::DIType *Ty) {
3187 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003188 if (CachedTy)
3189 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003190 return DBuilder.createObjectPointerType(Ty);
3191}
3192
Eric Christophere7b87e52014-10-26 23:40:33 +00003193void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3194 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003195 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003196 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003197 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003198
Craig Topper8a13c412014-05-21 05:09:00 +00003199 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003200 return;
Paul Robinsonafd2dde2016-06-16 00:42:36 +00003201 if (VD->hasAttr<NoDebugAttr>())
3202 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003203
Guy Benyei11169dd2012-12-18 14:30:41 +00003204 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003205
Guy Benyei11169dd2012-12-18 14:30:41 +00003206 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003207 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3208 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003209 if (isByRef)
3210 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003211 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003212 Ty = getOrCreateType(VD->getType(), Unit);
3213
3214 // Self is passed along as an implicit non-arg variable in a
3215 // block. Mark it as the object pointer.
3216 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00003217 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003218
3219 // Get location information.
3220 unsigned Line = getLineNumber(VD->getLocation());
3221 unsigned Column = getColumnNumber(VD->getLocation());
3222
3223 const llvm::DataLayout &target = CGM.getDataLayout();
3224
3225 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003226 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003227 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3228
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003229 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00003230 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003231 addr.push_back(llvm::dwarf::DW_OP_deref);
3232 addr.push_back(llvm::dwarf::DW_OP_plus);
3233 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003234 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003235 addr.push_back(llvm::dwarf::DW_OP_deref);
3236 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003237 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003238 offset =
3239 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003240 addr.push_back(offset.getQuantity());
3241 addr.push_back(llvm::dwarf::DW_OP_deref);
3242 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003243 // offset of x field
3244 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003245 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003246 }
3247
3248 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003249 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003250 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003251 Line, Ty);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003252
Guy Benyei11169dd2012-12-18 14:30:41 +00003253 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003254 auto DL = llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back());
3255 if (InsertPoint)
3256 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3257 InsertPoint);
3258 else
3259 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3260 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003261}
3262
Guy Benyei11169dd2012-12-18 14:30:41 +00003263void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3264 unsigned ArgNo,
3265 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003266 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003267 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003268}
3269
3270namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003271struct BlockLayoutChunk {
3272 uint64_t OffsetInBits;
3273 const BlockDecl::Capture *Capture;
3274};
3275bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3276 return l.OffsetInBits < r.OffsetInBits;
3277}
Guy Benyei11169dd2012-12-18 14:30:41 +00003278}
3279
3280void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003281 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003282 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003283 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003284 CGBuilderTy &Builder) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003285 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003286 ASTContext &C = CGM.getContext();
3287 const BlockDecl *blockDecl = block.getBlockDecl();
3288
3289 // Collect some general information about the block's location.
3290 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003291 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003292 unsigned line = getLineNumber(loc);
3293 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003294
Guy Benyei11169dd2012-12-18 14:30:41 +00003295 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003296 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003297
3298 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003299 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003300
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003301 SmallVector<llvm::Metadata *, 16> fields;
Guy Benyei11169dd2012-12-18 14:30:41 +00003302 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
3303 blockLayout->getElementOffsetInBits(0),
3304 tunit, tunit));
3305 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
3306 blockLayout->getElementOffsetInBits(1),
3307 tunit, tunit));
3308 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
3309 blockLayout->getElementOffsetInBits(2),
3310 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003311 auto *FnTy = block.getBlockExpr()->getFunctionType();
3312 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3313 fields.push_back(createFieldType("__FuncPtr", FnPtrType, 0, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003314 blockLayout->getElementOffsetInBits(3),
3315 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003316 fields.push_back(createFieldType(
3317 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3318 ? C.getBlockDescriptorExtendedType()
3319 : C.getBlockDescriptorType()),
3320 0, loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003321
3322 // We want to sort the captures by offset, not because DWARF
3323 // requires this, but because we're paranoid about debuggers.
3324 SmallVector<BlockLayoutChunk, 8> chunks;
3325
3326 // 'this' capture.
3327 if (blockDecl->capturesCXXThis()) {
3328 BlockLayoutChunk chunk;
3329 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003330 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003331 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003332 chunks.push_back(chunk);
3333 }
3334
3335 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003336 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003337 const VarDecl *variable = capture.getVariable();
3338 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3339
3340 // Ignore constant captures.
3341 if (captureInfo.isConstant())
3342 continue;
3343
3344 BlockLayoutChunk chunk;
3345 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003346 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003347 chunk.Capture = &capture;
3348 chunks.push_back(chunk);
3349 }
3350
3351 // Sort by offset.
3352 llvm::array_pod_sort(chunks.begin(), chunks.end());
3353
Eric Christophere7b87e52014-10-26 23:40:33 +00003354 for (SmallVectorImpl<BlockLayoutChunk>::iterator i = chunks.begin(),
3355 e = chunks.end();
3356 i != e; ++i) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003357 uint64_t offsetInBits = i->OffsetInBits;
3358 const BlockDecl::Capture *capture = i->Capture;
3359
3360 // If we have a null capture, this must be the C++ 'this' capture.
3361 if (!capture) {
Adrian Prantl2526fca2016-04-18 23:48:16 +00003362 QualType type;
3363 if (auto *Method =
3364 cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
3365 type = Method->getThisType(C);
3366 else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
3367 type = QualType(RDecl->getTypeForDecl(), 0);
3368 else
3369 llvm_unreachable("unexpected block declcontext");
Guy Benyei11169dd2012-12-18 14:30:41 +00003370
3371 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3372 offsetInBits, tunit, tunit));
3373 continue;
3374 }
3375
3376 const VarDecl *variable = capture->getVariable();
3377 StringRef name = variable->getName();
3378
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003379 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003380 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003381 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003382
3383 // FIXME: this creates a second copy of this type!
3384 uint64_t xoffset;
3385 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003386 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3387 fieldType =
3388 DBuilder.createMemberType(tunit, name, tunit, line, PtrInfo.Width,
3389 PtrInfo.Align, offsetInBits, 0, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003390 } else {
Eric Christophere7b87e52014-10-26 23:40:33 +00003391 fieldType = createFieldType(name, variable->getType(), 0, loc, AS_public,
3392 offsetInBits, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003393 }
3394 fields.push_back(fieldType);
3395 }
3396
3397 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003398 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3399 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003400
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003401 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003402
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003403 llvm::DIType *type = DBuilder.createStructType(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003404 tunit, typeName.str(), tunit, line,
3405 CGM.getContext().toBits(block.BlockSize),
3406 CGM.getContext().toBits(block.BlockAlign), 0, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003407 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3408
3409 // Get overall information about the block.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003410 unsigned flags = llvm::DINode::FlagArtificial;
3411 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003412
3413 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003414 auto *debugVar = DBuilder.createParameterVariable(
3415 scope, Arg->getName(), ArgNo, tunit, line, type,
3416 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003417
Adrian Prantl616bef42013-03-14 21:52:59 +00003418 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003419 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003420 DBuilder.insertDbgValueIntrinsic(
Eric Christophere7b87e52014-10-26 23:40:33 +00003421 LocalAddr, 0, debugVar, DBuilder.createExpression(),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003422 llvm::DebugLoc::get(line, column, scope), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003423 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003424
Adrian Prantl616bef42013-03-14 21:52:59 +00003425 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003426 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
3427 llvm::DebugLoc::get(line, column, scope),
3428 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003429}
3430
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003431llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003432CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3433 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003434 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003435
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003436 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003437 if (MI != StaticDataMemberCache.end()) {
3438 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003439 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003440 }
David Blaikiece763042013-08-20 21:49:21 +00003441
3442 // If the member wasn't found in the cache, lazily construct and add it to the
3443 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003444 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003445 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003446 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003447}
3448
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003449llvm::DIGlobalVariable *CGDebugInfo::CollectAnonRecordDecls(
3450 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3451 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
3452 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003453
3454 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003455 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003456 StringRef FieldName = Field->getName();
3457
3458 // Ignore unnamed fields, but recurse into anonymous records.
3459 if (FieldName.empty()) {
3460 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3461 if (RT)
3462 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3463 Var, DContext);
3464 continue;
3465 }
3466 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003467 GV = DBuilder.createGlobalVariable(DContext, FieldName, LinkageName, Unit,
3468 LineNo, FieldTy,
3469 Var->hasInternalLinkage(), Var, nullptr);
Eric Christophercab9fae2014-04-10 05:20:00 +00003470 }
3471 return GV;
3472}
3473
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003474void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003475 const VarDecl *D) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003476 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003477 if (D->hasAttr<NoDebugAttr>())
3478 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00003479 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003480 llvm::DIFile *Unit = nullptr;
3481 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003482 unsigned LineNo;
3483 StringRef DeclName, LinkageName;
3484 QualType T;
3485 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003486
3487 // Attempt to store one global variable for the declaration - even if we
3488 // emit a lot of fields.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003489 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003490
3491 // If this is an anonymous union then we'll want to emit a global
3492 // variable for each member of the anonymous union so that it's possible
3493 // to find the name of any field in the union.
3494 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003495 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003496 assert(RD->isAnonymousStructOrUnion() &&
3497 "unnamed non-anonymous struct or union?");
Eric Christophercab9fae2014-04-10 05:20:00 +00003498 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3499 } else {
David Blaikie7550b112014-10-20 17:42:23 +00003500 GV = DBuilder.createGlobalVariable(
Eric Christophercab9fae2014-04-10 05:20:00 +00003501 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3502 Var->hasInternalLinkage(), Var,
3503 getOrCreateStaticDataMemberDeclarationOrNull(D));
3504 }
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003505 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(GV));
Guy Benyei11169dd2012-12-18 14:30:41 +00003506}
3507
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003508void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3509 llvm::Constant *Init) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003510 assert(DebugKind >= codegenoptions::LimitedDebugInfo);
Paul Robinsonb17327d2016-04-27 17:37:12 +00003511 if (VD->hasAttr<NoDebugAttr>())
3512 return;
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003513 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003514 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003515 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003516 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003517 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3518 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3519 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3520 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3521 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003522 // Do not use global variables for enums.
3523 //
3524 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003525 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003526 return;
David Blaikiea15565562014-04-04 20:56:17 +00003527 // Do not emit separate definitions for function local const/statics.
3528 if (isa<FunctionDecl>(VD->getDeclContext()))
3529 return;
David Blaikiebb113912014-04-05 07:23:17 +00003530 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003531 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003532 if (VarD->isStaticDataMember()) {
3533 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003534 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003535 // Ensure that the type is retained even though it's otherwise unreferenced.
Duncan P. N. Exon Smith383f8412016-04-23 21:08:27 +00003536 //
3537 // FIXME: This is probably unnecessary, since Ty should reference RD
3538 // through its scope.
David Blaikie423eb5a2014-11-19 19:42:40 +00003539 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003540 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003541 return;
3542 }
3543
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003544 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003545
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003546 auto &GV = DeclCache[VD];
3547 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003548 return;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003549 GV.reset(DBuilder.createGlobalVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003550 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003551 true, Init, getOrCreateStaticDataMemberDeclarationOrNull(VarD)));
David Blaikiebd483762013-05-20 04:58:53 +00003552}
3553
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003554llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003555 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003556 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003557 llvm::DIScope *Mod = getParentModuleOrNull(D);
3558 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003559}
3560
David Blaikie9f88fe82013-04-22 06:13:21 +00003561void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003562 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003563 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003564 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
3565 if (!NSDecl->isAnonymousNamespace() ||
3566 CGM.getCodeGenOpts().DebugExplicitImport) {
3567 DBuilder.createImportedModule(
3568 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3569 getOrCreateNameSpace(NSDecl),
3570 getLineNumber(UD.getLocation()));
3571 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003572}
3573
David Blaikiebd483762013-05-20 04:58:53 +00003574void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003575 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikiebd483762013-05-20 04:58:53 +00003576 return;
3577 assert(UD.shadow_size() &&
3578 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3579 // Emitting one decl is sufficient - debuggers can detect that this is an
3580 // overloaded name & provide lookup for all the overloads.
3581 const UsingShadowDecl &USD = **UD.shadow_begin();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003582 if (llvm::DINode *Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003583 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003584 DBuilder.createImportedDeclaration(
3585 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3586 getLineNumber(USD.getLocation()));
3587}
3588
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003589void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
David Blaikieaf09f4a2016-05-03 23:06:40 +00003590 if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
3591 return;
Adrian Prantl8a634c12015-12-18 19:44:31 +00003592 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00003593 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl8a634c12015-12-18 19:44:31 +00003594 DBuilder.createImportedDeclaration(
3595 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
3596 getOrCreateModuleRef(Info, DebugTypeExtRefs),
3597 getLineNumber(ID.getLocation()));
3598 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003599}
3600
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003601llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00003602CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003603 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003604 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003605 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003606 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003607 return cast<llvm::DIImportedEntity>(VH);
3608 llvm::DIImportedEntity *R;
David Blaikief121b932013-05-20 22:50:41 +00003609 if (const NamespaceAliasDecl *Underlying =
3610 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3611 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003612 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003613 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3614 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3615 NA.getName());
3616 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003617 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003618 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3619 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3620 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003621 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003622 return R;
3623}
3624
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003625llvm::DINamespace *
Guy Benyei11169dd2012-12-18 14:30:41 +00003626CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003627 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003628 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003629 if (I != NameSpaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003630 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003631
Guy Benyei11169dd2012-12-18 14:30:41 +00003632 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003633 llvm::DIFile *FileD = getOrCreateFile(NSDecl->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003634 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003635 llvm::DINamespace *NS =
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003636 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003637 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003638 return NS;
3639}
3640
Adrian Prantla5206ce2015-09-22 23:26:43 +00003641void CGDebugInfo::setDwoId(uint64_t Signature) {
3642 assert(TheCU && "no main compile unit");
3643 TheCU->setDWOId(Signature);
3644}
3645
3646
Guy Benyei11169dd2012-12-18 14:30:41 +00003647void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003648 // Creating types might create further types - invalidating the current
3649 // element and the size(), so don't cache/reference them.
3650 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3651 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003652 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00003653 ? CreateTypeDefinition(E.Type, E.Unit)
3654 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003655 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00003656 }
3657
David Blaikief427b002014-05-06 03:42:01 +00003658 for (auto p : ReplaceMap) {
3659 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003660 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003661 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003662
David Blaikief427b002014-05-06 03:42:01 +00003663 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003664 assert(it != TypeCache.end());
3665 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003666
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003667 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
3668 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00003669 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003670
Frederic Rissd253ed62014-11-18 03:40:51 +00003671 for (const auto &p : FwdDeclReplaceMap) {
3672 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003673 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003674 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003675
3676 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003677 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003678 // with ourselves, that will destroy the temporary MDNode and
3679 // replace it with a standard one, avoiding leaking memory.
3680 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003681 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003682 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003683 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003684
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003685 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00003686 }
3687
Adrian Prantl73409ce2013-03-11 18:33:46 +00003688 // We keep our own list of retained types, because we need to look
3689 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00003690 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00003691 if (auto MD = TypeCache[RT])
3692 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003693
Guy Benyei11169dd2012-12-18 14:30:41 +00003694 DBuilder.finalize();
3695}
David Blaikie66088d52014-09-24 17:01:27 +00003696
3697void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
Benjamin Kramer8c305922016-02-02 11:06:51 +00003698 if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
David Blaikie66088d52014-09-24 17:01:27 +00003699 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003700
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003701 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003702 // Don't ignore in case of explicit cast where it is referenced indirectly.
3703 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003704}