blob: 9dedf37cc9f36aca1937e9effab454df75371478 [file] [log] [blame]
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +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"
Mike Stumpb1a6e682009-09-30 02:43:10 +000015#include "CodeGenFunction.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000016#include "CodeGenModule.h"
John McCalld16c2cf2011-02-08 08:22:06 +000017#include "CGBlocks.h"
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000018#include "clang/AST/ASTContext.h"
Devang Patel2ed8f002010-08-27 17:47:47 +000019#include "clang/AST/DeclFriend.h"
Devang Patel9ca36b62009-02-26 21:10:26 +000020#include "clang/AST/DeclObjC.h"
Devang Patel700a1cb2010-07-20 20:24:18 +000021#include "clang/AST/DeclTemplate.h"
Chris Lattner3cc5c402008-11-11 07:01:36 +000022#include "clang/AST/Expr.h"
Anders Carlsson19cc4ab2009-07-18 19:43:29 +000023#include "clang/AST/RecordLayout.h"
Benjamin Kramer00bd44d2012-02-04 12:31:12 +000024#include "clang/Basic/SourceManager.h"
Benjamin Kramerd7a3e2c2012-02-07 22:29:24 +000025#include "clang/Basic/FileManager.h"
Mike Stump5a862172009-09-15 21:48:34 +000026#include "clang/Basic/Version.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000027#include "clang/Frontend/CodeGenOptions.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000028#include "llvm/Constants.h"
29#include "llvm/DerivedTypes.h"
30#include "llvm/Instructions.h"
31#include "llvm/Intrinsics.h"
32#include "llvm/Module.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000033#include "llvm/ADT/StringExtras.h"
34#include "llvm/ADT/SmallVector.h"
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000035#include "llvm/Support/Dwarf.h"
Benjamin Kramerbcbca752011-10-14 18:45:11 +000036#include "llvm/Support/FileSystem.h"
John McCall6b5a61b2011-02-07 10:33:21 +000037#include "llvm/Target/TargetData.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000038using namespace clang;
39using namespace clang::CodeGen;
40
Anders Carlsson20f12a22009-12-06 18:00:51 +000041CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Devang Patel823d8e92010-12-08 22:42:58 +000042 : CGM(CGM), DBuilder(CGM.getModule()),
Dan Gohman4cac5b42010-08-20 22:02:57 +000043 BlockLiteralGenericSet(false) {
Devang Patel17800552010-03-09 00:44:50 +000044 CreateCompileUnit();
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000045}
46
Chris Lattner9c85ba32008-11-10 06:08:34 +000047CGDebugInfo::~CGDebugInfo() {
Eric Christopherab5278e2011-10-11 23:00:51 +000048 assert(LexicalBlockStack.empty() &&
49 "Region stack mismatch, stack not empty!");
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000050}
51
Chris Lattner9c85ba32008-11-10 06:08:34 +000052void CGDebugInfo::setLocation(SourceLocation Loc) {
Eric Christopher944542e2011-10-11 23:00:45 +000053 // If the new location isn't valid return.
54 if (!Loc.isValid()) return;
55
56 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
Eric Christopher73fb3502011-10-13 21:45:18 +000057
58 // If we've changed files in the middle of a lexical scope go ahead
59 // and create a new lexical scope with file node if it's different
60 // from the one in the scope.
61 if (LexicalBlockStack.empty()) return;
62
63 SourceManager &SM = CGM.getContext().getSourceManager();
64 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
65 PresumedLoc PPLoc = SM.getPresumedLoc(PrevLoc);
66
67 if (PCLoc.isInvalid() || PPLoc.isInvalid() ||
68 !strcmp(PPLoc.getFilename(), PCLoc.getFilename()))
69 return;
70
71 llvm::MDNode *LB = LexicalBlockStack.back();
72 llvm::DIScope Scope = llvm::DIScope(LB);
73 if (Scope.isLexicalBlockFile()) {
74 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(LB);
75 llvm::DIDescriptor D
76 = DBuilder.createLexicalBlockFile(LBF.getScope(),
Devang Patel53bc5182012-02-08 00:10:20 +000077 getOrCreateFile(CurLoc));
Eric Christopher73fb3502011-10-13 21:45:18 +000078 llvm::MDNode *N = D;
79 LexicalBlockStack.pop_back();
80 LexicalBlockStack.push_back(N);
81 } else if (Scope.isLexicalBlock()) {
82 llvm::DIDescriptor D
83 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
84 llvm::MDNode *N = D;
85 LexicalBlockStack.pop_back();
86 LexicalBlockStack.push_back(N);
87 }
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000088}
89
Devang Patel33583052010-01-28 23:15:27 +000090/// getContextDescriptor - Get context info for the decl.
Devang Patel170cef32010-12-09 00:33:05 +000091llvm::DIDescriptor CGDebugInfo::getContextDescriptor(const Decl *Context) {
Devang Pateleb6d79b2010-02-01 21:34:11 +000092 if (!Context)
Devang Patel170cef32010-12-09 00:33:05 +000093 return TheCU;
Devang Pateleb6d79b2010-02-01 21:34:11 +000094
95 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
96 I = RegionMap.find(Context);
97 if (I != RegionMap.end())
Gabor Greif38c9b172010-09-18 13:00:17 +000098 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(&*I->second));
Devang Patel411894b2010-02-01 22:40:08 +000099
Devang Pateleb6d79b2010-02-01 21:34:11 +0000100 // Check namespace.
101 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
Devang Patel170cef32010-12-09 00:33:05 +0000102 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
Devang Patel8b90a782010-05-13 23:52:37 +0000103
104 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context)) {
105 if (!RDecl->isDependentType()) {
Devang Patela2e57692010-10-28 17:27:32 +0000106 llvm::DIType Ty = getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Devang Patel170cef32010-12-09 00:33:05 +0000107 getOrCreateMainFile());
Devang Patel8b90a782010-05-13 23:52:37 +0000108 return llvm::DIDescriptor(Ty);
109 }
110 }
Devang Patel170cef32010-12-09 00:33:05 +0000111 return TheCU;
Devang Patel979ec2e2009-10-06 00:35:31 +0000112}
113
Devang Patel9c6c3a02010-01-14 00:36:21 +0000114/// getFunctionName - Get function name for the given FunctionDecl. If the
115/// name is constructred on demand (e.g. C++ destructor) then the name
116/// is stored on the side.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000117StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Devang Patel9c6c3a02010-01-14 00:36:21 +0000118 assert (FD && "Invalid FunctionDecl!");
119 IdentifierInfo *FII = FD->getIdentifier();
Eric Christopher16717452012-03-14 00:25:46 +0000120 FunctionTemplateSpecializationInfo *Info
121 = FD->getTemplateSpecializationInfo();
122 if (!Info && FII)
Devang Patel9c6c3a02010-01-14 00:36:21 +0000123 return FII->getName();
124
125 // Otherwise construct human readable name for debug info.
126 std::string NS = FD->getNameAsString();
127
Eric Christopher16717452012-03-14 00:25:46 +0000128 // Add any template specialization args.
129 if (Info) {
130 const TemplateArgumentList *TArgs = Info->TemplateArguments;
131 const TemplateArgument *Args = TArgs->data();
132 unsigned NumArgs = TArgs->size();
133 PrintingPolicy Policy(CGM.getLangOpts());
134 NS += TemplateSpecializationType::PrintTemplateArgumentList(Args,
135 NumArgs,
136 Policy);
137 }
138
Devang Patel9c6c3a02010-01-14 00:36:21 +0000139 // Copy this name on the side and use its reference.
Devang Patel89f05f82010-01-28 18:21:00 +0000140 char *StrPtr = DebugInfoNames.Allocate<char>(NS.length());
Benjamin Kramer1b627dc2010-01-23 18:16:07 +0000141 memcpy(StrPtr, NS.data(), NS.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000142 return StringRef(StrPtr, NS.length());
Devang Patel9c6c3a02010-01-14 00:36:21 +0000143}
144
Chris Lattner5f9e2722011-07-23 10:55:15 +0000145StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000146 SmallString<256> MethodName;
David Chisnall52044a22010-09-02 18:01:51 +0000147 llvm::raw_svector_ostream OS(MethodName);
148 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
149 const DeclContext *DC = OMD->getDeclContext();
Devang Patela2e57692010-10-28 17:27:32 +0000150 if (const ObjCImplementationDecl *OID =
151 dyn_cast<const ObjCImplementationDecl>(DC)) {
David Chisnall52044a22010-09-02 18:01:51 +0000152 OS << OID->getName();
Devang Patela2e57692010-10-28 17:27:32 +0000153 } else if (const ObjCInterfaceDecl *OID =
154 dyn_cast<const ObjCInterfaceDecl>(DC)) {
Fariborz Jahanian1a4c9372010-10-18 17:51:06 +0000155 OS << OID->getName();
Devang Patela2e57692010-10-28 17:27:32 +0000156 } else if (const ObjCCategoryImplDecl *OCD =
157 dyn_cast<const ObjCCategoryImplDecl>(DC)){
David Chisnall52044a22010-09-02 18:01:51 +0000158 OS << ((NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
159 OCD->getIdentifier()->getNameStart() << ')';
160 }
161 OS << ' ' << OMD->getSelector().getAsString() << ']';
162
163 char *StrPtr = DebugInfoNames.Allocate<char>(OS.tell());
164 memcpy(StrPtr, MethodName.begin(), OS.tell());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000165 return StringRef(StrPtr, OS.tell());
David Chisnall52044a22010-09-02 18:01:51 +0000166}
167
Eric Christopherecae5962012-03-29 17:31:33 +0000168/// getSelectorName - Return selector name. This is used for debugging
169/// info.
170StringRef CGDebugInfo::getSelectorName(Selector S) {
171 const std::string &SName = S.getAsString();
172 char *StrPtr = DebugInfoNames.Allocate<char>(SName.size());
173 memcpy(StrPtr, SName.data(), SName.size());
174 return StringRef(StrPtr, SName.size());
175}
176
Devang Patel700a1cb2010-07-20 20:24:18 +0000177/// getClassName - Get class name including template argument list.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000178StringRef
Eric Christopher9caf4402012-02-08 01:53:14 +0000179CGDebugInfo::getClassName(const RecordDecl *RD) {
180 const ClassTemplateSpecializationDecl *Spec
Devang Patel700a1cb2010-07-20 20:24:18 +0000181 = dyn_cast<ClassTemplateSpecializationDecl>(RD);
182 if (!Spec)
183 return RD->getName();
184
185 const TemplateArgument *Args;
186 unsigned NumArgs;
Devang Patel700a1cb2010-07-20 20:24:18 +0000187 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
188 const TemplateSpecializationType *TST =
189 cast<TemplateSpecializationType>(TAW->getType());
190 Args = TST->getArgs();
191 NumArgs = TST->getNumArgs();
192 } else {
193 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
Douglas Gregor910f8002010-11-07 23:05:16 +0000194 Args = TemplateArgs.data();
195 NumArgs = TemplateArgs.size();
Devang Patel700a1cb2010-07-20 20:24:18 +0000196 }
Benjamin Kramerc6b468e2012-04-13 18:00:37 +0000197 StringRef Name = RD->getIdentifier()->getName();
David Blaikie4e4d0842012-03-11 07:00:24 +0000198 PrintingPolicy Policy(CGM.getLangOpts());
Benjamin Kramerc6b468e2012-04-13 18:00:37 +0000199 std::string TemplateArgList =
200 TemplateSpecializationType::PrintTemplateArgumentList(Args, NumArgs, Policy);
Devang Patel700a1cb2010-07-20 20:24:18 +0000201
202 // Copy this name on the side and use its reference.
Benjamin Kramerc6b468e2012-04-13 18:00:37 +0000203 size_t Length = Name.size() + TemplateArgList.size();
204 char *StrPtr = DebugInfoNames.Allocate<char>(Length);
205 memcpy(StrPtr, Name.data(), Name.size());
206 memcpy(StrPtr + Name.size(), TemplateArgList.data(), TemplateArgList.size());
207 return StringRef(StrPtr, Length);
Devang Patel700a1cb2010-07-20 20:24:18 +0000208}
209
Devang Patel17800552010-03-09 00:44:50 +0000210/// getOrCreateFile - Get the file debug info descriptor for the input location.
211llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Devang Patel823d8e92010-12-08 22:42:58 +0000212 if (!Loc.isValid())
213 // If Location is not valid then use main input file.
Devang Patel16674e82011-02-22 18:56:36 +0000214 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
Devang Patel823d8e92010-12-08 22:42:58 +0000215
Anders Carlsson20f12a22009-12-06 18:00:51 +0000216 SourceManager &SM = CGM.getContext().getSourceManager();
Devang Patel17800552010-03-09 00:44:50 +0000217 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
Ted Kremenek9c250392010-03-30 00:27:51 +0000218
Chris Lattner5f9e2722011-07-23 10:55:15 +0000219 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
Douglas Gregor8c457a82010-11-11 20:45:16 +0000220 // If the location is not valid then use main input file.
Devang Patel16674e82011-02-22 18:56:36 +0000221 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
Douglas Gregor8c457a82010-11-11 20:45:16 +0000222
Ted Kremenek9c250392010-03-30 00:27:51 +0000223 // Cache the results.
224 const char *fname = PLoc.getFilename();
225 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
226 DIFileCache.find(fname);
227
228 if (it != DIFileCache.end()) {
229 // Verify that the information still exists.
230 if (&*it->second)
231 return llvm::DIFile(cast<llvm::MDNode>(it->second));
232 }
233
Devang Patel16674e82011-02-22 18:56:36 +0000234 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
Ted Kremenek9c250392010-03-30 00:27:51 +0000235
Devang Patelab699792010-05-07 18:12:35 +0000236 DIFileCache[fname] = F;
Ted Kremenek9c250392010-03-30 00:27:51 +0000237 return F;
Devang Patel17800552010-03-09 00:44:50 +0000238}
Devang Patel8ab870d2010-05-12 23:46:38 +0000239
Devang Patel532105f2010-10-28 22:03:20 +0000240/// getOrCreateMainFile - Get the file info for main compile unit.
241llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
Devang Patel16674e82011-02-22 18:56:36 +0000242 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
Devang Patel532105f2010-10-28 22:03:20 +0000243}
244
Devang Patel8ab870d2010-05-12 23:46:38 +0000245/// getLineNumber - Get line number for the location. If location is invalid
246/// then use current location.
247unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
Devang Patel362ed2a2012-02-06 23:24:13 +0000248 if (Loc.isInvalid() && CurLoc.isInvalid())
249 return 0;
Devang Patel8ab870d2010-05-12 23:46:38 +0000250 SourceManager &SM = CGM.getContext().getSourceManager();
251 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Douglas Gregor8c457a82010-11-11 20:45:16 +0000252 return PLoc.isValid()? PLoc.getLine() : 0;
Devang Patel8ab870d2010-05-12 23:46:38 +0000253}
254
255/// getColumnNumber - Get column number for the location. If location is
256/// invalid then use current location.
257unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc) {
Devang Patel362ed2a2012-02-06 23:24:13 +0000258 if (Loc.isInvalid() && CurLoc.isInvalid())
259 return 0;
Devang Patel8ab870d2010-05-12 23:46:38 +0000260 SourceManager &SM = CGM.getContext().getSourceManager();
261 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Douglas Gregor8c457a82010-11-11 20:45:16 +0000262 return PLoc.isValid()? PLoc.getColumn() : 0;
Devang Patel8ab870d2010-05-12 23:46:38 +0000263}
264
Chris Lattner5f9e2722011-07-23 10:55:15 +0000265StringRef CGDebugInfo::getCurrentDirname() {
Nick Lewycky7c4fd912011-10-21 02:32:14 +0000266 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
267 return CGM.getCodeGenOpts().DebugCompilationDir;
268
Devang Patelac4d13c2010-07-27 15:17:16 +0000269 if (!CWDName.empty())
270 return CWDName;
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000271 SmallString<256> CWD;
Benjamin Kramerbcbca752011-10-14 18:45:11 +0000272 llvm::sys::fs::current_path(CWD);
273 char *CompDirnamePtr = DebugInfoNames.Allocate<char>(CWD.size());
274 memcpy(CompDirnamePtr, CWD.data(), CWD.size());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000275 return CWDName = StringRef(CompDirnamePtr, CWD.size());
Devang Patelac4d13c2010-07-27 15:17:16 +0000276}
277
Devang Patel17800552010-03-09 00:44:50 +0000278/// CreateCompileUnit - Create new compile unit.
279void CGDebugInfo::CreateCompileUnit() {
280
281 // Get absolute path name.
Douglas Gregorac91b4c2010-03-18 23:46:43 +0000282 SourceManager &SM = CGM.getContext().getSourceManager();
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000283 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
284 if (MainFileName.empty())
Devang Patel22fe5852010-03-12 21:04:27 +0000285 MainFileName = "<unknown>";
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000286
Douglas Gregorf6728fc2010-03-22 21:28:29 +0000287 // The main file name provided via the "-main-file-name" option contains just
288 // the file name itself with no path information. This file name may have had
289 // a relative path, so we look into the actual file entry for the main
290 // file to determine the real absolute path for the file.
Devang Patel6e6bc392010-07-23 23:04:28 +0000291 std::string MainFileDir;
Devang Patelac4d13c2010-07-27 15:17:16 +0000292 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000293 MainFileDir = MainFile->getDir()->getName();
Devang Patelac4d13c2010-07-27 15:17:16 +0000294 if (MainFileDir != ".")
295 MainFileName = MainFileDir + "/" + MainFileName;
296 }
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000297
Devang Patelac4d13c2010-07-27 15:17:16 +0000298 // Save filename string.
299 char *FilenamePtr = DebugInfoNames.Allocate<char>(MainFileName.length());
300 memcpy(FilenamePtr, MainFileName.c_str(), MainFileName.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000301 StringRef Filename(FilenamePtr, MainFileName.length());
Devang Patelac4d13c2010-07-27 15:17:16 +0000302
Chris Lattner515455a2009-03-25 03:28:08 +0000303 unsigned LangTag;
David Blaikie4e4d0842012-03-11 07:00:24 +0000304 const LangOptions &LO = CGM.getLangOpts();
Chris Lattner515455a2009-03-25 03:28:08 +0000305 if (LO.CPlusPlus) {
306 if (LO.ObjC1)
307 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
308 else
309 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
310 } else if (LO.ObjC1) {
Devang Patel8d9aefc2009-03-24 20:35:51 +0000311 LangTag = llvm::dwarf::DW_LANG_ObjC;
Chris Lattner515455a2009-03-25 03:28:08 +0000312 } else if (LO.C99) {
Devang Patel8d9aefc2009-03-24 20:35:51 +0000313 LangTag = llvm::dwarf::DW_LANG_C99;
Chris Lattner515455a2009-03-25 03:28:08 +0000314 } else {
315 LangTag = llvm::dwarf::DW_LANG_C89;
316 }
Devang Patel446c6192009-04-17 21:06:59 +0000317
Daniel Dunbar19f19832010-08-24 17:41:09 +0000318 std::string Producer = getClangFullVersion();
Chris Lattner4c2577a2009-05-02 01:00:04 +0000319
320 // Figure out which version of the ObjC runtime we have.
321 unsigned RuntimeVers = 0;
322 if (LO.ObjC1)
John McCall260611a2012-06-20 06:18:46 +0000323 RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
Mike Stump1eb44332009-09-09 15:08:12 +0000324
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000325 // Create new compile unit.
Devang Patel16674e82011-02-22 18:56:36 +0000326 DBuilder.createCompileUnit(
Devang Patel58115002010-07-27 20:49:59 +0000327 LangTag, Filename, getCurrentDirname(),
Devang Patel823d8e92010-12-08 22:42:58 +0000328 Producer,
Daniel Dunbarf2d8b9f2009-12-18 02:43:17 +0000329 LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers);
Devang Patel823d8e92010-12-08 22:42:58 +0000330 // FIXME - Eliminate TheCU.
331 TheCU = llvm::DICompileUnit(DBuilder.getCU());
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000332}
333
Devang Patel65e99f22009-02-25 01:36:11 +0000334/// CreateType - Get the Basic type from the cache or create a new
Chris Lattner9c85ba32008-11-10 06:08:34 +0000335/// one if necessary.
Devang Patelf1d1d9a2010-11-01 16:52:40 +0000336llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000337 unsigned Encoding = 0;
Argyrios Kyrtzidis27a00972012-05-05 04:20:28 +0000338 StringRef BTName;
Chris Lattner9c85ba32008-11-10 06:08:34 +0000339 switch (BT->getKind()) {
John McCalle0a22d02011-10-18 21:02:43 +0000340#define BUILTIN_TYPE(Id, SingletonId)
341#define PLACEHOLDER_TYPE(Id, SingletonId) \
342 case BuiltinType::Id:
343#include "clang/AST/BuiltinTypes.def"
Devang Patele7566cf2011-09-12 18:50:21 +0000344 case BuiltinType::Dependent:
John McCalle0a22d02011-10-18 21:02:43 +0000345 llvm_unreachable("Unexpected builtin type");
Devang Patele7566cf2011-09-12 18:50:21 +0000346 case BuiltinType::NullPtr:
Devang Patelf60dca32011-09-14 23:14:14 +0000347 return DBuilder.
David Blaikie4e4d0842012-03-11 07:00:24 +0000348 createNullPtrType(BT->getName(CGM.getContext().getLangOpts()));
Chris Lattner9c85ba32008-11-10 06:08:34 +0000349 case BuiltinType::Void:
350 return llvm::DIType();
Devang Patelc8972c62010-07-28 01:33:15 +0000351 case BuiltinType::ObjCClass:
Eric Christopher917bc8d2012-02-20 18:05:04 +0000352 return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopher87380aa2012-04-23 19:00:24 +0000353 "objc_class", TheCU,
354 getOrCreateMainFile(), 0);
Devang Patelc8972c62010-07-28 01:33:15 +0000355 case BuiltinType::ObjCId: {
356 // typedef struct objc_class *Class;
357 // typedef struct objc_object {
358 // Class isa;
359 // } *id;
360
Eric Christopherb45cfea2012-02-23 00:43:12 +0000361 // TODO: Cache these two types to avoid duplicates.
Eric Christopher917bc8d2012-02-20 18:05:04 +0000362 llvm::DIType OCTy =
363 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopher87380aa2012-04-23 19:00:24 +0000364 "objc_class", TheCU, getOrCreateMainFile(), 0);
Devang Patelc8972c62010-07-28 01:33:15 +0000365 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
366
Devang Patel16674e82011-02-22 18:56:36 +0000367 llvm::DIType ISATy = DBuilder.createPointerType(OCTy, Size);
Devang Patelc8972c62010-07-28 01:33:15 +0000368
Chris Lattner5f9e2722011-07-23 10:55:15 +0000369 SmallVector<llvm::Value *, 16> EltTys;
Devang Patelc8972c62010-07-28 01:33:15 +0000370 llvm::DIType FieldTy =
Devang Patel1d323e02011-06-24 22:00:59 +0000371 DBuilder.createMemberType(getOrCreateMainFile(), "isa",
372 getOrCreateMainFile(), 0, Size,
373 0, 0, 0, ISATy);
Devang Patelc8972c62010-07-28 01:33:15 +0000374 EltTys.push_back(FieldTy);
Jay Foadc556ef22011-04-24 10:11:03 +0000375 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Devang Patelc8972c62010-07-28 01:33:15 +0000376
Devang Patel16674e82011-02-22 18:56:36 +0000377 return DBuilder.createStructType(TheCU, "objc_object",
Devang Patel823d8e92010-12-08 22:42:58 +0000378 getOrCreateMainFile(),
379 0, 0, 0, 0, Elements);
Devang Patelc8972c62010-07-28 01:33:15 +0000380 }
Devang Patel6e108ce2011-02-09 03:15:05 +0000381 case BuiltinType::ObjCSel: {
Eric Christopher917bc8d2012-02-20 18:05:04 +0000382 return
383 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopher87380aa2012-04-23 19:00:24 +0000384 "objc_selector", TheCU, getOrCreateMainFile(),
Eric Christophere86b9ea2012-02-20 23:02:36 +0000385 0);
Devang Patel6e108ce2011-02-09 03:15:05 +0000386 }
Chris Lattner9c85ba32008-11-10 06:08:34 +0000387 case BuiltinType::UChar:
388 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
389 case BuiltinType::Char_S:
390 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
Devang Patele8ee3f22011-09-12 17:11:58 +0000391 case BuiltinType::Char16:
392 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
Chris Lattner9c85ba32008-11-10 06:08:34 +0000393 case BuiltinType::UShort:
394 case BuiltinType::UInt:
Devang Patel31c79b42011-05-05 17:06:30 +0000395 case BuiltinType::UInt128:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000396 case BuiltinType::ULong:
Devang Patel68f76b12011-09-10 00:44:49 +0000397 case BuiltinType::WChar_U:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000398 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
399 case BuiltinType::Short:
400 case BuiltinType::Int:
Devang Patel31c79b42011-05-05 17:06:30 +0000401 case BuiltinType::Int128:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000402 case BuiltinType::Long:
Devang Patel68f76b12011-09-10 00:44:49 +0000403 case BuiltinType::WChar_S:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000404 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
405 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
Anton Korobeynikovaa4a99b2011-10-14 23:23:15 +0000406 case BuiltinType::Half:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000407 case BuiltinType::Float:
Devang Patel7c173cb2009-10-12 22:28:31 +0000408 case BuiltinType::LongDouble:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000409 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
Mike Stump1eb44332009-09-09 15:08:12 +0000410 }
Devang Patel05127ca2010-07-28 23:23:29 +0000411
412 switch (BT->getKind()) {
413 case BuiltinType::Long: BTName = "long int"; break;
414 case BuiltinType::LongLong: BTName = "long long int"; break;
415 case BuiltinType::ULong: BTName = "long unsigned int"; break;
416 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
417 default:
David Blaikie4e4d0842012-03-11 07:00:24 +0000418 BTName = BT->getName(CGM.getContext().getLangOpts());
Devang Patel05127ca2010-07-28 23:23:29 +0000419 break;
420 }
Chris Lattner9c85ba32008-11-10 06:08:34 +0000421 // Bit size, align and offset of the type.
Anders Carlsson20f12a22009-12-06 18:00:51 +0000422 uint64_t Size = CGM.getContext().getTypeSize(BT);
423 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Devang Patelca80a5f2009-10-20 19:55:01 +0000424 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +0000425 DBuilder.createBasicType(BTName, Size, Align, Encoding);
Devang Patelca80a5f2009-10-20 19:55:01 +0000426 return DbgTy;
Chris Lattner9c85ba32008-11-10 06:08:34 +0000427}
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000428
Devang Patel344ff5d2010-12-09 00:25:29 +0000429llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
Chris Lattnerb7003772009-04-23 06:13:01 +0000430 // Bit size, align and offset of the type.
431 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
432 if (Ty->isComplexIntegerType())
433 Encoding = llvm::dwarf::DW_ATE_lo_user;
Mike Stump1eb44332009-09-09 15:08:12 +0000434
Anders Carlsson20f12a22009-12-06 18:00:51 +0000435 uint64_t Size = CGM.getContext().getTypeSize(Ty);
436 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Devang Patelca80a5f2009-10-20 19:55:01 +0000437 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +0000438 DBuilder.createBasicType("complex", Size, Align, Encoding);
Devang Patel823d8e92010-12-08 22:42:58 +0000439
Devang Patelca80a5f2009-10-20 19:55:01 +0000440 return DbgTy;
Chris Lattnerb7003772009-04-23 06:13:01 +0000441}
442
John McCalla1805292009-09-25 01:40:47 +0000443/// CreateCVRType - Get the qualified type from the cache or create
Sanjiv Guptaf58c27a2008-06-07 04:46:53 +0000444/// a new one if necessary.
Devang Patel17800552010-03-09 00:44:50 +0000445llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
John McCalla1805292009-09-25 01:40:47 +0000446 QualifierCollector Qc;
447 const Type *T = Qc.strip(Ty);
448
449 // Ignore these qualifiers for now.
450 Qc.removeObjCGCAttr();
451 Qc.removeAddressSpace();
John McCallf85e1932011-06-15 23:02:42 +0000452 Qc.removeObjCLifetime();
John McCalla1805292009-09-25 01:40:47 +0000453
Chris Lattner9c85ba32008-11-10 06:08:34 +0000454 // We will create one Derived type for one qualifier and recurse to handle any
455 // additional ones.
Chris Lattner9c85ba32008-11-10 06:08:34 +0000456 unsigned Tag;
John McCalla1805292009-09-25 01:40:47 +0000457 if (Qc.hasConst()) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000458 Tag = llvm::dwarf::DW_TAG_const_type;
John McCalla1805292009-09-25 01:40:47 +0000459 Qc.removeConst();
460 } else if (Qc.hasVolatile()) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000461 Tag = llvm::dwarf::DW_TAG_volatile_type;
John McCalla1805292009-09-25 01:40:47 +0000462 Qc.removeVolatile();
463 } else if (Qc.hasRestrict()) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000464 Tag = llvm::dwarf::DW_TAG_restrict_type;
John McCalla1805292009-09-25 01:40:47 +0000465 Qc.removeRestrict();
466 } else {
467 assert(Qc.empty() && "Unknown type qualifier for debug info");
468 return getOrCreateType(QualType(T, 0), Unit);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000469 }
Mike Stump1eb44332009-09-09 15:08:12 +0000470
John McCall49f4e1c2010-12-10 11:01:00 +0000471 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
John McCalla1805292009-09-25 01:40:47 +0000472
Daniel Dunbar3845f862008-10-31 03:54:29 +0000473 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
474 // CVR derived types.
Devang Patel16674e82011-02-22 18:56:36 +0000475 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Devang Patel823d8e92010-12-08 22:42:58 +0000476
Devang Patelca80a5f2009-10-20 19:55:01 +0000477 return DbgTy;
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000478}
479
Daniel Dunbar9df4bb32009-07-14 01:20:56 +0000480llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000481 llvm::DIFile Unit) {
Devang Patelca80a5f2009-10-20 19:55:01 +0000482 llvm::DIType DbgTy =
Anders Carlssona031b352009-11-06 19:19:55 +0000483 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
484 Ty->getPointeeType(), Unit);
Devang Patelca80a5f2009-10-20 19:55:01 +0000485 return DbgTy;
Daniel Dunbar9df4bb32009-07-14 01:20:56 +0000486}
487
Chris Lattner9c85ba32008-11-10 06:08:34 +0000488llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000489 llvm::DIFile Unit) {
Anders Carlssona031b352009-11-06 19:19:55 +0000490 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
491 Ty->getPointeeType(), Unit);
492}
493
Eric Christopher5d613b52012-01-25 02:06:59 +0000494// Creates a forward declaration for a RecordDecl in the given context.
495llvm::DIType CGDebugInfo::createRecordFwdDecl(const RecordDecl *RD,
Devang Patel53bc5182012-02-08 00:10:20 +0000496 llvm::DIDescriptor Ctx) {
Eric Christopher5d613b52012-01-25 02:06:59 +0000497 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
498 unsigned Line = getLineNumber(RD->getLocation());
Eric Christophere88a71f2012-02-13 15:08:45 +0000499 StringRef RDName = RD->getName();
500
501 // Get the tag.
Eric Christopher5d613b52012-01-25 02:06:59 +0000502 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Eric Christophere88a71f2012-02-13 15:08:45 +0000503 unsigned Tag = 0;
504 if (CXXDecl) {
505 RDName = getClassName(RD);
506 Tag = llvm::dwarf::DW_TAG_class_type;
507 }
Eric Christopher5d613b52012-01-25 02:06:59 +0000508 else if (RD->isStruct())
Eric Christophere88a71f2012-02-13 15:08:45 +0000509 Tag = llvm::dwarf::DW_TAG_structure_type;
Eric Christopher5d613b52012-01-25 02:06:59 +0000510 else if (RD->isUnion())
Eric Christophere88a71f2012-02-13 15:08:45 +0000511 Tag = llvm::dwarf::DW_TAG_union_type;
Eric Christopher5d613b52012-01-25 02:06:59 +0000512 else
513 llvm_unreachable("Unknown RecordDecl type!");
Eric Christophere88a71f2012-02-13 15:08:45 +0000514
515 // Create the type.
Eric Christopher87380aa2012-04-23 19:00:24 +0000516 return DBuilder.createForwardDecl(Tag, RDName, Ctx, DefUnit, Line);
Eric Christopher5d613b52012-01-25 02:06:59 +0000517}
518
Eric Christopher4ddca8a2012-01-20 22:10:15 +0000519// Walk up the context chain and create forward decls for record decls,
520// and normal descriptors for namespaces.
521llvm::DIDescriptor CGDebugInfo::createContextChain(const Decl *Context) {
522 if (!Context)
523 return TheCU;
524
525 // See if we already have the parent.
526 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
527 I = RegionMap.find(Context);
528 if (I != RegionMap.end())
529 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(&*I->second));
530
531 // Check namespace.
532 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
533 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
534
535 if (const RecordDecl *RD = dyn_cast<RecordDecl>(Context)) {
536 if (!RD->isDependentType()) {
Eric Christopher9965dea2012-02-16 22:54:45 +0000537 llvm::DIType Ty = getOrCreateLimitedType(CGM.getContext().getTypeDeclType(RD),
538 getOrCreateMainFile());
Eric Christopher4ddca8a2012-01-20 22:10:15 +0000539 return llvm::DIDescriptor(Ty);
540 }
541 }
542 return TheCU;
543}
544
Eric Christopheredc95922011-09-13 23:45:09 +0000545/// CreatePointeeType - Create Pointee type. If Pointee is a record
Devang Patelc69e1cf2010-09-30 19:05:55 +0000546/// then emit record's fwd if debug info size reduction is enabled.
547llvm::DIType CGDebugInfo::CreatePointeeType(QualType PointeeTy,
548 llvm::DIFile Unit) {
Alexey Samsonov3a70cd62012-04-27 07:24:20 +0000549 if (CGM.getCodeGenOpts().DebugInfo != CodeGenOptions::LimitedDebugInfo)
Devang Patelc69e1cf2010-09-30 19:05:55 +0000550 return getOrCreateType(PointeeTy, Unit);
Devang Patel41422512011-10-24 23:15:17 +0000551
552 // Limit debug info for the pointee type.
553
Eric Christopher973bbb62011-12-16 23:40:18 +0000554 // If we have an existing type, use that, it's still smaller than creating
555 // a new type.
556 llvm::DIType Ty = getTypeOrNull(PointeeTy);
557 if (Ty.Verify()) return Ty;
558
Devang Patel41422512011-10-24 23:15:17 +0000559 // Handle qualifiers.
560 if (PointeeTy.hasLocalQualifiers())
Eric Christopher363e5ac2012-08-07 00:14:25 +0000561 return CreateQualifiedType(PointeeTy.getCanonicalType(), Unit);
Devang Patel41422512011-10-24 23:15:17 +0000562
Devang Patelc69e1cf2010-09-30 19:05:55 +0000563 if (const RecordType *RTy = dyn_cast<RecordType>(PointeeTy)) {
564 RecordDecl *RD = RTy->getDecl();
Devang Patelc69e1cf2010-09-30 19:05:55 +0000565 llvm::DIDescriptor FDContext =
John McCall8178df32011-02-22 22:38:33 +0000566 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Eric Christopher86211df2012-02-20 18:05:24 +0000567 llvm::DIType RetTy = createRecordFwdDecl(RD, FDContext);
568 TypeCache[QualType(RTy, 0).getAsOpaquePtr()] = RetTy;
569 return RetTy;
Devang Patelc69e1cf2010-09-30 19:05:55 +0000570 }
571 return getOrCreateType(PointeeTy, Unit);
Eric Christopher42e75da2012-02-13 14:56:11 +0000572
Devang Patelc69e1cf2010-09-30 19:05:55 +0000573}
574
Anders Carlssona031b352009-11-06 19:19:55 +0000575llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
576 const Type *Ty,
577 QualType PointeeTy,
Devang Patel17800552010-03-09 00:44:50 +0000578 llvm::DIFile Unit) {
Eric Christopher37e4cea2012-05-19 01:36:50 +0000579 if (Tag == llvm::dwarf::DW_TAG_reference_type ||
580 Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
581 return DBuilder.createReferenceType(Tag,
582 CreatePointeeType(PointeeTy, Unit));
Devang Patel823d8e92010-12-08 22:42:58 +0000583
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000584 // Bit size, align and offset of the type.
Anders Carlssona031b352009-11-06 19:19:55 +0000585 // Size is always the size of a pointer. We can't use getTypeSize here
586 // because that does not return the correct value for references.
Peter Collingbourne207f4d82011-03-18 22:38:29 +0000587 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000588 uint64_t Size = CGM.getContext().getTargetInfo().getPointerWidth(AS);
Anders Carlsson20f12a22009-12-06 18:00:51 +0000589 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Mike Stump1eb44332009-09-09 15:08:12 +0000590
Nick Lewycky7480d962011-11-10 00:34:02 +0000591 return DBuilder.createPointerType(CreatePointeeType(PointeeTy, Unit),
592 Size, Align);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000593}
594
Mike Stump9bc093c2009-05-14 02:03:51 +0000595llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000596 llvm::DIFile Unit) {
Mike Stump9bc093c2009-05-14 02:03:51 +0000597 if (BlockLiteralGenericSet)
598 return BlockLiteralGeneric;
599
Chris Lattner5f9e2722011-07-23 10:55:15 +0000600 SmallVector<llvm::Value *, 8> EltTys;
Mike Stump9bc093c2009-05-14 02:03:51 +0000601 llvm::DIType FieldTy;
Mike Stump9bc093c2009-05-14 02:03:51 +0000602 QualType FType;
603 uint64_t FieldSize, FieldOffset;
604 unsigned FieldAlign;
Mike Stump9bc093c2009-05-14 02:03:51 +0000605 llvm::DIArray Elements;
606 llvm::DIType EltTy, DescTy;
607
608 FieldOffset = 0;
Anders Carlsson20f12a22009-12-06 18:00:51 +0000609 FType = CGM.getContext().UnsignedLongTy;
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000610 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
611 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
Mike Stump9bc093c2009-05-14 02:03:51 +0000612
Jay Foadc556ef22011-04-24 10:11:03 +0000613 Elements = DBuilder.getOrCreateArray(EltTys);
Mike Stump9bc093c2009-05-14 02:03:51 +0000614 EltTys.clear();
615
Devang Patele2472482010-09-29 21:05:52 +0000616 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
Devang Patel8ab870d2010-05-12 23:46:38 +0000617 unsigned LineNo = getLineNumber(CurLoc);
Mike Stump3d363c52009-10-02 02:30:50 +0000618
Devang Patel16674e82011-02-22 18:56:36 +0000619 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
Devang Patel823d8e92010-12-08 22:42:58 +0000620 Unit, LineNo, FieldOffset, 0,
621 Flags, Elements);
Mike Stump1eb44332009-09-09 15:08:12 +0000622
Mike Stump9bc093c2009-05-14 02:03:51 +0000623 // Bit size, align and offset of the type.
Anders Carlsson20f12a22009-12-06 18:00:51 +0000624 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Mike Stump1eb44332009-09-09 15:08:12 +0000625
Devang Patel16674e82011-02-22 18:56:36 +0000626 DescTy = DBuilder.createPointerType(EltTy, Size);
Mike Stump9bc093c2009-05-14 02:03:51 +0000627
628 FieldOffset = 0;
Anders Carlsson20f12a22009-12-06 18:00:51 +0000629 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000630 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
Anders Carlsson20f12a22009-12-06 18:00:51 +0000631 FType = CGM.getContext().IntTy;
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000632 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
633 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Benjamin Kramerd3651cc2010-04-24 20:26:20 +0000634 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000635 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
Mike Stump9bc093c2009-05-14 02:03:51 +0000636
Anders Carlsson20f12a22009-12-06 18:00:51 +0000637 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Mike Stump9bc093c2009-05-14 02:03:51 +0000638 FieldTy = DescTy;
Anders Carlsson20f12a22009-12-06 18:00:51 +0000639 FieldSize = CGM.getContext().getTypeSize(Ty);
640 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Devang Patel1d323e02011-06-24 22:00:59 +0000641 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
Devang Patel823d8e92010-12-08 22:42:58 +0000642 LineNo, FieldSize, FieldAlign,
643 FieldOffset, 0, FieldTy);
Mike Stump9bc093c2009-05-14 02:03:51 +0000644 EltTys.push_back(FieldTy);
645
646 FieldOffset += FieldSize;
Jay Foadc556ef22011-04-24 10:11:03 +0000647 Elements = DBuilder.getOrCreateArray(EltTys);
Mike Stump9bc093c2009-05-14 02:03:51 +0000648
Devang Patel16674e82011-02-22 18:56:36 +0000649 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
Devang Patel823d8e92010-12-08 22:42:58 +0000650 Unit, LineNo, FieldOffset, 0,
651 Flags, Elements);
Mike Stump1eb44332009-09-09 15:08:12 +0000652
Mike Stump9bc093c2009-05-14 02:03:51 +0000653 BlockLiteralGenericSet = true;
Devang Patel16674e82011-02-22 18:56:36 +0000654 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
Mike Stump9bc093c2009-05-14 02:03:51 +0000655 return BlockLiteralGeneric;
656}
657
Nick Lewycky7480d962011-11-10 00:34:02 +0000658llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000659 // Typedefs are derived from some other type. If we have a typedef of a
660 // typedef, make sure to emit the whole chain.
661 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Devang Patel823d8e92010-12-08 22:42:58 +0000662 if (!Src.Verify())
663 return llvm::DIType();
Chris Lattner9c85ba32008-11-10 06:08:34 +0000664 // We don't set size information, but do specify where the typedef was
665 // declared.
Devang Patel8ab870d2010-05-12 23:46:38 +0000666 unsigned Line = getLineNumber(Ty->getDecl()->getLocation());
Devang Patelc4903122011-06-03 17:23:47 +0000667 const TypedefNameDecl *TyDecl = Ty->getDecl();
Eric Christopher9965dea2012-02-16 22:54:45 +0000668
Nick Lewycky7480d962011-11-10 00:34:02 +0000669 llvm::DIDescriptor TypedefContext =
Devang Patelc4903122011-06-03 17:23:47 +0000670 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
Eric Christopher9965dea2012-02-16 22:54:45 +0000671
672 return
Nick Lewycky7480d962011-11-10 00:34:02 +0000673 DBuilder.createTypedef(Src, TyDecl->getName(), Unit, Line, TypedefContext);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000674}
675
Chris Lattner9c85ba32008-11-10 06:08:34 +0000676llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000677 llvm::DIFile Unit) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000678 SmallVector<llvm::Value *, 16> EltTys;
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000679
Chris Lattner9c85ba32008-11-10 06:08:34 +0000680 // Add the result type at least.
681 EltTys.push_back(getOrCreateType(Ty->getResultType(), Unit));
Mike Stump1eb44332009-09-09 15:08:12 +0000682
Chris Lattner9c85ba32008-11-10 06:08:34 +0000683 // Set up remainder of arguments if there is a prototype.
684 // FIXME: IF NOT, HOW IS THIS REPRESENTED? llvm-gcc doesn't represent '...'!
Devang Patelaf164bb2010-10-06 20:51:45 +0000685 if (isa<FunctionNoProtoType>(Ty))
Devang Patel16674e82011-02-22 18:56:36 +0000686 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Eric Christopheraa6eccc2012-08-04 00:11:22 +0000687 else if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
Eric Christopher363e5ac2012-08-07 00:14:25 +0000688 for (unsigned i = 0, e = FPT->getNumArgs(); i != e; ++i) {
Eric Christopheraa6eccc2012-08-04 00:11:22 +0000689 EltTys.push_back(getOrCreateType(FPT->getArgType(i), Unit));
Eric Christopher363e5ac2012-08-07 00:14:25 +0000690 }
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000691 }
692
Jay Foadc556ef22011-04-24 10:11:03 +0000693 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
Eric Christopherd9f07d42012-05-16 22:02:36 +0000694 return DBuilder.createSubroutineType(Unit, EltTypeArray);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000695}
696
Eric Christopher42e75da2012-02-13 14:56:11 +0000697
Eric Christopher6faa5542012-01-26 01:57:13 +0000698void CGDebugInfo::
699CollectRecordStaticVars(const RecordDecl *RD, llvm::DIType FwdDecl) {
700
701 for (RecordDecl::decl_iterator I = RD->decls_begin(), E = RD->decls_end();
702 I != E; ++I)
703 if (const VarDecl *V = dyn_cast<VarDecl>(*I)) {
704 if (V->getInit()) {
705 const APValue *Value = V->evaluateValue();
706 if (Value && Value->isInt()) {
707 llvm::ConstantInt *CI
708 = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
709
710 // Create the descriptor for static variable.
711 llvm::DIFile VUnit = getOrCreateFile(V->getLocation());
712 StringRef VName = V->getName();
713 llvm::DIType VTy = getOrCreateType(V->getType(), VUnit);
714 // Do not use DIGlobalVariable for enums.
715 if (VTy.getTag() != llvm::dwarf::DW_TAG_enumeration_type) {
716 DBuilder.createStaticVariable(FwdDecl, VName, VName, VUnit,
717 getLineNumber(V->getLocation()),
718 VTy, true, CI);
719 }
720 }
721 }
722 }
723}
724
Chris Lattner5f9e2722011-07-23 10:55:15 +0000725llvm::DIType CGDebugInfo::createFieldType(StringRef name,
John McCall8178df32011-02-22 22:38:33 +0000726 QualType type,
Richard Smitha6b8b2c2011-10-10 18:28:20 +0000727 uint64_t sizeInBitsOverride,
John McCall8178df32011-02-22 22:38:33 +0000728 SourceLocation loc,
729 AccessSpecifier AS,
730 uint64_t offsetInBits,
Devang Patel1d323e02011-06-24 22:00:59 +0000731 llvm::DIFile tunit,
732 llvm::DIDescriptor scope) {
John McCall8178df32011-02-22 22:38:33 +0000733 llvm::DIType debugType = getOrCreateType(type, tunit);
734
735 // Get the location for the field.
736 llvm::DIFile file = getOrCreateFile(loc);
737 unsigned line = getLineNumber(loc);
738
739 uint64_t sizeInBits = 0;
740 unsigned alignInBits = 0;
741 if (!type->isIncompleteArrayType()) {
742 llvm::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
743
Richard Smitha6b8b2c2011-10-10 18:28:20 +0000744 if (sizeInBitsOverride)
745 sizeInBits = sizeInBitsOverride;
John McCall8178df32011-02-22 22:38:33 +0000746 }
747
748 unsigned flags = 0;
749 if (AS == clang::AS_private)
750 flags |= llvm::DIDescriptor::FlagPrivate;
751 else if (AS == clang::AS_protected)
752 flags |= llvm::DIDescriptor::FlagProtected;
753
Devang Patel1d323e02011-06-24 22:00:59 +0000754 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
755 alignInBits, offsetInBits, flags, debugType);
John McCall8178df32011-02-22 22:38:33 +0000756}
757
Devang Patel428deb52010-01-19 00:00:59 +0000758/// CollectRecordFields - A helper function to collect debug info for
759/// record fields. This is used while creating debug info entry for a Record.
760void CGDebugInfo::
John McCall8178df32011-02-22 22:38:33 +0000761CollectRecordFields(const RecordDecl *record, llvm::DIFile tunit,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000762 SmallVectorImpl<llvm::Value *> &elements,
Devang Patel1d323e02011-06-24 22:00:59 +0000763 llvm::DIType RecordTy) {
John McCall8178df32011-02-22 22:38:33 +0000764 unsigned fieldNo = 0;
765 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
Eric Christopherad8de512012-03-01 21:36:52 +0000766 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(record);
767
Eric Christopherda970d22012-06-28 01:20:05 +0000768 // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
Eric Christopherad8de512012-03-01 21:36:52 +0000769 // has the name and the location of the variable so we should iterate over
770 // both concurrently.
771 if (CXXDecl && CXXDecl->isLambda()) {
772 RecordDecl::field_iterator Field = CXXDecl->field_begin();
773 unsigned fieldno = 0;
774 for (CXXRecordDecl::capture_const_iterator I = CXXDecl->captures_begin(),
775 E = CXXDecl->captures_end(); I != E; ++I, ++Field, ++fieldno) {
776 const LambdaExpr::Capture C = *I;
777 // TODO: Need to handle 'this' in some way by probably renaming the
778 // this of the lambda class and having a field member of 'this'.
779 if (C.capturesVariable()) {
780 VarDecl *V = C.getCapturedVar();
781 llvm::DIFile VUnit = getOrCreateFile(C.getLocation());
782 StringRef VName = V->getName();
783 uint64_t SizeInBitsOverride = 0;
784 if (Field->isBitField()) {
785 SizeInBitsOverride = Field->getBitWidthValue(CGM.getContext());
786 assert(SizeInBitsOverride && "found named 0-width bitfield");
787 }
788 llvm::DIType fieldType
789 = createFieldType(VName, Field->getType(), SizeInBitsOverride, C.getLocation(),
790 Field->getAccess(), layout.getFieldOffset(fieldno),
791 VUnit, RecordTy);
792 elements.push_back(fieldType);
793 }
794 }
795 } else {
796 bool IsMsStruct = record->hasAttr<MsStructAttr>();
797 const FieldDecl *LastFD = 0;
798 for (RecordDecl::field_iterator I = record->field_begin(),
799 E = record->field_end();
800 I != E; ++I, ++fieldNo) {
David Blaikie581deb32012-06-06 20:45:41 +0000801 FieldDecl *field = *I;
Eric Christopherad8de512012-03-01 21:36:52 +0000802
803 if (IsMsStruct) {
804 // Zero-length bitfields following non-bitfield members are ignored
805 if (CGM.getContext().ZeroBitfieldFollowsNonBitfield((field), LastFD)) {
806 --fieldNo;
807 continue;
808 }
809 LastFD = field;
810 }
811
812 StringRef name = field->getName();
813 QualType type = field->getType();
814
815 // Ignore unnamed fields unless they're anonymous structs/unions.
816 if (name.empty() && !type->isRecordType()) {
817 LastFD = field;
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000818 continue;
819 }
Eric Christopherad8de512012-03-01 21:36:52 +0000820
821 uint64_t SizeInBitsOverride = 0;
822 if (field->isBitField()) {
823 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
824 assert(SizeInBitsOverride && "found named 0-width bitfield");
825 }
826
827 llvm::DIType fieldType
828 = createFieldType(name, type, SizeInBitsOverride,
829 field->getLocation(), field->getAccess(),
830 layout.getFieldOffset(fieldNo), tunit, RecordTy);
831
832 elements.push_back(fieldType);
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000833 }
Devang Patel428deb52010-01-19 00:00:59 +0000834 }
835}
836
Devang Patela6da1922010-01-28 00:28:01 +0000837/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
838/// function type is not updated to include implicit "this" pointer. Use this
839/// routine to get a method type which includes "this" pointer.
840llvm::DIType
841CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Devang Patel17800552010-03-09 00:44:50 +0000842 llvm::DIFile Unit) {
Douglas Gregor5f970ee2010-05-04 18:18:31 +0000843 llvm::DIType FnTy
844 = getOrCreateType(QualType(Method->getType()->getAs<FunctionProtoType>(),
845 0),
846 Unit);
Eric Christopher3b10cfe2012-03-13 23:40:48 +0000847
Devang Patela6da1922010-01-28 00:28:01 +0000848 // Add "this" pointer.
Devang Patelab699792010-05-07 18:12:35 +0000849 llvm::DIArray Args = llvm::DICompositeType(FnTy).getTypeArray();
Devang Patela6da1922010-01-28 00:28:01 +0000850 assert (Args.getNumElements() && "Invalid number of arguments!");
851
Chris Lattner5f9e2722011-07-23 10:55:15 +0000852 SmallVector<llvm::Value *, 16> Elts;
Devang Patela6da1922010-01-28 00:28:01 +0000853
854 // First element is always return type. For 'void' functions it is NULL.
855 Elts.push_back(Args.getElement(0));
856
Eric Christopher2121cda2011-09-14 01:10:50 +0000857 if (!Method->isStatic()) {
858 // "this" pointer is always first argument.
859 QualType ThisPtr = Method->getThisType(CGM.getContext());
Devang Patelef8857d2011-10-28 21:12:13 +0000860
861 const CXXRecordDecl *RD = Method->getParent();
862 if (isa<ClassTemplateSpecializationDecl>(RD)) {
863 // Create pointer type directly in this case.
864 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
865 QualType PointeeTy = ThisPtrTy->getPointeeType();
866 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
867 uint64_t Size = CGM.getContext().getTargetInfo().getPointerWidth(AS);
868 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +0000869 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Eric Christopher3b8e1972012-02-09 07:26:21 +0000870 llvm::DIType ThisPtrType = DBuilder.createPointerType(PointeeType, Size, Align);
Devang Patelef8857d2011-10-28 21:12:13 +0000871 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
Eric Christopher3b8e1972012-02-09 07:26:21 +0000872 // TODO: This and the artificial type below are misleading, the
873 // types aren't artificial the argument is, but the current
874 // metadata doesn't represent that.
875 ThisPtrType = DBuilder.createArtificialType(ThisPtrType);
Devang Patelef8857d2011-10-28 21:12:13 +0000876 Elts.push_back(ThisPtrType);
877 } else {
Eric Christopher3b8e1972012-02-09 07:26:21 +0000878 llvm::DIType ThisPtrType = getOrCreateType(ThisPtr, Unit);
Devang Patelef8857d2011-10-28 21:12:13 +0000879 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
Eric Christopher3b8e1972012-02-09 07:26:21 +0000880 ThisPtrType = DBuilder.createArtificialType(ThisPtrType);
Devang Patelef8857d2011-10-28 21:12:13 +0000881 Elts.push_back(ThisPtrType);
882 }
Eric Christopher2121cda2011-09-14 01:10:50 +0000883 }
Devang Patela6da1922010-01-28 00:28:01 +0000884
885 // Copy rest of the arguments.
886 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
887 Elts.push_back(Args.getElement(i));
888
Jay Foadc556ef22011-04-24 10:11:03 +0000889 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
Devang Patela6da1922010-01-28 00:28:01 +0000890
Devang Patel16674e82011-02-22 18:56:36 +0000891 return DBuilder.createSubroutineType(Unit, EltTypeArray);
Devang Patela6da1922010-01-28 00:28:01 +0000892}
893
Devang Patel58faf202010-10-22 17:11:50 +0000894/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
895/// inside a function.
896static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
Nick Lewycky7480d962011-11-10 00:34:02 +0000897 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Devang Patel58faf202010-10-22 17:11:50 +0000898 return isFunctionLocalClass(NRD);
Nick Lewycky7480d962011-11-10 00:34:02 +0000899 if (isa<FunctionDecl>(RD->getDeclContext()))
Devang Patel58faf202010-10-22 17:11:50 +0000900 return true;
901 return false;
Devang Patel58faf202010-10-22 17:11:50 +0000902}
Nick Lewyckyd4c100e2011-11-09 04:25:21 +0000903
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000904/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
905/// a single member function GlobalDecl.
906llvm::DISubprogram
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000907CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
Devang Patel17800552010-03-09 00:44:50 +0000908 llvm::DIFile Unit,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000909 llvm::DIType RecordTy) {
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000910 bool IsCtorOrDtor =
911 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
912
Chris Lattner5f9e2722011-07-23 10:55:15 +0000913 StringRef MethodName = getFunctionName(Method);
Devang Patela6da1922010-01-28 00:28:01 +0000914 llvm::DIType MethodTy = getOrCreateMethodType(Method, Unit);
Eric Christopheraa6eccc2012-08-04 00:11:22 +0000915
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000916 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
917 // make sense to give a single ctor/dtor a linkage name.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000918 StringRef MethodLinkageName;
Devang Patel58faf202010-10-22 17:11:50 +0000919 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
Anders Carlsson9a20d552010-06-22 16:16:50 +0000920 MethodLinkageName = CGM.getMangledName(Method);
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000921
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000922 // Get the location for the method.
Devang Patel8ab870d2010-05-12 23:46:38 +0000923 llvm::DIFile MethodDefUnit = getOrCreateFile(Method->getLocation());
924 unsigned MethodLine = getLineNumber(Method->getLocation());
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000925
926 // Collect virtual method info.
927 llvm::DIType ContainingType;
928 unsigned Virtuality = 0;
929 unsigned VIndex = 0;
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000930
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000931 if (Method->isVirtual()) {
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000932 if (Method->isPure())
933 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
934 else
935 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
936
937 // It doesn't make sense to give a virtual destructor a vtable index,
938 // since a single destructor has two entries in the vtable.
939 if (!isa<CXXDestructorDecl>(Method))
Peter Collingbourne1d2b3172011-09-26 01:56:30 +0000940 VIndex = CGM.getVTableContext().getMethodVTableIndex(Method);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000941 ContainingType = RecordTy;
942 }
943
Devang Patele2472482010-09-29 21:05:52 +0000944 unsigned Flags = 0;
945 if (Method->isImplicit())
946 Flags |= llvm::DIDescriptor::FlagArtificial;
Devang Patel10a7a6a2010-09-29 21:46:16 +0000947 AccessSpecifier Access = Method->getAccess();
948 if (Access == clang::AS_private)
949 Flags |= llvm::DIDescriptor::FlagPrivate;
950 else if (Access == clang::AS_protected)
951 Flags |= llvm::DIDescriptor::FlagProtected;
Devang Pateld78a0192010-10-01 23:32:17 +0000952 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
953 if (CXXC->isExplicit())
954 Flags |= llvm::DIDescriptor::FlagExplicit;
955 } else if (const CXXConversionDecl *CXXC =
956 dyn_cast<CXXConversionDecl>(Method)) {
957 if (CXXC->isExplicit())
958 Flags |= llvm::DIDescriptor::FlagExplicit;
959 }
Devang Patel3951e712010-10-07 22:03:49 +0000960 if (Method->hasPrototype())
961 Flags |= llvm::DIDescriptor::FlagPrototyped;
Eric Christopher3b10cfe2012-03-13 23:40:48 +0000962
963 llvm::DIArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000964 llvm::DISubprogram SP =
Nick Lewycky7803ec82011-09-01 21:49:51 +0000965 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Devang Patel823d8e92010-12-08 22:42:58 +0000966 MethodDefUnit, MethodLine,
967 MethodTy, /*isLocalToUnit=*/false,
968 /* isDefinition=*/ false,
969 Virtuality, VIndex, ContainingType,
Eric Christopher3b10cfe2012-03-13 23:40:48 +0000970 Flags, CGM.getLangOpts().Optimize, NULL,
971 TParamsArray);
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000972
Eric Christopherdeae6a82011-11-17 23:45:00 +0000973 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000974
975 return SP;
976}
977
Devang Patel4125fd22010-01-19 01:54:44 +0000978/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopher7c9b2fd2012-01-12 01:26:51 +0000979/// C++ member functions. This is used while creating debug info entry for
Devang Patel4125fd22010-01-19 01:54:44 +0000980/// a Record.
981void CGDebugInfo::
Devang Patel17800552010-03-09 00:44:50 +0000982CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000983 SmallVectorImpl<llvm::Value *> &EltTys,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000984 llvm::DIType RecordTy) {
Eric Christopher3b10cfe2012-03-13 23:40:48 +0000985
986 // Since we want more than just the individual member decls if we
987 // have templated functions iterate over every declaration to gather
988 // the functions.
989 for(DeclContext::decl_iterator I = RD->decls_begin(),
990 E = RD->decls_end(); I != E; ++I) {
991 Decl *D = *I;
992 if (D->isImplicit() && !D->isUsed())
Anders Carlssonbea9b232010-01-26 04:40:11 +0000993 continue;
Devang Patel4125fd22010-01-19 01:54:44 +0000994
Eric Christopher3de00ce2012-06-05 18:16:22 +0000995 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D)) {
996 // Only emit debug information for user provided functions, we're
997 // unlikely to want info for artificial functions.
998 if (Method->isUserProvided())
999 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
1000 }
Eric Christopher3b10cfe2012-03-13 23:40:48 +00001001 else if (FunctionTemplateDecl *FTD = dyn_cast<FunctionTemplateDecl>(D))
1002 for (FunctionTemplateDecl::spec_iterator SI = FTD->spec_begin(),
1003 SE = FTD->spec_end(); SI != SE; ++SI) {
1004 FunctionDecl *FD = *SI;
1005 if (CXXMethodDecl *M = dyn_cast<CXXMethodDecl>(FD))
1006 EltTys.push_back(CreateCXXMemberFunction(M, Unit, RecordTy));
1007 }
Devang Patel4125fd22010-01-19 01:54:44 +00001008 }
1009}
1010
Devang Patel2ed8f002010-08-27 17:47:47 +00001011/// CollectCXXFriends - A helper function to collect debug info for
1012/// C++ base classes. This is used while creating debug info entry for
1013/// a Record.
1014void CGDebugInfo::
1015CollectCXXFriends(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001016 SmallVectorImpl<llvm::Value *> &EltTys,
Devang Patel2ed8f002010-08-27 17:47:47 +00001017 llvm::DIType RecordTy) {
Eric Christopher121c67d2012-01-12 01:26:58 +00001018 for (CXXRecordDecl::friend_iterator BI = RD->friend_begin(),
Devang Patel2ed8f002010-08-27 17:47:47 +00001019 BE = RD->friend_end(); BI != BE; ++BI) {
Nick Lewycky7803ec82011-09-01 21:49:51 +00001020 if ((*BI)->isUnsupportedFriend())
1021 continue;
Devang Patel823d8e92010-12-08 22:42:58 +00001022 if (TypeSourceInfo *TInfo = (*BI)->getFriendType())
Devang Patel16674e82011-02-22 18:56:36 +00001023 EltTys.push_back(DBuilder.createFriend(RecordTy,
Devang Patel823d8e92010-12-08 22:42:58 +00001024 getOrCreateType(TInfo->getType(),
1025 Unit)));
Devang Patel2ed8f002010-08-27 17:47:47 +00001026 }
1027}
1028
Devang Patela245c5b2010-01-25 23:32:18 +00001029/// CollectCXXBases - A helper function to collect debug info for
1030/// C++ base classes. This is used while creating debug info entry for
1031/// a Record.
1032void CGDebugInfo::
Devang Patel17800552010-03-09 00:44:50 +00001033CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001034 SmallVectorImpl<llvm::Value *> &EltTys,
Dan Gohman4cac5b42010-08-20 22:02:57 +00001035 llvm::DIType RecordTy) {
Devang Patela245c5b2010-01-25 23:32:18 +00001036
Devang Patel239cec62010-02-01 21:39:52 +00001037 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1038 for (CXXRecordDecl::base_class_const_iterator BI = RD->bases_begin(),
1039 BE = RD->bases_end(); BI != BE; ++BI) {
Devang Patelca7daed2010-01-28 21:54:15 +00001040 unsigned BFlags = 0;
Devang Patel62c117d2011-04-04 20:36:06 +00001041 uint64_t BaseOffset;
Devang Patelca7daed2010-01-28 21:54:15 +00001042
1043 const CXXRecordDecl *Base =
1044 cast<CXXRecordDecl>(BI->getType()->getAs<RecordType>()->getDecl());
1045
1046 if (BI->isVirtual()) {
Anders Carlssonbba16072010-03-11 07:15:17 +00001047 // virtual base offset offset is -ve. The code generator emits dwarf
Devang Pateld5322da2010-02-09 19:09:28 +00001048 // expression where it expects +ve number.
Ken Dyck14c65ca2011-04-07 12:37:09 +00001049 BaseOffset =
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00001050 0 - CGM.getVTableContext()
1051 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
Devang Patele2472482010-09-29 21:05:52 +00001052 BFlags = llvm::DIDescriptor::FlagVirtual;
Devang Patelca7daed2010-01-28 21:54:15 +00001053 } else
Benjamin Kramerd4f51982012-07-04 18:45:14 +00001054 BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
Ken Dyck14c65ca2011-04-07 12:37:09 +00001055 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1056 // BI->isVirtual() and bits when not.
Devang Patelca7daed2010-01-28 21:54:15 +00001057
1058 AccessSpecifier Access = BI->getAccessSpecifier();
1059 if (Access == clang::AS_private)
Devang Patele2472482010-09-29 21:05:52 +00001060 BFlags |= llvm::DIDescriptor::FlagPrivate;
Devang Patelca7daed2010-01-28 21:54:15 +00001061 else if (Access == clang::AS_protected)
Devang Patele2472482010-09-29 21:05:52 +00001062 BFlags |= llvm::DIDescriptor::FlagProtected;
Devang Patelca7daed2010-01-28 21:54:15 +00001063
Devang Patel823d8e92010-12-08 22:42:58 +00001064 llvm::DIType DTy =
Devang Patel16674e82011-02-22 18:56:36 +00001065 DBuilder.createInheritance(RecordTy,
Devang Patel823d8e92010-12-08 22:42:58 +00001066 getOrCreateType(BI->getType(), Unit),
Devang Patel62c117d2011-04-04 20:36:06 +00001067 BaseOffset, BFlags);
Devang Patelca7daed2010-01-28 21:54:15 +00001068 EltTys.push_back(DTy);
1069 }
Devang Patela245c5b2010-01-25 23:32:18 +00001070}
1071
Devang Patel5ecb1df2011-04-05 22:54:11 +00001072/// CollectTemplateParams - A helper function to collect template parameters.
Devang Patel9c1714b2011-04-05 17:30:54 +00001073llvm::DIArray CGDebugInfo::
Devang Patel5ecb1df2011-04-05 22:54:11 +00001074CollectTemplateParams(const TemplateParameterList *TPList,
1075 const TemplateArgumentList &TAList,
1076 llvm::DIFile Unit) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001077 SmallVector<llvm::Value *, 16> TemplateParams;
Devang Patelc5ce2972011-04-05 20:15:06 +00001078 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1079 const TemplateArgument &TA = TAList[i];
Devang Patel5ecb1df2011-04-05 22:54:11 +00001080 const NamedDecl *ND = TPList->getParam(i);
Devang Patel9c1714b2011-04-05 17:30:54 +00001081 if (TA.getKind() == TemplateArgument::Type) {
1082 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1083 llvm::DITemplateTypeParameter TTP =
Devang Patelc5ce2972011-04-05 20:15:06 +00001084 DBuilder.createTemplateTypeParameter(TheCU, ND->getName(), TTy);
Devang Patel9c1714b2011-04-05 17:30:54 +00001085 TemplateParams.push_back(TTP);
1086 } else if (TA.getKind() == TemplateArgument::Integral) {
1087 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
Devang Patel9c1714b2011-04-05 17:30:54 +00001088 llvm::DITemplateValueParameter TVP =
Devang Patelc5ce2972011-04-05 20:15:06 +00001089 DBuilder.createTemplateValueParameter(TheCU, ND->getName(), TTy,
Benjamin Kramer85524372012-06-07 15:09:51 +00001090 TA.getAsIntegral().getZExtValue());
Devang Patel9c1714b2011-04-05 17:30:54 +00001091 TemplateParams.push_back(TVP);
1092 }
1093 }
Jay Foadc556ef22011-04-24 10:11:03 +00001094 return DBuilder.getOrCreateArray(TemplateParams);
Devang Patel9c1714b2011-04-05 17:30:54 +00001095}
1096
Devang Patel5ecb1df2011-04-05 22:54:11 +00001097/// CollectFunctionTemplateParams - A helper function to collect debug
1098/// info for function template parameters.
1099llvm::DIArray CGDebugInfo::
1100CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
Eric Christopherab5278e2011-10-11 23:00:51 +00001101 if (FD->getTemplatedKind() ==
1102 FunctionDecl::TK_FunctionTemplateSpecialization) {
Devang Patel5ecb1df2011-04-05 22:54:11 +00001103 const TemplateParameterList *TList =
Eric Christopherab5278e2011-10-11 23:00:51 +00001104 FD->getTemplateSpecializationInfo()->getTemplate()
1105 ->getTemplateParameters();
Devang Patel5ecb1df2011-04-05 22:54:11 +00001106 return
1107 CollectTemplateParams(TList, *FD->getTemplateSpecializationArgs(), Unit);
1108 }
1109 return llvm::DIArray();
1110}
1111
1112/// CollectCXXTemplateParams - A helper function to collect debug info for
1113/// template parameters.
1114llvm::DIArray CGDebugInfo::
1115CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1116 llvm::DIFile Unit) {
1117 llvm::PointerUnion<ClassTemplateDecl *,
1118 ClassTemplatePartialSpecializationDecl *>
1119 PU = TSpecial->getSpecializedTemplateOrPartial();
1120
1121 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1122 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1123 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1124 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
1125 return CollectTemplateParams(TPList, TAList, Unit);
1126}
1127
Devang Patel4ce3f202010-01-28 18:11:52 +00001128/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
Devang Patel17800552010-03-09 00:44:50 +00001129llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
Devang Patel0804e6e2010-03-08 20:53:17 +00001130 if (VTablePtrType.isValid())
Devang Patel4ce3f202010-01-28 18:11:52 +00001131 return VTablePtrType;
1132
1133 ASTContext &Context = CGM.getContext();
1134
1135 /* Function type */
Devang Patel823d8e92010-12-08 22:42:58 +00001136 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
Jay Foadc556ef22011-04-24 10:11:03 +00001137 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
Devang Patel16674e82011-02-22 18:56:36 +00001138 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
Devang Patel4ce3f202010-01-28 18:11:52 +00001139 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Devang Patel16674e82011-02-22 18:56:36 +00001140 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001141 "__vtbl_ptr_type");
Devang Patel16674e82011-02-22 18:56:36 +00001142 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
Devang Patel4ce3f202010-01-28 18:11:52 +00001143 return VTablePtrType;
1144}
1145
Anders Carlsson046c2942010-04-17 20:15:18 +00001146/// getVTableName - Get vtable name for the given Class.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001147StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Eric Christopher51cb75a2012-01-25 21:47:09 +00001148 // Construct gdb compatible name name.
Devang Patel239cec62010-02-01 21:39:52 +00001149 std::string Name = "_vptr$" + RD->getNameAsString();
Devang Patel4ce3f202010-01-28 18:11:52 +00001150
1151 // Copy this name on the side and use its reference.
Devang Patel89f05f82010-01-28 18:21:00 +00001152 char *StrPtr = DebugInfoNames.Allocate<char>(Name.length());
Devang Patel4ce3f202010-01-28 18:11:52 +00001153 memcpy(StrPtr, Name.data(), Name.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +00001154 return StringRef(StrPtr, Name.length());
Devang Patel4ce3f202010-01-28 18:11:52 +00001155}
1156
1157
Anders Carlsson046c2942010-04-17 20:15:18 +00001158/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
Devang Patel4ce3f202010-01-28 18:11:52 +00001159/// debug info entry in EltTys vector.
1160void CGDebugInfo::
Anders Carlsson046c2942010-04-17 20:15:18 +00001161CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001162 SmallVectorImpl<llvm::Value *> &EltTys) {
Devang Patel239cec62010-02-01 21:39:52 +00001163 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Devang Patel4ce3f202010-01-28 18:11:52 +00001164
1165 // If there is a primary base then it will hold vtable info.
1166 if (RL.getPrimaryBase())
1167 return;
1168
1169 // If this class is not dynamic then there is not any vtable info to collect.
Devang Patel239cec62010-02-01 21:39:52 +00001170 if (!RD->isDynamicClass())
Devang Patel4ce3f202010-01-28 18:11:52 +00001171 return;
1172
1173 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1174 llvm::DIType VPTR
Devang Patel1d323e02011-06-24 22:00:59 +00001175 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Devang Patel823d8e92010-12-08 22:42:58 +00001176 0, Size, 0, 0, 0,
1177 getOrCreateVTablePtrType(Unit));
Devang Patel4ce3f202010-01-28 18:11:52 +00001178 EltTys.push_back(VPTR);
1179}
1180
Devang Patelc69e1cf2010-09-30 19:05:55 +00001181/// getOrCreateRecordType - Emit record type's standalone debug info.
1182llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
1183 SourceLocation Loc) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001184 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001185 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
Devang Patelc69e1cf2010-09-30 19:05:55 +00001186 return T;
1187}
1188
Eric Christopherbe6c6862012-04-11 05:56:05 +00001189/// getOrCreateInterfaceType - Emit an objective c interface type standalone
1190/// debug info.
1191llvm::DIType CGDebugInfo::getOrCreateInterfaceType(QualType D,
1192 SourceLocation Loc) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00001193 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Eric Christopherbe6c6862012-04-11 05:56:05 +00001194 llvm::DIType T = getOrCreateType(D, getOrCreateFile(Loc));
1195 DBuilder.retainType(T);
1196 return T;
1197}
1198
Devang Patel65e99f22009-02-25 01:36:11 +00001199/// CreateType - get structure or union type.
Devang Patel31f7d022011-01-17 22:23:07 +00001200llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Devang Pateld6c5a262010-02-01 21:52:22 +00001201 RecordDecl *RD = Ty->getDecl();
Mike Stump1eb44332009-09-09 15:08:12 +00001202
Chris Lattner9c85ba32008-11-10 06:08:34 +00001203 // Get overall information about the record type for the debug info.
Devang Patel8ab870d2010-05-12 23:46:38 +00001204 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +00001205
Chris Lattner9c85ba32008-11-10 06:08:34 +00001206 // Records and classes and unions can all be recursive. To handle them, we
1207 // first generate a debug descriptor for the struct as a forward declaration.
1208 // Then (if it is a definition) we go through and get debug info for all of
1209 // its members. Finally, we create a descriptor for the complete type (which
1210 // may refer to the forward decl if the struct is recursive) and replace all
1211 // uses of the forward declaration with the final definition.
Eric Christopher4ddca8a2012-01-20 22:10:15 +00001212
Eric Christopher9965dea2012-02-16 22:54:45 +00001213 llvm::DIType FwdDecl = getOrCreateLimitedType(QualType(Ty, 0), DefUnit);
Devang Patel0b897992010-07-08 19:56:29 +00001214
Eric Christopher9965dea2012-02-16 22:54:45 +00001215 if (FwdDecl.isForwardDecl())
1216 return FwdDecl;
Benjamin Kramer6181e562012-03-20 19:49:14 +00001217
1218 llvm::TrackingVH<llvm::MDNode> FwdDeclNode(FwdDecl);
1219
Devang Patele4c1ea02010-03-11 20:01:48 +00001220 // Push the struct on region stack.
Eric Christopheraa2164c2011-09-29 00:00:45 +00001221 LexicalBlockStack.push_back(FwdDeclNode);
Devang Patelab699792010-05-07 18:12:35 +00001222 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001223
Eric Christopher9965dea2012-02-16 22:54:45 +00001224 // Add this to the completed types cache since we're completing it.
1225 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
1226
Chris Lattner9c85ba32008-11-10 06:08:34 +00001227 // Convert all the elements.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001228 SmallVector<llvm::Value *, 16> EltTys;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001229
Eric Christopher1c081d92012-01-26 07:01:04 +00001230 // Note: The split of CXXDecl information here is intentional, the
1231 // gdb tests will depend on a certain ordering at printout. The debug
1232 // information offsets are still correct if we merge them all together
1233 // though.
Devang Pateld6c5a262010-02-01 21:52:22 +00001234 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Devang Patel3064afe2010-01-28 21:41:35 +00001235 if (CXXDecl) {
Eric Christopher3ee8c912012-01-26 06:20:57 +00001236 CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
1237 CollectVTableInfo(CXXDecl, DefUnit, EltTys);
Eric Christopher1c081d92012-01-26 07:01:04 +00001238 }
1239
1240 // Collect static variables with initializers and other fields.
1241 CollectRecordStaticVars(RD, FwdDecl);
1242 CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
1243 llvm::DIArray TParamsArray;
1244 if (CXXDecl) {
Eric Christopher3ee8c912012-01-26 06:20:57 +00001245 CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
1246 CollectCXXFriends(CXXDecl, DefUnit, EltTys, FwdDecl);
Devang Patel9c1714b2011-04-05 17:30:54 +00001247 if (const ClassTemplateSpecializationDecl *TSpecial
1248 = dyn_cast<ClassTemplateSpecializationDecl>(RD))
Eric Christopher3ee8c912012-01-26 06:20:57 +00001249 TParamsArray = CollectCXXTemplateParams(TSpecial, DefUnit);
Devang Patel823d8e92010-12-08 22:42:58 +00001250 }
Devang Patel0ac8f312010-01-28 00:54:21 +00001251
Eric Christopheraa2164c2011-09-29 00:00:45 +00001252 LexicalBlockStack.pop_back();
Benjamin Kramer7e423922012-03-24 18:22:12 +00001253 RegionMap.erase(Ty->getDecl());
Devang Patel823d8e92010-12-08 22:42:58 +00001254
Jay Foadc556ef22011-04-24 10:11:03 +00001255 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Eric Christopher9965dea2012-02-16 22:54:45 +00001256 // FIXME: Magic numbers ahoy! These should be changed when we
1257 // get some enums in llvm/Analysis/DebugInfo.h to refer to
1258 // them.
Eric Christopher64a04302012-02-15 23:51:20 +00001259 if (RD->isUnion())
Benjamin Kramer6181e562012-03-20 19:49:14 +00001260 FwdDeclNode->replaceOperandWith(10, Elements);
Eric Christopher64a04302012-02-15 23:51:20 +00001261 else if (CXXDecl) {
Benjamin Kramer6181e562012-03-20 19:49:14 +00001262 FwdDeclNode->replaceOperandWith(10, Elements);
1263 FwdDeclNode->replaceOperandWith(13, TParamsArray);
Eric Christopher64a04302012-02-15 23:51:20 +00001264 } else
Benjamin Kramer6181e562012-03-20 19:49:14 +00001265 FwdDeclNode->replaceOperandWith(10, Elements);
Eric Christopher64a04302012-02-15 23:51:20 +00001266
Benjamin Kramer6181e562012-03-20 19:49:14 +00001267 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDeclNode);
1268 return llvm::DIType(FwdDeclNode);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001269}
1270
John McCallc12c5bb2010-05-15 11:32:37 +00001271/// CreateType - get objective-c object type.
1272llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1273 llvm::DIFile Unit) {
1274 // Ignore protocols.
1275 return getOrCreateType(Ty->getBaseType(), Unit);
1276}
1277
Devang Patel9ca36b62009-02-26 21:10:26 +00001278/// CreateType - get objective-c interface type.
1279llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001280 llvm::DIFile Unit) {
Devang Pateld6c5a262010-02-01 21:52:22 +00001281 ObjCInterfaceDecl *ID = Ty->getDecl();
Douglas Gregora6a28972010-11-30 06:38:09 +00001282 if (!ID)
1283 return llvm::DIType();
Devang Patel9ca36b62009-02-26 21:10:26 +00001284
1285 // Get overall information about the record type for the debug info.
Devang Patel17800552010-03-09 00:44:50 +00001286 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
Devang Patel8ab870d2010-05-12 23:46:38 +00001287 unsigned Line = getLineNumber(ID->getLocation());
Devang Patel17800552010-03-09 00:44:50 +00001288 unsigned RuntimeLang = TheCU.getLanguage();
Chris Lattnerac7c8142009-05-02 01:13:16 +00001289
Eric Christopherd1ab1a22011-10-06 00:31:18 +00001290 // If this is just a forward declaration return a special forward-declaration
1291 // debug type since we won't be able to lay out the entire type.
Douglas Gregor7c1f1f12011-12-15 23:32:29 +00001292 ObjCInterfaceDecl *Def = ID->getDefinition();
1293 if (!Def) {
Devang Patel823d8e92010-12-08 22:42:58 +00001294 llvm::DIType FwdDecl =
Eric Christopher917bc8d2012-02-20 18:05:04 +00001295 DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
Eric Christopher87380aa2012-04-23 19:00:24 +00001296 ID->getName(), TheCU, DefUnit, Line,
Eric Christopher917bc8d2012-02-20 18:05:04 +00001297 RuntimeLang);
Dan Gohman45f7c782010-08-23 21:15:56 +00001298 return FwdDecl;
1299 }
Eric Christopherbe6c6862012-04-11 05:56:05 +00001300
Douglas Gregor7c1f1f12011-12-15 23:32:29 +00001301 ID = Def;
Dan Gohman45f7c782010-08-23 21:15:56 +00001302
Eric Christopher9965dea2012-02-16 22:54:45 +00001303 // Bit size, align and offset of the type.
1304 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1305 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Mike Stump1eb44332009-09-09 15:08:12 +00001306
Eric Christopher9965dea2012-02-16 22:54:45 +00001307 unsigned Flags = 0;
1308 if (ID->getImplementation())
1309 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
1310
1311 llvm::DIType RealDecl =
1312 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
1313 Line, Size, Align, Flags,
1314 llvm::DIArray(), RuntimeLang);
Eric Christopherbe6c6862012-04-11 05:56:05 +00001315
Eric Christopheraf3db7d2012-02-27 08:23:23 +00001316 // Otherwise, insert it into the CompletedTypeCache so that recursive uses
1317 // will find it and we're emitting the complete type.
1318 CompletedTypeCache[QualType(Ty, 0).getAsOpaquePtr()] = RealDecl;
Devang Patele4c1ea02010-03-11 20:01:48 +00001319 // Push the struct on region stack.
Benjamin Kramer6181e562012-03-20 19:49:14 +00001320 llvm::TrackingVH<llvm::MDNode> FwdDeclNode(RealDecl);
Eric Christopher9965dea2012-02-16 22:54:45 +00001321
Eric Christopheraa2164c2011-09-29 00:00:45 +00001322 LexicalBlockStack.push_back(FwdDeclNode);
Eric Christopher9965dea2012-02-16 22:54:45 +00001323 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
Devang Patel9ca36b62009-02-26 21:10:26 +00001324
1325 // Convert all the elements.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001326 SmallVector<llvm::Value *, 16> EltTys;
Devang Patel9ca36b62009-02-26 21:10:26 +00001327
Devang Pateld6c5a262010-02-01 21:52:22 +00001328 ObjCInterfaceDecl *SClass = ID->getSuperClass();
Devang Patelfbe899f2009-03-10 21:30:26 +00001329 if (SClass) {
Mike Stump1eb44332009-09-09 15:08:12 +00001330 llvm::DIType SClassTy =
Anders Carlsson20f12a22009-12-06 18:00:51 +00001331 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Douglas Gregora6a28972010-11-30 06:38:09 +00001332 if (!SClassTy.isValid())
1333 return llvm::DIType();
1334
Mike Stump1eb44332009-09-09 15:08:12 +00001335 llvm::DIType InhTag =
Eric Christopher9965dea2012-02-16 22:54:45 +00001336 DBuilder.createInheritance(RealDecl, SClassTy, 0, 0);
Devang Patelfbe899f2009-03-10 21:30:26 +00001337 EltTys.push_back(InhTag);
1338 }
1339
Devang Patel693fcaa2012-02-07 18:40:30 +00001340 for (ObjCContainerDecl::prop_iterator I = ID->prop_begin(),
1341 E = ID->prop_end(); I != E; ++I) {
David Blaikie581deb32012-06-06 20:45:41 +00001342 const ObjCPropertyDecl *PD = *I;
Eric Christopher51c03712012-03-29 08:43:37 +00001343 SourceLocation Loc = PD->getLocation();
1344 llvm::DIFile PUnit = getOrCreateFile(Loc);
1345 unsigned PLine = getLineNumber(Loc);
Eric Christopher78af8fd2012-04-05 22:03:32 +00001346 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1347 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
Devang Patel693fcaa2012-02-07 18:40:30 +00001348 llvm::MDNode *PropertyNode =
1349 DBuilder.createObjCProperty(PD->getName(),
Eric Christopher51c03712012-03-29 08:43:37 +00001350 PUnit, PLine,
Eric Christopher78af8fd2012-04-05 22:03:32 +00001351 (Getter && Getter->isImplicit()) ? "" :
Eric Christopherecae5962012-03-29 17:31:33 +00001352 getSelectorName(PD->getGetterName()),
Eric Christopher78af8fd2012-04-05 22:03:32 +00001353 (Setter && Setter->isImplicit()) ? "" :
Eric Christopherecae5962012-03-29 17:31:33 +00001354 getSelectorName(PD->getSetterName()),
Eric Christopher51c03712012-03-29 08:43:37 +00001355 PD->getPropertyAttributes(),
1356 getOrCreateType(PD->getType(), PUnit));
Devang Patel693fcaa2012-02-07 18:40:30 +00001357 EltTys.push_back(PropertyNode);
1358 }
1359
Devang Pateld6c5a262010-02-01 21:52:22 +00001360 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
Devang Patel9ca36b62009-02-26 21:10:26 +00001361 unsigned FieldNo = 0;
Fariborz Jahanian97477392010-10-01 00:01:53 +00001362 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
Fariborz Jahanianfe8fdba2010-10-11 23:55:47 +00001363 Field = Field->getNextIvar(), ++FieldNo) {
Devang Patel9ca36b62009-02-26 21:10:26 +00001364 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
Douglas Gregora6a28972010-11-30 06:38:09 +00001365 if (!FieldTy.isValid())
1366 return llvm::DIType();
1367
Chris Lattner5f9e2722011-07-23 10:55:15 +00001368 StringRef FieldName = Field->getName();
Devang Patel9ca36b62009-02-26 21:10:26 +00001369
Devang Patelde135022009-04-27 22:40:36 +00001370 // Ignore unnamed fields.
Devang Patel73621622009-11-25 17:37:31 +00001371 if (FieldName.empty())
Devang Patelde135022009-04-27 22:40:36 +00001372 continue;
1373
Devang Patel9ca36b62009-02-26 21:10:26 +00001374 // Get the location for the field.
Devang Patel8ab870d2010-05-12 23:46:38 +00001375 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1376 unsigned FieldLine = getLineNumber(Field->getLocation());
Devang Patel99c20eb2009-03-20 18:24:39 +00001377 QualType FType = Field->getType();
1378 uint64_t FieldSize = 0;
1379 unsigned FieldAlign = 0;
Devang Patelc20482b2009-03-19 00:23:53 +00001380
Devang Patel99c20eb2009-03-20 18:24:39 +00001381 if (!FType->isIncompleteArrayType()) {
Mike Stump1eb44332009-09-09 15:08:12 +00001382
Devang Patel99c20eb2009-03-20 18:24:39 +00001383 // Bit size, align and offset of the type.
Richard Smitha6b8b2c2011-10-10 18:28:20 +00001384 FieldSize = Field->isBitField()
1385 ? Field->getBitWidthValue(CGM.getContext())
1386 : CGM.getContext().getTypeSize(FType);
1387 FieldAlign = CGM.getContext().getTypeAlign(FType);
Devang Patel99c20eb2009-03-20 18:24:39 +00001388 }
1389
Eric Christopherd1ab1a22011-10-06 00:31:18 +00001390 // We can't know the offset of our ivar in the structure if we're using
1391 // the non-fragile abi and the debugger should ignore the value anyways.
1392 // Call it the FieldNo+1 due to how debuggers use the information,
1393 // e.g. negating the value when it needs a lookup in the dynamic table.
John McCall260611a2012-06-20 06:18:46 +00001394 uint64_t FieldOffset = CGM.getLangOpts().ObjCRuntime.isNonFragile()
1395 ? FieldNo+1 : RL.getFieldOffset(FieldNo);
Mike Stump1eb44332009-09-09 15:08:12 +00001396
Devang Patelc20482b2009-03-19 00:23:53 +00001397 unsigned Flags = 0;
1398 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Devang Patele2472482010-09-29 21:05:52 +00001399 Flags = llvm::DIDescriptor::FlagProtected;
Devang Patelc20482b2009-03-19 00:23:53 +00001400 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Devang Patele2472482010-09-29 21:05:52 +00001401 Flags = llvm::DIDescriptor::FlagPrivate;
Mike Stump1eb44332009-09-09 15:08:12 +00001402
Devang Patel693a70d2012-02-04 01:15:04 +00001403 llvm::MDNode *PropertyNode = NULL;
Devang Patel693fcaa2012-02-07 18:40:30 +00001404 if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
Devang Patel8c6f9c42011-09-19 18:54:16 +00001405 if (ObjCPropertyImplDecl *PImpD =
Devang Patel693fcaa2012-02-07 18:40:30 +00001406 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
1407 if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
Eric Christopher51c03712012-03-29 08:43:37 +00001408 SourceLocation Loc = PD->getLocation();
1409 llvm::DIFile PUnit = getOrCreateFile(Loc);
1410 unsigned PLine = getLineNumber(Loc);
Eric Christopher78af8fd2012-04-05 22:03:32 +00001411 ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
1412 ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
1413 PropertyNode =
1414 DBuilder.createObjCProperty(PD->getName(),
1415 PUnit, PLine,
1416 (Getter && Getter->isImplicit()) ? "" :
Eric Christopherecae5962012-03-29 17:31:33 +00001417 getSelectorName(PD->getGetterName()),
Eric Christopher78af8fd2012-04-05 22:03:32 +00001418 (Setter && Setter->isImplicit()) ? "" :
Eric Christopherecae5962012-03-29 17:31:33 +00001419 getSelectorName(PD->getSetterName()),
Eric Christopher78af8fd2012-04-05 22:03:32 +00001420 PD->getPropertyAttributes(),
1421 getOrCreateType(PD->getType(), PUnit));
Devang Patel53bc5182012-02-08 00:10:20 +00001422 }
Devang Patel693fcaa2012-02-07 18:40:30 +00001423 }
Devang Patel693a70d2012-02-04 01:15:04 +00001424 }
Devang Patelfa936d82011-04-16 00:12:55 +00001425 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1426 FieldLine, FieldSize, FieldAlign,
1427 FieldOffset, Flags, FieldTy,
Devang Patel5f3c7fa2012-02-06 18:20:02 +00001428 PropertyNode);
Devang Patel9ca36b62009-02-26 21:10:26 +00001429 EltTys.push_back(FieldTy);
1430 }
Mike Stump1eb44332009-09-09 15:08:12 +00001431
Jay Foadc556ef22011-04-24 10:11:03 +00001432 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Benjamin Kramer6181e562012-03-20 19:49:14 +00001433 FwdDeclNode->replaceOperandWith(10, Elements);
Eric Christopher9965dea2012-02-16 22:54:45 +00001434
Eric Christopheraa2164c2011-09-29 00:00:45 +00001435 LexicalBlockStack.pop_back();
Benjamin Kramer6181e562012-03-20 19:49:14 +00001436 return llvm::DIType(FwdDeclNode);
Devang Patel9ca36b62009-02-26 21:10:26 +00001437}
1438
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001439llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
Devang Patel70c23cd2010-02-23 22:59:39 +00001440 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Devang Patel6cf37dd2011-04-08 21:56:52 +00001441 int64_t NumElems = Ty->getNumElements();
1442 int64_t LowerBound = 0;
1443 if (NumElems == 0)
1444 // If number of elements are not known then this is an unbounded array.
1445 // Use Low = 1, Hi = 0 to express such arrays.
1446 LowerBound = 1;
1447 else
Devang Patel70c23cd2010-02-23 22:59:39 +00001448 --NumElems;
Devang Patel70c23cd2010-02-23 22:59:39 +00001449
Devang Patel6cf37dd2011-04-08 21:56:52 +00001450 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(LowerBound, NumElems);
Jay Foadc556ef22011-04-24 10:11:03 +00001451 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Devang Patel70c23cd2010-02-23 22:59:39 +00001452
1453 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1454 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1455
1456 return
Devang Patel16674e82011-02-22 18:56:36 +00001457 DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
Devang Patel70c23cd2010-02-23 22:59:39 +00001458}
1459
Chris Lattner9c85ba32008-11-10 06:08:34 +00001460llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001461 llvm::DIFile Unit) {
Anders Carlsson835c9092009-01-05 01:23:29 +00001462 uint64_t Size;
1463 uint64_t Align;
Mike Stump1eb44332009-09-09 15:08:12 +00001464
Nuno Lopes010d5142009-01-28 00:35:17 +00001465 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
Anders Carlsson835c9092009-01-05 01:23:29 +00001466 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
Anders Carlsson835c9092009-01-05 01:23:29 +00001467 Size = 0;
1468 Align =
Anders Carlsson20f12a22009-12-06 18:00:51 +00001469 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Nuno Lopes010d5142009-01-28 00:35:17 +00001470 } else if (Ty->isIncompleteArrayType()) {
1471 Size = 0;
Anders Carlsson20f12a22009-12-06 18:00:51 +00001472 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
Devang Patelba690a42011-04-04 23:18:38 +00001473 } else if (Ty->isDependentSizedArrayType() || Ty->isIncompleteType()) {
Devang Patelae503df2011-04-01 19:02:33 +00001474 Size = 0;
1475 Align = 0;
Anders Carlsson835c9092009-01-05 01:23:29 +00001476 } else {
1477 // Size and align of the whole array, not the element type.
Anders Carlsson20f12a22009-12-06 18:00:51 +00001478 Size = CGM.getContext().getTypeSize(Ty);
1479 Align = CGM.getContext().getTypeAlign(Ty);
Anders Carlsson835c9092009-01-05 01:23:29 +00001480 }
Mike Stump1eb44332009-09-09 15:08:12 +00001481
Chris Lattner9c85ba32008-11-10 06:08:34 +00001482 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1483 // interior arrays, do we care? Why aren't nested arrays represented the
1484 // obvious/recursive way?
Chris Lattner5f9e2722011-07-23 10:55:15 +00001485 SmallVector<llvm::Value *, 8> Subscripts;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001486 QualType EltTy(Ty, 0);
Eric Christophere6d11972012-05-21 22:13:23 +00001487 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
1488 int64_t UpperBound = 0;
1489 int64_t LowerBound = 0;
1490 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty)) {
1491 if (CAT->getSize().getZExtValue())
1492 UpperBound = CAT->getSize().getZExtValue() - 1;
1493 } else
1494 // This is an unbounded array. Use Low = 1, Hi = 0 to express such
1495 // arrays.
1496 LowerBound = 1;
1497
1498 // FIXME: Verify this is right for VLAs.
1499 Subscripts.push_back(DBuilder.getOrCreateSubrange(LowerBound,
1500 UpperBound));
Chris Lattner9c85ba32008-11-10 06:08:34 +00001501 EltTy = Ty->getElementType();
Sanjiv Gupta507de852008-06-09 10:47:41 +00001502 }
Mike Stump1eb44332009-09-09 15:08:12 +00001503
Jay Foadc556ef22011-04-24 10:11:03 +00001504 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001505
Devang Patelca80a5f2009-10-20 19:55:01 +00001506 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +00001507 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
Devang Patel823d8e92010-12-08 22:42:58 +00001508 SubscriptArray);
Devang Patelca80a5f2009-10-20 19:55:01 +00001509 return DbgTy;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001510}
1511
Anders Carlssona031b352009-11-06 19:19:55 +00001512llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001513 llvm::DIFile Unit) {
Anders Carlssona031b352009-11-06 19:19:55 +00001514 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
1515 Ty, Ty->getPointeeType(), Unit);
1516}
Chris Lattner9c85ba32008-11-10 06:08:34 +00001517
Douglas Gregor36b8ee62011-01-22 01:58:15 +00001518llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
1519 llvm::DIFile Unit) {
1520 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
1521 Ty, Ty->getPointeeType(), Unit);
1522}
1523
Anders Carlsson20f12a22009-12-06 18:00:51 +00001524llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001525 llvm::DIFile U) {
Anders Carlsson20f12a22009-12-06 18:00:51 +00001526 QualType PointerDiffTy = CGM.getContext().getPointerDiffType();
1527 llvm::DIType PointerDiffDITy = getOrCreateType(PointerDiffTy, U);
1528
1529 if (!Ty->getPointeeType()->isFunctionType()) {
1530 // We have a data member pointer type.
1531 return PointerDiffDITy;
1532 }
1533
1534 // We have a member function pointer type. Treat it as a struct with two
1535 // ptrdiff_t members.
1536 std::pair<uint64_t, unsigned> Info = CGM.getContext().getTypeInfo(Ty);
1537
1538 uint64_t FieldOffset = 0;
Devang Patel823d8e92010-12-08 22:42:58 +00001539 llvm::Value *ElementTypes[2];
Anders Carlsson20f12a22009-12-06 18:00:51 +00001540
Eric Christopher3e078812012-08-04 00:11:20 +00001541 // FIXME: This should be a DW_TAG_pointer_to_member type.
Anders Carlsson20f12a22009-12-06 18:00:51 +00001542 ElementTypes[0] =
Devang Patel1d323e02011-06-24 22:00:59 +00001543 DBuilder.createMemberType(U, "ptr", U, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001544 Info.first, Info.second, FieldOffset, 0,
1545 PointerDiffDITy);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001546 FieldOffset += Info.first;
1547
1548 ElementTypes[1] =
Devang Patel1d323e02011-06-24 22:00:59 +00001549 DBuilder.createMemberType(U, "ptr", U, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001550 Info.first, Info.second, FieldOffset, 0,
1551 PointerDiffDITy);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001552
Jay Foadc556ef22011-04-24 10:11:03 +00001553 llvm::DIArray Elements = DBuilder.getOrCreateArray(ElementTypes);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001554
Chris Lattner5f9e2722011-07-23 10:55:15 +00001555 return DBuilder.createStructType(U, StringRef("test"),
Devang Patel823d8e92010-12-08 22:42:58 +00001556 U, 0, FieldOffset,
1557 0, 0, Elements);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001558}
1559
Eli Friedmanb001de72011-10-06 23:00:33 +00001560llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
1561 llvm::DIFile U) {
1562 // Ignore the atomic wrapping
1563 // FIXME: What is the correct representation?
1564 return getOrCreateType(Ty->getValueType(), U);
1565}
1566
Devang Patel6237cea2010-08-23 22:07:25 +00001567/// CreateEnumType - get enumeration type.
Devang Patel31f7d022011-01-17 22:23:07 +00001568llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001569 SmallVector<llvm::Value *, 16> Enumerators;
Devang Patel6237cea2010-08-23 22:07:25 +00001570
1571 // Create DIEnumerator elements for each enumerator.
1572 for (EnumDecl::enumerator_iterator
1573 Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1574 Enum != EnumEnd; ++Enum) {
Devang Patel823d8e92010-12-08 22:42:58 +00001575 Enumerators.push_back(
Devang Patel16674e82011-02-22 18:56:36 +00001576 DBuilder.createEnumerator(Enum->getName(),
Devang Patel823d8e92010-12-08 22:42:58 +00001577 Enum->getInitVal().getZExtValue()));
Devang Patel6237cea2010-08-23 22:07:25 +00001578 }
1579
1580 // Return a CompositeType for the enum itself.
Jay Foadc556ef22011-04-24 10:11:03 +00001581 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Devang Patel6237cea2010-08-23 22:07:25 +00001582
1583 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1584 unsigned Line = getLineNumber(ED->getLocation());
1585 uint64_t Size = 0;
Devang Patelffc52e72010-08-24 18:14:06 +00001586 uint64_t Align = 0;
1587 if (!ED->getTypeForDecl()->isIncompleteType()) {
1588 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1589 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1590 }
Devang Patel4bc48872010-10-27 23:23:58 +00001591 llvm::DIDescriptor EnumContext =
John McCall8178df32011-02-22 22:38:33 +00001592 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Eric Christopher9ee5f462012-05-23 00:09:47 +00001593 llvm::DIType ClassTy = ED->isScopedUsingClassTag() ?
1594 getOrCreateType(ED->getIntegerType(), DefUnit) : llvm::DIType();
Eric Christopher5a2eff82012-06-01 00:22:57 +00001595 unsigned Flags = !ED->isCompleteDefinition() ? llvm::DIDescriptor::FlagFwdDecl : 0;
Devang Patel6237cea2010-08-23 22:07:25 +00001596 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +00001597 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
Eric Christopher9ee5f462012-05-23 00:09:47 +00001598 Size, Align, EltArray,
Eric Christopher5a2eff82012-06-01 00:22:57 +00001599 ClassTy, Flags);
Devang Patel6237cea2010-08-23 22:07:25 +00001600 return DbgTy;
1601}
1602
Douglas Gregor840943d2009-12-21 20:18:30 +00001603static QualType UnwrapTypeForDebugInfo(QualType T) {
1604 do {
1605 QualType LastT = T;
1606 switch (T->getTypeClass()) {
1607 default:
1608 return T;
1609 case Type::TemplateSpecialization:
1610 T = cast<TemplateSpecializationType>(T)->desugar();
1611 break;
John McCallf4c73712011-01-19 06:33:43 +00001612 case Type::TypeOfExpr:
1613 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
Douglas Gregor840943d2009-12-21 20:18:30 +00001614 break;
Douglas Gregor840943d2009-12-21 20:18:30 +00001615 case Type::TypeOf:
1616 T = cast<TypeOfType>(T)->getUnderlyingType();
1617 break;
1618 case Type::Decltype:
1619 T = cast<DecltypeType>(T)->getUnderlyingType();
1620 break;
Sean Huntca63c202011-05-24 22:41:36 +00001621 case Type::UnaryTransform:
1622 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1623 break;
John McCall9d156a72011-01-06 01:58:22 +00001624 case Type::Attributed:
1625 T = cast<AttributedType>(T)->getEquivalentType();
John McCall14aa2172011-03-04 04:00:19 +00001626 break;
Abramo Bagnara465d41b2010-05-11 21:36:43 +00001627 case Type::Elaborated:
1628 T = cast<ElaboratedType>(T)->getNamedType();
Douglas Gregor840943d2009-12-21 20:18:30 +00001629 break;
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001630 case Type::Paren:
1631 T = cast<ParenType>(T)->getInnerType();
1632 break;
Eric Christopher363e5ac2012-08-07 00:14:25 +00001633 case Type::SubstTemplateTypeParm: {
1634 // We need to keep the qualifiers handy since getReplacementType()
1635 // will strip them away.
1636 unsigned Quals = T.getLocalFastQualifiers();
Douglas Gregor840943d2009-12-21 20:18:30 +00001637 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
Eric Christopher363e5ac2012-08-07 00:14:25 +00001638 T.addFastQualifiers(Quals);
1639 }
Douglas Gregor840943d2009-12-21 20:18:30 +00001640 break;
Anders Carlssonebc32792011-03-06 16:43:04 +00001641 case Type::Auto:
1642 T = cast<AutoType>(T)->getDeducedType();
1643 break;
Douglas Gregor840943d2009-12-21 20:18:30 +00001644 }
1645
1646 assert(T != LastT && "Type unwrapping failed to unwrap!");
1647 if (T == LastT)
1648 return T;
1649 } while (true);
Anders Carlsson5b6117a2009-11-14 21:08:12 +00001650}
1651
Eric Christopher973bbb62011-12-16 23:40:18 +00001652/// getType - Get the type from the cache or return null type if it doesn't exist.
1653llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
Mike Stump1eb44332009-09-09 15:08:12 +00001654
Douglas Gregor840943d2009-12-21 20:18:30 +00001655 // Unwrap the type as needed for debug information.
1656 Ty = UnwrapTypeForDebugInfo(Ty);
Eric Christopher42e75da2012-02-13 14:56:11 +00001657
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001658 // Check for existing entry.
Ted Kremenek590838b2010-03-29 18:29:57 +00001659 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001660 TypeCache.find(Ty.getAsOpaquePtr());
Daniel Dunbar65f13c32009-09-19 20:17:48 +00001661 if (it != TypeCache.end()) {
1662 // Verify that the debug info still exists.
1663 if (&*it->second)
1664 return llvm::DIType(cast<llvm::MDNode>(it->second));
1665 }
Daniel Dunbar03faac32009-09-19 19:27:14 +00001666
Eric Christopher973bbb62011-12-16 23:40:18 +00001667 return llvm::DIType();
1668}
1669
Eric Christopher9965dea2012-02-16 22:54:45 +00001670/// getCompletedTypeOrNull - Get the type from the cache or return null if it
1671/// doesn't exist.
1672llvm::DIType CGDebugInfo::getCompletedTypeOrNull(QualType Ty) {
1673
1674 // Unwrap the type as needed for debug information.
1675 Ty = UnwrapTypeForDebugInfo(Ty);
1676
1677 // Check for existing entry.
1678 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
1679 CompletedTypeCache.find(Ty.getAsOpaquePtr());
1680 if (it != CompletedTypeCache.end()) {
1681 // Verify that the debug info still exists.
1682 if (&*it->second)
1683 return llvm::DIType(cast<llvm::MDNode>(it->second));
1684 }
1685
1686 return llvm::DIType();
1687}
1688
1689
Eric Christopher973bbb62011-12-16 23:40:18 +00001690/// getOrCreateType - Get the type from the cache or create a new
1691/// one if necessary.
1692llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
1693 if (Ty.isNull())
1694 return llvm::DIType();
1695
1696 // Unwrap the type as needed for debug information.
1697 Ty = UnwrapTypeForDebugInfo(Ty);
Eric Christopher363e5ac2012-08-07 00:14:25 +00001698
Eric Christopher9965dea2012-02-16 22:54:45 +00001699 llvm::DIType T = getCompletedTypeOrNull(Ty);
1700
Eric Christopher363e5ac2012-08-07 00:14:25 +00001701 if (T.Verify())
1702 return T;
Eric Christopher973bbb62011-12-16 23:40:18 +00001703
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001704 // Otherwise create the type.
1705 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00001706
1707 llvm::DIType TC = getTypeOrNull(Ty);
1708 if (TC.Verify() && TC.isForwardDecl())
Michael J. Spencer50e3faa2012-06-08 23:47:12 +00001709 ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(),
1710 static_cast<llvm::Value*>(TC)));
Eric Christopher9965dea2012-02-16 22:54:45 +00001711
Anders Carlsson0dd57c62009-11-14 20:52:05 +00001712 // And update the type cache.
Eric Christopher9965dea2012-02-16 22:54:45 +00001713 TypeCache[Ty.getAsOpaquePtr()] = Res;
1714
1715 if (!Res.isForwardDecl())
1716 CompletedTypeCache[Ty.getAsOpaquePtr()] = Res;
Eric Christopher363e5ac2012-08-07 00:14:25 +00001717
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001718 return Res;
Daniel Dunbar03faac32009-09-19 19:27:14 +00001719}
1720
Anders Carlsson0dd57c62009-11-14 20:52:05 +00001721/// CreateTypeNode - Create a new debug type node.
Nick Lewycky7b3819d2011-11-09 04:27:23 +00001722llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
John McCalla1805292009-09-25 01:40:47 +00001723 // Handle qualifiers, which recursively handles what they refer to.
Douglas Gregora4923eb2009-11-16 21:35:15 +00001724 if (Ty.hasLocalQualifiers())
John McCalla1805292009-09-25 01:40:47 +00001725 return CreateQualifiedType(Ty, Unit);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001726
Douglas Gregor2101a822009-12-21 19:57:21 +00001727 const char *Diag = 0;
1728
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001729 // Work out details of type.
Chris Lattner9c85ba32008-11-10 06:08:34 +00001730 switch (Ty->getTypeClass()) {
Douglas Gregor72564e72009-02-26 23:50:07 +00001731#define TYPE(Class, Base)
1732#define ABSTRACT_TYPE(Class, Base)
1733#define NON_CANONICAL_TYPE(Class, Base)
1734#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1735#include "clang/AST/TypeNodes.def"
David Blaikieb219cfc2011-09-23 05:06:16 +00001736 llvm_unreachable("Dependent types cannot show up in debug information");
Argyrios Kyrtzidis1bb8a452009-08-19 01:28:17 +00001737
Anders Carlssonbfe69952009-11-06 18:24:04 +00001738 case Type::ExtVector:
Devang Patel70c23cd2010-02-23 22:59:39 +00001739 case Type::Vector:
1740 return CreateType(cast<VectorType>(Ty), Unit);
Daniel Dunbar9df4bb32009-07-14 01:20:56 +00001741 case Type::ObjCObjectPointer:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001742 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
John McCallc12c5bb2010-05-15 11:32:37 +00001743 case Type::ObjCObject:
1744 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Mike Stump1eb44332009-09-09 15:08:12 +00001745 case Type::ObjCInterface:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001746 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001747 case Type::Builtin:
1748 return CreateType(cast<BuiltinType>(Ty));
1749 case Type::Complex:
1750 return CreateType(cast<ComplexType>(Ty));
1751 case Type::Pointer:
1752 return CreateType(cast<PointerType>(Ty), Unit);
Mike Stump9bc093c2009-05-14 02:03:51 +00001753 case Type::BlockPointer:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001754 return CreateType(cast<BlockPointerType>(Ty), Unit);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001755 case Type::Typedef:
1756 return CreateType(cast<TypedefType>(Ty), Unit);
Douglas Gregor72564e72009-02-26 23:50:07 +00001757 case Type::Record:
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001758 return CreateType(cast<RecordType>(Ty));
Douglas Gregor72564e72009-02-26 23:50:07 +00001759 case Type::Enum:
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001760 return CreateEnumType(cast<EnumType>(Ty)->getDecl());
Chris Lattner9c85ba32008-11-10 06:08:34 +00001761 case Type::FunctionProto:
1762 case Type::FunctionNoProto:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001763 return CreateType(cast<FunctionType>(Ty), Unit);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001764 case Type::ConstantArray:
1765 case Type::VariableArray:
1766 case Type::IncompleteArray:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001767 return CreateType(cast<ArrayType>(Ty), Unit);
Anders Carlssona031b352009-11-06 19:19:55 +00001768
1769 case Type::LValueReference:
1770 return CreateType(cast<LValueReferenceType>(Ty), Unit);
Douglas Gregor36b8ee62011-01-22 01:58:15 +00001771 case Type::RValueReference:
1772 return CreateType(cast<RValueReferenceType>(Ty), Unit);
Anders Carlssona031b352009-11-06 19:19:55 +00001773
Anders Carlsson20f12a22009-12-06 18:00:51 +00001774 case Type::MemberPointer:
1775 return CreateType(cast<MemberPointerType>(Ty), Unit);
Douglas Gregor2101a822009-12-21 19:57:21 +00001776
Eli Friedmanb001de72011-10-06 23:00:33 +00001777 case Type::Atomic:
1778 return CreateType(cast<AtomicType>(Ty), Unit);
1779
John McCall9d156a72011-01-06 01:58:22 +00001780 case Type::Attributed:
Douglas Gregor2101a822009-12-21 19:57:21 +00001781 case Type::TemplateSpecialization:
Douglas Gregor2101a822009-12-21 19:57:21 +00001782 case Type::Elaborated:
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001783 case Type::Paren:
Douglas Gregor2101a822009-12-21 19:57:21 +00001784 case Type::SubstTemplateTypeParm:
Douglas Gregor2101a822009-12-21 19:57:21 +00001785 case Type::TypeOfExpr:
1786 case Type::TypeOf:
Douglas Gregor840943d2009-12-21 20:18:30 +00001787 case Type::Decltype:
Sean Huntca63c202011-05-24 22:41:36 +00001788 case Type::UnaryTransform:
Richard Smith34b41d92011-02-20 03:19:35 +00001789 case Type::Auto:
Douglas Gregor840943d2009-12-21 20:18:30 +00001790 llvm_unreachable("type should have been unwrapped!");
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001791 }
Douglas Gregor2101a822009-12-21 19:57:21 +00001792
1793 assert(Diag && "Fall through without a diagnostic?");
David Blaikied6471f72011-09-25 23:23:43 +00001794 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
Douglas Gregor2101a822009-12-21 19:57:21 +00001795 "debug information for %0 is not yet supported");
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +00001796 CGM.getDiags().Report(DiagID)
Douglas Gregor2101a822009-12-21 19:57:21 +00001797 << Diag;
1798 return llvm::DIType();
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001799}
1800
Eric Christopher9965dea2012-02-16 22:54:45 +00001801/// getOrCreateLimitedType - Get the type from the cache or create a new
1802/// limited type if necessary.
1803llvm::DIType CGDebugInfo::getOrCreateLimitedType(QualType Ty,
1804 llvm::DIFile Unit) {
1805 if (Ty.isNull())
1806 return llvm::DIType();
1807
1808 // Unwrap the type as needed for debug information.
1809 Ty = UnwrapTypeForDebugInfo(Ty);
1810
1811 llvm::DIType T = getTypeOrNull(Ty);
1812
1813 // We may have cached a forward decl when we could have created
1814 // a non-forward decl. Go ahead and create a non-forward decl
1815 // now.
1816 if (T.Verify() && !T.isForwardDecl()) return T;
1817
1818 // Otherwise create the type.
1819 llvm::DIType Res = CreateLimitedTypeNode(Ty, Unit);
1820
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00001821 if (T.Verify() && T.isForwardDecl())
Michael J. Spencer50e3faa2012-06-08 23:47:12 +00001822 ReplaceMap.push_back(std::make_pair(Ty.getAsOpaquePtr(),
1823 static_cast<llvm::Value*>(T)));
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00001824
Eric Christopher9965dea2012-02-16 22:54:45 +00001825 // And update the type cache.
1826 TypeCache[Ty.getAsOpaquePtr()] = Res;
1827 return Res;
1828}
1829
1830// TODO: Currently used for context chains when limiting debug info.
1831llvm::DIType CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
1832 RecordDecl *RD = Ty->getDecl();
1833
1834 // Get overall information about the record type for the debug info.
1835 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1836 unsigned Line = getLineNumber(RD->getLocation());
1837 StringRef RDName = RD->getName();
1838
1839 llvm::DIDescriptor RDContext;
Alexey Samsonov3a70cd62012-04-27 07:24:20 +00001840 if (CGM.getCodeGenOpts().DebugInfo == CodeGenOptions::LimitedDebugInfo)
Eric Christopher9965dea2012-02-16 22:54:45 +00001841 RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
1842 else
1843 RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
1844
1845 // If this is just a forward declaration, construct an appropriately
1846 // marked node and just return it.
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00001847 if (!RD->getDefinition())
1848 return createRecordFwdDecl(RD, RDContext);
Eric Christopher9965dea2012-02-16 22:54:45 +00001849
1850 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1851 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1852 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Benjamin Kramer6181e562012-03-20 19:49:14 +00001853 llvm::TrackingVH<llvm::MDNode> RealDecl;
Eric Christopher9965dea2012-02-16 22:54:45 +00001854
1855 if (RD->isUnion())
1856 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
1857 Size, Align, 0, llvm::DIArray());
1858 else if (CXXDecl) {
1859 RDName = getClassName(RD);
1860
1861 // FIXME: This could be a struct type giving a default visibility different
1862 // than C++ class type, but needs llvm metadata changes first.
1863 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
1864 Size, Align, 0, 0, llvm::DIType(),
Eric Christopher86211df2012-02-20 18:05:24 +00001865 llvm::DIArray(), llvm::DIType(),
Eric Christopher9965dea2012-02-16 22:54:45 +00001866 llvm::DIArray());
1867 } else
1868 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
1869 Size, Align, 0, llvm::DIArray());
1870
1871 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
1872 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = llvm::DIType(RealDecl);
1873
1874 if (CXXDecl) {
1875 // A class's primary base or the class itself contains the vtable.
1876 llvm::MDNode *ContainingType = NULL;
1877 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1878 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
1879 // Seek non virtual primary base root.
1880 while (1) {
1881 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
1882 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
1883 if (PBT && !BRL.isPrimaryBaseVirtual())
1884 PBase = PBT;
1885 else
1886 break;
1887 }
1888 ContainingType =
1889 getOrCreateType(QualType(PBase->getTypeForDecl(), 0), DefUnit);
1890 }
1891 else if (CXXDecl->isDynamicClass())
1892 ContainingType = RealDecl;
1893
Eric Christopher1e009d52012-02-17 07:09:48 +00001894 RealDecl->replaceOperandWith(12, ContainingType);
Eric Christopher9965dea2012-02-16 22:54:45 +00001895 }
1896 return llvm::DIType(RealDecl);
1897}
1898
1899/// CreateLimitedTypeNode - Create a new debug type node, but only forward
1900/// declare composite types that haven't been processed yet.
1901llvm::DIType CGDebugInfo::CreateLimitedTypeNode(QualType Ty,llvm::DIFile Unit) {
1902
1903 // Work out details of type.
1904 switch (Ty->getTypeClass()) {
1905#define TYPE(Class, Base)
1906#define ABSTRACT_TYPE(Class, Base)
1907#define NON_CANONICAL_TYPE(Class, Base)
1908#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1909 #include "clang/AST/TypeNodes.def"
1910 llvm_unreachable("Dependent types cannot show up in debug information");
1911
1912 case Type::Record:
1913 return CreateLimitedType(cast<RecordType>(Ty));
1914 default:
1915 return CreateTypeNode(Ty, Unit);
1916 }
1917}
1918
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001919/// CreateMemberType - Create new member and increase Offset by FType's size.
1920llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001921 StringRef Name,
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001922 uint64_t *Offset) {
1923 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
1924 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
1925 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Devang Patel1d323e02011-06-24 22:00:59 +00001926 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001927 FieldSize, FieldAlign,
1928 *Offset, 0, FieldTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001929 *Offset += FieldSize;
1930 return Ty;
1931}
1932
Devang Patel120bf322011-04-23 00:08:01 +00001933/// getFunctionDeclaration - Return debug info descriptor to describe method
1934/// declaration for the given method definition.
1935llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
1936 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
1937 if (!FD) return llvm::DISubprogram();
1938
1939 // Setup context.
1940 getContextDescriptor(cast<Decl>(D->getDeclContext()));
1941
Devang Patel22a5cdf2011-04-29 23:42:32 +00001942 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
Eric Christopherdeae6a82011-11-17 23:45:00 +00001943 MI = SPCache.find(FD->getCanonicalDecl());
Devang Patel22a5cdf2011-04-29 23:42:32 +00001944 if (MI != SPCache.end()) {
1945 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1946 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1947 return SP;
1948 }
1949
Devang Patel120bf322011-04-23 00:08:01 +00001950 for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
1951 E = FD->redecls_end(); I != E; ++I) {
1952 const FunctionDecl *NextFD = *I;
1953 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
Eric Christopherdeae6a82011-11-17 23:45:00 +00001954 MI = SPCache.find(NextFD->getCanonicalDecl());
Devang Patel120bf322011-04-23 00:08:01 +00001955 if (MI != SPCache.end()) {
1956 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1957 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1958 return SP;
1959 }
1960 }
1961 return llvm::DISubprogram();
1962}
1963
Devang Patel1c296522011-05-31 20:46:46 +00001964// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
1965// implicit parameter "this".
Eric Christopherab5278e2011-10-11 23:00:51 +00001966llvm::DIType CGDebugInfo::getOrCreateFunctionType(const Decl * D,
1967 QualType FnType,
Devang Patel1c296522011-05-31 20:46:46 +00001968 llvm::DIFile F) {
Eric Christopher363e5ac2012-08-07 00:14:25 +00001969
Devang Patel1c296522011-05-31 20:46:46 +00001970 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
1971 return getOrCreateMethodType(Method, F);
Nick Lewycky7480d962011-11-10 00:34:02 +00001972 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Devang Patelc478f212011-05-31 21:18:50 +00001973 // Add "self" and "_cmd"
Chris Lattner5f9e2722011-07-23 10:55:15 +00001974 SmallVector<llvm::Value *, 16> Elts;
Devang Patelc478f212011-05-31 21:18:50 +00001975
1976 // First element is always return type. For 'void' functions it is NULL.
Devang Pateld127bcb2011-05-31 22:21:11 +00001977 Elts.push_back(getOrCreateType(OMethod->getResultType(), F));
Devang Patelc478f212011-05-31 21:18:50 +00001978 // "self" pointer is always first argument.
1979 Elts.push_back(getOrCreateType(OMethod->getSelfDecl()->getType(), F));
1980 // "cmd" pointer is always second argument.
1981 Elts.push_back(getOrCreateType(OMethod->getCmdDecl()->getType(), F));
Devang Pateld127bcb2011-05-31 22:21:11 +00001982 // Get rest of the arguments.
Argyrios Kyrtzidis491306a2011-10-03 06:37:04 +00001983 for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
Devang Pateld127bcb2011-05-31 22:21:11 +00001984 PE = OMethod->param_end(); PI != PE; ++PI)
1985 Elts.push_back(getOrCreateType((*PI)->getType(), F));
1986
Devang Patelc478f212011-05-31 21:18:50 +00001987 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1988 return DBuilder.createSubroutineType(F, EltTypeArray);
1989 }
Devang Patel1c296522011-05-31 20:46:46 +00001990 return getOrCreateType(FnType, F);
1991}
1992
Eric Christopher451b4412012-03-20 23:28:32 +00001993/// EmitFunctionStart - Constructs the debug code for entering a function.
Devang Patel9c6c3a02010-01-14 00:36:21 +00001994void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001995 llvm::Function *Fn,
Chris Lattner9c85ba32008-11-10 06:08:34 +00001996 CGBuilderTy &Builder) {
Mike Stump1eb44332009-09-09 15:08:12 +00001997
Chris Lattner5f9e2722011-07-23 10:55:15 +00001998 StringRef Name;
1999 StringRef LinkageName;
Devang Patel9c6c3a02010-01-14 00:36:21 +00002000
Eric Christopheraa2164c2011-09-29 00:00:45 +00002001 FnBeginRegionCount.push_back(LexicalBlockStack.size());
Devang Patel5a6fbcf2010-07-22 22:29:16 +00002002
Devang Patel9c6c3a02010-01-14 00:36:21 +00002003 const Decl *D = GD.getDecl();
Eric Christopherea320472012-04-03 00:44:15 +00002004 // Use the location of the declaration.
2005 SourceLocation Loc = D->getLocation();
Eric Christopher73fb3502011-10-13 21:45:18 +00002006
Devang Patel3951e712010-10-07 22:03:49 +00002007 unsigned Flags = 0;
Eric Christopherea320472012-04-03 00:44:15 +00002008 llvm::DIFile Unit = getOrCreateFile(Loc);
Devang Patel0692f832010-10-11 21:58:41 +00002009 llvm::DIDescriptor FDContext(Unit);
Devang Patel5ecb1df2011-04-05 22:54:11 +00002010 llvm::DIArray TParamsArray;
Devang Patel9c6c3a02010-01-14 00:36:21 +00002011 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
Eric Christopherbf979472011-11-14 18:55:02 +00002012 // If there is a DISubprogram for this function available then use it.
Devang Patel4125fd22010-01-19 01:54:44 +00002013 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
Eric Christopherdeae6a82011-11-17 23:45:00 +00002014 FI = SPCache.find(FD->getCanonicalDecl());
Devang Patel4125fd22010-01-19 01:54:44 +00002015 if (FI != SPCache.end()) {
Gabor Greif38c9b172010-09-18 13:00:17 +00002016 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(&*FI->second));
Devang Patelab699792010-05-07 18:12:35 +00002017 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
2018 llvm::MDNode *SPN = SP;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002019 LexicalBlockStack.push_back(SPN);
Devang Patelab699792010-05-07 18:12:35 +00002020 RegionMap[D] = llvm::WeakVH(SP);
Devang Patel4125fd22010-01-19 01:54:44 +00002021 return;
2022 }
2023 }
Devang Patel9c6c3a02010-01-14 00:36:21 +00002024 Name = getFunctionName(FD);
2025 // Use mangled name as linkage name for c/c++ functions.
Eric Christopher43443de2012-04-12 00:35:06 +00002026 if (FD->hasPrototype()) {
Devang Patel2df74c02011-05-02 22:37:48 +00002027 LinkageName = CGM.getMangledName(GD);
Eric Christopher43443de2012-04-12 00:35:06 +00002028 Flags |= llvm::DIDescriptor::FlagPrototyped;
2029 }
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002030 if (LinkageName == Name ||
2031 CGM.getCodeGenOpts().DebugInfo <= CodeGenOptions::DebugLineTablesOnly)
Chris Lattner5f9e2722011-07-23 10:55:15 +00002032 LinkageName = StringRef();
Eric Christopher43443de2012-04-12 00:35:06 +00002033
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002034 if (CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo) {
2035 if (const NamespaceDecl *NSDecl =
2036 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
2037 FDContext = getOrCreateNameSpace(NSDecl);
2038 else if (const RecordDecl *RDecl =
2039 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
2040 FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
Devang Patel5ecb1df2011-04-05 22:54:11 +00002041
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002042 // Collect template parameters.
2043 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
2044 }
David Chisnall70b9b442010-09-02 17:16:32 +00002045 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
David Chisnall52044a22010-09-02 18:01:51 +00002046 Name = getObjCMethodName(OMD);
Devang Patel3951e712010-10-07 22:03:49 +00002047 Flags |= llvm::DIDescriptor::FlagPrototyped;
Devang Patel9c6c3a02010-01-14 00:36:21 +00002048 } else {
Devang Patel58faf202010-10-22 17:11:50 +00002049 // Use llvm function name.
Devang Patel9c6c3a02010-01-14 00:36:21 +00002050 Name = Fn->getName();
Devang Patel3951e712010-10-07 22:03:49 +00002051 Flags |= llvm::DIDescriptor::FlagPrototyped;
Devang Patel9c6c3a02010-01-14 00:36:21 +00002052 }
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002053 if (!Name.empty() && Name[0] == '\01')
2054 Name = Name.substr(1);
Mike Stump1eb44332009-09-09 15:08:12 +00002055
Eric Christopherea320472012-04-03 00:44:15 +00002056 unsigned LineNo = getLineNumber(Loc);
Devang Patele2472482010-09-29 21:05:52 +00002057 if (D->isImplicit())
2058 Flags |= llvm::DIDescriptor::FlagArtificial;
Eric Christopherea320472012-04-03 00:44:15 +00002059
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002060 llvm::DIType DIFnType;
2061 llvm::DISubprogram SPDecl;
2062 if (CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo) {
2063 DIFnType = getOrCreateFunctionType(D, FnType, Unit);
2064 SPDecl = getFunctionDeclaration(D);
2065 } else {
2066 // Create fake but valid subroutine type. Otherwise
2067 // llvm::DISubprogram::Verify() would return false, and
2068 // subprogram DIE will miss DW_AT_decl_file and
2069 // DW_AT_decl_line fields.
2070 SmallVector<llvm::Value*, 16> Elts;
2071 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
2072 DIFnType = DBuilder.createSubroutineType(Unit, EltTypeArray);
2073 }
2074 llvm::DISubprogram SP;
2075 SP = DBuilder.createFunction(FDContext, Name, LinkageName, Unit,
2076 LineNo, DIFnType,
2077 Fn->hasInternalLinkage(), true/*definition*/,
2078 getLineNumber(CurLoc), Flags,
2079 CGM.getLangOpts().Optimize,
2080 Fn, TParamsArray, SPDecl);
Mike Stump1eb44332009-09-09 15:08:12 +00002081
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00002082 // Push function on region stack.
Devang Patelab699792010-05-07 18:12:35 +00002083 llvm::MDNode *SPN = SP;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002084 LexicalBlockStack.push_back(SPN);
Devang Patelab699792010-05-07 18:12:35 +00002085 RegionMap[D] = llvm::WeakVH(SP);
Eric Christopher69a1b742011-09-29 00:00:37 +00002086}
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00002087
Eric Christopher5321bc42011-09-29 00:00:41 +00002088/// EmitLocation - Emit metadata to indicate a change in line/column
2089/// information in the source file.
Eric Christopher73fb3502011-10-13 21:45:18 +00002090void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
2091
2092 // Update our current location
2093 setLocation(Loc);
2094
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00002095 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
Mike Stump1eb44332009-09-09 15:08:12 +00002096
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00002097 // Don't bother if things are the same as last time.
Anders Carlsson20f12a22009-12-06 18:00:51 +00002098 SourceManager &SM = CGM.getContext().getSourceManager();
Eric Christopher73fb3502011-10-13 21:45:18 +00002099 if (CurLoc == PrevLoc ||
Chandler Carruth40278532011-07-25 16:49:02 +00002100 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
Devang Patel4800ea62010-04-05 21:09:15 +00002101 // New Builder may not be in sync with CGDebugInfo.
2102 if (!Builder.getCurrentDebugLocation().isUnknown())
2103 return;
Eric Christopher414ee4b2011-09-29 00:00:35 +00002104
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00002105 // Update last state.
2106 PrevLoc = CurLoc;
2107
Eric Christopheraa2164c2011-09-29 00:00:45 +00002108 llvm::MDNode *Scope = LexicalBlockStack.back();
Devang Patel8ab870d2010-05-12 23:46:38 +00002109 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(CurLoc),
2110 getColumnNumber(CurLoc),
Chris Lattnere541d012010-04-02 20:21:43 +00002111 Scope));
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00002112}
2113
Eric Christopher73fb3502011-10-13 21:45:18 +00002114/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
2115/// the stack.
2116void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Devang Patel8fae0602009-11-13 19:10:24 +00002117 llvm::DIDescriptor D =
Eric Christopher73fb3502011-10-13 21:45:18 +00002118 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
Devang Patel53bc5182012-02-08 00:10:20 +00002119 llvm::DIDescriptor() :
2120 llvm::DIDescriptor(LexicalBlockStack.back()),
2121 getOrCreateFile(CurLoc),
2122 getLineNumber(CurLoc),
2123 getColumnNumber(CurLoc));
Devang Patelab699792010-05-07 18:12:35 +00002124 llvm::MDNode *DN = D;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002125 LexicalBlockStack.push_back(DN);
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00002126}
2127
Eric Christopher73fb3502011-10-13 21:45:18 +00002128/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
2129/// region - beginning of a DW_TAG_lexical_block.
2130void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc) {
2131 // Set our current location.
2132 setLocation(Loc);
2133
2134 // Create a new lexical block and push it on the stack.
2135 CreateLexicalBlock(Loc);
2136
2137 // Emit a line table change for the current location inside the new scope.
2138 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
Devang Patel53bc5182012-02-08 00:10:20 +00002139 getColumnNumber(Loc),
2140 LexicalBlockStack.back()));
Eric Christopher73fb3502011-10-13 21:45:18 +00002141}
2142
Eric Christopheraa2164c2011-09-29 00:00:45 +00002143/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
Eric Christopher43202ae2011-09-26 15:03:22 +00002144/// region - end of a DW_TAG_lexical_block.
Eric Christopher73fb3502011-10-13 21:45:18 +00002145void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc) {
Eric Christopheraa2164c2011-09-29 00:00:45 +00002146 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Eric Christopherc852e9f2012-07-11 15:32:13 +00002147
2148 // Provide an entry in the line table for the end of the block.
2149 EmitLocation(Builder, Loc);
2150
Eric Christopheraa2164c2011-09-29 00:00:45 +00002151 LexicalBlockStack.pop_back();
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00002152}
2153
Devang Patel5a6fbcf2010-07-22 22:29:16 +00002154/// EmitFunctionEnd - Constructs the debug code for exiting a function.
2155void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
Eric Christopheraa2164c2011-09-29 00:00:45 +00002156 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Devang Patel5a6fbcf2010-07-22 22:29:16 +00002157 unsigned RCount = FnBeginRegionCount.back();
Eric Christopheraa2164c2011-09-29 00:00:45 +00002158 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
Devang Patel5a6fbcf2010-07-22 22:29:16 +00002159
2160 // Pop all regions for this function.
Eric Christopheraa2164c2011-09-29 00:00:45 +00002161 while (LexicalBlockStack.size() != RCount)
Eric Christopher73fb3502011-10-13 21:45:18 +00002162 EmitLexicalBlockEnd(Builder, CurLoc);
Devang Patel5a6fbcf2010-07-22 22:29:16 +00002163 FnBeginRegionCount.pop_back();
2164}
2165
Devang Patel809b9bb2010-02-10 18:49:08 +00002166// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
2167// See BuildByRefType.
2168llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const ValueDecl *VD,
2169 uint64_t *XOffset) {
2170
Chris Lattner5f9e2722011-07-23 10:55:15 +00002171 SmallVector<llvm::Value *, 5> EltTys;
Devang Patel809b9bb2010-02-10 18:49:08 +00002172 QualType FType;
2173 uint64_t FieldSize, FieldOffset;
2174 unsigned FieldAlign;
2175
Devang Patel17800552010-03-09 00:44:50 +00002176 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Devang Patel809b9bb2010-02-10 18:49:08 +00002177 QualType Type = VD->getType();
2178
2179 FieldOffset = 0;
2180 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002181 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
2182 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
Devang Patel809b9bb2010-02-10 18:49:08 +00002183 FType = CGM.getContext().IntTy;
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002184 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
2185 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
2186
John McCall6b5a61b2011-02-07 10:33:21 +00002187 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type);
Devang Patel809b9bb2010-02-10 18:49:08 +00002188 if (HasCopyAndDispose) {
2189 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002190 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
2191 &FieldOffset));
2192 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
2193 &FieldOffset));
Devang Patel809b9bb2010-02-10 18:49:08 +00002194 }
2195
2196 CharUnits Align = CGM.getContext().getDeclAlign(VD);
Ken Dyck573be632011-04-22 17:34:18 +00002197 if (Align > CGM.getContext().toCharUnitsFromBits(
Douglas Gregorbcfd1f52011-09-02 00:18:52 +00002198 CGM.getContext().getTargetInfo().getPointerAlign(0))) {
Ken Dyck573be632011-04-22 17:34:18 +00002199 CharUnits FieldOffsetInBytes
2200 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
2201 CharUnits AlignedOffsetInBytes
2202 = FieldOffsetInBytes.RoundUpToAlignment(Align);
2203 CharUnits NumPaddingBytes
2204 = AlignedOffsetInBytes - FieldOffsetInBytes;
Devang Patel809b9bb2010-02-10 18:49:08 +00002205
Ken Dyck573be632011-04-22 17:34:18 +00002206 if (NumPaddingBytes.isPositive()) {
2207 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
Devang Patel809b9bb2010-02-10 18:49:08 +00002208 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2209 pad, ArrayType::Normal, 0);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002210 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
Devang Patel809b9bb2010-02-10 18:49:08 +00002211 }
2212 }
2213
2214 FType = Type;
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002215 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Devang Patel809b9bb2010-02-10 18:49:08 +00002216 FieldSize = CGM.getContext().getTypeSize(FType);
Ken Dyck573be632011-04-22 17:34:18 +00002217 FieldAlign = CGM.getContext().toBits(Align);
Devang Patel809b9bb2010-02-10 18:49:08 +00002218
2219 *XOffset = FieldOffset;
Devang Patel1d323e02011-06-24 22:00:59 +00002220 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
Devang Patel823d8e92010-12-08 22:42:58 +00002221 0, FieldSize, FieldAlign,
2222 FieldOffset, 0, FieldTy);
Devang Patel809b9bb2010-02-10 18:49:08 +00002223 EltTys.push_back(FieldTy);
2224 FieldOffset += FieldSize;
2225
Jay Foadc556ef22011-04-24 10:11:03 +00002226 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Devang Patel809b9bb2010-02-10 18:49:08 +00002227
Devang Patele2472482010-09-29 21:05:52 +00002228 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Devang Patel809b9bb2010-02-10 18:49:08 +00002229
Devang Patel16674e82011-02-22 18:56:36 +00002230 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Devang Patel823d8e92010-12-08 22:42:58 +00002231 Elements);
Devang Patel809b9bb2010-02-10 18:49:08 +00002232}
Devang Patel823d8e92010-12-08 22:42:58 +00002233
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00002234/// EmitDeclare - Emit local variable declaration debug info.
Devang Patel239cec62010-02-01 21:39:52 +00002235void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Devang Patel093ac462011-03-03 20:13:15 +00002236 llvm::Value *Storage,
2237 unsigned ArgNo, CGBuilderTy &Builder) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002238 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Eric Christopheraa2164c2011-09-29 00:00:45 +00002239 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Daniel Dunbar5273f512008-10-17 01:07:56 +00002240
Devang Patel17800552010-03-09 00:44:50 +00002241 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Devang Patel809b9bb2010-02-10 18:49:08 +00002242 llvm::DIType Ty;
2243 uint64_t XOffset = 0;
2244 if (VD->hasAttr<BlocksAttr>())
2245 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2246 else
2247 Ty = getOrCreateType(VD->getType(), Unit);
Chris Lattner650cea92009-05-05 04:57:08 +00002248
Devang Patelf4e54a22010-05-07 23:05:55 +00002249 // If there is not any debug info for type then do not emit debug info
2250 // for this variable.
2251 if (!Ty)
2252 return;
2253
Devang Patel34753802011-02-16 01:11:51 +00002254 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage)) {
2255 // If Storage is an aggregate returned as 'sret' then let debugger know
2256 // about this.
Devang Patel0691f932011-02-10 00:40:52 +00002257 if (Arg->hasStructRetAttr())
Eric Christopher37e4cea2012-05-19 01:36:50 +00002258 Ty = DBuilder.createReferenceType(llvm::dwarf::DW_TAG_reference_type, Ty);
Devang Patel34753802011-02-16 01:11:51 +00002259 else if (CXXRecordDecl *Record = VD->getType()->getAsCXXRecordDecl()) {
2260 // If an aggregate variable has non trivial destructor or non trivial copy
2261 // constructor than it is pass indirectly. Let debug info know about this
2262 // by using reference of the aggregate type as a argument type.
Eric Christopherab5278e2011-10-11 23:00:51 +00002263 if (!Record->hasTrivialCopyConstructor() ||
2264 !Record->hasTrivialDestructor())
Eric Christopher37e4cea2012-05-19 01:36:50 +00002265 Ty = DBuilder.createReferenceType(llvm::dwarf::DW_TAG_reference_type, Ty);
Devang Patel34753802011-02-16 01:11:51 +00002266 }
2267 }
Devang Patel0691f932011-02-10 00:40:52 +00002268
Chris Lattner9c85ba32008-11-10 06:08:34 +00002269 // Get location information.
Devang Patel8ab870d2010-05-12 23:46:38 +00002270 unsigned Line = getLineNumber(VD->getLocation());
2271 unsigned Column = getColumnNumber(VD->getLocation());
Devang Patelaca745b2010-09-29 23:09:21 +00002272 unsigned Flags = 0;
2273 if (VD->isImplicit())
2274 Flags |= llvm::DIDescriptor::FlagArtificial;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002275 llvm::MDNode *Scope = LexicalBlockStack.back();
Devang Patelcebbedd2010-10-12 23:24:54 +00002276
Chris Lattner5f9e2722011-07-23 10:55:15 +00002277 StringRef Name = VD->getName();
Devang Patelcebbedd2010-10-12 23:24:54 +00002278 if (!Name.empty()) {
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002279 if (VD->hasAttr<BlocksAttr>()) {
2280 CharUnits offset = CharUnits::fromQuantity(32);
Chris Lattner5f9e2722011-07-23 10:55:15 +00002281 SmallVector<llvm::Value *, 9> addr;
Chris Lattner8b418682012-02-07 00:39:47 +00002282 llvm::Type *Int64Ty = CGM.Int64Ty;
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002283 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002284 // offset of __forwarding field
Ken Dyck0ebce0e2011-04-22 17:41:34 +00002285 offset = CGM.getContext().toCharUnitsFromBits(
Douglas Gregorbcfd1f52011-09-02 00:18:52 +00002286 CGM.getContext().getTargetInfo().getPointerWidth(0));
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002287 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002288 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2289 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002290 // offset of x field
Ken Dyck0ebce0e2011-04-22 17:41:34 +00002291 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002292 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2293
2294 // Create the descriptor for the variable.
2295 llvm::DIVariable D =
Devang Patel16674e82011-02-22 18:56:36 +00002296 DBuilder.createComplexVariable(Tag,
Eric Christopherab5278e2011-10-11 23:00:51 +00002297 llvm::DIDescriptor(Scope),
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002298 VD->getName(), Unit, Line, Ty,
Jay Foadc556ef22011-04-24 10:11:03 +00002299 addr, ArgNo);
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002300
2301 // Insert an llvm.dbg.declare into the current block.
2302 llvm::Instruction *Call =
Devang Patel16674e82011-02-22 18:56:36 +00002303 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002304 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2305 return;
Eric Christophera135f2c2012-05-08 18:56:47 +00002306 } else if (isa<VariableArrayType>(VD->getType())) {
2307 // These are "complex" variables in that they need an op_deref.
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002308 // Create the descriptor for the variable.
Eric Christophera135f2c2012-05-08 18:56:47 +00002309 llvm::Value *Addr = llvm::ConstantInt::get(CGM.Int64Ty,
2310 llvm::DIBuilder::OpDeref);
2311 llvm::DIVariable D =
2312 DBuilder.createComplexVariable(Tag,
2313 llvm::DIDescriptor(Scope),
2314 Name, Unit, Line, Ty,
2315 Addr, ArgNo);
2316
2317 // Insert an llvm.dbg.declare into the current block.
2318 llvm::Instruction *Call =
2319 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
2320 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2321 return;
2322 }
2323
2324 // Create the descriptor for the variable.
Devang Patelcebbedd2010-10-12 23:24:54 +00002325 llvm::DIVariable D =
Devang Patel16674e82011-02-22 18:56:36 +00002326 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Devang Patel823d8e92010-12-08 22:42:58 +00002327 Name, Unit, Line, Ty,
David Blaikie4e4d0842012-03-11 07:00:24 +00002328 CGM.getLangOpts().Optimize, Flags, ArgNo);
Devang Patelcebbedd2010-10-12 23:24:54 +00002329
2330 // Insert an llvm.dbg.declare into the current block.
2331 llvm::Instruction *Call =
Devang Patel16674e82011-02-22 18:56:36 +00002332 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
Devang Patelcebbedd2010-10-12 23:24:54 +00002333 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Devang Patelf4dd9622010-10-29 16:21:19 +00002334 return;
Devang Patelcebbedd2010-10-12 23:24:54 +00002335 }
2336
2337 // If VD is an anonymous union then Storage represents value for
2338 // all union fields.
John McCall8178df32011-02-22 22:38:33 +00002339 if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2340 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2341 if (RD->isUnion()) {
2342 for (RecordDecl::field_iterator I = RD->field_begin(),
2343 E = RD->field_end();
2344 I != E; ++I) {
David Blaikie581deb32012-06-06 20:45:41 +00002345 FieldDecl *Field = *I;
John McCall8178df32011-02-22 22:38:33 +00002346 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
Chris Lattner5f9e2722011-07-23 10:55:15 +00002347 StringRef FieldName = Field->getName();
Devang Patelcebbedd2010-10-12 23:24:54 +00002348
John McCall8178df32011-02-22 22:38:33 +00002349 // Ignore unnamed fields. Do not ignore unnamed records.
2350 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2351 continue;
Devang Patelcebbedd2010-10-12 23:24:54 +00002352
John McCall8178df32011-02-22 22:38:33 +00002353 // Use VarDecl's Tag, Scope and Line number.
2354 llvm::DIVariable D =
2355 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2356 FieldName, Unit, Line, FieldTy,
David Blaikie4e4d0842012-03-11 07:00:24 +00002357 CGM.getLangOpts().Optimize, Flags,
Devang Patel093ac462011-03-03 20:13:15 +00002358 ArgNo);
Devang Patelcebbedd2010-10-12 23:24:54 +00002359
John McCall8178df32011-02-22 22:38:33 +00002360 // Insert an llvm.dbg.declare into the current block.
2361 llvm::Instruction *Call =
2362 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
John McCall8178df32011-02-22 22:38:33 +00002363 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Devang Patelcebbedd2010-10-12 23:24:54 +00002364 }
John McCall8178df32011-02-22 22:38:33 +00002365 }
2366 }
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00002367}
2368
Devang Patele2d01912011-04-25 23:43:36 +00002369void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2370 llvm::Value *Storage,
2371 CGBuilderTy &Builder) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002372 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Devang Patele2d01912011-04-25 23:43:36 +00002373 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2374}
Mike Stumpb1a6e682009-09-30 02:43:10 +00002375
Devang Patele2d01912011-04-25 23:43:36 +00002376void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
2377 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
2378 const CGBlockInfo &blockInfo) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002379 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Eric Christopheraa2164c2011-09-29 00:00:45 +00002380 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Devang Patele2d01912011-04-25 23:43:36 +00002381
Devang Patel2b594b92010-04-26 23:28:46 +00002382 if (Builder.GetInsertBlock() == 0)
Mike Stumpb1a6e682009-09-30 02:43:10 +00002383 return;
Devang Patele2d01912011-04-25 23:43:36 +00002384
John McCall6b5a61b2011-02-07 10:33:21 +00002385 bool isByRef = VD->hasAttr<BlocksAttr>();
Devang Patele2d01912011-04-25 23:43:36 +00002386
Mike Stumpb1a6e682009-09-30 02:43:10 +00002387 uint64_t XOffset = 0;
Devang Patel17800552010-03-09 00:44:50 +00002388 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Devang Patel809b9bb2010-02-10 18:49:08 +00002389 llvm::DIType Ty;
John McCall6b5a61b2011-02-07 10:33:21 +00002390 if (isByRef)
Devang Patel809b9bb2010-02-10 18:49:08 +00002391 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2392 else
2393 Ty = getOrCreateType(VD->getType(), Unit);
Mike Stumpb1a6e682009-09-30 02:43:10 +00002394
2395 // Get location information.
Devang Patel8ab870d2010-05-12 23:46:38 +00002396 unsigned Line = getLineNumber(VD->getLocation());
2397 unsigned Column = getColumnNumber(VD->getLocation());
Mike Stumpb1a6e682009-09-30 02:43:10 +00002398
John McCall6b5a61b2011-02-07 10:33:21 +00002399 const llvm::TargetData &target = CGM.getTargetData();
2400
2401 CharUnits offset = CharUnits::fromQuantity(
2402 target.getStructLayout(blockInfo.StructureType)
2403 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2404
Chris Lattner5f9e2722011-07-23 10:55:15 +00002405 SmallVector<llvm::Value *, 9> addr;
Chris Lattner8b418682012-02-07 00:39:47 +00002406 llvm::Type *Int64Ty = CGM.Int64Ty;
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002407 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Chris Lattner14b1a362010-01-25 03:29:35 +00002408 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
John McCall6b5a61b2011-02-07 10:33:21 +00002409 if (isByRef) {
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002410 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2411 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Ken Dyck199c3d62010-01-11 17:06:35 +00002412 // offset of __forwarding field
Eric Christopherab5278e2011-10-11 23:00:51 +00002413 offset = CGM.getContext()
2414 .toCharUnitsFromBits(target.getPointerSizeInBits());
Chris Lattner14b1a362010-01-25 03:29:35 +00002415 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002416 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2417 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Ken Dyck199c3d62010-01-11 17:06:35 +00002418 // offset of x field
Ken Dyck0ebce0e2011-04-22 17:41:34 +00002419 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Chris Lattner14b1a362010-01-25 03:29:35 +00002420 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
Mike Stumpb1a6e682009-09-30 02:43:10 +00002421 }
2422
2423 // Create the descriptor for the variable.
2424 llvm::DIVariable D =
Devang Patele2d01912011-04-25 23:43:36 +00002425 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Eric Christopheraa2164c2011-09-29 00:00:45 +00002426 llvm::DIDescriptor(LexicalBlockStack.back()),
Jay Foadc556ef22011-04-24 10:11:03 +00002427 VD->getName(), Unit, Line, Ty, addr);
Mike Stumpb1a6e682009-09-30 02:43:10 +00002428 // Insert an llvm.dbg.declare into the current block.
Eric Christopher73fb3502011-10-13 21:45:18 +00002429 llvm::Instruction *Call =
Devang Patel50811d22011-04-25 23:52:27 +00002430 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
Eric Christopher73fb3502011-10-13 21:45:18 +00002431 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2432 LexicalBlockStack.back()));
Mike Stumpb1a6e682009-09-30 02:43:10 +00002433}
2434
Chris Lattner9c85ba32008-11-10 06:08:34 +00002435/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2436/// variable declaration.
Devang Pateld6c5a262010-02-01 21:52:22 +00002437void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
Devang Patel093ac462011-03-03 20:13:15 +00002438 unsigned ArgNo,
Devang Patel34753802011-02-16 01:11:51 +00002439 CGBuilderTy &Builder) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002440 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Devang Patel093ac462011-03-03 20:13:15 +00002441 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
Chris Lattner9c85ba32008-11-10 06:08:34 +00002442}
2443
John McCall8178df32011-02-22 22:38:33 +00002444namespace {
2445 struct BlockLayoutChunk {
2446 uint64_t OffsetInBits;
2447 const BlockDecl::Capture *Capture;
2448 };
2449 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2450 return l.OffsetInBits < r.OffsetInBits;
2451 }
2452}
Chris Lattner9c85ba32008-11-10 06:08:34 +00002453
John McCall8178df32011-02-22 22:38:33 +00002454void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
2455 llvm::Value *addr,
2456 CGBuilderTy &Builder) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002457 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
John McCall8178df32011-02-22 22:38:33 +00002458 ASTContext &C = CGM.getContext();
2459 const BlockDecl *blockDecl = block.getBlockDecl();
2460
2461 // Collect some general information about the block's location.
2462 SourceLocation loc = blockDecl->getCaretLocation();
2463 llvm::DIFile tunit = getOrCreateFile(loc);
2464 unsigned line = getLineNumber(loc);
2465 unsigned column = getColumnNumber(loc);
2466
2467 // Build the debug-info type for the block literal.
Nick Lewycky7d4b1592011-05-02 01:41:48 +00002468 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
John McCall8178df32011-02-22 22:38:33 +00002469
2470 const llvm::StructLayout *blockLayout =
2471 CGM.getTargetData().getStructLayout(block.StructureType);
2472
Chris Lattner5f9e2722011-07-23 10:55:15 +00002473 SmallVector<llvm::Value*, 16> fields;
John McCall8178df32011-02-22 22:38:33 +00002474 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2475 blockLayout->getElementOffsetInBits(0),
Devang Patel1d323e02011-06-24 22:00:59 +00002476 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002477 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2478 blockLayout->getElementOffsetInBits(1),
Devang Patel1d323e02011-06-24 22:00:59 +00002479 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002480 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2481 blockLayout->getElementOffsetInBits(2),
Devang Patel1d323e02011-06-24 22:00:59 +00002482 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002483 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2484 blockLayout->getElementOffsetInBits(3),
Devang Patel1d323e02011-06-24 22:00:59 +00002485 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002486 fields.push_back(createFieldType("__descriptor",
2487 C.getPointerType(block.NeedsCopyDispose ?
2488 C.getBlockDescriptorExtendedType() :
2489 C.getBlockDescriptorType()),
2490 0, loc, AS_public,
2491 blockLayout->getElementOffsetInBits(4),
Devang Patel1d323e02011-06-24 22:00:59 +00002492 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002493
2494 // We want to sort the captures by offset, not because DWARF
2495 // requires this, but because we're paranoid about debuggers.
Chris Lattner5f9e2722011-07-23 10:55:15 +00002496 SmallVector<BlockLayoutChunk, 8> chunks;
John McCall8178df32011-02-22 22:38:33 +00002497
2498 // 'this' capture.
2499 if (blockDecl->capturesCXXThis()) {
2500 BlockLayoutChunk chunk;
2501 chunk.OffsetInBits =
2502 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2503 chunk.Capture = 0;
2504 chunks.push_back(chunk);
2505 }
2506
2507 // Variable captures.
2508 for (BlockDecl::capture_const_iterator
2509 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2510 i != e; ++i) {
2511 const BlockDecl::Capture &capture = *i;
2512 const VarDecl *variable = capture.getVariable();
2513 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2514
2515 // Ignore constant captures.
2516 if (captureInfo.isConstant())
2517 continue;
2518
2519 BlockLayoutChunk chunk;
2520 chunk.OffsetInBits =
2521 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2522 chunk.Capture = &capture;
2523 chunks.push_back(chunk);
2524 }
2525
2526 // Sort by offset.
2527 llvm::array_pod_sort(chunks.begin(), chunks.end());
2528
Chris Lattner5f9e2722011-07-23 10:55:15 +00002529 for (SmallVectorImpl<BlockLayoutChunk>::iterator
John McCall8178df32011-02-22 22:38:33 +00002530 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2531 uint64_t offsetInBits = i->OffsetInBits;
2532 const BlockDecl::Capture *capture = i->Capture;
2533
2534 // If we have a null capture, this must be the C++ 'this' capture.
2535 if (!capture) {
2536 const CXXMethodDecl *method =
2537 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2538 QualType type = method->getThisType(C);
2539
2540 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
Devang Patel1d323e02011-06-24 22:00:59 +00002541 offsetInBits, tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002542 continue;
2543 }
2544
2545 const VarDecl *variable = capture->getVariable();
Chris Lattner5f9e2722011-07-23 10:55:15 +00002546 StringRef name = variable->getName();
John McCalld113a6f2011-03-02 06:57:14 +00002547
2548 llvm::DIType fieldType;
2549 if (capture->isByRef()) {
2550 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
2551
2552 // FIXME: this creates a second copy of this type!
2553 uint64_t xoffset;
2554 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
2555 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
Devang Patel1d323e02011-06-24 22:00:59 +00002556 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
John McCalld113a6f2011-03-02 06:57:14 +00002557 ptrInfo.first, ptrInfo.second,
2558 offsetInBits, 0, fieldType);
2559 } else {
2560 fieldType = createFieldType(name, variable->getType(), 0,
Devang Patel1d323e02011-06-24 22:00:59 +00002561 loc, AS_public, offsetInBits, tunit, tunit);
John McCalld113a6f2011-03-02 06:57:14 +00002562 }
2563 fields.push_back(fieldType);
John McCall8178df32011-02-22 22:38:33 +00002564 }
2565
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00002566 SmallString<36> typeName;
John McCall8178df32011-02-22 22:38:33 +00002567 llvm::raw_svector_ostream(typeName)
2568 << "__block_literal_" << CGM.getUniqueBlockCount();
2569
Jay Foadc556ef22011-04-24 10:11:03 +00002570 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
John McCall8178df32011-02-22 22:38:33 +00002571
2572 llvm::DIType type =
2573 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
2574 CGM.getContext().toBits(block.BlockSize),
2575 CGM.getContext().toBits(block.BlockAlign),
2576 0, fieldsArray);
2577 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
2578
2579 // Get overall information about the block.
2580 unsigned flags = llvm::DIDescriptor::FlagArtificial;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002581 llvm::MDNode *scope = LexicalBlockStack.back();
Chris Lattner5f9e2722011-07-23 10:55:15 +00002582 StringRef name = ".block_descriptor";
John McCall8178df32011-02-22 22:38:33 +00002583
2584 // Create the descriptor for the parameter.
2585 llvm::DIVariable debugVar =
2586 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
2587 llvm::DIDescriptor(scope),
2588 name, tunit, line, type,
David Blaikie4e4d0842012-03-11 07:00:24 +00002589 CGM.getLangOpts().Optimize, flags,
Devang Patel093ac462011-03-03 20:13:15 +00002590 cast<llvm::Argument>(addr)->getArgNo() + 1);
John McCall8178df32011-02-22 22:38:33 +00002591
2592 // Insert an llvm.dbg.value into the current block.
2593 llvm::Instruction *declare =
2594 DBuilder.insertDbgValueIntrinsic(addr, 0, debugVar,
2595 Builder.GetInsertBlock());
2596 declare->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
2597}
Chris Lattner9c85ba32008-11-10 06:08:34 +00002598
Sanjiv Gupta686226b2008-06-05 08:59:10 +00002599/// EmitGlobalVariable - Emit information about a global variable.
Mike Stump1eb44332009-09-09 15:08:12 +00002600void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Devang Pateleb6d79b2010-02-01 21:34:11 +00002601 const VarDecl *D) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002602 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Sanjiv Gupta686226b2008-06-05 08:59:10 +00002603 // Create global variable debug descriptor.
Devang Patel17800552010-03-09 00:44:50 +00002604 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
Devang Patel8ab870d2010-05-12 23:46:38 +00002605 unsigned LineNo = getLineNumber(D->getLocation());
Chris Lattner8ec03f52008-11-24 03:54:41 +00002606
Eric Christopher73fb3502011-10-13 21:45:18 +00002607 setLocation(D->getLocation());
2608
Devang Pateleb6d79b2010-02-01 21:34:11 +00002609 QualType T = D->getType();
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002610 if (T->isIncompleteArrayType()) {
Mike Stump1eb44332009-09-09 15:08:12 +00002611
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002612 // CodeGen turns int[] into int[1] so we'll do the same here.
Benjamin Kramer65263b42012-08-04 17:00:46 +00002613 llvm::APInt ConstVal(32, 1);
Anders Carlsson20f12a22009-12-06 18:00:51 +00002614 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
Mike Stump1eb44332009-09-09 15:08:12 +00002615
Anders Carlsson20f12a22009-12-06 18:00:51 +00002616 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00002617 ArrayType::Normal, 0);
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002618 }
Chris Lattner5f9e2722011-07-23 10:55:15 +00002619 StringRef DeclName = D->getName();
2620 StringRef LinkageName;
Devang Pateleb4c45b2011-02-09 19:16:38 +00002621 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
2622 && !isa<ObjCMethodDecl>(D->getDeclContext()))
Devang Patel8b90a782010-05-13 23:52:37 +00002623 LinkageName = Var->getName();
Devang Patel58faf202010-10-22 17:11:50 +00002624 if (LinkageName == DeclName)
Chris Lattner5f9e2722011-07-23 10:55:15 +00002625 LinkageName = StringRef();
Devang Pateleb6d79b2010-02-01 21:34:11 +00002626 llvm::DIDescriptor DContext =
Devang Patel170cef32010-12-09 00:33:05 +00002627 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
Devang Patel16674e82011-02-22 18:56:36 +00002628 DBuilder.createStaticVariable(DContext, DeclName, LinkageName,
Devang Patel823d8e92010-12-08 22:42:58 +00002629 Unit, LineNo, getOrCreateType(T, Unit),
2630 Var->hasInternalLinkage(), Var);
Sanjiv Gupta686226b2008-06-05 08:59:10 +00002631}
2632
Devang Patel9ca36b62009-02-26 21:10:26 +00002633/// EmitGlobalVariable - Emit information about an objective-c interface.
Mike Stump1eb44332009-09-09 15:08:12 +00002634void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Devang Pateld6c5a262010-02-01 21:52:22 +00002635 ObjCInterfaceDecl *ID) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002636 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Devang Patel9ca36b62009-02-26 21:10:26 +00002637 // Create global variable debug descriptor.
Devang Patel17800552010-03-09 00:44:50 +00002638 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
Devang Patel8ab870d2010-05-12 23:46:38 +00002639 unsigned LineNo = getLineNumber(ID->getLocation());
Devang Patel9ca36b62009-02-26 21:10:26 +00002640
Chris Lattner5f9e2722011-07-23 10:55:15 +00002641 StringRef Name = ID->getName();
Devang Patel9ca36b62009-02-26 21:10:26 +00002642
Devang Pateld6c5a262010-02-01 21:52:22 +00002643 QualType T = CGM.getContext().getObjCInterfaceType(ID);
Devang Patel9ca36b62009-02-26 21:10:26 +00002644 if (T->isIncompleteArrayType()) {
Mike Stump1eb44332009-09-09 15:08:12 +00002645
Devang Patel9ca36b62009-02-26 21:10:26 +00002646 // CodeGen turns int[] into int[1] so we'll do the same here.
Benjamin Kramer65263b42012-08-04 17:00:46 +00002647 llvm::APInt ConstVal(32, 1);
Anders Carlsson20f12a22009-12-06 18:00:51 +00002648 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
Mike Stump1eb44332009-09-09 15:08:12 +00002649
Anders Carlsson20f12a22009-12-06 18:00:51 +00002650 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
Devang Patel9ca36b62009-02-26 21:10:26 +00002651 ArrayType::Normal, 0);
2652 }
2653
Devang Patel16674e82011-02-22 18:56:36 +00002654 DBuilder.createGlobalVariable(Name, Unit, LineNo,
Devang Patel823d8e92010-12-08 22:42:58 +00002655 getOrCreateType(T, Unit),
2656 Var->hasInternalLinkage(), Var);
Devang Patel9ca36b62009-02-26 21:10:26 +00002657}
Devang Patelabb485f2010-02-01 19:16:32 +00002658
Devang Patel25c2c8f2010-08-10 17:53:33 +00002659/// EmitGlobalVariable - Emit global variable's debug info.
2660void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
John McCall189d6ef2010-10-09 01:34:31 +00002661 llvm::Constant *Init) {
Alexey Samsonovfd00eec2012-05-04 07:39:27 +00002662 assert(CGM.getCodeGenOpts().DebugInfo >= CodeGenOptions::LimitedDebugInfo);
Devang Patel8d308382010-08-10 07:24:25 +00002663 // Create the descriptor for the variable.
2664 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Chris Lattner5f9e2722011-07-23 10:55:15 +00002665 StringRef Name = VD->getName();
Devang Patel0317ab02010-08-10 18:27:15 +00002666 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
Devang Patel6237cea2010-08-23 22:07:25 +00002667 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
Benjamin Kramer527e6162012-06-20 18:11:18 +00002668 const EnumDecl *ED = cast<EnumDecl>(ECD->getDeclContext());
2669 assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
2670 Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
Devang Patel6237cea2010-08-23 22:07:25 +00002671 }
Devang Patel0317ab02010-08-10 18:27:15 +00002672 // Do not use DIGlobalVariable for enums.
2673 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
2674 return;
Devang Patel16674e82011-02-22 18:56:36 +00002675 DBuilder.createStaticVariable(Unit, Name, Name, Unit,
Devang Patel823d8e92010-12-08 22:42:58 +00002676 getLineNumber(VD->getLocation()),
2677 Ty, true, Init);
Devang Patel8d308382010-08-10 07:24:25 +00002678}
2679
Devang Patelabb485f2010-02-01 19:16:32 +00002680/// getOrCreateNamesSpace - Return namespace descriptor for the given
2681/// namespace decl.
2682llvm::DINameSpace
Devang Patel170cef32010-12-09 00:33:05 +00002683CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
Devang Patelabb485f2010-02-01 19:16:32 +00002684 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
2685 NameSpaceCache.find(NSDecl);
2686 if (I != NameSpaceCache.end())
2687 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
2688
Devang Patel8ab870d2010-05-12 23:46:38 +00002689 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Devang Patel8c376682010-10-28 19:12:46 +00002690 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Devang Patelabb485f2010-02-01 19:16:32 +00002691 llvm::DIDescriptor Context =
Devang Patel170cef32010-12-09 00:33:05 +00002692 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
Devang Patelabb485f2010-02-01 19:16:32 +00002693 llvm::DINameSpace NS =
Devang Patel16674e82011-02-22 18:56:36 +00002694 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Devang Patelab699792010-05-07 18:12:35 +00002695 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
Devang Patelabb485f2010-02-01 19:16:32 +00002696 return NS;
2697}
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00002698
2699void CGDebugInfo::finalize(void) {
2700 for (std::vector<std::pair<void *, llvm::WeakVH> >::const_iterator VI
2701 = ReplaceMap.begin(), VE = ReplaceMap.end(); VI != VE; ++VI) {
2702 llvm::DIType Ty, RepTy;
2703 // Verify that the debug info still exists.
2704 if (&*VI->second)
2705 Ty = llvm::DIType(cast<llvm::MDNode>(VI->second));
2706
2707 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2708 TypeCache.find(VI->first);
2709 if (it != TypeCache.end()) {
2710 // Verify that the debug info still exists.
2711 if (&*it->second)
2712 RepTy = llvm::DIType(cast<llvm::MDNode>(it->second));
2713 }
2714
Eric Christopher86211df2012-02-20 18:05:24 +00002715 if (Ty.Verify() && Ty.isForwardDecl() && RepTy.Verify()) {
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00002716 Ty.replaceAllUsesWith(RepTy);
Eric Christopher86211df2012-02-20 18:05:24 +00002717 }
Eric Christopher7ff0c5d2012-02-18 00:50:17 +00002718 }
2719 DBuilder.finalize();
2720}