blob: 1e30cb69bbb432e53901bacac3dbfddb8564a0d1 [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"
30#include "llvm/ADT/SmallVector.h"
31#include "llvm/ADT/StringExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/Constants.h"
33#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/DerivedTypes.h"
35#include "llvm/IR/Instructions.h"
36#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/Module.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000038#include "llvm/Support/Dwarf.h"
39#include "llvm/Support/FileSystem.h"
Adrian Prantl0630eb72013-12-18 21:48:18 +000040#include "llvm/Support/Path.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000041using namespace clang;
42using namespace clang::CodeGen;
43
44CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher324bbbd2013-07-14 21:12:44 +000045 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
46 DBuilder(CGM.getModule()) {
Guy Benyei11169dd2012-12-18 14:30:41 +000047 CreateCompileUnit();
48}
49
50CGDebugInfo::~CGDebugInfo() {
51 assert(LexicalBlockStack.empty() &&
52 "Region stack mismatch, stack not empty!");
53}
54
David Blaikie66e41972015-01-14 07:38:27 +000055ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
David Blaikie835afb22015-01-21 23:08:17 +000056 SourceLocation TemporaryLocation)
David Blaikie66e41972015-01-14 07:38:27 +000057 : CGF(CGF) {
David Blaikie9b479662015-01-25 01:19:10 +000058 init(TemporaryLocation);
59}
60
Adrian Prantl39428e72015-02-03 18:40:42 +000061ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
Adrian Prantl95b24e92015-02-03 20:00:54 +000062 bool DefaultToEmpty,
Adrian Prantl39428e72015-02-03 18:40:42 +000063 SourceLocation TemporaryLocation)
64 : CGF(CGF) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000065 init(TemporaryLocation, DefaultToEmpty);
Adrian Prantl39428e72015-02-03 18:40:42 +000066}
67
68void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
Adrian Prantl95b24e92015-02-03 20:00:54 +000069 bool DefaultToEmpty) {
David Blaikie66e41972015-01-14 07:38:27 +000070 if (auto *DI = CGF.getDebugInfo()) {
71 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
Adrian Prantl39428e72015-02-03 18:40:42 +000072 if (TemporaryLocation.isInvalid()) {
Adrian Prantl95b24e92015-02-03 20:00:54 +000073 if (DefaultToEmpty)
Adrian Prantl39428e72015-02-03 18:40:42 +000074 CGF.Builder.SetCurrentDebugLocation(llvm::DebugLoc());
75 else {
76 // Construct a location that has a valid scope, but no line info.
77 assert(!DI->LexicalBlockStack.empty());
78 llvm::DIDescriptor Scope(DI->LexicalBlockStack.back());
79 CGF.Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(0, 0, Scope));
80 }
81 } else
David Blaikie835afb22015-01-21 23:08:17 +000082 DI->EmitLocation(CGF.Builder, TemporaryLocation);
David Blaikie66e41972015-01-14 07:38:27 +000083 }
Adrian Prantl2e0637f2013-07-18 00:28:02 +000084}
85
David Blaikie9b479662015-01-25 01:19:10 +000086ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
87 : CGF(CGF) {
88 init(E->getExprLoc());
89}
90
David Blaikie66e41972015-01-14 07:38:27 +000091ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
92 : CGF(CGF) {
93 if (CGF.getDebugInfo()) {
94 OriginalLocation = CGF.Builder.getCurrentDebugLocation();
95 if (!Loc.isUnknown())
Benjamin Kramer03278662015-02-07 13:15:54 +000096 CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
David Blaikie66e41972015-01-14 07:38:27 +000097 }
98}
99
100ApplyDebugLocation::~ApplyDebugLocation() {
101 // Query CGF so the location isn't overwritten when location updates are
102 // temporarily disabled (for C++ default function arguments)
103 if (CGF.getDebugInfo())
Benjamin Kramer03278662015-02-07 13:15:54 +0000104 CGF.Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
David Blaikie66e41972015-01-14 07:38:27 +0000105}
106
107/// ArtificialLocation - An RAII object that temporarily switches to
108/// an artificial debug location that has a valid scope, but no line
Guy Benyei11169dd2012-12-18 14:30:41 +0000109void CGDebugInfo::setLocation(SourceLocation Loc) {
110 // If the new location isn't valid return.
Eric Christophere7b87e52014-10-26 23:40:33 +0000111 if (Loc.isInvalid())
112 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000113
114 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
115
116 // If we've changed files in the middle of a lexical scope go ahead
117 // and create a new lexical scope with file node if it's different
118 // from the one in the scope.
Eric Christophere7b87e52014-10-26 23:40:33 +0000119 if (LexicalBlockStack.empty())
120 return;
Guy Benyei11169dd2012-12-18 14:30:41 +0000121
122 SourceManager &SM = CGM.getContext().getSourceManager();
David Blaikieaabde052014-05-14 00:29:00 +0000123 llvm::DIScope Scope(LexicalBlockStack.back());
Guy Benyei11169dd2012-12-18 14:30:41 +0000124 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000125
David Blaikieaabde052014-05-14 00:29:00 +0000126 if (PCLoc.isInvalid() || Scope.getFilename() == PCLoc.getFilename())
Guy Benyei11169dd2012-12-18 14:30:41 +0000127 return;
128
Guy Benyei11169dd2012-12-18 14:30:41 +0000129 if (Scope.isLexicalBlockFile()) {
David Blaikieaabde052014-05-14 00:29:00 +0000130 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(Scope);
Eric Christophere7b87e52014-10-26 23:40:33 +0000131 llvm::DIDescriptor D = DBuilder.createLexicalBlockFile(
132 LBF.getScope(), getOrCreateFile(CurLoc));
Guy Benyei11169dd2012-12-18 14:30:41 +0000133 llvm::MDNode *N = D;
134 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000135 LexicalBlockStack.emplace_back(N);
David Blaikie0a21d0d2013-01-26 22:16:26 +0000136 } else if (Scope.isLexicalBlock() || Scope.isSubprogram()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000137 llvm::DIDescriptor D =
138 DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
Guy Benyei11169dd2012-12-18 14:30:41 +0000139 llvm::MDNode *N = D;
140 LexicalBlockStack.pop_back();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000141 LexicalBlockStack.emplace_back(N);
Guy Benyei11169dd2012-12-18 14:30:41 +0000142 }
143}
144
145/// getContextDescriptor - Get context info for the decl.
David Blaikiebfa52742013-04-19 06:56:38 +0000146llvm::DIScope CGDebugInfo::getContextDescriptor(const Decl *Context) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000147 if (!Context)
148 return TheCU;
149
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000150 auto I = RegionMap.find(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +0000151 if (I != RegionMap.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000152 llvm::Metadata *V = I->second;
David Blaikiebfa52742013-04-19 06:56:38 +0000153 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
Guy Benyei11169dd2012-12-18 14:30:41 +0000154 }
155
156 // Check namespace.
157 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebfa52742013-04-19 06:56:38 +0000158 return getOrCreateNameSpace(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000159
David Blaikiebfa52742013-04-19 06:56:38 +0000160 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
161 if (!RDecl->isDependentType())
162 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Eric Christophere7b87e52014-10-26 23:40:33 +0000163 getOrCreateMainFile());
Guy Benyei11169dd2012-12-18 14:30:41 +0000164 return TheCU;
165}
166
167/// getFunctionName - Get function name for the given FunctionDecl. If the
Benjamin Kramer60509af2013-09-09 14:48:42 +0000168/// name is constructed on demand (e.g. C++ destructor) then the name
Guy Benyei11169dd2012-12-18 14:30:41 +0000169/// is stored on the side.
170StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000171 assert(FD && "Invalid FunctionDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000172 IdentifierInfo *FII = FD->getIdentifier();
Eric Christophere7b87e52014-10-26 23:40:33 +0000173 FunctionTemplateSpecializationInfo *Info =
174 FD->getTemplateSpecializationInfo();
Guy Benyei11169dd2012-12-18 14:30:41 +0000175 if (!Info && FII)
176 return FII->getName();
177
178 // Otherwise construct human readable name for debug info.
Benjamin Kramer9170e912013-02-22 15:46:01 +0000179 SmallString<128> NS;
180 llvm::raw_svector_ostream OS(NS);
181 FD->printName(OS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000182
183 // Add any template specialization args.
184 if (Info) {
185 const TemplateArgumentList *TArgs = Info->TemplateArguments;
186 const TemplateArgument *Args = TArgs->data();
187 unsigned NumArgs = TArgs->size();
188 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer9170e912013-02-22 15:46:01 +0000189 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
190 Policy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000191 }
192
193 // Copy this name on the side and use its reference.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000194 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000195}
196
197StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
198 SmallString<256> MethodName;
199 llvm::raw_svector_ostream OS(MethodName);
200 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
201 const DeclContext *DC = OMD->getDeclContext();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000202 if (const ObjCImplementationDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000203 dyn_cast<const ObjCImplementationDecl>(DC)) {
204 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000205 } else if (const ObjCInterfaceDecl *OID =
Eric Christophere7b87e52014-10-26 23:40:33 +0000206 dyn_cast<const ObjCInterfaceDecl>(DC)) {
207 OS << OID->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000208 } else if (const ObjCCategoryImplDecl *OCD =
Eric Christophere7b87e52014-10-26 23:40:33 +0000209 dyn_cast<const ObjCCategoryImplDecl>(DC)) {
210 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '('
211 << OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb39fc142013-05-17 23:58:45 +0000212 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000213 // We can extract the type of the class from the self pointer.
Eric Christophere7b87e52014-10-26 23:40:33 +0000214 if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000215 QualType ClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000216 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
Adrian Prantl6e785ec2013-05-17 23:49:10 +0000217 ClassTy.print(OS, PrintingPolicy(LangOptions()));
218 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000219 }
220 OS << ' ' << OMD->getSelector().getAsString() << ']';
221
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000222 return internString(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000223}
224
225/// getSelectorName - Return selector name. This is used for debugging
226/// info.
227StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000228 return internString(S.getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +0000229}
230
231/// getClassName - Get class name including template argument list.
Eric Christophere7b87e52014-10-26 23:40:33 +0000232StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
David Blaikie65813a32014-04-02 18:21:09 +0000233 // quick optimization to avoid having to intern strings that are already
234 // stored reliably elsewhere
235 if (!isa<ClassTemplateSpecializationDecl>(RD))
Guy Benyei11169dd2012-12-18 14:30:41 +0000236 return RD->getName();
237
David Blaikie65813a32014-04-02 18:21:09 +0000238 SmallString<128> Name;
Benjamin Kramer9170e912013-02-22 15:46:01 +0000239 {
David Blaikie65813a32014-04-02 18:21:09 +0000240 llvm::raw_svector_ostream OS(Name);
241 RD->getNameForDiagnostic(OS, CGM.getContext().getPrintingPolicy(),
242 /*Qualified*/ false);
Benjamin Kramer9170e912013-02-22 15:46:01 +0000243 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000244
245 // Copy this name on the side and use its reference.
David Blaikie65813a32014-04-02 18:21:09 +0000246 return internString(Name);
Guy Benyei11169dd2012-12-18 14:30:41 +0000247}
248
249/// getOrCreateFile - Get the file debug info descriptor for the input location.
250llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
251 if (!Loc.isValid())
252 // If Location is not valid then use main input file.
253 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
254
255 SourceManager &SM = CGM.getContext().getSourceManager();
256 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
257
258 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
259 // If the location is not valid then use main input file.
260 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
261
262 // Cache the results.
263 const char *fname = PLoc.getFilename();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000264 auto it = DIFileCache.find(fname);
Guy Benyei11169dd2012-12-18 14:30:41 +0000265
266 if (it != DIFileCache.end()) {
267 // Verify that the information still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000268 if (llvm::Metadata *V = it->second)
Guy Benyei11169dd2012-12-18 14:30:41 +0000269 return llvm::DIFile(cast<llvm::MDNode>(V));
270 }
271
272 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
273
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000274 DIFileCache[fname].reset(F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000275 return F;
276}
277
278/// getOrCreateMainFile - Get the file info for main compile unit.
279llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
280 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
281}
282
283/// getLineNumber - Get line number for the location. If location is invalid
284/// then use current location.
285unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
286 if (Loc.isInvalid() && CurLoc.isInvalid())
287 return 0;
288 SourceManager &SM = CGM.getContext().getSourceManager();
289 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000290 return PLoc.isValid() ? PLoc.getLine() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000291}
292
293/// getColumnNumber - Get column number for the location.
Adrian Prantlc7822422013-03-12 20:43:25 +0000294unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000295 // We may not want column information at all.
Adrian Prantlc7822422013-03-12 20:43:25 +0000296 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei11169dd2012-12-18 14:30:41 +0000297 return 0;
298
299 // If the location is invalid then use the current column.
300 if (Loc.isInvalid() && CurLoc.isInvalid())
301 return 0;
302 SourceManager &SM = CGM.getContext().getSourceManager();
303 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Eric Christophere7b87e52014-10-26 23:40:33 +0000304 return PLoc.isValid() ? PLoc.getColumn() : 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000305}
306
307StringRef CGDebugInfo::getCurrentDirname() {
308 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
309 return CGM.getCodeGenOpts().DebugCompilationDir;
310
311 if (!CWDName.empty())
312 return CWDName;
313 SmallString<256> CWD;
314 llvm::sys::fs::current_path(CWD);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000315 return CWDName = internString(CWD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000316}
317
318/// CreateCompileUnit - Create new compile unit.
319void CGDebugInfo::CreateCompileUnit() {
320
David Blaikieaabde052014-05-14 00:29:00 +0000321 // Should we be asking the SourceManager for the main file name, instead of
322 // accepting it as an argument? This just causes the main file name to
323 // mismatch with source locations and create extra lexical scopes or
324 // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
325 // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
326 // because that's what the SourceManager says)
327
Guy Benyei11169dd2012-12-18 14:30:41 +0000328 // Get absolute path name.
329 SourceManager &SM = CGM.getContext().getSourceManager();
330 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
331 if (MainFileName.empty())
David Blaikieaabde052014-05-14 00:29:00 +0000332 MainFileName = "<stdin>";
Guy Benyei11169dd2012-12-18 14:30:41 +0000333
334 // The main file name provided via the "-main-file-name" option contains just
335 // the file name itself with no path information. This file name may have had
336 // a relative path, so we look into the actual file entry for the main
337 // file to determine the real absolute path for the file.
338 std::string MainFileDir;
339 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
340 MainFileDir = MainFile->getDir()->getName();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000341 if (MainFileDir != ".") {
Eric Christopher0a1301f2014-02-26 02:49:36 +0000342 llvm::SmallString<1024> MainFileDirSS(MainFileDir);
343 llvm::sys::path::append(MainFileDirSS, MainFileName);
344 MainFileName = MainFileDirSS.str();
Yaron Keren9fb7e902013-10-21 20:07:37 +0000345 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000346 }
347
348 // Save filename string.
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000349 StringRef Filename = internString(MainFileName);
Eric Christopherf1545832013-02-22 23:50:16 +0000350
351 // Save split dwarf file string.
352 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000353 StringRef SplitDwarfFilename = internString(SplitDwarfFile);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000354
Ed Masteda706022014-05-07 12:49:30 +0000355 llvm::dwarf::SourceLanguage LangTag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000356 const LangOptions &LO = CGM.getLangOpts();
357 if (LO.CPlusPlus) {
358 if (LO.ObjC1)
359 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
360 else
361 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
362 } else if (LO.ObjC1) {
363 LangTag = llvm::dwarf::DW_LANG_ObjC;
364 } else if (LO.C99) {
365 LangTag = llvm::dwarf::DW_LANG_C99;
366 } else {
367 LangTag = llvm::dwarf::DW_LANG_C89;
368 }
369
370 std::string Producer = getClangFullVersion();
371
372 // Figure out which version of the ObjC runtime we have.
373 unsigned RuntimeVers = 0;
374 if (LO.ObjC1)
375 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
376
377 // Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000378 // FIXME - Eliminate TheCU.
Eric Christophere4200a22014-02-27 01:25:08 +0000379 TheCU = DBuilder.createCompileUnit(
380 LangTag, Filename, getCurrentDirname(), Producer, LO.Optimize,
381 CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers, SplitDwarfFilename,
Diego Novillo913690c2014-06-24 17:02:17 +0000382 DebugKind <= CodeGenOptions::DebugLineTablesOnly
Eric Christophere4200a22014-02-27 01:25:08 +0000383 ? llvm::DIBuilder::LineTablesOnly
Diego Novillo913690c2014-06-24 17:02:17 +0000384 : llvm::DIBuilder::FullDebug,
385 DebugKind != CodeGenOptions::LocTrackingOnly);
Guy Benyei11169dd2012-12-18 14:30:41 +0000386}
387
388/// CreateType - Get the Basic type from the cache or create a new
389/// one if necessary.
390llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
Ed Masteda706022014-05-07 12:49:30 +0000391 llvm::dwarf::TypeKind Encoding;
Guy Benyei11169dd2012-12-18 14:30:41 +0000392 StringRef BTName;
393 switch (BT->getKind()) {
394#define BUILTIN_TYPE(Id, SingletonId)
Eric Christophere7b87e52014-10-26 23:40:33 +0000395#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
Guy Benyei11169dd2012-12-18 14:30:41 +0000396#include "clang/AST/BuiltinTypes.def"
397 case BuiltinType::Dependent:
398 llvm_unreachable("Unexpected builtin type");
399 case BuiltinType::NullPtr:
Peter Collingbourne5c5e6172013-06-27 22:51:01 +0000400 return DBuilder.createNullPtrType();
Guy Benyei11169dd2012-12-18 14:30:41 +0000401 case BuiltinType::Void:
402 return llvm::DIType();
403 case BuiltinType::ObjCClass:
David Blaikief427b002014-05-06 03:42:01 +0000404 if (!ClassTy)
405 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
406 "objc_class", TheCU,
407 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000408 return ClassTy;
409 case BuiltinType::ObjCId: {
410 // typedef struct objc_class *Class;
411 // typedef struct objc_object {
412 // Class isa;
413 // } *id;
414
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000415 if (ObjTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000416 return ObjTy;
417
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000418 if (!ClassTy)
Guy Benyei11169dd2012-12-18 14:30:41 +0000419 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
420 "objc_class", TheCU,
421 getOrCreateMainFile(), 0);
422
423 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000424
Guy Benyei11169dd2012-12-18 14:30:41 +0000425 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
426
Eric Christopher5c7ee8b2013-04-02 22:59:11 +0000427 ObjTy =
David Blaikie6d4fe152013-02-25 01:07:08 +0000428 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
429 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei11169dd2012-12-18 14:30:41 +0000430
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +0000431 DBuilder.replaceArrays(
432 ObjTy,
433 DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
434 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000435 return ObjTy;
436 }
437 case BuiltinType::ObjCSel: {
David Blaikief427b002014-05-06 03:42:01 +0000438 if (!SelTy)
439 SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
440 "objc_selector", TheCU,
441 getOrCreateMainFile(), 0);
Guy Benyei11169dd2012-12-18 14:30:41 +0000442 return SelTy;
443 }
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000444
445 case BuiltinType::OCLImage1d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000446 return getOrCreateStructPtrType("opencl_image1d_t", OCLImage1dDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000447 case BuiltinType::OCLImage1dArray:
Eric Christopherb2a008c2013-05-16 00:45:12 +0000448 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000449 OCLImage1dArrayDITy);
450 case BuiltinType::OCLImage1dBuffer:
451 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
452 OCLImage1dBufferDITy);
453 case BuiltinType::OCLImage2d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000454 return getOrCreateStructPtrType("opencl_image2d_t", OCLImage2dDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000455 case BuiltinType::OCLImage2dArray:
456 return getOrCreateStructPtrType("opencl_image2d_array_t",
457 OCLImage2dArrayDITy);
458 case BuiltinType::OCLImage3d:
Eric Christophere7b87e52014-10-26 23:40:33 +0000459 return getOrCreateStructPtrType("opencl_image3d_t", OCLImage3dDITy);
Guy Benyei61054192013-02-07 10:55:47 +0000460 case BuiltinType::OCLSampler:
Eric Christophere7b87e52014-10-26 23:40:33 +0000461 return DBuilder.createBasicType(
462 "opencl_sampler_t", CGM.getContext().getTypeSize(BT),
463 CGM.getContext().getTypeAlign(BT), llvm::dwarf::DW_ATE_unsigned);
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000464 case BuiltinType::OCLEvent:
Eric Christophere7b87e52014-10-26 23:40:33 +0000465 return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000466
Guy Benyei11169dd2012-12-18 14:30:41 +0000467 case BuiltinType::UChar:
Eric Christophere7b87e52014-10-26 23:40:33 +0000468 case BuiltinType::Char_U:
469 Encoding = llvm::dwarf::DW_ATE_unsigned_char;
470 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000471 case BuiltinType::Char_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000472 case BuiltinType::SChar:
473 Encoding = llvm::dwarf::DW_ATE_signed_char;
474 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000475 case BuiltinType::Char16:
Eric Christophere7b87e52014-10-26 23:40:33 +0000476 case BuiltinType::Char32:
477 Encoding = llvm::dwarf::DW_ATE_UTF;
478 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000479 case BuiltinType::UShort:
480 case BuiltinType::UInt:
481 case BuiltinType::UInt128:
482 case BuiltinType::ULong:
483 case BuiltinType::WChar_U:
Eric Christophere7b87e52014-10-26 23:40:33 +0000484 case BuiltinType::ULongLong:
485 Encoding = llvm::dwarf::DW_ATE_unsigned;
486 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000487 case BuiltinType::Short:
488 case BuiltinType::Int:
489 case BuiltinType::Int128:
490 case BuiltinType::Long:
491 case BuiltinType::WChar_S:
Eric Christophere7b87e52014-10-26 23:40:33 +0000492 case BuiltinType::LongLong:
493 Encoding = llvm::dwarf::DW_ATE_signed;
494 break;
495 case BuiltinType::Bool:
496 Encoding = llvm::dwarf::DW_ATE_boolean;
497 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000498 case BuiltinType::Half:
499 case BuiltinType::Float:
500 case BuiltinType::LongDouble:
Eric Christophere7b87e52014-10-26 23:40:33 +0000501 case BuiltinType::Double:
502 Encoding = llvm::dwarf::DW_ATE_float;
503 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000504 }
505
506 switch (BT->getKind()) {
Eric Christophere7b87e52014-10-26 23:40:33 +0000507 case BuiltinType::Long:
508 BTName = "long int";
509 break;
510 case BuiltinType::LongLong:
511 BTName = "long long int";
512 break;
513 case BuiltinType::ULong:
514 BTName = "long unsigned int";
515 break;
516 case BuiltinType::ULongLong:
517 BTName = "long long unsigned int";
518 break;
Guy Benyei11169dd2012-12-18 14:30:41 +0000519 default:
520 BTName = BT->getName(CGM.getLangOpts());
521 break;
522 }
523 // Bit size, align and offset of the type.
524 uint64_t Size = CGM.getContext().getTypeSize(BT);
525 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christophere7b87e52014-10-26 23:40:33 +0000526 llvm::DIType DbgTy = DBuilder.createBasicType(BTName, Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000527 return DbgTy;
528}
529
530llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
531 // Bit size, align and offset of the type.
Ed Masteda706022014-05-07 12:49:30 +0000532 llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
Guy Benyei11169dd2012-12-18 14:30:41 +0000533 if (Ty->isComplexIntegerType())
534 Encoding = llvm::dwarf::DW_ATE_lo_user;
535
536 uint64_t Size = CGM.getContext().getTypeSize(Ty);
537 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000538 llvm::DIType DbgTy =
Eric Christophere7b87e52014-10-26 23:40:33 +0000539 DBuilder.createBasicType("complex", Size, Align, Encoding);
Guy Benyei11169dd2012-12-18 14:30:41 +0000540
541 return DbgTy;
542}
543
544/// CreateCVRType - Get the qualified type from the cache or create
545/// a new one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +0000546llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000547 QualifierCollector Qc;
548 const Type *T = Qc.strip(Ty);
549
550 // Ignore these qualifiers for now.
551 Qc.removeObjCGCAttr();
552 Qc.removeAddressSpace();
553 Qc.removeObjCLifetime();
554
555 // We will create one Derived type for one qualifier and recurse to handle any
556 // additional ones.
Ed Masteda706022014-05-07 12:49:30 +0000557 llvm::dwarf::Tag Tag;
Guy Benyei11169dd2012-12-18 14:30:41 +0000558 if (Qc.hasConst()) {
559 Tag = llvm::dwarf::DW_TAG_const_type;
560 Qc.removeConst();
561 } else if (Qc.hasVolatile()) {
562 Tag = llvm::dwarf::DW_TAG_volatile_type;
563 Qc.removeVolatile();
564 } else if (Qc.hasRestrict()) {
565 Tag = llvm::dwarf::DW_TAG_restrict_type;
566 Qc.removeRestrict();
567 } else {
568 assert(Qc.empty() && "Unknown type qualifier for debug info");
569 return getOrCreateType(QualType(T, 0), Unit);
570 }
571
David Blaikie99dab3b2013-09-04 22:03:57 +0000572 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000573
574 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
575 // CVR derived types.
576 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopherb2a008c2013-05-16 00:45:12 +0000577
Guy Benyei11169dd2012-12-18 14:30:41 +0000578 return DbgTy;
579}
580
581llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
582 llvm::DIFile Unit) {
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000583
584 // The frontend treats 'id' as a typedef to an ObjCObjectType,
585 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
586 // debug info, we want to emit 'id' in both cases.
587 if (Ty->isObjCQualifiedIdType())
Eric Christophere7b87e52014-10-26 23:40:33 +0000588 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000589
Eric Christophere7b87e52014-10-26 23:40:33 +0000590 llvm::DIType DbgTy = CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type,
591 Ty, Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000592 return DbgTy;
593}
594
Eric Christophere7b87e52014-10-26 23:40:33 +0000595llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty, llvm::DIFile Unit) {
Eric Christopherb2a008c2013-05-16 00:45:12 +0000596 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000597 Ty->getPointeeType(), Unit);
598}
599
Manman Rene0064d82013-08-29 23:19:58 +0000600/// In C++ mode, types have linkage, so we can rely on the ODR and
601/// on their mangled names, if they're external.
Eric Christophere7b87e52014-10-26 23:40:33 +0000602static SmallString<256> getUniqueTagTypeName(const TagType *Ty,
603 CodeGenModule &CGM,
604 llvm::DICompileUnit TheCU) {
Manman Rene0064d82013-08-29 23:19:58 +0000605 SmallString<256> FullName;
606 // FIXME: ODR should apply to ObjC++ exactly the same wasy it does to C++.
607 // For now, only apply ODR with C++.
608 const TagDecl *TD = Ty->getDecl();
609 if (TheCU.getLanguage() != llvm::dwarf::DW_LANG_C_plus_plus ||
610 !TD->isExternallyVisible())
611 return FullName;
612 // Microsoft Mangler does not have support for mangleCXXRTTIName yet.
613 if (CGM.getTarget().getCXXABI().isMicrosoft())
614 return FullName;
615
616 // TODO: This is using the RTTI name. Is there a better way to get
617 // a unique string for a type?
618 llvm::raw_svector_ostream Out(FullName);
619 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(QualType(Ty, 0), Out);
620 Out.flush();
621 return FullName;
622}
623
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000624static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
625 llvm::dwarf::Tag Tag;
626 if (RD->isStruct() || RD->isInterface())
627 Tag = llvm::dwarf::DW_TAG_structure_type;
628 else if (RD->isUnion())
629 Tag = llvm::dwarf::DW_TAG_union_type;
630 else {
631 // FIXME: This could be a struct type giving a default visibility different
632 // than C++ class type, but needs llvm metadata changes first.
633 assert(RD->isClass());
634 Tag = llvm::dwarf::DW_TAG_class_type;
635 }
636 return Tag;
637}
638
Guy Benyei11169dd2012-12-18 14:30:41 +0000639// Creates a forward declaration for a RecordDecl in the given context.
David Blaikie8d5e1282013-08-20 21:03:29 +0000640llvm::DICompositeType
Manman Ren1b457022013-08-28 21:20:28 +0000641CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
David Blaikie8d5e1282013-08-20 21:03:29 +0000642 llvm::DIDescriptor Ctx) {
Manman Ren1b457022013-08-28 21:20:28 +0000643 const RecordDecl *RD = Ty->getDecl();
David Blaikie4e7ef802013-08-15 20:17:25 +0000644 if (llvm::DIType T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
David Blaikie8d5e1282013-08-20 21:03:29 +0000645 return llvm::DICompositeType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000646 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
647 unsigned Line = getLineNumber(RD->getLocation());
648 StringRef RDName = getClassName(RD);
649
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000650 uint64_t Size = 0;
651 uint64_t Align = 0;
652
653 const RecordDecl *D = RD->getDefinition();
654 if (D && D->isCompleteDefinition()) {
655 Size = CGM.getContext().getTypeSize(Ty);
656 Align = CGM.getContext().getTypeAlign(Ty);
657 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000658
659 // Create the type.
Manman Rene0064d82013-08-29 23:19:58 +0000660 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000661 llvm::DICompositeType RetTy = DBuilder.createReplaceableCompositeType(
Peter Collingbourned251b0a2015-03-01 22:07:04 +0000662 getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
Adrian Prantl5f66bae2015-02-11 17:45:15 +0000663 llvm::DIDescriptor::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000664 ReplaceMap.emplace_back(
665 std::piecewise_construct, std::make_tuple(Ty),
666 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +0000667 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +0000668}
669
Ed Masteda706022014-05-07 12:49:30 +0000670llvm::DIType CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
Eric Christopherb2a008c2013-05-16 00:45:12 +0000671 const Type *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +0000672 QualType PointeeTy,
673 llvm::DIFile Unit) {
674 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
675 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikie99dab3b2013-09-04 22:03:57 +0000676 return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit));
Fariborz Jahanian65f1fa12013-02-21 20:42:11 +0000677
Guy Benyei11169dd2012-12-18 14:30:41 +0000678 // Bit size, align and offset of the type.
679 // Size is always the size of a pointer. We can't use getTypeSize here
680 // because that does not return the correct value for references.
681 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +0000682 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei11169dd2012-12-18 14:30:41 +0000683 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
684
David Blaikie99dab3b2013-09-04 22:03:57 +0000685 return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
686 Align);
Guy Benyei11169dd2012-12-18 14:30:41 +0000687}
688
Eric Christopher0fdcb312013-05-16 00:52:20 +0000689llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
690 llvm::DIType &Cache) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000691 if (Cache)
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000692 return Cache;
David Blaikiefefc7f72013-05-21 17:58:54 +0000693 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
694 TheCU, getOrCreateMainFile(), 0);
695 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
696 Cache = DBuilder.createPointerType(Cache, Size);
697 return Cache;
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000698}
699
Guy Benyei11169dd2012-12-18 14:30:41 +0000700llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
701 llvm::DIFile Unit) {
Eric Christopherf8bc4d82013-07-18 00:52:50 +0000702 if (BlockLiteralGeneric)
Guy Benyei11169dd2012-12-18 14:30:41 +0000703 return BlockLiteralGeneric;
704
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000705 SmallVector<llvm::Metadata *, 8> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000706 llvm::DIType FieldTy;
707 QualType FType;
708 uint64_t FieldSize, FieldOffset;
709 unsigned FieldAlign;
710 llvm::DIArray Elements;
711 llvm::DIType EltTy, DescTy;
712
713 FieldOffset = 0;
714 FType = CGM.getContext().UnsignedLongTy;
715 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
716 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
717
718 Elements = DBuilder.getOrCreateArray(EltTys);
719 EltTys.clear();
720
721 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
722 unsigned LineNo = getLineNumber(CurLoc);
723
Eric Christophere7b87e52014-10-26 23:40:33 +0000724 EltTy = DBuilder.createStructType(Unit, "__block_descriptor", Unit, LineNo,
725 FieldOffset, 0, Flags, llvm::DIType(),
726 Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000727
728 // Bit size, align and offset of the type.
729 uint64_t Size = CGM.getContext().getTypeSize(Ty);
730
731 DescTy = DBuilder.createPointerType(EltTy, Size);
732
733 FieldOffset = 0;
734 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
735 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
736 FType = CGM.getContext().IntTy;
737 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
738 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Adrian Prantl65d5d002014-11-05 01:01:30 +0000739 FType = CGM.getContext().getPointerType(Ty->getPointeeType());
Guy Benyei11169dd2012-12-18 14:30:41 +0000740 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
741
742 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
743 FieldTy = DescTy;
744 FieldSize = CGM.getContext().getTypeSize(Ty);
745 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Eric Christophere7b87e52014-10-26 23:40:33 +0000746 FieldTy =
747 DBuilder.createMemberType(Unit, "__descriptor", Unit, LineNo, FieldSize,
748 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000749 EltTys.push_back(FieldTy);
750
751 FieldOffset += FieldSize;
752 Elements = DBuilder.getOrCreateArray(EltTys);
753
Eric Christophere7b87e52014-10-26 23:40:33 +0000754 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic", Unit,
755 LineNo, FieldOffset, 0, Flags,
756 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +0000757
Guy Benyei11169dd2012-12-18 14:30:41 +0000758 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
759 return BlockLiteralGeneric;
760}
761
Eric Christophere7b87e52014-10-26 23:40:33 +0000762llvm::DIType CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
763 llvm::DIFile Unit) {
David Blaikief1b382e2014-04-06 17:14:06 +0000764 assert(Ty->isTypeAlias());
765 llvm::DIType Src = getOrCreateType(Ty->getAliasedType(), Unit);
David Blaikief1b382e2014-04-06 17:14:06 +0000766
767 SmallString<128> NS;
768 llvm::raw_svector_ostream OS(NS);
Eric Christophere7b87e52014-10-26 23:40:33 +0000769 Ty->getTemplateName().print(OS, CGM.getContext().getPrintingPolicy(),
770 /*qualified*/ false);
David Blaikief1b382e2014-04-06 17:14:06 +0000771
772 TemplateSpecializationType::PrintTemplateArgumentList(
773 OS, Ty->getArgs(), Ty->getNumArgs(),
774 CGM.getContext().getPrintingPolicy());
775
Eric Christophere7b87e52014-10-26 23:40:33 +0000776 TypeAliasDecl *AliasDecl = cast<TypeAliasTemplateDecl>(
777 Ty->getTemplateName().getAsTemplateDecl())->getTemplatedDecl();
David Blaikief1b382e2014-04-06 17:14:06 +0000778
779 SourceLocation Loc = AliasDecl->getLocation();
780 llvm::DIFile File = getOrCreateFile(Loc);
781 unsigned Line = getLineNumber(Loc);
782
Eric Christophere7b87e52014-10-26 23:40:33 +0000783 llvm::DIDescriptor Ctxt =
784 getContextDescriptor(cast<Decl>(AliasDecl->getDeclContext()));
David Blaikief1b382e2014-04-06 17:14:06 +0000785
786 return DBuilder.createTypedef(Src, internString(OS.str()), File, Line, Ctxt);
787}
788
David Blaikie99dab3b2013-09-04 22:03:57 +0000789llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000790 // Typedefs are derived from some other type. If we have a typedef of a
791 // typedef, make sure to emit the whole chain.
David Blaikie99dab3b2013-09-04 22:03:57 +0000792 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +0000793 // We don't set size information, but do specify where the typedef was
794 // declared.
Adrian Prantl3eff2252014-01-21 18:42:27 +0000795 SourceLocation Loc = Ty->getDecl()->getLocation();
796 llvm::DIFile File = getOrCreateFile(Loc);
797 unsigned Line = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000798 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +0000799
Guy Benyei11169dd2012-12-18 14:30:41 +0000800 llvm::DIDescriptor TypedefContext =
Eric Christophere7b87e52014-10-26 23:40:33 +0000801 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopherb2a008c2013-05-16 00:45:12 +0000802
Eric Christophere7b87e52014-10-26 23:40:33 +0000803 return DBuilder.createTypedef(Src, TyDecl->getName(), File, Line,
804 TypedefContext);
Guy Benyei11169dd2012-12-18 14:30:41 +0000805}
806
807llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
808 llvm::DIFile Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000809 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +0000810
811 // Add the result type at least.
Alp Toker314cc812014-01-25 16:55:45 +0000812 EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +0000813
814 // Set up remainder of arguments if there is a prototype.
Adrian Prantl800faef2014-02-25 23:42:18 +0000815 // otherwise emit it as a variadic function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000816 if (isa<FunctionNoProtoType>(Ty))
817 EltTys.push_back(DBuilder.createUnspecifiedParameter());
818 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Alp Toker9cacbab2014-01-20 20:26:09 +0000819 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
820 EltTys.push_back(getOrCreateType(FPT->getParamType(i), Unit));
Adrian Prantld45ba252014-02-25 19:38:11 +0000821 if (FPT->isVariadic())
822 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +0000823 }
824
Manman Ren67f005e2014-07-28 22:24:34 +0000825 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Guy Benyei11169dd2012-12-18 14:30:41 +0000826 return DBuilder.createSubroutineType(Unit, EltTypeArray);
827}
828
Adrian Prantl21361fb2014-08-29 22:44:27 +0000829/// Convert an AccessSpecifier into the corresponding DIDescriptor flag.
830/// As an optimization, return 0 if the access specifier equals the
831/// default for the containing type.
832static unsigned getAccessFlag(AccessSpecifier Access, const RecordDecl *RD) {
833 AccessSpecifier Default = clang::AS_none;
834 if (RD && RD->isClass())
835 Default = clang::AS_private;
836 else if (RD && (RD->isStruct() || RD->isUnion()))
837 Default = clang::AS_public;
838
839 if (Access == Default)
840 return 0;
841
Eric Christophere7b87e52014-10-26 23:40:33 +0000842 switch (Access) {
843 case clang::AS_private:
844 return llvm::DIDescriptor::FlagPrivate;
845 case clang::AS_protected:
846 return llvm::DIDescriptor::FlagProtected;
847 case clang::AS_public:
848 return llvm::DIDescriptor::FlagPublic;
849 case clang::AS_none:
850 return 0;
Adrian Prantl21361fb2014-08-29 22:44:27 +0000851 }
852 llvm_unreachable("unexpected access enumerator");
853}
Guy Benyei11169dd2012-12-18 14:30:41 +0000854
Eric Christophere7b87e52014-10-26 23:40:33 +0000855llvm::DIType CGDebugInfo::createFieldType(
856 StringRef name, QualType type, uint64_t sizeInBitsOverride,
857 SourceLocation loc, AccessSpecifier AS, uint64_t offsetInBits,
858 llvm::DIFile tunit, llvm::DIScope scope, const RecordDecl *RD) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000859 llvm::DIType debugType = getOrCreateType(type, tunit);
860
861 // Get the location for the field.
862 llvm::DIFile file = getOrCreateFile(loc);
863 unsigned line = getLineNumber(loc);
864
David Majnemer34b57492014-07-30 01:30:47 +0000865 uint64_t SizeInBits = 0;
866 unsigned AlignInBits = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000867 if (!type->isIncompleteArrayType()) {
David Majnemer34b57492014-07-30 01:30:47 +0000868 TypeInfo TI = CGM.getContext().getTypeInfo(type);
869 SizeInBits = TI.Width;
870 AlignInBits = TI.Align;
Guy Benyei11169dd2012-12-18 14:30:41 +0000871
872 if (sizeInBitsOverride)
David Majnemer34b57492014-07-30 01:30:47 +0000873 SizeInBits = sizeInBitsOverride;
Guy Benyei11169dd2012-12-18 14:30:41 +0000874 }
875
Adrian Prantl21361fb2014-08-29 22:44:27 +0000876 unsigned flags = getAccessFlag(AS, RD);
David Majnemer34b57492014-07-30 01:30:47 +0000877 return DBuilder.createMemberType(scope, name, file, line, SizeInBits,
878 AlignInBits, offsetInBits, flags, debugType);
Guy Benyei11169dd2012-12-18 14:30:41 +0000879}
880
Eric Christopher91a31902013-01-16 01:22:32 +0000881/// CollectRecordLambdaFields - Helper for CollectRecordFields.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000882void CGDebugInfo::CollectRecordLambdaFields(
883 const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
884 llvm::DIType RecordTy) {
Eric Christopher91a31902013-01-16 01:22:32 +0000885 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
886 // has the name and the location of the variable so we should iterate over
887 // both concurrently.
888 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
889 RecordDecl::field_iterator Field = CXXDecl->field_begin();
890 unsigned fieldno = 0;
891 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
Eric Christophere7b87e52014-10-26 23:40:33 +0000892 E = CXXDecl->captures_end();
893 I != E; ++I, ++Field, ++fieldno) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +0000894 const LambdaCapture &C = *I;
Eric Christopher91a31902013-01-16 01:22:32 +0000895 if (C.capturesVariable()) {
896 VarDecl *V = C.getCapturedVar();
897 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
898 StringRef VName = V->getName();
899 uint64_t SizeInBitsOverride = 0;
900 if (Field->isBitField()) {
901 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
902 assert(SizeInBitsOverride && "found named 0-width bitfield");
903 }
Eric Christophere7b87e52014-10-26 23:40:33 +0000904 llvm::DIType fieldType = createFieldType(
905 VName, Field->getType(), SizeInBitsOverride, C.getLocation(),
906 Field->getAccess(), layout.getFieldOffset(fieldno), VUnit, RecordTy,
907 CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000908 elements.push_back(fieldType);
Alexey Bataev39c81e22014-08-28 04:28:19 +0000909 } else if (C.capturesThis()) {
Eric Christopher91a31902013-01-16 01:22:32 +0000910 // TODO: Need to handle 'this' in some way by probably renaming the
911 // this of the lambda class and having a field member of 'this' or
912 // by using AT_object_pointer for the function and having that be
913 // used as 'this' for semantic references.
Eric Christopher91a31902013-01-16 01:22:32 +0000914 FieldDecl *f = *Field;
915 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
916 QualType type = f->getType();
Eric Christophere7b87e52014-10-26 23:40:33 +0000917 llvm::DIType fieldType = createFieldType(
918 "this", type, 0, f->getLocation(), f->getAccess(),
919 layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
Eric Christopher91a31902013-01-16 01:22:32 +0000920
921 elements.push_back(fieldType);
922 }
923 }
924}
925
David Blaikie6943dea2013-08-20 01:28:15 +0000926/// Helper for CollectRecordFields.
Eric Christophere7b87e52014-10-26 23:40:33 +0000927llvm::DIDerivedType CGDebugInfo::CreateRecordStaticField(const VarDecl *Var,
928 llvm::DIType RecordTy,
929 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000930 // Create the descriptor for the static variable, with or without
931 // constant initializers.
David Blaikie8e707bb2014-10-14 22:22:17 +0000932 Var = Var->getCanonicalDecl();
Eric Christopher91a31902013-01-16 01:22:32 +0000933 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
934 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
935
Eric Christopher91a31902013-01-16 01:22:32 +0000936 unsigned LineNumber = getLineNumber(Var->getLocation());
937 StringRef VName = Var->getName();
Craig Topper8a13c412014-05-21 05:09:00 +0000938 llvm::Constant *C = nullptr;
Eric Christopher91a31902013-01-16 01:22:32 +0000939 if (Var->getInit()) {
940 const APValue *Value = Var->evaluateValue();
David Blaikied42917f2013-01-20 01:19:17 +0000941 if (Value) {
942 if (Value->isInt())
943 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
944 if (Value->isFloat())
945 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
946 }
Eric Christopher91a31902013-01-16 01:22:32 +0000947 }
948
Adrian Prantl21361fb2014-08-29 22:44:27 +0000949 unsigned Flags = getAccessFlag(Var->getAccess(), RD);
David Blaikieae019462013-08-15 22:50:29 +0000950 llvm::DIDerivedType GV = DBuilder.createStaticMemberType(
951 RecordTy, VName, VUnit, LineNumber, VTy, Flags, C);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000952 StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
David Blaikieae019462013-08-15 22:50:29 +0000953 return GV;
Eric Christopher91a31902013-01-16 01:22:32 +0000954}
955
956/// CollectRecordNormalField - Helper for CollectRecordFields.
Eric Christophere7b87e52014-10-26 23:40:33 +0000957void CGDebugInfo::CollectRecordNormalField(
958 const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile tunit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000959 SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType RecordTy,
Eric Christophere7b87e52014-10-26 23:40:33 +0000960 const RecordDecl *RD) {
Eric Christopher91a31902013-01-16 01:22:32 +0000961 StringRef name = field->getName();
962 QualType type = field->getType();
963
964 // Ignore unnamed fields unless they're anonymous structs/unions.
965 if (name.empty() && !type->isRecordType())
966 return;
967
968 uint64_t SizeInBitsOverride = 0;
969 if (field->isBitField()) {
970 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
971 assert(SizeInBitsOverride && "found named 0-width bitfield");
972 }
973
Eric Christophere7b87e52014-10-26 23:40:33 +0000974 llvm::DIType fieldType =
975 createFieldType(name, type, SizeInBitsOverride, field->getLocation(),
976 field->getAccess(), OffsetInBits, tunit, RecordTy, RD);
Eric Christopher91a31902013-01-16 01:22:32 +0000977
978 elements.push_back(fieldType);
979}
980
Guy Benyei11169dd2012-12-18 14:30:41 +0000981/// CollectRecordFields - A helper function to collect debug info for
982/// record fields. This is used while creating debug info entry for a Record.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000983void CGDebugInfo::CollectRecordFields(
984 const RecordDecl *record, llvm::DIFile tunit,
985 SmallVectorImpl<llvm::Metadata *> &elements,
986 llvm::DICompositeType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000987 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
988
Eric Christopher91a31902013-01-16 01:22:32 +0000989 if (CXXDecl && CXXDecl->isLambda())
990 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
991 else {
992 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei11169dd2012-12-18 14:30:41 +0000993
Eric Christopher91a31902013-01-16 01:22:32 +0000994 // Field number for non-static fields.
Eric Christopher0f7594372013-01-04 17:59:07 +0000995 unsigned fieldNo = 0;
Eric Christopher91a31902013-01-16 01:22:32 +0000996
Eric Christopher91a31902013-01-16 01:22:32 +0000997 // Static and non-static members should appear in the same order as
998 // the corresponding declarations in the source program.
Aaron Ballman629afae2014-03-07 19:56:05 +0000999 for (const auto *I : record->decls())
1000 if (const auto *V = dyn_cast<VarDecl>(I)) {
David Blaikiece763042013-08-20 21:49:21 +00001001 // Reuse the existing static member declaration if one exists
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001002 auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
David Blaikiece763042013-08-20 21:49:21 +00001003 if (MI != StaticDataMemberCache.end()) {
1004 assert(MI->second &&
1005 "Static data member declaration should still exist");
1006 elements.push_back(
1007 llvm::DIDerivedType(cast<llvm::MDNode>(MI->second)));
Adrian Prantl21361fb2014-08-29 22:44:27 +00001008 } else {
1009 auto Field = CreateRecordStaticField(V, RecordTy, record);
1010 elements.push_back(Field);
1011 }
Aaron Ballman629afae2014-03-07 19:56:05 +00001012 } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001013 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1014 elements, RecordTy, record);
Eric Christopher91a31902013-01-16 01:22:32 +00001015
1016 // Bump field number for next field.
1017 ++fieldNo;
Guy Benyei11169dd2012-12-18 14:30:41 +00001018 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001019 }
1020}
1021
1022/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
1023/// function type is not updated to include implicit "this" pointer. Use this
1024/// routine to get a method type which includes "this" pointer.
David Blaikie469f0792013-05-22 23:22:42 +00001025llvm::DICompositeType
Guy Benyei11169dd2012-12-18 14:30:41 +00001026CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1027 llvm::DIFile Unit) {
David Blaikie7eb06852013-01-07 23:06:35 +00001028 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie2aaf0652013-01-07 22:24:59 +00001029 if (Method->isStatic())
David Blaikie469f0792013-05-22 23:22:42 +00001030 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie7eb06852013-01-07 23:06:35 +00001031 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
1032 Func, Unit);
1033}
David Blaikie2aaf0652013-01-07 22:24:59 +00001034
David Blaikie469f0792013-05-22 23:22:42 +00001035llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie7eb06852013-01-07 23:06:35 +00001036 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001037 // Add "this" pointer.
Manman Ren67f005e2014-07-28 22:24:34 +00001038 llvm::DITypeArray Args = llvm::DISubroutineType(
1039 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Eric Christophere7b87e52014-10-26 23:40:33 +00001040 assert(Args.getNumElements() && "Invalid number of arguments!");
Guy Benyei11169dd2012-12-18 14:30:41 +00001041
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001042 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001043
1044 // First element is always return type. For 'void' functions it is NULL.
1045 Elts.push_back(Args.getElement(0));
1046
David Blaikie2aaf0652013-01-07 22:24:59 +00001047 // "this" pointer is always first argument.
David Blaikie7eb06852013-01-07 23:06:35 +00001048 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie2aaf0652013-01-07 22:24:59 +00001049 if (isa<ClassTemplateSpecializationDecl>(RD)) {
1050 // Create pointer type directly in this case.
1051 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1052 QualType PointeeTy = ThisPtrTy->getPointeeType();
1053 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCallc8e01702013-04-16 22:48:15 +00001054 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie2aaf0652013-01-07 22:24:59 +00001055 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
1056 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopher0fdcb312013-05-16 00:52:20 +00001057 llvm::DIType ThisPtrType =
Eric Christophere7b87e52014-10-26 23:40:33 +00001058 DBuilder.createPointerType(PointeeType, Size, Align);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001059 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001060 // TODO: This and the artificial type below are misleading, the
1061 // types aren't artificial the argument is, but the current
1062 // metadata doesn't represent that.
1063 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1064 Elts.push_back(ThisPtrType);
1065 } else {
1066 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001067 TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
David Blaikie2aaf0652013-01-07 22:24:59 +00001068 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1069 Elts.push_back(ThisPtrType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001070 }
1071
1072 // Copy rest of the arguments.
1073 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
1074 Elts.push_back(Args.getElement(i));
1075
Manman Ren67f005e2014-07-28 22:24:34 +00001076 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00001077
Adrian Prantl0630eb72013-12-18 21:48:18 +00001078 unsigned Flags = 0;
1079 if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1080 Flags |= llvm::DIDescriptor::FlagLValueReference;
1081 if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1082 Flags |= llvm::DIDescriptor::FlagRValueReference;
1083
1084 return DBuilder.createSubroutineType(Unit, EltTypeArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001085}
1086
Eric Christopherb2a008c2013-05-16 00:45:12 +00001087/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei11169dd2012-12-18 14:30:41 +00001088/// inside a function.
1089static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1090 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1091 return isFunctionLocalClass(NRD);
1092 if (isa<FunctionDecl>(RD->getDeclContext()))
1093 return true;
1094 return false;
1095}
1096
1097/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1098/// a single member function GlobalDecl.
1099llvm::DISubprogram
1100CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
Eric Christophere7b87e52014-10-26 23:40:33 +00001101 llvm::DIFile Unit, llvm::DIType RecordTy) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001102 bool IsCtorOrDtor =
Eric Christophere7b87e52014-10-26 23:40:33 +00001103 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001104
Guy Benyei11169dd2012-12-18 14:30:41 +00001105 StringRef MethodName = getFunctionName(Method);
David Blaikie469f0792013-05-22 23:22:42 +00001106 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001107
1108 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1109 // make sense to give a single ctor/dtor a linkage name.
1110 StringRef MethodLinkageName;
1111 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1112 MethodLinkageName = CGM.getMangledName(Method);
1113
1114 // Get the location for the method.
David Blaikie7fceebf2013-08-19 03:37:48 +00001115 llvm::DIFile MethodDefUnit;
1116 unsigned MethodLine = 0;
1117 if (!Method->isImplicit()) {
1118 MethodDefUnit = getOrCreateFile(Method->getLocation());
1119 MethodLine = getLineNumber(Method->getLocation());
1120 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001121
1122 // Collect virtual method info.
1123 llvm::DIType ContainingType;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001124 unsigned Virtuality = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00001125 unsigned VIndex = 0;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001126
Guy Benyei11169dd2012-12-18 14:30:41 +00001127 if (Method->isVirtual()) {
1128 if (Method->isPure())
1129 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1130 else
1131 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001132
Guy Benyei11169dd2012-12-18 14:30:41 +00001133 // It doesn't make sense to give a virtual destructor a vtable index,
1134 // since a single destructor has two entries in the vtable.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001135 // FIXME: Add proper support for debug info for virtual calls in
1136 // the Microsoft ABI, where we may use multiple vptrs to make a vftable
1137 // lookup if we have multiple or virtual inheritance.
1138 if (!isa<CXXDestructorDecl>(Method) &&
1139 !CGM.getTarget().getCXXABI().isMicrosoft())
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001140 VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
Guy Benyei11169dd2012-12-18 14:30:41 +00001141 ContainingType = RecordTy;
1142 }
1143
1144 unsigned Flags = 0;
1145 if (Method->isImplicit())
1146 Flags |= llvm::DIDescriptor::FlagArtificial;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001147 Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
Guy Benyei11169dd2012-12-18 14:30:41 +00001148 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1149 if (CXXC->isExplicit())
1150 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001151 } else if (const CXXConversionDecl *CXXC =
Eric Christophere7b87e52014-10-26 23:40:33 +00001152 dyn_cast<CXXConversionDecl>(Method)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001153 if (CXXC->isExplicit())
1154 Flags |= llvm::DIDescriptor::FlagExplicit;
1155 }
1156 if (Method->hasPrototype())
1157 Flags |= llvm::DIDescriptor::FlagPrototyped;
Adrian Prantl0630eb72013-12-18 21:48:18 +00001158 if (Method->getRefQualifier() == RQ_LValue)
1159 Flags |= llvm::DIDescriptor::FlagLValueReference;
1160 if (Method->getRefQualifier() == RQ_RValue)
1161 Flags |= llvm::DIDescriptor::FlagRValueReference;
Guy Benyei11169dd2012-12-18 14:30:41 +00001162
1163 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
Eric Christophere7b87e52014-10-26 23:40:33 +00001164 llvm::DISubprogram SP = DBuilder.createMethod(
1165 RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1166 MethodTy, /*isLocalToUnit=*/false,
1167 /* isDefinition=*/false, Virtuality, VIndex, ContainingType, Flags,
1168 CGM.getLangOpts().Optimize, nullptr, TParamsArray);
Eric Christopherb2a008c2013-05-16 00:45:12 +00001169
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001170 SPCache[Method->getCanonicalDecl()].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00001171
1172 return SP;
1173}
1174
1175/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001176/// C++ member functions. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001177/// a Record.
Eric Christophere7b87e52014-10-26 23:40:33 +00001178void CGDebugInfo::CollectCXXMemberFunctions(
1179 const CXXRecordDecl *RD, llvm::DIFile Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001180 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001181
1182 // Since we want more than just the individual member decls if we
1183 // have templated functions iterate over every declaration to gather
1184 // the functions.
Eric Christophere7b87e52014-10-26 23:40:33 +00001185 for (const auto *I : RD->decls()) {
David Blaikiefd580722014-10-06 05:18:55 +00001186 const auto *Method = dyn_cast<CXXMethodDecl>(I);
1187 // If the member is implicit, don't add it to the member list. This avoids
1188 // the member being added to type units by LLVM, while still allowing it
1189 // to be emitted into the type declaration/reference inside the compile
1190 // unit.
David Blaikie6dddfe32014-10-06 05:52:27 +00001191 // FIXME: Handle Using(Shadow?)Decls here to create
1192 // DW_TAG_imported_declarations inside the class for base decls brought into
1193 // derived classes. GDB doesn't seem to notice/leverage these when I tried
1194 // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1195 // referenced)
David Blaikiefd580722014-10-06 05:18:55 +00001196 if (!Method || Method->isImplicit())
1197 continue;
David Blaikie42edade2014-11-11 20:44:45 +00001198
1199 if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1200 continue;
1201
David Blaikiefd580722014-10-06 05:18:55 +00001202 // Reuse the existing member function declaration if it exists.
1203 // It may be associated with the declaration of the type & should be
1204 // reused as we're building the definition.
1205 //
1206 // This situation can arise in the vtable-based debug info reduction where
1207 // implicit members are emitted in a non-vtable TU.
1208 auto MI = SPCache.find(Method->getCanonicalDecl());
1209 EltTys.push_back(MI == SPCache.end()
1210 ? CreateCXXMemberFunction(Method, Unit, RecordTy)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001211 : static_cast<llvm::Metadata *>(MI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00001212 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00001213}
Guy Benyei11169dd2012-12-18 14:30:41 +00001214
Guy Benyei11169dd2012-12-18 14:30:41 +00001215/// CollectCXXBases - A helper function to collect debug info for
Eric Christopherb2a008c2013-05-16 00:45:12 +00001216/// C++ base classes. This is used while creating debug info entry for
Guy Benyei11169dd2012-12-18 14:30:41 +00001217/// a Record.
Eric Christophere7b87e52014-10-26 23:40:33 +00001218void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001219 SmallVectorImpl<llvm::Metadata *> &EltTys,
Eric Christophere7b87e52014-10-26 23:40:33 +00001220 llvm::DIType RecordTy) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001221
1222 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Aaron Ballman574705e2014-03-13 15:41:46 +00001223 for (const auto &BI : RD->bases()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001224 unsigned BFlags = 0;
1225 uint64_t BaseOffset;
Eric Christopherb2a008c2013-05-16 00:45:12 +00001226
Guy Benyei11169dd2012-12-18 14:30:41 +00001227 const CXXRecordDecl *Base =
Eric Christophere7b87e52014-10-26 23:40:33 +00001228 cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001229
Aaron Ballman574705e2014-03-13 15:41:46 +00001230 if (BI.isVirtual()) {
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001231 if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1232 // virtual base offset offset is -ve. The code generator emits dwarf
1233 // expression where it expects +ve number.
Eric Christophere7b87e52014-10-26 23:40:33 +00001234 BaseOffset = 0 - CGM.getItaniumVTableContext()
1235 .getVirtualBaseOffsetOffset(RD, Base)
1236 .getQuantity();
Reid Klecknerd3b23d62014-08-07 21:29:25 +00001237 } else {
1238 // In the MS ABI, store the vbtable offset, which is analogous to the
1239 // vbase offset offset in Itanium.
1240 BaseOffset =
1241 4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1242 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001243 BFlags = llvm::DIDescriptor::FlagVirtual;
1244 } else
1245 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1246 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1247 // BI->isVirtual() and bits when not.
Eric Christopherb2a008c2013-05-16 00:45:12 +00001248
Adrian Prantl21361fb2014-08-29 22:44:27 +00001249 BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001250 llvm::DIType DTy = DBuilder.createInheritance(
1251 RecordTy, getOrCreateType(BI.getType(), Unit), BaseOffset, BFlags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001252 EltTys.push_back(DTy);
1253 }
1254}
1255
1256/// CollectTemplateParams - A helper function to collect template parameters.
Eric Christophere7b87e52014-10-26 23:40:33 +00001257llvm::DIArray
1258CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1259 ArrayRef<TemplateArgument> TAList,
1260 llvm::DIFile Unit) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001261 SmallVector<llvm::Metadata *, 16> TemplateParams;
Guy Benyei11169dd2012-12-18 14:30:41 +00001262 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1263 const TemplateArgument &TA = TAList[i];
David Blaikie47c11502013-06-22 18:59:18 +00001264 StringRef Name;
1265 if (TPList)
1266 Name = TPList->getParam(i)->getName();
David Blaikie38079fd2013-05-10 21:53:14 +00001267 switch (TA.getKind()) {
1268 case TemplateArgument::Type: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001269 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1270 llvm::DITemplateTypeParameter TTP =
David Blaikie47c11502013-06-22 18:59:18 +00001271 DBuilder.createTemplateTypeParameter(TheCU, Name, TTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001272 TemplateParams.push_back(TTP);
David Blaikie38079fd2013-05-10 21:53:14 +00001273 } break;
1274 case TemplateArgument::Integral: {
Guy Benyei11169dd2012-12-18 14:30:41 +00001275 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1276 llvm::DITemplateValueParameter TVP =
David Blaikie38079fd2013-05-10 21:53:14 +00001277 DBuilder.createTemplateValueParameter(
David Blaikie47c11502013-06-22 18:59:18 +00001278 TheCU, Name, TTy,
David Blaikie38079fd2013-05-10 21:53:14 +00001279 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1280 TemplateParams.push_back(TVP);
1281 } break;
1282 case TemplateArgument::Declaration: {
1283 const ValueDecl *D = TA.getAsDecl();
David Blaikieb5c7e6a2014-10-18 02:21:26 +00001284 QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
David Blaikie38079fd2013-05-10 21:53:14 +00001285 llvm::DIType TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001286 llvm::Constant *V = nullptr;
David Blaikie1a83db42014-10-20 18:56:54 +00001287 const CXXMethodDecl *MD;
David Blaikie38079fd2013-05-10 21:53:14 +00001288 // Variable pointer template parameters have a value that is the address
1289 // of the variable.
David Blaikie952a9b12014-10-17 18:00:12 +00001290 if (const auto *VD = dyn_cast<VarDecl>(D))
David Blaikie38079fd2013-05-10 21:53:14 +00001291 V = CGM.GetAddrOfGlobalVar(VD);
1292 // Member function pointers have special support for building them, though
1293 // this is currently unsupported in LLVM CodeGen.
David Blaikie1a83db42014-10-20 18:56:54 +00001294 else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
David Blaikie0a7c9d52014-10-20 20:29:35 +00001295 V = CGM.getCXXABI().EmitMemberPointer(MD);
David Blaikie952a9b12014-10-17 18:00:12 +00001296 else if (const auto *FD = dyn_cast<FunctionDecl>(D))
David Blaikied900f982013-05-13 06:57:50 +00001297 V = CGM.GetAddrOfFunction(FD);
David Blaikie38079fd2013-05-10 21:53:14 +00001298 // Member data pointers have special handling too to compute the fixed
1299 // offset within the object.
David Blaikie952a9b12014-10-17 18:00:12 +00001300 else if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr())) {
David Blaikie38079fd2013-05-10 21:53:14 +00001301 // These five lines (& possibly the above member function pointer
1302 // handling) might be able to be refactored to use similar code in
1303 // CodeGenModule::getMemberPointerConstant
1304 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1305 CharUnits chars =
Eric Christophere7b87e52014-10-26 23:40:33 +00001306 CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
David Blaikie952a9b12014-10-17 18:00:12 +00001307 V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
David Blaikie38079fd2013-05-10 21:53:14 +00001308 }
1309 llvm::DITemplateValueParameter TVP =
Duncan P. N. Exon Smith2f68dad2014-11-15 00:24:50 +00001310 DBuilder.createTemplateValueParameter(
1311 TheCU, Name, TTy,
1312 cast_or_null<llvm::Constant>(V->stripPointerCasts()));
David Blaikie38079fd2013-05-10 21:53:14 +00001313 TemplateParams.push_back(TVP);
1314 } break;
1315 case TemplateArgument::NullPtr: {
1316 QualType T = TA.getNullPtrType();
1317 llvm::DIType TTy = getOrCreateType(T, Unit);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001318 llvm::Constant *V = nullptr;
David Blaikie38079fd2013-05-10 21:53:14 +00001319 // Special case member data pointer null values since they're actually -1
1320 // instead of zero.
1321 if (const MemberPointerType *MPT =
1322 dyn_cast<MemberPointerType>(T.getTypePtr()))
1323 // But treat member function pointers as simple zero integers because
1324 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1325 // CodeGen grows handling for values of non-null member function
1326 // pointers then perhaps we could remove this special case and rely on
1327 // EmitNullMemberPointer for member function pointers.
1328 if (MPT->isMemberDataPointer())
1329 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1330 if (!V)
1331 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1332 llvm::DITemplateValueParameter TVP =
Duncan P. N. Exon Smith2f68dad2014-11-15 00:24:50 +00001333 DBuilder.createTemplateValueParameter(TheCU, Name, TTy,
1334 cast<llvm::Constant>(V));
David Blaikie38079fd2013-05-10 21:53:14 +00001335 TemplateParams.push_back(TVP);
1336 } break;
David Blaikie47c11502013-06-22 18:59:18 +00001337 case TemplateArgument::Template: {
Eric Christophere7b87e52014-10-26 23:40:33 +00001338 llvm::DITemplateValueParameter
1339 TVP = DBuilder.createTemplateTemplateParameter(
1340 TheCU, Name, llvm::DIType(),
1341 TA.getAsTemplate().getAsTemplateDecl()->getQualifiedNameAsString());
David Blaikie47c11502013-06-22 18:59:18 +00001342 TemplateParams.push_back(TVP);
1343 } break;
1344 case TemplateArgument::Pack: {
Eric Christophere7b87e52014-10-26 23:40:33 +00001345 llvm::DITemplateValueParameter TVP = DBuilder.createTemplateParameterPack(
1346 TheCU, Name, llvm::DIType(),
1347 CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit));
David Blaikie47c11502013-06-22 18:59:18 +00001348 TemplateParams.push_back(TVP);
1349 } break;
David Majnemer5559d472013-08-24 08:21:10 +00001350 case TemplateArgument::Expression: {
1351 const Expr *E = TA.getAsExpr();
1352 QualType T = E->getType();
David Majnemer922ad9f2014-10-24 19:49:04 +00001353 if (E->isGLValue())
1354 T = CGM.getContext().getLValueReferenceType(T);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001355 llvm::Constant *V = CGM.EmitConstantExpr(E, T);
David Majnemer5559d472013-08-24 08:21:10 +00001356 assert(V && "Expression in template argument isn't constant");
1357 llvm::DIType TTy = getOrCreateType(T, Unit);
1358 llvm::DITemplateValueParameter TVP =
Duncan P. N. Exon Smith2f68dad2014-11-15 00:24:50 +00001359 DBuilder.createTemplateValueParameter(
1360 TheCU, Name, TTy, cast<llvm::Constant>(V->stripPointerCasts()));
David Majnemer5559d472013-08-24 08:21:10 +00001361 TemplateParams.push_back(TVP);
1362 } break;
David Blaikie2b93c542013-05-10 23:36:06 +00001363 // And the following should never occur:
David Blaikie38079fd2013-05-10 21:53:14 +00001364 case TemplateArgument::TemplateExpansion:
David Blaikie38079fd2013-05-10 21:53:14 +00001365 case TemplateArgument::Null:
1366 llvm_unreachable(
1367 "These argument types shouldn't exist in concrete types");
Guy Benyei11169dd2012-12-18 14:30:41 +00001368 }
1369 }
1370 return DBuilder.getOrCreateArray(TemplateParams);
1371}
1372
1373/// CollectFunctionTemplateParams - A helper function to collect debug
1374/// info for function template parameters.
Eric Christophere7b87e52014-10-26 23:40:33 +00001375llvm::DIArray CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1376 llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001377 if (FD->getTemplatedKind() ==
1378 FunctionDecl::TK_FunctionTemplateSpecialization) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001379 const TemplateParameterList *TList = FD->getTemplateSpecializationInfo()
1380 ->getTemplate()
1381 ->getTemplateParameters();
David Blaikie47c11502013-06-22 18:59:18 +00001382 return CollectTemplateParams(
1383 TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001384 }
1385 return llvm::DIArray();
1386}
1387
1388/// CollectCXXTemplateParams - A helper function to collect debug info for
1389/// template parameters.
Eric Christophere7b87e52014-10-26 23:40:33 +00001390llvm::DIArray CGDebugInfo::CollectCXXTemplateParams(
1391 const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile Unit) {
Adrian Prantl649f0302014-04-17 01:04:01 +00001392 // Always get the full list of parameters, not just the ones from
1393 // the specialization.
1394 TemplateParameterList *TPList =
Eric Christophere7b87e52014-10-26 23:40:33 +00001395 TSpecial->getSpecializedTemplate()->getTemplateParameters();
Adrian Prantl2c92e9c2014-04-17 00:30:48 +00001396 const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
David Blaikie47c11502013-06-22 18:59:18 +00001397 return CollectTemplateParams(TPList, TAList.asArray(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001398}
1399
1400/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1401llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1402 if (VTablePtrType.isValid())
1403 return VTablePtrType;
1404
1405 ASTContext &Context = CGM.getContext();
1406
1407 /* Function type */
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001408 llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
Manman Ren67f005e2014-07-28 22:24:34 +00001409 llvm::DITypeArray SElements = DBuilder.getOrCreateTypeArray(STy);
Guy Benyei11169dd2012-12-18 14:30:41 +00001410 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1411 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00001412 llvm::DIType vtbl_ptr_type =
1413 DBuilder.createPointerType(SubTy, Size, 0, "__vtbl_ptr_type");
Guy Benyei11169dd2012-12-18 14:30:41 +00001414 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1415 return VTablePtrType;
1416}
1417
1418/// getVTableName - Get vtable name for the given Class.
1419StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +00001420 // Copy the gdb compatible name on the side and use its reference.
1421 return internString("_vptr$", RD->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00001422}
1423
Guy Benyei11169dd2012-12-18 14:30:41 +00001424/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1425/// debug info entry in EltTys vector.
Eric Christophere7b87e52014-10-26 23:40:33 +00001426void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001427 SmallVectorImpl<llvm::Metadata *> &EltTys) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001428 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1429
1430 // If there is a primary base then it will hold vtable info.
1431 if (RL.getPrimaryBase())
1432 return;
1433
1434 // If this class is not dynamic then there is not any vtable info to collect.
1435 if (!RD->isDynamicClass())
1436 return;
1437
1438 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00001439 llvm::DIType VPTR = DBuilder.createMemberType(
1440 Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1441 llvm::DIDescriptor::FlagArtificial, getOrCreateVTablePtrType(Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001442 EltTys.push_back(VPTR);
1443}
1444
Eric Christopherb2a008c2013-05-16 00:45:12 +00001445/// getOrCreateRecordType - Emit record type's standalone debug info.
1446llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei11169dd2012-12-18 14:30:41 +00001447 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001448 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001449 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1450 return T;
1451}
1452
1453/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1454/// debug info.
1455llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherc0c5d462013-02-21 22:35:08 +00001456 SourceLocation Loc) {
Eric Christopher75e17682013-05-16 00:45:23 +00001457 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00001458 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantl73409ce2013-03-11 18:33:46 +00001459 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00001460 return T;
1461}
1462
David Blaikie483a9da2014-05-06 18:35:21 +00001463void CGDebugInfo::completeType(const EnumDecl *ED) {
1464 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1465 return;
1466 QualType Ty = CGM.getContext().getEnumType(ED);
Eric Christophere7b87e52014-10-26 23:40:33 +00001467 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikie483a9da2014-05-06 18:35:21 +00001468 auto I = TypeCache.find(TyPtr);
1469 if (I == TypeCache.end() ||
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001470 !llvm::DIType(cast<llvm::MDNode>(I->second)).isForwardDecl())
David Blaikie483a9da2014-05-06 18:35:21 +00001471 return;
1472 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<EnumType>());
1473 assert(!Res.isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001474 TypeCache[TyPtr].reset(Res);
David Blaikie483a9da2014-05-06 18:35:21 +00001475}
1476
David Blaikieb2e86eb2013-08-15 20:49:17 +00001477void CGDebugInfo::completeType(const RecordDecl *RD) {
1478 if (DebugKind > CodeGenOptions::LimitedDebugInfo ||
1479 !CGM.getLangOpts().CPlusPlus)
1480 completeRequiredType(RD);
1481}
1482
1483void CGDebugInfo::completeRequiredType(const RecordDecl *RD) {
David Blaikie0856f662014-03-04 22:01:08 +00001484 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
1485 return;
1486
David Blaikie6943dea2013-08-20 01:28:15 +00001487 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1488 if (CXXDecl->isDynamicClass())
1489 return;
1490
David Blaikieb2e86eb2013-08-15 20:49:17 +00001491 QualType Ty = CGM.getContext().getRecordType(RD);
1492 llvm::DIType T = getTypeOrNull(Ty);
David Blaikie6943dea2013-08-20 01:28:15 +00001493 if (T && T.isForwardDecl())
1494 completeClassData(RD);
1495}
1496
1497void CGDebugInfo::completeClassData(const RecordDecl *RD) {
1498 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
Michael Gottesman349542b2013-08-19 18:46:16 +00001499 return;
David Blaikie6943dea2013-08-20 01:28:15 +00001500 QualType Ty = CGM.getContext().getRecordType(RD);
Eric Christophere7b87e52014-10-26 23:40:33 +00001501 void *TyPtr = Ty.getAsOpaquePtr();
David Blaikieef8a9512014-05-05 23:23:53 +00001502 auto I = TypeCache.find(TyPtr);
1503 if (I != TypeCache.end() &&
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001504 !llvm::DIType(cast<llvm::MDNode>(I->second)).isForwardDecl())
David Blaikieb2e86eb2013-08-15 20:49:17 +00001505 return;
1506 llvm::DIType Res = CreateTypeDefinition(Ty->castAs<RecordType>());
1507 assert(!Res.isForwardDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001508 TypeCache[TyPtr].reset(Res);
David Blaikieb2e86eb2013-08-15 20:49:17 +00001509}
1510
David Blaikie0e716b42014-03-03 23:48:23 +00001511static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I,
1512 CXXRecordDecl::method_iterator End) {
1513 for (; I != End; ++I)
1514 if (FunctionDecl *Tmpl = I->getInstantiatedFromMemberFunction())
David Blaikief7f21852014-03-04 03:08:14 +00001515 if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
1516 !I->getMemberSpecializationInfo()->isExplicitSpecialization())
David Blaikie0e716b42014-03-03 23:48:23 +00001517 return true;
1518 return false;
1519}
1520
1521static bool shouldOmitDefinition(CodeGenOptions::DebugInfoKind DebugKind,
1522 const RecordDecl *RD,
1523 const LangOptions &LangOpts) {
1524 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
1525 return false;
1526
1527 if (!LangOpts.CPlusPlus)
1528 return false;
1529
1530 if (!RD->isCompleteDefinitionRequired())
1531 return true;
1532
1533 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1534
1535 if (!CXXDecl)
1536 return false;
1537
1538 if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass())
1539 return true;
1540
1541 TemplateSpecializationKind Spec = TSK_Undeclared;
1542 if (const ClassTemplateSpecializationDecl *SD =
1543 dyn_cast<ClassTemplateSpecializationDecl>(RD))
1544 Spec = SD->getSpecializationKind();
1545
1546 if (Spec == TSK_ExplicitInstantiationDeclaration &&
1547 hasExplicitMemberDefinition(CXXDecl->method_begin(),
1548 CXXDecl->method_end()))
1549 return true;
1550
1551 return false;
1552}
1553
Guy Benyei11169dd2012-12-18 14:30:41 +00001554/// CreateType - get structure or union type.
David Blaikie99dab3b2013-09-04 22:03:57 +00001555llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001556 RecordDecl *RD = Ty->getDecl();
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001557 llvm::DICompositeType T(getTypeOrNull(QualType(Ty, 0)));
David Blaikie0e716b42014-03-03 23:48:23 +00001558 if (T || shouldOmitDefinition(DebugKind, RD, CGM.getLangOpts())) {
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001559 if (!T)
David Blaikie65ec94e2014-02-18 20:52:05 +00001560 T = getOrCreateRecordFwdDecl(
1561 Ty, getContextDescriptor(cast<Decl>(RD->getDeclContext())));
David Blaikie3b1cc9b2013-09-06 06:45:04 +00001562 return T;
David Blaikiee36464c2013-06-05 05:32:23 +00001563 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001564
David Blaikieb2e86eb2013-08-15 20:49:17 +00001565 return CreateTypeDefinition(Ty);
1566}
1567
1568llvm::DIType CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
1569 RecordDecl *RD = Ty->getDecl();
1570
Guy Benyei11169dd2012-12-18 14:30:41 +00001571 // Get overall information about the record type for the debug info.
1572 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1573
1574 // Records and classes and unions can all be recursive. To handle them, we
1575 // first generate a debug descriptor for the struct as a forward declaration.
1576 // Then (if it is a definition) we go through and get debug info for all of
1577 // its members. Finally, we create a descriptor for the complete type (which
1578 // may refer to the forward decl if the struct is recursive) and replace all
1579 // uses of the forward declaration with the final definition.
1580
David Blaikie4a2b5ef2013-08-12 22:24:20 +00001581 llvm::DICompositeType FwdDecl(getOrCreateLimitedType(Ty, DefUnit));
Manman Ren0d441f12013-07-02 19:01:53 +00001582 assert(FwdDecl.isCompositeType() &&
David Blaikie469f0792013-05-22 23:22:42 +00001583 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei11169dd2012-12-18 14:30:41 +00001584
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001585 const RecordDecl *D = RD->getDefinition();
1586 if (!D || !D->isCompleteDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00001587 return FwdDecl;
1588
David Blaikieadfbf992013-08-18 16:55:33 +00001589 if (const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
1590 CollectContainingType(CXXDecl, FwdDecl);
1591
Guy Benyei11169dd2012-12-18 14:30:41 +00001592 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001593 LexicalBlockStack.emplace_back(&*FwdDecl);
1594 RegionMap[Ty->getDecl()].reset(FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001595
Guy Benyei11169dd2012-12-18 14:30:41 +00001596 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001597 SmallVector<llvm::Metadata *, 16> EltTys;
David Blaikie6943dea2013-08-20 01:28:15 +00001598 // what about nested types?
Guy Benyei11169dd2012-12-18 14:30:41 +00001599
1600 // Note: The split of CXXDecl information here is intentional, the
1601 // gdb tests will depend on a certain ordering at printout. The debug
1602 // information offsets are still correct if we merge them all together
1603 // though.
1604 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1605 if (CXXDecl) {
1606 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1607 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1608 }
1609
Eric Christopher91a31902013-01-16 01:22:32 +00001610 // Collect data fields (including static variables and any initializers).
Guy Benyei11169dd2012-12-18 14:30:41 +00001611 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
Eric Christopher2df080e2013-10-11 18:16:51 +00001612 if (CXXDecl)
Guy Benyei11169dd2012-12-18 14:30:41 +00001613 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001614
1615 LexicalBlockStack.pop_back();
1616 RegionMap.erase(Ty->getDecl());
1617
1618 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001619 DBuilder.replaceArrays(FwdDecl, Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00001620
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001621 if (FwdDecl->isTemporary())
1622 FwdDecl = llvm::DICompositeType(llvm::MDNode::replaceWithPermanent(
1623 llvm::TempMDNode(FwdDecl.get())));
1624
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001625 RegionMap[Ty->getDecl()].reset(FwdDecl);
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001626 return FwdDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001627}
1628
1629/// CreateType - get objective-c object type.
1630llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1631 llvm::DIFile Unit) {
1632 // Ignore protocols.
1633 return getOrCreateType(Ty->getBaseType(), Unit);
1634}
1635
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001636/// \return true if Getter has the default name for the property PD.
1637static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1638 const ObjCMethodDecl *Getter) {
1639 assert(PD);
1640 if (!Getter)
1641 return true;
1642
1643 assert(Getter->getDeclName().isObjCZeroArgSelector());
1644 return PD->getName() ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001645 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001646}
1647
1648/// \return true if Setter has the default name for the property PD.
1649static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1650 const ObjCMethodDecl *Setter) {
1651 assert(PD);
1652 if (!Setter)
1653 return true;
1654
1655 assert(Setter->getDeclName().isObjCOneArgSelector());
Adrian Prantla4ce9062013-06-07 22:29:12 +00001656 return SelectorTable::constructSetterName(PD->getName()) ==
Eric Christophere7b87e52014-10-26 23:40:33 +00001657 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
Adrian Prantlb8fad1a2013-06-07 01:10:45 +00001658}
1659
Guy Benyei11169dd2012-12-18 14:30:41 +00001660/// CreateType - get objective-c interface type.
1661llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1662 llvm::DIFile Unit) {
1663 ObjCInterfaceDecl *ID = Ty->getDecl();
1664 if (!ID)
1665 return llvm::DIType();
1666
1667 // Get overall information about the record type for the debug info.
1668 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1669 unsigned Line = getLineNumber(ID->getLocation());
Ed Masteda706022014-05-07 12:49:30 +00001670 llvm::dwarf::SourceLanguage RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001671
1672 // If this is just a forward declaration return a special forward-declaration
1673 // debug type since we won't be able to lay out the entire type.
1674 ObjCInterfaceDecl *Def = ID->getDefinition();
David Blaikieef8a9512014-05-05 23:23:53 +00001675 if (!Def || !Def->getImplementation()) {
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001676 llvm::DIType FwdDecl = DBuilder.createReplaceableCompositeType(
David Blaikief427b002014-05-06 03:42:01 +00001677 llvm::dwarf::DW_TAG_structure_type, ID->getName(), TheCU, DefUnit, Line,
1678 RuntimeLang);
David Blaikieef8a9512014-05-05 23:23:53 +00001679 ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001680 return FwdDecl;
1681 }
1682
David Blaikieef8a9512014-05-05 23:23:53 +00001683 return CreateTypeDefinition(Ty, Unit);
1684}
1685
Eric Christophere7b87e52014-10-26 23:40:33 +00001686llvm::DIType CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
1687 llvm::DIFile Unit) {
David Blaikieef8a9512014-05-05 23:23:53 +00001688 ObjCInterfaceDecl *ID = Ty->getDecl();
1689 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1690 unsigned Line = getLineNumber(ID->getLocation());
1691 unsigned RuntimeLang = TheCU.getLanguage();
Guy Benyei11169dd2012-12-18 14:30:41 +00001692
1693 // Bit size, align and offset of the type.
1694 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1695 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1696
1697 unsigned Flags = 0;
1698 if (ID->getImplementation())
1699 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1700
Eric Christophere7b87e52014-10-26 23:40:33 +00001701 llvm::DICompositeType RealDecl = DBuilder.createStructType(
1702 Unit, ID->getName(), DefUnit, Line, Size, Align, Flags, llvm::DIType(),
1703 llvm::DIArray(), RuntimeLang);
Guy Benyei11169dd2012-12-18 14:30:41 +00001704
David Blaikieef8a9512014-05-05 23:23:53 +00001705 QualType QTy(Ty, 0);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001706 TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001707
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001708 // Push the struct on region stack.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001709 LexicalBlockStack.emplace_back(static_cast<llvm::MDNode *>(RealDecl));
1710 RegionMap[Ty->getDecl()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001711
1712 // Convert all the elements.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001713 SmallVector<llvm::Metadata *, 16> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00001714
1715 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1716 if (SClass) {
1717 llvm::DIType SClassTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001718 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001719 if (!SClassTy.isValid())
1720 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001721
Eric Christophere7b87e52014-10-26 23:40:33 +00001722 llvm::DIType InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00001723 EltTys.push_back(InhTag);
1724 }
1725
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001726 // Create entries for all of the properties.
Aaron Ballmand174edf2014-03-13 19:11:50 +00001727 for (const auto *PD : ID->properties()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001728 SourceLocation Loc = PD->getLocation();
1729 llvm::DIFile PUnit = getOrCreateFile(Loc);
1730 unsigned PLine = getLineNumber(Loc);
1731 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1732 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001733 llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
1734 PD->getName(), PUnit, PLine,
1735 hasDefaultGetterName(PD, Getter) ? ""
1736 : getSelectorName(PD->getGetterName()),
1737 hasDefaultSetterName(PD, Setter) ? ""
1738 : getSelectorName(PD->getSetterName()),
1739 PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001740 EltTys.push_back(PropertyNode);
1741 }
1742
1743 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1744 unsigned FieldNo = 0;
1745 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1746 Field = Field->getNextIvar(), ++FieldNo) {
1747 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1748 if (!FieldTy.isValid())
1749 return llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001750
Guy Benyei11169dd2012-12-18 14:30:41 +00001751 StringRef FieldName = Field->getName();
1752
1753 // Ignore unnamed fields.
1754 if (FieldName.empty())
1755 continue;
1756
1757 // Get the location for the field.
1758 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1759 unsigned FieldLine = getLineNumber(Field->getLocation());
1760 QualType FType = Field->getType();
1761 uint64_t FieldSize = 0;
1762 unsigned FieldAlign = 0;
1763
1764 if (!FType->isIncompleteArrayType()) {
1765
1766 // Bit size, align and offset of the type.
1767 FieldSize = Field->isBitField()
Eric Christopher35f1f9f2013-07-14 21:00:07 +00001768 ? Field->getBitWidthValue(CGM.getContext())
1769 : CGM.getContext().getTypeSize(FType);
Guy Benyei11169dd2012-12-18 14:30:41 +00001770 FieldAlign = CGM.getContext().getTypeAlign(FType);
1771 }
1772
1773 uint64_t FieldOffset;
1774 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1775 // We don't know the runtime offset of an ivar if we're using the
1776 // non-fragile ABI. For bitfields, use the bit offset into the first
1777 // byte of storage of the bitfield. For other fields, use zero.
1778 if (Field->isBitField()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001779 FieldOffset =
1780 CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
Guy Benyei11169dd2012-12-18 14:30:41 +00001781 FieldOffset %= CGM.getContext().getCharWidth();
1782 } else {
1783 FieldOffset = 0;
1784 }
1785 } else {
1786 FieldOffset = RL.getFieldOffset(FieldNo);
1787 }
1788
1789 unsigned Flags = 0;
1790 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1791 Flags = llvm::DIDescriptor::FlagProtected;
1792 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1793 Flags = llvm::DIDescriptor::FlagPrivate;
Adrian Prantl21361fb2014-08-29 22:44:27 +00001794 else if (Field->getAccessControl() == ObjCIvarDecl::Public)
1795 Flags = llvm::DIDescriptor::FlagPublic;
Guy Benyei11169dd2012-12-18 14:30:41 +00001796
Craig Topper8a13c412014-05-21 05:09:00 +00001797 llvm::MDNode *PropertyNode = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001798 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopherb2a008c2013-05-16 00:45:12 +00001799 if (ObjCPropertyImplDecl *PImpD =
Eric Christophere7b87e52014-10-26 23:40:33 +00001800 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001801 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherc0c5d462013-02-21 22:35:08 +00001802 SourceLocation Loc = PD->getLocation();
1803 llvm::DIFile PUnit = getOrCreateFile(Loc);
1804 unsigned PLine = getLineNumber(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001805 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1806 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00001807 PropertyNode = DBuilder.createObjCProperty(
1808 PD->getName(), PUnit, PLine,
1809 hasDefaultGetterName(PD, Getter) ? "" : getSelectorName(
1810 PD->getGetterName()),
1811 hasDefaultSetterName(PD, Setter) ? "" : getSelectorName(
1812 PD->getSetterName()),
1813 PD->getPropertyAttributes(),
1814 getOrCreateType(PD->getType(), PUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00001815 }
1816 }
1817 }
Eric Christophere7b87e52014-10-26 23:40:33 +00001818 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
1819 FieldSize, FieldAlign, FieldOffset, Flags,
1820 FieldTy, PropertyNode);
Guy Benyei11169dd2012-12-18 14:30:41 +00001821 EltTys.push_back(FieldTy);
1822 }
1823
1824 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00001825 DBuilder.replaceArrays(RealDecl, Elements);
Adrian Prantla03a85a2013-03-06 22:03:30 +00001826
Guy Benyei11169dd2012-12-18 14:30:41 +00001827 LexicalBlockStack.pop_back();
Eric Christopher5c7ee8b2013-04-02 22:59:11 +00001828 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00001829}
1830
1831llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1832 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1833 int64_t Count = Ty->getNumElements();
1834 if (Count == 0)
1835 // If number of elements are not known then this is an unbounded array.
1836 // Use Count == -1 to express such arrays.
1837 Count = -1;
1838
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001839 llvm::Metadata *Subscript = DBuilder.getOrCreateSubrange(0, Count);
Guy Benyei11169dd2012-12-18 14:30:41 +00001840 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1841
1842 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1843 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1844
1845 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1846}
1847
Eric Christophere7b87e52014-10-26 23:40:33 +00001848llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001849 uint64_t Size;
1850 uint64_t Align;
1851
1852 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1853 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1854 Size = 0;
1855 Align =
Eric Christophere7b87e52014-10-26 23:40:33 +00001856 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Guy Benyei11169dd2012-12-18 14:30:41 +00001857 } else if (Ty->isIncompleteArrayType()) {
1858 Size = 0;
1859 if (Ty->getElementType()->isIncompleteType())
1860 Align = 0;
1861 else
1862 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikief03b2e82013-05-09 20:48:12 +00001863 } else if (Ty->isIncompleteType()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001864 Size = 0;
1865 Align = 0;
1866 } else {
1867 // Size and align of the whole array, not the element type.
1868 Size = CGM.getContext().getTypeSize(Ty);
1869 Align = CGM.getContext().getTypeAlign(Ty);
1870 }
1871
1872 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1873 // interior arrays, do we care? Why aren't nested arrays represented the
1874 // obvious/recursive way?
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001875 SmallVector<llvm::Metadata *, 8> Subscripts;
Guy Benyei11169dd2012-12-18 14:30:41 +00001876 QualType EltTy(Ty, 0);
1877 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1878 // If the number of elements is known, then count is that number. Otherwise,
1879 // it's -1. This allows us to represent a subrange with an array of 0
1880 // elements, like this:
1881 //
1882 // struct foo {
1883 // int x[0];
1884 // };
Eric Christophere7b87e52014-10-26 23:40:33 +00001885 int64_t Count = -1; // Count == -1 is an unbounded array.
Guy Benyei11169dd2012-12-18 14:30:41 +00001886 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1887 Count = CAT->getSize().getZExtValue();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001888
Guy Benyei11169dd2012-12-18 14:30:41 +00001889 // FIXME: Verify this is right for VLAs.
1890 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1891 EltTy = Ty->getElementType();
1892 }
1893
1894 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1895
Eric Christophere7b87e52014-10-26 23:40:33 +00001896 llvm::DIType DbgTy = DBuilder.createArrayType(
1897 Size, Align, getOrCreateType(EltTy, Unit), SubscriptArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00001898 return DbgTy;
1899}
1900
Eric Christopherb2a008c2013-05-16 00:45:12 +00001901llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001902 llvm::DIFile Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001903 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
1904 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001905}
1906
Eric Christopherb2a008c2013-05-16 00:45:12 +00001907llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001908 llvm::DIFile Unit) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001909 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
1910 Ty->getPointeeType(), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00001911}
1912
Eric Christopherb2a008c2013-05-16 00:45:12 +00001913llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei11169dd2012-12-18 14:30:41 +00001914 llvm::DIFile U) {
David Blaikie2c705ca2013-01-19 19:20:56 +00001915 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1916 if (!Ty->getPointeeType()->isFunctionType())
1917 return DBuilder.createMemberPointerType(
Adrian Prantlee24e142014-12-23 19:11:54 +00001918 getOrCreateType(Ty->getPointeeType(), U), ClassType,
Adrian Prantl0772dbd2015-01-07 17:49:30 +00001919 CGM.getContext().getTypeSize(Ty));
Adrian Prantl0866acd2013-12-19 01:38:47 +00001920
1921 const FunctionProtoType *FPT =
Eric Christophere7b87e52014-10-26 23:40:33 +00001922 Ty->getPointeeType()->getAs<FunctionProtoType>();
1923 return DBuilder.createMemberPointerType(
1924 getOrCreateInstanceMethodType(CGM.getContext().getPointerType(QualType(
1925 Ty->getClass(), FPT->getTypeQuals())),
1926 FPT, U),
Adrian Prantl0772dbd2015-01-07 17:49:30 +00001927 ClassType, CGM.getContext().getTypeSize(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00001928}
1929
Eric Christophere7b87e52014-10-26 23:40:33 +00001930llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001931 // Ignore the atomic wrapping
1932 // FIXME: What is the correct representation?
1933 return getOrCreateType(Ty->getValueType(), U);
1934}
1935
1936/// CreateEnumType - get enumeration type.
Manman Ren501ecf92013-08-28 21:46:36 +00001937llvm::DIType CGDebugInfo::CreateEnumType(const EnumType *Ty) {
Manman Ren1b457022013-08-28 21:20:28 +00001938 const EnumDecl *ED = Ty->getDecl();
Guy Benyei11169dd2012-12-18 14:30:41 +00001939 uint64_t Size = 0;
1940 uint64_t Align = 0;
1941 if (!ED->getTypeForDecl()->isIncompleteType()) {
1942 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1943 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1944 }
1945
Manman Rene0064d82013-08-29 23:19:58 +00001946 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1947
Guy Benyei11169dd2012-12-18 14:30:41 +00001948 // If this is just a forward declaration, construct an appropriately
1949 // marked node and just return it.
1950 if (!ED->getDefinition()) {
1951 llvm::DIDescriptor EDContext;
1952 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1953 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1954 unsigned Line = getLineNumber(ED->getLocation());
1955 StringRef EDName = ED->getName();
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001956 llvm::DIType RetTy = DBuilder.createReplaceableCompositeType(
David Blaikief427b002014-05-06 03:42:01 +00001957 llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
Adrian Prantl5f66bae2015-02-11 17:45:15 +00001958 0, Size, Align, llvm::DIDescriptor::FlagFwdDecl, FullName);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001959 ReplaceMap.emplace_back(
1960 std::piecewise_construct, std::make_tuple(Ty),
1961 std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
David Blaikief427b002014-05-06 03:42:01 +00001962 return RetTy;
Guy Benyei11169dd2012-12-18 14:30:41 +00001963 }
1964
David Blaikie483a9da2014-05-06 18:35:21 +00001965 return CreateTypeDefinition(Ty);
1966}
1967
1968llvm::DIType CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
1969 const EnumDecl *ED = Ty->getDecl();
1970 uint64_t Size = 0;
1971 uint64_t Align = 0;
1972 if (!ED->getTypeForDecl()->isIncompleteType()) {
1973 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1974 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1975 }
1976
1977 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
1978
Guy Benyei11169dd2012-12-18 14:30:41 +00001979 // Create DIEnumerator elements for each enumerator.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001980 SmallVector<llvm::Metadata *, 16> Enumerators;
Guy Benyei11169dd2012-12-18 14:30:41 +00001981 ED = ED->getDefinition();
Aaron Ballman23a6dcb2014-03-08 18:45:14 +00001982 for (const auto *Enum : ED->enumerators()) {
Eric Christophere7b87e52014-10-26 23:40:33 +00001983 Enumerators.push_back(DBuilder.createEnumerator(
1984 Enum->getName(), Enum->getInitVal().getSExtValue()));
Guy Benyei11169dd2012-12-18 14:30:41 +00001985 }
1986
1987 // Return a CompositeType for the enum itself.
1988 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1989
1990 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1991 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00001992 llvm::DIDescriptor EnumContext =
Eric Christophere7b87e52014-10-26 23:40:33 +00001993 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1994 llvm::DIType ClassTy = ED->isFixed()
1995 ? getOrCreateType(ED->getIntegerType(), DefUnit)
1996 : llvm::DIType();
Eric Christopherb2a008c2013-05-16 00:45:12 +00001997 llvm::DIType DbgTy =
Eric Christophere7b87e52014-10-26 23:40:33 +00001998 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1999 Size, Align, EltArray, ClassTy, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002000 return DbgTy;
2001}
2002
David Blaikie05491062013-01-21 04:37:12 +00002003static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
2004 Qualifiers Quals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002005 do {
Adrian Prantl179af902013-09-26 21:35:50 +00002006 Qualifiers InnerQuals = T.getLocalQualifiers();
2007 // Qualifiers::operator+() doesn't like it if you add a Qualifier
2008 // that is already there.
2009 Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2010 Quals += InnerQuals;
Guy Benyei11169dd2012-12-18 14:30:41 +00002011 QualType LastT = T;
2012 switch (T->getTypeClass()) {
2013 default:
David Blaikie05491062013-01-21 04:37:12 +00002014 return C.getQualifiedType(T.getTypePtr(), Quals);
David Blaikief1b382e2014-04-06 17:14:06 +00002015 case Type::TemplateSpecialization: {
2016 const auto *Spec = cast<TemplateSpecializationType>(T);
2017 if (Spec->isTypeAlias())
2018 return C.getQualifiedType(T.getTypePtr(), Quals);
2019 T = Spec->desugar();
Eric Christophere7b87e52014-10-26 23:40:33 +00002020 break;
2021 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002022 case Type::TypeOfExpr:
2023 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2024 break;
2025 case Type::TypeOf:
2026 T = cast<TypeOfType>(T)->getUnderlyingType();
2027 break;
2028 case Type::Decltype:
2029 T = cast<DecltypeType>(T)->getUnderlyingType();
2030 break;
2031 case Type::UnaryTransform:
2032 T = cast<UnaryTransformType>(T)->getUnderlyingType();
2033 break;
2034 case Type::Attributed:
2035 T = cast<AttributedType>(T)->getEquivalentType();
2036 break;
2037 case Type::Elaborated:
2038 T = cast<ElaboratedType>(T)->getNamedType();
2039 break;
2040 case Type::Paren:
2041 T = cast<ParenType>(T)->getInnerType();
2042 break;
David Blaikie05491062013-01-21 04:37:12 +00002043 case Type::SubstTemplateTypeParm:
Guy Benyei11169dd2012-12-18 14:30:41 +00002044 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002045 break;
2046 case Type::Auto:
David Blaikie22c460a02013-05-24 21:24:35 +00002047 QualType DT = cast<AutoType>(T)->getDeducedType();
David Blaikie42edade2014-11-11 20:44:45 +00002048 assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
David Blaikie22c460a02013-05-24 21:24:35 +00002049 T = DT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002050 break;
2051 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002052
Guy Benyei11169dd2012-12-18 14:30:41 +00002053 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumi3e0a3632013-01-21 10:51:28 +00002054 (void)LastT;
Guy Benyei11169dd2012-12-18 14:30:41 +00002055 } while (true);
2056}
2057
Eric Christopher0fdcb312013-05-16 00:52:20 +00002058/// getType - Get the type from the cache or return null type if it doesn't
2059/// exist.
Guy Benyei11169dd2012-12-18 14:30:41 +00002060llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
2061
2062 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002063 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002064
David Blaikief427b002014-05-06 03:42:01 +00002065 auto it = TypeCache.find(Ty.getAsOpaquePtr());
Guy Benyei11169dd2012-12-18 14:30:41 +00002066 if (it != TypeCache.end()) {
2067 // Verify that the debug info still exists.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002068 if (llvm::Metadata *V = it->second)
Guy Benyei11169dd2012-12-18 14:30:41 +00002069 return llvm::DIType(cast<llvm::MDNode>(V));
2070 }
2071
2072 return llvm::DIType();
2073}
2074
David Blaikie0e716b42014-03-03 23:48:23 +00002075void CGDebugInfo::completeTemplateDefinition(
2076 const ClassTemplateSpecializationDecl &SD) {
David Blaikie0856f662014-03-04 22:01:08 +00002077 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2078 return;
2079
David Blaikie0e716b42014-03-03 23:48:23 +00002080 completeClassData(&SD);
2081 // In case this type has no member function definitions being emitted, ensure
2082 // it is retained
2083 RetainedTypes.push_back(CGM.getContext().getRecordType(&SD).getAsOpaquePtr());
2084}
2085
Guy Benyei11169dd2012-12-18 14:30:41 +00002086/// getOrCreateType - Get the type from the cache or create a new
2087/// one if necessary.
David Blaikie99dab3b2013-09-04 22:03:57 +00002088llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002089 if (Ty.isNull())
2090 return llvm::DIType();
2091
2092 // Unwrap the type as needed for debug information.
David Blaikie05491062013-01-21 04:37:12 +00002093 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00002094
David Blaikieef8a9512014-05-05 23:23:53 +00002095 if (llvm::DIType T = getTypeOrNull(Ty))
Guy Benyei11169dd2012-12-18 14:30:41 +00002096 return T;
2097
2098 // Otherwise create the type.
David Blaikie99dab3b2013-09-04 22:03:57 +00002099 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Eric Christophere7b87e52014-10-26 23:40:33 +00002100 void *TyPtr = Ty.getAsOpaquePtr();
Adrian Prantl73409ce2013-03-11 18:33:46 +00002101
2102 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002103 TypeCache[TyPtr].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002104
Guy Benyei11169dd2012-12-18 14:30:41 +00002105 return Res;
2106}
2107
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002108/// Currently the checksum of an interface includes the number of
2109/// ivars and property accessors.
Eric Christopher1ecc5632013-06-07 22:54:39 +00002110unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl *ID) {
Adrian Prantl817bbb32013-06-07 01:10:48 +00002111 // The assumption is that the number of ivars can only increase
2112 // monotonically, so it is safe to just use their current number as
2113 // a checksum.
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002114 unsigned Sum = 0;
2115 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
Craig Topper8a13c412014-05-21 05:09:00 +00002116 Ivar != nullptr; Ivar = Ivar->getNextIvar())
Adrian Prantlc4de1ef2013-06-07 01:10:41 +00002117 ++Sum;
2118
2119 return Sum;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002120}
2121
2122ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
2123 switch (Ty->getTypeClass()) {
2124 case Type::ObjCObjectPointer:
Eric Christophere7b87e52014-10-26 23:40:33 +00002125 return getObjCInterfaceDecl(
2126 cast<ObjCObjectPointerType>(Ty)->getPointeeType());
Adrian Prantla03a85a2013-03-06 22:03:30 +00002127 case Type::ObjCInterface:
2128 return cast<ObjCInterfaceType>(Ty)->getDecl();
2129 default:
Craig Topper8a13c412014-05-21 05:09:00 +00002130 return nullptr;
Adrian Prantla03a85a2013-03-06 22:03:30 +00002131 }
2132}
2133
Guy Benyei11169dd2012-12-18 14:30:41 +00002134/// CreateTypeNode - Create a new debug type node.
David Blaikie99dab3b2013-09-04 22:03:57 +00002135llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002136 // Handle qualifiers, which recursively handles what they refer to.
2137 if (Ty.hasLocalQualifiers())
David Blaikie99dab3b2013-09-04 22:03:57 +00002138 return CreateQualifiedType(Ty, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002139
Guy Benyei11169dd2012-12-18 14:30:41 +00002140 // Work out details of type.
2141 switch (Ty->getTypeClass()) {
2142#define TYPE(Class, Base)
2143#define ABSTRACT_TYPE(Class, Base)
2144#define NON_CANONICAL_TYPE(Class, Base)
2145#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2146#include "clang/AST/TypeNodes.def"
2147 llvm_unreachable("Dependent types cannot show up in debug information");
2148
2149 case Type::ExtVector:
2150 case Type::Vector:
2151 return CreateType(cast<VectorType>(Ty), Unit);
2152 case Type::ObjCObjectPointer:
2153 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2154 case Type::ObjCObject:
2155 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2156 case Type::ObjCInterface:
2157 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2158 case Type::Builtin:
2159 return CreateType(cast<BuiltinType>(Ty));
2160 case Type::Complex:
2161 return CreateType(cast<ComplexType>(Ty));
2162 case Type::Pointer:
2163 return CreateType(cast<PointerType>(Ty), Unit);
Reid Kleckner0503a872013-12-05 01:23:43 +00002164 case Type::Adjusted:
Reid Kleckner8a365022013-06-24 17:51:48 +00002165 case Type::Decayed:
Reid Kleckner0503a872013-12-05 01:23:43 +00002166 // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
Reid Kleckner8a365022013-06-24 17:51:48 +00002167 return CreateType(
Reid Kleckner0503a872013-12-05 01:23:43 +00002168 cast<PointerType>(cast<AdjustedType>(Ty)->getAdjustedType()), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002169 case Type::BlockPointer:
2170 return CreateType(cast<BlockPointerType>(Ty), Unit);
2171 case Type::Typedef:
David Blaikie99dab3b2013-09-04 22:03:57 +00002172 return CreateType(cast<TypedefType>(Ty), Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002173 case Type::Record:
David Blaikie99dab3b2013-09-04 22:03:57 +00002174 return CreateType(cast<RecordType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002175 case Type::Enum:
Manman Ren1b457022013-08-28 21:20:28 +00002176 return CreateEnumType(cast<EnumType>(Ty));
Guy Benyei11169dd2012-12-18 14:30:41 +00002177 case Type::FunctionProto:
2178 case Type::FunctionNoProto:
2179 return CreateType(cast<FunctionType>(Ty), Unit);
2180 case Type::ConstantArray:
2181 case Type::VariableArray:
2182 case Type::IncompleteArray:
2183 return CreateType(cast<ArrayType>(Ty), Unit);
2184
2185 case Type::LValueReference:
2186 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2187 case Type::RValueReference:
2188 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2189
2190 case Type::MemberPointer:
2191 return CreateType(cast<MemberPointerType>(Ty), Unit);
2192
2193 case Type::Atomic:
2194 return CreateType(cast<AtomicType>(Ty), Unit);
2195
Guy Benyei11169dd2012-12-18 14:30:41 +00002196 case Type::TemplateSpecialization:
David Blaikief1b382e2014-04-06 17:14:06 +00002197 return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2198
David Blaikie42edade2014-11-11 20:44:45 +00002199 case Type::Auto:
David Blaikief1b382e2014-04-06 17:14:06 +00002200 case Type::Attributed:
Guy Benyei11169dd2012-12-18 14:30:41 +00002201 case Type::Elaborated:
2202 case Type::Paren:
2203 case Type::SubstTemplateTypeParm:
2204 case Type::TypeOfExpr:
2205 case Type::TypeOf:
2206 case Type::Decltype:
2207 case Type::UnaryTransform:
David Blaikie66ed89d2013-07-13 21:08:08 +00002208 case Type::PackExpansion:
David Blaikie22c460a02013-05-24 21:24:35 +00002209 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002210 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002211
David Blaikie42edade2014-11-11 20:44:45 +00002212 llvm_unreachable("type should have been unwrapped!");
Guy Benyei11169dd2012-12-18 14:30:41 +00002213}
2214
2215/// getOrCreateLimitedType - Get the type from the cache or create a new
2216/// limited type if necessary.
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002217llvm::DIType CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
Eric Christopherc0c5d462013-02-21 22:35:08 +00002218 llvm::DIFile Unit) {
David Blaikie4a2b5ef2013-08-12 22:24:20 +00002219 QualType QTy(Ty, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002220
David Blaikie8d5e1282013-08-20 21:03:29 +00002221 llvm::DICompositeType T(getTypeOrNull(QTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002222
2223 // We may have cached a forward decl when we could have created
2224 // a non-forward decl. Go ahead and create a non-forward decl
2225 // now.
Eric Christophere7b87e52014-10-26 23:40:33 +00002226 if (T && !T.isForwardDecl())
2227 return T;
Guy Benyei11169dd2012-12-18 14:30:41 +00002228
2229 // Otherwise create the type.
David Blaikie8d5e1282013-08-20 21:03:29 +00002230 llvm::DICompositeType Res = CreateLimitedType(Ty);
2231
2232 // Propagate members from the declaration to the definition
2233 // CreateType(const RecordType*) will overwrite this with the members in the
2234 // correct order if the full type is needed.
Duncan P. N. Exon Smith7ea96c22015-03-20 00:53:40 +00002235 DBuilder.replaceArrays(Res, T ? T.getElements() : llvm::DIArray());
Guy Benyei11169dd2012-12-18 14:30:41 +00002236
Guy Benyei11169dd2012-12-18 14:30:41 +00002237 // And update the type cache.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002238 TypeCache[QTy.getAsOpaquePtr()].reset(Res);
Guy Benyei11169dd2012-12-18 14:30:41 +00002239 return Res;
2240}
2241
2242// TODO: Currently used for context chains when limiting debug info.
David Blaikie8d5e1282013-08-20 21:03:29 +00002243llvm::DICompositeType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002244 RecordDecl *RD = Ty->getDecl();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002245
Guy Benyei11169dd2012-12-18 14:30:41 +00002246 // Get overall information about the record type for the debug info.
2247 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2248 unsigned Line = getLineNumber(RD->getLocation());
2249 StringRef RDName = getClassName(RD);
2250
Eric Christopher07429ff2013-10-15 21:22:34 +00002251 llvm::DIDescriptor RDContext =
2252 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002253
David Blaikied2785892013-08-18 17:36:19 +00002254 // If we ended up creating the type during the context chain construction,
2255 // just return that.
David Blaikie8d5e1282013-08-20 21:03:29 +00002256 llvm::DICompositeType T(getTypeOrNull(CGM.getContext().getRecordType(RD)));
2257 if (T && (!T.isForwardDecl() || !RD->getDefinition()))
Eric Christophere7b87e52014-10-26 23:40:33 +00002258 return T;
David Blaikied2785892013-08-18 17:36:19 +00002259
Adrian Prantl381e7552014-02-04 21:29:50 +00002260 // If this is just a forward or incomplete declaration, construct an
2261 // appropriately marked node and just return it.
2262 const RecordDecl *D = RD->getDefinition();
2263 if (!D || !D->isCompleteDefinition())
Manman Ren1b457022013-08-28 21:20:28 +00002264 return getOrCreateRecordFwdDecl(Ty, RDContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002265
2266 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2267 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
David Blaikie49ae6a72013-03-26 23:47:35 +00002268 llvm::DICompositeType RealDecl;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002269
Manman Rene0064d82013-08-29 23:19:58 +00002270 SmallString<256> FullName = getUniqueTagTypeName(Ty, CGM, TheCU);
2271
Adrian Prantl5f66bae2015-02-11 17:45:15 +00002272 RealDecl = DBuilder.createReplaceableCompositeType(getTagForRecord(RD),
2273 RDName, RDContext, DefUnit, Line, 0, Size, Align, 0, FullName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002274
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002275 RegionMap[Ty->getDecl()].reset(RealDecl);
2276 TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00002277
David Blaikieadfbf992013-08-18 16:55:33 +00002278 if (const ClassTemplateSpecializationDecl *TSpecial =
2279 dyn_cast<ClassTemplateSpecializationDecl>(RD))
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002280 DBuilder.replaceArrays(RealDecl, llvm::DIArray(),
2281 CollectCXXTemplateParams(TSpecial, DefUnit));
David Blaikie952dac32013-08-15 22:42:12 +00002282 return RealDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00002283}
2284
David Blaikieadfbf992013-08-18 16:55:33 +00002285void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
2286 llvm::DICompositeType RealDecl) {
2287 // A class's primary base or the class itself contains the vtable.
2288 llvm::DICompositeType ContainingType;
2289 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2290 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
Alp Tokerd4733632013-12-05 04:47:09 +00002291 // Seek non-virtual primary base root.
David Blaikieadfbf992013-08-18 16:55:33 +00002292 while (1) {
2293 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2294 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2295 if (PBT && !BRL.isPrimaryBaseVirtual())
2296 PBase = PBT;
2297 else
2298 break;
2299 }
2300 ContainingType = llvm::DICompositeType(
2301 getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
2302 getOrCreateFile(RD->getLocation())));
2303 } else if (RD->isDynamicClass())
2304 ContainingType = RealDecl;
2305
Duncan P. N. Exon Smithc8ee63e2014-12-18 00:48:56 +00002306 DBuilder.replaceVTableHolder(RealDecl, ContainingType);
David Blaikieadfbf992013-08-18 16:55:33 +00002307}
2308
Guy Benyei11169dd2012-12-18 14:30:41 +00002309/// CreateMemberType - Create new member and increase Offset by FType's size.
2310llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
Eric Christophere7b87e52014-10-26 23:40:33 +00002311 StringRef Name, uint64_t *Offset) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002312 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2313 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2314 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Eric Christophere7b87e52014-10-26 23:40:33 +00002315 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize,
2316 FieldAlign, *Offset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002317 *Offset += FieldSize;
2318 return Ty;
2319}
2320
Frederic Riss9db79f12014-11-18 03:40:46 +00002321void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD,
2322 llvm::DIFile Unit,
2323 StringRef &Name, StringRef &LinkageName,
2324 llvm::DIDescriptor &FDContext,
2325 llvm::DIArray &TParamsArray,
2326 unsigned &Flags) {
2327 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
2328 Name = getFunctionName(FD);
2329 // Use mangled name as linkage name for C/C++ functions.
2330 if (FD->hasPrototype()) {
2331 LinkageName = CGM.getMangledName(GD);
2332 Flags |= llvm::DIDescriptor::FlagPrototyped;
2333 }
2334 // No need to replicate the linkage name if it isn't different from the
2335 // subprogram name, no need to have it at all unless coverage is enabled or
2336 // debug is set to more than just line tables.
2337 if (LinkageName == Name ||
2338 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2339 !CGM.getCodeGenOpts().EmitGcovNotes &&
2340 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
2341 LinkageName = StringRef();
2342
2343 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
2344 if (const NamespaceDecl *NSDecl =
2345 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2346 FDContext = getOrCreateNameSpace(NSDecl);
2347 else if (const RecordDecl *RDecl =
2348 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2349 FDContext = getContextDescriptor(cast<Decl>(RDecl));
2350 // Collect template parameters.
2351 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2352 }
2353}
2354
2355void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile &Unit,
2356 unsigned &LineNo, QualType &T,
2357 StringRef &Name, StringRef &LinkageName,
2358 llvm::DIDescriptor &VDContext) {
2359 Unit = getOrCreateFile(VD->getLocation());
2360 LineNo = getLineNumber(VD->getLocation());
2361
2362 setLocation(VD->getLocation());
2363
2364 T = VD->getType();
2365 if (T->isIncompleteArrayType()) {
2366 // CodeGen turns int[] into int[1] so we'll do the same here.
2367 llvm::APInt ConstVal(32, 1);
2368 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2369
2370 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2371 ArrayType::Normal, 0);
2372 }
2373
2374 Name = VD->getName();
2375 if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
2376 !isa<ObjCMethodDecl>(VD->getDeclContext()))
2377 LinkageName = CGM.getMangledName(VD);
2378 if (LinkageName == Name)
2379 LinkageName = StringRef();
2380
2381 // Since we emit declarations (DW_AT_members) for static members, place the
2382 // definition of those static members in the namespace they were declared in
2383 // in the source code (the lexical decl context).
2384 // FIXME: Generalize this for even non-member global variables where the
2385 // declaration and definition may have different lexical decl contexts, once
2386 // we have support for emitting declarations of (non-member) global variables.
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00002387 const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
2388 : VD->getDeclContext();
2389 // When a record type contains an in-line initialization of a static data
2390 // member, and the record type is marked as __declspec(dllexport), an implicit
2391 // definition of the member will be created in the record context. DWARF
2392 // doesn't seem to have a nice way to describe this in a form that consumers
2393 // are likely to understand, so fake the "normal" situation of a definition
2394 // outside the class by putting it in the global scope.
2395 if (DC->isRecord())
2396 DC = CGM.getContext().getTranslationUnitDecl();
2397 VDContext = getContextDescriptor(dyn_cast<Decl>(DC));
Frederic Riss9db79f12014-11-18 03:40:46 +00002398}
2399
Frederic Rissd253ed62014-11-18 03:40:51 +00002400llvm::DISubprogram
2401CGDebugInfo::getFunctionForwardDeclaration(const FunctionDecl *FD) {
2402 llvm::DIArray TParamsArray;
2403 StringRef Name, LinkageName;
2404 unsigned Flags = 0;
2405 SourceLocation Loc = FD->getLocation();
2406 llvm::DIFile Unit = getOrCreateFile(Loc);
2407 llvm::DIDescriptor DContext(Unit);
2408 unsigned Line = getLineNumber(Loc);
2409
2410 collectFunctionDeclProps(FD, Unit, Name, LinkageName, DContext,
2411 TParamsArray, Flags);
2412 // Build function type.
2413 SmallVector<QualType, 16> ArgTypes;
2414 for (const ParmVarDecl *Parm: FD->parameters())
2415 ArgTypes.push_back(Parm->getType());
2416 QualType FnType =
2417 CGM.getContext().getFunctionType(FD->getReturnType(), ArgTypes,
2418 FunctionProtoType::ExtProtoInfo());
2419 llvm::DISubprogram SP =
2420 DBuilder.createTempFunctionFwdDecl(DContext, Name, LinkageName, Unit, Line,
2421 getOrCreateFunctionType(FD, FnType, Unit),
2422 !FD->isExternallyVisible(),
2423 false /*declaration*/, 0, Flags,
2424 CGM.getLangOpts().Optimize, nullptr,
2425 TParamsArray, getFunctionDeclaration(FD));
2426 const FunctionDecl *CanonDecl = cast<FunctionDecl>(FD->getCanonicalDecl());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002427 FwdDeclReplaceMap.emplace_back(
2428 std::piecewise_construct, std::make_tuple(CanonDecl),
2429 std::make_tuple(static_cast<llvm::Metadata *>(SP)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002430 return SP;
2431}
2432
2433llvm::DIGlobalVariable
2434CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
2435 QualType T;
2436 StringRef Name, LinkageName;
2437 SourceLocation Loc = VD->getLocation();
2438 llvm::DIFile Unit = getOrCreateFile(Loc);
2439 llvm::DIDescriptor DContext(Unit);
2440 unsigned Line = getLineNumber(Loc);
2441
2442 collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, DContext);
2443 llvm::DIGlobalVariable GV =
2444 DBuilder.createTempGlobalVariableFwdDecl(DContext, Name, LinkageName, Unit,
2445 Line, getOrCreateType(T, Unit),
2446 !VD->isExternallyVisible(),
2447 nullptr, nullptr);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002448 FwdDeclReplaceMap.emplace_back(
2449 std::piecewise_construct,
2450 std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
2451 std::make_tuple(static_cast<llvm::Metadata *>(GV)));
Frederic Rissd253ed62014-11-18 03:40:51 +00002452 return GV;
2453}
2454
Frederic Riss442293e2014-11-06 21:12:06 +00002455llvm::DIDescriptor CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
David Blaikiebd483762013-05-20 04:58:53 +00002456 // We only need a declaration (not a definition) of the type - so use whatever
2457 // we would otherwise do to get a type for a pointee. (forward declarations in
2458 // limited debug info, full definitions (if the type definition is available)
2459 // in unlimited debug info)
David Blaikie6b7d060c2013-08-12 23:14:36 +00002460 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D))
2461 return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
David Blaikie99dab3b2013-09-04 22:03:57 +00002462 getOrCreateFile(TD->getLocation()));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002463 auto I = DeclCache.find(D->getCanonicalDecl());
Frederic Rissd253ed62014-11-18 03:40:51 +00002464
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002465 if (I != DeclCache.end())
2466 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(I->second));
Frederic Rissd253ed62014-11-18 03:40:51 +00002467
2468 // No definition for now. Emit a forward definition that might be
2469 // merged with a potential upcoming definition.
2470 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
2471 return getFunctionForwardDeclaration(FD);
2472 else if (const auto *VD = dyn_cast<VarDecl>(D))
2473 return getGlobalVariableForwardDeclaration(VD);
2474
2475 return llvm::DIDescriptor();
David Blaikiebd483762013-05-20 04:58:53 +00002476}
2477
Guy Benyei11169dd2012-12-18 14:30:41 +00002478/// getFunctionDeclaration - Return debug info descriptor to describe method
2479/// declaration for the given method definition.
2480llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
Diego Novillo913690c2014-06-24 17:02:17 +00002481 if (!D || DebugKind <= CodeGenOptions::DebugLineTablesOnly)
David Blaikie18cfbc52013-06-22 00:09:36 +00002482 return llvm::DISubprogram();
2483
Guy Benyei11169dd2012-12-18 14:30:41 +00002484 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
Eric Christophere7b87e52014-10-26 23:40:33 +00002485 if (!FD)
2486 return llvm::DISubprogram();
Guy Benyei11169dd2012-12-18 14:30:41 +00002487
2488 // Setup context.
David Blaikiefd07c602013-08-09 17:20:05 +00002489 llvm::DIScope S = getContextDescriptor(cast<Decl>(D->getDeclContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00002490
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002491 auto MI = SPCache.find(FD->getCanonicalDecl());
David Blaikiefd07c602013-08-09 17:20:05 +00002492 if (MI == SPCache.end()) {
Eric Christopherf86c4052013-08-28 23:12:10 +00002493 if (const CXXMethodDecl *MD =
2494 dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
David Blaikiefd07c602013-08-09 17:20:05 +00002495 llvm::DICompositeType T(S);
Eric Christopherf86c4052013-08-28 23:12:10 +00002496 llvm::DISubprogram SP =
2497 CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()), T);
David Blaikiefd07c602013-08-09 17:20:05 +00002498 return SP;
2499 }
2500 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002501 if (MI != SPCache.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002502 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(MI->second));
David Blaikie18cfbc52013-06-22 00:09:36 +00002503 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002504 return SP;
2505 }
2506
Aaron Ballman86c93902014-03-06 23:45:36 +00002507 for (auto NextFD : FD->redecls()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002508 auto MI = SPCache.find(NextFD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002509 if (MI != SPCache.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002510 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(MI->second));
David Blaikie18cfbc52013-06-22 00:09:36 +00002511 if (SP.isSubprogram() && !SP.isDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00002512 return SP;
2513 }
2514 }
2515 return llvm::DISubprogram();
2516}
2517
2518// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2519// implicit parameter "this".
David Blaikie469f0792013-05-22 23:22:42 +00002520llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2521 QualType FnType,
2522 llvm::DIFile F) {
Diego Novillo913690c2014-06-24 17:02:17 +00002523 if (!D || DebugKind <= CodeGenOptions::DebugLineTablesOnly)
David Blaikie18cfbc52013-06-22 00:09:36 +00002524 // Create fake but valid subroutine type. Otherwise
2525 // llvm::DISubprogram::Verify() would return false, and
2526 // subprogram DIE will miss DW_AT_decl_file and
2527 // DW_AT_decl_line fields.
Manman Ren67f005e2014-07-28 22:24:34 +00002528 return DBuilder.createSubroutineType(F,
2529 DBuilder.getOrCreateTypeArray(None));
Guy Benyei11169dd2012-12-18 14:30:41 +00002530
2531 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2532 return getOrCreateMethodType(Method, F);
2533 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2534 // Add "self" and "_cmd"
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002535 SmallVector<llvm::Metadata *, 16> Elts;
Guy Benyei11169dd2012-12-18 14:30:41 +00002536
2537 // First element is always return type. For 'void' functions it is NULL.
Alp Toker314cc812014-01-25 16:55:45 +00002538 QualType ResultTy = OMethod->getReturnType();
Adrian Prantl5f360102013-05-22 21:37:49 +00002539
2540 // Replace the instancetype keyword with the actual type.
2541 if (ResultTy == CGM.getContext().getObjCInstanceType())
2542 ResultTy = CGM.getContext().getPointerType(
Eric Christophere7b87e52014-10-26 23:40:33 +00002543 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
Adrian Prantl5f360102013-05-22 21:37:49 +00002544
Adrian Prantl7bec9032013-05-10 21:08:31 +00002545 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002546 // "self" pointer is always first argument.
Adrian Prantlde17db32013-03-29 19:20:29 +00002547 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2548 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2549 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei11169dd2012-12-18 14:30:41 +00002550 // "_cmd" pointer is always second argument.
2551 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2552 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2553 // Get rest of the arguments.
Aaron Ballman43b68be2014-03-07 17:50:17 +00002554 for (const auto *PI : OMethod->params())
2555 Elts.push_back(getOrCreateType(PI->getType(), F));
Frederic Riss787d9d62014-08-12 04:42:23 +00002556 // Variadic methods need a special marker at the end of the type list.
2557 if (OMethod->isVariadic())
2558 Elts.push_back(DBuilder.createUnspecifiedParameter());
Guy Benyei11169dd2012-12-18 14:30:41 +00002559
Manman Ren67f005e2014-07-28 22:24:34 +00002560 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
Guy Benyei11169dd2012-12-18 14:30:41 +00002561 return DBuilder.createSubroutineType(F, EltTypeArray);
2562 }
Adrian Prantld45ba252014-02-25 19:38:11 +00002563
Adrian Prantl800faef2014-02-25 23:42:18 +00002564 // Handle variadic function types; they need an additional
2565 // unspecified parameter.
Adrian Prantld45ba252014-02-25 19:38:11 +00002566 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
2567 if (FD->isVariadic()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002568 SmallVector<llvm::Metadata *, 16> EltTys;
Adrian Prantld45ba252014-02-25 19:38:11 +00002569 EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
2570 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FnType))
2571 for (unsigned i = 0, e = FPT->getNumParams(); i != e; ++i)
2572 EltTys.push_back(getOrCreateType(FPT->getParamType(i), F));
2573 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Manman Ren67f005e2014-07-28 22:24:34 +00002574 llvm::DITypeArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
Adrian Prantld45ba252014-02-25 19:38:11 +00002575 return DBuilder.createSubroutineType(F, EltTypeArray);
2576 }
2577
David Blaikie469f0792013-05-22 23:22:42 +00002578 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002579}
2580
2581/// EmitFunctionStart - Constructs the debug code for entering a function.
Eric Christophere7b87e52014-10-26 23:40:33 +00002582void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
2583 SourceLocation ScopeLoc, QualType FnType,
2584 llvm::Function *Fn, CGBuilderTy &Builder) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002585
2586 StringRef Name;
2587 StringRef LinkageName;
2588
2589 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2590
2591 const Decl *D = GD.getDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002592 bool HasDecl = (D != nullptr);
Eric Christopher885c41b2014-04-01 22:25:28 +00002593
Guy Benyei11169dd2012-12-18 14:30:41 +00002594 unsigned Flags = 0;
2595 llvm::DIFile Unit = getOrCreateFile(Loc);
2596 llvm::DIDescriptor FDContext(Unit);
2597 llvm::DIArray TParamsArray;
2598 if (!HasDecl) {
2599 // Use llvm function name.
David Blaikieebe87e12013-08-27 23:57:18 +00002600 LinkageName = Fn->getName();
Guy Benyei11169dd2012-12-18 14:30:41 +00002601 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2602 // If there is a DISubprogram for this function available then use it.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002603 auto FI = SPCache.find(FD->getCanonicalDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002604 if (FI != SPCache.end()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002605 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(FI->second));
Guy Benyei11169dd2012-12-18 14:30:41 +00002606 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2607 llvm::MDNode *SPN = SP;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002608 LexicalBlockStack.emplace_back(SPN);
2609 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002610 return;
2611 }
2612 }
Frederic Riss9db79f12014-11-18 03:40:46 +00002613 collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
2614 TParamsArray, Flags);
Guy Benyei11169dd2012-12-18 14:30:41 +00002615 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2616 Name = getObjCMethodName(OMD);
2617 Flags |= llvm::DIDescriptor::FlagPrototyped;
2618 } else {
2619 // Use llvm function name.
2620 Name = Fn->getName();
2621 Flags |= llvm::DIDescriptor::FlagPrototyped;
2622 }
2623 if (!Name.empty() && Name[0] == '\01')
2624 Name = Name.substr(1);
2625
Adrian Prantl42d71b92014-04-10 23:21:53 +00002626 if (!HasDecl || D->isImplicit()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002627 Flags |= llvm::DIDescriptor::FlagArtificial;
Adrian Prantl42d71b92014-04-10 23:21:53 +00002628 // Artificial functions without a location should not silently reuse CurLoc.
2629 if (Loc.isInvalid())
2630 CurLoc = SourceLocation();
2631 }
2632 unsigned LineNo = getLineNumber(Loc);
2633 unsigned ScopeLine = getLineNumber(ScopeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002634
Eric Christopher8018e412014-03-27 18:50:35 +00002635 // FIXME: The function declaration we're constructing here is mostly reusing
2636 // declarations from CXXMethodDecl and not constructing new ones for arbitrary
2637 // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
2638 // all subprograms instead of the actual context since subprogram definitions
2639 // are emitted as CU level entities by the backend.
Eric Christophere7b87e52014-10-26 23:40:33 +00002640 llvm::DISubprogram SP = DBuilder.createFunction(
2641 FDContext, Name, LinkageName, Unit, LineNo,
2642 getOrCreateFunctionType(D, FnType, Unit), Fn->hasInternalLinkage(),
2643 true /*definition*/, ScopeLine, Flags, CGM.getLangOpts().Optimize, Fn,
2644 TParamsArray, getFunctionDeclaration(D));
Frederic Rissb1ab28c2014-11-05 19:19:04 +00002645 // We might get here with a VarDecl in the case we're generating
2646 // code for the initialization of globals. Do not record these decls
2647 // as they will overwrite the actual VarDecl Decl in the cache.
2648 if (HasDecl && isa<FunctionDecl>(D))
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002649 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(SP));
Guy Benyei11169dd2012-12-18 14:30:41 +00002650
Adrian Prantlbebb8932014-03-21 21:01:58 +00002651 // Push the function onto the lexical block stack.
Guy Benyei11169dd2012-12-18 14:30:41 +00002652 llvm::MDNode *SPN = SP;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002653 LexicalBlockStack.emplace_back(SPN);
Adrian Prantlbebb8932014-03-21 21:01:58 +00002654
Guy Benyei11169dd2012-12-18 14:30:41 +00002655 if (HasDecl)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002656 RegionMap[D].reset(SP);
Guy Benyei11169dd2012-12-18 14:30:41 +00002657}
2658
2659/// EmitLocation - Emit metadata to indicate a change in line/column
Adrian Prantl02c0caa2013-07-18 00:27:59 +00002660/// information in the source file. If the location is invalid, the
2661/// previous location will be reused.
David Blaikie835afb22015-01-21 23:08:17 +00002662void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002663 // Update our current location
2664 setLocation(Loc);
2665
Eric Christophere7b87e52014-10-26 23:40:33 +00002666 if (CurLoc.isInvalid() || CurLoc.isMacroID())
2667 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002668
Adrian Prantle83b1302014-01-07 22:05:52 +00002669 llvm::MDNode *Scope = LexicalBlockStack.back();
Eric Christophere7b87e52014-10-26 23:40:33 +00002670 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
David Blaikie835afb22015-01-21 23:08:17 +00002671 getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002672}
2673
2674/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2675/// the stack.
2676void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002677 llvm::MDNode *Back = nullptr;
2678 if (!LexicalBlockStack.empty())
2679 Back = LexicalBlockStack.back().get();
David Blaikief9ea2422014-06-02 16:32:05 +00002680 llvm::DIDescriptor D = DBuilder.createLexicalBlock(
Duncan P. N. Exon Smitha66e3052014-12-09 19:22:40 +00002681 llvm::DIDescriptor(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
2682 getColumnNumber(CurLoc));
Guy Benyei11169dd2012-12-18 14:30:41 +00002683 llvm::MDNode *DN = D;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002684 LexicalBlockStack.emplace_back(DN);
Guy Benyei11169dd2012-12-18 14:30:41 +00002685}
2686
2687/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2688/// region - beginning of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002689void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2690 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002691 // Set our current location.
2692 setLocation(Loc);
2693
Guy Benyei11169dd2012-12-18 14:30:41 +00002694 // Emit a line table change for the current location inside the new scope.
Eric Christophere7b87e52014-10-26 23:40:33 +00002695 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
2696 getLineNumber(Loc), getColumnNumber(Loc), LexicalBlockStack.back()));
David Blaikie60a877b2014-10-22 19:34:33 +00002697
2698 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2699 return;
2700
2701 // Create a new lexical block and push it on the stack.
2702 CreateLexicalBlock(Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +00002703}
2704
2705/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2706/// region - end of a DW_TAG_lexical_block.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002707void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2708 SourceLocation Loc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002709 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2710
2711 // Provide an entry in the line table for the end of the block.
2712 EmitLocation(Builder, Loc);
2713
David Blaikie60a877b2014-10-22 19:34:33 +00002714 if (DebugKind <= CodeGenOptions::DebugLineTablesOnly)
2715 return;
2716
Guy Benyei11169dd2012-12-18 14:30:41 +00002717 LexicalBlockStack.pop_back();
2718}
2719
2720/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2721void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2722 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2723 unsigned RCount = FnBeginRegionCount.back();
2724 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2725
2726 // Pop all regions for this function.
David Blaikie60a877b2014-10-22 19:34:33 +00002727 while (LexicalBlockStack.size() != RCount) {
2728 // Provide an entry in the line table for the end of the block.
2729 EmitLocation(Builder, CurLoc);
2730 LexicalBlockStack.pop_back();
2731 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002732 FnBeginRegionCount.pop_back();
2733}
2734
Eric Christopherb2a008c2013-05-16 00:45:12 +00002735// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei11169dd2012-12-18 14:30:41 +00002736// See BuildByRefType.
2737llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2738 uint64_t *XOffset) {
2739
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002740 SmallVector<llvm::Metadata *, 5> EltTys;
Guy Benyei11169dd2012-12-18 14:30:41 +00002741 QualType FType;
2742 uint64_t FieldSize, FieldOffset;
2743 unsigned FieldAlign;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002744
Guy Benyei11169dd2012-12-18 14:30:41 +00002745 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00002746 QualType Type = VD->getType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002747
2748 FieldOffset = 0;
2749 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2750 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2751 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2752 FType = CGM.getContext().IntTy;
2753 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2754 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2755
2756 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2757 if (HasCopyAndDispose) {
2758 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002759 EltTys.push_back(
2760 CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
2761 EltTys.push_back(
2762 CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00002763 }
2764 bool HasByrefExtendedLayout;
2765 Qualifiers::ObjCLifetime Lifetime;
Eric Christophere7b87e52014-10-26 23:40:33 +00002766 if (CGM.getContext().getByrefLifetime(Type, Lifetime,
2767 HasByrefExtendedLayout) &&
2768 HasByrefExtendedLayout) {
Adrian Prantlead2ba42013-07-23 00:12:14 +00002769 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002770 EltTys.push_back(
2771 CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
Adrian Prantlead2ba42013-07-23 00:12:14 +00002772 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002773
Guy Benyei11169dd2012-12-18 14:30:41 +00002774 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2775 if (Align > CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00002776 CGM.getTarget().getPointerAlign(0))) {
2777 CharUnits FieldOffsetInBytes =
2778 CGM.getContext().toCharUnitsFromBits(FieldOffset);
2779 CharUnits AlignedOffsetInBytes =
2780 FieldOffsetInBytes.RoundUpToAlignment(Align);
2781 CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002782
Guy Benyei11169dd2012-12-18 14:30:41 +00002783 if (NumPaddingBytes.isPositive()) {
2784 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2785 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2786 pad, ArrayType::Normal, 0);
2787 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2788 }
2789 }
Eric Christopherb2a008c2013-05-16 00:45:12 +00002790
Guy Benyei11169dd2012-12-18 14:30:41 +00002791 FType = Type;
David Blaikief427b002014-05-06 03:42:01 +00002792 llvm::DIType FieldTy = getOrCreateType(FType, Unit);
Guy Benyei11169dd2012-12-18 14:30:41 +00002793 FieldSize = CGM.getContext().getTypeSize(FType);
2794 FieldAlign = CGM.getContext().toBits(Align);
2795
Eric Christopherb2a008c2013-05-16 00:45:12 +00002796 *XOffset = FieldOffset;
Eric Christophere7b87e52014-10-26 23:40:33 +00002797 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit, 0, FieldSize,
2798 FieldAlign, FieldOffset, 0, FieldTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002799 EltTys.push_back(FieldTy);
2800 FieldOffset += FieldSize;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002801
Guy Benyei11169dd2012-12-18 14:30:41 +00002802 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002803
Guy Benyei11169dd2012-12-18 14:30:41 +00002804 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002805
Guy Benyei11169dd2012-12-18 14:30:41 +00002806 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikie6d4fe152013-02-25 01:07:08 +00002807 llvm::DIType(), Elements);
Guy Benyei11169dd2012-12-18 14:30:41 +00002808}
2809
2810/// EmitDeclare - Emit local variable declaration debug info.
Duncan P. N. Exon Smithf796a1d2015-02-03 21:25:34 +00002811void CGDebugInfo::EmitDeclare(const VarDecl *VD, llvm::dwarf::Tag Tag,
Eric Christophere7b87e52014-10-26 23:40:33 +00002812 llvm::Value *Storage, unsigned ArgNo,
2813 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002814 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002815 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2816
David Blaikie7fceebf2013-08-19 03:37:48 +00002817 bool Unwritten =
2818 VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
2819 cast<Decl>(VD->getDeclContext())->isImplicit());
2820 llvm::DIFile Unit;
2821 if (!Unwritten)
2822 Unit = getOrCreateFile(VD->getLocation());
Guy Benyei11169dd2012-12-18 14:30:41 +00002823 llvm::DIType Ty;
2824 uint64_t XOffset = 0;
2825 if (VD->hasAttr<BlocksAttr>())
2826 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002827 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002828 Ty = getOrCreateType(VD->getType(), Unit);
2829
2830 // If there is no debug info for this type then do not emit debug info
2831 // for this variable.
2832 if (!Ty)
2833 return;
2834
Guy Benyei11169dd2012-12-18 14:30:41 +00002835 // Get location information.
David Blaikie7fceebf2013-08-19 03:37:48 +00002836 unsigned Line = 0;
2837 unsigned Column = 0;
2838 if (!Unwritten) {
2839 Line = getLineNumber(VD->getLocation());
2840 Column = getColumnNumber(VD->getLocation());
2841 }
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002842 SmallVector<int64_t, 9> Expr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002843 unsigned Flags = 0;
2844 if (VD->isImplicit())
2845 Flags |= llvm::DIDescriptor::FlagArtificial;
2846 // If this is the first argument and it is implicit then
2847 // give it an object pointer flag.
2848 // FIXME: There has to be a better way to do this, but for static
2849 // functions there won't be an implicit param at arg1 and
2850 // otherwise it is 'self' or 'this'.
2851 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2852 Flags |= llvm::DIDescriptor::FlagObjectPointer;
David Blaikieb9c667d2013-06-19 21:53:53 +00002853 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage))
Eric Christopherffdeb1e2013-07-17 22:52:53 +00002854 if (Arg->getType()->isPointerTy() && !Arg->hasByValAttr() &&
2855 !VD->getType()->isPointerType())
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002856 Expr.push_back(llvm::dwarf::DW_OP_deref);
Guy Benyei11169dd2012-12-18 14:30:41 +00002857
2858 llvm::MDNode *Scope = LexicalBlockStack.back();
2859
2860 StringRef Name = VD->getName();
2861 if (!Name.empty()) {
2862 if (VD->hasAttr<BlocksAttr>()) {
2863 CharUnits offset = CharUnits::fromQuantity(32);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002864 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002865 // offset of __forwarding field
2866 offset = CGM.getContext().toCharUnitsFromBits(
Eric Christophere7b87e52014-10-26 23:40:33 +00002867 CGM.getTarget().getPointerWidth(0));
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002868 Expr.push_back(offset.getQuantity());
2869 Expr.push_back(llvm::dwarf::DW_OP_deref);
2870 Expr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002871 // offset of x field
2872 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002873 Expr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002874
2875 // Create the descriptor for the variable.
Eric Christophere7b87e52014-10-26 23:40:33 +00002876 llvm::DIVariable D = DBuilder.createLocalVariable(
2877 Tag, llvm::DIDescriptor(Scope), VD->getName(), Unit, Line, Ty, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002878
Guy Benyei11169dd2012-12-18 14:30:41 +00002879 // Insert an llvm.dbg.declare into the current block.
2880 llvm::Instruction *Call =
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002881 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
Eric Christophere7b87e52014-10-26 23:40:33 +00002882 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00002883 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2884 return;
Adrian Prantl7f2ef222013-09-18 22:18:17 +00002885 } else if (isa<VariableArrayType>(VD->getType()))
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002886 Expr.push_back(llvm::dwarf::DW_OP_deref);
David Blaikiea76a7c92013-01-05 05:58:35 +00002887 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2888 // If VD is an anonymous union then Storage represents value for
2889 // all union fields.
Guy Benyei11169dd2012-12-18 14:30:41 +00002890 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikie219c7d92013-01-05 20:03:07 +00002891 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002892 for (const auto *Field : RD->fields()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002893 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2894 StringRef FieldName = Field->getName();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002895
Guy Benyei11169dd2012-12-18 14:30:41 +00002896 // Ignore unnamed fields. Do not ignore unnamed records.
2897 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2898 continue;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002899
Guy Benyei11169dd2012-12-18 14:30:41 +00002900 // Use VarDecl's Tag, Scope and Line number.
Eric Christophere7b87e52014-10-26 23:40:33 +00002901 llvm::DIVariable D = DBuilder.createLocalVariable(
2902 Tag, llvm::DIDescriptor(Scope), FieldName, Unit, Line, FieldTy,
2903 CGM.getLangOpts().Optimize, Flags, ArgNo);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002904
Guy Benyei11169dd2012-12-18 14:30:41 +00002905 // Insert an llvm.dbg.declare into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00002906 llvm::Instruction *Call = DBuilder.insertDeclare(
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002907 Storage, D, DBuilder.createExpression(Expr),
2908 Builder.GetInsertBlock());
Guy Benyei11169dd2012-12-18 14:30:41 +00002909 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2910 }
David Blaikie219c7d92013-01-05 20:03:07 +00002911 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00002912 }
2913 }
David Blaikiea76a7c92013-01-05 05:58:35 +00002914
2915 // Create the descriptor for the variable.
Eric Christophere7b87e52014-10-26 23:40:33 +00002916 llvm::DIVariable D = DBuilder.createLocalVariable(
2917 Tag, llvm::DIDescriptor(Scope), Name, Unit, Line, Ty,
2918 CGM.getLangOpts().Optimize, Flags, ArgNo);
David Blaikiea76a7c92013-01-05 05:58:35 +00002919
2920 // Insert an llvm.dbg.declare into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00002921 llvm::Instruction *Call = DBuilder.insertDeclare(
Adrian Prantl7c6f9442015-01-19 17:51:58 +00002922 Storage, D, DBuilder.createExpression(Expr), Builder.GetInsertBlock());
David Blaikiea76a7c92013-01-05 05:58:35 +00002923 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00002924}
2925
2926void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2927 llvm::Value *Storage,
2928 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00002929 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002930 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2931}
2932
Adrian Prantlde17db32013-03-29 19:20:29 +00002933/// Look up the completed type for a self pointer in the TypeCache and
2934/// create a copy of it with the ObjectPointer and Artificial flags
2935/// set. If the type is not cached, a new one is created. This should
2936/// never happen though, since creating a type for the implicit self
2937/// argument implies that we already parsed the interface definition
2938/// and the ivar declarations in the implementation.
Eric Christopher0fdcb312013-05-16 00:52:20 +00002939llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2940 llvm::DIType Ty) {
Adrian Prantlde17db32013-03-29 19:20:29 +00002941 llvm::DIType CachedTy = getTypeOrNull(QualTy);
Eric Christophere7b87e52014-10-26 23:40:33 +00002942 if (CachedTy)
2943 Ty = CachedTy;
Adrian Prantlde17db32013-03-29 19:20:29 +00002944 return DBuilder.createObjectPointerType(Ty);
2945}
2946
Eric Christophere7b87e52014-10-26 23:40:33 +00002947void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
2948 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +00002949 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
Eric Christopher75e17682013-05-16 00:45:23 +00002950 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00002951 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherb2a008c2013-05-16 00:45:12 +00002952
Craig Topper8a13c412014-05-21 05:09:00 +00002953 if (Builder.GetInsertBlock() == nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +00002954 return;
Eric Christopherb2a008c2013-05-16 00:45:12 +00002955
Guy Benyei11169dd2012-12-18 14:30:41 +00002956 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopherb2a008c2013-05-16 00:45:12 +00002957
Guy Benyei11169dd2012-12-18 14:30:41 +00002958 uint64_t XOffset = 0;
2959 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2960 llvm::DIType Ty;
2961 if (isByRef)
2962 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopherb2a008c2013-05-16 00:45:12 +00002963 else
Guy Benyei11169dd2012-12-18 14:30:41 +00002964 Ty = getOrCreateType(VD->getType(), Unit);
2965
2966 // Self is passed along as an implicit non-arg variable in a
2967 // block. Mark it as the object pointer.
2968 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantlde17db32013-03-29 19:20:29 +00002969 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002970
2971 // Get location information.
2972 unsigned Line = getLineNumber(VD->getLocation());
2973 unsigned Column = getColumnNumber(VD->getLocation());
2974
2975 const llvm::DataLayout &target = CGM.getDataLayout();
2976
2977 CharUnits offset = CharUnits::fromQuantity(
Eric Christophere7b87e52014-10-26 23:40:33 +00002978 target.getStructLayout(blockInfo.StructureType)
Guy Benyei11169dd2012-12-18 14:30:41 +00002979 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2980
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002981 SmallVector<int64_t, 9> addr;
Adrian Prantl0f6df002013-03-29 19:20:35 +00002982 if (isa<llvm::AllocaInst>(Storage))
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002983 addr.push_back(llvm::dwarf::DW_OP_deref);
2984 addr.push_back(llvm::dwarf::DW_OP_plus);
2985 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002986 if (isByRef) {
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002987 addr.push_back(llvm::dwarf::DW_OP_deref);
2988 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002989 // offset of __forwarding field
Eric Christophere7b87e52014-10-26 23:40:33 +00002990 offset =
2991 CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002992 addr.push_back(offset.getQuantity());
2993 addr.push_back(llvm::dwarf::DW_OP_deref);
2994 addr.push_back(llvm::dwarf::DW_OP_plus);
Guy Benyei11169dd2012-12-18 14:30:41 +00002995 // offset of x field
2996 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Duncan P. N. Exon Smithf3dc4292014-10-01 20:26:18 +00002997 addr.push_back(offset.getQuantity());
Guy Benyei11169dd2012-12-18 14:30:41 +00002998 }
2999
3000 // Create the descriptor for the variable.
3001 llvm::DIVariable D =
Eric Christophere7b87e52014-10-26 23:40:33 +00003002 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_auto_variable,
3003 llvm::DIDescriptor(LexicalBlockStack.back()),
3004 VD->getName(), Unit, Line, Ty);
Adrian Prantl0f6df002013-03-29 19:20:35 +00003005
Guy Benyei11169dd2012-12-18 14:30:41 +00003006 // Insert an llvm.dbg.declare into the current block.
Adrian Prantl88eec392014-11-21 00:35:25 +00003007 llvm::Instruction *Call = InsertPoint ?
3008 DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr),
3009 InsertPoint)
3010 : DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(addr),
3011 Builder.GetInsertBlock());
Eric Christophere7b87e52014-10-26 23:40:33 +00003012 Call->setDebugLoc(
3013 llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003014}
3015
3016/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
3017/// variable declaration.
3018void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
3019 unsigned ArgNo,
3020 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003021 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003022 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
3023}
3024
3025namespace {
Eric Christophere7b87e52014-10-26 23:40:33 +00003026struct BlockLayoutChunk {
3027 uint64_t OffsetInBits;
3028 const BlockDecl::Capture *Capture;
3029};
3030bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
3031 return l.OffsetInBits < r.OffsetInBits;
3032}
Guy Benyei11169dd2012-12-18 14:30:41 +00003033}
3034
3035void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003036 llvm::Value *Arg,
David Blaikie77bbb5f2014-08-08 17:10:14 +00003037 unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +00003038 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +00003039 CGBuilderTy &Builder) {
Eric Christopher75e17682013-05-16 00:45:23 +00003040 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003041 ASTContext &C = CGM.getContext();
3042 const BlockDecl *blockDecl = block.getBlockDecl();
3043
3044 // Collect some general information about the block's location.
3045 SourceLocation loc = blockDecl->getCaretLocation();
3046 llvm::DIFile tunit = getOrCreateFile(loc);
3047 unsigned line = getLineNumber(loc);
3048 unsigned column = getColumnNumber(loc);
Eric Christopherb2a008c2013-05-16 00:45:12 +00003049
Guy Benyei11169dd2012-12-18 14:30:41 +00003050 // Build the debug-info type for the block literal.
3051 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
3052
3053 const llvm::StructLayout *blockLayout =
Eric Christophere7b87e52014-10-26 23:40:33 +00003054 CGM.getDataLayout().getStructLayout(block.StructureType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003055
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003056 SmallVector<llvm::Metadata *, 16> fields;
Guy Benyei11169dd2012-12-18 14:30:41 +00003057 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
3058 blockLayout->getElementOffsetInBits(0),
3059 tunit, tunit));
3060 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
3061 blockLayout->getElementOffsetInBits(1),
3062 tunit, tunit));
3063 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
3064 blockLayout->getElementOffsetInBits(2),
3065 tunit, tunit));
Adrian Prantl65d5d002014-11-05 01:01:30 +00003066 auto *FnTy = block.getBlockExpr()->getFunctionType();
3067 auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
3068 fields.push_back(createFieldType("__FuncPtr", FnPtrType, 0, loc, AS_public,
Guy Benyei11169dd2012-12-18 14:30:41 +00003069 blockLayout->getElementOffsetInBits(3),
3070 tunit, tunit));
Eric Christophere7b87e52014-10-26 23:40:33 +00003071 fields.push_back(createFieldType(
3072 "__descriptor", C.getPointerType(block.NeedsCopyDispose
3073 ? C.getBlockDescriptorExtendedType()
3074 : C.getBlockDescriptorType()),
3075 0, loc, AS_public, blockLayout->getElementOffsetInBits(4), tunit, tunit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003076
3077 // We want to sort the captures by offset, not because DWARF
3078 // requires this, but because we're paranoid about debuggers.
3079 SmallVector<BlockLayoutChunk, 8> chunks;
3080
3081 // 'this' capture.
3082 if (blockDecl->capturesCXXThis()) {
3083 BlockLayoutChunk chunk;
3084 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003085 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
Craig Topper8a13c412014-05-21 05:09:00 +00003086 chunk.Capture = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003087 chunks.push_back(chunk);
3088 }
3089
3090 // Variable captures.
Aaron Ballman9371dd22014-03-14 18:34:04 +00003091 for (const auto &capture : blockDecl->captures()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003092 const VarDecl *variable = capture.getVariable();
3093 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
3094
3095 // Ignore constant captures.
3096 if (captureInfo.isConstant())
3097 continue;
3098
3099 BlockLayoutChunk chunk;
3100 chunk.OffsetInBits =
Eric Christophere7b87e52014-10-26 23:40:33 +00003101 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
Guy Benyei11169dd2012-12-18 14:30:41 +00003102 chunk.Capture = &capture;
3103 chunks.push_back(chunk);
3104 }
3105
3106 // Sort by offset.
3107 llvm::array_pod_sort(chunks.begin(), chunks.end());
3108
Eric Christophere7b87e52014-10-26 23:40:33 +00003109 for (SmallVectorImpl<BlockLayoutChunk>::iterator i = chunks.begin(),
3110 e = chunks.end();
3111 i != e; ++i) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003112 uint64_t offsetInBits = i->OffsetInBits;
3113 const BlockDecl::Capture *capture = i->Capture;
3114
3115 // If we have a null capture, this must be the C++ 'this' capture.
3116 if (!capture) {
3117 const CXXMethodDecl *method =
Eric Christophere7b87e52014-10-26 23:40:33 +00003118 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00003119 QualType type = method->getThisType(C);
3120
3121 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
3122 offsetInBits, tunit, tunit));
3123 continue;
3124 }
3125
3126 const VarDecl *variable = capture->getVariable();
3127 StringRef name = variable->getName();
3128
3129 llvm::DIType fieldType;
3130 if (capture->isByRef()) {
David Majnemer34b57492014-07-30 01:30:47 +00003131 TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003132
3133 // FIXME: this creates a second copy of this type!
3134 uint64_t xoffset;
3135 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
David Majnemer34b57492014-07-30 01:30:47 +00003136 fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
3137 fieldType =
3138 DBuilder.createMemberType(tunit, name, tunit, line, PtrInfo.Width,
3139 PtrInfo.Align, offsetInBits, 0, fieldType);
Guy Benyei11169dd2012-12-18 14:30:41 +00003140 } else {
Eric Christophere7b87e52014-10-26 23:40:33 +00003141 fieldType = createFieldType(name, variable->getType(), 0, loc, AS_public,
3142 offsetInBits, tunit, tunit);
Guy Benyei11169dd2012-12-18 14:30:41 +00003143 }
3144 fields.push_back(fieldType);
3145 }
3146
3147 SmallString<36> typeName;
Eric Christophere7b87e52014-10-26 23:40:33 +00003148 llvm::raw_svector_ostream(typeName) << "__block_literal_"
3149 << CGM.getUniqueBlockCount();
Guy Benyei11169dd2012-12-18 14:30:41 +00003150
3151 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
3152
3153 llvm::DIType type =
Eric Christophere7b87e52014-10-26 23:40:33 +00003154 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
3155 CGM.getContext().toBits(block.BlockSize),
3156 CGM.getContext().toBits(block.BlockAlign), 0,
3157 llvm::DIType(), fieldsArray);
Guy Benyei11169dd2012-12-18 14:30:41 +00003158 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
3159
3160 // Get overall information about the block.
3161 unsigned flags = llvm::DIDescriptor::FlagArtificial;
3162 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei11169dd2012-12-18 14:30:41 +00003163
3164 // Create the descriptor for the parameter.
Eric Christophere7b87e52014-10-26 23:40:33 +00003165 llvm::DIVariable debugVar = DBuilder.createLocalVariable(
3166 llvm::dwarf::DW_TAG_arg_variable, llvm::DIDescriptor(scope),
3167 Arg->getName(), tunit, line, type, CGM.getLangOpts().Optimize, flags,
3168 ArgNo);
Adrian Prantl51936dd2013-03-14 17:53:33 +00003169
Adrian Prantl616bef42013-03-14 21:52:59 +00003170 if (LocalAddr) {
Adrian Prantl51936dd2013-03-14 17:53:33 +00003171 // Insert an llvm.dbg.value into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00003172 llvm::Instruction *DbgVal = DBuilder.insertDbgValueIntrinsic(
3173 LocalAddr, 0, debugVar, DBuilder.createExpression(),
3174 Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003175 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
3176 }
Adrian Prantl51936dd2013-03-14 17:53:33 +00003177
Adrian Prantl616bef42013-03-14 21:52:59 +00003178 // Insert an llvm.dbg.declare into the current block.
Eric Christophere7b87e52014-10-26 23:40:33 +00003179 llvm::Instruction *DbgDecl = DBuilder.insertDeclare(
3180 Arg, debugVar, DBuilder.createExpression(), Builder.GetInsertBlock());
Adrian Prantl616bef42013-03-14 21:52:59 +00003181 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei11169dd2012-12-18 14:30:41 +00003182}
3183
David Blaikie6943dea2013-08-20 01:28:15 +00003184/// If D is an out-of-class definition of a static data member of a class, find
3185/// its corresponding in-class declaration.
3186llvm::DIDerivedType
3187CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
3188 if (!D->isStaticDataMember())
3189 return llvm::DIDerivedType();
Saleem Abdulrasoolcd187f02015-02-28 00:13:13 +00003190
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003191 auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
David Blaikie6943dea2013-08-20 01:28:15 +00003192 if (MI != StaticDataMemberCache.end()) {
3193 assert(MI->second && "Static data member declaration should still exist");
3194 return llvm::DIDerivedType(cast<llvm::MDNode>(MI->second));
Evgeniy Stepanov37b3f732013-08-16 10:35:31 +00003195 }
David Blaikiece763042013-08-20 21:49:21 +00003196
3197 // If the member wasn't found in the cache, lazily construct and add it to the
3198 // type (used when a limited form of the type is emitted).
Adrian Prantl21361fb2014-08-29 22:44:27 +00003199 auto DC = D->getDeclContext();
3200 llvm::DICompositeType Ctxt(getContextDescriptor(cast<Decl>(DC)));
3201 return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
David Blaikie6943dea2013-08-20 01:28:15 +00003202}
3203
Eric Christophercab9fae2014-04-10 05:20:00 +00003204/// Recursively collect all of the member fields of a global anonymous decl and
3205/// create static variables for them. The first time this is called it needs
3206/// to be on a union and then from there we can have additional unnamed fields.
3207llvm::DIGlobalVariable
3208CGDebugInfo::CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile Unit,
3209 unsigned LineNo, StringRef LinkageName,
3210 llvm::GlobalVariable *Var,
3211 llvm::DIDescriptor DContext) {
3212 llvm::DIGlobalVariable GV;
3213
3214 for (const auto *Field : RD->fields()) {
3215 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
3216 StringRef FieldName = Field->getName();
3217
3218 // Ignore unnamed fields, but recurse into anonymous records.
3219 if (FieldName.empty()) {
3220 const RecordType *RT = dyn_cast<RecordType>(Field->getType());
3221 if (RT)
3222 GV = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
3223 Var, DContext);
3224 continue;
3225 }
3226 // Use VarDecl's Tag, Scope and Line number.
Eric Christophere7b87e52014-10-26 23:40:33 +00003227 GV = DBuilder.createGlobalVariable(
3228 DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
3229 Var->hasInternalLinkage(), Var, llvm::DIDerivedType());
Eric Christophercab9fae2014-04-10 05:20:00 +00003230 }
3231 return GV;
3232}
3233
Guy Benyei11169dd2012-12-18 14:30:41 +00003234/// EmitGlobalVariable - Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003235void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Guy Benyei11169dd2012-12-18 14:30:41 +00003236 const VarDecl *D) {
Eric Christopher75e17682013-05-16 00:45:23 +00003237 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei11169dd2012-12-18 14:30:41 +00003238 // Create global variable debug descriptor.
Frederic Riss9db79f12014-11-18 03:40:46 +00003239 llvm::DIFile Unit;
3240 llvm::DIDescriptor DContext;
3241 unsigned LineNo;
3242 StringRef DeclName, LinkageName;
3243 QualType T;
3244 collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName, DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +00003245
3246 // Attempt to store one global variable for the declaration - even if we
3247 // emit a lot of fields.
3248 llvm::DIGlobalVariable GV;
3249
3250 // If this is an anonymous union then we'll want to emit a global
3251 // variable for each member of the anonymous union so that it's possible
3252 // to find the name of any field in the union.
3253 if (T->isUnionType() && DeclName.empty()) {
3254 const RecordDecl *RD = cast<RecordType>(T)->getDecl();
Eric Christophere7b87e52014-10-26 23:40:33 +00003255 assert(RD->isAnonymousStructOrUnion() &&
3256 "unnamed non-anonymous struct or union?");
Eric Christophercab9fae2014-04-10 05:20:00 +00003257 GV = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
3258 } else {
David Blaikie7550b112014-10-20 17:42:23 +00003259 GV = DBuilder.createGlobalVariable(
Eric Christophercab9fae2014-04-10 05:20:00 +00003260 DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
3261 Var->hasInternalLinkage(), Var,
3262 getOrCreateStaticDataMemberDeclarationOrNull(D));
3263 }
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003264 DeclCache[D->getCanonicalDecl()].reset(static_cast<llvm::Metadata *>(GV));
Guy Benyei11169dd2012-12-18 14:30:41 +00003265}
3266
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003267/// EmitGlobalVariable - Emit global variable's debug info.
3268void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
3269 llvm::Constant *Init) {
Eric Christopher75e17682013-05-16 00:45:23 +00003270 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00003271 // Create the descriptor for the variable.
3272 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3273 StringRef Name = VD->getName();
3274 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3275 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3276 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3277 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3278 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3279 }
3280 // Do not use DIGlobalVariable for enums.
3281 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3282 return;
David Blaikiea15565562014-04-04 20:56:17 +00003283 // Do not emit separate definitions for function local const/statics.
3284 if (isa<FunctionDecl>(VD->getDeclContext()))
3285 return;
David Blaikiebb113912014-04-05 07:23:17 +00003286 VD = cast<ValueDecl>(VD->getCanonicalDecl());
David Blaikie423eb5a2014-11-19 19:42:40 +00003287 auto *VarD = cast<VarDecl>(VD);
David Blaikieaf080852014-11-21 00:20:58 +00003288 if (VarD->isStaticDataMember()) {
3289 auto *RD = cast<RecordDecl>(VarD->getDeclContext());
3290 getContextDescriptor(RD);
David Blaikie423eb5a2014-11-19 19:42:40 +00003291 // Ensure that the type is retained even though it's otherwise unreferenced.
3292 RetainedTypes.push_back(
David Blaikieaf080852014-11-21 00:20:58 +00003293 CGM.getContext().getRecordType(RD).getAsOpaquePtr());
David Blaikie423eb5a2014-11-19 19:42:40 +00003294 return;
3295 }
3296
David Blaikieaf080852014-11-21 00:20:58 +00003297 llvm::DIDescriptor DContext =
3298 getContextDescriptor(dyn_cast<Decl>(VD->getDeclContext()));
3299
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003300 auto &GV = DeclCache[VD];
3301 if (GV)
David Blaikiebb113912014-04-05 07:23:17 +00003302 return;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003303 GV.reset(DBuilder.createGlobalVariable(
David Blaikie506a7452014-04-05 07:46:57 +00003304 DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003305 true, Init, getOrCreateStaticDataMemberDeclarationOrNull(VarD)));
David Blaikiebd483762013-05-20 04:58:53 +00003306}
3307
3308llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3309 if (!LexicalBlockStack.empty())
3310 return llvm::DIScope(LexicalBlockStack.back());
3311 return getContextDescriptor(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003312}
3313
David Blaikie9f88fe82013-04-22 06:13:21 +00003314void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikiebd483762013-05-20 04:58:53 +00003315 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3316 return;
David Blaikie9f88fe82013-04-22 06:13:21 +00003317 DBuilder.createImportedModule(
David Blaikiebd483762013-05-20 04:58:53 +00003318 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3319 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie9f88fe82013-04-22 06:13:21 +00003320 getLineNumber(UD.getLocation()));
3321}
3322
David Blaikiebd483762013-05-20 04:58:53 +00003323void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3324 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3325 return;
3326 assert(UD.shadow_size() &&
3327 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3328 // Emitting one decl is sufficient - debuggers can detect that this is an
3329 // overloaded name & provide lookup for all the overloads.
3330 const UsingShadowDecl &USD = **UD.shadow_begin();
Frederic Riss442293e2014-11-06 21:12:06 +00003331 if (llvm::DIDescriptor Target =
Eric Christopher1ecc5632013-06-07 22:54:39 +00003332 getDeclarationOrDefinition(USD.getUnderlyingDecl()))
David Blaikiebd483762013-05-20 04:58:53 +00003333 DBuilder.createImportedDeclaration(
3334 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3335 getLineNumber(USD.getLocation()));
3336}
3337
David Blaikief121b932013-05-20 22:50:41 +00003338llvm::DIImportedEntity
3339CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3340 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
Duncan P. N. Exon Smitha346e032015-02-26 04:44:27 +00003341 return llvm::DIImportedEntity();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003342 auto &VH = NamespaceAliasCache[&NA];
David Blaikief121b932013-05-20 22:50:41 +00003343 if (VH)
3344 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
Duncan P. N. Exon Smitha346e032015-02-26 04:44:27 +00003345 llvm::DIImportedEntity R;
David Blaikief121b932013-05-20 22:50:41 +00003346 if (const NamespaceAliasDecl *Underlying =
3347 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3348 // This could cache & dedup here rather than relying on metadata deduping.
David Blaikie551fb0a2014-04-06 06:30:03 +00003349 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003350 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3351 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3352 NA.getName());
3353 else
David Blaikie551fb0a2014-04-06 06:30:03 +00003354 R = DBuilder.createImportedDeclaration(
David Blaikief121b932013-05-20 22:50:41 +00003355 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3356 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3357 getLineNumber(NA.getLocation()), NA.getName());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003358 VH.reset(R);
David Blaikief121b932013-05-20 22:50:41 +00003359 return R;
3360}
3361
Guy Benyei11169dd2012-12-18 14:30:41 +00003362/// getOrCreateNamesSpace - Return namespace descriptor for the given
3363/// namespace decl.
Eric Christopherb2a008c2013-05-16 00:45:12 +00003364llvm::DINameSpace
Guy Benyei11169dd2012-12-18 14:30:41 +00003365CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
David Blaikie9fdedec2013-08-16 22:52:07 +00003366 NSDecl = NSDecl->getCanonicalDecl();
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003367 auto I = NameSpaceCache.find(NSDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00003368 if (I != NameSpaceCache.end())
3369 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopherb2a008c2013-05-16 00:45:12 +00003370
Guy Benyei11169dd2012-12-18 14:30:41 +00003371 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3372 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003373 llvm::DIDescriptor Context =
Guy Benyei11169dd2012-12-18 14:30:41 +00003374 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3375 llvm::DINameSpace NS =
3376 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003377 NameSpaceCache[NSDecl].reset(NS);
Guy Benyei11169dd2012-12-18 14:30:41 +00003378 return NS;
3379}
3380
3381void CGDebugInfo::finalize() {
David Blaikie87dab872014-05-07 16:56:58 +00003382 // Creating types might create further types - invalidating the current
3383 // element and the size(), so don't cache/reference them.
3384 for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
3385 ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
3386 E.Decl.replaceAllUsesWith(CGM.getLLVMContext(),
3387 E.Type->getDecl()->getDefinition()
3388 ? CreateTypeDefinition(E.Type, E.Unit)
3389 : E.Decl);
3390 }
3391
David Blaikief427b002014-05-06 03:42:01 +00003392 for (auto p : ReplaceMap) {
3393 assert(p.second);
3394 llvm::DIType Ty(cast<llvm::MDNode>(p.second));
David Blaikieb8149042014-05-05 21:21:39 +00003395 assert(Ty.isForwardDecl());
Eric Christopherb2a008c2013-05-16 00:45:12 +00003396
David Blaikief427b002014-05-06 03:42:01 +00003397 auto it = TypeCache.find(p.first);
David Blaikieb8149042014-05-05 21:21:39 +00003398 assert(it != TypeCache.end());
3399 assert(it->second);
Adrian Prantl73409ce2013-03-11 18:33:46 +00003400
David Blaikief427b002014-05-06 03:42:01 +00003401 llvm::DIType RepTy(cast<llvm::MDNode>(it->second));
3402 Ty.replaceAllUsesWith(CGM.getLLVMContext(), RepTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00003403 }
Adrian Prantl73409ce2013-03-11 18:33:46 +00003404
Frederic Rissd253ed62014-11-18 03:40:51 +00003405 for (const auto &p : FwdDeclReplaceMap) {
3406 assert(p.second);
3407 llvm::DIDescriptor FwdDecl(cast<llvm::MDNode>(p.second));
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003408 llvm::Metadata *Repl;
Frederic Rissd253ed62014-11-18 03:40:51 +00003409
3410 auto it = DeclCache.find(p.first);
Adrian Prantl97f76852014-12-19 01:02:11 +00003411 // If there has been no definition for the declaration, call RAUW
Frederic Rissd253ed62014-11-18 03:40:51 +00003412 // with ourselves, that will destroy the temporary MDNode and
3413 // replace it with a standard one, avoiding leaking memory.
3414 if (it == DeclCache.end())
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003415 Repl = p.second;
Frederic Rissd253ed62014-11-18 03:40:51 +00003416 else
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003417 Repl = it->second;
Frederic Rissdce60a72014-11-19 18:53:46 +00003418
Frederic Rissd253ed62014-11-18 03:40:51 +00003419 FwdDecl.replaceAllUsesWith(CGM.getLLVMContext(),
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00003420 llvm::DIDescriptor(cast<llvm::MDNode>(Repl)));
Frederic Rissd253ed62014-11-18 03:40:51 +00003421 }
3422
Adrian Prantl73409ce2013-03-11 18:33:46 +00003423 // We keep our own list of retained types, because we need to look
3424 // up the final type in the type cache.
3425 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3426 RE = RetainedTypes.end(); RI != RE; ++RI)
David Blaikie0856f662014-03-04 22:01:08 +00003427 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
Adrian Prantl73409ce2013-03-11 18:33:46 +00003428
Guy Benyei11169dd2012-12-18 14:30:41 +00003429 DBuilder.finalize();
3430}
David Blaikie66088d52014-09-24 17:01:27 +00003431
3432void CGDebugInfo::EmitExplicitCastType(QualType Ty) {
3433 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3434 return;
Duncan P. N. Exon Smith5043f912015-03-27 22:58:05 +00003435
3436 if (llvm::DIType DieTy = getOrCreateType(Ty, getOrCreateMainFile()))
3437 // Don't ignore in case of explicit cast where it is referenced indirectly.
3438 DBuilder.retainType(DieTy);
David Blaikie66088d52014-09-24 17:01:27 +00003439}