blob: 86b5075ac22d2d8be8009356b0a9ba95cc77abd8 [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
1454/// CreateType - get objective-c interface type.
1455llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
1456 llvm::DIFile Unit) {
1457 ObjCInterfaceDecl *ID = Ty->getDecl();
1458 if (!ID)
1459 return llvm::DIType();
1460
1461 // Get overall information about the record type for the debug info.
1462 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
1463 unsigned Line = getLineNumber(ID->getLocation());
1464 unsigned RuntimeLang = TheCU.getLanguage();
1465
1466 // If this is just a forward declaration return a special forward-declaration
1467 // debug type since we won't be able to lay out the entire type.
1468 ObjCInterfaceDecl *Def = ID->getDefinition();
1469 if (!Def) {
1470 llvm::DIType FwdDecl =
1471 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001472 ID->getName(), TheCU, DefUnit, Line,
1473 RuntimeLang);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001474 return FwdDecl;
1475 }
1476
1477 ID = Def;
1478
1479 // Bit size, align and offset of the type.
1480 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1481 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1482
1483 unsigned Flags = 0;
1484 if (ID->getImplementation())
1485 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1486
Eric Christopherf068c922013-04-02 22:59:11 +00001487 llvm::DICompositeType RealDecl =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001488 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1489 Line, Size, Align, Flags,
David Blaikiec1d0af12013-02-25 01:07:08 +00001490 llvm::DIType(), llvm::DIArray(), RuntimeLang);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001491
1492 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1493 // will find it and we're emitting the complete type.
Adrian Prantl4919de62013-03-06 22:03:30 +00001494 QualType QualTy = QualType(Ty, 0);
1495 CompletedTypeCache[QualTy.getAsOpaquePtr()] = RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001496 // Push the struct on region stack.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001497
Eric Christopherf068c922013-04-02 22:59:11 +00001498 LexicalBlockStack.push_back(static_cast<llvm::MDNode*>(RealDecl));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001499 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1500
1501 // Convert all the elements.
1502 SmallVector<llvm::Value *, 16> EltTys;
1503
1504 ObjCInterfaceDecl *SClass = ID->getSuperClass();
1505 if (SClass) {
1506 llvm::DIType SClassTy =
1507 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
1508 if (!SClassTy.isValid())
1509 return llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001510
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001511 llvm::DIType InhTag =
1512 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
1513 EltTys.push_back(InhTag);
1514 }
1515
1516 for (ObjCContainerDecl::prop_iterator I = ID->prop_begin(),
1517 E = ID->prop_end(); I != E; ++I) {
1518 const ObjCPropertyDecl *PD = *I;
1519 SourceLocation Loc = PD->getLocation();
1520 llvm::DIFile PUnit = getOrCreateFile(Loc);
1521 unsigned PLine = getLineNumber(Loc);
1522 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1523 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1524 llvm::MDNode *PropertyNode =
1525 DBuilder.createObjCProperty(PD->getName(),
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001526 PUnit, PLine,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001527 (Getter && Getter->isImplicit()) ? "" :
1528 getSelectorName(PD->getGetterName()),
1529 (Setter && Setter->isImplicit()) ? "" :
1530 getSelectorName(PD->getSetterName()),
1531 PD->getPropertyAttributes(),
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001532 getOrCreateType(PD->getType(), PUnit));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001533 EltTys.push_back(PropertyNode);
1534 }
1535
1536 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
1537 unsigned FieldNo = 0;
1538 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
1539 Field = Field->getNextIvar(), ++FieldNo) {
1540 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
1541 if (!FieldTy.isValid())
1542 return llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001543
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001544 StringRef FieldName = Field->getName();
1545
1546 // Ignore unnamed fields.
1547 if (FieldName.empty())
1548 continue;
1549
1550 // Get the location for the field.
1551 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1552 unsigned FieldLine = getLineNumber(Field->getLocation());
1553 QualType FType = Field->getType();
1554 uint64_t FieldSize = 0;
1555 unsigned FieldAlign = 0;
1556
1557 if (!FType->isIncompleteArrayType()) {
1558
1559 // Bit size, align and offset of the type.
1560 FieldSize = Field->isBitField()
1561 ? Field->getBitWidthValue(CGM.getContext())
1562 : CGM.getContext().getTypeSize(FType);
1563 FieldAlign = CGM.getContext().getTypeAlign(FType);
1564 }
1565
1566 uint64_t FieldOffset;
1567 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1568 // We don't know the runtime offset of an ivar if we're using the
1569 // non-fragile ABI. For bitfields, use the bit offset into the first
1570 // byte of storage of the bitfield. For other fields, use zero.
1571 if (Field->isBitField()) {
1572 FieldOffset = CGM.getObjCRuntime().ComputeBitfieldBitOffset(
1573 CGM, ID, Field);
1574 FieldOffset %= CGM.getContext().getCharWidth();
1575 } else {
1576 FieldOffset = 0;
1577 }
1578 } else {
1579 FieldOffset = RL.getFieldOffset(FieldNo);
1580 }
1581
1582 unsigned Flags = 0;
1583 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
1584 Flags = llvm::DIDescriptor::FlagProtected;
1585 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
1586 Flags = llvm::DIDescriptor::FlagPrivate;
1587
1588 llvm::MDNode *PropertyNode = NULL;
1589 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Eric Christopher6537f082013-05-16 00:45:12 +00001590 if (ObjCPropertyImplDecl *PImpD =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001591 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1592 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopherbe5f1be2013-02-21 22:35:08 +00001593 SourceLocation Loc = PD->getLocation();
1594 llvm::DIFile PUnit = getOrCreateFile(Loc);
1595 unsigned PLine = getLineNumber(Loc);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001596 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1597 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1598 PropertyNode =
1599 DBuilder.createObjCProperty(PD->getName(),
1600 PUnit, PLine,
1601 (Getter && Getter->isImplicit()) ? "" :
1602 getSelectorName(PD->getGetterName()),
1603 (Setter && Setter->isImplicit()) ? "" :
1604 getSelectorName(PD->getSetterName()),
1605 PD->getPropertyAttributes(),
1606 getOrCreateType(PD->getType(), PUnit));
1607 }
1608 }
1609 }
1610 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1611 FieldLine, FieldSize, FieldAlign,
1612 FieldOffset, Flags, FieldTy,
1613 PropertyNode);
1614 EltTys.push_back(FieldTy);
1615 }
1616
1617 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopherf068c922013-04-02 22:59:11 +00001618 RealDecl.setTypeArray(Elements);
Adrian Prantl4919de62013-03-06 22:03:30 +00001619
1620 // If the implementation is not yet set, we do not want to mark it
1621 // as complete. An implementation may declare additional
1622 // private ivars that we would miss otherwise.
1623 if (ID->getImplementation() == 0)
1624 CompletedTypeCache.erase(QualTy.getAsOpaquePtr());
Eric Christopher6537f082013-05-16 00:45:12 +00001625
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001626 LexicalBlockStack.pop_back();
Eric Christopherf068c922013-04-02 22:59:11 +00001627 return RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001628}
1629
1630llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
1631 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
1632 int64_t Count = Ty->getNumElements();
1633 if (Count == 0)
1634 // If number of elements are not known then this is an unbounded array.
1635 // Use Count == -1 to express such arrays.
1636 Count = -1;
1637
1638 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(0, Count);
1639 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
1640
1641 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1642 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1643
1644 return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
1645}
1646
1647llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
1648 llvm::DIFile Unit) {
1649 uint64_t Size;
1650 uint64_t Align;
1651
1652 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
1653 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
1654 Size = 0;
1655 Align =
1656 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
1657 } else if (Ty->isIncompleteArrayType()) {
1658 Size = 0;
1659 if (Ty->getElementType()->isIncompleteType())
1660 Align = 0;
1661 else
1662 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
David Blaikie089db2e2013-05-09 20:48:12 +00001663 } else if (Ty->isIncompleteType()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001664 Size = 0;
1665 Align = 0;
1666 } else {
1667 // Size and align of the whole array, not the element type.
1668 Size = CGM.getContext().getTypeSize(Ty);
1669 Align = CGM.getContext().getTypeAlign(Ty);
1670 }
1671
1672 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1673 // interior arrays, do we care? Why aren't nested arrays represented the
1674 // obvious/recursive way?
1675 SmallVector<llvm::Value *, 8> Subscripts;
1676 QualType EltTy(Ty, 0);
1677 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1678 // If the number of elements is known, then count is that number. Otherwise,
1679 // it's -1. This allows us to represent a subrange with an array of 0
1680 // elements, like this:
1681 //
1682 // struct foo {
1683 // int x[0];
1684 // };
1685 int64_t Count = -1; // Count == -1 is an unbounded array.
1686 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty))
1687 Count = CAT->getSize().getZExtValue();
Eric Christopher6537f082013-05-16 00:45:12 +00001688
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001689 // FIXME: Verify this is right for VLAs.
1690 Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
1691 EltTy = Ty->getElementType();
1692 }
1693
1694 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
1695
Eric Christopher6537f082013-05-16 00:45:12 +00001696 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001697 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
1698 SubscriptArray);
1699 return DbgTy;
1700}
1701
Eric Christopher6537f082013-05-16 00:45:12 +00001702llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001703 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001704 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001705 Ty, Ty->getPointeeType(), Unit);
1706}
1707
Eric Christopher6537f082013-05-16 00:45:12 +00001708llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001709 llvm::DIFile Unit) {
Eric Christopher6537f082013-05-16 00:45:12 +00001710 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001711 Ty, Ty->getPointeeType(), Unit);
1712}
1713
Eric Christopher6537f082013-05-16 00:45:12 +00001714llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001715 llvm::DIFile U) {
David Blaikiee8d75142013-01-19 19:20:56 +00001716 llvm::DIType ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
1717 if (!Ty->getPointeeType()->isFunctionType())
1718 return DBuilder.createMemberPointerType(
David Blaikieb0f77b02013-05-24 21:33:22 +00001719 getOrCreateTypeDeclaration(Ty->getPointeeType(), U), ClassType);
David Blaikiee8d75142013-01-19 19:20:56 +00001720 return DBuilder.createMemberPointerType(getOrCreateInstanceMethodType(
1721 CGM.getContext().getPointerType(
1722 QualType(Ty->getClass(), Ty->getPointeeType().getCVRQualifiers())),
1723 Ty->getPointeeType()->getAs<FunctionProtoType>(), U),
1724 ClassType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001725}
1726
Eric Christopher6537f082013-05-16 00:45:12 +00001727llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001728 llvm::DIFile U) {
1729 // Ignore the atomic wrapping
1730 // FIXME: What is the correct representation?
1731 return getOrCreateType(Ty->getValueType(), U);
1732}
1733
1734/// CreateEnumType - get enumeration type.
1735llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
1736 uint64_t Size = 0;
1737 uint64_t Align = 0;
1738 if (!ED->getTypeForDecl()->isIncompleteType()) {
1739 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1740 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1741 }
1742
1743 // If this is just a forward declaration, construct an appropriately
1744 // marked node and just return it.
1745 if (!ED->getDefinition()) {
1746 llvm::DIDescriptor EDContext;
1747 EDContext = getContextDescriptor(cast<Decl>(ED->getDeclContext()));
1748 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1749 unsigned Line = getLineNumber(ED->getLocation());
1750 StringRef EDName = ED->getName();
1751 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_enumeration_type,
1752 EDName, EDContext, DefUnit, Line, 0,
1753 Size, Align);
1754 }
1755
1756 // Create DIEnumerator elements for each enumerator.
1757 SmallVector<llvm::Value *, 16> Enumerators;
1758 ED = ED->getDefinition();
1759 for (EnumDecl::enumerator_iterator
1760 Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1761 Enum != EnumEnd; ++Enum) {
1762 Enumerators.push_back(
1763 DBuilder.createEnumerator(Enum->getName(),
1764 Enum->getInitVal().getZExtValue()));
1765 }
1766
1767 // Return a CompositeType for the enum itself.
1768 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
1769
1770 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1771 unsigned Line = getLineNumber(ED->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00001772 llvm::DIDescriptor EnumContext =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001773 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Adrian Prantl59d6a712013-04-19 19:56:39 +00001774 llvm::DIType ClassTy = ED->isFixed() ?
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001775 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopher6537f082013-05-16 00:45:12 +00001776 llvm::DIType DbgTy =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001777 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
1778 Size, Align, EltArray,
1779 ClassTy);
1780 return DbgTy;
1781}
1782
David Blaikie4b12be62013-01-21 04:37:12 +00001783static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C) {
1784 Qualifiers Quals;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001785 do {
David Blaikie4b12be62013-01-21 04:37:12 +00001786 Quals += T.getLocalQualifiers();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001787 QualType LastT = T;
1788 switch (T->getTypeClass()) {
1789 default:
David Blaikie4b12be62013-01-21 04:37:12 +00001790 return C.getQualifiedType(T.getTypePtr(), Quals);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001791 case Type::TemplateSpecialization:
1792 T = cast<TemplateSpecializationType>(T)->desugar();
1793 break;
1794 case Type::TypeOfExpr:
1795 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
1796 break;
1797 case Type::TypeOf:
1798 T = cast<TypeOfType>(T)->getUnderlyingType();
1799 break;
1800 case Type::Decltype:
1801 T = cast<DecltypeType>(T)->getUnderlyingType();
1802 break;
1803 case Type::UnaryTransform:
1804 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1805 break;
1806 case Type::Attributed:
1807 T = cast<AttributedType>(T)->getEquivalentType();
1808 break;
1809 case Type::Elaborated:
1810 T = cast<ElaboratedType>(T)->getNamedType();
1811 break;
1812 case Type::Paren:
1813 T = cast<ParenType>(T)->getInnerType();
1814 break;
David Blaikie4b12be62013-01-21 04:37:12 +00001815 case Type::SubstTemplateTypeParm:
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001816 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001817 break;
1818 case Type::Auto:
David Blaikie91296482013-05-24 21:24:35 +00001819 QualType DT = cast<AutoType>(T)->getDeducedType();
1820 if (DT.isNull())
1821 return T;
1822 T = DT;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001823 break;
1824 }
Eric Christopher6537f082013-05-16 00:45:12 +00001825
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001826 assert(T != LastT && "Type unwrapping failed to unwrap!");
NAKAMURA Takumid24c9ab2013-01-21 10:51:28 +00001827 (void)LastT;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001828 } while (true);
1829}
1830
Eric Christopherf0890c42013-05-16 00:52:20 +00001831/// getType - Get the type from the cache or return null type if it doesn't
1832/// exist.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001833llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
1834
1835 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001836 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Eric Christopher6537f082013-05-16 00:45:12 +00001837
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001838 // Check for existing entry.
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001839 if (Ty->getTypeClass() == Type::ObjCInterface) {
1840 llvm::Value *V = getCachedInterfaceTypeOrNull(Ty);
1841 if (V)
1842 return llvm::DIType(cast<llvm::MDNode>(V));
1843 else return llvm::DIType();
1844 }
1845
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001846 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1847 TypeCache.find(Ty.getAsOpaquePtr());
1848 if (it != TypeCache.end()) {
1849 // Verify that the debug info still exists.
1850 if (llvm::Value *V = it->second)
1851 return llvm::DIType(cast<llvm::MDNode>(V));
1852 }
1853
1854 return llvm::DIType();
1855}
1856
1857/// getCompletedTypeOrNull - Get the type from the cache or return null if it
1858/// doesn't exist.
1859llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
1860
1861 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001862 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001863
1864 // Check for existing entry.
Adrian Prantl4919de62013-03-06 22:03:30 +00001865 llvm::Value *V = 0;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001866 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1867 CompletedTypeCache.find(Ty.getAsOpaquePtr());
Adrian Prantl4919de62013-03-06 22:03:30 +00001868 if (it != CompletedTypeCache.end())
1869 V = it->second;
1870 else {
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001871 V = getCachedInterfaceTypeOrNull(Ty);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001872 }
1873
Adrian Prantl4919de62013-03-06 22:03:30 +00001874 // Verify that any cached debug info still exists.
1875 if (V != 0)
1876 return llvm::DIType(cast<llvm::MDNode>(V));
1877
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001878 return llvm::DIType();
1879}
1880
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001881/// getCachedInterfaceTypeOrNull - Get the type from the interface
1882/// cache, unless it needs to regenerated. Otherwise return null.
1883llvm::Value *CGDebugInfo::getCachedInterfaceTypeOrNull(QualType Ty) {
1884 // Is there a cached interface that hasn't changed?
1885 llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned > >
1886 ::iterator it1 = ObjCInterfaceCache.find(Ty.getAsOpaquePtr());
1887
1888 if (it1 != ObjCInterfaceCache.end())
1889 if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty))
1890 if (Checksum(Decl) == it1->second.second)
1891 // Return cached forward declaration.
1892 return it1->second.first;
1893
1894 return 0;
1895}
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001896
1897/// getOrCreateType - Get the type from the cache or create a new
1898/// one if necessary.
David Blaikie5f6e2f42013-06-05 05:32:23 +00001899llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit, bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001900 if (Ty.isNull())
1901 return llvm::DIType();
1902
1903 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00001904 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001905
1906 llvm::DIType T = getCompletedTypeOrNull(Ty);
1907
1908 if (T.Verify())
1909 return T;
1910
1911 // Otherwise create the type.
David Blaikie5f6e2f42013-06-05 05:32:23 +00001912 llvm::DIType Res = CreateTypeNode(Ty, Unit, Declaration);
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001913 void* TyPtr = Ty.getAsOpaquePtr();
1914
1915 // And update the type cache.
1916 TypeCache[TyPtr] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001917
1918 llvm::DIType TC = getTypeOrNull(Ty);
1919 if (TC.Verify() && TC.isForwardDecl())
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001920 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
1921 else if (ObjCInterfaceDecl* Decl = getObjCInterfaceDecl(Ty)) {
1922 // Interface types may have elements added to them by a
1923 // subsequent implementation or extension, so we keep them in
1924 // the ObjCInterfaceCache together with a checksum. Instead of
Adrian Prantlf06989b2013-05-08 23:37:22 +00001925 // the (possibly) incomplete interface type, we return a forward
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001926 // declaration that gets RAUW'd in CGDebugInfo::finalize().
David Blaikiee2eb89a2013-05-21 18:29:40 +00001927 std::pair<llvm::WeakVH, unsigned> &V = ObjCInterfaceCache[TyPtr];
1928 if (V.first)
1929 return llvm::DIType(cast<llvm::MDNode>(V.first));
1930 TC = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
1931 Decl->getName(), TheCU, Unit,
1932 getLineNumber(Decl->getLocation()),
1933 TheCU.getLanguage());
1934 // Store the forward declaration in the cache.
1935 V.first = TC;
1936 V.second = Checksum(Decl);
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001937
David Blaikiee2eb89a2013-05-21 18:29:40 +00001938 // Register the type for replacement in finalize().
1939 ReplaceMap.push_back(std::make_pair(TyPtr, static_cast<llvm::Value*>(TC)));
1940
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001941 return TC;
Adrian Prantl4919de62013-03-06 22:03:30 +00001942 }
1943
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001944 if (!Res.isForwardDecl())
Adrian Prantlebbd7e02013-03-11 18:33:46 +00001945 CompletedTypeCache[TyPtr] = Res;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001946
1947 return Res;
1948}
1949
Adrian Prantlb5a50072013-06-07 01:10:41 +00001950/// Currently the checksum of an interface includes the number of
1951/// ivars and property accessors.
Adrian Prantl4919de62013-03-06 22:03:30 +00001952unsigned CGDebugInfo::Checksum(const ObjCInterfaceDecl
Adrian Prantlb5a50072013-06-07 01:10:41 +00001953 *ID) {
1954 // The assumption is that the number of ivars and property accessors
1955 // can only increase monotonically, so it is safe to just use the
1956 // sum of these as a checksum.
1957 unsigned Sum = 0;
1958 for (const ObjCIvarDecl *Ivar = ID->all_declared_ivar_begin();
1959 Ivar != 0; Ivar = Ivar->getNextIvar())
1960 ++Sum;
1961
1962 return Sum;
Adrian Prantl4919de62013-03-06 22:03:30 +00001963}
1964
1965ObjCInterfaceDecl *CGDebugInfo::getObjCInterfaceDecl(QualType Ty) {
1966 switch (Ty->getTypeClass()) {
1967 case Type::ObjCObjectPointer:
Eric Christopherf0890c42013-05-16 00:52:20 +00001968 return getObjCInterfaceDecl(cast<ObjCObjectPointerType>(Ty)
1969 ->getPointeeType());
Adrian Prantl4919de62013-03-06 22:03:30 +00001970 case Type::ObjCInterface:
1971 return cast<ObjCInterfaceType>(Ty)->getDecl();
1972 default:
1973 return 0;
1974 }
1975}
1976
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001977/// CreateTypeNode - Create a new debug type node.
David Blaikie5f6e2f42013-06-05 05:32:23 +00001978llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit, bool Declaration) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001979 // Handle qualifiers, which recursively handles what they refer to.
1980 if (Ty.hasLocalQualifiers())
David Blaikie5f6e2f42013-06-05 05:32:23 +00001981 return CreateQualifiedType(Ty, Unit, Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001982
1983 const char *Diag = 0;
Eric Christopher6537f082013-05-16 00:45:12 +00001984
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001985 // Work out details of type.
1986 switch (Ty->getTypeClass()) {
1987#define TYPE(Class, Base)
1988#define ABSTRACT_TYPE(Class, Base)
1989#define NON_CANONICAL_TYPE(Class, Base)
1990#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1991#include "clang/AST/TypeNodes.def"
1992 llvm_unreachable("Dependent types cannot show up in debug information");
1993
1994 case Type::ExtVector:
1995 case Type::Vector:
1996 return CreateType(cast<VectorType>(Ty), Unit);
1997 case Type::ObjCObjectPointer:
1998 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
1999 case Type::ObjCObject:
2000 return CreateType(cast<ObjCObjectType>(Ty), Unit);
2001 case Type::ObjCInterface:
2002 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2003 case Type::Builtin:
2004 return CreateType(cast<BuiltinType>(Ty));
2005 case Type::Complex:
2006 return CreateType(cast<ComplexType>(Ty));
2007 case Type::Pointer:
2008 return CreateType(cast<PointerType>(Ty), Unit);
2009 case Type::BlockPointer:
2010 return CreateType(cast<BlockPointerType>(Ty), Unit);
2011 case Type::Typedef:
David Blaikie5f6e2f42013-06-05 05:32:23 +00002012 return CreateType(cast<TypedefType>(Ty), Unit, Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002013 case Type::Record:
David Blaikie5f6e2f42013-06-05 05:32:23 +00002014 return CreateType(cast<RecordType>(Ty), Declaration);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002015 case Type::Enum:
2016 return CreateEnumType(cast<EnumType>(Ty)->getDecl());
2017 case Type::FunctionProto:
2018 case Type::FunctionNoProto:
2019 return CreateType(cast<FunctionType>(Ty), Unit);
2020 case Type::ConstantArray:
2021 case Type::VariableArray:
2022 case Type::IncompleteArray:
2023 return CreateType(cast<ArrayType>(Ty), Unit);
2024
2025 case Type::LValueReference:
2026 return CreateType(cast<LValueReferenceType>(Ty), Unit);
2027 case Type::RValueReference:
2028 return CreateType(cast<RValueReferenceType>(Ty), Unit);
2029
2030 case Type::MemberPointer:
2031 return CreateType(cast<MemberPointerType>(Ty), Unit);
2032
2033 case Type::Atomic:
2034 return CreateType(cast<AtomicType>(Ty), Unit);
2035
2036 case Type::Attributed:
2037 case Type::TemplateSpecialization:
2038 case Type::Elaborated:
2039 case Type::Paren:
2040 case Type::SubstTemplateTypeParm:
2041 case Type::TypeOfExpr:
2042 case Type::TypeOf:
2043 case Type::Decltype:
2044 case Type::UnaryTransform:
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002045 llvm_unreachable("type should have been unwrapped!");
David Blaikie91296482013-05-24 21:24:35 +00002046 case Type::Auto:
2047 Diag = "auto";
2048 break;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002049 }
Eric Christopher6537f082013-05-16 00:45:12 +00002050
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002051 assert(Diag && "Fall through without a diagnostic?");
2052 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
2053 "debug information for %0 is not yet supported");
2054 CGM.getDiags().Report(DiagID)
2055 << Diag;
2056 return llvm::DIType();
2057}
2058
2059/// getOrCreateLimitedType - Get the type from the cache or create a new
2060/// limited type if necessary.
2061llvm::DIType CGDebugInfo::getOrCreateLimitedType(QualType Ty,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002062 llvm::DIFile Unit) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002063 if (Ty.isNull())
2064 return llvm::DIType();
2065
2066 // Unwrap the type as needed for debug information.
David Blaikie4b12be62013-01-21 04:37:12 +00002067 Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002068
2069 llvm::DIType T = getTypeOrNull(Ty);
2070
2071 // We may have cached a forward decl when we could have created
2072 // a non-forward decl. Go ahead and create a non-forward decl
2073 // now.
2074 if (T.Verify() && !T.isForwardDecl()) return T;
2075
2076 // Otherwise create the type.
2077 llvm::DIType Res = CreateLimitedTypeNode(Ty, Unit);
2078
2079 if (T.Verify() && T.isForwardDecl())
2080 ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(),
2081 static_cast<llvm::Value*>(T)));
2082
2083 // And update the type cache.
2084 TypeCache[Ty.getAsOpaquePtr()] = Res;
2085 return Res;
2086}
2087
2088// TODO: Currently used for context chains when limiting debug info.
2089llvm::DIType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
2090 RecordDecl *RD = Ty->getDecl();
Eric Christopher6537f082013-05-16 00:45:12 +00002091
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002092 // Get overall information about the record type for the debug info.
2093 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
2094 unsigned Line = getLineNumber(RD->getLocation());
2095 StringRef RDName = getClassName(RD);
2096
2097 llvm::DIDescriptor RDContext;
Eric Christopher13c97672013-05-16 00:45:23 +00002098 if (DebugKind == CodeGenOptions::LimitedDebugInfo)
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002099 RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
2100 else
2101 RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
2102
2103 // If this is just a forward declaration, construct an appropriately
2104 // marked node and just return it.
2105 if (!RD->getDefinition())
2106 return createRecordFwdDecl(RD, RDContext);
2107
2108 uint64_t Size = CGM.getContext().getTypeSize(Ty);
2109 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
2110 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
David Blaikie2fcadbe2013-03-26 23:47:35 +00002111 llvm::DICompositeType RealDecl;
Eric Christopher6537f082013-05-16 00:45:12 +00002112
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002113 if (RD->isUnion())
2114 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002115 Size, Align, 0, llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002116 else if (RD->isClass()) {
2117 // FIXME: This could be a struct type giving a default visibility different
2118 // than C++ class type, but needs llvm metadata changes first.
2119 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002120 Size, Align, 0, 0, llvm::DIType(),
2121 llvm::DIArray(), llvm::DIType(),
2122 llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002123 } else
2124 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
Eric Christopherf0890c42013-05-16 00:52:20 +00002125 Size, Align, 0, llvm::DIType(),
2126 llvm::DIArray());
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002127
2128 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
David Blaikie2fcadbe2013-03-26 23:47:35 +00002129 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002130
2131 if (CXXDecl) {
2132 // A class's primary base or the class itself contains the vtable.
David Blaikie2fcadbe2013-03-26 23:47:35 +00002133 llvm::DICompositeType ContainingType;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002134 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
2135 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
2136 // Seek non virtual primary base root.
2137 while (1) {
Eric Christopherbe5f1be2013-02-21 22:35:08 +00002138 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
2139 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
2140 if (PBT && !BRL.isPrimaryBaseVirtual())
2141 PBase = PBT;
2142 else
2143 break;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002144 }
David Blaikie2fcadbe2013-03-26 23:47:35 +00002145 ContainingType = llvm::DICompositeType(
2146 getOrCreateType(QualType(PBase->getTypeForDecl(), 0), DefUnit));
2147 } else if (CXXDecl->isDynamicClass())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002148 ContainingType = RealDecl;
2149
David Blaikie2fcadbe2013-03-26 23:47:35 +00002150 RealDecl.setContainingType(ContainingType);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002151 }
2152 return llvm::DIType(RealDecl);
2153}
2154
2155/// CreateLimitedTypeNode - Create a new debug type node, but only forward
2156/// declare composite types that haven't been processed yet.
2157llvm::DIType CGDebugInfo::CreateLimitedTypeNode(QualType Ty,llvm::DIFile Unit) {
2158
2159 // Work out details of type.
2160 switch (Ty->getTypeClass()) {
2161#define TYPE(Class, Base)
2162#define ABSTRACT_TYPE(Class, Base)
2163#define NON_CANONICAL_TYPE(Class, Base)
2164#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2165 #include "clang/AST/TypeNodes.def"
2166 llvm_unreachable("Dependent types cannot show up in debug information");
2167
2168 case Type::Record:
2169 return CreateLimitedType(cast<RecordType>(Ty));
2170 default:
David Blaikie5f6e2f42013-06-05 05:32:23 +00002171 return CreateTypeNode(Ty, Unit, false);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002172 }
2173}
2174
2175/// CreateMemberType - Create new member and increase Offset by FType's size.
2176llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
2177 StringRef Name,
2178 uint64_t *Offset) {
2179 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2180 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
2181 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
2182 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
2183 FieldSize, FieldAlign,
2184 *Offset, 0, FieldTy);
2185 *Offset += FieldSize;
2186 return Ty;
2187}
2188
David Blaikie9faebd22013-05-20 04:58:53 +00002189llvm::DIDescriptor CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
2190 // We only need a declaration (not a definition) of the type - so use whatever
2191 // we would otherwise do to get a type for a pointee. (forward declarations in
2192 // limited debug info, full definitions (if the type definition is available)
2193 // in unlimited debug info)
2194 if (const TypeDecl *TD = dyn_cast<TypeDecl>(D)) {
2195 llvm::DIFile DefUnit = getOrCreateFile(TD->getLocation());
David Blaikieb0f77b02013-05-24 21:33:22 +00002196 return getOrCreateTypeDeclaration(CGM.getContext().getTypeDeclType(TD),
2197 DefUnit);
David Blaikie9faebd22013-05-20 04:58:53 +00002198 }
2199 // Otherwise fall back to a fairly rudimentary cache of existing declarations.
2200 // This doesn't handle providing declarations (for functions or variables) for
2201 // entities without definitions in this TU, nor when the definition proceeds
2202 // the call to this function.
2203 // FIXME: This should be split out into more specific maps with support for
2204 // emitting forward declarations and merging definitions with declarations,
2205 // the same way as we do for types.
2206 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator I =
2207 DeclCache.find(D->getCanonicalDecl());
2208 if (I == DeclCache.end())
2209 return llvm::DIDescriptor();
2210 llvm::Value *V = I->second;
2211 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(V));
2212}
2213
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002214/// getFunctionDeclaration - Return debug info descriptor to describe method
2215/// declaration for the given method definition.
2216llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
2217 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
2218 if (!FD) return llvm::DISubprogram();
2219
2220 // Setup context.
2221 getContextDescriptor(cast<Decl>(D->getDeclContext()));
2222
2223 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2224 MI = SPCache.find(FD->getCanonicalDecl());
2225 if (MI != SPCache.end()) {
2226 llvm::Value *V = MI->second;
2227 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
2228 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
2229 return SP;
2230 }
2231
2232 for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
2233 E = FD->redecls_end(); I != E; ++I) {
2234 const FunctionDecl *NextFD = *I;
2235 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2236 MI = SPCache.find(NextFD->getCanonicalDecl());
2237 if (MI != SPCache.end()) {
2238 llvm::Value *V = MI->second;
2239 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(V));
2240 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
2241 return SP;
2242 }
2243 }
2244 return llvm::DISubprogram();
2245}
2246
2247// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
2248// implicit parameter "this".
David Blaikie9a845292013-05-22 23:22:42 +00002249llvm::DICompositeType CGDebugInfo::getOrCreateFunctionType(const Decl *D,
2250 QualType FnType,
2251 llvm::DIFile F) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002252
2253 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
2254 return getOrCreateMethodType(Method, F);
2255 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
2256 // Add "self" and "_cmd"
2257 SmallVector<llvm::Value *, 16> Elts;
2258
2259 // First element is always return type. For 'void' functions it is NULL.
Adrian Prantl0cb00022013-05-22 21:37:49 +00002260 QualType ResultTy = OMethod->getResultType();
2261
2262 // Replace the instancetype keyword with the actual type.
2263 if (ResultTy == CGM.getContext().getObjCInstanceType())
2264 ResultTy = CGM.getContext().getPointerType(
2265 QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
2266
Adrian Prantl566a9c32013-05-10 21:08:31 +00002267 Elts.push_back(getOrCreateType(ResultTy, F));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002268 // "self" pointer is always first argument.
Adrian Prantle86fcc42013-03-29 19:20:29 +00002269 QualType SelfDeclTy = OMethod->getSelfDecl()->getType();
2270 llvm::DIType SelfTy = getOrCreateType(SelfDeclTy, F);
2271 Elts.push_back(CreateSelfType(SelfDeclTy, SelfTy));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002272 // "_cmd" pointer is always second argument.
2273 llvm::DIType CmdTy = getOrCreateType(OMethod->getCmdDecl()->getType(), F);
2274 Elts.push_back(DBuilder.createArtificialType(CmdTy));
2275 // Get rest of the arguments.
Eric Christopher6537f082013-05-16 00:45:12 +00002276 for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002277 PE = OMethod->param_end(); PI != PE; ++PI)
2278 Elts.push_back(getOrCreateType((*PI)->getType(), F));
2279
2280 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2281 return DBuilder.createSubroutineType(F, EltTypeArray);
2282 }
David Blaikie9a845292013-05-22 23:22:42 +00002283 return llvm::DICompositeType(getOrCreateType(FnType, F));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002284}
2285
2286/// EmitFunctionStart - Constructs the debug code for entering a function.
2287void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
2288 llvm::Function *Fn,
2289 CGBuilderTy &Builder) {
2290
2291 StringRef Name;
2292 StringRef LinkageName;
2293
2294 FnBeginRegionCount.push_back(LexicalBlockStack.size());
2295
2296 const Decl *D = GD.getDecl();
2297 // Function may lack declaration in source code if it is created by Clang
2298 // CodeGen (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
2299 bool HasDecl = (D != 0);
2300 // Use the location of the declaration.
2301 SourceLocation Loc;
2302 if (HasDecl)
2303 Loc = D->getLocation();
2304
2305 unsigned Flags = 0;
2306 llvm::DIFile Unit = getOrCreateFile(Loc);
2307 llvm::DIDescriptor FDContext(Unit);
2308 llvm::DIArray TParamsArray;
2309 if (!HasDecl) {
2310 // Use llvm function name.
2311 Name = Fn->getName();
2312 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
2313 // If there is a DISubprogram for this function available then use it.
2314 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
2315 FI = SPCache.find(FD->getCanonicalDecl());
2316 if (FI != SPCache.end()) {
2317 llvm::Value *V = FI->second;
2318 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(V));
2319 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2320 llvm::MDNode *SPN = SP;
2321 LexicalBlockStack.push_back(SPN);
2322 RegionMap[D] = llvm::WeakVH(SP);
2323 return;
2324 }
2325 }
2326 Name = getFunctionName(FD);
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002327 // Use mangled name as linkage name for C/C++ functions.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002328 if (FD->hasPrototype()) {
2329 LinkageName = CGM.getMangledName(GD);
2330 Flags |= llvm::DIDescriptor::FlagPrototyped;
2331 }
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002332 // No need to replicate the linkage name if it isn't different from the
2333 // subprogram name, no need to have it at all unless coverage is enabled or
2334 // debug is set to more than just line tables.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002335 if (LinkageName == Name ||
Nick Lewyckyf2b5e072013-03-20 01:38:16 +00002336 (!CGM.getCodeGenOpts().EmitGcovArcs &&
2337 !CGM.getCodeGenOpts().EmitGcovNotes &&
Eric Christopher13c97672013-05-16 00:45:23 +00002338 DebugKind <= CodeGenOptions::DebugLineTablesOnly))
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002339 LinkageName = StringRef();
2340
Eric Christopher13c97672013-05-16 00:45:23 +00002341 if (DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002342 if (const NamespaceDecl *NSDecl =
2343 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2344 FDContext = getOrCreateNameSpace(NSDecl);
2345 else if (const RecordDecl *RDecl =
2346 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2347 FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
2348
2349 // Collect template parameters.
2350 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2351 }
2352 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
2353 Name = getObjCMethodName(OMD);
2354 Flags |= llvm::DIDescriptor::FlagPrototyped;
2355 } else {
2356 // Use llvm function name.
2357 Name = Fn->getName();
2358 Flags |= llvm::DIDescriptor::FlagPrototyped;
2359 }
2360 if (!Name.empty() && Name[0] == '\01')
2361 Name = Name.substr(1);
2362
2363 unsigned LineNo = getLineNumber(Loc);
2364 if (!HasDecl || D->isImplicit())
2365 Flags |= llvm::DIDescriptor::FlagArtificial;
2366
David Blaikie9a845292013-05-22 23:22:42 +00002367 llvm::DICompositeType DIFnType;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002368 llvm::DISubprogram SPDecl;
2369 if (HasDecl &&
Eric Christopher13c97672013-05-16 00:45:23 +00002370 DebugKind >= CodeGenOptions::LimitedDebugInfo) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002371 DIFnType = getOrCreateFunctionType(D, FnType, Unit);
2372 SPDecl = getFunctionDeclaration(D);
2373 } else {
2374 // Create fake but valid subroutine type. Otherwise
2375 // llvm::DISubprogram::Verify() would return false, and
2376 // subprogram DIE will miss DW_AT_decl_file and
2377 // DW_AT_decl_line fields.
2378 SmallVector<llvm::Value*, 16> Elts;
2379 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2380 DIFnType = DBuilder.createSubroutineType(Unit, EltTypeArray);
2381 }
2382 llvm::DISubprogram SP;
2383 SP = DBuilder.createFunction(FDContext, Name, LinkageName, Unit,
2384 LineNo, DIFnType,
2385 Fn->hasInternalLinkage(), true/*definition*/,
2386 getLineNumber(CurLoc), Flags,
2387 CGM.getLangOpts().Optimize,
2388 Fn, TParamsArray, SPDecl);
David Blaikie9faebd22013-05-20 04:58:53 +00002389 if (HasDecl)
2390 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(SP)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002391
2392 // Push function on region stack.
2393 llvm::MDNode *SPN = SP;
2394 LexicalBlockStack.push_back(SPN);
2395 if (HasDecl)
2396 RegionMap[D] = llvm::WeakVH(SP);
2397}
2398
2399/// EmitLocation - Emit metadata to indicate a change in line/column
2400/// information in the source file.
Adrian Prantl00df5ea2013-03-12 20:43:25 +00002401void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
2402 bool ForceColumnInfo) {
Eric Christopher6537f082013-05-16 00:45:12 +00002403
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002404 // Update our current location
2405 setLocation(Loc);
2406
2407 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
2408
2409 // Don't bother if things are the same as last time.
2410 SourceManager &SM = CGM.getContext().getSourceManager();
2411 if (CurLoc == PrevLoc ||
2412 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
2413 // New Builder may not be in sync with CGDebugInfo.
David Blaikie0a0f93c2013-02-01 19:09:49 +00002414 if (!Builder.getCurrentDebugLocation().isUnknown() &&
2415 Builder.getCurrentDebugLocation().getScope(CGM.getLLVMContext()) ==
2416 LexicalBlockStack.back())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002417 return;
Eric Christopher6537f082013-05-16 00:45:12 +00002418
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002419 // Update last state.
2420 PrevLoc = CurLoc;
2421
2422 llvm::MDNode *Scope = LexicalBlockStack.back();
Adrian Prantl00df5ea2013-03-12 20:43:25 +00002423 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get
2424 (getLineNumber(CurLoc),
2425 getColumnNumber(CurLoc, ForceColumnInfo),
2426 Scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002427}
2428
2429/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2430/// the stack.
2431void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
2432 llvm::DIDescriptor D =
2433 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
2434 llvm::DIDescriptor() :
2435 llvm::DIDescriptor(LexicalBlockStack.back()),
2436 getOrCreateFile(CurLoc),
2437 getLineNumber(CurLoc),
2438 getColumnNumber(CurLoc));
2439 llvm::MDNode *DN = D;
2440 LexicalBlockStack.push_back(DN);
2441}
2442
2443/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2444/// region - beginning of a DW_TAG_lexical_block.
Eric Christopherf0890c42013-05-16 00:52:20 +00002445void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder,
2446 SourceLocation Loc) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002447 // Set our current location.
2448 setLocation(Loc);
2449
2450 // Create a new lexical block and push it on the stack.
2451 CreateLexicalBlock(Loc);
2452
2453 // Emit a line table change for the current location inside the new scope.
2454 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
2455 getColumnNumber(Loc),
2456 LexicalBlockStack.back()));
2457}
2458
2459/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
2460/// region - end of a DW_TAG_lexical_block.
Eric Christopherf0890c42013-05-16 00:52:20 +00002461void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder,
2462 SourceLocation Loc) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002463 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2464
2465 // Provide an entry in the line table for the end of the block.
2466 EmitLocation(Builder, Loc);
2467
2468 LexicalBlockStack.pop_back();
2469}
2470
2471/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2472void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
2473 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2474 unsigned RCount = FnBeginRegionCount.back();
2475 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
2476
2477 // Pop all regions for this function.
2478 while (LexicalBlockStack.size() != RCount)
2479 EmitLexicalBlockEnd(Builder, CurLoc);
2480 FnBeginRegionCount.pop_back();
2481}
2482
Eric Christopher6537f082013-05-16 00:45:12 +00002483// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002484// See BuildByRefType.
2485llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
2486 uint64_t *XOffset) {
2487
2488 SmallVector<llvm::Value *, 5> EltTys;
2489 QualType FType;
2490 uint64_t FieldSize, FieldOffset;
2491 unsigned FieldAlign;
Eric Christopher6537f082013-05-16 00:45:12 +00002492
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002493 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00002494 QualType Type = VD->getType();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002495
2496 FieldOffset = 0;
2497 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2498 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2499 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
2500 FType = CGM.getContext().IntTy;
2501 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2502 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2503
2504 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
2505 if (HasCopyAndDispose) {
2506 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
2507 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2508 &FieldOffset));
2509 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2510 &FieldOffset));
2511 }
2512 bool HasByrefExtendedLayout;
2513 Qualifiers::ObjCLifetime Lifetime;
2514 if (CGM.getContext().getByrefLifetime(Type,
2515 Lifetime, HasByrefExtendedLayout)
2516 && HasByrefExtendedLayout)
2517 EltTys.push_back(CreateMemberType(Unit, FType,
2518 "__byref_variable_layout",
2519 &FieldOffset));
Eric Christopher6537f082013-05-16 00:45:12 +00002520
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002521 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2522 if (Align > CGM.getContext().toCharUnitsFromBits(
John McCall64aa4b32013-04-16 22:48:15 +00002523 CGM.getTarget().getPointerAlign(0))) {
Eric Christopher6537f082013-05-16 00:45:12 +00002524 CharUnits FieldOffsetInBytes
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002525 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2526 CharUnits AlignedOffsetInBytes
2527 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2528 CharUnits NumPaddingBytes
2529 = AlignedOffsetInBytes - FieldOffsetInBytes;
Eric Christopher6537f082013-05-16 00:45:12 +00002530
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002531 if (NumPaddingBytes.isPositive()) {
2532 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
2533 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2534 pad, ArrayType::Normal, 0);
2535 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
2536 }
2537 }
Eric Christopher6537f082013-05-16 00:45:12 +00002538
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002539 FType = Type;
2540 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
2541 FieldSize = CGM.getContext().getTypeSize(FType);
2542 FieldAlign = CGM.getContext().toBits(Align);
2543
Eric Christopher6537f082013-05-16 00:45:12 +00002544 *XOffset = FieldOffset;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002545 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
2546 0, FieldSize, FieldAlign,
2547 FieldOffset, 0, FieldTy);
2548 EltTys.push_back(FieldTy);
2549 FieldOffset += FieldSize;
Eric Christopher6537f082013-05-16 00:45:12 +00002550
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002551 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher6537f082013-05-16 00:45:12 +00002552
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002553 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Eric Christopher6537f082013-05-16 00:45:12 +00002554
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002555 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
David Blaikiec1d0af12013-02-25 01:07:08 +00002556 llvm::DIType(), Elements);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002557}
2558
2559/// EmitDeclare - Emit local variable declaration debug info.
2560void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Eric Christopher6537f082013-05-16 00:45:12 +00002561 llvm::Value *Storage,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002562 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002563 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002564 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
2565
2566 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2567 llvm::DIType Ty;
2568 uint64_t XOffset = 0;
2569 if (VD->hasAttr<BlocksAttr>())
2570 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopher6537f082013-05-16 00:45:12 +00002571 else
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002572 Ty = getOrCreateType(VD->getType(), Unit);
2573
2574 // If there is no debug info for this type then do not emit debug info
2575 // for this variable.
2576 if (!Ty)
2577 return;
2578
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002579 // Get location information.
2580 unsigned Line = getLineNumber(VD->getLocation());
2581 unsigned Column = getColumnNumber(VD->getLocation());
2582 unsigned Flags = 0;
2583 if (VD->isImplicit())
2584 Flags |= llvm::DIDescriptor::FlagArtificial;
2585 // If this is the first argument and it is implicit then
2586 // give it an object pointer flag.
2587 // FIXME: There has to be a better way to do this, but for static
2588 // functions there won't be an implicit param at arg1 and
2589 // otherwise it is 'self' or 'this'.
2590 if (isa<ImplicitParamDecl>(VD) && ArgNo == 1)
2591 Flags |= llvm::DIDescriptor::FlagObjectPointer;
2592
2593 llvm::MDNode *Scope = LexicalBlockStack.back();
2594
2595 StringRef Name = VD->getName();
2596 if (!Name.empty()) {
2597 if (VD->hasAttr<BlocksAttr>()) {
2598 CharUnits offset = CharUnits::fromQuantity(32);
2599 SmallVector<llvm::Value *, 9> addr;
2600 llvm::Type *Int64Ty = CGM.Int64Ty;
2601 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2602 // offset of __forwarding field
2603 offset = CGM.getContext().toCharUnitsFromBits(
John McCall64aa4b32013-04-16 22:48:15 +00002604 CGM.getTarget().getPointerWidth(0));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002605 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2606 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2607 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2608 // offset of x field
2609 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2610 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2611
2612 // Create the descriptor for the variable.
2613 llvm::DIVariable D =
Eric Christopher6537f082013-05-16 00:45:12 +00002614 DBuilder.createComplexVariable(Tag,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002615 llvm::DIDescriptor(Scope),
2616 VD->getName(), Unit, Line, Ty,
2617 addr, ArgNo);
Eric Christopher6537f082013-05-16 00:45:12 +00002618
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002619 // Insert an llvm.dbg.declare into the current block.
2620 llvm::Instruction *Call =
2621 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2622 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2623 return;
Adrian Prantl230ea412013-04-30 22:45:09 +00002624 } else if (isa<VariableArrayType>(VD->getType())) {
2625 // These are "complex" variables in that they need an op_deref.
2626 // Create the descriptor for the variable.
2627 llvm::Value *Addr = llvm::ConstantInt::get(CGM.Int64Ty,
2628 llvm::DIBuilder::OpDeref);
2629 llvm::DIVariable D =
2630 DBuilder.createComplexVariable(Tag,
2631 llvm::DIDescriptor(Scope),
2632 Name, Unit, Line, Ty,
2633 Addr, ArgNo);
2634
2635 // Insert an llvm.dbg.declare into the current block.
2636 llvm::Instruction *Call =
2637 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2638 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2639 return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002640 }
David Blaikie436653b2013-01-05 05:58:35 +00002641 } else if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2642 // If VD is an anonymous union then Storage represents value for
2643 // all union fields.
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002644 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
David Blaikied8180cf2013-01-05 20:03:07 +00002645 if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002646 for (RecordDecl::field_iterator I = RD->field_begin(),
2647 E = RD->field_end();
2648 I != E; ++I) {
2649 FieldDecl *Field = *I;
2650 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
2651 StringRef FieldName = Field->getName();
Eric Christopher6537f082013-05-16 00:45:12 +00002652
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002653 // Ignore unnamed fields. Do not ignore unnamed records.
2654 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2655 continue;
Eric Christopher6537f082013-05-16 00:45:12 +00002656
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002657 // Use VarDecl's Tag, Scope and Line number.
2658 llvm::DIVariable D =
2659 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Eric Christopher6537f082013-05-16 00:45:12 +00002660 FieldName, Unit, Line, FieldTy,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002661 CGM.getLangOpts().Optimize, Flags,
2662 ArgNo);
Eric Christopher6537f082013-05-16 00:45:12 +00002663
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002664 // Insert an llvm.dbg.declare into the current block.
2665 llvm::Instruction *Call =
2666 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2667 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2668 }
David Blaikied8180cf2013-01-05 20:03:07 +00002669 return;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002670 }
2671 }
David Blaikie436653b2013-01-05 05:58:35 +00002672
2673 // Create the descriptor for the variable.
2674 llvm::DIVariable D =
2675 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2676 Name, Unit, Line, Ty,
2677 CGM.getLangOpts().Optimize, Flags, ArgNo);
2678
2679 // Insert an llvm.dbg.declare into the current block.
2680 llvm::Instruction *Call =
2681 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2682 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002683}
2684
2685void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2686 llvm::Value *Storage,
2687 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002688 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002689 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2690}
2691
Adrian Prantle86fcc42013-03-29 19:20:29 +00002692/// Look up the completed type for a self pointer in the TypeCache and
2693/// create a copy of it with the ObjectPointer and Artificial flags
2694/// set. If the type is not cached, a new one is created. This should
2695/// never happen though, since creating a type for the implicit self
2696/// argument implies that we already parsed the interface definition
2697/// and the ivar declarations in the implementation.
Eric Christopherf0890c42013-05-16 00:52:20 +00002698llvm::DIType CGDebugInfo::CreateSelfType(const QualType &QualTy,
2699 llvm::DIType Ty) {
Adrian Prantle86fcc42013-03-29 19:20:29 +00002700 llvm::DIType CachedTy = getTypeOrNull(QualTy);
2701 if (CachedTy.Verify()) Ty = CachedTy;
2702 else DEBUG(llvm::dbgs() << "No cached type for self.");
2703 return DBuilder.createObjectPointerType(Ty);
2704}
2705
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002706void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(const VarDecl *VD,
2707 llvm::Value *Storage,
2708 CGBuilderTy &Builder,
2709 const CGBlockInfo &blockInfo) {
Eric Christopher13c97672013-05-16 00:45:23 +00002710 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002711 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopher6537f082013-05-16 00:45:12 +00002712
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002713 if (Builder.GetInsertBlock() == 0)
2714 return;
Eric Christopher6537f082013-05-16 00:45:12 +00002715
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002716 bool isByRef = VD->hasAttr<BlocksAttr>();
Eric Christopher6537f082013-05-16 00:45:12 +00002717
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002718 uint64_t XOffset = 0;
2719 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
2720 llvm::DIType Ty;
2721 if (isByRef)
2722 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
Eric Christopher6537f082013-05-16 00:45:12 +00002723 else
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002724 Ty = getOrCreateType(VD->getType(), Unit);
2725
2726 // Self is passed along as an implicit non-arg variable in a
2727 // block. Mark it as the object pointer.
2728 if (isa<ImplicitParamDecl>(VD) && VD->getName() == "self")
Adrian Prantle86fcc42013-03-29 19:20:29 +00002729 Ty = CreateSelfType(VD->getType(), Ty);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002730
2731 // Get location information.
2732 unsigned Line = getLineNumber(VD->getLocation());
2733 unsigned Column = getColumnNumber(VD->getLocation());
2734
2735 const llvm::DataLayout &target = CGM.getDataLayout();
2736
2737 CharUnits offset = CharUnits::fromQuantity(
2738 target.getStructLayout(blockInfo.StructureType)
2739 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2740
2741 SmallVector<llvm::Value *, 9> addr;
2742 llvm::Type *Int64Ty = CGM.Int64Ty;
Adrian Prantl9b97adf2013-03-29 19:20:35 +00002743 if (isa<llvm::AllocaInst>(Storage))
2744 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002745 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2746 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2747 if (isByRef) {
2748 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2749 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2750 // offset of __forwarding field
2751 offset = CGM.getContext()
2752 .toCharUnitsFromBits(target.getPointerSizeInBits(0));
2753 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2754 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2755 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
2756 // offset of x field
2757 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
2758 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2759 }
2760
2761 // Create the descriptor for the variable.
2762 llvm::DIVariable D =
Eric Christopher6537f082013-05-16 00:45:12 +00002763 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002764 llvm::DIDescriptor(LexicalBlockStack.back()),
2765 VD->getName(), Unit, Line, Ty, addr);
Adrian Prantl9b97adf2013-03-29 19:20:35 +00002766
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002767 // Insert an llvm.dbg.declare into the current block.
2768 llvm::Instruction *Call =
2769 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
2770 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2771 LexicalBlockStack.back()));
2772}
2773
2774/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2775/// variable declaration.
2776void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
2777 unsigned ArgNo,
2778 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002779 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002780 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
2781}
2782
2783namespace {
2784 struct BlockLayoutChunk {
2785 uint64_t OffsetInBits;
2786 const BlockDecl::Capture *Capture;
2787 };
2788 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2789 return l.OffsetInBits < r.OffsetInBits;
2790 }
2791}
2792
2793void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
Adrian Prantl836e7c92013-03-14 17:53:33 +00002794 llvm::Value *Arg,
2795 llvm::Value *LocalAddr,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002796 CGBuilderTy &Builder) {
Eric Christopher13c97672013-05-16 00:45:23 +00002797 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002798 ASTContext &C = CGM.getContext();
2799 const BlockDecl *blockDecl = block.getBlockDecl();
2800
2801 // Collect some general information about the block's location.
2802 SourceLocation loc = blockDecl->getCaretLocation();
2803 llvm::DIFile tunit = getOrCreateFile(loc);
2804 unsigned line = getLineNumber(loc);
2805 unsigned column = getColumnNumber(loc);
Eric Christopher6537f082013-05-16 00:45:12 +00002806
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002807 // Build the debug-info type for the block literal.
2808 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
2809
2810 const llvm::StructLayout *blockLayout =
2811 CGM.getDataLayout().getStructLayout(block.StructureType);
2812
2813 SmallVector<llvm::Value*, 16> fields;
2814 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2815 blockLayout->getElementOffsetInBits(0),
2816 tunit, tunit));
2817 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2818 blockLayout->getElementOffsetInBits(1),
2819 tunit, tunit));
2820 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2821 blockLayout->getElementOffsetInBits(2),
2822 tunit, tunit));
2823 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2824 blockLayout->getElementOffsetInBits(3),
2825 tunit, tunit));
2826 fields.push_back(createFieldType("__descriptor",
2827 C.getPointerType(block.NeedsCopyDispose ?
2828 C.getBlockDescriptorExtendedType() :
2829 C.getBlockDescriptorType()),
2830 0, loc, AS_public,
2831 blockLayout->getElementOffsetInBits(4),
2832 tunit, tunit));
2833
2834 // We want to sort the captures by offset, not because DWARF
2835 // requires this, but because we're paranoid about debuggers.
2836 SmallVector<BlockLayoutChunk, 8> chunks;
2837
2838 // 'this' capture.
2839 if (blockDecl->capturesCXXThis()) {
2840 BlockLayoutChunk chunk;
2841 chunk.OffsetInBits =
2842 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2843 chunk.Capture = 0;
2844 chunks.push_back(chunk);
2845 }
2846
2847 // Variable captures.
2848 for (BlockDecl::capture_const_iterator
2849 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2850 i != e; ++i) {
2851 const BlockDecl::Capture &capture = *i;
2852 const VarDecl *variable = capture.getVariable();
2853 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2854
2855 // Ignore constant captures.
2856 if (captureInfo.isConstant())
2857 continue;
2858
2859 BlockLayoutChunk chunk;
2860 chunk.OffsetInBits =
2861 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2862 chunk.Capture = &capture;
2863 chunks.push_back(chunk);
2864 }
2865
2866 // Sort by offset.
2867 llvm::array_pod_sort(chunks.begin(), chunks.end());
2868
2869 for (SmallVectorImpl<BlockLayoutChunk>::iterator
2870 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2871 uint64_t offsetInBits = i->OffsetInBits;
2872 const BlockDecl::Capture *capture = i->Capture;
2873
2874 // If we have a null capture, this must be the C++ 'this' capture.
2875 if (!capture) {
2876 const CXXMethodDecl *method =
2877 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2878 QualType type = method->getThisType(C);
2879
2880 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
2881 offsetInBits, tunit, tunit));
2882 continue;
2883 }
2884
2885 const VarDecl *variable = capture->getVariable();
2886 StringRef name = variable->getName();
2887
2888 llvm::DIType fieldType;
2889 if (capture->isByRef()) {
2890 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
2891
2892 // FIXME: this creates a second copy of this type!
2893 uint64_t xoffset;
2894 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
2895 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
2896 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
2897 ptrInfo.first, ptrInfo.second,
2898 offsetInBits, 0, fieldType);
2899 } else {
2900 fieldType = createFieldType(name, variable->getType(), 0,
2901 loc, AS_public, offsetInBits, tunit, tunit);
2902 }
2903 fields.push_back(fieldType);
2904 }
2905
2906 SmallString<36> typeName;
2907 llvm::raw_svector_ostream(typeName)
2908 << "__block_literal_" << CGM.getUniqueBlockCount();
2909
2910 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
2911
2912 llvm::DIType type =
2913 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
2914 CGM.getContext().toBits(block.BlockSize),
2915 CGM.getContext().toBits(block.BlockAlign),
David Blaikiec1d0af12013-02-25 01:07:08 +00002916 0, llvm::DIType(), fieldsArray);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002917 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
2918
2919 // Get overall information about the block.
2920 unsigned flags = llvm::DIDescriptor::FlagArtificial;
2921 llvm::MDNode *scope = LexicalBlockStack.back();
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002922
2923 // Create the descriptor for the parameter.
2924 llvm::DIVariable debugVar =
2925 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
Eric Christopher6537f082013-05-16 00:45:12 +00002926 llvm::DIDescriptor(scope),
Adrian Prantl836e7c92013-03-14 17:53:33 +00002927 Arg->getName(), tunit, line, type,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002928 CGM.getLangOpts().Optimize, flags,
Adrian Prantl836e7c92013-03-14 17:53:33 +00002929 cast<llvm::Argument>(Arg)->getArgNo() + 1);
2930
Adrian Prantlbea407c2013-03-14 21:52:59 +00002931 if (LocalAddr) {
Adrian Prantl836e7c92013-03-14 17:53:33 +00002932 // Insert an llvm.dbg.value into the current block.
Adrian Prantlbea407c2013-03-14 21:52:59 +00002933 llvm::Instruction *DbgVal =
2934 DBuilder.insertDbgValueIntrinsic(LocalAddr, 0, debugVar,
Eric Christopherf068c922013-04-02 22:59:11 +00002935 Builder.GetInsertBlock());
Adrian Prantlbea407c2013-03-14 21:52:59 +00002936 DbgVal->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
2937 }
Adrian Prantl836e7c92013-03-14 17:53:33 +00002938
Adrian Prantlbea407c2013-03-14 21:52:59 +00002939 // Insert an llvm.dbg.declare into the current block.
2940 llvm::Instruction *DbgDecl =
2941 DBuilder.insertDeclare(Arg, debugVar, Builder.GetInsertBlock());
2942 DbgDecl->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002943}
2944
Eric Christopher0395de32013-01-16 01:22:32 +00002945/// getStaticDataMemberDeclaration - If D is an out-of-class definition of
2946/// a static data member of a class, find its corresponding in-class
2947/// declaration.
2948llvm::DIDerivedType CGDebugInfo::getStaticDataMemberDeclaration(const Decl *D) {
2949 if (cast<VarDecl>(D)->isStaticDataMember()) {
2950 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
2951 MI = StaticDataMemberCache.find(D->getCanonicalDecl());
2952 if (MI != StaticDataMemberCache.end())
2953 // Verify the info still exists.
2954 if (llvm::Value *V = MI->second)
2955 return llvm::DIDerivedType(cast<llvm::MDNode>(V));
2956 }
2957 return llvm::DIDerivedType();
2958}
2959
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002960/// EmitGlobalVariable - Emit information about a global variable.
2961void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2962 const VarDecl *D) {
Eric Christopher13c97672013-05-16 00:45:23 +00002963 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002964 // Create global variable debug descriptor.
2965 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
2966 unsigned LineNo = getLineNumber(D->getLocation());
2967
2968 setLocation(D->getLocation());
2969
2970 QualType T = D->getType();
2971 if (T->isIncompleteArrayType()) {
2972
2973 // CodeGen turns int[] into int[1] so we'll do the same here.
2974 llvm::APInt ConstVal(32, 1);
2975 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
2976
2977 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
2978 ArrayType::Normal, 0);
2979 }
2980 StringRef DeclName = D->getName();
2981 StringRef LinkageName;
2982 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
2983 && !isa<ObjCMethodDecl>(D->getDeclContext()))
2984 LinkageName = Var->getName();
2985 if (LinkageName == DeclName)
2986 LinkageName = StringRef();
Eric Christopher6537f082013-05-16 00:45:12 +00002987 llvm::DIDescriptor DContext =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002988 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
David Blaikie9faebd22013-05-20 04:58:53 +00002989 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(DContext, DeclName, LinkageName,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002990 Unit, LineNo, getOrCreateType(T, Unit),
Eric Christopher0395de32013-01-16 01:22:32 +00002991 Var->hasInternalLinkage(), Var,
2992 getStaticDataMemberDeclaration(D));
David Blaikie9faebd22013-05-20 04:58:53 +00002993 DeclCache.insert(std::make_pair(D->getCanonicalDecl(), llvm::WeakVH(GV)));
Guy Benyei7f92f2d2012-12-18 14:30:41 +00002994}
2995
2996/// EmitGlobalVariable - Emit information about an objective-c interface.
2997void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
2998 ObjCInterfaceDecl *ID) {
Eric Christopher13c97672013-05-16 00:45:23 +00002999 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003000 // Create global variable debug descriptor.
3001 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
3002 unsigned LineNo = getLineNumber(ID->getLocation());
3003
3004 StringRef Name = ID->getName();
3005
3006 QualType T = CGM.getContext().getObjCInterfaceType(ID);
3007 if (T->isIncompleteArrayType()) {
3008
3009 // CodeGen turns int[] into int[1] so we'll do the same here.
3010 llvm::APInt ConstVal(32, 1);
3011 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3012
3013 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
3014 ArrayType::Normal, 0);
3015 }
3016
3017 DBuilder.createGlobalVariable(Name, Unit, LineNo,
3018 getOrCreateType(T, Unit),
3019 Var->hasInternalLinkage(), Var);
3020}
3021
3022/// EmitGlobalVariable - Emit global variable's debug info.
Eric Christopher6537f082013-05-16 00:45:12 +00003023void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003024 llvm::Constant *Init) {
Eric Christopher13c97672013-05-16 00:45:23 +00003025 assert(DebugKind >= CodeGenOptions::LimitedDebugInfo);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003026 // Create the descriptor for the variable.
3027 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
3028 StringRef Name = VD->getName();
3029 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
3030 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
3031 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
3032 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
3033 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
3034 }
3035 // Do not use DIGlobalVariable for enums.
3036 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
3037 return;
David Blaikie9faebd22013-05-20 04:58:53 +00003038 llvm::DIGlobalVariable GV = DBuilder.createStaticVariable(Unit, Name, Name, Unit,
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003039 getLineNumber(VD->getLocation()),
Eric Christopher0395de32013-01-16 01:22:32 +00003040 Ty, true, Init,
3041 getStaticDataMemberDeclaration(VD));
David Blaikie9faebd22013-05-20 04:58:53 +00003042 DeclCache.insert(std::make_pair(VD->getCanonicalDecl(), llvm::WeakVH(GV)));
3043}
3044
3045llvm::DIScope CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
3046 if (!LexicalBlockStack.empty())
3047 return llvm::DIScope(LexicalBlockStack.back());
3048 return getContextDescriptor(D);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003049}
3050
David Blaikie957dac52013-04-22 06:13:21 +00003051void CGDebugInfo::EmitUsingDirective(const UsingDirectiveDecl &UD) {
David Blaikie9faebd22013-05-20 04:58:53 +00003052 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3053 return;
David Blaikie957dac52013-04-22 06:13:21 +00003054 DBuilder.createImportedModule(
David Blaikie9faebd22013-05-20 04:58:53 +00003055 getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
3056 getOrCreateNameSpace(UD.getNominatedNamespace()),
David Blaikie957dac52013-04-22 06:13:21 +00003057 getLineNumber(UD.getLocation()));
3058}
3059
David Blaikie9faebd22013-05-20 04:58:53 +00003060void CGDebugInfo::EmitUsingDecl(const UsingDecl &UD) {
3061 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3062 return;
3063 assert(UD.shadow_size() &&
3064 "We shouldn't be codegening an invalid UsingDecl containing no decls");
3065 // Emitting one decl is sufficient - debuggers can detect that this is an
3066 // overloaded name & provide lookup for all the overloads.
3067 const UsingShadowDecl &USD = **UD.shadow_begin();
3068 if (llvm::DIDescriptor Target = getDeclarationOrDefinition(USD.getUnderlyingDecl()))
3069 DBuilder.createImportedDeclaration(
3070 getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
3071 getLineNumber(USD.getLocation()));
3072}
3073
David Blaikiefc46ebc2013-05-20 22:50:41 +00003074llvm::DIImportedEntity
3075CGDebugInfo::EmitNamespaceAlias(const NamespaceAliasDecl &NA) {
3076 if (CGM.getCodeGenOpts().getDebugInfo() < CodeGenOptions::LimitedDebugInfo)
3077 return llvm::DIImportedEntity(0);
3078 llvm::WeakVH &VH = NamespaceAliasCache[&NA];
3079 if (VH)
3080 return llvm::DIImportedEntity(cast<llvm::MDNode>(VH));
3081 llvm::DIImportedEntity R(0);
3082 if (const NamespaceAliasDecl *Underlying =
3083 dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
3084 // This could cache & dedup here rather than relying on metadata deduping.
3085 R = DBuilder.createImportedModule(
3086 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3087 EmitNamespaceAlias(*Underlying), getLineNumber(NA.getLocation()),
3088 NA.getName());
3089 else
3090 R = DBuilder.createImportedModule(
3091 getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
3092 getOrCreateNameSpace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
3093 getLineNumber(NA.getLocation()), NA.getName());
3094 VH = R;
3095 return R;
3096}
3097
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003098/// getOrCreateNamesSpace - Return namespace descriptor for the given
3099/// namespace decl.
Eric Christopher6537f082013-05-16 00:45:12 +00003100llvm::DINameSpace
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003101CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
Eric Christopher6537f082013-05-16 00:45:12 +00003102 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003103 NameSpaceCache.find(NSDecl);
3104 if (I != NameSpaceCache.end())
3105 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
Eric Christopher6537f082013-05-16 00:45:12 +00003106
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003107 unsigned LineNo = getLineNumber(NSDecl->getLocation());
3108 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Eric Christopher6537f082013-05-16 00:45:12 +00003109 llvm::DIDescriptor Context =
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003110 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
3111 llvm::DINameSpace NS =
3112 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
3113 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
3114 return NS;
3115}
3116
3117void CGDebugInfo::finalize() {
3118 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
3119 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
3120 llvm::DIType Ty, RepTy;
3121 // Verify that the debug info still exists.
3122 if (llvm::Value *V = VI->second)
3123 Ty = llvm::DIType(cast<llvm::MDNode>(V));
Eric Christopher6537f082013-05-16 00:45:12 +00003124
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003125 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
3126 TypeCache.find(VI->first);
3127 if (it != TypeCache.end()) {
3128 // Verify that the debug info still exists.
3129 if (llvm::Value *V = it->second)
3130 RepTy = llvm::DIType(cast<llvm::MDNode>(V));
3131 }
Adrian Prantlebbd7e02013-03-11 18:33:46 +00003132
Adrian Prantl9b97adf2013-03-29 19:20:35 +00003133 if (Ty.Verify() && Ty.isForwardDecl() && RepTy.Verify())
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003134 Ty.replaceAllUsesWith(RepTy);
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003135 }
Adrian Prantlebbd7e02013-03-11 18:33:46 +00003136
3137 // We keep our own list of retained types, because we need to look
3138 // up the final type in the type cache.
3139 for (std::vector<void *>::const_iterator RI = RetainedTypes.begin(),
3140 RE = RetainedTypes.end(); RI != RE; ++RI)
3141 DBuilder.retainType(llvm::DIType(cast<llvm::MDNode>(TypeCache[*RI])));
3142
Guy Benyei7f92f2d2012-12-18 14:30:41 +00003143 DBuilder.finalize();
3144}