blob: d0dcc5305370430183f0044f95fcfface344fde6 [file] [log] [blame]
Guy Benyei7f92f2d2012-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 Blaikie9dfd2432013-05-10 21:53:14 +000016#include "CGCXXABI.h"
Guy Benyei7f92f2d2012-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 Carruth3b844ba2013-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 Benyei7f92f2d2012-12-18 14:30:41 +000038#include "llvm/Support/Dwarf.h"
39#include "llvm/Support/FileSystem.h"
40using namespace clang;
41using namespace clang::CodeGen;
42
43CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Eric Christopher13c97672013-05-16 00:45:23 +000044 : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
45 DBuilder(CGM.getModule()),
Guy Benyei7f92f2d2012-12-18 14:30:41 +000046 BlockLiteralGenericSet(false) {
47 CreateCompileUnit();
48}
49
50CGDebugInfo::~CGDebugInfo() {
51 assert(LexicalBlockStack.empty() &&
52 "Region stack mismatch, stack not empty!");
53}
54
55void CGDebugInfo::setLocation(SourceLocation Loc) {
56 // If the new location isn't valid return.
57 if (!Loc.isValid()) return;
58
59 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
60
61 // If we've changed files in the middle of a lexical scope go ahead
62 // and create a new lexical scope with file node if it's different
63 // from the one in the scope.
64 if (LexicalBlockStack.empty()) return;
65
66 SourceManager &SM = CGM.getContext().getSourceManager();
67 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
68 PresumedLoc PPLoc = SM.getPresumedLoc(PrevLoc);
69
70 if (PCLoc.isInvalid() || PPLoc.isInvalid() ||
71 !strcmp(PPLoc.getFilename(), PCLoc.getFilename()))
72 return;
73
74 llvm::MDNode *LB = LexicalBlockStack.back();
75 llvm::DIScope Scope = llvm::DIScope(LB);
76 if (Scope.isLexicalBlockFile()) {
77 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(LB);
78 llvm::DIDescriptor D
79 = DBuilder.createLexicalBlockFile(LBF.getScope(),
80 getOrCreateFile(CurLoc));
81 llvm::MDNode *N = D;
82 LexicalBlockStack.pop_back();
83 LexicalBlockStack.push_back(N);
David Blaikiea6504852013-01-26 22:16:26 +000084 } else if (Scope.isLexicalBlock() || Scope.isSubprogram()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +000085 llvm::DIDescriptor D
86 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
87 llvm::MDNode *N = D;
88 LexicalBlockStack.pop_back();
89 LexicalBlockStack.push_back(N);
90 }
91}
92
93/// getContextDescriptor - Get context info for the decl.
David Blaikiebb000792013-04-19 06:56:38 +000094llvm::DIScope CGDebugInfo::getContextDescriptor(const Decl *Context) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +000095 if (!Context)
96 return TheCU;
97
98 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
99 I = RegionMap.find(Context);
100 if (I != RegionMap.end()) {
101 llvm::Value *V = I->second;
David Blaikiebb000792013-04-19 06:56:38 +0000102 return llvm::DIScope(dyn_cast_or_null<llvm::MDNode>(V));
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000103 }
104
105 // Check namespace.
106 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
David Blaikiebb000792013-04-19 06:56:38 +0000107 return getOrCreateNameSpace(NSDecl);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000108
David Blaikiebb000792013-04-19 06:56:38 +0000109 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context))
110 if (!RDecl->isDependentType())
111 return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000112 getOrCreateMainFile());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000113 return TheCU;
114}
115
116/// getFunctionName - Get function name for the given FunctionDecl. If the
117/// name is constructred on demand (e.g. C++ destructor) then the name
118/// is stored on the side.
119StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
120 assert (FD && "Invalid FunctionDecl!");
121 IdentifierInfo *FII = FD->getIdentifier();
122 FunctionTemplateSpecializationInfo *Info
123 = FD->getTemplateSpecializationInfo();
124 if (!Info && FII)
125 return FII->getName();
126
127 // Otherwise construct human readable name for debug info.
Benjamin Kramer5eada842013-02-22 15:46:01 +0000128 SmallString<128> NS;
129 llvm::raw_svector_ostream OS(NS);
130 FD->printName(OS);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000131
132 // Add any template specialization args.
133 if (Info) {
134 const TemplateArgumentList *TArgs = Info->TemplateArguments;
135 const TemplateArgument *Args = TArgs->data();
136 unsigned NumArgs = TArgs->size();
137 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer5eada842013-02-22 15:46:01 +0000138 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
139 Policy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000140 }
141
142 // Copy this name on the side and use its reference.
Benjamin Kramer5eada842013-02-22 15:46:01 +0000143 OS.flush();
144 char *StrPtr = DebugInfoNames.Allocate<char>(NS.size());
145 memcpy(StrPtr, NS.data(), NS.size());
146 return StringRef(StrPtr, NS.size());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000147}
148
149StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
150 SmallString<256> MethodName;
151 llvm::raw_svector_ostream OS(MethodName);
152 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
153 const DeclContext *DC = OMD->getDeclContext();
Eric Christopher6537f082013-05-16 00:45:12 +0000154 if (const ObjCImplementationDecl *OID =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000155 dyn_cast<const ObjCImplementationDecl>(DC)) {
156 OS << OID->getName();
Eric Christopher6537f082013-05-16 00:45:12 +0000157 } else if (const ObjCInterfaceDecl *OID =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000158 dyn_cast<const ObjCInterfaceDecl>(DC)) {
159 OS << OID->getName();
Eric Christopher6537f082013-05-16 00:45:12 +0000160 } else if (const ObjCCategoryImplDecl *OCD =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000161 dyn_cast<const ObjCCategoryImplDecl>(DC)){
162 OS << ((const NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
163 OCD->getIdentifier()->getNameStart() << ')';
Adrian Prantlb5092242013-05-17 23:58:45 +0000164 } else if (isa<ObjCProtocolDecl>(DC)) {
Adrian Prantl687ecae2013-05-17 23:49:10 +0000165 // We can extract the type of the class from the self pointer.
166 if (ImplicitParamDecl* SelfDecl = OMD->getSelfDecl()) {
167 QualType ClassTy =
168 cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
169 ClassTy.print(OS, PrintingPolicy(LangOptions()));
170 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000171 }
172 OS << ' ' << OMD->getSelector().getAsString() << ']';
173
174 char *StrPtr = DebugInfoNames.Allocate<char>(OS.tell());
175 memcpy(StrPtr, MethodName.begin(), OS.tell());
176 return StringRef(StrPtr, OS.tell());
177}
178
179/// getSelectorName - Return selector name. This is used for debugging
180/// info.
181StringRef CGDebugInfo::getSelectorName(Selector S) {
182 const std::string &SName = S.getAsString();
183 char *StrPtr = DebugInfoNames.Allocate<char>(SName.size());
184 memcpy(StrPtr, SName.data(), SName.size());
185 return StringRef(StrPtr, SName.size());
186}
187
188/// getClassName - Get class name including template argument list.
Eric Christopher6537f082013-05-16 00:45:12 +0000189StringRef
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000190CGDebugInfo::getClassName(const RecordDecl *RD) {
191 const ClassTemplateSpecializationDecl *Spec
192 = dyn_cast<ClassTemplateSpecializationDecl>(RD);
193 if (!Spec)
194 return RD->getName();
195
196 const TemplateArgument *Args;
197 unsigned NumArgs;
198 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
199 const TemplateSpecializationType *TST =
200 cast<TemplateSpecializationType>(TAW->getType());
201 Args = TST->getArgs();
202 NumArgs = TST->getNumArgs();
203 } else {
204 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
205 Args = TemplateArgs.data();
206 NumArgs = TemplateArgs.size();
207 }
208 StringRef Name = RD->getIdentifier()->getName();
209 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramer5eada842013-02-22 15:46:01 +0000210 SmallString<128> TemplateArgList;
211 {
212 llvm::raw_svector_ostream OS(TemplateArgList);
213 TemplateSpecializationType::PrintTemplateArgumentList(OS, Args, NumArgs,
214 Policy);
215 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000216
217 // Copy this name on the side and use its reference.
218 size_t Length = Name.size() + TemplateArgList.size();
219 char *StrPtr = DebugInfoNames.Allocate<char>(Length);
220 memcpy(StrPtr, Name.data(), Name.size());
221 memcpy(StrPtr + Name.size(), TemplateArgList.data(), TemplateArgList.size());
222 return StringRef(StrPtr, Length);
223}
224
225/// getOrCreateFile - Get the file debug info descriptor for the input location.
226llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
227 if (!Loc.isValid())
228 // If Location is not valid then use main input file.
229 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
230
231 SourceManager &SM = CGM.getContext().getSourceManager();
232 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
233
234 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
235 // If the location is not valid then use main input file.
236 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
237
238 // Cache the results.
239 const char *fname = PLoc.getFilename();
240 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
241 DIFileCache.find(fname);
242
243 if (it != DIFileCache.end()) {
244 // Verify that the information still exists.
245 if (llvm::Value *V = it->second)
246 return llvm::DIFile(cast<llvm::MDNode>(V));
247 }
248
249 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
250
251 DIFileCache[fname] = F;
252 return F;
253}
254
255/// getOrCreateMainFile - Get the file info for main compile unit.
256llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
257 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
258}
259
260/// getLineNumber - Get line number for the location. If location is invalid
261/// then use current location.
262unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
263 if (Loc.isInvalid() && CurLoc.isInvalid())
264 return 0;
265 SourceManager &SM = CGM.getContext().getSourceManager();
266 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
267 return PLoc.isValid()? PLoc.getLine() : 0;
268}
269
270/// getColumnNumber - Get column number for the location.
Adrian Prantl00df5ea2013-03-12 20:43:25 +0000271unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000272 // We may not want column information at all.
Adrian Prantl00df5ea2013-03-12 20:43:25 +0000273 if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000274 return 0;
275
276 // If the location is invalid then use the current column.
277 if (Loc.isInvalid() && CurLoc.isInvalid())
278 return 0;
279 SourceManager &SM = CGM.getContext().getSourceManager();
280 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
281 return PLoc.isValid()? PLoc.getColumn() : 0;
282}
283
284StringRef CGDebugInfo::getCurrentDirname() {
285 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
286 return CGM.getCodeGenOpts().DebugCompilationDir;
287
288 if (!CWDName.empty())
289 return CWDName;
290 SmallString<256> CWD;
291 llvm::sys::fs::current_path(CWD);
292 char *CompDirnamePtr = DebugInfoNames.Allocate<char>(CWD.size());
293 memcpy(CompDirnamePtr, CWD.data(), CWD.size());
294 return CWDName = StringRef(CompDirnamePtr, CWD.size());
295}
296
297/// CreateCompileUnit - Create new compile unit.
298void CGDebugInfo::CreateCompileUnit() {
299
300 // Get absolute path name.
301 SourceManager &SM = CGM.getContext().getSourceManager();
302 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
303 if (MainFileName.empty())
304 MainFileName = "<unknown>";
305
306 // The main file name provided via the "-main-file-name" option contains just
307 // the file name itself with no path information. This file name may have had
308 // a relative path, so we look into the actual file entry for the main
309 // file to determine the real absolute path for the file.
310 std::string MainFileDir;
311 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
312 MainFileDir = MainFile->getDir()->getName();
313 if (MainFileDir != ".")
314 MainFileName = MainFileDir + "/" + MainFileName;
315 }
316
317 // Save filename string.
318 char *FilenamePtr = DebugInfoNames.Allocate<char>(MainFileName.length());
319 memcpy(FilenamePtr, MainFileName.c_str(), MainFileName.length());
320 StringRef Filename(FilenamePtr, MainFileName.length());
Eric Christopherff971d72013-02-22 23:50:16 +0000321
322 // Save split dwarf file string.
323 std::string SplitDwarfFile = CGM.getCodeGenOpts().SplitDwarfFile;
324 char *SplitDwarfPtr = DebugInfoNames.Allocate<char>(SplitDwarfFile.length());
325 memcpy(SplitDwarfPtr, SplitDwarfFile.c_str(), SplitDwarfFile.length());
326 StringRef SplitDwarfFilename(SplitDwarfPtr, SplitDwarfFile.length());
Eric Christopher6537f082013-05-16 00:45:12 +0000327
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000328 unsigned LangTag;
329 const LangOptions &LO = CGM.getLangOpts();
330 if (LO.CPlusPlus) {
331 if (LO.ObjC1)
332 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
333 else
334 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
335 } else if (LO.ObjC1) {
336 LangTag = llvm::dwarf::DW_LANG_ObjC;
337 } else if (LO.C99) {
338 LangTag = llvm::dwarf::DW_LANG_C99;
339 } else {
340 LangTag = llvm::dwarf::DW_LANG_C89;
341 }
342
343 std::string Producer = getClangFullVersion();
344
345 // Figure out which version of the ObjC runtime we have.
346 unsigned RuntimeVers = 0;
347 if (LO.ObjC1)
348 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
349
350 // Create new compile unit.
Eric Christopherbe5f1be2013-02-21 22:35:08 +0000351 DBuilder.createCompileUnit(LangTag, Filename, getCurrentDirname(),
352 Producer, LO.Optimize,
Eric Christopherff971d72013-02-22 23:50:16 +0000353 CGM.getCodeGenOpts().DwarfDebugFlags,
354 RuntimeVers, SplitDwarfFilename);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000355 // FIXME - Eliminate TheCU.
356 TheCU = llvm::DICompileUnit(DBuilder.getCU());
357}
358
359/// CreateType - Get the Basic type from the cache or create a new
360/// one if necessary.
361llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
362 unsigned Encoding = 0;
363 StringRef BTName;
364 switch (BT->getKind()) {
365#define BUILTIN_TYPE(Id, SingletonId)
366#define PLACEHOLDER_TYPE(Id, SingletonId) \
367 case BuiltinType::Id:
368#include "clang/AST/BuiltinTypes.def"
369 case BuiltinType::Dependent:
370 llvm_unreachable("Unexpected builtin type");
371 case BuiltinType::NullPtr:
372 return DBuilder.
373 createNullPtrType(BT->getName(CGM.getLangOpts()));
374 case BuiltinType::Void:
375 return llvm::DIType();
376 case BuiltinType::ObjCClass:
377 if (ClassTy.Verify())
378 return ClassTy;
379 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
380 "objc_class", TheCU,
381 getOrCreateMainFile(), 0);
382 return ClassTy;
383 case BuiltinType::ObjCId: {
384 // typedef struct objc_class *Class;
385 // typedef struct objc_object {
386 // Class isa;
387 // } *id;
388
389 if (ObjTy.Verify())
390 return ObjTy;
391
392 if (!ClassTy.Verify())
393 ClassTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
394 "objc_class", TheCU,
395 getOrCreateMainFile(), 0);
396
397 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
Eric Christopher6537f082013-05-16 00:45:12 +0000398
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000399 llvm::DIType ISATy = DBuilder.createPointerType(ClassTy, Size);
400
Eric Christopherf068c922013-04-02 22:59:11 +0000401 ObjTy =
David Blaikiec1d0af12013-02-25 01:07:08 +0000402 DBuilder.createStructType(TheCU, "objc_object", getOrCreateMainFile(),
403 0, 0, 0, 0, llvm::DIType(), llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000404
Eric Christopherf068c922013-04-02 22:59:11 +0000405 ObjTy.setTypeArray(DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
406 ObjTy, "isa", getOrCreateMainFile(), 0, Size, 0, 0, 0, ISATy)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000407 return ObjTy;
408 }
409 case BuiltinType::ObjCSel: {
410 if (SelTy.Verify())
411 return SelTy;
412 SelTy =
413 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
414 "objc_selector", TheCU, getOrCreateMainFile(),
415 0);
416 return SelTy;
417 }
Guy Benyeib13621d2012-12-18 14:38:23 +0000418
419 case BuiltinType::OCLImage1d:
420 return getOrCreateStructPtrType("opencl_image1d_t",
421 OCLImage1dDITy);
422 case BuiltinType::OCLImage1dArray:
Eric Christopher6537f082013-05-16 00:45:12 +0000423 return getOrCreateStructPtrType("opencl_image1d_array_t",
Guy Benyeib13621d2012-12-18 14:38:23 +0000424 OCLImage1dArrayDITy);
425 case BuiltinType::OCLImage1dBuffer:
426 return getOrCreateStructPtrType("opencl_image1d_buffer_t",
427 OCLImage1dBufferDITy);
428 case BuiltinType::OCLImage2d:
429 return getOrCreateStructPtrType("opencl_image2d_t",
430 OCLImage2dDITy);
431 case BuiltinType::OCLImage2dArray:
432 return getOrCreateStructPtrType("opencl_image2d_array_t",
433 OCLImage2dArrayDITy);
434 case BuiltinType::OCLImage3d:
435 return getOrCreateStructPtrType("opencl_image3d_t",
436 OCLImage3dDITy);
Guy Benyei21f18c42013-02-07 10:55:47 +0000437 case BuiltinType::OCLSampler:
438 return DBuilder.createBasicType("opencl_sampler_t",
439 CGM.getContext().getTypeSize(BT),
440 CGM.getContext().getTypeAlign(BT),
441 llvm::dwarf::DW_ATE_unsigned);
Guy Benyeie6b9d802013-01-20 12:31:11 +0000442 case BuiltinType::OCLEvent:
443 return getOrCreateStructPtrType("opencl_event_t",
444 OCLEventDITy);
Guy Benyeib13621d2012-12-18 14:38:23 +0000445
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000446 case BuiltinType::UChar:
447 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
448 case BuiltinType::Char_S:
449 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
450 case BuiltinType::Char16:
451 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
452 case BuiltinType::UShort:
453 case BuiltinType::UInt:
454 case BuiltinType::UInt128:
455 case BuiltinType::ULong:
456 case BuiltinType::WChar_U:
457 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
458 case BuiltinType::Short:
459 case BuiltinType::Int:
460 case BuiltinType::Int128:
461 case BuiltinType::Long:
462 case BuiltinType::WChar_S:
463 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
464 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
465 case BuiltinType::Half:
466 case BuiltinType::Float:
467 case BuiltinType::LongDouble:
468 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
469 }
470
471 switch (BT->getKind()) {
472 case BuiltinType::Long: BTName = "long int"; break;
473 case BuiltinType::LongLong: BTName = "long long int"; break;
474 case BuiltinType::ULong: BTName = "long unsigned int"; break;
475 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
476 default:
477 BTName = BT->getName(CGM.getLangOpts());
478 break;
479 }
480 // Bit size, align and offset of the type.
481 uint64_t Size = CGM.getContext().getTypeSize(BT);
482 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Eric Christopher6537f082013-05-16 00:45:12 +0000483 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000484 DBuilder.createBasicType(BTName, Size, Align, Encoding);
485 return DbgTy;
486}
487
488llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
489 // Bit size, align and offset of the type.
490 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
491 if (Ty->isComplexIntegerType())
492 Encoding = llvm::dwarf::DW_ATE_lo_user;
493
494 uint64_t Size = CGM.getContext().getTypeSize(Ty);
495 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Eric Christopher6537f082013-05-16 00:45:12 +0000496 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000497 DBuilder.createBasicType("complex", Size, Align, Encoding);
498
499 return DbgTy;
500}
501
502/// CreateCVRType - Get the qualified type from the cache or create
503/// a new one if necessary.
David Blaikie5f6e2f42013-06-05 05:32:23 +0000504llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit, bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000505 QualifierCollector Qc;
506 const Type *T = Qc.strip(Ty);
507
508 // Ignore these qualifiers for now.
509 Qc.removeObjCGCAttr();
510 Qc.removeAddressSpace();
511 Qc.removeObjCLifetime();
512
513 // We will create one Derived type for one qualifier and recurse to handle any
514 // additional ones.
515 unsigned Tag;
516 if (Qc.hasConst()) {
517 Tag = llvm::dwarf::DW_TAG_const_type;
518 Qc.removeConst();
519 } else if (Qc.hasVolatile()) {
520 Tag = llvm::dwarf::DW_TAG_volatile_type;
521 Qc.removeVolatile();
522 } else if (Qc.hasRestrict()) {
523 Tag = llvm::dwarf::DW_TAG_restrict_type;
524 Qc.removeRestrict();
525 } else {
526 assert(Qc.empty() && "Unknown type qualifier for debug info");
527 return getOrCreateType(QualType(T, 0), Unit);
528 }
529
David Blaikie5f6e2f42013-06-05 05:32:23 +0000530 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit, Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000531
532 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
533 // CVR derived types.
534 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Eric Christopher6537f082013-05-16 00:45:12 +0000535
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000536 return DbgTy;
537}
538
539llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
540 llvm::DIFile Unit) {
Fariborz Jahanian05f8ff12013-02-21 20:42:11 +0000541
542 // The frontend treats 'id' as a typedef to an ObjCObjectType,
543 // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
544 // debug info, we want to emit 'id' in both cases.
545 if (Ty->isObjCQualifiedIdType())
546 return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
547
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000548 llvm::DIType DbgTy =
Eric Christopher6537f082013-05-16 00:45:12 +0000549 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000550 Ty->getPointeeType(), Unit);
551 return DbgTy;
552}
553
554llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
555 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +0000556 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000557 Ty->getPointeeType(), Unit);
558}
559
560// Creates a forward declaration for a RecordDecl in the given context.
561llvm::DIType CGDebugInfo::createRecordFwdDecl(const RecordDecl *RD,
562 llvm::DIDescriptor Ctx) {
563 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
564 unsigned Line = getLineNumber(RD->getLocation());
565 StringRef RDName = getClassName(RD);
566
567 unsigned Tag = 0;
568 if (RD->isStruct() || RD->isInterface())
569 Tag = llvm::dwarf::DW_TAG_structure_type;
570 else if (RD->isUnion())
571 Tag = llvm::dwarf::DW_TAG_union_type;
572 else {
573 assert(RD->isClass());
574 Tag = llvm::dwarf::DW_TAG_class_type;
575 }
576
577 // Create the type.
578 return DBuilder.createForwardDecl(Tag, RDName, Ctx, DefUnit, Line);
579}
580
581// Walk up the context chain and create forward decls for record decls,
582// and normal descriptors for namespaces.
583llvm::DIDescriptor CGDebugInfo::createContextChain(const Decl *Context) {
584 if (!Context)
585 return TheCU;
586
587 // See if we already have the parent.
588 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
589 I = RegionMap.find(Context);
590 if (I != RegionMap.end()) {
591 llvm::Value *V = I->second;
592 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(V));
593 }
Eric Christopher6537f082013-05-16 00:45:12 +0000594
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000595 // Check namespace.
596 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
597 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
598
599 if (const RecordDecl *RD = dyn_cast<RecordDecl>(Context)) {
600 if (!RD->isDependentType()) {
Eric Christopherf0890c42013-05-16 00:52:20 +0000601 llvm::DIType Ty =
602 getOrCreateLimitedType(CGM.getContext().getTypeDeclType(RD),
603 getOrCreateMainFile());
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000604 return llvm::DIDescriptor(Ty);
605 }
606 }
607 return TheCU;
608}
609
David Blaikieb0f77b02013-05-24 21:33:22 +0000610/// getOrCreateTypeDeclaration - Create Pointee type. If Pointee is a record
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000611/// then emit record's fwd if debug info size reduction is enabled.
David Blaikieb0f77b02013-05-24 21:33:22 +0000612llvm::DIType CGDebugInfo::getOrCreateTypeDeclaration(QualType PointeeTy,
613 llvm::DIFile Unit) {
David Blaikie9faebd22013-05-20 04:58:53 +0000614 if (DebugKind > CodeGenOptions::LimitedDebugInfo)
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000615 return getOrCreateType(PointeeTy, Unit);
David Blaikie5f6e2f42013-06-05 05:32:23 +0000616 return getOrCreateType(PointeeTy, Unit, true);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000617}
618
619llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
Eric Christopher6537f082013-05-16 00:45:12 +0000620 const Type *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000621 QualType PointeeTy,
622 llvm::DIFile Unit) {
623 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
624 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
David Blaikieb0f77b02013-05-24 21:33:22 +0000625 return DBuilder.createReferenceType(
626 Tag, getOrCreateTypeDeclaration(PointeeTy, Unit));
Fariborz Jahanian05f8ff12013-02-21 20:42:11 +0000627
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000628 // Bit size, align and offset of the type.
629 // Size is always the size of a pointer. We can't use getTypeSize here
630 // because that does not return the correct value for references.
631 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCall64aa4b32013-04-16 22:48:15 +0000632 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000633 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
634
David Blaikieb0f77b02013-05-24 21:33:22 +0000635 return DBuilder.createPointerType(getOrCreateTypeDeclaration(PointeeTy, Unit),
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000636 Size, Align);
637}
638
Eric Christopherf0890c42013-05-16 00:52:20 +0000639llvm::DIType CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
640 llvm::DIType &Cache) {
David Blaikie1e97c1e2013-05-21 17:58:54 +0000641 if (Cache.Verify())
Guy Benyeib13621d2012-12-18 14:38:23 +0000642 return Cache;
David Blaikie1e97c1e2013-05-21 17:58:54 +0000643 Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
644 TheCU, getOrCreateMainFile(), 0);
645 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
646 Cache = DBuilder.createPointerType(Cache, Size);
647 return Cache;
Guy Benyeib13621d2012-12-18 14:38:23 +0000648}
649
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000650llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
651 llvm::DIFile Unit) {
652 if (BlockLiteralGenericSet)
653 return BlockLiteralGeneric;
654
655 SmallVector<llvm::Value *, 8> EltTys;
656 llvm::DIType FieldTy;
657 QualType FType;
658 uint64_t FieldSize, FieldOffset;
659 unsigned FieldAlign;
660 llvm::DIArray Elements;
661 llvm::DIType EltTy, DescTy;
662
663 FieldOffset = 0;
664 FType = CGM.getContext().UnsignedLongTy;
665 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
666 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
667
668 Elements = DBuilder.getOrCreateArray(EltTys);
669 EltTys.clear();
670
671 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
672 unsigned LineNo = getLineNumber(CurLoc);
673
674 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
675 Unit, LineNo, FieldOffset, 0,
David Blaikiec1d0af12013-02-25 01:07:08 +0000676 Flags, llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000677
678 // Bit size, align and offset of the type.
679 uint64_t Size = CGM.getContext().getTypeSize(Ty);
680
681 DescTy = DBuilder.createPointerType(EltTy, Size);
682
683 FieldOffset = 0;
684 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
685 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
686 FType = CGM.getContext().IntTy;
687 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
688 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
689 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
690 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
691
692 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
693 FieldTy = DescTy;
694 FieldSize = CGM.getContext().getTypeSize(Ty);
695 FieldAlign = CGM.getContext().getTypeAlign(Ty);
696 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
697 LineNo, FieldSize, FieldAlign,
698 FieldOffset, 0, FieldTy);
699 EltTys.push_back(FieldTy);
700
701 FieldOffset += FieldSize;
702 Elements = DBuilder.getOrCreateArray(EltTys);
703
704 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
705 Unit, LineNo, FieldOffset, 0,
David Blaikiec1d0af12013-02-25 01:07:08 +0000706 Flags, llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000707
708 BlockLiteralGenericSet = true;
709 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
710 return BlockLiteralGeneric;
711}
712
David Blaikie5f6e2f42013-06-05 05:32:23 +0000713llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit,
714 bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000715 // Typedefs are derived from some other type. If we have a typedef of a
716 // typedef, make sure to emit the whole chain.
David Blaikieb0f77b02013-05-24 21:33:22 +0000717 llvm::DIType Src =
David Blaikie5f6e2f42013-06-05 05:32:23 +0000718 getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit, Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000719 if (!Src.Verify())
720 return llvm::DIType();
721 // We don't set size information, but do specify where the typedef was
722 // declared.
723 unsigned Line = getLineNumber(Ty->getDecl()->getLocation());
724 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopher6537f082013-05-16 00:45:12 +0000725
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000726 llvm::DIDescriptor TypedefContext =
727 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopher6537f082013-05-16 00:45:12 +0000728
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000729 return
730 DBuilder.createTypedef(Src, TyDecl->getName(), Unit, Line, TypedefContext);
731}
732
733llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
734 llvm::DIFile Unit) {
735 SmallVector<llvm::Value *, 16> EltTys;
736
737 // Add the result type at least.
738 EltTys.push_back(getOrCreateType(Ty->getResultType(), Unit));
739
740 // Set up remainder of arguments if there is a prototype.
741 // FIXME: IF NOT, HOW IS THIS REPRESENTED? llvm-gcc doesn't represent '...'!
742 if (isa<FunctionNoProtoType>(Ty))
743 EltTys.push_back(DBuilder.createUnspecifiedParameter());
744 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
745 for (unsigned i = 0, e = FPT->getNumArgs(); i != e; ++i)
746 EltTys.push_back(getOrCreateType(FPT->getArgType(i), Unit));
747 }
748
749 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
750 return DBuilder.createSubroutineType(Unit, EltTypeArray);
751}
752
753
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000754llvm::DIType CGDebugInfo::createFieldType(StringRef name,
755 QualType type,
756 uint64_t sizeInBitsOverride,
757 SourceLocation loc,
758 AccessSpecifier AS,
759 uint64_t offsetInBits,
760 llvm::DIFile tunit,
761 llvm::DIDescriptor scope) {
762 llvm::DIType debugType = getOrCreateType(type, tunit);
763
764 // Get the location for the field.
765 llvm::DIFile file = getOrCreateFile(loc);
766 unsigned line = getLineNumber(loc);
767
768 uint64_t sizeInBits = 0;
769 unsigned alignInBits = 0;
770 if (!type->isIncompleteArrayType()) {
771 llvm::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
772
773 if (sizeInBitsOverride)
774 sizeInBits = sizeInBitsOverride;
775 }
776
777 unsigned flags = 0;
778 if (AS == clang::AS_private)
779 flags |= llvm::DIDescriptor::FlagPrivate;
780 else if (AS == clang::AS_protected)
781 flags |= llvm::DIDescriptor::FlagProtected;
782
783 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
784 alignInBits, offsetInBits, flags, debugType);
785}
786
Eric Christopher0395de32013-01-16 01:22:32 +0000787/// CollectRecordLambdaFields - Helper for CollectRecordFields.
788void CGDebugInfo::
789CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
790 SmallVectorImpl<llvm::Value *> &elements,
791 llvm::DIType RecordTy) {
792 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
793 // has the name and the location of the variable so we should iterate over
794 // both concurrently.
795 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
796 RecordDecl::field_iterator Field = CXXDecl->field_begin();
797 unsigned fieldno = 0;
798 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
799 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
800 const LambdaExpr::Capture C = *I;
801 if (C.capturesVariable()) {
802 VarDecl *V = C.getCapturedVar();
803 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
804 StringRef VName = V->getName();
805 uint64_t SizeInBitsOverride = 0;
806 if (Field->isBitField()) {
807 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
808 assert(SizeInBitsOverride && "found named 0-width bitfield");
809 }
810 llvm::DIType fieldType
811 = createFieldType(VName, Field->getType(), SizeInBitsOverride,
812 C.getLocation(), Field->getAccess(),
813 layout.getFieldOffset(fieldno), VUnit, RecordTy);
814 elements.push_back(fieldType);
815 } else {
816 // TODO: Need to handle 'this' in some way by probably renaming the
817 // this of the lambda class and having a field member of 'this' or
818 // by using AT_object_pointer for the function and having that be
819 // used as 'this' for semantic references.
820 assert(C.capturesThis() && "Field that isn't captured and isn't this?");
821 FieldDecl *f = *Field;
822 llvm::DIFile VUnit = getOrCreateFile(f->getLocation());
823 QualType type = f->getType();
824 llvm::DIType fieldType
825 = createFieldType("this", type, 0, f->getLocation(), f->getAccess(),
826 layout.getFieldOffset(fieldno), VUnit, RecordTy);
827
828 elements.push_back(fieldType);
829 }
830 }
831}
832
833/// CollectRecordStaticField - Helper for CollectRecordFields.
834void CGDebugInfo::
835CollectRecordStaticField(const VarDecl *Var,
836 SmallVectorImpl<llvm::Value *> &elements,
837 llvm::DIType RecordTy) {
838 // Create the descriptor for the static variable, with or without
839 // constant initializers.
840 llvm::DIFile VUnit = getOrCreateFile(Var->getLocation());
841 llvm::DIType VTy = getOrCreateType(Var->getType(), VUnit);
842
843 // Do not describe enums as static members.
844 if (VTy.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
845 return;
846
847 unsigned LineNumber = getLineNumber(Var->getLocation());
848 StringRef VName = Var->getName();
David Blaikiea89701b2013-01-20 01:19:17 +0000849 llvm::Constant *C = NULL;
Eric Christopher0395de32013-01-16 01:22:32 +0000850 if (Var->getInit()) {
851 const APValue *Value = Var->evaluateValue();
David Blaikiea89701b2013-01-20 01:19:17 +0000852 if (Value) {
853 if (Value->isInt())
854 C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
855 if (Value->isFloat())
856 C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
857 }
Eric Christopher0395de32013-01-16 01:22:32 +0000858 }
859
860 unsigned Flags = 0;
861 AccessSpecifier Access = Var->getAccess();
862 if (Access == clang::AS_private)
863 Flags |= llvm::DIDescriptor::FlagPrivate;
864 else if (Access == clang::AS_protected)
865 Flags |= llvm::DIDescriptor::FlagProtected;
866
867 llvm::DIType GV = DBuilder.createStaticMemberType(RecordTy, VName, VUnit,
David Blaikiea89701b2013-01-20 01:19:17 +0000868 LineNumber, VTy, Flags, C);
Eric Christopher0395de32013-01-16 01:22:32 +0000869 elements.push_back(GV);
870 StaticDataMemberCache[Var->getCanonicalDecl()] = llvm::WeakVH(GV);
871}
872
873/// CollectRecordNormalField - Helper for CollectRecordFields.
874void CGDebugInfo::
875CollectRecordNormalField(const FieldDecl *field, uint64_t OffsetInBits,
876 llvm::DIFile tunit,
877 SmallVectorImpl<llvm::Value *> &elements,
878 llvm::DIType RecordTy) {
879 StringRef name = field->getName();
880 QualType type = field->getType();
881
882 // Ignore unnamed fields unless they're anonymous structs/unions.
883 if (name.empty() && !type->isRecordType())
884 return;
885
886 uint64_t SizeInBitsOverride = 0;
887 if (field->isBitField()) {
888 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
889 assert(SizeInBitsOverride && "found named 0-width bitfield");
890 }
891
892 llvm::DIType fieldType
893 = createFieldType(name, type, SizeInBitsOverride,
894 field->getLocation(), field->getAccess(),
895 OffsetInBits, tunit, RecordTy);
896
897 elements.push_back(fieldType);
898}
899
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000900/// CollectRecordFields - A helper function to collect debug info for
901/// record fields. This is used while creating debug info entry for a Record.
902void CGDebugInfo::
903CollectRecordFields(const RecordDecl *record, llvm::DIFile tunit,
904 SmallVectorImpl<llvm::Value *> &elements,
905 llvm::DIType RecordTy) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000906 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
907
Eric Christopher0395de32013-01-16 01:22:32 +0000908 if (CXXDecl && CXXDecl->isLambda())
909 CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
910 else {
911 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000912
Eric Christopher0395de32013-01-16 01:22:32 +0000913 // Field number for non-static fields.
Eric Christopherfd5ac0d2013-01-04 17:59:07 +0000914 unsigned fieldNo = 0;
Eric Christopher0395de32013-01-16 01:22:32 +0000915
916 // Bookkeeping for an ms struct, which ignores certain fields.
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000917 bool IsMsStruct = record->isMsStruct(CGM.getContext());
918 const FieldDecl *LastFD = 0;
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000919
Eric Christopher0395de32013-01-16 01:22:32 +0000920 // Static and non-static members should appear in the same order as
921 // the corresponding declarations in the source program.
922 for (RecordDecl::decl_iterator I = record->decls_begin(),
923 E = record->decls_end(); I != E; ++I)
924 if (const VarDecl *V = dyn_cast<VarDecl>(*I))
925 CollectRecordStaticField(V, elements, RecordTy);
926 else if (FieldDecl *field = dyn_cast<FieldDecl>(*I)) {
927 if (IsMsStruct) {
928 // Zero-length bitfields following non-bitfield members are
929 // completely ignored; we don't even count them.
930 if (CGM.getContext().ZeroBitfieldFollowsNonBitfield((field), LastFD))
931 continue;
932 LastFD = field;
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000933 }
Eric Christopher0395de32013-01-16 01:22:32 +0000934 CollectRecordNormalField(field, layout.getFieldOffset(fieldNo),
935 tunit, elements, RecordTy);
936
937 // Bump field number for next field.
938 ++fieldNo;
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000939 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000940 }
941}
942
943/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
944/// function type is not updated to include implicit "this" pointer. Use this
945/// routine to get a method type which includes "this" pointer.
David Blaikie9a845292013-05-22 23:22:42 +0000946llvm::DICompositeType
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000947CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
948 llvm::DIFile Unit) {
David Blaikie9c78f9b2013-01-07 23:06:35 +0000949 const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
David Blaikie67f8b5e2013-01-07 22:24:59 +0000950 if (Method->isStatic())
David Blaikie9a845292013-05-22 23:22:42 +0000951 return llvm::DICompositeType(getOrCreateType(QualType(Func, 0), Unit));
David Blaikie9c78f9b2013-01-07 23:06:35 +0000952 return getOrCreateInstanceMethodType(Method->getThisType(CGM.getContext()),
953 Func, Unit);
954}
David Blaikie67f8b5e2013-01-07 22:24:59 +0000955
David Blaikie9a845292013-05-22 23:22:42 +0000956llvm::DICompositeType CGDebugInfo::getOrCreateInstanceMethodType(
David Blaikie9c78f9b2013-01-07 23:06:35 +0000957 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000958 // Add "this" pointer.
David Blaikie9c78f9b2013-01-07 23:06:35 +0000959 llvm::DIArray Args = llvm::DICompositeType(
960 getOrCreateType(QualType(Func, 0), Unit)).getTypeArray();
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000961 assert (Args.getNumElements() && "Invalid number of arguments!");
962
963 SmallVector<llvm::Value *, 16> Elts;
964
965 // First element is always return type. For 'void' functions it is NULL.
966 Elts.push_back(Args.getElement(0));
967
David Blaikie67f8b5e2013-01-07 22:24:59 +0000968 // "this" pointer is always first argument.
David Blaikie9c78f9b2013-01-07 23:06:35 +0000969 const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
David Blaikie67f8b5e2013-01-07 22:24:59 +0000970 if (isa<ClassTemplateSpecializationDecl>(RD)) {
971 // Create pointer type directly in this case.
972 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
973 QualType PointeeTy = ThisPtrTy->getPointeeType();
974 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
John McCall64aa4b32013-04-16 22:48:15 +0000975 uint64_t Size = CGM.getTarget().getPointerWidth(AS);
David Blaikie67f8b5e2013-01-07 22:24:59 +0000976 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
977 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopherf0890c42013-05-16 00:52:20 +0000978 llvm::DIType ThisPtrType =
979 DBuilder.createPointerType(PointeeType, Size, Align);
David Blaikie67f8b5e2013-01-07 22:24:59 +0000980 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
981 // TODO: This and the artificial type below are misleading, the
982 // types aren't artificial the argument is, but the current
983 // metadata doesn't represent that.
984 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
985 Elts.push_back(ThisPtrType);
986 } else {
987 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
988 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
989 ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
990 Elts.push_back(ThisPtrType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000991 }
992
993 // Copy rest of the arguments.
994 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
995 Elts.push_back(Args.getElement(i));
996
997 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
998
999 return DBuilder.createSubroutineType(Unit, EltTypeArray);
1000}
1001
Eric Christopher6537f082013-05-16 00:45:12 +00001002/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001003/// inside a function.
1004static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1005 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1006 return isFunctionLocalClass(NRD);
1007 if (isa<FunctionDecl>(RD->getDeclContext()))
1008 return true;
1009 return false;
1010}
1011
1012/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
1013/// a single member function GlobalDecl.
1014llvm::DISubprogram
1015CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
1016 llvm::DIFile Unit,
1017 llvm::DIType RecordTy) {
Eric Christopher6537f082013-05-16 00:45:12 +00001018 bool IsCtorOrDtor =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001019 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
Eric Christopher6537f082013-05-16 00:45:12 +00001020
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001021 StringRef MethodName = getFunctionName(Method);
David Blaikie9a845292013-05-22 23:22:42 +00001022 llvm::DICompositeType MethodTy = getOrCreateMethodType(Method, Unit);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001023
1024 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1025 // make sense to give a single ctor/dtor a linkage name.
1026 StringRef MethodLinkageName;
1027 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1028 MethodLinkageName = CGM.getMangledName(Method);
1029
1030 // Get the location for the method.
1031 llvm::DIFile MethodDefUnit = getOrCreateFile(Method->getLocation());
1032 unsigned MethodLine = getLineNumber(Method->getLocation());
1033
1034 // Collect virtual method info.
1035 llvm::DIType ContainingType;
Eric Christopher6537f082013-05-16 00:45:12 +00001036 unsigned Virtuality = 0;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001037 unsigned VIndex = 0;
Eric Christopher6537f082013-05-16 00:45:12 +00001038
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001039 if (Method->isVirtual()) {
1040 if (Method->isPure())
1041 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
1042 else
1043 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
Eric Christopher6537f082013-05-16 00:45:12 +00001044
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001045 // It doesn't make sense to give a virtual destructor a vtable index,
1046 // since a single destructor has two entries in the vtable.
1047 if (!isa<CXXDestructorDecl>(Method))
1048 VIndex = CGM.getVTableContext().getMethodVTableIndex(Method);
1049 ContainingType = RecordTy;
1050 }
1051
1052 unsigned Flags = 0;
1053 if (Method->isImplicit())
1054 Flags |= llvm::DIDescriptor::FlagArtificial;
1055 AccessSpecifier Access = Method->getAccess();
1056 if (Access == clang::AS_private)
1057 Flags |= llvm::DIDescriptor::FlagPrivate;
1058 else if (Access == clang::AS_protected)
1059 Flags |= llvm::DIDescriptor::FlagProtected;
1060 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1061 if (CXXC->isExplicit())
1062 Flags |= llvm::DIDescriptor::FlagExplicit;
Eric Christopher6537f082013-05-16 00:45:12 +00001063 } else if (const CXXConversionDecl *CXXC =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001064 dyn_cast<CXXConversionDecl>(Method)) {
1065 if (CXXC->isExplicit())
1066 Flags |= llvm::DIDescriptor::FlagExplicit;
1067 }
1068 if (Method->hasPrototype())
1069 Flags |= llvm::DIDescriptor::FlagPrototyped;
1070
1071 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1072 llvm::DISubprogram SP =
Eric Christopher6537f082013-05-16 00:45:12 +00001073 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001074 MethodDefUnit, MethodLine,
Eric Christopher6537f082013-05-16 00:45:12 +00001075 MethodTy, /*isLocalToUnit=*/false,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001076 /* isDefinition=*/ false,
1077 Virtuality, VIndex, ContainingType,
1078 Flags, CGM.getLangOpts().Optimize, NULL,
1079 TParamsArray);
Eric Christopher6537f082013-05-16 00:45:12 +00001080
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001081 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
1082
1083 return SP;
1084}
1085
1086/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopher6537f082013-05-16 00:45:12 +00001087/// C++ member functions. This is used while creating debug info entry for
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001088/// a Record.
1089void CGDebugInfo::
1090CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
1091 SmallVectorImpl<llvm::Value *> &EltTys,
1092 llvm::DIType RecordTy) {
1093
1094 // Since we want more than just the individual member decls if we
1095 // have templated functions iterate over every declaration to gather
1096 // the functions.
1097 for(DeclContext::decl_iterator I = RD->decls_begin(),
1098 E = RD->decls_end(); I != E; ++I) {
1099 Decl *D = *I;
1100 if (D->isImplicit() && !D->isUsed())
1101 continue;
1102
1103 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
1104 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
1105 else if (FunctionTemplateDecl *FTD = dyn_cast<FunctionTemplateDecl>(D))
1106 for (FunctionTemplateDecl::spec_iterator SI = FTD->spec_begin(),
1107 SE = FTD->spec_end(); SI != SE; ++SI)
1108 EltTys.push_back(CreateCXXMemberFunction(cast<CXXMethodDecl>(*SI), Unit,
1109 RecordTy));
1110 }
Eric Christopher6537f082013-05-16 00:45:12 +00001111}
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001112
1113/// CollectCXXFriends - A helper function to collect debug info for
1114/// C++ base classes. This is used while creating debug info entry for
1115/// a Record.
1116void CGDebugInfo::
1117CollectCXXFriends(const CXXRecordDecl *RD, llvm::DIFile Unit,
1118 SmallVectorImpl<llvm::Value *> &EltTys,
1119 llvm::DIType RecordTy) {
1120 for (CXXRecordDecl::friend_iterator BI = RD->friend_begin(),
1121 BE = RD->friend_end(); BI != BE; ++BI) {
1122 if ((*BI)->isUnsupportedFriend())
1123 continue;
1124 if (TypeSourceInfo *TInfo = (*BI)->getFriendType())
Eric Christopher6537f082013-05-16 00:45:12 +00001125 EltTys.push_back(DBuilder.createFriend(RecordTy,
1126 getOrCreateType(TInfo->getType(),
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001127 Unit)));
1128 }
1129}
1130
1131/// CollectCXXBases - A helper function to collect debug info for
Eric Christopher6537f082013-05-16 00:45:12 +00001132/// C++ base classes. This is used while creating debug info entry for
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001133/// a Record.
1134void CGDebugInfo::
1135CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
1136 SmallVectorImpl<llvm::Value *> &EltTys,
1137 llvm::DIType RecordTy) {
1138
1139 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1140 for (CXXRecordDecl::base_class_const_iterator BI = RD->bases_begin(),
1141 BE = RD->bases_end(); BI != BE; ++BI) {
1142 unsigned BFlags = 0;
1143 uint64_t BaseOffset;
Eric Christopher6537f082013-05-16 00:45:12 +00001144
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001145 const CXXRecordDecl *Base =
1146 cast<CXXRecordDecl>(BI->getType()->getAs<RecordType>()->getDecl());
Eric Christopher6537f082013-05-16 00:45:12 +00001147
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001148 if (BI->isVirtual()) {
1149 // virtual base offset offset is -ve. The code generator emits dwarf
1150 // expression where it expects +ve number.
Eric Christopher6537f082013-05-16 00:45:12 +00001151 BaseOffset =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001152 0 - CGM.getVTableContext()
1153 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
1154 BFlags = llvm::DIDescriptor::FlagVirtual;
1155 } else
1156 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1157 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1158 // BI->isVirtual() and bits when not.
Eric Christopher6537f082013-05-16 00:45:12 +00001159
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001160 AccessSpecifier Access = BI->getAccessSpecifier();
1161 if (Access == clang::AS_private)
1162 BFlags |= llvm::DIDescriptor::FlagPrivate;
1163 else if (Access == clang::AS_protected)
1164 BFlags |= llvm::DIDescriptor::FlagProtected;
Eric Christopher6537f082013-05-16 00:45:12 +00001165
1166 llvm::DIType DTy =
1167 DBuilder.createInheritance(RecordTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001168 getOrCreateType(BI->getType(), Unit),
1169 BaseOffset, BFlags);
1170 EltTys.push_back(DTy);
1171 }
1172}
1173
1174/// CollectTemplateParams - A helper function to collect template parameters.
1175llvm::DIArray CGDebugInfo::
1176CollectTemplateParams(const TemplateParameterList *TPList,
1177 const TemplateArgumentList &TAList,
1178 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001179 SmallVector<llvm::Value *, 16> TemplateParams;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001180 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1181 const TemplateArgument &TA = TAList[i];
1182 const NamedDecl *ND = TPList->getParam(i);
David Blaikie9dfd2432013-05-10 21:53:14 +00001183 switch (TA.getKind()) {
1184 case TemplateArgument::Type: {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001185 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1186 llvm::DITemplateTypeParameter TTP =
1187 DBuilder.createTemplateTypeParameter(TheCU, ND->getName(), TTy);
1188 TemplateParams.push_back(TTP);
David Blaikie9dfd2432013-05-10 21:53:14 +00001189 } break;
1190 case TemplateArgument::Integral: {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001191 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
1192 llvm::DITemplateValueParameter TVP =
David Blaikie9dfd2432013-05-10 21:53:14 +00001193 DBuilder.createTemplateValueParameter(
1194 TheCU, ND->getName(), TTy,
1195 llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral()));
1196 TemplateParams.push_back(TVP);
1197 } break;
1198 case TemplateArgument::Declaration: {
1199 const ValueDecl *D = TA.getAsDecl();
1200 bool InstanceMember = D->isCXXInstanceMember();
1201 QualType T = InstanceMember
1202 ? CGM.getContext().getMemberPointerType(
1203 D->getType(), cast<RecordDecl>(D->getDeclContext())
1204 ->getTypeForDecl())
1205 : CGM.getContext().getPointerType(D->getType());
1206 llvm::DIType TTy = getOrCreateType(T, Unit);
1207 llvm::Value *V = 0;
1208 // Variable pointer template parameters have a value that is the address
1209 // of the variable.
1210 if (const VarDecl *VD = dyn_cast<VarDecl>(D))
1211 V = CGM.GetAddrOfGlobalVar(VD);
1212 // Member function pointers have special support for building them, though
1213 // this is currently unsupported in LLVM CodeGen.
David Blaikief8aa1552013-05-13 06:57:50 +00001214 if (InstanceMember) {
David Blaikie9dfd2432013-05-10 21:53:14 +00001215 if (const CXXMethodDecl *method = dyn_cast<CXXMethodDecl>(D))
1216 V = CGM.getCXXABI().EmitMemberPointer(method);
David Blaikief8aa1552013-05-13 06:57:50 +00001217 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1218 V = CGM.GetAddrOfFunction(FD);
David Blaikie9dfd2432013-05-10 21:53:14 +00001219 // Member data pointers have special handling too to compute the fixed
1220 // offset within the object.
1221 if (isa<FieldDecl>(D)) {
1222 // These five lines (& possibly the above member function pointer
1223 // handling) might be able to be refactored to use similar code in
1224 // CodeGenModule::getMemberPointerConstant
1225 uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1226 CharUnits chars =
1227 CGM.getContext().toCharUnitsFromBits((int64_t) fieldOffset);
1228 V = CGM.getCXXABI().EmitMemberDataPointer(
1229 cast<MemberPointerType>(T.getTypePtr()), chars);
1230 }
1231 llvm::DITemplateValueParameter TVP =
1232 DBuilder.createTemplateValueParameter(TheCU, ND->getName(), TTy, V);
1233 TemplateParams.push_back(TVP);
1234 } break;
1235 case TemplateArgument::NullPtr: {
1236 QualType T = TA.getNullPtrType();
1237 llvm::DIType TTy = getOrCreateType(T, Unit);
1238 llvm::Value *V = 0;
1239 // Special case member data pointer null values since they're actually -1
1240 // instead of zero.
1241 if (const MemberPointerType *MPT =
1242 dyn_cast<MemberPointerType>(T.getTypePtr()))
1243 // But treat member function pointers as simple zero integers because
1244 // it's easier than having a special case in LLVM's CodeGen. If LLVM
1245 // CodeGen grows handling for values of non-null member function
1246 // pointers then perhaps we could remove this special case and rely on
1247 // EmitNullMemberPointer for member function pointers.
1248 if (MPT->isMemberDataPointer())
1249 V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1250 if (!V)
1251 V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1252 llvm::DITemplateValueParameter TVP =
1253 DBuilder.createTemplateValueParameter(TheCU, ND->getName(), TTy, V);
1254 TemplateParams.push_back(TVP);
1255 } break;
1256 case TemplateArgument::Template:
1257 // We could support this with the GCC extension
1258 // DW_TAG_GNU_template_template_param
1259 break;
David Blaikie776a3642013-05-10 22:53:25 +00001260 case TemplateArgument::Pack:
1261 // And this with DW_TAG_GNU_template_parameter_pack
1262 break;
David Blaikiee8065122013-05-10 23:36:06 +00001263 // And the following should never occur:
David Blaikie9dfd2432013-05-10 21:53:14 +00001264 case TemplateArgument::Expression:
1265 case TemplateArgument::TemplateExpansion:
David Blaikie9dfd2432013-05-10 21:53:14 +00001266 case TemplateArgument::Null:
1267 llvm_unreachable(
1268 "These argument types shouldn't exist in concrete types");
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001269 }
1270 }
1271 return DBuilder.getOrCreateArray(TemplateParams);
1272}
1273
1274/// CollectFunctionTemplateParams - A helper function to collect debug
1275/// info for function template parameters.
1276llvm::DIArray CGDebugInfo::
1277CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
1278 if (FD->getTemplatedKind() ==
1279 FunctionDecl::TK_FunctionTemplateSpecialization) {
1280 const TemplateParameterList *TList =
1281 FD->getTemplateSpecializationInfo()->getTemplate()
1282 ->getTemplateParameters();
Eric Christopher6537f082013-05-16 00:45:12 +00001283 return
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001284 CollectTemplateParams(TList, *FD->getTemplateSpecializationArgs(), Unit);
1285 }
1286 return llvm::DIArray();
1287}
1288
1289/// CollectCXXTemplateParams - A helper function to collect debug info for
1290/// template parameters.
1291llvm::DIArray CGDebugInfo::
1292CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1293 llvm::DIFile Unit) {
1294 llvm::PointerUnion<ClassTemplateDecl *,
1295 ClassTemplatePartialSpecializationDecl *>
1296 PU = TSpecial->getSpecializedTemplateOrPartial();
Eric Christopher6537f082013-05-16 00:45:12 +00001297
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001298 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1299 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1300 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1301 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
1302 return CollectTemplateParams(TPList, TAList, Unit);
1303}
1304
1305/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
1306llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
1307 if (VTablePtrType.isValid())
1308 return VTablePtrType;
1309
1310 ASTContext &Context = CGM.getContext();
1311
1312 /* Function type */
1313 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
1314 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
1315 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
1316 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1317 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
1318 "__vtbl_ptr_type");
1319 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1320 return VTablePtrType;
1321}
1322
1323/// getVTableName - Get vtable name for the given Class.
1324StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1325 // Construct gdb compatible name name.
1326 std::string Name = "_vptr$" + RD->getNameAsString();
1327
1328 // Copy this name on the side and use its reference.
1329 char *StrPtr = DebugInfoNames.Allocate<char>(Name.length());
1330 memcpy(StrPtr, Name.data(), Name.length());
1331 return StringRef(StrPtr, Name.length());
1332}
1333
1334
1335/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
1336/// debug info entry in EltTys vector.
1337void CGDebugInfo::
1338CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
1339 SmallVectorImpl<llvm::Value *> &EltTys) {
1340 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1341
1342 // If there is a primary base then it will hold vtable info.
1343 if (RL.getPrimaryBase())
1344 return;
1345
1346 // If this class is not dynamic then there is not any vtable info to collect.
1347 if (!RD->isDynamicClass())
1348 return;
1349
1350 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1351 llvm::DIType VPTR
1352 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Eric Christopherf0890c42013-05-16 00:52:20 +00001353 0, Size, 0, 0,
1354 llvm::DIDescriptor::FlagArtificial,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001355 getOrCreateVTablePtrType(Unit));
1356 EltTys.push_back(VPTR);
1357}
1358
Eric Christopher6537f082013-05-16 00:45:12 +00001359/// getOrCreateRecordType - Emit record type's standalone debug info.
1360llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001361 SourceLocation Loc) {
Eric Christopher13c97672013-05-16 00:45:23 +00001362 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001363 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
1364 return T;
1365}
1366
1367/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1368/// debug info.
1369llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001370 SourceLocation Loc) {
Eric Christopher13c97672013-05-16 00:45:23 +00001371 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001372 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001373 RetainedTypes.push_back(D.getAsOpaquePtr());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001374 return T;
1375}
1376
1377/// CreateType - get structure or union type.
David Blaikie5f6e2f42013-06-05 05:32:23 +00001378llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty, bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001379 RecordDecl *RD = Ty->getDecl();
David Blaikie5f6e2f42013-06-05 05:32:23 +00001380 if (Declaration) {
1381 llvm::DIDescriptor FDContext =
1382 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
1383 llvm::DIType RetTy = createRecordFwdDecl(RD, FDContext);
1384 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RetTy;
1385 return RetTy;
1386 }
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001387
1388 // Get overall information about the record type for the debug info.
1389 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1390
1391 // Records and classes and unions can all be recursive. To handle them, we
1392 // first generate a debug descriptor for the struct as a forward declaration.
1393 // Then (if it is a definition) we go through and get debug info for all of
1394 // its members. Finally, we create a descriptor for the complete type (which
1395 // may refer to the forward decl if the struct is recursive) and replace all
1396 // uses of the forward declaration with the final definition.
1397
Eric Christopherf068c922013-04-02 22:59:11 +00001398 llvm::DICompositeType FwdDecl(
1399 getOrCreateLimitedType(QualType(Ty, 0), DefUnit));
1400 assert(FwdDecl.Verify() &&
David Blaikie9a845292013-05-22 23:22:42 +00001401 "The debug type of a RecordType should be a llvm::DICompositeType");
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001402
1403 if (FwdDecl.isForwardDecl())
1404 return FwdDecl;
1405
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001406 // Push the struct on region stack.
Eric Christopherf068c922013-04-02 22:59:11 +00001407 LexicalBlockStack.push_back(&*FwdDecl);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001408 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1409
Adrian Prantl4919de62013-03-06 22:03:30 +00001410 // Add this to the completed-type cache while we're completing it recursively.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001411 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1412
1413 // Convert all the elements.
1414 SmallVector<llvm::Value *, 16> EltTys;
1415
1416 // Note: The split of CXXDecl information here is intentional, the
1417 // gdb tests will depend on a certain ordering at printout. The debug
1418 // information offsets are still correct if we merge them all together
1419 // though.
1420 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
1421 if (CXXDecl) {
1422 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1423 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
1424 }
1425
Eric Christopher0395de32013-01-16 01:22:32 +00001426 // Collect data fields (including static variables and any initializers).
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001427 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
1428 llvm::DIArray TParamsArray;
1429 if (CXXDecl) {
1430 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
1431 CollectCXXFriends(CXXDecl, DefUnit, EltTys, FwdDecl);
1432 if (const ClassTemplateSpecializationDecl *TSpecial
1433 = dyn_cast<ClassTemplateSpecializationDecl>(RD))
1434 TParamsArray = CollectCXXTemplateParams(TSpecial, DefUnit);
1435 }
1436
1437 LexicalBlockStack.pop_back();
1438 RegionMap.erase(Ty->getDecl());
1439
1440 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherf068c922013-04-02 22:59:11 +00001441 FwdDecl.setTypeArray(Elements, TParamsArray);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001442
Eric Christopherf068c922013-04-02 22:59:11 +00001443 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
1444 return FwdDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001445}
1446
1447/// CreateType - get objective-c object type.
1448llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1449 llvm::DIFile Unit) {
1450 // Ignore protocols.
1451 return getOrCreateType(Ty->getBaseType(), Unit);
1452}
1453
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001454
1455/// \return true if Getter has the default name for the property PD.
1456static bool hasDefaultGetterName(const ObjCPropertyDecl *PD,
1457 const ObjCMethodDecl *Getter) {
1458 assert(PD);
1459 if (!Getter)
1460 return true;
1461
1462 assert(Getter->getDeclName().isObjCZeroArgSelector());
1463 return PD->getName() ==
1464 Getter->getDeclName().getObjCSelector().getNameForSlot(0);
1465}
1466
1467/// \return true if Setter has the default name for the property PD.
1468static bool hasDefaultSetterName(const ObjCPropertyDecl *PD,
1469 const ObjCMethodDecl *Setter) {
1470 assert(PD);
1471 if (!Setter)
1472 return true;
1473
1474 assert(Setter->getDeclName().isObjCOneArgSelector());
1475 // Construct a setter name like SelectorTable::constructSetterName()
1476 // does, but without entering it into the table.
1477 SmallString<100> DefaultName("set");
1478 DefaultName += PD->getName();
1479 DefaultName[3] = toUppercase(DefaultName[3]);
1480 return DefaultName ==
1481 Setter->getDeclName().getObjCSelector().getNameForSlot(0);
1482}
1483
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001484/// CreateType - get objective-c interface type.
1485llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1486 llvm::DIFile Unit) {
1487 ObjCInterfaceDecl *ID = Ty->getDecl();
1488 if (!ID)
1489 return llvm::DIType();
1490
1491 // Get overall information about the record type for the debug info.
1492 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1493 unsigned Line = getLineNumber(ID->getLocation());
1494 unsigned RuntimeLang = TheCU.getLanguage();
1495
1496 // If this is just a forward declaration return a special forward-declaration
1497 // debug type since we won't be able to lay out the entire type.
1498 ObjCInterfaceDecl *Def = ID->getDefinition();
1499 if (!Def) {
1500 llvm::DIType FwdDecl =
1501 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001502 ID->getName(), TheCU, DefUnit, Line,
1503 RuntimeLang);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001504 return FwdDecl;
1505 }
1506
1507 ID = Def;
1508
1509 // Bit size, align and offset of the type.
1510 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1511 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1512
1513 unsigned Flags = 0;
1514 if (ID->getImplementation())
1515 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1516
Eric Christopherf068c922013-04-02 22:59:11 +00001517 llvm::DICompositeType RealDecl =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001518 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1519 Line, Size, Align, Flags,
David Blaikiec1d0af12013-02-25 01:07:08 +00001520 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001521
1522 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1523 // will find it and we're emitting the complete type.
Adrian Prantl4919de62013-03-06 22:03:30 +00001524 QualType QualTy = QualType(Ty, 0);
1525 CompletedTypeCache[QualTy.getAsOpaquePtr()] = RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001526 // Push the struct on region stack.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001527
Eric Christopherf068c922013-04-02 22:59:11 +00001528 LexicalBlockStack.push_back(static_cast<llvm::MDNode*>(RealDecl));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001529 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1530
1531 // Convert all the elements.
1532 SmallVector<llvm::Value *, 16> EltTys;
1533
1534 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1535 if (SClass) {
1536 llvm::DIType SClassTy =
1537 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1538 if (!SClassTy.isValid())
1539 return llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001540
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001541 llvm::DIType InhTag =
1542 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1543 EltTys.push_back(InhTag);
1544 }
1545
1546 for (ObjCContainerDecl::prop_iterator I = ID->prop_begin(),
1547 E = ID->prop_end(); I != E; ++I) {
1548 const ObjCPropertyDecl *PD = *I;
1549 SourceLocation Loc = PD->getLocation();
1550 llvm::DIFile PUnit = getOrCreateFile(Loc);
1551 unsigned PLine = getLineNumber(Loc);
1552 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1553 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1554 llvm::MDNode *PropertyNode =
1555 DBuilder.createObjCProperty(PD->getName(),
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001556 PUnit, PLine,
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001557 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001558 getSelectorName(PD->getGetterName()),
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001559 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001560 getSelectorName(PD->getSetterName()),
1561 PD->getPropertyAttributes(),
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001562 getOrCreateType(PD->getType(), PUnit));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001563 EltTys.push_back(PropertyNode);
1564 }
1565
1566 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1567 unsigned FieldNo = 0;
1568 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1569 Field = Field->getNextIvar(), ++FieldNo) {
1570 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1571 if (!FieldTy.isValid())
1572 return llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001573
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001574 StringRef FieldName = Field->getName();
1575
1576 // Ignore unnamed fields.
1577 if (FieldName.empty())
1578 continue;
1579
1580 // Get the location for the field.
1581 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1582 unsigned FieldLine = getLineNumber(Field->getLocation());
1583 QualType FType = Field->getType();
1584 uint64_t FieldSize = 0;
1585 unsigned FieldAlign = 0;
1586
1587 if (!FType->isIncompleteArrayType()) {
1588
1589 // Bit size, align and offset of the type.
1590 FieldSize = Field->isBitField()
1591 ? Field->getBitWidthValue(CGM.getContext())
1592 : CGM.getContext().getTypeSize(FType);
1593 FieldAlign = CGM.getContext().getTypeAlign(FType);
1594 }
1595
1596 uint64_t FieldOffset;
1597 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1598 // We don't know the runtime offset of an ivar if we're using the
1599 // non-fragile ABI. For bitfields, use the bit offset into the first
1600 // byte of storage of the bitfield. For other fields, use zero.
1601 if (Field->isBitField()) {
1602 FieldOffset = CGM.getObjCRuntime().ComputeBitfieldBitOffset(
1603 CGM, ID, Field);
1604 FieldOffset %= CGM.getContext().getCharWidth();
1605 } else {
1606 FieldOffset = 0;
1607 }
1608 } else {
1609 FieldOffset = RL.getFieldOffset(FieldNo);
1610 }
1611
1612 unsigned Flags = 0;
1613 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1614 Flags = llvm::DIDescriptor::FlagProtected;
1615 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1616 Flags = llvm::DIDescriptor::FlagPrivate;
1617
1618 llvm::MDNode *PropertyNode = NULL;
1619 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopher6537f082013-05-16 00:45:12 +00001620 if (ObjCPropertyImplDecl *PImpD =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001621 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1622 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001623 SourceLocation Loc = PD->getLocation();
1624 llvm::DIFile PUnit = getOrCreateFile(Loc);
1625 unsigned PLine = getLineNumber(Loc);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001626 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1627 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1628 PropertyNode =
1629 DBuilder.createObjCProperty(PD->getName(),
1630 PUnit, PLine,
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001631 hasDefaultGetterName(PD, Getter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001632 getSelectorName(PD->getGetterName()),
Adrian Prantl5ae17a12013-06-07 01:10:45 +00001633 hasDefaultSetterName(PD, Setter) ? "" :
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001634 getSelectorName(PD->getSetterName()),
1635 PD->getPropertyAttributes(),
1636 getOrCreateType(PD->getType(), PUnit));
1637 }
1638 }
1639 }
1640 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1641 FieldLine, FieldSize, FieldAlign,
1642 FieldOffset, Flags, FieldTy,
1643 PropertyNode);
1644 EltTys.push_back(FieldTy);
1645 }
1646
1647 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherf068c922013-04-02 22:59:11 +00001648 RealDecl.setTypeArray(Elements);
Adrian Prantl4919de62013-03-06 22:03:30 +00001649
1650 // If the implementation is not yet set, we do not want to mark it
1651 // as complete. An implementation may declare additional
1652 // private ivars that we would miss otherwise.
1653 if (ID->getImplementation() == 0)
1654 CompletedTypeCache.erase(QualTy.getAsOpaquePtr());
Eric Christopher6537f082013-05-16 00:45:12 +00001655
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001656 LexicalBlockStack.pop_back();
Eric Christopherf068c922013-04-02 22:59:11 +00001657 return RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001658}
1659
1660llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1661 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1662 int64_t Count = Ty->getNumElements();
1663 if (Count == 0)
1664 // If number of elements are not known then this is an unbounded array.
1665 // Use Count == -1 to express such arrays.
1666 Count = -1;
1667
1668 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1669 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1670
1671 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1672 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1673
1674 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1675}
1676
1677llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1678 llvm::DIFile Unit) {
1679 uint64_t Size;
1680 uint64_t Align;
1681
1682 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1683 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1684 Size = 0;
1685 Align =
1686 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1687 } else if (Ty->isIncompleteArrayType()) {
1688 Size = 0;
1689 if (Ty->getElementType()->isIncompleteType())
1690 Align = 0;
1691 else
1692 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikie089db2e2013-05-09 20:48:12 +00001693 } else if (Ty->isIncompleteType()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001694 Size = 0;
1695 Align = 0;
1696 } else {
1697 // Size and align of the whole array, not the element type.
1698 Size = CGM.getContext().getTypeSize(Ty);
1699 Align = CGM.getContext().getTypeAlign(Ty);
1700 }
1701
1702 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1703 // interior arrays, do we care? Why aren't nested arrays represented the
1704 // obvious/recursive way?
1705 SmallVector<llvm::Value *, 8> Subscripts;
1706 QualType EltTy(Ty, 0);
1707 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1708 // If the number of elements is known, then count is that number. Otherwise,
1709 // it's -1. This allows us to represent a subrange with an array of 0
1710 // elements, like this:
1711 //
1712 // struct foo {
1713 // int x[0];
1714 // };
1715 int64_t Count = -1; // Count == -1 is an unbounded array.
1716 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1717 Count = CAT->getSize().getZExtValue();
Eric Christopher6537f082013-05-16 00:45:12 +00001718
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001719 // FIXME: Verify this is right for VLAs.
1720 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1721 EltTy = Ty->getElementType();
1722 }
1723
1724 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1725
Eric Christopher6537f082013-05-16 00:45:12 +00001726 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001727 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1728 SubscriptArray);
1729 return DbgTy;
1730}
1731
Eric Christopher6537f082013-05-16 00:45:12 +00001732llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001733 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001734 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001735 Ty, Ty->getPointeeType(), Unit);
1736}
1737
Eric Christopher6537f082013-05-16 00:45:12 +00001738llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001739 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001740 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001741 Ty, Ty->getPointeeType(), Unit);
1742}
1743
Eric Christopher6537f082013-05-16 00:45:12 +00001744llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001745 llvm::DIFile U) {
David Blaikiee8d75142013-01-19 19:20:56 +00001746 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1747 if (!Ty->getPointeeType()->isFunctionType())
1748 return DBuilder.createMemberPointerType(
David Blaikieb0f77b02013-05-24 21:33:22 +00001749 getOrCreateTypeDeclaration(Ty->getPointeeType(), U), ClassType);
David Blaikiee8d75142013-01-19 19:20:56 +00001750 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
1751 CGM.getContext().getPointerType(
1752 QualType(Ty->getClass(), Ty->getPointeeType().getCVRQualifiers())),
1753 Ty->getPointeeType()->getAs<FunctionProtoType>(), U),
1754 ClassType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001755}
1756
Eric Christopher6537f082013-05-16 00:45:12 +00001757llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001758 llvm::DIFile U) {
1759 // Ignore the atomic wrapping
1760 // FIXME: What is the correct representation?
1761 return getOrCreateType(Ty->getValueType(), U);
1762}
1763
1764/// CreateEnumType - get enumeration type.
1765llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
1766 uint64_t Size = 0;
1767 uint64_t Align = 0;
1768 if (!ED->getTypeForDecl()->isIncompleteType()) {
1769 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1770 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1771 }
1772
1773 // If this is just a forward declaration, construct an appropriately
1774 // marked node and just return it.
1775 if (!ED->getDefinition()) {
1776 llvm::DIDescriptor EDContext;
1777 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1778 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1779 unsigned Line = getLineNumber(ED->getLocation());
1780 StringRef EDName = ED->getName();
1781 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_enumeration_type,
1782 EDName, EDContext, DefUnit, Line, 0,
1783 Size, Align);
1784 }
1785
1786 // Create DIEnumerator elements for each enumerator.
1787 SmallVector<llvm::Value *, 16> Enumerators;
1788 ED = ED->getDefinition();
1789 for (EnumDecl::enumerator_iterator
1790 Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1791 Enum != EnumEnd; ++Enum) {
1792 Enumerators.push_back(
1793 DBuilder.createEnumerator(Enum->getName(),
1794 Enum->getInitVal().getZExtValue()));
1795 }
1796
1797 // Return a CompositeType for the enum itself.
1798 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1799
1800 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1801 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00001802 llvm::DIDescriptor EnumContext =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001803 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantl59d6a712013-04-19 19:56:39 +00001804 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001805 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001806 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001807 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1808 Size, Align, EltArray,
1809 ClassTy);
1810 return DbgTy;
1811}
1812
David Blaikie4b12be62013-01-21 04:37:12 +00001813static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1814 Qualifiers Quals;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001815 do {
David Blaikie4b12be62013-01-21 04:37:12 +00001816 Quals += T.getLocalQualifiers();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001817 QualType LastT = T;
1818 switch (T->getTypeClass()) {
1819 default:
David Blaikie4b12be62013-01-21 04:37:12 +00001820 return C.getQualifiedType(T.getTypePtr(), Quals);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001821 case Type::TemplateSpecialization:
1822 T = cast<TemplateSpecializationType>(T)->desugar();
1823 break;
1824 case Type::TypeOfExpr:
1825 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1826 break;
1827 case Type::TypeOf:
1828 T = cast<TypeOfType>(T)->getUnderlyingType();
1829 break;
1830 case Type::Decltype:
1831 T = cast<DecltypeType>(T)->getUnderlyingType();
1832 break;
1833 case Type::UnaryTransform:
1834 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1835 break;
1836 case Type::Attributed:
1837 T = cast<AttributedType>(T)->getEquivalentType();
1838 break;
1839 case Type::Elaborated:
1840 T = cast<ElaboratedType>(T)->getNamedType();
1841 break;
1842 case Type::Paren:
1843 T = cast<ParenType>(T)->getInnerType();
1844 break;
David Blaikie4b12be62013-01-21 04:37:12 +00001845 case Type::SubstTemplateTypeParm:
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001846 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001847 break;
1848 case Type::Auto:
David Blaikie91296482013-05-24 21:24:35 +00001849 QualType DT = cast<AutoType>(T)->getDeducedType();
1850 if (DT.isNull())
1851 return T;
1852 T = DT;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001853 break;
1854 }
Eric Christopher6537f082013-05-16 00:45:12 +00001855
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001856 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumid24c9ab2013-01-21 10:51:28 +00001857 (void)LastT;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001858 } while (true);
1859}
1860
Eric Christopherf0890c42013-05-16 00:52:20 +00001861/// getType - Get the type from the cache or return null type if it doesn't
1862/// exist.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001863llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
1864
1865 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001866 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopher6537f082013-05-16 00:45:12 +00001867
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001868 // Check for existing entry.
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001869 if (Ty->getTypeClass() == Type::ObjCInterface) {
1870 llvm::Value *V = getCachedInterfaceTypeOrNull(Ty);
1871 if (V)
1872 return llvm::DIType(cast<llvm::MDNode>(V));
1873 else return llvm::DIType();
1874 }
1875
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001876 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1877 TypeCache.find(Ty.getAsOpaquePtr());
1878 if (it != TypeCache.end()) {
1879 // Verify that the debug info still exists.
1880 if (llvm::Value *V = it->second)
1881 return llvm::DIType(cast<llvm::MDNode>(V));
1882 }
1883
1884 return llvm::DIType();
1885}
1886
1887/// getCompletedTypeOrNull - Get the type from the cache or return null if it
1888/// doesn't exist.
1889llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
1890
1891 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001892 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001893
1894 // Check for existing entry.
Adrian Prantl4919de62013-03-06 22:03:30 +00001895 llvm::Value *V = 0;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001896 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1897 CompletedTypeCache.find(Ty.getAsOpaquePtr());
Adrian Prantl4919de62013-03-06 22:03:30 +00001898 if (it != CompletedTypeCache.end())
1899 V = it->second;
1900 else {
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001901 V = getCachedInterfaceTypeOrNull(Ty);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001902 }
1903
Adrian Prantl4919de62013-03-06 22:03:30 +00001904 // Verify that any cached debug info still exists.
1905 if (V != 0)
1906 return llvm::DIType(cast<llvm::MDNode>(V));
1907
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001908 return llvm::DIType();
1909}
1910
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001911/// getCachedInterfaceTypeOrNull - Get the type from the interface
1912/// cache, unless it needs to regenerated. Otherwise return null.
1913llvm::Value *CGDebugInfo::getCachedInterfaceTypeOrNull(QualType Ty) {
1914 // Is there a cached interface that hasn't changed?
1915 llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned > >
1916 ::iterator it1 = ObjCInterfaceCache.find(Ty.getAsOpaquePtr());
1917
1918 if (it1 != ObjCInterfaceCache.end())
1919 if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty))
1920 if (Checksum(Decl) == it1->second.second)
1921 // Return cached forward declaration.
1922 return it1->second.first;
1923
1924 return 0;
1925}
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001926
1927/// getOrCreateType - Get the type from the cache or create a new
1928/// one if necessary.
David Blaikie5f6e2f42013-06-05 05:32:23 +00001929llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit, bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001930 if (Ty.isNull())
1931 return llvm::DIType();
1932
1933 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001934 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001935
1936 llvm::DIType T = getCompletedTypeOrNull(Ty);
1937
1938 if (T.Verify())
1939 return T;
1940
1941 // Otherwise create the type.
David Blaikie5f6e2f42013-06-05 05:32:23 +00001942 llvm::DIType Res = CreateTypeNode(Ty, Unit, Declaration);
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001943 void* TyPtr = Ty.getAsOpaquePtr();
1944
1945 // And update the type cache.
1946 TypeCache[TyPtr] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001947
1948 llvm::DIType TC = getTypeOrNull(Ty);
1949 if (TC.Verify() && TC.isForwardDecl())
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001950 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
1951 else if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty)) {
1952 // Interface types may have elements added to them by a
1953 // subsequent implementation or extension, so we keep them in
1954 // the ObjCInterfaceCache together with a checksum. Instead of
Adrian Prantlf06989b2013-05-08 23:37:22 +00001955 // the (possibly) incomplete interface type, we return a forward
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001956 // declaration that gets RAUW'd in CGDebugInfo::finalize().
David Blaikiee2eb89a2013-05-21 18:29:40 +00001957 std::pair<llvm::WeakVH, unsigned> &V = ObjCInterfaceCache[TyPtr];
1958 if (V.first)
1959 return llvm::DIType(cast<llvm::MDNode>(V.first));
1960 TC = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1961 Decl->getName(), TheCU, Unit,
1962 getLineNumber(Decl->getLocation()),
1963 TheCU.getLanguage());
1964 // Store the forward declaration in the cache.
1965 V.first = TC;
1966 V.second = Checksum(Decl);
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001967
David Blaikiee2eb89a2013-05-21 18:29:40 +00001968 // Register the type for replacement in finalize().
1969 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
1970
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001971 return TC;
Adrian Prantl4919de62013-03-06 22:03:30 +00001972 }
1973
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001974 if (!Res.isForwardDecl())
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001975 CompletedTypeCache[TyPtr] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001976
1977 return Res;
1978}
1979
Adrian Prantlb5a50072013-06-07 01:10:41 +00001980/// Currently the checksum of an interface includes the number of
1981/// ivars and property accessors.
Adrian Prantl4919de62013-03-06 22:03:30 +00001982unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl
Adrian Prantlb5a50072013-06-07 01:10:41 +00001983 *ID) {
Adrian Prantl4f97f852013-06-07 01:10:48 +00001984 // The assumption is that the number of ivars can only increase
1985 // monotonically, so it is safe to just use their current number as
1986 // a checksum.
Adrian Prantlb5a50072013-06-07 01:10:41 +00001987 unsigned Sum = 0;
1988 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
1989 Ivar != 0; Ivar = Ivar->getNextIvar())
1990 ++Sum;
1991
1992 return Sum;
Adrian Prantl4919de62013-03-06 22:03:30 +00001993}
1994
1995ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
1996 switch (Ty->getTypeClass()) {
1997 case Type::ObjCObjectPointer:
Eric Christopherf0890c42013-05-16 00:52:20 +00001998 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
1999 ->getPointeeType());
Adrian Prantl4919de62013-03-06 22:03:30 +00002000 case Type::ObjCInterface:
2001 return cast<ObjCInterfaceType>(Ty)->getDecl();
2002 default:
2003 return 0;
2004 }
2005}
2006
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002007/// CreateTypeNode - Create a new debug type node.
David Blaikie5f6e2f42013-06-05 05:32:23 +00002008llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit, bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002009 // Handle qualifiers, which recursively handles what they refer to.
2010 if (Ty.hasLocalQualifiers())
David Blaikie5f6e2f42013-06-05 05:32:23 +00002011 return CreateQualifiedType(Ty, Unit, Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002012
2013 const char *Diag = 0;
Eric Christopher6537f082013-05-16 00:45:12 +00002014
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002015 // Work out details of type.
2016 switch (Ty->getTypeClass()) {
2017#define TYPE(Class, Base)
2018#define ABSTRACT_TYPE(Class, Base)
2019#define NON_CANONICAL_TYPE(Class, Base)
2020#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2021#include "clang/AST/TypeNodes.def"
2022 llvm_unreachable("Dependent types cannot show up in debug information");
2023
2024 case Type::ExtVector:
2025 case Type::Vector:
2026 return CreateType(cast<VectorType>(Ty), Unit);
2027 case Type::ObjCObjectPointer:
2028 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2029 case Type::ObjCObject:
2030 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2031 case Type::ObjCInterface:
2032 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2033 case Type::Builtin:
2034 return CreateType(cast<BuiltinType>(Ty));
2035 case Type::Complex:
2036 return CreateType(cast<ComplexType>(Ty));
2037 case Type::Pointer:
2038 return CreateType(cast<PointerType>(Ty), Unit);
2039 case Type::BlockPointer:
2040 return CreateType(cast<BlockPointerType>(Ty), Unit);
2041 case Type::Typedef:
David Blaikie5f6e2f42013-06-05 05:32:23 +00002042 return CreateType(cast<TypedefType>(Ty), Unit, Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002043 case Type::Record:
David Blaikie5f6e2f42013-06-05 05:32:23 +00002044 return CreateType(cast<RecordType>(Ty), Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002045 case Type::Enum:
2046 return CreateEnumType(cast<EnumType>(Ty)->getDecl());
2047 case Type::FunctionProto:
2048 case Type::FunctionNoProto:
2049 return CreateType(cast<FunctionType>(Ty), Unit);
2050 case Type::ConstantArray:
2051 case Type::VariableArray:
2052 case Type::IncompleteArray:
2053 return CreateType(cast<ArrayType>(Ty), Unit);
2054
2055 case Type::LValueReference:
2056 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2057 case Type::RValueReference:
2058 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2059
2060 case Type::MemberPointer:
2061 return CreateType(cast<MemberPointerType>(Ty), Unit);
2062
2063 case Type::Atomic:
2064 return CreateType(cast<AtomicType>(Ty), Unit);
2065
2066 case Type::Attributed:
2067 case Type::TemplateSpecialization:
2068 case Type::Elaborated:
2069 case Type::Paren:
2070 case Type::SubstTemplateTypeParm:
2071 case Type::TypeOfExpr:
2072 case Type::TypeOf:
2073 case Type::Decltype:
2074 case Type::UnaryTransform:
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002075 llvm_unreachable("type should have been unwrapped!");
David Blaikie91296482013-05-24 21:24:35 +00002076 case Type::Auto:
2077 Diag = "auto";
2078 break;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002079 }
Eric Christopher6537f082013-05-16 00:45:12 +00002080
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002081 assert(Diag && "Fall through without a diagnostic?");
2082 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2083 "debug information for %0 is not yet supported");
2084 CGM.getDiags().Report(DiagID)
2085 << Diag;
2086 return llvm::DIType();
2087}
2088
2089/// getOrCreateLimitedType - Get the type from the cache or create a new
2090/// limited type if necessary.
2091llvm::DIType CGDebugInfo::getOrCreateLimitedType(QualType Ty,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002092 llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002093 if (Ty.isNull())
2094 return llvm::DIType();
2095
2096 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00002097 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002098
2099 llvm::DIType T = getTypeOrNull(Ty);
2100
2101 // We may have cached a forward decl when we could have created
2102 // a non-forward decl. Go ahead and create a non-forward decl
2103 // now.
2104 if (T.Verify() && !T.isForwardDecl()) return T;
2105
2106 // Otherwise create the type.
2107 llvm::DIType Res = CreateLimitedTypeNode(Ty, Unit);
2108
2109 if (T.Verify() && T.isForwardDecl())
2110 ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(),
2111 static_cast<llvm::Value*>(T)));
2112
2113 // And update the type cache.
2114 TypeCache[Ty.getAsOpaquePtr()] = Res;
2115 return Res;
2116}
2117
2118// TODO: Currently used for context chains when limiting debug info.
2119llvm::DIType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
2120 RecordDecl *RD = Ty->getDecl();
Eric Christopher6537f082013-05-16 00:45:12 +00002121
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002122 // Get overall information about the record type for the debug info.
2123 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2124 unsigned Line = getLineNumber(RD->getLocation());
2125 StringRef RDName = getClassName(RD);
2126
2127 llvm::DIDescriptor RDContext;
Eric Christopher13c97672013-05-16 00:45:23 +00002128 if (DebugKind == CodeGenOptions::LimitedDebugInfo)
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002129 RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
2130 else
2131 RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
2132
2133 // If this is just a forward declaration, construct an appropriately
2134 // marked node and just return it.
2135 if (!RD->getDefinition())
2136 return createRecordFwdDecl(RD, RDContext);
2137
2138 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2139 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
2140 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie2fcadbe2013-03-26 23:47:35 +00002141 llvm::DICompositeType RealDecl;
Eric Christopher6537f082013-05-16 00:45:12 +00002142
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002143 if (RD->isUnion())
2144 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002145 Size, Align, 0, llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002146 else if (RD->isClass()) {
2147 // FIXME: This could be a struct type giving a default visibility different
2148 // than C++ class type, but needs llvm metadata changes first.
2149 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002150 Size, Align, 0, 0, llvm::DIType(),
2151 llvm::DIArray(), llvm::DIType(),
2152 llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002153 } else
2154 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopherf0890c42013-05-16 00:52:20 +00002155 Size, Align, 0, llvm::DIType(),
2156 llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002157
2158 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie2fcadbe2013-03-26 23:47:35 +00002159 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002160
2161 if (CXXDecl) {
2162 // A class's primary base or the class itself contains the vtable.
David Blaikie2fcadbe2013-03-26 23:47:35 +00002163 llvm::DICompositeType ContainingType;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002164 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2165 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
2166 // Seek non virtual primary base root.
2167 while (1) {
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002168 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2169 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2170 if (PBT && !BRL.isPrimaryBaseVirtual())
2171 PBase = PBT;
2172 else
2173 break;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002174 }
David Blaikie2fcadbe2013-03-26 23:47:35 +00002175 ContainingType = llvm::DICompositeType(
2176 getOrCreateType(QualType(PBase->getTypeForDecl(), 0), DefUnit));
2177 } else if (CXXDecl->isDynamicClass())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002178 ContainingType = RealDecl;
2179
David Blaikie2fcadbe2013-03-26 23:47:35 +00002180 RealDecl.setContainingType(ContainingType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002181 }
2182 return llvm::DIType(RealDecl);
2183}
2184
2185/// CreateLimitedTypeNode - Create a new debug type node, but only forward
2186/// declare composite types that haven't been processed yet.
2187llvm::DIType CGDebugInfo::CreateLimitedTypeNode(QualType Ty,llvm::DIFile Unit) {
2188
2189 // Work out details of type.
2190 switch (Ty->getTypeClass()) {
2191#define TYPE(Class, Base)
2192#define ABSTRACT_TYPE(Class, Base)
2193#define NON_CANONICAL_TYPE(Class, Base)
2194#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2195 #include "clang/AST/TypeNodes.def"
2196 llvm_unreachable("Dependent types cannot show up in debug information");
2197
2198 case Type::Record:
2199 return CreateLimitedType(cast<RecordType>(Ty));
2200 default:
David Blaikie5f6e2f42013-06-05 05:32:23 +00002201 return CreateTypeNode(Ty, Unit, false);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002202 }
2203}
2204
2205/// CreateMemberType - Create new member and increase Offset by FType's size.
2206llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2207 StringRef Name,
2208 uint64_t *Offset) {
2209 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2210 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2211 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2212 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2213 FieldSize, FieldAlign,
2214 *Offset, 0, FieldTy);
2215 *Offset += FieldSize;
2216 return Ty;
2217}
2218
David Blaikie9faebd22013-05-20 04:58:53 +00002219llvm::DIDescriptor CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
2220 // We only need a declaration (not a definition) of the type - so use whatever
2221 // we would otherwise do to get a type for a pointee. (forward declarations in
2222 // limited debug info, full definitions (if the type definition is available)
2223 // in unlimited debug info)
2224 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D)) {
2225 llvm::DIFile DefUnit = getOrCreateFile(TD->getLocation());
David Blaikieb0f77b02013-05-24 21:33:22 +00002226 return getOrCreateTypeDeclaration(CGM.getContext().getTypeDeclType(TD),
2227 DefUnit);
David Blaikie9faebd22013-05-20 04:58:53 +00002228 }
2229 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2230 // This doesn't handle providing declarations (for functions or variables) for
2231 // entities without definitions in this TU, nor when the definition proceeds
2232 // the call to this function.
2233 // FIXME: This should be split out into more specific maps with support for
2234 // emitting forward declarations and merging definitions with declarations,
2235 // the same way as we do for types.
2236 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2237 DeclCache.find(D->getCanonicalDecl());
2238 if (I == DeclCache.end())
2239 return llvm::DIDescriptor();
2240 llvm::Value *V = I->second;
2241 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(V));
2242}
2243
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002244/// getFunctionDeclaration - Return debug info descriptor to describe method
2245/// declaration for the given method definition.
2246llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
2247 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2248 if (!FD) return llvm::DISubprogram();
2249
2250 // Setup context.
2251 getContextDescriptor(cast<Decl>(D->getDeclContext()));
2252
2253 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2254 MI = SPCache.find(FD->getCanonicalDecl());
2255 if (MI != SPCache.end()) {
2256 llvm::Value *V = MI->second;
2257 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
2258 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
2259 return SP;
2260 }
2261
2262 for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
2263 E = FD->redecls_end(); I != E; ++I) {
2264 const FunctionDecl *NextFD = *I;
2265 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2266 MI = SPCache.find(NextFD->getCanonicalDecl());
2267 if (MI != SPCache.end()) {
2268 llvm::Value *V = MI->second;
2269 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
2270 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
2271 return SP;
2272 }
2273 }
2274 return llvm::DISubprogram();
2275}
2276
2277// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2278// implicit parameter "this".
David Blaikie9a845292013-05-22 23:22:42 +00002279llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2280 QualType FnType,
2281 llvm::DIFile F) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002282
2283 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2284 return getOrCreateMethodType(Method, F);
2285 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2286 // Add "self" and "_cmd"
2287 SmallVector<llvm::Value *, 16> Elts;
2288
2289 // First element is always return type. For 'void' functions it is NULL.
Adrian Prantl0cb00022013-05-22 21:37:49 +00002290 QualType ResultTy = OMethod->getResultType();
2291
2292 // Replace the instancetype keyword with the actual type.
2293 if (ResultTy == CGM.getContext().getObjCInstanceType())
2294 ResultTy = CGM.getContext().getPointerType(
2295 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2296
Adrian Prantl566a9c32013-05-10 21:08:31 +00002297 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002298 // "self" pointer is always first argument.
Adrian Prantle86fcc42013-03-29 19:20:29 +00002299 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2300 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2301 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002302 // "_cmd" pointer is always second argument.
2303 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2304 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2305 // Get rest of the arguments.
Eric Christopher6537f082013-05-16 00:45:12 +00002306 for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002307 PE = OMethod->param_end(); PI != PE; ++PI)
2308 Elts.push_back(getOrCreateType((*PI)->getType(), F));
2309
2310 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2311 return DBuilder.createSubroutineType(F, EltTypeArray);
2312 }
David Blaikie9a845292013-05-22 23:22:42 +00002313 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002314}
2315
2316/// EmitFunctionStart - Constructs the debug code for entering a function.
2317void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
2318 llvm::Function *Fn,
2319 CGBuilderTy &Builder) {
2320
2321 StringRef Name;
2322 StringRef LinkageName;
2323
2324 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2325
2326 const Decl *D = GD.getDecl();
2327 // Function may lack declaration in source code if it is created by Clang
2328 // CodeGen (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
2329 bool HasDecl = (D != 0);
2330 // Use the location of the declaration.
2331 SourceLocation Loc;
2332 if (HasDecl)
2333 Loc = D->getLocation();
2334
2335 unsigned Flags = 0;
2336 llvm::DIFile Unit = getOrCreateFile(Loc);
2337 llvm::DIDescriptor FDContext(Unit);
2338 llvm::DIArray TParamsArray;
2339 if (!HasDecl) {
2340 // Use llvm function name.
2341 Name = Fn->getName();
2342 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2343 // If there is a DISubprogram for this function available then use it.
2344 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2345 FI = SPCache.find(FD->getCanonicalDecl());
2346 if (FI != SPCache.end()) {
2347 llvm::Value *V = FI->second;
2348 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2349 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2350 llvm::MDNode *SPN = SP;
2351 LexicalBlockStack.push_back(SPN);
2352 RegionMap[D] = llvm::WeakVH(SP);
2353 return;
2354 }
2355 }
2356 Name = getFunctionName(FD);
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002357 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002358 if (FD->hasPrototype()) {
2359 LinkageName = CGM.getMangledName(GD);
2360 Flags |= llvm::DIDescriptor::FlagPrototyped;
2361 }
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002362 // No need to replicate the linkage name if it isn't different from the
2363 // subprogram name, no need to have it at all unless coverage is enabled or
2364 // debug is set to more than just line tables.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002365 if (LinkageName == Name ||
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002366 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2367 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher13c97672013-05-16 00:45:23 +00002368 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002369 LinkageName = StringRef();
2370
Eric Christopher13c97672013-05-16 00:45:23 +00002371 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002372 if (const NamespaceDecl *NSDecl =
2373 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2374 FDContext = getOrCreateNameSpace(NSDecl);
2375 else if (const RecordDecl *RDecl =
2376 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2377 FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
2378
2379 // Collect template parameters.
2380 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2381 }
2382 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2383 Name = getObjCMethodName(OMD);
2384 Flags |= llvm::DIDescriptor::FlagPrototyped;
2385 } else {
2386 // Use llvm function name.
2387 Name = Fn->getName();
2388 Flags |= llvm::DIDescriptor::FlagPrototyped;
2389 }
2390 if (!Name.empty() && Name[0] == '\01')
2391 Name = Name.substr(1);
2392
2393 unsigned LineNo = getLineNumber(Loc);
2394 if (!HasDecl || D->isImplicit())
2395 Flags |= llvm::DIDescriptor::FlagArtificial;
2396
David Blaikie9a845292013-05-22 23:22:42 +00002397 llvm::DICompositeType DIFnType;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002398 llvm::DISubprogram SPDecl;
2399 if (HasDecl &&
Eric Christopher13c97672013-05-16 00:45:23 +00002400 DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002401 DIFnType = getOrCreateFunctionType(D, FnType, Unit);
2402 SPDecl = getFunctionDeclaration(D);
2403 } else {
2404 // Create fake but valid subroutine type. Otherwise
2405 // llvm::DISubprogram::Verify() would return false, and
2406 // subprogram DIE will miss DW_AT_decl_file and
2407 // DW_AT_decl_line fields.
2408 SmallVector<llvm::Value*, 16> Elts;
2409 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2410 DIFnType = DBuilder.createSubroutineType(Unit, EltTypeArray);
2411 }
2412 llvm::DISubprogram SP;
2413 SP = DBuilder.createFunction(FDContext, Name, LinkageName, Unit,
2414 LineNo, DIFnType,
2415 Fn->hasInternalLinkage(), true/*definition*/,
2416 getLineNumber(CurLoc), Flags,
2417 CGM.getLangOpts().Optimize,
2418 Fn, TParamsArray, SPDecl);
David Blaikie9faebd22013-05-20 04:58:53 +00002419 if (HasDecl)
2420 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002421
2422 // Push function on region stack.
2423 llvm::MDNode *SPN = SP;
2424 LexicalBlockStack.push_back(SPN);
2425 if (HasDecl)
2426 RegionMap[D] = llvm::WeakVH(SP);
2427}
2428
2429/// EmitLocation - Emit metadata to indicate a change in line/column
2430/// information in the source file.
Adrian Prantl00df5ea2013-03-12 20:43:25 +00002431void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
2432 bool ForceColumnInfo) {
Eric Christopher6537f082013-05-16 00:45:12 +00002433
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002434 // Update our current location
2435 setLocation(Loc);
2436
2437 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2438
2439 // Don't bother if things are the same as last time.
2440 SourceManager &SM = CGM.getContext().getSourceManager();
2441 if (CurLoc == PrevLoc ||
2442 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2443 // New Builder may not be in sync with CGDebugInfo.
David Blaikie0a0f93c2013-02-01 19:09:49 +00002444 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2445 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2446 LexicalBlockStack.back())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002447 return;
Eric Christopher6537f082013-05-16 00:45:12 +00002448
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002449 // Update last state.
2450 PrevLoc = CurLoc;
2451
2452 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantl00df5ea2013-03-12 20:43:25 +00002453 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2454 (getLineNumber(CurLoc),
2455 getColumnNumber(CurLoc, ForceColumnInfo),
2456 Scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002457}
2458
2459/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2460/// the stack.
2461void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2462 llvm::DIDescriptor D =
2463 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2464 llvm::DIDescriptor() :
2465 llvm::DIDescriptor(LexicalBlockStack.back()),
2466 getOrCreateFile(CurLoc),
2467 getLineNumber(CurLoc),
2468 getColumnNumber(CurLoc));
2469 llvm::MDNode *DN = D;
2470 LexicalBlockStack.push_back(DN);
2471}
2472
2473/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2474/// region - beginning of a DW_TAG_lexical_block.
Eric Christopherf0890c42013-05-16 00:52:20 +00002475void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2476 SourceLocation Loc) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002477 // Set our current location.
2478 setLocation(Loc);
2479
2480 // Create a new lexical block and push it on the stack.
2481 CreateLexicalBlock(Loc);
2482
2483 // Emit a line table change for the current location inside the new scope.
2484 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2485 getColumnNumber(Loc),
2486 LexicalBlockStack.back()));
2487}
2488
2489/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2490/// region - end of a DW_TAG_lexical_block.
Eric Christopherf0890c42013-05-16 00:52:20 +00002491void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2492 SourceLocation Loc) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002493 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2494
2495 // Provide an entry in the line table for the end of the block.
2496 EmitLocation(Builder, Loc);
2497
2498 LexicalBlockStack.pop_back();
2499}
2500
2501/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2502void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2503 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2504 unsigned RCount = FnBeginRegionCount.back();
2505 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2506
2507 // Pop all regions for this function.
2508 while (LexicalBlockStack.size() != RCount)
2509 EmitLexicalBlockEnd(Builder, CurLoc);
2510 FnBeginRegionCount.pop_back();
2511}
2512
Eric Christopher6537f082013-05-16 00:45:12 +00002513// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002514// See BuildByRefType.
2515llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2516 uint64_t *XOffset) {
2517
2518 SmallVector<llvm::Value *, 5> EltTys;
2519 QualType FType;
2520 uint64_t FieldSize, FieldOffset;
2521 unsigned FieldAlign;
Eric Christopher6537f082013-05-16 00:45:12 +00002522
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002523 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00002524 QualType Type = VD->getType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002525
2526 FieldOffset = 0;
2527 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2528 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2529 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2530 FType = CGM.getContext().IntTy;
2531 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2532 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2533
2534 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2535 if (HasCopyAndDispose) {
2536 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2537 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2538 &FieldOffset));
2539 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2540 &FieldOffset));
2541 }
2542 bool HasByrefExtendedLayout;
2543 Qualifiers::ObjCLifetime Lifetime;
2544 if (CGM.getContext().getByrefLifetime(Type,
2545 Lifetime, HasByrefExtendedLayout)
2546 && HasByrefExtendedLayout)
2547 EltTys.push_back(CreateMemberType(Unit, FType,
2548 "__byref_variable_layout",
2549 &FieldOffset));
Eric Christopher6537f082013-05-16 00:45:12 +00002550
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002551 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2552 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCall64aa4b32013-04-16 22:48:15 +00002553 CGM.getTarget().getPointerAlign(0))) {
Eric Christopher6537f082013-05-16 00:45:12 +00002554 CharUnits FieldOffsetInBytes
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002555 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2556 CharUnits AlignedOffsetInBytes
2557 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2558 CharUnits NumPaddingBytes
2559 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopher6537f082013-05-16 00:45:12 +00002560
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002561 if (NumPaddingBytes.isPositive()) {
2562 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2563 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2564 pad, ArrayType::Normal, 0);
2565 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2566 }
2567 }
Eric Christopher6537f082013-05-16 00:45:12 +00002568
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002569 FType = Type;
2570 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2571 FieldSize = CGM.getContext().getTypeSize(FType);
2572 FieldAlign = CGM.getContext().toBits(Align);
2573
Eric Christopher6537f082013-05-16 00:45:12 +00002574 *XOffset = FieldOffset;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002575 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2576 0, FieldSize, FieldAlign,
2577 FieldOffset, 0, FieldTy);
2578 EltTys.push_back(FieldTy);
2579 FieldOffset += FieldSize;
Eric Christopher6537f082013-05-16 00:45:12 +00002580
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002581 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher6537f082013-05-16 00:45:12 +00002582
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002583 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopher6537f082013-05-16 00:45:12 +00002584
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002585 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikiec1d0af12013-02-25 01:07:08 +00002586 llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002587}
2588
2589/// EmitDeclare - Emit local variable declaration debug info.
2590void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Eric Christopher6537f082013-05-16 00:45:12 +00002591 llvm::Value *Storage,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002592 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002593 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002594 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2595
2596 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2597 llvm::DIType Ty;
2598 uint64_t XOffset = 0;
2599 if (VD->hasAttr<BlocksAttr>())
2600 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopher6537f082013-05-16 00:45:12 +00002601 else
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002602 Ty = getOrCreateType(VD->getType(), Unit);
2603
2604 // If there is no debug info for this type then do not emit debug info
2605 // for this variable.
2606 if (!Ty)
2607 return;
2608
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002609 // Get location information.
2610 unsigned Line = getLineNumber(VD->getLocation());
2611 unsigned Column = getColumnNumber(VD->getLocation());
2612 unsigned Flags = 0;
2613 if (VD->isImplicit())
2614 Flags |= llvm::DIDescriptor::FlagArtificial;
2615 // If this is the first argument and it is implicit then
2616 // give it an object pointer flag.
2617 // FIXME: There has to be a better way to do this, but for static
2618 // functions there won't be an implicit param at arg1 and
2619 // otherwise it is 'self' or 'this'.
2620 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2621 Flags |= llvm::DIDescriptor::FlagObjectPointer;
2622
2623 llvm::MDNode *Scope = LexicalBlockStack.back();
2624
2625 StringRef Name = VD->getName();
2626 if (!Name.empty()) {
2627 if (VD->hasAttr<BlocksAttr>()) {
2628 CharUnits offset = CharUnits::fromQuantity(32);
2629 SmallVector<llvm::Value *, 9> addr;
2630 llvm::Type *Int64Ty = CGM.Int64Ty;
2631 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2632 // offset of __forwarding field
2633 offset = CGM.getContext().toCharUnitsFromBits(
John McCall64aa4b32013-04-16 22:48:15 +00002634 CGM.getTarget().getPointerWidth(0));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002635 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2636 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2637 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2638 // offset of x field
2639 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2640 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2641
2642 // Create the descriptor for the variable.
2643 llvm::DIVariable D =
Eric Christopher6537f082013-05-16 00:45:12 +00002644 DBuilder.createComplexVariable(Tag,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002645 llvm::DIDescriptor(Scope),
2646 VD->getName(), Unit, Line, Ty,
2647 addr, ArgNo);
Eric Christopher6537f082013-05-16 00:45:12 +00002648
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002649 // Insert an llvm.dbg.declare into the current block.
2650 llvm::Instruction *Call =
2651 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2652 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2653 return;
Adrian Prantl230ea412013-04-30 22:45:09 +00002654 } else if (isa<VariableArrayType>(VD->getType())) {
2655 // These are "complex" variables in that they need an op_deref.
2656 // Create the descriptor for the variable.
2657 llvm::Value *Addr = llvm::ConstantInt::get(CGM.Int64Ty,
2658 llvm::DIBuilder::OpDeref);
2659 llvm::DIVariable D =
2660 DBuilder.createComplexVariable(Tag,
2661 llvm::DIDescriptor(Scope),
2662 Name, Unit, Line, Ty,
2663 Addr, ArgNo);
2664
2665 // Insert an llvm.dbg.declare into the current block.
2666 llvm::Instruction *Call =
2667 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2668 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2669 return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002670 }
David Blaikie436653b2013-01-05 05:58:35 +00002671 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2672 // If VD is an anonymous union then Storage represents value for
2673 // all union fields.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002674 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikied8180cf2013-01-05 20:03:07 +00002675 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002676 for (RecordDecl::field_iterator I = RD->field_begin(),
2677 E = RD->field_end();
2678 I != E; ++I) {
2679 FieldDecl *Field = *I;
2680 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2681 StringRef FieldName = Field->getName();
Eric Christopher6537f082013-05-16 00:45:12 +00002682
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002683 // Ignore unnamed fields. Do not ignore unnamed records.
2684 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2685 continue;
Eric Christopher6537f082013-05-16 00:45:12 +00002686
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002687 // Use VarDecl's Tag, Scope and Line number.
2688 llvm::DIVariable D =
2689 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopher6537f082013-05-16 00:45:12 +00002690 FieldName, Unit, Line, FieldTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002691 CGM.getLangOpts().Optimize, Flags,
2692 ArgNo);
Eric Christopher6537f082013-05-16 00:45:12 +00002693
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002694 // Insert an llvm.dbg.declare into the current block.
2695 llvm::Instruction *Call =
2696 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2697 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2698 }
David Blaikied8180cf2013-01-05 20:03:07 +00002699 return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002700 }
2701 }
David Blaikie436653b2013-01-05 05:58:35 +00002702
2703 // Create the descriptor for the variable.
2704 llvm::DIVariable D =
2705 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2706 Name, Unit, Line, Ty,
2707 CGM.getLangOpts().Optimize, Flags, ArgNo);
2708
2709 // Insert an llvm.dbg.declare into the current block.
2710 llvm::Instruction *Call =
2711 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2712 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002713}
2714
2715void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2716 llvm::Value *Storage,
2717 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002718 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002719 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2720}
2721
Adrian Prantle86fcc42013-03-29 19:20:29 +00002722/// Look up the completed type for a self pointer in the TypeCache and
2723/// create a copy of it with the ObjectPointer and Artificial flags
2724/// set. If the type is not cached, a new one is created. This should
2725/// never happen though, since creating a type for the implicit self
2726/// argument implies that we already parsed the interface definition
2727/// and the ivar declarations in the implementation.
Eric Christopherf0890c42013-05-16 00:52:20 +00002728llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2729 llvm::DIType Ty) {
Adrian Prantle86fcc42013-03-29 19:20:29 +00002730 llvm::DIType CachedTy = getTypeOrNull(QualTy);
2731 if (CachedTy.Verify()) Ty = CachedTy;
2732 else DEBUG(llvm::dbgs() << "No cached type for self.");
2733 return DBuilder.createObjectPointerType(Ty);
2734}
2735
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002736void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2737 llvm::Value *Storage,
2738 CGBuilderTy &Builder,
2739 const CGBlockInfo &blockInfo) {
Eric Christopher13c97672013-05-16 00:45:23 +00002740 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002741 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopher6537f082013-05-16 00:45:12 +00002742
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002743 if (Builder.GetInsertBlock() == 0)
2744 return;
Eric Christopher6537f082013-05-16 00:45:12 +00002745
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002746 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopher6537f082013-05-16 00:45:12 +00002747
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002748 uint64_t XOffset = 0;
2749 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2750 llvm::DIType Ty;
2751 if (isByRef)
2752 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopher6537f082013-05-16 00:45:12 +00002753 else
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002754 Ty = getOrCreateType(VD->getType(), Unit);
2755
2756 // Self is passed along as an implicit non-arg variable in a
2757 // block. Mark it as the object pointer.
2758 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantle86fcc42013-03-29 19:20:29 +00002759 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002760
2761 // Get location information.
2762 unsigned Line = getLineNumber(VD->getLocation());
2763 unsigned Column = getColumnNumber(VD->getLocation());
2764
2765 const llvm::DataLayout &target = CGM.getDataLayout();
2766
2767 CharUnits offset = CharUnits::fromQuantity(
2768 target.getStructLayout(blockInfo.StructureType)
2769 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2770
2771 SmallVector<llvm::Value *, 9> addr;
2772 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl9b97adf2013-03-29 19:20:35 +00002773 if (isa<llvm::AllocaInst>(Storage))
2774 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002775 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2776 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2777 if (isByRef) {
2778 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2779 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2780 // offset of __forwarding field
2781 offset = CGM.getContext()
2782 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2783 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2784 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2785 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2786 // offset of x field
2787 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2788 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2789 }
2790
2791 // Create the descriptor for the variable.
2792 llvm::DIVariable D =
Eric Christopher6537f082013-05-16 00:45:12 +00002793 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002794 llvm::DIDescriptor(LexicalBlockStack.back()),
2795 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl9b97adf2013-03-29 19:20:35 +00002796
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002797 // Insert an llvm.dbg.declare into the current block.
2798 llvm::Instruction *Call =
2799 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2800 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2801 LexicalBlockStack.back()));
2802}
2803
2804/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2805/// variable declaration.
2806void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2807 unsigned ArgNo,
2808 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002809 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002810 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2811}
2812
2813namespace {
2814 struct BlockLayoutChunk {
2815 uint64_t OffsetInBits;
2816 const BlockDecl::Capture *Capture;
2817 };
2818 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2819 return l.OffsetInBits < r.OffsetInBits;
2820 }
2821}
2822
2823void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl836e7c92013-03-14 17:53:33 +00002824 llvm::Value *Arg,
2825 llvm::Value *LocalAddr,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002826 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002827 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002828 ASTContext &C = CGM.getContext();
2829 const BlockDecl *blockDecl = block.getBlockDecl();
2830
2831 // Collect some general information about the block's location.
2832 SourceLocation loc = blockDecl->getCaretLocation();
2833 llvm::DIFile tunit = getOrCreateFile(loc);
2834 unsigned line = getLineNumber(loc);
2835 unsigned column = getColumnNumber(loc);
Eric Christopher6537f082013-05-16 00:45:12 +00002836
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002837 // Build the debug-info type for the block literal.
2838 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2839
2840 const llvm::StructLayout *blockLayout =
2841 CGM.getDataLayout().getStructLayout(block.StructureType);
2842
2843 SmallVector<llvm::Value*, 16> fields;
2844 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2845 blockLayout->getElementOffsetInBits(0),
2846 tunit, tunit));
2847 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2848 blockLayout->getElementOffsetInBits(1),
2849 tunit, tunit));
2850 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2851 blockLayout->getElementOffsetInBits(2),
2852 tunit, tunit));
2853 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2854 blockLayout->getElementOffsetInBits(3),
2855 tunit, tunit));
2856 fields.push_back(createFieldType("__descriptor",
2857 C.getPointerType(block.NeedsCopyDispose ?
2858 C.getBlockDescriptorExtendedType() :
2859 C.getBlockDescriptorType()),
2860 0, loc, AS_public,
2861 blockLayout->getElementOffsetInBits(4),
2862 tunit, tunit));
2863
2864 // We want to sort the captures by offset, not because DWARF
2865 // requires this, but because we're paranoid about debuggers.
2866 SmallVector<BlockLayoutChunk, 8> chunks;
2867
2868 // 'this' capture.
2869 if (blockDecl->capturesCXXThis()) {
2870 BlockLayoutChunk chunk;
2871 chunk.OffsetInBits =
2872 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2873 chunk.Capture = 0;
2874 chunks.push_back(chunk);
2875 }
2876
2877 // Variable captures.
2878 for (BlockDecl::capture_const_iterator
2879 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2880 i != e; ++i) {
2881 const BlockDecl::Capture &capture = *i;
2882 const VarDecl *variable = capture.getVariable();
2883 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2884
2885 // Ignore constant captures.
2886 if (captureInfo.isConstant())
2887 continue;
2888
2889 BlockLayoutChunk chunk;
2890 chunk.OffsetInBits =
2891 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2892 chunk.Capture = &capture;
2893 chunks.push_back(chunk);
2894 }
2895
2896 // Sort by offset.
2897 llvm::array_pod_sort(chunks.begin(), chunks.end());
2898
2899 for (SmallVectorImpl<BlockLayoutChunk>::iterator
2900 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2901 uint64_t offsetInBits = i->OffsetInBits;
2902 const BlockDecl::Capture *capture = i->Capture;
2903
2904 // If we have a null capture, this must be the C++ 'this' capture.
2905 if (!capture) {
2906 const CXXMethodDecl *method =
2907 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2908 QualType type = method->getThisType(C);
2909
2910 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
2911 offsetInBits, tunit, tunit));
2912 continue;
2913 }
2914
2915 const VarDecl *variable = capture->getVariable();
2916 StringRef name = variable->getName();
2917
2918 llvm::DIType fieldType;
2919 if (capture->isByRef()) {
2920 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
2921
2922 // FIXME: this creates a second copy of this type!
2923 uint64_t xoffset;
2924 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
2925 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
2926 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
2927 ptrInfo.first, ptrInfo.second,
2928 offsetInBits, 0, fieldType);
2929 } else {
2930 fieldType = createFieldType(name, variable->getType(), 0,
2931 loc, AS_public, offsetInBits, tunit, tunit);
2932 }
2933 fields.push_back(fieldType);
2934 }
2935
2936 SmallString<36> typeName;
2937 llvm::raw_svector_ostream(typeName)
2938 << "__block_literal_" << CGM.getUniqueBlockCount();
2939
2940 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
2941
2942 llvm::DIType type =
2943 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
2944 CGM.getContext().toBits(block.BlockSize),
2945 CGM.getContext().toBits(block.BlockAlign),
David Blaikiec1d0af12013-02-25 01:07:08 +00002946 0, llvm::DIType(), fieldsArray);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002947 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
2948
2949 // Get overall information about the block.
2950 unsigned flags = llvm::DIDescriptor::FlagArtificial;
2951 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002952
2953 // Create the descriptor for the parameter.
2954 llvm::DIVariable debugVar =
2955 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopher6537f082013-05-16 00:45:12 +00002956 llvm::DIDescriptor(scope),
Adrian Prantl836e7c92013-03-14 17:53:33 +00002957 Arg->getName(), tunit, line, type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002958 CGM.getLangOpts().Optimize, flags,
Adrian Prantl836e7c92013-03-14 17:53:33 +00002959 cast<llvm::Argument>(Arg)->getArgNo() + 1);
2960
Adrian Prantlbea407c2013-03-14 21:52:59 +00002961 if (LocalAddr) {
Adrian Prantl836e7c92013-03-14 17:53:33 +00002962 // Insert an llvm.dbg.value into the current block.
Adrian Prantlbea407c2013-03-14 21:52:59 +00002963 llvm::Instruction *DbgVal =
2964 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopherf068c922013-04-02 22:59:11 +00002965 Builder.GetInsertBlock());
Adrian Prantlbea407c2013-03-14 21:52:59 +00002966 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
2967 }
Adrian Prantl836e7c92013-03-14 17:53:33 +00002968
Adrian Prantlbea407c2013-03-14 21:52:59 +00002969 // Insert an llvm.dbg.declare into the current block.
2970 llvm::Instruction *DbgDecl =
2971 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
2972 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002973}
2974
Eric Christopher0395de32013-01-16 01:22:32 +00002975/// getStaticDataMemberDeclaration - If D is an out-of-class definition of
2976/// a static data member of a class, find its corresponding in-class
2977/// declaration.
2978llvm::DIDerivedType CGDebugInfo::getStaticDataMemberDeclaration(const Decl *D) {
2979 if (cast<VarDecl>(D)->isStaticDataMember()) {
2980 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
2981 MI = StaticDataMemberCache.find(D->getCanonicalDecl());
2982 if (MI != StaticDataMemberCache.end())
2983 // Verify the info still exists.
2984 if (llvm::Value *V = MI->second)
2985 return llvm::DIDerivedType(cast<llvm::MDNode>(V));
2986 }
2987 return llvm::DIDerivedType();
2988}
2989
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002990/// EmitGlobalVariable - Emit information about a global variable.
2991void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2992 const VarDecl *D) {
Eric Christopher13c97672013-05-16 00:45:23 +00002993 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002994 // Create global variable debug descriptor.
2995 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
2996 unsigned LineNo = getLineNumber(D->getLocation());
2997
2998 setLocation(D->getLocation());
2999
3000 QualType T = D->getType();
3001 if (T->isIncompleteArrayType()) {
3002
3003 // CodeGen turns int[] into int[1] so we'll do the same here.
3004 llvm::APInt ConstVal(32, 1);
3005 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3006
3007 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3008 ArrayType::Normal, 0);
3009 }
3010 StringRef DeclName = D->getName();
3011 StringRef LinkageName;
3012 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
3013 && !isa<ObjCMethodDecl>(D->getDeclContext()))
3014 LinkageName = Var->getName();
3015 if (LinkageName == DeclName)
3016 LinkageName = StringRef();
Eric Christopher6537f082013-05-16 00:45:12 +00003017 llvm::DIDescriptor DContext =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003018 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
David Blaikie9faebd22013-05-20 04:58:53 +00003019 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(DContext, DeclName, LinkageName,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003020 Unit, LineNo, getOrCreateType(T, Unit),
Eric Christopher0395de32013-01-16 01:22:32 +00003021 Var->hasInternalLinkage(), Var,
3022 getStaticDataMemberDeclaration(D));
David Blaikie9faebd22013-05-20 04:58:53 +00003023 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003024}
3025
3026/// EmitGlobalVariable - Emit information about an objective-c interface.
3027void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
3028 ObjCInterfaceDecl *ID) {
Eric Christopher13c97672013-05-16 00:45:23 +00003029 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003030 // Create global variable debug descriptor.
3031 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
3032 unsigned LineNo = getLineNumber(ID->getLocation());
3033
3034 StringRef Name = ID->getName();
3035
3036 QualType T = CGM.getContext().getObjCInterfaceType(ID);
3037 if (T->isIncompleteArrayType()) {
3038
3039 // CodeGen turns int[] into int[1] so we'll do the same here.
3040 llvm::APInt ConstVal(32, 1);
3041 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3042
3043 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3044 ArrayType::Normal, 0);
3045 }
3046
3047 DBuilder.createGlobalVariable(Name, Unit, LineNo,
3048 getOrCreateType(T, Unit),
3049 Var->hasInternalLinkage(), Var);
3050}
3051
3052/// EmitGlobalVariable - Emit global variable's debug info.
Eric Christopher6537f082013-05-16 00:45:12 +00003053void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003054 llvm::Constant *Init) {
Eric Christopher13c97672013-05-16 00:45:23 +00003055 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003056 // Create the descriptor for the variable.
3057 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3058 StringRef Name = VD->getName();
3059 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3060 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3061 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3062 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3063 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3064 }
3065 // Do not use DIGlobalVariable for enums.
3066 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3067 return;
David Blaikie9faebd22013-05-20 04:58:53 +00003068 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(Unit, Name, Name, Unit,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003069 getLineNumber(VD->getLocation()),
Eric Christopher0395de32013-01-16 01:22:32 +00003070 Ty, true, Init,
3071 getStaticDataMemberDeclaration(VD));
David Blaikie9faebd22013-05-20 04:58:53 +00003072 DeclCache.insert(std::make_pair(VD->getCanonicalDecl(), llvm::WeakVH(GV)));
3073}
3074
3075llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3076 if (!LexicalBlockStack.empty())
3077 return llvm::DIScope(LexicalBlockStack.back());
3078 return getContextDescriptor(D);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003079}
3080
David Blaikie957dac52013-04-22 06:13:21 +00003081void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikie9faebd22013-05-20 04:58:53 +00003082 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3083 return;
David Blaikie957dac52013-04-22 06:13:21 +00003084 DBuilder.createImportedModule(
David Blaikie9faebd22013-05-20 04:58:53 +00003085 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3086 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie957dac52013-04-22 06:13:21 +00003087 getLineNumber(UD.getLocation()));
3088}
3089
David Blaikie9faebd22013-05-20 04:58:53 +00003090void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3091 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3092 return;
3093 assert(UD.shadow_size() &&
3094 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3095 // Emitting one decl is sufficient - debuggers can detect that this is an
3096 // overloaded name & provide lookup for all the overloads.
3097 const UsingShadowDecl &USD = **UD.shadow_begin();
3098 if (llvm::DIDescriptor Target = getDeclarationOrDefinition(USD.getUnderlyingDecl()))
3099 DBuilder.createImportedDeclaration(
3100 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3101 getLineNumber(USD.getLocation()));
3102}
3103
David Blaikiefc46ebc2013-05-20 22:50:41 +00003104llvm::DIImportedEntity
3105CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3106 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3107 return llvm::DIImportedEntity(0);
3108 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3109 if (VH)
3110 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
3111 llvm::DIImportedEntity R(0);
3112 if (const NamespaceAliasDecl *Underlying =
3113 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3114 // This could cache & dedup here rather than relying on metadata deduping.
3115 R = DBuilder.createImportedModule(
3116 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3117 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3118 NA.getName());
3119 else
3120 R = DBuilder.createImportedModule(
3121 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3122 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3123 getLineNumber(NA.getLocation()), NA.getName());
3124 VH = R;
3125 return R;
3126}
3127
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003128/// getOrCreateNamesSpace - Return namespace descriptor for the given
3129/// namespace decl.
Eric Christopher6537f082013-05-16 00:45:12 +00003130llvm::DINameSpace
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003131CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
Eric Christopher6537f082013-05-16 00:45:12 +00003132 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003133 NameSpaceCache.find(NSDecl);
3134 if (I != NameSpaceCache.end())
3135 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopher6537f082013-05-16 00:45:12 +00003136
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003137 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3138 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00003139 llvm::DIDescriptor Context =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003140 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3141 llvm::DINameSpace NS =
3142 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3143 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3144 return NS;
3145}
3146
3147void CGDebugInfo::finalize() {
3148 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
3149 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
3150 llvm::DIType Ty, RepTy;
3151 // Verify that the debug info still exists.
3152 if (llvm::Value *V = VI->second)
3153 Ty = llvm::DIType(cast<llvm::MDNode>(V));
Eric Christopher6537f082013-05-16 00:45:12 +00003154
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003155 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
3156 TypeCache.find(VI->first);
3157 if (it != TypeCache.end()) {
3158 // Verify that the debug info still exists.
3159 if (llvm::Value *V = it->second)
3160 RepTy = llvm::DIType(cast<llvm::MDNode>(V));
3161 }
Adrian Prantlebbd7e02013-03-11 18:33:46 +00003162
Adrian Prantl9b97adf2013-03-29 19:20:35 +00003163 if (Ty.Verify() && Ty.isForwardDecl() && RepTy.Verify())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003164 Ty.replaceAllUsesWith(RepTy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003165 }
Adrian Prantlebbd7e02013-03-11 18:33:46 +00003166
3167 // We keep our own list of retained types, because we need to look
3168 // up the final type in the type cache.
3169 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3170 RE = RetainedTypes.end(); RI != RE; ++RI)
3171 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
3172
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003173 DBuilder.finalize();
3174}