blob: 2511b249f0f57f9ecaaac416f2d32ff8bd8b5fba [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"
29#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
187 if (!Info && FII && !CGM.getCodeGenOpts().EmitCodeView)
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());
Guy Benyei11169dd2012-12-18 14:30:41 +0000194
Reid Kleckner60103382015-12-16 02:04:40 +0000195 if (CGM.getCodeGenOpts().EmitCodeView) {
196 // Print a fully qualified name like MSVC would.
197 Policy.MSVCFormatting = true;
198 FD->printQualifiedName(OS, Policy);
199 } else {
200 // Print the unqualified name with some template arguments. This is what
201 // DWARF-based debuggers expect.
202 FD->printName(OS);
203 // Add any template specialization args.
204 if (Info) {
205 const TemplateArgumentList *TArgs = Info->TemplateArguments;
206 const TemplateArgument *Args = TArgs->data();
207 unsigned NumArgs = TArgs->size();
208 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
209 Policy);
210 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000211 }
212
213 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000214 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000215}
216
217StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
218 SmallString<256> MethodName;
219 llvm::raw_svector_ostream OS(MethodName);
220 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
221 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000222 if (const ObjCImplementationDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000223 dyn_cast<const ObjCImplementationDecl>(DC)) {
224 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000225 } else if (const ObjCInterfaceDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000226 dyn_cast<const ObjCInterfaceDecl>(DC)) {
227 OS << OID->getName();
Douglas Gregoracf4fd32015-11-03 01:15:46 +0000228 } else if (const ObjCCategoryDecl *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
229 if (OC->IsClassExtension()) {
230 OS << OC->getClassInterface()->getName();
231 } else {
232 OS << ((const NamedDecl *)OC)->getIdentifier()->getNameStart() << '('
233 << OC->getIdentifier()->getNameStart() << ')';
234 }
Eric Christopherb2a008c2013-05-16 00:45:12 +0000235 } else if (const ObjCCategoryImplDecl *OCD =
Eric Christophere7b87e52014-10-26 23:40:33 +0000236 dyn_cast<const ObjCCategoryImplDecl>(DC)) {
237 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
238 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000239 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000240 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000241 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000242 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000243 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000244 ClassTy.print(OS, PrintingPolicy(LangOptions()));
245 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000246 }
247 OS << ' ' << OMD->getSelector().getAsString() << ']';
248
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000249 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000250}
251
Guy Benyei11169dd2012-12-18 14:30:41 +0000252StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000253 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000254}
255
Eric Christophere7b87e52014-10-26 23:40:33 +0000256StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Blaikie65813a32014-04-02 18:21:09 +0000257 // quick optimization to avoid having to intern strings that are already
258 // stored reliably elsewhere
259 if (!isa<ClassTemplateSpecializationDecl>(RD))
Guy Benyei11169dd2012-12-18 14:30:41 +0000260 return RD->getName();
261
David Blaikie65813a32014-04-02 18:21:09 +0000262 SmallString<128> Name;
Benjamin Kramer9170e912013-02-22 15:46:01 +0000263 {
David Blaikie65813a32014-04-02 18:21:09 +0000264 llvm::raw_svector_ostream OS(Name);
265 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
266 /*Qualified*/ false);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000267 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000268
269 // Copy this name on the side and use its reference.
David Blaikie65813a32014-04-02 18:21:09 +0000270 return internString(Name);
Guy Benyei11169dd2012-12-18 14:30:41 +0000271}
272
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000273llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000274 if (!Loc.isValid())
275 // If Location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000276 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
277 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000278
279 SourceManager &SM = CGM.getContext().getSourceManager();
280 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
281
282 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
283 // If the location is not valid then use main input file.
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000284 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
285 remapDIPath(TheCU->getDirectory()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000286
287 // Cache the results.
288 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000289 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000290
291 if (it != DIFileCache.end()) {
292 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000293 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000294 return cast<llvm::DIFile>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +0000295 }
296
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000297 llvm::DIFile *F = DBuilder.createFile(remapDIPath(PLoc.getFilename()),
298 remapDIPath(getCurrentDirname()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000299
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000300 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000301 return F;
302}
303
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000304llvm::DIFile *CGDebugInfo::getOrCreateMainFile() {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000305 return DBuilder.createFile(remapDIPath(TheCU->getFilename()),
306 remapDIPath(TheCU->getDirectory()));
307}
308
309std::string CGDebugInfo::remapDIPath(StringRef Path) const {
310 for (const auto &Entry : DebugPrefixMap)
311 if (Path.startswith(Entry.first))
312 return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
313 return Path.str();
Guy Benyei11169dd2012-12-18 14:30:41 +0000314}
315
Guy Benyei11169dd2012-12-18 14:30:41 +0000316unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
317 if (Loc.isInvalid() && CurLoc.isInvalid())
318 return 0;
319 SourceManager &SM = CGM.getContext().getSourceManager();
320 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000321 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000322}
323
Adrian Prantlc7822422013-03-12 20:43:25 +0000324unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000325 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000326 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000327 return 0;
328
329 // If the location is invalid then use the current column.
330 if (Loc.isInvalid() && CurLoc.isInvalid())
331 return 0;
332 SourceManager &SM = CGM.getContext().getSourceManager();
333 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000334 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000335}
336
337StringRef CGDebugInfo::getCurrentDirname() {
338 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
339 return CGM.getCodeGenOpts().DebugCompilationDir;
340
341 if (!CWDName.empty())
342 return CWDName;
343 SmallString<256> CWD;
344 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000345 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000346}
347
Guy Benyei11169dd2012-12-18 14:30:41 +0000348void CGDebugInfo::CreateCompileUnit() {
349
David Blaikieaabde052014-05-14 00:29:00 +0000350 // Should we be asking the SourceManager for the main file name, instead of
351 // accepting it as an argument? This just causes the main file name to
352 // mismatch with source locations and create extra lexical scopes or
353 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
354 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
355 // because that's what the SourceManager says)
356
Guy Benyei11169dd2012-12-18 14:30:41 +0000357 // Get absolute path name.
358 SourceManager &SM = CGM.getContext().getSourceManager();
359 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
360 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000361 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000362
363 // The main file name provided via the "-main-file-name" option contains just
364 // the file name itself with no path information. This file name may have had
365 // a relative path, so we look into the actual file entry for the main
366 // file to determine the real absolute path for the file.
367 std::string MainFileDir;
368 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000369 MainFileDir = remapDIPath(MainFile->getDir()->getName());
Yaron Keren9fb7e902013-10-21 20:07:37 +0000370 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000371 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
372 llvm::sys::path::append(MainFileDirSS, MainFileName);
373 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000374 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000375 }
376
Ed Masteda706022014-05-07 12:49:30 +0000377 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000378 const LangOptions &LO = CGM.getLangOpts();
379 if (LO.CPlusPlus) {
380 if (LO.ObjC1)
381 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
382 else
383 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
384 } else if (LO.ObjC1) {
385 LangTag = llvm::dwarf::DW_LANG_ObjC;
386 } else if (LO.C99) {
387 LangTag = llvm::dwarf::DW_LANG_C99;
388 } else {
389 LangTag = llvm::dwarf::DW_LANG_C89;
390 }
391
392 std::string Producer = getClangFullVersion();
393
394 // Figure out which version of the ObjC runtime we have.
395 unsigned RuntimeVers = 0;
396 if (LO.ObjC1)
397 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
398
399 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000400 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000401 TheCU = DBuilder.createCompileUnit(
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000402 LangTag, remapDIPath(MainFileName), remapDIPath(getCurrentDirname()),
403 Producer, LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers,
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000404 CGM.getCodeGenOpts().SplitDwarfFile,
Diego Novillo913690c2014-06-24 17:02:17 +0000405 DebugKind <= CodeGenOptions::DebugLineTablesOnly
Eric Christophere4200a22014-02-27 01:25:08 +0000406 ? llvm::DIBuilder::LineTablesOnly
Diego Novillo913690c2014-06-24 17:02:17 +0000407 : llvm::DIBuilder::FullDebug,
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000408 0 /* DWOid */, DebugKind != CodeGenOptions::LocTrackingOnly);
Guy Benyei11169dd2012-12-18 14:30:41 +0000409}
410
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000411llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000412 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000413 StringRef BTName;
414 switch (BT->getKind()) {
415#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000416#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000417#include "clang/AST/BuiltinTypes.def"
418 case BuiltinType::Dependent:
419 llvm_unreachable("Unexpected builtin type");
420 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000421 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000422 case BuiltinType::Void:
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000423 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000424 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000425 if (!ClassTy)
426 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
427 "objc_class", TheCU,
428 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000429 return ClassTy;
430 case BuiltinType::ObjCId: {
431 // typedef struct objc_class *Class;
432 // typedef struct objc_object {
433 // Class isa;
434 // } *id;
435
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000436 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000437 return ObjTy;
438
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000439 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000440 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
441 "objc_class", TheCU,
442 getOrCreateMainFile(), 0);
443
444 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000445
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000446 auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000447
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000448 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000449 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000450 0, 0, 0, 0, nullptr, llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000451
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000452 DBuilder.replaceArrays(
453 ObjTy,
454 DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
455 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000456 return ObjTy;
457 }
458 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000459 if (!SelTy)
460 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
461 "objc_selector", TheCU,
462 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 return SelTy;
464 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000465
466 case BuiltinType::OCLImage1d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000467 return getOrCreateStructPtrType("opencl_image1d_t", OCLImage1dDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000468 case BuiltinType::OCLImage1dArray:
Eric Christopherb2a008c2013-05-16 00:45:12 +0000469 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000470 OCLImage1dArrayDITy);
471 case BuiltinType::OCLImage1dBuffer:
472 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
473 OCLImage1dBufferDITy);
474 case BuiltinType::OCLImage2d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000475 return getOrCreateStructPtrType("opencl_image2d_t", OCLImage2dDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000476 case BuiltinType::OCLImage2dArray:
477 return getOrCreateStructPtrType("opencl_image2d_array_t",
478 OCLImage2dArrayDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000479 case BuiltinType::OCLImage2dDepth:
480 return getOrCreateStructPtrType("opencl_image2d_depth_t",
481 OCLImage2dDepthDITy);
482 case BuiltinType::OCLImage2dArrayDepth:
483 return getOrCreateStructPtrType("opencl_image2d_array_depth_t",
484 OCLImage2dArrayDepthDITy);
485 case BuiltinType::OCLImage2dMSAA:
486 return getOrCreateStructPtrType("opencl_image2d_msaa_t",
487 OCLImage2dMSAADITy);
488 case BuiltinType::OCLImage2dArrayMSAA:
489 return getOrCreateStructPtrType("opencl_image2d_array_msaa_t",
490 OCLImage2dArrayMSAADITy);
491 case BuiltinType::OCLImage2dMSAADepth:
492 return getOrCreateStructPtrType("opencl_image2d_msaa_depth_t",
493 OCLImage2dMSAADepthDITy);
494 case BuiltinType::OCLImage2dArrayMSAADepth:
495 return getOrCreateStructPtrType("opencl_image2d_array_msaa_depth_t",
496 OCLImage2dArrayMSAADepthDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000497 case BuiltinType::OCLImage3d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000498 return getOrCreateStructPtrType("opencl_image3d_t", OCLImage3dDITy);
Guy Benyei61054192013-02-07 10:55:47 +0000499 case BuiltinType::OCLSampler:
Eric Christophere7b87e52014-10-26 23:40:33 +0000500 return DBuilder.createBasicType(
501 "opencl_sampler_t", CGM.getContext().getTypeSize(BT),
502 CGM.getContext().getTypeAlign(BT), llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000503 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000504 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Alexey Bader9c8453f2015-09-15 11:18:52 +0000505 case BuiltinType::OCLClkEvent:
506 return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
507 case BuiltinType::OCLQueue:
508 return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
509 case BuiltinType::OCLNDRange:
510 return getOrCreateStructPtrType("opencl_ndrange_t", OCLNDRangeDITy);
511 case BuiltinType::OCLReserveID:
512 return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000513
Guy Benyei11169dd2012-12-18 14:30:41 +0000514 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000515 case BuiltinType::Char_U:
516 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
517 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000518 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000519 case BuiltinType::SChar:
520 Encoding = llvm::dwarf::DW_ATE_signed_char;
521 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000522 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000523 case BuiltinType::Char32:
524 Encoding = llvm::dwarf::DW_ATE_UTF;
525 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000526 case BuiltinType::UShort:
527 case BuiltinType::UInt:
528 case BuiltinType::UInt128:
529 case BuiltinType::ULong:
530 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000531 case BuiltinType::ULongLong:
532 Encoding = llvm::dwarf::DW_ATE_unsigned;
533 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000534 case BuiltinType::Short:
535 case BuiltinType::Int:
536 case BuiltinType::Int128:
537 case BuiltinType::Long:
538 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000539 case BuiltinType::LongLong:
540 Encoding = llvm::dwarf::DW_ATE_signed;
541 break;
542 case BuiltinType::Bool:
543 Encoding = llvm::dwarf::DW_ATE_boolean;
544 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000545 case BuiltinType::Half:
546 case BuiltinType::Float:
547 case BuiltinType::LongDouble:
Eric Christophere7b87e52014-10-26 23:40:33 +0000548 case BuiltinType::Double:
549 Encoding = llvm::dwarf::DW_ATE_float;
550 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000551 }
552
553 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000554 case BuiltinType::Long:
555 BTName = "long int";
556 break;
557 case BuiltinType::LongLong:
558 BTName = "long long int";
559 break;
560 case BuiltinType::ULong:
561 BTName = "long unsigned int";
562 break;
563 case BuiltinType::ULongLong:
564 BTName = "long long unsigned int";
565 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000566 default:
567 BTName = BT->getName(CGM.getLangOpts());
568 break;
569 }
570 // Bit size, align and offset of the type.
571 uint64_t Size = CGM.getContext().getTypeSize(BT);
572 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000573 return DBuilder.createBasicType(BTName, Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000574}
575
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000576llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000577 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000578 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000579 if (Ty->isComplexIntegerType())
580 Encoding = llvm::dwarf::DW_ATE_lo_user;
581
582 uint64_t Size = CGM.getContext().getTypeSize(Ty);
583 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000584 return DBuilder.createBasicType("complex", Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000585}
586
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000587llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
588 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000589 QualifierCollector Qc;
590 const Type *T = Qc.strip(Ty);
591
592 // Ignore these qualifiers for now.
593 Qc.removeObjCGCAttr();
594 Qc.removeAddressSpace();
595 Qc.removeObjCLifetime();
596
597 // We will create one Derived type for one qualifier and recurse to handle any
598 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000599 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000600 if (Qc.hasConst()) {
601 Tag = llvm::dwarf::DW_TAG_const_type;
602 Qc.removeConst();
603 } else if (Qc.hasVolatile()) {
604 Tag = llvm::dwarf::DW_TAG_volatile_type;
605 Qc.removeVolatile();
606 } else if (Qc.hasRestrict()) {
607 Tag = llvm::dwarf::DW_TAG_restrict_type;
608 Qc.removeRestrict();
609 } else {
610 assert(Qc.empty() && "Unknown type qualifier for debug info");
611 return getOrCreateType(QualType(T, 0), Unit);
612 }
613
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000614 auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000615
616 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
617 // CVR derived types.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000618 return DBuilder.createQualifiedType(Tag, FromTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000619}
620
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000621llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
622 llvm::DIFile *Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000623
624 // The frontend treats 'id' as a typedef to an ObjCObjectType,
625 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
626 // debug info, we want to emit 'id' in both cases.
627 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000628 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000629
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000630 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
631 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000632}
633
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000634llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
635 llvm::DIFile *Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000636 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000637 Ty->getPointeeType(), Unit);
638}
639
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000640/// \return whether a C++ mangling exists for the type defined by TD.
641static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
642 switch (TheCU->getSourceLanguage()) {
643 case llvm::dwarf::DW_LANG_C_plus_plus:
644 return true;
645 case llvm::dwarf::DW_LANG_ObjC_plus_plus:
646 return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
647 default:
648 return false;
649 }
650}
651
Manman Rene0064d82013-08-29 23:19:58 +0000652/// In C++ mode, types have linkage, so we can rely on the ODR and
653/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000654static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
655 CodeGenModule &CGM,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000656 llvm::DICompileUnit *TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000657 SmallString<256> FullName;
Manman Rene0064d82013-08-29 23:19:58 +0000658 const TagDecl *TD = Ty->getDecl();
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000659
660 if (!hasCXXMangling(TD, TheCU) || !TD->isExternallyVisible())
Manman Rene0064d82013-08-29 23:19:58 +0000661 return FullName;
Adrian Prantlc6f91a22015-06-15 23:18:16 +0000662
Manman Rene0064d82013-08-29 23:19:58 +0000663 // Microsoft Mangler does not have support for mangleCXXRTTIName yet.
664 if (CGM.getTarget().getCXXABI().isMicrosoft())
665 return FullName;
666
667 // TODO: This is using the RTTI name. Is there a better way to get
668 // a unique string for a type?
669 llvm::raw_svector_ostream Out(FullName);
670 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
Manman Rene0064d82013-08-29 23:19:58 +0000671 return FullName;
672}
673
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000674/// \return the approproate DWARF tag for a composite type.
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000675static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
676 llvm::dwarf::Tag Tag;
677 if (RD->isStruct() || RD->isInterface())
678 Tag = llvm::dwarf::DW_TAG_structure_type;
679 else if (RD->isUnion())
680 Tag = llvm::dwarf::DW_TAG_union_type;
681 else {
682 // FIXME: This could be a struct type giving a default visibility different
683 // than C++ class type, but needs llvm metadata changes first.
684 assert(RD->isClass());
685 Tag = llvm::dwarf::DW_TAG_class_type;
686 }
687 return Tag;
688}
689
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000690llvm::DICompositeType *
Manman Ren1b457022013-08-28 21:20:28 +0000691CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000692 llvm::DIScope *Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000693 const RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000694 if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
695 return cast<llvm::DICompositeType>(T);
696 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +0000697 unsigned Line = getLineNumber(RD->getLocation());
698 StringRef RDName = getClassName(RD);
699
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000700 uint64_t Size = 0;
701 uint64_t Align = 0;
702
703 const RecordDecl *D = RD->getDefinition();
704 if (D && D->isCompleteDefinition()) {
705 Size = CGM.getContext().getTypeSize(Ty);
706 Align = CGM.getContext().getTypeAlign(Ty);
707 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000708
709 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000710 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000711 llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000712 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000713 llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000714 ReplaceMap.emplace_back(
715 std::piecewise_construct, std::make_tuple(Ty),
716 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000717 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000718}
719
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000720llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000721 const Type *Ty,
722 QualType PointeeTy,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000723 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000724 // Bit size, align and offset of the type.
725 // Size is always the size of a pointer. We can't use getTypeSize here
726 // because that does not return the correct value for references.
727 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000728 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000729 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
730
Keno Fischer87842f32015-11-16 09:04:13 +0000731 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
732 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
733 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
734 Size, Align);
735 else
736 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
737 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000738}
739
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000740llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
741 llvm::DIType *&Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000742 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000743 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000744 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
745 TheCU, getOrCreateMainFile(), 0);
746 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
747 Cache = DBuilder.createPointerType(Cache, Size);
748 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000749}
750
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000751llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
752 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000753 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000754 QualType FType;
755 uint64_t FieldSize, FieldOffset;
756 unsigned FieldAlign;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000757 llvm::DINodeArray Elements;
Guy Benyei11169dd2012-12-18 14:30:41 +0000758
759 FieldOffset = 0;
760 FType = CGM.getContext().UnsignedLongTy;
761 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
762 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
763
764 Elements = DBuilder.getOrCreateArray(EltTys);
765 EltTys.clear();
766
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000767 unsigned Flags = llvm::DINode::FlagAppleBlock;
Adrian Prantl498fff62015-07-06 21:31:35 +0000768 unsigned LineNo = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000769
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000770 auto *EltTy =
Adrian Prantl498fff62015-07-06 21:31:35 +0000771 DBuilder.createStructType(Unit, "__block_descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000772 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000773
774 // Bit size, align and offset of the type.
775 uint64_t Size = CGM.getContext().getTypeSize(Ty);
776
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000777 auto *DescTy = DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000778
779 FieldOffset = 0;
780 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
781 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
782 FType = CGM.getContext().IntTy;
783 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
784 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000785 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000786 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
787
788 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000789 FieldSize = CGM.getContext().getTypeSize(Ty);
790 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Adrian Prantl498fff62015-07-06 21:31:35 +0000791 EltTys.push_back(DBuilder.createMemberType(Unit, "__descriptor", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000792 FieldSize, FieldAlign, FieldOffset,
793 0, DescTy));
Guy Benyei11169dd2012-12-18 14:30:41 +0000794
795 FieldOffset += FieldSize;
796 Elements = DBuilder.getOrCreateArray(EltTys);
797
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000798 // The __block_literal_generic structs are marked with a special
799 // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
800 // the debugger needs to know about. To allow type uniquing, emit
801 // them without a name or a location.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000802 EltTy =
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000803 DBuilder.createStructType(Unit, "", nullptr, LineNo,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000804 FieldOffset, 0, Flags, nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000805
Adrian Prantl3d2c0512015-07-07 00:49:35 +0000806 return DBuilder.createPointerType(EltTy, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +0000807}
808
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000809llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
810 llvm::DIFile *Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000811 assert(Ty->isTypeAlias());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000812 llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000813
814 SmallString<128> NS;
815 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000816 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
817 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000818
819 TemplateSpecializationType::PrintTemplateArgumentList(
820 OS, Ty->getArgs(), Ty->getNumArgs(),
821 CGM.getContext().getPrintingPolicy());
822
Eric Christophere7b87e52014-10-26 23:40:33 +0000823 TypeAliasDecl *AliasDecl = cast<TypeAliasTemplateDecl>(
824 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000825
826 SourceLocation Loc = AliasDecl->getLocation();
Adrian Prantlb67dbce2015-09-11 18:45:02 +0000827 return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
828 getLineNumber(Loc),
829 getDeclContextDescriptor(AliasDecl));
David Blaikief1b382e2014-04-06 17:14:06 +0000830}
831
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000832llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
833 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000834 // We don't set size information, but do specify where the typedef was
835 // declared.
David Blaikiebe822ed2015-07-01 18:07:22 +0000836 SourceLocation Loc = Ty->getDecl()->getLocation();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000837
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000838 // Typedefs are derived from some other type.
839 return DBuilder.createTypedef(
840 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
841 Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000842 getDeclContextDescriptor(Ty->getDecl()));
Guy Benyei11169dd2012-12-18 14:30:41 +0000843}
844
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000845llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
846 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000847 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000848
849 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000850 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000851
852 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000853 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000854 if (isa<FunctionNoProtoType>(Ty))
855 EltTys.push_back(DBuilder.createUnspecifiedParameter());
856 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000857 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
858 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000859 if (FPT->isVariadic())
860 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000861 }
862
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000863 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Eric Christopher28a6db52015-10-15 06:56:08 +0000864 return DBuilder.createSubroutineType(EltTypeArray);
Guy Benyei11169dd2012-12-18 14:30:41 +0000865}
866
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000867/// Convert an AccessSpecifier into the corresponding DINode flag.
Adrian Prantl21361fb2014-08-29 22:44:27 +0000868/// As an optimization, return 0 if the access specifier equals the
869/// default for the containing type.
870static unsigned getAccessFlag(AccessSpecifier Access, const RecordDecl *RD) {
871 AccessSpecifier Default = clang::AS_none;
872 if (RD && RD->isClass())
873 Default = clang::AS_private;
874 else if (RD && (RD->isStruct() || RD->isUnion()))
875 Default = clang::AS_public;
876
877 if (Access == Default)
878 return 0;
879
Eric Christophere7b87e52014-10-26 23:40:33 +0000880 switch (Access) {
881 case clang::AS_private:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000882 return llvm::DINode::FlagPrivate;
Eric Christophere7b87e52014-10-26 23:40:33 +0000883 case clang::AS_protected:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000884 return llvm::DINode::FlagProtected;
Eric Christophere7b87e52014-10-26 23:40:33 +0000885 case clang::AS_public:
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000886 return llvm::DINode::FlagPublic;
Eric Christophere7b87e52014-10-26 23:40:33 +0000887 case clang::AS_none:
888 return 0;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000889 }
890 llvm_unreachable("unexpected access enumerator");
891}
Guy Benyei11169dd2012-12-18 14:30:41 +0000892
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000893llvm::DIType *CGDebugInfo::createFieldType(
Eric Christophere7b87e52014-10-26 23:40:33 +0000894 StringRef name, QualType type, uint64_t sizeInBitsOverride,
895 SourceLocation loc, AccessSpecifier AS, uint64_t offsetInBits,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000896 llvm::DIFile *tunit, llvm::DIScope *scope, const RecordDecl *RD) {
897 llvm::DIType *debugType = getOrCreateType(type, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000898
899 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000900 llvm::DIFile *file = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000901 unsigned line = getLineNumber(loc);
902
David Majnemer34b57492014-07-30 01:30:47 +0000903 uint64_t SizeInBits = 0;
904 unsigned AlignInBits = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000905 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +0000906 TypeInfo TI = CGM.getContext().getTypeInfo(type);
907 SizeInBits = TI.Width;
908 AlignInBits = TI.Align;
Guy Benyei11169dd2012-12-18 14:30:41 +0000909
910 if (sizeInBitsOverride)
David Majnemer34b57492014-07-30 01:30:47 +0000911 SizeInBits = sizeInBitsOverride;
Guy Benyei11169dd2012-12-18 14:30:41 +0000912 }
913
Adrian Prantl21361fb2014-08-29 22:44:27 +0000914 unsigned flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +0000915 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
916 AlignInBits, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +0000917}
918
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000919void CGDebugInfo::CollectRecordLambdaFields(
920 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000921 llvm::DIType *RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000922 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
923 // has the name and the location of the variable so we should iterate over
924 // both concurrently.
925 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
926 RecordDecl::field_iterator Field = CXXDecl->field_begin();
927 unsigned fieldno = 0;
928 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +0000929 E = CXXDecl->captures_end();
930 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +0000931 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +0000932 if (C.capturesVariable()) {
933 VarDecl *V = C.getCapturedVar();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000934 llvm::DIFile *VUnit = getOrCreateFile(C.getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +0000935 StringRef VName = V->getName();
936 uint64_t SizeInBitsOverride = 0;
937 if (Field->isBitField()) {
938 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
939 assert(SizeInBitsOverride && "found named 0-width bitfield");
940 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000941 llvm::DIType *fieldType = createFieldType(
Eric Christophere7b87e52014-10-26 23:40:33 +0000942 VName, Field->getType(), SizeInBitsOverride, C.getLocation(),
943 Field->getAccess(), layout.getFieldOffset(fieldno), VUnit, RecordTy,
944 CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000945 elements.push_back(fieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +0000946 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +0000947 // TODO: Need to handle 'this' in some way by probably renaming the
948 // this of the lambda class and having a field member of 'this' or
949 // by using AT_object_pointer for the function and having that be
950 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +0000951 FieldDecl *f = *Field;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000952 llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
Eric Christopher91a31902013-01-16 01:22:32 +0000953 QualType type = f->getType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000954 llvm::DIType *fieldType = createFieldType(
Eric Christophere7b87e52014-10-26 23:40:33 +0000955 "this", type, 0, f->getLocation(), f->getAccess(),
956 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000957
958 elements.push_back(fieldType);
959 }
960 }
961}
962
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000963llvm::DIDerivedType *
964CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +0000965 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000966 // Create the descriptor for the static variable, with or without
967 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +0000968 Var = Var->getCanonicalDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000969 llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
970 llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
Eric Christopher91a31902013-01-16 01:22:32 +0000971
Eric Christopher91a31902013-01-16 01:22:32 +0000972 unsigned LineNumber = getLineNumber(Var->getLocation());
973 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +0000974 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +0000975 if (Var->getInit()) {
976 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000977 if (Value) {
978 if (Value->isInt())
979 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
980 if (Value->isFloat())
981 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
982 }
Eric Christopher91a31902013-01-16 01:22:32 +0000983 }
984
Adrian Prantl21361fb2014-08-29 22:44:27 +0000985 unsigned Flags = getAccessFlag(Var->getAccess(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000986 llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
David Blaikieae019462013-08-15 22:50:29 +0000987 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000988 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +0000989 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +0000990}
991
Eric Christophere7b87e52014-10-26 23:40:33 +0000992void CGDebugInfo::CollectRecordNormalField(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000993 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
994 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +0000995 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000996 StringRef name = field->getName();
997 QualType type = field->getType();
998
999 // Ignore unnamed fields unless they're anonymous structs/unions.
1000 if (name.empty() && !type->isRecordType())
1001 return;
1002
1003 uint64_t SizeInBitsOverride = 0;
1004 if (field->isBitField()) {
1005 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
1006 assert(SizeInBitsOverride && "found named 0-width bitfield");
1007 }
1008
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001009 llvm::DIType *fieldType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001010 createFieldType(name, type, SizeInBitsOverride, field->getLocation(),
1011 field->getAccess(), OffsetInBits, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +00001012
1013 elements.push_back(fieldType);
1014}
1015
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001016void CGDebugInfo::CollectRecordFields(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001017 const RecordDecl *record, llvm::DIFile *tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001018 SmallVectorImpl<llvm::Metadata *> &elements,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001019 llvm::DICompositeType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001020 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1021
Eric Christopher91a31902013-01-16 01:22:32 +00001022 if (CXXDecl && CXXDecl->isLambda())
1023 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1024 else {
1025 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001026
Eric Christopher91a31902013-01-16 01:22:32 +00001027 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +00001028 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +00001029
Eric Christopher91a31902013-01-16 01:22:32 +00001030 // Static and non-static members should appear in the same order as
1031 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +00001032 for (const auto *I : record->decls())
1033 if (const auto *V = dyn_cast<VarDecl>(I)) {
David Blaikiece763042013-08-20 21:49:21 +00001034 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001035 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001036 if (MI != StaticDataMemberCache.end()) {
1037 assert(MI->second &&
1038 "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00001039 elements.push_back(MI->second);
Adrian Prantl21361fb2014-08-29 22:44:27 +00001040 } else {
1041 auto Field = CreateRecordStaticField(V, RecordTy, record);
1042 elements.push_back(Field);
1043 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001044 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001045 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1046 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001047
1048 // Bump field number for next field.
1049 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +00001050 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001051 }
1052}
1053
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001054llvm::DISubroutineType *
Guy Benyei11169dd2012-12-18 14:30:41 +00001055CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001056 llvm::DIFile *Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001057 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001058 if (Method->isStatic())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001059 return cast_or_null<llvm::DISubroutineType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001060 getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001061 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1062 Func, Unit);
1063}
David Blaikie2aaf0652013-01-07 22:24:59 +00001064
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001065llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1066 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001067 // Add "this" pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001068 llvm::DITypeRefArray Args(
1069 cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00001070 ->getTypeArray());
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001071 assert(Args.size() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001072
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001073 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001074
1075 // First element is always return type. For 'void' functions it is NULL.
Duncan P. N. Exon Smith37328582015-04-07 18:41:26 +00001076 Elts.push_back(Args[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001077
David Blaikie2aaf0652013-01-07 22:24:59 +00001078 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001079 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001080 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1081 // Create pointer type directly in this case.
1082 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1083 QualType PointeeTy = ThisPtrTy->getPointeeType();
1084 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001085 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001086 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001087 llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1088 llvm::DIType *ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001089 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001090 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001091 // TODO: This and the artificial type below are misleading, the
1092 // types aren't artificial the argument is, but the current
1093 // metadata doesn't represent that.
1094 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1095 Elts.push_back(ThisPtrType);
1096 } else {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001097 llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001098 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001099 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1100 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001101 }
1102
1103 // Copy rest of the arguments.
Duncan P. N. Exon Smitha98fac62015-04-07 04:14:45 +00001104 for (unsigned i = 1, e = Args.size(); i != e; ++i)
1105 Elts.push_back(Args[i]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001106
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001107 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001108
Adrian Prantl0630eb72013-12-18 21:48:18 +00001109 unsigned Flags = 0;
1110 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001111 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001112 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001113 Flags |= llvm::DINode::FlagRValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001114
Eric Christopher28a6db52015-10-15 06:56:08 +00001115 return DBuilder.createSubroutineType(EltTypeArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001116}
1117
Eric Christopherb2a008c2013-05-16 00:45:12 +00001118/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001119/// inside a function.
1120static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1121 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1122 return isFunctionLocalClass(NRD);
1123 if (isa<FunctionDecl>(RD->getDeclContext()))
1124 return true;
1125 return false;
1126}
1127
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001128llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1129 const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001130 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001131 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001132
Guy Benyei11169dd2012-12-18 14:30:41 +00001133 StringRef MethodName = getFunctionName(Method);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001134 llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001135
1136 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1137 // make sense to give a single ctor/dtor a linkage name.
1138 StringRef MethodLinkageName;
1139 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1140 MethodLinkageName = CGM.getMangledName(Method);
1141
1142 // Get the location for the method.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001143 llvm::DIFile *MethodDefUnit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00001144 unsigned MethodLine = 0;
1145 if (!Method->isImplicit()) {
1146 MethodDefUnit = getOrCreateFile(Method->getLocation());
1147 MethodLine = getLineNumber(Method->getLocation());
1148 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001149
1150 // Collect virtual method info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001151 llvm::DIType *ContainingType = nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001152 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001153 unsigned VIndex = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001154
Guy Benyei11169dd2012-12-18 14:30:41 +00001155 if (Method->isVirtual()) {
1156 if (Method->isPure())
1157 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1158 else
1159 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001160
Guy Benyei11169dd2012-12-18 14:30:41 +00001161 // It doesn't make sense to give a virtual destructor a vtable index,
1162 // since a single destructor has two entries in the vtable.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001163 // FIXME: Add proper support for debug info for virtual calls in
1164 // the Microsoft ABI, where we may use multiple vptrs to make a vftable
1165 // lookup if we have multiple or virtual inheritance.
1166 if (!isa<CXXDestructorDecl>(Method) &&
1167 !CGM.getTarget().getCXXABI().isMicrosoft())
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001168 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
Guy Benyei11169dd2012-12-18 14:30:41 +00001169 ContainingType = RecordTy;
1170 }
1171
1172 unsigned Flags = 0;
1173 if (Method->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001174 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001175 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
Guy Benyei11169dd2012-12-18 14:30:41 +00001176 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1177 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001178 Flags |= llvm::DINode::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001179 } else if (const CXXConversionDecl *CXXC =
Eric Christophere7b87e52014-10-26 23:40:33 +00001180 dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001181 if (CXXC->isExplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001182 Flags |= llvm::DINode::FlagExplicit;
Guy Benyei11169dd2012-12-18 14:30:41 +00001183 }
1184 if (Method->hasPrototype())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001185 Flags |= llvm::DINode::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001186 if (Method->getRefQualifier() == RQ_LValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001187 Flags |= llvm::DINode::FlagLValueReference;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001188 if (Method->getRefQualifier() == RQ_RValue)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001189 Flags |= llvm::DINode::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001190
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001191 llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1192 llvm::DISubprogram *SP = DBuilder.createMethod(
Eric Christophere7b87e52014-10-26 23:40:33 +00001193 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1194 MethodTy, /*isLocalToUnit=*/false,
1195 /* isDefinition=*/false, Virtuality, VIndex, ContainingType, Flags,
Peter Collingbourne0900fe02015-11-05 22:04:14 +00001196 CGM.getLangOpts().Optimize, TParamsArray.get());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001197
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001198 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001199
1200 return SP;
1201}
1202
Eric Christophere7b87e52014-10-26 23:40:33 +00001203void CGDebugInfo::CollectCXXMemberFunctions(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001204 const CXXRecordDecl *RD, llvm::DIFile *Unit,
1205 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001206
1207 // Since we want more than just the individual member decls if we
1208 // have templated functions iterate over every declaration to gather
1209 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001210 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001211 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1212 // If the member is implicit, don't add it to the member list. This avoids
1213 // the member being added to type units by LLVM, while still allowing it
1214 // to be emitted into the type declaration/reference inside the compile
1215 // unit.
Paul Robinson6a7511b2015-06-25 17:50:43 +00001216 // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
David Blaikie6dddfe32014-10-06 05:52:27 +00001217 // FIXME: Handle Using(Shadow?)Decls here to create
1218 // DW_TAG_imported_declarations inside the class for base decls brought into
1219 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1220 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1221 // referenced)
Paul Robinson6a7511b2015-06-25 17:50:43 +00001222 if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
David Blaikiefd580722014-10-06 05:18:55 +00001223 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001224
1225 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1226 continue;
1227
David Blaikiefd580722014-10-06 05:18:55 +00001228 // Reuse the existing member function declaration if it exists.
1229 // It may be associated with the declaration of the type & should be
1230 // reused as we're building the definition.
1231 //
1232 // This situation can arise in the vtable-based debug info reduction where
1233 // implicit members are emitted in a non-vtable TU.
1234 auto MI = SPCache.find(Method->getCanonicalDecl());
1235 EltTys.push_back(MI == SPCache.end()
1236 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001237 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001238 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001239}
Guy Benyei11169dd2012-12-18 14:30:41 +00001240
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001241void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001242 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001243 llvm::DIType *RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001244 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001245 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001246 unsigned BFlags = 0;
1247 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001248
Guy Benyei11169dd2012-12-18 14:30:41 +00001249 const CXXRecordDecl *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001250 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001251
Aaron Ballman574705e2014-03-13 15:41:46 +00001252 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001253 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1254 // virtual base offset offset is -ve. The code generator emits dwarf
1255 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001256 BaseOffset = 0 - CGM.getItaniumVTableContext()
1257 .getVirtualBaseOffsetOffset(RD, Base)
1258 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001259 } else {
1260 // In the MS ABI, store the vbtable offset, which is analogous to the
1261 // vbase offset offset in Itanium.
1262 BaseOffset =
1263 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1264 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001265 BFlags = llvm::DINode::FlagVirtual;
Guy Benyei11169dd2012-12-18 14:30:41 +00001266 } else
1267 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1268 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1269 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001270
Adrian Prantl21361fb2014-08-29 22:44:27 +00001271 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001272 llvm::DIType *DTy = DBuilder.createInheritance(
Eric Christophere7b87e52014-10-26 23:40:33 +00001273 RecordTy, getOrCreateType(BI.getType(), Unit), BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001274 EltTys.push_back(DTy);
1275 }
1276}
1277
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001278llvm::DINodeArray
Eric Christophere7b87e52014-10-26 23:40:33 +00001279CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1280 ArrayRef<TemplateArgument> TAList,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001281 llvm::DIFile *Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001282 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001283 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1284 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001285 StringRef Name;
1286 if (TPList)
1287 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001288 switch (TA.getKind()) {
1289 case TemplateArgument::Type: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001290 llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001291 TemplateParams.push_back(
1292 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
David Blaikie38079fd2013-05-10 21:53:14 +00001293 } break;
1294 case TemplateArgument::Integral: {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001295 llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001296 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1297 TheCU, Name, TTy,
1298 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
David Blaikie38079fd2013-05-10 21:53:14 +00001299 } break;
1300 case TemplateArgument::Declaration: {
1301 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001302 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001303 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001304 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001305 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001306 // Variable pointer template parameters have a value that is the address
1307 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001308 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001309 V = CGM.GetAddrOfGlobalVar(VD);
1310 // Member function pointers have special support for building them, though
1311 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001312 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Majnemere2be95b2015-06-23 07:31:01 +00001313 V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001314 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001315 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001316 // Member data pointers have special handling too to compute the fixed
1317 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001318 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001319 // These five lines (& possibly the above member function pointer
1320 // handling) might be able to be refactored to use similar code in
1321 // CodeGenModule::getMemberPointerConstant
1322 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1323 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001324 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001325 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001326 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001327 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1328 TheCU, Name, TTy,
1329 cast_or_null<llvm::Constant>(V->stripPointerCasts())));
David Blaikie38079fd2013-05-10 21:53:14 +00001330 } break;
1331 case TemplateArgument::NullPtr: {
1332 QualType T = TA.getNullPtrType();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001333 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001334 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001335 // Special case member data pointer null values since they're actually -1
1336 // instead of zero.
1337 if (const MemberPointerType *MPT =
1338 dyn_cast<MemberPointerType>(T.getTypePtr()))
1339 // But treat member function pointers as simple zero integers because
1340 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1341 // CodeGen grows handling for values of non-null member function
1342 // pointers then perhaps we could remove this special case and rely on
1343 // EmitNullMemberPointer for member function pointers.
1344 if (MPT->isMemberDataPointer())
1345 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1346 if (!V)
1347 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001348 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1349 TheCU, Name, TTy, cast<llvm::Constant>(V)));
David Blaikie38079fd2013-05-10 21:53:14 +00001350 } break;
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001351 case TemplateArgument::Template:
1352 TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001353 TheCU, Name, nullptr,
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001354 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString()));
1355 break;
1356 case TemplateArgument::Pack:
1357 TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1358 TheCU, Name, nullptr,
1359 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1360 break;
David Majnemer5559d472013-08-24 08:21:10 +00001361 case TemplateArgument::Expression: {
1362 const Expr *E = TA.getAsExpr();
1363 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001364 if (E->isGLValue())
1365 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001366 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001367 assert(V && "Expression in template argument isn't constant");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001368 llvm::DIType *TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00001369 TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1370 TheCU, Name, TTy, cast<llvm::Constant>(V->stripPointerCasts())));
David Majnemer5559d472013-08-24 08:21:10 +00001371 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001372 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001373 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001374 case TemplateArgument::Null:
1375 llvm_unreachable(
1376 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001377 }
1378 }
1379 return DBuilder.getOrCreateArray(TemplateParams);
1380}
1381
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001382llvm::DINodeArray
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00001383CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001384 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001385 if (FD->getTemplatedKind() ==
1386 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001387 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1388 ->getTemplate()
1389 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001390 return CollectTemplateParams(
1391 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001392 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001393 return llvm::DINodeArray();
Guy Benyei11169dd2012-12-18 14:30:41 +00001394}
1395
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001396llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1397 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001398 // Always get the full list of parameters, not just the ones from
1399 // the specialization.
1400 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001401 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001402 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001403 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001404}
1405
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001406llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001407 if (VTablePtrType)
Guy Benyei11169dd2012-12-18 14:30:41 +00001408 return VTablePtrType;
1409
1410 ASTContext &Context = CGM.getContext();
1411
1412 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001413 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001414 llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
Eric Christopher28a6db52015-10-15 06:56:08 +00001415 llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001416 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001417 llvm::DIType *vtbl_ptr_type =
Eric Christophere7b87e52014-10-26 23:40:33 +00001418 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001419 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1420 return VTablePtrType;
1421}
1422
Guy Benyei11169dd2012-12-18 14:30:41 +00001423StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001424 // Copy the gdb compatible name on the side and use its reference.
1425 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001426}
1427
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001428void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001429 SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001430 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1431
1432 // If there is a primary base then it will hold vtable info.
1433 if (RL.getPrimaryBase())
1434 return;
1435
1436 // If this class is not dynamic then there is not any vtable info to collect.
1437 if (!RD->isDynamicClass())
1438 return;
1439
1440 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001441 llvm::DIType *VPTR = DBuilder.createMemberType(
Eric Christophere7b87e52014-10-26 23:40:33 +00001442 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001443 llvm::DINode::FlagArtificial, getOrCreateVTablePtrType(Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001444 EltTys.push_back(VPTR);
1445}
1446
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001447llvm::DIType *CGDebugInfo::getOrCreateRecordType(QualType RTy,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001448 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001449 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001450 llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00001451 return T;
1452}
1453
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001454llvm::DIType *CGDebugInfo::getOrCreateInterfaceType(QualType D,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001455 SourceLocation Loc) {
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001456 return getOrCreateStandaloneType(D, Loc);
1457}
1458
1459llvm::DIType *CGDebugInfo::getOrCreateStandaloneType(QualType D,
1460 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001461 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001462 assert(!D.isNull() && "null type");
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001463 llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlad9a195e2015-08-27 21:21:19 +00001464 assert(T && "could not create debug info for type");
Adrian Prantl3a884fa2015-08-27 22:56:46 +00001465
1466 // Composite types with UIDs were already retained by DIBuilder
1467 // because they are only referenced by name in the IR.
1468 if (auto *CTy = dyn_cast<llvm::DICompositeType>(T))
1469 if (!CTy->getIdentifier().empty())
1470 return T;
Adrian Prantl73409ce2013-03-11 18:33:46 +00001471 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001472 return T;
1473}
1474
David Blaikie483a9da2014-05-06 18:35:21 +00001475void CGDebugInfo::completeType(const EnumDecl *ED) {
1476 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1477 return;
1478 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001479 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001480 auto I = TypeCache.find(TyPtr);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001481 if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001482 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001483 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001484 assert(!Res->isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001485 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001486}
1487
David Blaikieb2e86eb2013-08-15 20:49:17 +00001488void CGDebugInfo::completeType(const RecordDecl *RD) {
1489 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1490 !CGM.getLangOpts().CPlusPlus)
1491 completeRequiredType(RD);
1492}
1493
1494void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie0856f662014-03-04 22:01:08 +00001495 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1496 return;
1497
David Blaikie6943dea2013-08-20 01:28:15 +00001498 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1499 if (CXXDecl->isDynamicClass())
1500 return;
1501
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001502 if (DebugTypeExtRefs && RD->isFromASTFile())
1503 return;
1504
David Blaikieb2e86eb2013-08-15 20:49:17 +00001505 QualType Ty = CGM.getContext().getRecordType(RD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001506 llvm::DIType *T = getTypeOrNull(Ty);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00001507 if (T && T->isForwardDecl())
David Blaikie6943dea2013-08-20 01:28:15 +00001508 completeClassData(RD);
1509}
1510
1511void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1512 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001513 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001514 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001515 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +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 Blaikieb2e86eb2013-08-15 20:49:17 +00001518 return;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001519 llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
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 Blaikieb2e86eb2013-08-15 20:49:17 +00001522}
1523
David Blaikie0e716b42014-03-03 23:48:23 +00001524static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1525 CXXRecordDecl::method_iterator End) {
1526 for (; I != End; ++I)
1527 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001528 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1529 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001530 return true;
1531 return false;
1532}
1533
1534static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001535 bool DebugTypeExtRefs,
David Blaikie0e716b42014-03-03 23:48:23 +00001536 const RecordDecl *RD,
1537 const LangOptions &LangOpts) {
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001538 // Does the type exist in an imported clang module?
Adrian Prantl5d66c6b2015-09-11 18:54:28 +00001539 if (DebugTypeExtRefs && RD->isFromASTFile() && RD->getDefinition())
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001540 return true;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001541
David Blaikie0e716b42014-03-03 23:48:23 +00001542 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1543 return false;
1544
1545 if (!LangOpts.CPlusPlus)
1546 return false;
1547
1548 if (!RD->isCompleteDefinitionRequired())
1549 return true;
1550
1551 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1552
1553 if (!CXXDecl)
1554 return false;
1555
1556 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1557 return true;
1558
1559 TemplateSpecializationKind Spec = TSK_Undeclared;
1560 if (const ClassTemplateSpecializationDecl *SD =
1561 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1562 Spec = SD->getSpecializationKind();
1563
1564 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1565 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1566 CXXDecl->method_end()))
1567 return true;
1568
1569 return false;
1570}
1571
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001572llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001573 RecordDecl *RD = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001574 llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001575 if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
1576 CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001577 if (!T)
Adrian Prantl6ec370a2015-09-10 18:39:45 +00001578 T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001579 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001580 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001581
David Blaikieb2e86eb2013-08-15 20:49:17 +00001582 return CreateTypeDefinition(Ty);
1583}
1584
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001585llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
David Blaikieb2e86eb2013-08-15 20:49:17 +00001586 RecordDecl *RD = Ty->getDecl();
1587
Guy Benyei11169dd2012-12-18 14:30:41 +00001588 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001589 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001590
1591 // Records and classes and unions can all be recursive. To handle them, we
1592 // first generate a debug descriptor for the struct as a forward declaration.
1593 // Then (if it is a definition) we go through and get debug info for all of
1594 // its members. Finally, we create a descriptor for the complete type (which
1595 // may refer to the forward decl if the struct is recursive) and replace all
1596 // uses of the forward declaration with the final definition.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00001597 llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001598
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001599 const RecordDecl *D = RD->getDefinition();
1600 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001601 return FwdDecl;
1602
David Blaikieadfbf992013-08-18 16:55:33 +00001603 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1604 CollectContainingType(CXXDecl, FwdDecl);
1605
Guy Benyei11169dd2012-12-18 14:30:41 +00001606 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001607 LexicalBlockStack.emplace_back(&*FwdDecl);
1608 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001609
Guy Benyei11169dd2012-12-18 14:30:41 +00001610 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001611 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001612 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001613
1614 // Note: The split of CXXDecl information here is intentional, the
1615 // gdb tests will depend on a certain ordering at printout. The debug
1616 // information offsets are still correct if we merge them all together
1617 // though.
1618 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1619 if (CXXDecl) {
1620 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1621 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1622 }
1623
Eric Christopher91a31902013-01-16 01:22:32 +00001624 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001625 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001626 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001627 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001628
1629 LexicalBlockStack.pop_back();
1630 RegionMap.erase(Ty->getDecl());
1631
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001632 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001633 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001634
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001635 if (FwdDecl->isTemporary())
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001636 FwdDecl =
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001637 llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001638
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001639 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001640 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001641}
1642
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001643llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1644 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001645 // Ignore protocols.
1646 return getOrCreateType(Ty->getBaseType(), Unit);
1647}
1648
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001649/// \return true if Getter has the default name for the property PD.
1650static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1651 const ObjCMethodDecl *Getter) {
1652 assert(PD);
1653 if (!Getter)
1654 return true;
1655
1656 assert(Getter->getDeclName().isObjCZeroArgSelector());
1657 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001658 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001659}
1660
1661/// \return true if Setter has the default name for the property PD.
1662static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1663 const ObjCMethodDecl *Setter) {
1664 assert(PD);
1665 if (!Setter)
1666 return true;
1667
1668 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001669 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001670 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001671}
1672
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001673llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1674 llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001675 ObjCInterfaceDecl *ID = Ty->getDecl();
1676 if (!ID)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001677 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001678
Adrian Prantl5c8bd882015-09-11 17:23:08 +00001679 // Return a forward declaration if this type was imported from a clang module.
1680 if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition())
1681 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1682 ID->getName(),
1683 getDeclContextDescriptor(ID), Unit, 0);
1684
Guy Benyei11169dd2012-12-18 14:30:41 +00001685 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001686 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001687 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001688 auto RuntimeLang =
1689 static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
Guy Benyei11169dd2012-12-18 14:30:41 +00001690
1691 // If this is just a forward declaration return a special forward-declaration
1692 // debug type since we won't be able to lay out the entire type.
1693 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001694 if (!Def || !Def->getImplementation()) {
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001695 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001696 llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
Adrian Prantl42ce2d32015-10-01 16:57:02 +00001697 llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
1698 DefUnit, Line, RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001699 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001700 return FwdDecl;
1701 }
1702
David Blaikieef8a9512014-05-05 23:23:53 +00001703 return CreateTypeDefinition(Ty, Unit);
1704}
1705
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001706llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +00001707CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
1708 bool CreateSkeletonCU) {
Adrian Prantleb66a262015-09-24 16:10:04 +00001709 // Use the Module pointer as the key into the cache. This is a
1710 // nullptr if the "Module" is a PCH, which is safe because we don't
1711 // support chained PCH debug info, so there can only be a single PCH.
1712 const Module *M = Mod.getModuleOrNull();
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001713 auto ModRef = ModuleCache.find(M);
1714 if (ModRef != ModuleCache.end())
1715 return cast<llvm::DIModule>(ModRef->second);
Adrian Prantl2388ead2015-06-30 18:01:05 +00001716
1717 // Macro definitions that were defined with "-D" on the command line.
1718 SmallString<128> ConfigMacros;
1719 {
1720 llvm::raw_svector_ostream OS(ConfigMacros);
1721 const auto &PPOpts = CGM.getPreprocessorOpts();
1722 unsigned I = 0;
1723 // Translate the macro definitions back into a commmand line.
1724 for (auto &M : PPOpts.Macros) {
1725 if (++I > 1)
1726 OS << " ";
1727 const std::string &Macro = M.first;
1728 bool Undef = M.second;
1729 OS << "\"-" << (Undef ? 'U' : 'D');
1730 for (char c : Macro)
1731 switch (c) {
1732 case '\\' : OS << "\\\\"; break;
1733 case '"' : OS << "\\\""; break;
1734 default: OS << c;
1735 }
1736 OS << '\"';
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001737 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001738 }
Adrian Prantl66689202015-09-18 23:01:45 +00001739
Adrian Prantl835e6632015-09-24 16:10:10 +00001740 bool IsRootModule = M ? !M->Parent : true;
1741 if (CreateSkeletonCU && IsRootModule) {
Adrian Prantl66689202015-09-18 23:01:45 +00001742 llvm::DIBuilder DIB(CGM.getModule());
Adrian Prantl835e6632015-09-24 16:10:10 +00001743 DIB.createCompileUnit(TheCU->getSourceLanguage(), Mod.getModuleName(),
Adrian Prantl6083b082015-09-24 16:10:00 +00001744 Mod.getPath(), TheCU->getProducer(), true,
1745 StringRef(), 0, Mod.getASTFile(),
1746 llvm::DIBuilder::FullDebug, Mod.getSignature());
Adrian Prantl66689202015-09-18 23:01:45 +00001747 DIB.finalize();
Adrian Prantl2f957ac2015-09-19 00:59:22 +00001748 }
Adrian Prantl835e6632015-09-24 16:10:10 +00001749 llvm::DIModule *Parent =
1750 IsRootModule ? nullptr
1751 : getOrCreateModuleRef(
1752 ExternalASTSource::ASTSourceDescriptor(*M->Parent),
1753 CreateSkeletonCU);
Adrian Prantleb66a262015-09-24 16:10:04 +00001754 llvm::DIModule *DIMod =
Adrian Prantl835e6632015-09-24 16:10:10 +00001755 DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
1756 Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
Adrian Prantl9e8ea352015-09-29 20:44:46 +00001757 ModuleCache[M].reset(DIMod);
Adrian Prantleb66a262015-09-24 16:10:04 +00001758 return DIMod;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00001759}
1760
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001761llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
1762 llvm::DIFile *Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00001763 ObjCInterfaceDecl *ID = Ty->getDecl();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001764 llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
David Blaikieef8a9512014-05-05 23:23:53 +00001765 unsigned Line = getLineNumber(ID->getLocation());
Duncan P. N. Exon Smith798d5652015-04-15 23:19:15 +00001766 unsigned RuntimeLang = TheCU->getSourceLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001767
1768 // Bit size, align and offset of the type.
1769 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1770 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1771
1772 unsigned Flags = 0;
1773 if (ID->getImplementation())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001774 Flags |= llvm::DINode::FlagObjcClassComplete;
Guy Benyei11169dd2012-12-18 14:30:41 +00001775
Adrian Prantlfd696112015-10-01 00:48:51 +00001776 llvm::DIScope *Mod = getParentModuleOrNull(ID);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001777 llvm::DICompositeType *RealDecl = DBuilder.createStructType(
Adrian Prantlfd696112015-10-01 00:48:51 +00001778 Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
1779 nullptr, llvm::DINodeArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001780
David Blaikieef8a9512014-05-05 23:23:53 +00001781 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001782 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001783
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001784 // Push the struct on region stack.
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00001785 LexicalBlockStack.emplace_back(RealDecl);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001786 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001787
1788 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001789 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001790
1791 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1792 if (SClass) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001793 llvm::DIType *SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001794 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001795 if (!SClassTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001796 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001797
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001798 llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00001799 EltTys.push_back(InhTag);
1800 }
1801
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001802 // Create entries for all of the properties.
Nico Weber7123bca2015-12-04 19:14:14 +00001803 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001804 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001805 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001806 unsigned PLine = getLineNumber(Loc);
1807 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1808 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001809 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
1810 PD->getName(), PUnit, PLine,
1811 hasDefaultGetterName(PD, Getter) ? ""
1812 : getSelectorName(PD->getGetterName()),
1813 hasDefaultSetterName(PD, Setter) ? ""
1814 : getSelectorName(PD->getSetterName()),
1815 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001816 EltTys.push_back(PropertyNode);
Nico Weber7123bca2015-12-04 19:14:14 +00001817 };
1818 {
1819 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weberde059e12015-12-04 19:35:45 +00001820 for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
1821 for (auto *PD : ClassExt->properties()) {
1822 PropertySet.insert(PD->getIdentifier());
1823 AddProperty(PD);
1824 }
Nico Weber7123bca2015-12-04 19:14:14 +00001825 for (const auto *PD : ID->properties()) {
1826 // Don't emit duplicate metadata for properties that were already in a
1827 // class extension.
1828 if (!PropertySet.insert(PD->getIdentifier()).second)
1829 continue;
1830 AddProperty(PD);
1831 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001832 }
1833
1834 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1835 unsigned FieldNo = 0;
1836 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1837 Field = Field->getNextIvar(), ++FieldNo) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001838 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Duncan P. N. Exon Smithb7470232015-04-15 23:48:50 +00001839 if (!FieldTy)
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001840 return nullptr;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001841
Guy Benyei11169dd2012-12-18 14:30:41 +00001842 StringRef FieldName = Field->getName();
1843
1844 // Ignore unnamed fields.
1845 if (FieldName.empty())
1846 continue;
1847
1848 // Get the location for the field.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001849 llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00001850 unsigned FieldLine = getLineNumber(Field->getLocation());
1851 QualType FType = Field->getType();
1852 uint64_t FieldSize = 0;
1853 unsigned FieldAlign = 0;
1854
1855 if (!FType->isIncompleteArrayType()) {
1856
1857 // Bit size, align and offset of the type.
1858 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001859 ? Field->getBitWidthValue(CGM.getContext())
1860 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001861 FieldAlign = CGM.getContext().getTypeAlign(FType);
1862 }
1863
1864 uint64_t FieldOffset;
1865 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1866 // We don't know the runtime offset of an ivar if we're using the
1867 // non-fragile ABI. For bitfields, use the bit offset into the first
1868 // byte of storage of the bitfield. For other fields, use zero.
1869 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001870 FieldOffset =
1871 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00001872 FieldOffset %= CGM.getContext().getCharWidth();
1873 } else {
1874 FieldOffset = 0;
1875 }
1876 } else {
1877 FieldOffset = RL.getFieldOffset(FieldNo);
1878 }
1879
1880 unsigned Flags = 0;
1881 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001882 Flags = llvm::DINode::FlagProtected;
Guy Benyei11169dd2012-12-18 14:30:41 +00001883 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001884 Flags = llvm::DINode::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001885 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001886 Flags = llvm::DINode::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00001887
Craig Topper8a13c412014-05-21 05:09:00 +00001888 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001889 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001890 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00001891 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001892 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001893 SourceLocation Loc = PD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001894 llvm::DIFile *PUnit = getOrCreateFile(Loc);
Eric Christopherc0c5d462013-02-21 22:35:08 +00001895 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001896 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1897 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001898 PropertyNode = DBuilder.createObjCProperty(
1899 PD->getName(), PUnit, PLine,
1900 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
1901 PD->getGetterName()),
1902 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
1903 PD->getSetterName()),
1904 PD->getPropertyAttributes(),
1905 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001906 }
1907 }
1908 }
Eric Christophere7b87e52014-10-26 23:40:33 +00001909 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
1910 FieldSize, FieldAlign, FieldOffset, Flags,
1911 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00001912 EltTys.push_back(FieldTy);
1913 }
1914
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001915 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001916 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001917
Guy Benyei11169dd2012-12-18 14:30:41 +00001918 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001919 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001920}
1921
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001922llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
1923 llvm::DIFile *Unit) {
1924 llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001925 int64_t Count = Ty->getNumElements();
1926 if (Count == 0)
1927 // If number of elements are not known then this is an unbounded array.
1928 // Use Count == -1 to express such arrays.
1929 Count = -1;
1930
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001931 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001932 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Guy Benyei11169dd2012-12-18 14:30:41 +00001933
1934 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1935 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1936
1937 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1938}
1939
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001940llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001941 uint64_t Size;
1942 uint64_t Align;
1943
1944 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1945 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1946 Size = 0;
1947 Align =
Eric Christophere7b87e52014-10-26 23:40:33 +00001948 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Guy Benyei11169dd2012-12-18 14:30:41 +00001949 } else if (Ty->isIncompleteArrayType()) {
1950 Size = 0;
1951 if (Ty->getElementType()->isIncompleteType())
1952 Align = 0;
1953 else
1954 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001955 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001956 Size = 0;
1957 Align = 0;
1958 } else {
1959 // Size and align of the whole array, not the element type.
1960 Size = CGM.getContext().getTypeSize(Ty);
1961 Align = CGM.getContext().getTypeAlign(Ty);
1962 }
1963
1964 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1965 // interior arrays, do we care? Why aren't nested arrays represented the
1966 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001967 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001968 QualType EltTy(Ty, 0);
1969 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1970 // If the number of elements is known, then count is that number. Otherwise,
1971 // it's -1. This allows us to represent a subrange with an array of 0
1972 // elements, like this:
1973 //
1974 // struct foo {
1975 // int x[0];
1976 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00001977 int64_t Count = -1; // Count == -1 is an unbounded array.
Guy Benyei11169dd2012-12-18 14:30:41 +00001978 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1979 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001980
Guy Benyei11169dd2012-12-18 14:30:41 +00001981 // FIXME: Verify this is right for VLAs.
1982 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1983 EltTy = Ty->getElementType();
1984 }
1985
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001986 llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001987
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00001988 return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1989 SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00001990}
1991
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001992llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
1993 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001994 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
1995 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001996}
1997
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00001998llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
1999 llvm::DIFile *Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002000 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2001 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002002}
2003
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002004llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2005 llvm::DIFile *U) {
David Majnemer9df56372015-09-10 21:52:00 +00002006 uint64_t Size =
2007 !Ty->isIncompleteType() ? CGM.getContext().getTypeSize(Ty) : 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002008 llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
David Majnemer5fd33e02015-04-24 01:25:08 +00002009 if (Ty->isMemberDataPointerType())
David Blaikie2c705ca2013-01-19 19:20:56 +00002010 return DBuilder.createMemberPointerType(
David Majnemer34568bc2015-05-26 21:54:24 +00002011 getOrCreateType(Ty->getPointeeType(), U), ClassType, Size);
Adrian Prantl0866acd2013-12-19 01:38:47 +00002012
2013 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00002014 Ty->getPointeeType()->getAs<FunctionProtoType>();
2015 return DBuilder.createMemberPointerType(
2016 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
2017 Ty->getClass(), FPT->getTypeQuals())),
2018 FPT, U),
David Majnemer34568bc2015-05-26 21:54:24 +00002019 ClassType, Size);
Guy Benyei11169dd2012-12-18 14:30:41 +00002020}
2021
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002022llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002023 // Ignore the atomic wrapping
2024 // FIXME: What is the correct representation?
2025 return getOrCreateType(Ty->getValueType(), U);
2026}
2027
Xiuli Pan9c14e282016-01-09 12:53:17 +00002028llvm::DIType* CGDebugInfo::CreateType(const PipeType *Ty,
2029 llvm::DIFile *U) {
2030 return getOrCreateType(Ty->getElementType(), U);
2031}
2032
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002033llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00002034 const EnumDecl *ED = Ty->getDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002035
Guy Benyei11169dd2012-12-18 14:30:41 +00002036 uint64_t Size = 0;
2037 uint64_t Align = 0;
2038 if (!ED->getTypeForDecl()->isIncompleteType()) {
2039 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2040 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2041 }
2042
Manman Rene0064d82013-08-29 23:19:58 +00002043 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2044
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002045 bool isImportedFromModule =
2046 DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2047
Guy Benyei11169dd2012-12-18 14:30:41 +00002048 // If this is just a forward declaration, construct an appropriately
2049 // marked node and just return it.
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002050 if (isImportedFromModule || !ED->getDefinition()) {
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002051 llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002052 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002053 unsigned Line = getLineNumber(ED->getLocation());
2054 StringRef EDName = ED->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002055 llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
David Blaikief427b002014-05-06 03:42:01 +00002056 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002057 0, Size, Align, llvm::DINode::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002058 ReplaceMap.emplace_back(
2059 std::piecewise_construct, std::make_tuple(Ty),
2060 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00002061 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00002062 }
2063
David Blaikie483a9da2014-05-06 18:35:21 +00002064 return CreateTypeDefinition(Ty);
2065}
2066
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002067llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
David Blaikie483a9da2014-05-06 18:35:21 +00002068 const EnumDecl *ED = Ty->getDecl();
2069 uint64_t Size = 0;
2070 uint64_t Align = 0;
2071 if (!ED->getTypeForDecl()->isIncompleteType()) {
2072 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2073 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
2074 }
2075
2076 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2077
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002078 // Create elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002079 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00002080 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00002081 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00002082 Enumerators.push_back(DBuilder.createEnumerator(
2083 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002084 }
2085
2086 // Return a CompositeType for the enum itself.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002087 llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Guy Benyei11169dd2012-12-18 14:30:41 +00002088
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002089 llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002090 unsigned Line = getLineNumber(ED->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002091 llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002092 llvm::DIType *ClassTy =
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002093 ED->isFixed() ? getOrCreateType(ED->getIntegerType(), DefUnit) : nullptr;
2094 return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2095 Line, Size, Align, EltArray, ClassTy,
2096 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002097}
2098
David Blaikie05491062013-01-21 04:37:12 +00002099static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2100 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002101 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002102 Qualifiers InnerQuals = T.getLocalQualifiers();
2103 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2104 // that is already there.
2105 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2106 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002107 QualType LastT = T;
2108 switch (T->getTypeClass()) {
2109 default:
David Blaikie05491062013-01-21 04:37:12 +00002110 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002111 case Type::TemplateSpecialization: {
2112 const auto *Spec = cast<TemplateSpecializationType>(T);
2113 if (Spec->isTypeAlias())
2114 return C.getQualifiedType(T.getTypePtr(), Quals);
2115 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002116 break;
2117 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002118 case Type::TypeOfExpr:
2119 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2120 break;
2121 case Type::TypeOf:
2122 T = cast<TypeOfType>(T)->getUnderlyingType();
2123 break;
2124 case Type::Decltype:
2125 T = cast<DecltypeType>(T)->getUnderlyingType();
2126 break;
2127 case Type::UnaryTransform:
2128 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2129 break;
2130 case Type::Attributed:
2131 T = cast<AttributedType>(T)->getEquivalentType();
2132 break;
2133 case Type::Elaborated:
2134 T = cast<ElaboratedType>(T)->getNamedType();
2135 break;
2136 case Type::Paren:
2137 T = cast<ParenType>(T)->getInnerType();
2138 break;
David Blaikie05491062013-01-21 04:37:12 +00002139 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002140 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002141 break;
2142 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002143 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002144 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002145 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002146 break;
2147 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002148
Guy Benyei11169dd2012-12-18 14:30:41 +00002149 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002150 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002151 } while (true);
2152}
2153
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002154llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002155
2156 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002157 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002158
David Blaikief427b002014-05-06 03:42:01 +00002159 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002160 if (it != TypeCache.end()) {
2161 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002162 if (llvm::Metadata *V = it->second)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002163 return cast<llvm::DIType>(V);
Guy Benyei11169dd2012-12-18 14:30:41 +00002164 }
2165
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002166 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002167}
2168
David Blaikie0e716b42014-03-03 23:48:23 +00002169void CGDebugInfo::completeTemplateDefinition(
2170 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002171 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2172 return;
2173
David Blaikie0e716b42014-03-03 23:48:23 +00002174 completeClassData(&SD);
2175 // In case this type has no member function definitions being emitted, ensure
2176 // it is retained
2177 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2178}
2179
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002180llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002181 if (Ty.isNull())
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002182 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002183
2184 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002185 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002186
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002187 if (auto *T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002188 return T;
2189
Adrian Prantlca844182015-09-11 17:23:03 +00002190 llvm::DIType *Res = CreateTypeNode(Ty, Unit);
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002191 void* TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002192
2193 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002194 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002195
Guy Benyei11169dd2012-12-18 14:30:41 +00002196 return Res;
2197}
2198
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002199llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
Adrian Prantl335f5c72015-10-02 17:36:14 +00002200 // A forward declaration inside a module header does not belong to the module.
2201 if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2202 return nullptr;
Adrian Prantl85d938a2015-09-21 17:48:37 +00002203 if (DebugTypeExtRefs && D->isFromASTFile()) {
2204 // Record a reference to an imported clang module or precompiled header.
2205 auto *Reader = CGM.getContext().getExternalSource();
2206 auto Idx = D->getOwningModuleID();
2207 auto Info = Reader->getSourceDescriptor(Idx);
2208 if (Info)
2209 return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2210 } else if (ClangModuleMap) {
Adrian Prantl9402cef2015-09-20 16:51:35 +00002211 // We are building a clang module or a precompiled header.
2212 //
2213 // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2214 // and it wouldn't be necessary to specify the parent scope
2215 // because the type is already unique by definition (it would look
2216 // like the output of -fno-standalone-debug). On the other hand,
2217 // the parent scope helps a consumer to quickly locate the object
2218 // file where the type's definition is located, so it might be
2219 // best to make this behavior a command line or debugger tuning
2220 // option.
2221 FullSourceLoc Loc(D->getLocation(), CGM.getContext().getSourceManager());
2222 if (Module *M = ClangModuleMap->inferModuleFromLocation(Loc)) {
2223 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
2224 return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
2225 }
2226 }
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002227
Adrian Prantl9402cef2015-09-20 16:51:35 +00002228 return nullptr;
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002229}
2230
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002231llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002232 // Handle qualifiers, which recursively handles what they refer to.
2233 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002234 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002235
Guy Benyei11169dd2012-12-18 14:30:41 +00002236 // Work out details of type.
2237 switch (Ty->getTypeClass()) {
2238#define TYPE(Class, Base)
2239#define ABSTRACT_TYPE(Class, Base)
2240#define NON_CANONICAL_TYPE(Class, Base)
2241#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2242#include "clang/AST/TypeNodes.def"
2243 llvm_unreachable("Dependent types cannot show up in debug information");
2244
2245 case Type::ExtVector:
2246 case Type::Vector:
2247 return CreateType(cast<VectorType>(Ty), Unit);
2248 case Type::ObjCObjectPointer:
2249 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2250 case Type::ObjCObject:
2251 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2252 case Type::ObjCInterface:
2253 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2254 case Type::Builtin:
2255 return CreateType(cast<BuiltinType>(Ty));
2256 case Type::Complex:
2257 return CreateType(cast<ComplexType>(Ty));
2258 case Type::Pointer:
2259 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002260 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002261 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002262 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002263 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002264 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002265 case Type::BlockPointer:
2266 return CreateType(cast<BlockPointerType>(Ty), Unit);
2267 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002268 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002269 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002270 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002271 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002272 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002273 case Type::FunctionProto:
2274 case Type::FunctionNoProto:
2275 return CreateType(cast<FunctionType>(Ty), Unit);
2276 case Type::ConstantArray:
2277 case Type::VariableArray:
2278 case Type::IncompleteArray:
2279 return CreateType(cast<ArrayType>(Ty), Unit);
2280
2281 case Type::LValueReference:
2282 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2283 case Type::RValueReference:
2284 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2285
2286 case Type::MemberPointer:
2287 return CreateType(cast<MemberPointerType>(Ty), Unit);
2288
2289 case Type::Atomic:
2290 return CreateType(cast<AtomicType>(Ty), Unit);
2291
Xiuli Pan9c14e282016-01-09 12:53:17 +00002292 case Type::Pipe:
2293 return CreateType(cast<PipeType>(Ty), Unit);
2294
Guy Benyei11169dd2012-12-18 14:30:41 +00002295 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002296 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2297
David Blaikie42edade2014-11-11 20:44:45 +00002298 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002299 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002300 case Type::Elaborated:
2301 case Type::Paren:
2302 case Type::SubstTemplateTypeParm:
2303 case Type::TypeOfExpr:
2304 case Type::TypeOf:
2305 case Type::Decltype:
2306 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002307 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002308 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002309 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002310
David Blaikie42edade2014-11-11 20:44:45 +00002311 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002312}
2313
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002314llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2315 llvm::DIFile *Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002316 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002317
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +00002318 auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002319
2320 // We may have cached a forward decl when we could have created
2321 // a non-forward decl. Go ahead and create a non-forward decl
2322 // now.
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002323 if (T && !T->isForwardDecl())
Eric Christophere7b87e52014-10-26 23:40:33 +00002324 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002325
2326 // Otherwise create the type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002327 llvm::DICompositeType *Res = CreateLimitedType(Ty);
David Blaikie8d5e1282013-08-20 21:03:29 +00002328
2329 // Propagate members from the declaration to the definition
2330 // CreateType(const RecordType*) will overwrite this with the members in the
2331 // correct order if the full type is needed.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002332 DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002333
Guy Benyei11169dd2012-12-18 14:30:41 +00002334 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002335 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002336 return Res;
2337}
2338
2339// TODO: Currently used for context chains when limiting debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002340llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002341 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002342
Guy Benyei11169dd2012-12-18 14:30:41 +00002343 // Get overall information about the record type for the debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002344 llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002345 unsigned Line = getLineNumber(RD->getLocation());
2346 StringRef RDName = getClassName(RD);
2347
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002348 llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002349
David Blaikied2785892013-08-18 17:36:19 +00002350 // If we ended up creating the type during the context chain construction,
2351 // just return that.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002352 auto *T = cast_or_null<llvm::DICompositeType>(
Duncan P. N. Exon Smithc7551282015-04-06 23:21:33 +00002353 getTypeOrNull(CGM.getContext().getRecordType(RD)));
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00002354 if (T && (!T->isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002355 return T;
David Blaikied2785892013-08-18 17:36:19 +00002356
Adrian Prantl381e7552014-02-04 21:29:50 +00002357 // If this is just a forward or incomplete declaration, construct an
2358 // appropriately marked node and just return it.
2359 const RecordDecl *D = RD->getDefinition();
2360 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002361 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002362
2363 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2364 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002365
Manman Rene0064d82013-08-29 23:19:58 +00002366 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2367
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002368 llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002369 getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align, 0,
2370 FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002371
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002372 RegionMap[Ty->getDecl()].reset(RealDecl);
2373 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002374
David Blaikieadfbf992013-08-18 16:55:33 +00002375 if (const ClassTemplateSpecializationDecl *TSpecial =
2376 dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002377 DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002378 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002379 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002380}
2381
David Blaikieadfbf992013-08-18 16:55:33 +00002382void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002383 llvm::DICompositeType *RealDecl) {
David Blaikieadfbf992013-08-18 16:55:33 +00002384 // A class's primary base or the class itself contains the vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002385 llvm::DICompositeType *ContainingType = nullptr;
David Blaikieadfbf992013-08-18 16:55:33 +00002386 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2387 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002388 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002389 while (1) {
2390 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2391 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2392 if (PBT && !BRL.isPrimaryBaseVirtual())
2393 PBase = PBT;
2394 else
2395 break;
2396 }
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002397 ContainingType = cast<llvm::DICompositeType>(
David Blaikieadfbf992013-08-18 16:55:33 +00002398 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2399 getOrCreateFile(RD->getLocation())));
2400 } else if (RD->isDynamicClass())
2401 ContainingType = RealDecl;
2402
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002403 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002404}
2405
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002406llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002407 StringRef Name, uint64_t *Offset) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002408 llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002409 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2410 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002411 llvm::DIType *Ty = DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002412 FieldAlign, *Offset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002413 *Offset += FieldSize;
2414 return Ty;
2415}
2416
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002417void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002418 StringRef &Name,
2419 StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002420 llvm::DIScope *&FDContext,
2421 llvm::DINodeArray &TParamsArray,
Duncan P. N. Exon Smith8e47da42015-04-21 20:07:29 +00002422 unsigned &Flags) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002423 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
2424 Name = getFunctionName(FD);
2425 // Use mangled name as linkage name for C/C++ functions.
2426 if (FD->hasPrototype()) {
2427 LinkageName = CGM.getMangledName(GD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002428 Flags |= llvm::DINode::FlagPrototyped;
Frederic Riss9db79f12014-11-18 03:40:46 +00002429 }
2430 // No need to replicate the linkage name if it isn't different from the
2431 // subprogram name, no need to have it at all unless coverage is enabled or
2432 // debug is set to more than just line tables.
2433 if (LinkageName == Name ||
2434 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2435 !CGM.getCodeGenOpts().EmitGcovNotes &&
2436 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
2437 LinkageName = StringRef();
2438
2439 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
2440 if (const NamespaceDecl *NSDecl =
2441 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2442 FDContext = getOrCreateNameSpace(NSDecl);
2443 else if (const RecordDecl *RDecl =
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002444 dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
2445 llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
2446 FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
2447 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002448 // Collect template parameters.
2449 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2450 }
2451}
2452
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002453void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +00002454 unsigned &LineNo, QualType &T,
2455 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002456 llvm::DIScope *&VDContext) {
Frederic Riss9db79f12014-11-18 03:40:46 +00002457 Unit = getOrCreateFile(VD->getLocation());
2458 LineNo = getLineNumber(VD->getLocation());
2459
2460 setLocation(VD->getLocation());
2461
2462 T = VD->getType();
2463 if (T->isIncompleteArrayType()) {
2464 // CodeGen turns int[] into int[1] so we'll do the same here.
2465 llvm::APInt ConstVal(32, 1);
2466 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2467
2468 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2469 ArrayType::Normal, 0);
2470 }
2471
2472 Name = VD->getName();
2473 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2474 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2475 LinkageName = CGM.getMangledName(VD);
2476 if (LinkageName == Name)
2477 LinkageName = StringRef();
2478
2479 // Since we emit declarations (DW_AT_members) for static members, place the
2480 // definition of those static members in the namespace they were declared in
2481 // in the source code (the lexical decl context).
2482 // FIXME: Generalize this for even non-member global variables where the
2483 // declaration and definition may have different lexical decl contexts, once
2484 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002485 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2486 : VD->getDeclContext();
2487 // When a record type contains an in-line initialization of a static data
2488 // member, and the record type is marked as __declspec(dllexport), an implicit
2489 // definition of the member will be created in the record context. DWARF
2490 // doesn't seem to have a nice way to describe this in a form that consumers
2491 // are likely to understand, so fake the "normal" situation of a definition
2492 // outside the class by putting it in the global scope.
2493 if (DC->isRecord())
2494 DC = CGM.getContext().getTranslationUnitDecl();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00002495
2496 llvm::DIScope *Mod = getParentModuleOrNull(VD);
2497 VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
Frederic Riss9db79f12014-11-18 03:40:46 +00002498}
2499
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002500llvm::DISubprogram *
Frederic Rissd253ed62014-11-18 03:40:51 +00002501CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002502 llvm::DINodeArray TParamsArray;
Frederic Rissd253ed62014-11-18 03:40:51 +00002503 StringRef Name, LinkageName;
2504 unsigned Flags = 0;
2505 SourceLocation Loc = FD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002506 llvm::DIFile *Unit = getOrCreateFile(Loc);
2507 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002508 unsigned Line = getLineNumber(Loc);
2509
2510 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2511 TParamsArray, Flags);
2512 // Build function type.
2513 SmallVector<QualType, 16> ArgTypes;
2514 for (const ParmVarDecl *Parm: FD->parameters())
2515 ArgTypes.push_back(Parm->getType());
2516 QualType FnType =
2517 CGM.getContext().getFunctionType(FD->getReturnType(), ArgTypes,
2518 FunctionProtoType::ExtProtoInfo());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002519 llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002520 DContext, Name, LinkageName, Unit, Line,
2521 getOrCreateFunctionType(FD, FnType, Unit), !FD->isExternallyVisible(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002522 /* isDefinition = */ false, 0, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002523 TParamsArray.get(), getFunctionDeclaration(FD));
Frederic Rissd253ed62014-11-18 03:40:51 +00002524 const FunctionDecl *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002525 FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
2526 std::make_tuple(CanonDecl),
2527 std::make_tuple(SP));
Frederic Rissd253ed62014-11-18 03:40:51 +00002528 return SP;
2529}
2530
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002531llvm::DIGlobalVariable *
Frederic Rissd253ed62014-11-18 03:40:51 +00002532CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2533 QualType T;
2534 StringRef Name, LinkageName;
2535 SourceLocation Loc = VD->getLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002536 llvm::DIFile *Unit = getOrCreateFile(Loc);
2537 llvm::DIScope *DContext = Unit;
Frederic Rissd253ed62014-11-18 03:40:51 +00002538 unsigned Line = getLineNumber(Loc);
2539
2540 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00002541 auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
2542 DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
2543 !VD->isExternallyVisible(), nullptr, nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002544 FwdDeclReplaceMap.emplace_back(
2545 std::piecewise_construct,
2546 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2547 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002548 return GV;
2549}
2550
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002551llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002552 // We only need a declaration (not a definition) of the type - so use whatever
2553 // we would otherwise do to get a type for a pointee. (forward declarations in
2554 // limited debug info, full definitions (if the type definition is available)
2555 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002556 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2557 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002558 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002559 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002560
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002561 if (I != DeclCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002562 return dyn_cast_or_null<llvm::DINode>(I->second);
Frederic Rissd253ed62014-11-18 03:40:51 +00002563
2564 // No definition for now. Emit a forward definition that might be
2565 // merged with a potential upcoming definition.
2566 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
2567 return getFunctionForwardDeclaration(FD);
2568 else if (const auto *VD = dyn_cast<VarDecl>(D))
2569 return getGlobalVariableForwardDeclaration(VD);
2570
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002571 return nullptr;
David Blaikiebd483762013-05-20 04:58:53 +00002572}
2573
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002574llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Diego Novillo913690c2014-06-24 17:02:17 +00002575 if (!D || DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002576 return nullptr;
David Blaikie18cfbc52013-06-22 00:09:36 +00002577
Guy Benyei11169dd2012-12-18 14:30:41 +00002578 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002579 if (!FD)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002580 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002581
2582 // Setup context.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00002583 auto *S = getDeclContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00002584
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002585 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002586 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002587 if (const CXXMethodDecl *MD =
2588 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00002589 return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002590 cast<llvm::DICompositeType>(S));
David Blaikiefd07c602013-08-09 17:20:05 +00002591 }
2592 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002593 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002594 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002595 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002596 return SP;
2597 }
2598
Aaron Ballman86c93902014-03-06 23:45:36 +00002599 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002600 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002601 if (MI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002602 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002603 if (SP && !SP->isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002604 return SP;
2605 }
2606 }
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002607 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002608}
2609
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002610// getOrCreateFunctionType - Construct type. If it is a c++ method, include
Guy Benyei11169dd2012-12-18 14:30:41 +00002611// implicit parameter "this".
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002612llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00002613 QualType FnType,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002614 llvm::DIFile *F) {
Diego Novillo913690c2014-06-24 17:02:17 +00002615 if (!D || DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002616 // Create fake but valid subroutine type. Otherwise -verify would fail, and
2617 // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
Eric Christopher28a6db52015-10-15 06:56:08 +00002618 return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002619
2620 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2621 return getOrCreateMethodType(Method, F);
2622 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2623 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002624 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002625
2626 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002627 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002628
2629 // Replace the instancetype keyword with the actual type.
2630 if (ResultTy == CGM.getContext().getObjCInstanceType())
2631 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002632 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002633
Adrian Prantl7bec9032013-05-10 21:08:31 +00002634 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002635 // "self" pointer is always first argument.
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002636 QualType SelfDeclTy;
2637 if (auto *SelfDecl = OMethod->getSelfDecl())
2638 SelfDeclTy = SelfDecl->getType();
2639 else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
2640 if (FPT->getNumParams() > 1)
2641 SelfDeclTy = FPT->getParamType(0);
2642 if (!SelfDeclTy.isNull())
2643 Elts.push_back(CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002644 // "_cmd" pointer is always second argument.
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002645 Elts.push_back(DBuilder.createArtificialType(
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002646 getOrCreateType(CGM.getContext().getObjCSelType(), F)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002647 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002648 for (const auto *PI : OMethod->params())
2649 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00002650 // Variadic methods need a special marker at the end of the type list.
2651 if (OMethod->isVariadic())
2652 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00002653
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002654 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Eric Christopher28a6db52015-10-15 06:56:08 +00002655 return DBuilder.createSubroutineType(EltTypeArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00002656 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002657
Adrian Prantl800faef2014-02-25 23:42:18 +00002658 // Handle variadic function types; they need an additional
2659 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002660 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2661 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002662 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00002663 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2664 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2665 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2666 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2667 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002668 llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Eric Christopher28a6db52015-10-15 06:56:08 +00002669 return DBuilder.createSubroutineType(EltTypeArray);
Adrian Prantld45ba252014-02-25 19:38:11 +00002670 }
2671
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002672 return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002673}
2674
Eric Christophere7b87e52014-10-26 23:40:33 +00002675void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
2676 SourceLocation ScopeLoc, QualType FnType,
2677 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002678
2679 StringRef Name;
2680 StringRef LinkageName;
2681
2682 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2683
2684 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002685 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002686
Guy Benyei11169dd2012-12-18 14:30:41 +00002687 unsigned Flags = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002688 llvm::DIFile *Unit = getOrCreateFile(Loc);
2689 llvm::DIScope *FDContext = Unit;
2690 llvm::DINodeArray TParamsArray;
Guy Benyei11169dd2012-12-18 14:30:41 +00002691 if (!HasDecl) {
2692 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002693 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002694 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00002695 // If there is a subprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002696 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002697 if (FI != SPCache.end()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002698 auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
Duncan P. N. Exon Smith87afdeb2015-04-14 03:24:14 +00002699 if (SP && SP->isDefinition()) {
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002700 LexicalBlockStack.emplace_back(SP);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002701 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002702 return;
2703 }
2704 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002705 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2706 TParamsArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002707 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2708 Name = getObjCMethodName(OMD);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002709 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002710 } else {
2711 // Use llvm function name.
2712 Name = Fn->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002713 Flags |= llvm::DINode::FlagPrototyped;
Guy Benyei11169dd2012-12-18 14:30:41 +00002714 }
2715 if (!Name.empty() && Name[0] == '\01')
2716 Name = Name.substr(1);
2717
Adrian Prantl42d71b92014-04-10 23:21:53 +00002718 if (!HasDecl || D->isImplicit()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002719 Flags |= llvm::DINode::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002720 // Artificial functions without a location should not silently reuse CurLoc.
2721 if (Loc.isInvalid())
2722 CurLoc = SourceLocation();
2723 }
2724 unsigned LineNo = getLineNumber(Loc);
2725 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002726
Eric Christopher8018e412014-03-27 18:50:35 +00002727 // FIXME: The function declaration we're constructing here is mostly reusing
2728 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2729 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2730 // all subprograms instead of the actual context since subprogram definitions
2731 // are emitted as CU level entities by the backend.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002732 llvm::DISubprogram *SP = DBuilder.createFunction(
Eric Christophere7b87e52014-10-26 23:40:33 +00002733 FDContext, Name, LinkageName, Unit, LineNo,
2734 getOrCreateFunctionType(D, FnType, Unit), Fn->hasInternalLinkage(),
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002735 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize,
Duncan P. N. Exon Smithebad0aa2015-04-07 16:50:49 +00002736 TParamsArray.get(), getFunctionDeclaration(D));
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002737 Fn->setSubprogram(SP);
Frederic Rissb1ab28c2014-11-05 19:19:04 +00002738 // We might get here with a VarDecl in the case we're generating
2739 // code for the initialization of globals. Do not record these decls
2740 // as they will overwrite the actual VarDecl Decl in the cache.
2741 if (HasDecl && isa<FunctionDecl>(D))
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002742 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(SP));
Guy Benyei11169dd2012-12-18 14:30:41 +00002743
Adrian Prantlbebb8932014-03-21 21:01:58 +00002744 // Push the function onto the lexical block stack.
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002745 LexicalBlockStack.emplace_back(SP);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002746
Guy Benyei11169dd2012-12-18 14:30:41 +00002747 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002748 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002749}
2750
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002751void CGDebugInfo::EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
2752 QualType FnType) {
2753 StringRef Name;
2754 StringRef LinkageName;
2755
2756 const Decl *D = GD.getDecl();
2757 if (!D)
2758 return;
2759
2760 unsigned Flags = 0;
2761 llvm::DIFile *Unit = getOrCreateFile(Loc);
Adrian Prantlf0cd6772015-10-04 23:23:04 +00002762 llvm::DIScope *FDContext = getDeclContextDescriptor(D);
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002763 llvm::DINodeArray TParamsArray;
2764 if (isa<FunctionDecl>(D)) {
2765 // If there is a DISubprogram for this function available then use it.
2766 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2767 TParamsArray, Flags);
2768 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2769 Name = getObjCMethodName(OMD);
2770 Flags |= llvm::DINode::FlagPrototyped;
2771 } else {
2772 llvm_unreachable("not a function or ObjC method");
2773 }
2774 if (!Name.empty() && Name[0] == '\01')
2775 Name = Name.substr(1);
2776
2777 if (D->isImplicit()) {
2778 Flags |= llvm::DINode::FlagArtificial;
2779 // Artificial functions without a location should not silently reuse CurLoc.
2780 if (Loc.isInvalid())
2781 CurLoc = SourceLocation();
2782 }
2783 unsigned LineNo = getLineNumber(Loc);
2784 unsigned ScopeLine = 0;
2785
2786 DBuilder.createFunction(FDContext, Name, LinkageName, Unit, LineNo,
2787 getOrCreateFunctionType(D, FnType, Unit),
2788 false /*internalLinkage*/, true /*definition*/,
Peter Collingbourne0900fe02015-11-05 22:04:14 +00002789 ScopeLine, Flags, CGM.getLangOpts().Optimize,
2790 TParamsArray.get(), getFunctionDeclaration(D));
Adrian Prantl748a6cd2015-09-08 20:41:52 +00002791}
2792
David Blaikie835afb22015-01-21 23:08:17 +00002793void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002794 // Update our current location
2795 setLocation(Loc);
2796
Eric Christophere7b87e52014-10-26 23:40:33 +00002797 if (CurLoc.isInvalid() || CurLoc.isMacroID())
2798 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002799
Adrian Prantle83b1302014-01-07 22:05:52 +00002800 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00002801 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00002802 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002803}
2804
Guy Benyei11169dd2012-12-18 14:30:41 +00002805void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002806 llvm::MDNode *Back = nullptr;
2807 if (!LexicalBlockStack.empty())
2808 Back = LexicalBlockStack.back().get();
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002809 LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002810 cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00002811 getColumnNumber(CurLoc)));
Guy Benyei11169dd2012-12-18 14:30:41 +00002812}
2813
Eric Christopher0fdcb312013-05-16 00:52:20 +00002814void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2815 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002816 // Set our current location.
2817 setLocation(Loc);
2818
Guy Benyei11169dd2012-12-18 14:30:41 +00002819 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00002820 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
2821 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00002822
2823 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2824 return;
2825
2826 // Create a new lexical block and push it on the stack.
2827 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002828}
2829
Eric Christopher0fdcb312013-05-16 00:52:20 +00002830void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2831 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002832 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2833
2834 // Provide an entry in the line table for the end of the block.
2835 EmitLocation(Builder, Loc);
2836
David Blaikie60a877b2014-10-22 19:34:33 +00002837 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2838 return;
2839
Guy Benyei11169dd2012-12-18 14:30:41 +00002840 LexicalBlockStack.pop_back();
2841}
2842
Guy Benyei11169dd2012-12-18 14:30:41 +00002843void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2844 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2845 unsigned RCount = FnBeginRegionCount.back();
2846 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2847
2848 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00002849 while (LexicalBlockStack.size() != RCount) {
2850 // Provide an entry in the line table for the end of the block.
2851 EmitLocation(Builder, CurLoc);
2852 LexicalBlockStack.pop_back();
2853 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002854 FnBeginRegionCount.pop_back();
2855}
2856
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002857llvm::DIType *CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002858 uint64_t *XOffset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002859
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002860 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002861 QualType FType;
2862 uint64_t FieldSize, FieldOffset;
2863 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002864
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002865 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002866 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002867
2868 FieldOffset = 0;
2869 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2870 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2871 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2872 FType = CGM.getContext().IntTy;
2873 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2874 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2875
2876 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2877 if (HasCopyAndDispose) {
2878 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002879 EltTys.push_back(
2880 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
2881 EltTys.push_back(
2882 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00002883 }
2884 bool HasByrefExtendedLayout;
2885 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00002886 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
2887 HasByrefExtendedLayout) &&
2888 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00002889 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002890 EltTys.push_back(
2891 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002892 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002893
Guy Benyei11169dd2012-12-18 14:30:41 +00002894 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2895 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00002896 CGM.getTarget().getPointerAlign(0))) {
2897 CharUnits FieldOffsetInBytes =
2898 CGM.getContext().toCharUnitsFromBits(FieldOffset);
Rui Ueyama83aa9792016-01-14 21:00:27 +00002899 CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
Eric Christophere7b87e52014-10-26 23:40:33 +00002900 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002901
Guy Benyei11169dd2012-12-18 14:30:41 +00002902 if (NumPaddingBytes.isPositive()) {
2903 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2904 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2905 pad, ArrayType::Normal, 0);
2906 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2907 }
2908 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002909
Guy Benyei11169dd2012-12-18 14:30:41 +00002910 FType = Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002911 llvm::DIType *FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002912 FieldSize = CGM.getContext().getTypeSize(FType);
2913 FieldAlign = CGM.getContext().toBits(Align);
2914
Eric Christopherb2a008c2013-05-16 00:45:12 +00002915 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00002916 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
2917 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002918 EltTys.push_back(FieldTy);
2919 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002920
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002921 llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002922
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002923 unsigned Flags = llvm::DINode::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002924
Guy Benyei11169dd2012-12-18 14:30:41 +00002925 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00002926 nullptr, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002927}
2928
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00002929void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::Value *Storage,
2930 llvm::Optional<unsigned> ArgNo,
Eric Christophere7b87e52014-10-26 23:40:33 +00002931 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002932 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002933 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2934
David Blaikie7fceebf2013-08-19 03:37:48 +00002935 bool Unwritten =
2936 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2937 cast<Decl>(VD->getDeclContext())->isImplicit());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002938 llvm::DIFile *Unit = nullptr;
David Blaikie7fceebf2013-08-19 03:37:48 +00002939 if (!Unwritten)
2940 Unit = getOrCreateFile(VD->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002941 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00002942 uint64_t XOffset = 0;
2943 if (VD->hasAttr<BlocksAttr>())
2944 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002945 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002946 Ty = getOrCreateType(VD->getType(), Unit);
2947
2948 // If there is no debug info for this type then do not emit debug info
2949 // for this variable.
2950 if (!Ty)
2951 return;
2952
Guy Benyei11169dd2012-12-18 14:30:41 +00002953 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002954 unsigned Line = 0;
2955 unsigned Column = 0;
2956 if (!Unwritten) {
2957 Line = getLineNumber(VD->getLocation());
2958 Column = getColumnNumber(VD->getLocation());
2959 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002960 SmallVector<int64_t, 9> Expr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002961 unsigned Flags = 0;
2962 if (VD->isImplicit())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002963 Flags |= llvm::DINode::FlagArtificial;
Guy Benyei11169dd2012-12-18 14:30:41 +00002964 // If this is the first argument and it is implicit then
2965 // give it an object pointer flag.
2966 // FIXME: There has to be a better way to do this, but for static
2967 // functions there won't be an implicit param at arg1 and
2968 // otherwise it is 'self' or 'this'.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00002969 if (isa<ImplicitParamDecl>(VD) && ArgNo && *ArgNo == 1)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002970 Flags |= llvm::DINode::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002971 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002972 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2973 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002974 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00002975
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00002976 auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00002977
2978 StringRef Name = VD->getName();
2979 if (!Name.empty()) {
2980 if (VD->hasAttr<BlocksAttr>()) {
2981 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002982 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002983 // offset of __forwarding field
2984 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00002985 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002986 Expr.push_back(offset.getQuantity());
2987 Expr.push_back(llvm::dwarf::DW_OP_deref);
2988 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002989 // offset of x field
2990 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002991 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002992
2993 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00002994 auto *D = ArgNo
2995 ? DBuilder.createParameterVariable(Scope, VD->getName(),
2996 *ArgNo, Unit, Line, Ty)
2997 : DBuilder.createAutoVariable(Scope, VD->getName(), Unit,
2998 Line, Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002999
Guy Benyei11169dd2012-12-18 14:30:41 +00003000 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003001 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3002 llvm::DebugLoc::get(Line, Column, Scope),
3003 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003004 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00003005 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00003006 Expr.push_back(llvm::dwarf::DW_OP_deref);
Adrian Prantl0d820892015-04-29 15:05:50 +00003007 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
3008 // If VD is an anonymous union then Storage represents value for
3009 // all union fields.
3010 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
3011 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Adrian Prantl00820ab2015-04-29 16:52:31 +00003012 // GDB has trouble finding local variables in anonymous unions, so we emit
3013 // artifical local variables for each of the members.
3014 //
3015 // FIXME: Remove this code as soon as GDB supports this.
3016 // The debug info verifier in LLVM operates based on the assumption that a
3017 // variable has the same size as its storage and we had to disable the check
3018 // for artificial variables.
Adrian Prantl0d820892015-04-29 15:05:50 +00003019 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003020 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Adrian Prantl0d820892015-04-29 15:05:50 +00003021 StringRef FieldName = Field->getName();
3022
3023 // Ignore unnamed fields. Do not ignore unnamed records.
3024 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3025 continue;
3026
3027 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003028 auto *D = DBuilder.createAutoVariable(
3029 Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3030 Flags | llvm::DINode::FlagArtificial);
Adrian Prantl0d820892015-04-29 15:05:50 +00003031
3032 // Insert an llvm.dbg.declare into the current block.
3033 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3034 llvm::DebugLoc::get(Line, Column, Scope),
3035 Builder.GetInsertBlock());
3036 }
Adrian Prantl0d820892015-04-29 15:05:50 +00003037 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003038 }
David Blaikiea76a7c92013-01-05 05:58:35 +00003039
3040 // Create the descriptor for the variable.
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003041 auto *D =
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003042 ArgNo
3043 ? DBuilder.createParameterVariable(Scope, Name, *ArgNo, Unit, Line,
3044 Ty, CGM.getLangOpts().Optimize,
3045 Flags)
3046 : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3047 CGM.getLangOpts().Optimize, Flags);
David Blaikiea76a7c92013-01-05 05:58:35 +00003048
3049 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003050 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3051 llvm::DebugLoc::get(Line, Column, Scope),
3052 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003053}
3054
3055void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
3056 llvm::Value *Storage,
3057 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003058 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003059 EmitDeclare(VD, Storage, llvm::None, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003060}
3061
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003062llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3063 llvm::DIType *Ty) {
3064 llvm::DIType *CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00003065 if (CachedTy)
3066 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00003067 return DBuilder.createObjectPointerType(Ty);
3068}
3069
Eric Christophere7b87e52014-10-26 23:40:33 +00003070void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
3071 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00003072 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Eric Christopher75e17682013-05-16 00:45:23 +00003073 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003074 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00003075
Craig Topper8a13c412014-05-21 05:09:00 +00003076 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00003077 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00003078
Guy Benyei11169dd2012-12-18 14:30:41 +00003079 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00003080
Guy Benyei11169dd2012-12-18 14:30:41 +00003081 uint64_t XOffset = 0;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003082 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3083 llvm::DIType *Ty;
Guy Benyei11169dd2012-12-18 14:30:41 +00003084 if (isByRef)
3085 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003086 else
Guy Benyei11169dd2012-12-18 14:30:41 +00003087 Ty = getOrCreateType(VD->getType(), Unit);
3088
3089 // Self is passed along as an implicit non-arg variable in a
3090 // block. Mark it as the object pointer.
3091 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00003092 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00003093
3094 // Get location information.
3095 unsigned Line = getLineNumber(VD->getLocation());
3096 unsigned Column = getColumnNumber(VD->getLocation());
3097
3098 const llvm::DataLayout &target = CGM.getDataLayout();
3099
3100 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00003101 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00003102 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3103
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003104 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00003105 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003106 addr.push_back(llvm::dwarf::DW_OP_deref);
3107 addr.push_back(llvm::dwarf::DW_OP_plus);
3108 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003109 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003110 addr.push_back(llvm::dwarf::DW_OP_deref);
3111 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003112 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00003113 offset =
3114 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003115 addr.push_back(offset.getQuantity());
3116 addr.push_back(llvm::dwarf::DW_OP_deref);
3117 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00003118 // offset of x field
3119 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00003120 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00003121 }
3122
3123 // Create the descriptor for the variable.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003124 auto *D = DBuilder.createAutoVariable(
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003125 cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +00003126 Line, Ty);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003127
Guy Benyei11169dd2012-12-18 14:30:41 +00003128 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003129 auto DL = llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back());
3130 if (InsertPoint)
3131 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3132 InsertPoint);
3133 else
3134 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr), DL,
3135 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003136}
3137
Guy Benyei11169dd2012-12-18 14:30:41 +00003138void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3139 unsigned ArgNo,
3140 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003141 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003142 EmitDeclare(VD, AI, ArgNo, Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +00003143}
3144
3145namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003146struct BlockLayoutChunk {
3147 uint64_t OffsetInBits;
3148 const BlockDecl::Capture *Capture;
3149};
3150bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3151 return l.OffsetInBits < r.OffsetInBits;
3152}
Guy Benyei11169dd2012-12-18 14:30:41 +00003153}
3154
3155void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003156 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003157 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003158 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003159 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003160 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003161 ASTContext &C = CGM.getContext();
3162 const BlockDecl *blockDecl = block.getBlockDecl();
3163
3164 // Collect some general information about the block's location.
3165 SourceLocation loc = blockDecl->getCaretLocation();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003166 llvm::DIFile *tunit = getOrCreateFile(loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003167 unsigned line = getLineNumber(loc);
3168 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003169
Guy Benyei11169dd2012-12-18 14:30:41 +00003170 // Build the debug-info type for the block literal.
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003171 getDeclContextDescriptor(blockDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003172
3173 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003174 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003175
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003176 SmallVector<llvm::Metadata *, 16> fields;
Guy Benyei11169dd2012-12-18 14:30:41 +00003177 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
3178 blockLayout->getElementOffsetInBits(0),
3179 tunit, tunit));
3180 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
3181 blockLayout->getElementOffsetInBits(1),
3182 tunit, tunit));
3183 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
3184 blockLayout->getElementOffsetInBits(2),
3185 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003186 auto *FnTy = block.getBlockExpr()->getFunctionType();
3187 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3188 fields.push_back(createFieldType("__FuncPtr", FnPtrType, 0, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003189 blockLayout->getElementOffsetInBits(3),
3190 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003191 fields.push_back(createFieldType(
3192 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3193 ? C.getBlockDescriptorExtendedType()
3194 : C.getBlockDescriptorType()),
3195 0, loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003196
3197 // We want to sort the captures by offset, not because DWARF
3198 // requires this, but because we're paranoid about debuggers.
3199 SmallVector<BlockLayoutChunk, 8> chunks;
3200
3201 // 'this' capture.
3202 if (blockDecl->capturesCXXThis()) {
3203 BlockLayoutChunk chunk;
3204 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003205 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003206 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003207 chunks.push_back(chunk);
3208 }
3209
3210 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003211 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003212 const VarDecl *variable = capture.getVariable();
3213 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3214
3215 // Ignore constant captures.
3216 if (captureInfo.isConstant())
3217 continue;
3218
3219 BlockLayoutChunk chunk;
3220 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003221 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003222 chunk.Capture = &capture;
3223 chunks.push_back(chunk);
3224 }
3225
3226 // Sort by offset.
3227 llvm::array_pod_sort(chunks.begin(), chunks.end());
3228
Eric Christophere7b87e52014-10-26 23:40:33 +00003229 for (SmallVectorImpl<BlockLayoutChunk>::iterator i = chunks.begin(),
3230 e = chunks.end();
3231 i != e; ++i) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003232 uint64_t offsetInBits = i->OffsetInBits;
3233 const BlockDecl::Capture *capture = i->Capture;
3234
3235 // If we have a null capture, this must be the C++ 'this' capture.
3236 if (!capture) {
3237 const CXXMethodDecl *method =
Eric Christophere7b87e52014-10-26 23:40:33 +00003238 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00003239 QualType type = method->getThisType(C);
3240
3241 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3242 offsetInBits, tunit, tunit));
3243 continue;
3244 }
3245
3246 const VarDecl *variable = capture->getVariable();
3247 StringRef name = variable->getName();
3248
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003249 llvm::DIType *fieldType;
Guy Benyei11169dd2012-12-18 14:30:41 +00003250 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003251 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003252
3253 // FIXME: this creates a second copy of this type!
3254 uint64_t xoffset;
3255 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003256 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3257 fieldType =
3258 DBuilder.createMemberType(tunit, name, tunit, line, PtrInfo.Width,
3259 PtrInfo.Align, offsetInBits, 0, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003260 } else {
Eric Christophere7b87e52014-10-26 23:40:33 +00003261 fieldType = createFieldType(name, variable->getType(), 0, loc, AS_public,
3262 offsetInBits, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003263 }
3264 fields.push_back(fieldType);
3265 }
3266
3267 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003268 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3269 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003270
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003271 llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
Guy Benyei11169dd2012-12-18 14:30:41 +00003272
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003273 llvm::DIType *type = DBuilder.createStructType(
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003274 tunit, typeName.str(), tunit, line,
3275 CGM.getContext().toBits(block.BlockSize),
3276 CGM.getContext().toBits(block.BlockAlign), 0, nullptr, fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003277 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3278
3279 // Get overall information about the block.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003280 unsigned flags = llvm::DINode::FlagArtificial;
3281 auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +00003282
3283 // Create the descriptor for the parameter.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +00003284 auto *debugVar = DBuilder.createParameterVariable(
3285 scope, Arg->getName(), ArgNo, tunit, line, type,
3286 CGM.getLangOpts().Optimize, flags);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003287
Adrian Prantl616bef42013-03-14 21:52:59 +00003288 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003289 // Insert an llvm.dbg.value into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003290 DBuilder.insertDbgValueIntrinsic(
Eric Christophere7b87e52014-10-26 23:40:33 +00003291 LocalAddr, 0, debugVar, DBuilder.createExpression(),
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003292 llvm::DebugLoc::get(line, column, scope), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003293 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003294
Adrian Prantl616bef42013-03-14 21:52:59 +00003295 // Insert an llvm.dbg.declare into the current block.
Duncan P. N. Exon Smithfe88b482015-04-15 21:18:30 +00003296 DBuilder.insertDeclare(Arg, debugVar, DBuilder.createExpression(),
3297 llvm::DebugLoc::get(line, column, scope),
3298 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00003299}
3300
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003301llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +00003302CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3303 if (!D->isStaticDataMember())
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003304 return nullptr;
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003305
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003306 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003307 if (MI != StaticDataMemberCache.end()) {
3308 assert(MI->second && "Static data member declaration should still exist");
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +00003309 return MI->second;
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003310 }
David Blaikiece763042013-08-20 21:49:21 +00003311
3312 // If the member wasn't found in the cache, lazily construct and add it to the
3313 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003314 auto DC = D->getDeclContext();
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003315 auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
Adrian Prantl21361fb2014-08-29 22:44:27 +00003316 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003317}
3318
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003319llvm::DIGlobalVariable *CGDebugInfo::CollectAnonRecordDecls(
3320 const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
3321 StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
3322 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003323
3324 for (const auto *Field : RD->fields()) {
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003325 llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
Eric Christophercab9fae2014-04-10 05:20:00 +00003326 StringRef FieldName = Field->getName();
3327
3328 // Ignore unnamed fields, but recurse into anonymous records.
3329 if (FieldName.empty()) {
3330 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3331 if (RT)
3332 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3333 Var, DContext);
3334 continue;
3335 }
3336 // Use VarDecl's Tag, Scope and Line number.
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +00003337 GV = DBuilder.createGlobalVariable(DContext, FieldName, LinkageName, Unit,
3338 LineNo, FieldTy,
3339 Var->hasInternalLinkage(), Var, nullptr);
Eric Christophercab9fae2014-04-10 05:20:00 +00003340 }
3341 return GV;
3342}
3343
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003344void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003345 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003346 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003347 // Create global variable debug descriptor.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003348 llvm::DIFile *Unit = nullptr;
3349 llvm::DIScope *DContext = nullptr;
Frederic Riss9db79f12014-11-18 03:40:46 +00003350 unsigned LineNo;
3351 StringRef DeclName, LinkageName;
3352 QualType T;
3353 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003354
3355 // Attempt to store one global variable for the declaration - even if we
3356 // emit a lot of fields.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003357 llvm::DIGlobalVariable *GV = nullptr;
Eric Christophercab9fae2014-04-10 05:20:00 +00003358
3359 // If this is an anonymous union then we'll want to emit a global
3360 // variable for each member of the anonymous union so that it's possible
3361 // to find the name of any field in the union.
3362 if (T->isUnionType() && DeclName.empty()) {
Reid Kleckner43ecd7c2015-11-20 17:41:12 +00003363 const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003364 assert(RD->isAnonymousStructOrUnion() &&
3365 "unnamed non-anonymous struct or union?");
Eric Christophercab9fae2014-04-10 05:20:00 +00003366 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3367 } else {
David Blaikie7550b112014-10-20 17:42:23 +00003368 GV = DBuilder.createGlobalVariable(
Eric Christophercab9fae2014-04-10 05:20:00 +00003369 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3370 Var->hasInternalLinkage(), Var,
3371 getOrCreateStaticDataMemberDeclarationOrNull(D));
3372 }
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003373 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(GV));
Guy Benyei11169dd2012-12-18 14:30:41 +00003374}
3375
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003376void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3377 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003378 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003379 // Create the descriptor for the variable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003380 llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003381 StringRef Name = VD->getName();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003382 llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003383 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3384 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3385 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3386 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3387 }
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003388 // Do not use global variables for enums.
3389 //
3390 // FIXME: why not?
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003391 if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003392 return;
David Blaikiea15565562014-04-04 20:56:17 +00003393 // Do not emit separate definitions for function local const/statics.
3394 if (isa<FunctionDecl>(VD->getDeclContext()))
3395 return;
David Blaikiebb113912014-04-05 07:23:17 +00003396 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003397 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003398 if (VarD->isStaticDataMember()) {
3399 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003400 getDeclContextDescriptor(VarD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003401 // Ensure that the type is retained even though it's otherwise unreferenced.
3402 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003403 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003404 return;
3405 }
3406
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003407 llvm::DIScope *DContext = getDeclContextDescriptor(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003408
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003409 auto &GV = DeclCache[VD];
3410 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003411 return;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003412 GV.reset(DBuilder.createGlobalVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003413 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003414 true, Init, getOrCreateStaticDataMemberDeclarationOrNull(VarD)));
David Blaikiebd483762013-05-20 04:58:53 +00003415}
3416
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003417llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00003418 if (!LexicalBlockStack.empty())
Duncan P. N. Exon Smithfc8d9d92015-04-20 18:32:15 +00003419 return LexicalBlockStack.back();
Adrian Prantl5c8bd882015-09-11 17:23:08 +00003420 llvm::DIScope *Mod = getParentModuleOrNull(D);
3421 return getContextDescriptor(D, Mod ? Mod : TheCU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003422}
3423
David Blaikie9f88fe82013-04-22 06:13:21 +00003424void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003425 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3426 return;
Ekaterina Romanova9218a3b2015-12-10 18:52:50 +00003427 const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
3428 if (!NSDecl->isAnonymousNamespace() ||
3429 CGM.getCodeGenOpts().DebugExplicitImport) {
3430 DBuilder.createImportedModule(
3431 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3432 getOrCreateNameSpace(NSDecl),
3433 getLineNumber(UD.getLocation()));
3434 }
David Blaikie9f88fe82013-04-22 06:13:21 +00003435}
3436
David Blaikiebd483762013-05-20 04:58:53 +00003437void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3438 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3439 return;
3440 assert(UD.shadow_size() &&
3441 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3442 // Emitting one decl is sufficient - debuggers can detect that this is an
3443 // overloaded name & provide lookup for all the overloads.
3444 const UsingShadowDecl &USD = **UD.shadow_begin();
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003445 if (llvm::DINode *Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003446 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003447 DBuilder.createImportedDeclaration(
3448 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3449 getLineNumber(USD.getLocation()));
3450}
3451
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003452void CGDebugInfo::EmitImportDecl(const ImportDecl &ID) {
Adrian Prantl8a634c12015-12-18 19:44:31 +00003453 if (Module *M = ID.getImportedModule()) {
Chad Rosiere5dafd12015-12-18 20:08:40 +00003454 auto Info = ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl8a634c12015-12-18 19:44:31 +00003455 DBuilder.createImportedDeclaration(
3456 getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
3457 getOrCreateModuleRef(Info, DebugTypeExtRefs),
3458 getLineNumber(ID.getLocation()));
3459 }
Adrian Prantlc4bb47e2015-06-30 17:39:51 +00003460}
3461
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003462llvm::DIImportedEntity *
David Blaikief121b932013-05-20 22:50:41 +00003463CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3464 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +00003465 return nullptr;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003466 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003467 if (VH)
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003468 return cast<llvm::DIImportedEntity>(VH);
3469 llvm::DIImportedEntity *R;
David Blaikief121b932013-05-20 22:50:41 +00003470 if (const NamespaceAliasDecl *Underlying =
3471 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3472 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003473 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003474 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3475 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3476 NA.getName());
3477 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003478 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003479 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3480 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3481 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003482 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003483 return R;
3484}
3485
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003486llvm::DINamespace *
Guy Benyei11169dd2012-12-18 14:30:41 +00003487CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003488 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003489 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003490 if (I != NameSpaceCache.end())
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003491 return cast<llvm::DINamespace>(I->second);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003492
Guy Benyei11169dd2012-12-18 14:30:41 +00003493 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003494 llvm::DIFile *FileD = getOrCreateFile(NSDecl->getLocation());
Adrian Prantl6ec370a2015-09-10 18:39:45 +00003495 llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003496 llvm::DINamespace *NS =
Duncan P. N. Exon Smitha7fbcbf2015-04-20 22:09:57 +00003497 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003498 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003499 return NS;
3500}
3501
Adrian Prantla5206ce2015-09-22 23:26:43 +00003502void CGDebugInfo::setDwoId(uint64_t Signature) {
3503 assert(TheCU && "no main compile unit");
3504 TheCU->setDWOId(Signature);
3505}
3506
3507
Guy Benyei11169dd2012-12-18 14:30:41 +00003508void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003509 // Creating types might create further types - invalidating the current
3510 // element and the size(), so don't cache/reference them.
3511 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3512 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003513 llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
Duncan P. N. Exon Smith497d4d462015-04-11 19:05:04 +00003514 ? CreateTypeDefinition(E.Type, E.Unit)
3515 : E.Decl;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003516 DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
David Blaikie87dab872014-05-07 16:56:58 +00003517 }
3518
David Blaikief427b002014-05-06 03:42:01 +00003519 for (auto p : ReplaceMap) {
3520 assert(p.second);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003521 auto *Ty = cast<llvm::DIType>(p.second);
Duncan P. N. Exon Smith4caa7f22015-04-16 01:00:56 +00003522 assert(Ty->isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003523
David Blaikief427b002014-05-06 03:42:01 +00003524 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003525 assert(it != TypeCache.end());
3526 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003527
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +00003528 DBuilder.replaceTemporary(llvm::TempDIType(Ty),
3529 cast<llvm::DIType>(it->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00003530 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003531
Frederic Rissd253ed62014-11-18 03:40:51 +00003532 for (const auto &p : FwdDeclReplaceMap) {
3533 assert(p.second);
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003534 llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003535 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003536
3537 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003538 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003539 // with ourselves, that will destroy the temporary MDNode and
3540 // replace it with a standard one, avoiding leaking memory.
3541 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003542 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003543 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003544 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003545
Duncan P. N. Exon Smithd899f6e2015-04-18 00:07:30 +00003546 DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
Frederic Rissd253ed62014-11-18 03:40:51 +00003547 }
3548
Adrian Prantl73409ce2013-03-11 18:33:46 +00003549 // We keep our own list of retained types, because we need to look
3550 // up the final type in the type cache.
Adrian Prantl3a884fa2015-08-27 22:56:46 +00003551 for (auto &RT : RetainedTypes)
Adrian Prantlad9a195e2015-08-27 21:21:19 +00003552 if (auto MD = TypeCache[RT])
3553 DBuilder.retainType(cast<llvm::DIType>(MD));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003554
Guy Benyei11169dd2012-12-18 14:30:41 +00003555 DBuilder.finalize();
3556}
David Blaikie66088d52014-09-24 17:01:27 +00003557
3558void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
3559 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3560 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003561
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +00003562 if (auto *DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003563 // Don't ignore in case of explicit cast where it is referenced indirectly.
3564 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003565}