blob: 6e4353e7689b834320772cf8f17ad645ebb3fd0e [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"
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000024#include "clang/Basic/SourceManager.h"
25#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 Gupta1c6a38b2008-05-25 05:15:42 +000038#include "llvm/Target/TargetMachine.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000039using namespace clang;
40using namespace clang::CodeGen;
41
Anders Carlsson20f12a22009-12-06 18:00:51 +000042CGDebugInfo::CGDebugInfo(CodeGenModule &CGM)
Devang Patel823d8e92010-12-08 22:42:58 +000043 : CGM(CGM), DBuilder(CGM.getModule()),
Dan Gohman4cac5b42010-08-20 22:02:57 +000044 BlockLiteralGenericSet(false) {
Devang Patel17800552010-03-09 00:44:50 +000045 CreateCompileUnit();
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000046}
47
Chris Lattner9c85ba32008-11-10 06:08:34 +000048CGDebugInfo::~CGDebugInfo() {
Eric Christopherab5278e2011-10-11 23:00:51 +000049 assert(LexicalBlockStack.empty() &&
50 "Region stack mismatch, stack not empty!");
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000051}
52
Chris Lattner9c85ba32008-11-10 06:08:34 +000053void CGDebugInfo::setLocation(SourceLocation Loc) {
Eric Christopher944542e2011-10-11 23:00:45 +000054 // If the new location isn't valid return.
55 if (!Loc.isValid()) return;
56
57 CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
Eric Christopher73fb3502011-10-13 21:45:18 +000058
59 // If we've changed files in the middle of a lexical scope go ahead
60 // and create a new lexical scope with file node if it's different
61 // from the one in the scope.
62 if (LexicalBlockStack.empty()) return;
63
64 SourceManager &SM = CGM.getContext().getSourceManager();
65 PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
66 PresumedLoc PPLoc = SM.getPresumedLoc(PrevLoc);
67
68 if (PCLoc.isInvalid() || PPLoc.isInvalid() ||
69 !strcmp(PPLoc.getFilename(), PCLoc.getFilename()))
70 return;
71
72 llvm::MDNode *LB = LexicalBlockStack.back();
73 llvm::DIScope Scope = llvm::DIScope(LB);
74 if (Scope.isLexicalBlockFile()) {
75 llvm::DILexicalBlockFile LBF = llvm::DILexicalBlockFile(LB);
76 llvm::DIDescriptor D
77 = DBuilder.createLexicalBlockFile(LBF.getScope(),
78 getOrCreateFile(CurLoc));
79 llvm::MDNode *N = D;
80 LexicalBlockStack.pop_back();
81 LexicalBlockStack.push_back(N);
82 } else if (Scope.isLexicalBlock()) {
83 llvm::DIDescriptor D
84 = DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc));
85 llvm::MDNode *N = D;
86 LexicalBlockStack.pop_back();
87 LexicalBlockStack.push_back(N);
88 }
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000089}
90
Devang Patel33583052010-01-28 23:15:27 +000091/// getContextDescriptor - Get context info for the decl.
Devang Patel170cef32010-12-09 00:33:05 +000092llvm::DIDescriptor CGDebugInfo::getContextDescriptor(const Decl *Context) {
Devang Pateleb6d79b2010-02-01 21:34:11 +000093 if (!Context)
Devang Patel170cef32010-12-09 00:33:05 +000094 return TheCU;
Devang Pateleb6d79b2010-02-01 21:34:11 +000095
96 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
97 I = RegionMap.find(Context);
98 if (I != RegionMap.end())
Gabor Greif38c9b172010-09-18 13:00:17 +000099 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(&*I->second));
Devang Patel411894b2010-02-01 22:40:08 +0000100
Devang Pateleb6d79b2010-02-01 21:34:11 +0000101 // Check namespace.
102 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
Devang Patel170cef32010-12-09 00:33:05 +0000103 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
Devang Patel8b90a782010-05-13 23:52:37 +0000104
105 if (const RecordDecl *RDecl = dyn_cast<RecordDecl>(Context)) {
106 if (!RDecl->isDependentType()) {
Devang Patela2e57692010-10-28 17:27:32 +0000107 llvm::DIType Ty = getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
Devang Patel170cef32010-12-09 00:33:05 +0000108 getOrCreateMainFile());
Devang Patel8b90a782010-05-13 23:52:37 +0000109 return llvm::DIDescriptor(Ty);
110 }
111 }
Devang Patel170cef32010-12-09 00:33:05 +0000112 return TheCU;
Devang Patel979ec2e2009-10-06 00:35:31 +0000113}
114
Devang Patel9c6c3a02010-01-14 00:36:21 +0000115/// getFunctionName - Get function name for the given FunctionDecl. If the
116/// name is constructred on demand (e.g. C++ destructor) then the name
117/// is stored on the side.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000118StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
Devang Patel9c6c3a02010-01-14 00:36:21 +0000119 assert (FD && "Invalid FunctionDecl!");
120 IdentifierInfo *FII = FD->getIdentifier();
121 if (FII)
122 return FII->getName();
123
124 // Otherwise construct human readable name for debug info.
125 std::string NS = FD->getNameAsString();
126
127 // Copy this name on the side and use its reference.
Devang Patel89f05f82010-01-28 18:21:00 +0000128 char *StrPtr = DebugInfoNames.Allocate<char>(NS.length());
Benjamin Kramer1b627dc2010-01-23 18:16:07 +0000129 memcpy(StrPtr, NS.data(), NS.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000130 return StringRef(StrPtr, NS.length());
Devang Patel9c6c3a02010-01-14 00:36:21 +0000131}
132
Chris Lattner5f9e2722011-07-23 10:55:15 +0000133StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
David Chisnall52044a22010-09-02 18:01:51 +0000134 llvm::SmallString<256> MethodName;
135 llvm::raw_svector_ostream OS(MethodName);
136 OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
137 const DeclContext *DC = OMD->getDeclContext();
Devang Patela2e57692010-10-28 17:27:32 +0000138 if (const ObjCImplementationDecl *OID =
139 dyn_cast<const ObjCImplementationDecl>(DC)) {
David Chisnall52044a22010-09-02 18:01:51 +0000140 OS << OID->getName();
Devang Patela2e57692010-10-28 17:27:32 +0000141 } else if (const ObjCInterfaceDecl *OID =
142 dyn_cast<const ObjCInterfaceDecl>(DC)) {
Fariborz Jahanian1a4c9372010-10-18 17:51:06 +0000143 OS << OID->getName();
Devang Patela2e57692010-10-28 17:27:32 +0000144 } else if (const ObjCCategoryImplDecl *OCD =
145 dyn_cast<const ObjCCategoryImplDecl>(DC)){
David Chisnall52044a22010-09-02 18:01:51 +0000146 OS << ((NamedDecl *)OCD)->getIdentifier()->getNameStart() << '(' <<
147 OCD->getIdentifier()->getNameStart() << ')';
148 }
149 OS << ' ' << OMD->getSelector().getAsString() << ']';
150
151 char *StrPtr = DebugInfoNames.Allocate<char>(OS.tell());
152 memcpy(StrPtr, MethodName.begin(), OS.tell());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000153 return StringRef(StrPtr, OS.tell());
David Chisnall52044a22010-09-02 18:01:51 +0000154}
155
Devang Patel1f15c192011-04-18 17:30:25 +0000156/// getSelectorName - Return selector name. This is used for debugging
Devang Patel90c1eed2011-04-16 00:37:51 +0000157/// info.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000158StringRef CGDebugInfo::getSelectorName(Selector S) {
Benjamin Kramer2b5cfbc2011-10-14 18:45:16 +0000159 const std::string &SName = S.getAsString();
160 char *StrPtr = DebugInfoNames.Allocate<char>(SName.size());
161 memcpy(StrPtr, SName.data(), SName.size());
162 return StringRef(StrPtr, SName.size());
Devang Patel90c1eed2011-04-16 00:37:51 +0000163}
164
Devang Patel700a1cb2010-07-20 20:24:18 +0000165/// getClassName - Get class name including template argument list.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000166StringRef
Devang Patel700a1cb2010-07-20 20:24:18 +0000167CGDebugInfo::getClassName(RecordDecl *RD) {
168 ClassTemplateSpecializationDecl *Spec
169 = dyn_cast<ClassTemplateSpecializationDecl>(RD);
170 if (!Spec)
171 return RD->getName();
172
173 const TemplateArgument *Args;
174 unsigned NumArgs;
175 std::string Buffer;
176 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
177 const TemplateSpecializationType *TST =
178 cast<TemplateSpecializationType>(TAW->getType());
179 Args = TST->getArgs();
180 NumArgs = TST->getNumArgs();
181 } else {
182 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
Douglas Gregor910f8002010-11-07 23:05:16 +0000183 Args = TemplateArgs.data();
184 NumArgs = TemplateArgs.size();
Devang Patel700a1cb2010-07-20 20:24:18 +0000185 }
186 Buffer = RD->getIdentifier()->getNameStart();
187 PrintingPolicy Policy(CGM.getLangOptions());
188 Buffer += TemplateSpecializationType::PrintTemplateArgumentList(Args,
189 NumArgs,
190 Policy);
191
192 // Copy this name on the side and use its reference.
193 char *StrPtr = DebugInfoNames.Allocate<char>(Buffer.length());
194 memcpy(StrPtr, Buffer.data(), Buffer.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000195 return StringRef(StrPtr, Buffer.length());
Devang Patel700a1cb2010-07-20 20:24:18 +0000196}
197
Devang Patel17800552010-03-09 00:44:50 +0000198/// getOrCreateFile - Get the file debug info descriptor for the input location.
199llvm::DIFile CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
Devang Patel823d8e92010-12-08 22:42:58 +0000200 if (!Loc.isValid())
201 // If Location is not valid then use main input file.
Devang Patel16674e82011-02-22 18:56:36 +0000202 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
Devang Patel823d8e92010-12-08 22:42:58 +0000203
Anders Carlsson20f12a22009-12-06 18:00:51 +0000204 SourceManager &SM = CGM.getContext().getSourceManager();
Devang Patel17800552010-03-09 00:44:50 +0000205 PresumedLoc PLoc = SM.getPresumedLoc(Loc);
Ted Kremenek9c250392010-03-30 00:27:51 +0000206
Chris Lattner5f9e2722011-07-23 10:55:15 +0000207 if (PLoc.isInvalid() || StringRef(PLoc.getFilename()).empty())
Douglas Gregor8c457a82010-11-11 20:45:16 +0000208 // If the location is not valid then use main input file.
Devang Patel16674e82011-02-22 18:56:36 +0000209 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
Douglas Gregor8c457a82010-11-11 20:45:16 +0000210
Ted Kremenek9c250392010-03-30 00:27:51 +0000211 // Cache the results.
212 const char *fname = PLoc.getFilename();
213 llvm::DenseMap<const char *, llvm::WeakVH>::iterator it =
214 DIFileCache.find(fname);
215
216 if (it != DIFileCache.end()) {
217 // Verify that the information still exists.
218 if (&*it->second)
219 return llvm::DIFile(cast<llvm::MDNode>(it->second));
220 }
221
Devang Patel16674e82011-02-22 18:56:36 +0000222 llvm::DIFile F = DBuilder.createFile(PLoc.getFilename(), getCurrentDirname());
Ted Kremenek9c250392010-03-30 00:27:51 +0000223
Devang Patelab699792010-05-07 18:12:35 +0000224 DIFileCache[fname] = F;
Ted Kremenek9c250392010-03-30 00:27:51 +0000225 return F;
Devang Patel17800552010-03-09 00:44:50 +0000226}
Devang Patel8ab870d2010-05-12 23:46:38 +0000227
Devang Patel532105f2010-10-28 22:03:20 +0000228/// getOrCreateMainFile - Get the file info for main compile unit.
229llvm::DIFile CGDebugInfo::getOrCreateMainFile() {
Devang Patel16674e82011-02-22 18:56:36 +0000230 return DBuilder.createFile(TheCU.getFilename(), TheCU.getDirectory());
Devang Patel532105f2010-10-28 22:03:20 +0000231}
232
Devang Patel8ab870d2010-05-12 23:46:38 +0000233/// getLineNumber - Get line number for the location. If location is invalid
234/// then use current location.
235unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
Benjamin Kramerc95ff942011-10-14 18:45:06 +0000236 assert((Loc.isValid() || CurLoc.isValid()) && "Invalid current location!");
Devang Patel8ab870d2010-05-12 23:46:38 +0000237 SourceManager &SM = CGM.getContext().getSourceManager();
238 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Douglas Gregor8c457a82010-11-11 20:45:16 +0000239 return PLoc.isValid()? PLoc.getLine() : 0;
Devang Patel8ab870d2010-05-12 23:46:38 +0000240}
241
242/// getColumnNumber - Get column number for the location. If location is
243/// invalid then use current location.
244unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc) {
Benjamin Kramerc95ff942011-10-14 18:45:06 +0000245 assert((Loc.isValid() || CurLoc.isValid()) && "Invalid current location!");
Devang Patel8ab870d2010-05-12 23:46:38 +0000246 SourceManager &SM = CGM.getContext().getSourceManager();
247 PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
Douglas Gregor8c457a82010-11-11 20:45:16 +0000248 return PLoc.isValid()? PLoc.getColumn() : 0;
Devang Patel8ab870d2010-05-12 23:46:38 +0000249}
250
Chris Lattner5f9e2722011-07-23 10:55:15 +0000251StringRef CGDebugInfo::getCurrentDirname() {
Nick Lewycky7c4fd912011-10-21 02:32:14 +0000252 if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
253 return CGM.getCodeGenOpts().DebugCompilationDir;
254
Devang Patelac4d13c2010-07-27 15:17:16 +0000255 if (!CWDName.empty())
256 return CWDName;
Benjamin Kramerbcbca752011-10-14 18:45:11 +0000257 llvm::SmallString<256> CWD;
258 llvm::sys::fs::current_path(CWD);
259 char *CompDirnamePtr = DebugInfoNames.Allocate<char>(CWD.size());
260 memcpy(CompDirnamePtr, CWD.data(), CWD.size());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000261 return CWDName = StringRef(CompDirnamePtr, CWD.size());
Devang Patelac4d13c2010-07-27 15:17:16 +0000262}
263
Devang Patel17800552010-03-09 00:44:50 +0000264/// CreateCompileUnit - Create new compile unit.
265void CGDebugInfo::CreateCompileUnit() {
266
267 // Get absolute path name.
Douglas Gregorac91b4c2010-03-18 23:46:43 +0000268 SourceManager &SM = CGM.getContext().getSourceManager();
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000269 std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
270 if (MainFileName.empty())
Devang Patel22fe5852010-03-12 21:04:27 +0000271 MainFileName = "<unknown>";
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000272
Douglas Gregorf6728fc2010-03-22 21:28:29 +0000273 // The main file name provided via the "-main-file-name" option contains just
274 // the file name itself with no path information. This file name may have had
275 // a relative path, so we look into the actual file entry for the main
276 // file to determine the real absolute path for the file.
Devang Patel6e6bc392010-07-23 23:04:28 +0000277 std::string MainFileDir;
Devang Patelac4d13c2010-07-27 15:17:16 +0000278 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000279 MainFileDir = MainFile->getDir()->getName();
Devang Patelac4d13c2010-07-27 15:17:16 +0000280 if (MainFileDir != ".")
281 MainFileName = MainFileDir + "/" + MainFileName;
282 }
Douglas Gregorf7ad5002010-03-19 14:49:09 +0000283
Devang Patelac4d13c2010-07-27 15:17:16 +0000284 // Save filename string.
285 char *FilenamePtr = DebugInfoNames.Allocate<char>(MainFileName.length());
286 memcpy(FilenamePtr, MainFileName.c_str(), MainFileName.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +0000287 StringRef Filename(FilenamePtr, MainFileName.length());
Devang Patelac4d13c2010-07-27 15:17:16 +0000288
Chris Lattner515455a2009-03-25 03:28:08 +0000289 unsigned LangTag;
Devang Patel17800552010-03-09 00:44:50 +0000290 const LangOptions &LO = CGM.getLangOptions();
Chris Lattner515455a2009-03-25 03:28:08 +0000291 if (LO.CPlusPlus) {
292 if (LO.ObjC1)
293 LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
294 else
295 LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
296 } else if (LO.ObjC1) {
Devang Patel8d9aefc2009-03-24 20:35:51 +0000297 LangTag = llvm::dwarf::DW_LANG_ObjC;
Chris Lattner515455a2009-03-25 03:28:08 +0000298 } else if (LO.C99) {
Devang Patel8d9aefc2009-03-24 20:35:51 +0000299 LangTag = llvm::dwarf::DW_LANG_C99;
Chris Lattner515455a2009-03-25 03:28:08 +0000300 } else {
301 LangTag = llvm::dwarf::DW_LANG_C89;
302 }
Devang Patel446c6192009-04-17 21:06:59 +0000303
Daniel Dunbar19f19832010-08-24 17:41:09 +0000304 std::string Producer = getClangFullVersion();
Chris Lattner4c2577a2009-05-02 01:00:04 +0000305
306 // Figure out which version of the ObjC runtime we have.
307 unsigned RuntimeVers = 0;
308 if (LO.ObjC1)
309 RuntimeVers = LO.ObjCNonFragileABI ? 2 : 1;
Mike Stump1eb44332009-09-09 15:08:12 +0000310
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000311 // Create new compile unit.
Devang Patel16674e82011-02-22 18:56:36 +0000312 DBuilder.createCompileUnit(
Devang Patel58115002010-07-27 20:49:59 +0000313 LangTag, Filename, getCurrentDirname(),
Devang Patel823d8e92010-12-08 22:42:58 +0000314 Producer,
Daniel Dunbarf2d8b9f2009-12-18 02:43:17 +0000315 LO.Optimize, CGM.getCodeGenOpts().DwarfDebugFlags, RuntimeVers);
Devang Patel823d8e92010-12-08 22:42:58 +0000316 // FIXME - Eliminate TheCU.
317 TheCU = llvm::DICompileUnit(DBuilder.getCU());
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000318}
319
Devang Patel65e99f22009-02-25 01:36:11 +0000320/// CreateType - Get the Basic type from the cache or create a new
Chris Lattner9c85ba32008-11-10 06:08:34 +0000321/// one if necessary.
Devang Patelf1d1d9a2010-11-01 16:52:40 +0000322llvm::DIType CGDebugInfo::CreateType(const BuiltinType *BT) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000323 unsigned Encoding = 0;
Devang Patel05127ca2010-07-28 23:23:29 +0000324 const char *BTName = NULL;
Chris Lattner9c85ba32008-11-10 06:08:34 +0000325 switch (BT->getKind()) {
John McCalle0a22d02011-10-18 21:02:43 +0000326#define BUILTIN_TYPE(Id, SingletonId)
327#define PLACEHOLDER_TYPE(Id, SingletonId) \
328 case BuiltinType::Id:
329#include "clang/AST/BuiltinTypes.def"
Devang Patele7566cf2011-09-12 18:50:21 +0000330 case BuiltinType::Dependent:
John McCalle0a22d02011-10-18 21:02:43 +0000331 llvm_unreachable("Unexpected builtin type");
Devang Patele7566cf2011-09-12 18:50:21 +0000332 case BuiltinType::NullPtr:
Devang Patelf60dca32011-09-14 23:14:14 +0000333 return DBuilder.
334 createNullPtrType(BT->getName(CGM.getContext().getLangOptions()));
Chris Lattner9c85ba32008-11-10 06:08:34 +0000335 case BuiltinType::Void:
336 return llvm::DIType();
Devang Patelc8972c62010-07-28 01:33:15 +0000337 case BuiltinType::ObjCClass:
Devang Patel16674e82011-02-22 18:56:36 +0000338 return DBuilder.createStructType(TheCU, "objc_class",
Devang Patel823d8e92010-12-08 22:42:58 +0000339 getOrCreateMainFile(), 0, 0, 0,
340 llvm::DIDescriptor::FlagFwdDecl,
341 llvm::DIArray());
Devang Patelc8972c62010-07-28 01:33:15 +0000342 case BuiltinType::ObjCId: {
343 // typedef struct objc_class *Class;
344 // typedef struct objc_object {
345 // Class isa;
346 // } *id;
347
348 llvm::DIType OCTy =
Devang Patel16674e82011-02-22 18:56:36 +0000349 DBuilder.createStructType(TheCU, "objc_class",
Devang Patel823d8e92010-12-08 22:42:58 +0000350 getOrCreateMainFile(), 0, 0, 0,
351 llvm::DIDescriptor::FlagFwdDecl,
352 llvm::DIArray());
Devang Patelc8972c62010-07-28 01:33:15 +0000353 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
354
Devang Patel16674e82011-02-22 18:56:36 +0000355 llvm::DIType ISATy = DBuilder.createPointerType(OCTy, Size);
Devang Patelc8972c62010-07-28 01:33:15 +0000356
Chris Lattner5f9e2722011-07-23 10:55:15 +0000357 SmallVector<llvm::Value *, 16> EltTys;
Devang Patelc8972c62010-07-28 01:33:15 +0000358 llvm::DIType FieldTy =
Devang Patel1d323e02011-06-24 22:00:59 +0000359 DBuilder.createMemberType(getOrCreateMainFile(), "isa",
360 getOrCreateMainFile(), 0, Size,
361 0, 0, 0, ISATy);
Devang Patelc8972c62010-07-28 01:33:15 +0000362 EltTys.push_back(FieldTy);
Jay Foadc556ef22011-04-24 10:11:03 +0000363 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Devang Patelc8972c62010-07-28 01:33:15 +0000364
Devang Patel16674e82011-02-22 18:56:36 +0000365 return DBuilder.createStructType(TheCU, "objc_object",
Devang Patel823d8e92010-12-08 22:42:58 +0000366 getOrCreateMainFile(),
367 0, 0, 0, 0, Elements);
Devang Patelc8972c62010-07-28 01:33:15 +0000368 }
Devang Patel6e108ce2011-02-09 03:15:05 +0000369 case BuiltinType::ObjCSel: {
Devang Patel16674e82011-02-22 18:56:36 +0000370 return DBuilder.createStructType(TheCU, "objc_selector",
Devang Patel6e108ce2011-02-09 03:15:05 +0000371 getOrCreateMainFile(), 0, 0, 0,
372 llvm::DIDescriptor::FlagFwdDecl,
373 llvm::DIArray());
374 }
Chris Lattner9c85ba32008-11-10 06:08:34 +0000375 case BuiltinType::UChar:
376 case BuiltinType::Char_U: Encoding = llvm::dwarf::DW_ATE_unsigned_char; break;
377 case BuiltinType::Char_S:
378 case BuiltinType::SChar: Encoding = llvm::dwarf::DW_ATE_signed_char; break;
Devang Patele8ee3f22011-09-12 17:11:58 +0000379 case BuiltinType::Char16:
380 case BuiltinType::Char32: Encoding = llvm::dwarf::DW_ATE_UTF; break;
Chris Lattner9c85ba32008-11-10 06:08:34 +0000381 case BuiltinType::UShort:
382 case BuiltinType::UInt:
Devang Patel31c79b42011-05-05 17:06:30 +0000383 case BuiltinType::UInt128:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000384 case BuiltinType::ULong:
Devang Patel68f76b12011-09-10 00:44:49 +0000385 case BuiltinType::WChar_U:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000386 case BuiltinType::ULongLong: Encoding = llvm::dwarf::DW_ATE_unsigned; break;
387 case BuiltinType::Short:
388 case BuiltinType::Int:
Devang Patel31c79b42011-05-05 17:06:30 +0000389 case BuiltinType::Int128:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000390 case BuiltinType::Long:
Devang Patel68f76b12011-09-10 00:44:49 +0000391 case BuiltinType::WChar_S:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000392 case BuiltinType::LongLong: Encoding = llvm::dwarf::DW_ATE_signed; break;
393 case BuiltinType::Bool: Encoding = llvm::dwarf::DW_ATE_boolean; break;
Anton Korobeynikovaa4a99b2011-10-14 23:23:15 +0000394 case BuiltinType::Half:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000395 case BuiltinType::Float:
Devang Patel7c173cb2009-10-12 22:28:31 +0000396 case BuiltinType::LongDouble:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000397 case BuiltinType::Double: Encoding = llvm::dwarf::DW_ATE_float; break;
Mike Stump1eb44332009-09-09 15:08:12 +0000398 }
Devang Patel05127ca2010-07-28 23:23:29 +0000399
400 switch (BT->getKind()) {
401 case BuiltinType::Long: BTName = "long int"; break;
402 case BuiltinType::LongLong: BTName = "long long int"; break;
403 case BuiltinType::ULong: BTName = "long unsigned int"; break;
404 case BuiltinType::ULongLong: BTName = "long long unsigned int"; break;
405 default:
406 BTName = BT->getName(CGM.getContext().getLangOptions());
407 break;
408 }
Chris Lattner9c85ba32008-11-10 06:08:34 +0000409 // Bit size, align and offset of the type.
Anders Carlsson20f12a22009-12-06 18:00:51 +0000410 uint64_t Size = CGM.getContext().getTypeSize(BT);
411 uint64_t Align = CGM.getContext().getTypeAlign(BT);
Devang Patelca80a5f2009-10-20 19:55:01 +0000412 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +0000413 DBuilder.createBasicType(BTName, Size, Align, Encoding);
Devang Patelca80a5f2009-10-20 19:55:01 +0000414 return DbgTy;
Chris Lattner9c85ba32008-11-10 06:08:34 +0000415}
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000416
Devang Patel344ff5d2010-12-09 00:25:29 +0000417llvm::DIType CGDebugInfo::CreateType(const ComplexType *Ty) {
Chris Lattnerb7003772009-04-23 06:13:01 +0000418 // Bit size, align and offset of the type.
419 unsigned Encoding = llvm::dwarf::DW_ATE_complex_float;
420 if (Ty->isComplexIntegerType())
421 Encoding = llvm::dwarf::DW_ATE_lo_user;
Mike Stump1eb44332009-09-09 15:08:12 +0000422
Anders Carlsson20f12a22009-12-06 18:00:51 +0000423 uint64_t Size = CGM.getContext().getTypeSize(Ty);
424 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Devang Patelca80a5f2009-10-20 19:55:01 +0000425 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +0000426 DBuilder.createBasicType("complex", Size, Align, Encoding);
Devang Patel823d8e92010-12-08 22:42:58 +0000427
Devang Patelca80a5f2009-10-20 19:55:01 +0000428 return DbgTy;
Chris Lattnerb7003772009-04-23 06:13:01 +0000429}
430
John McCalla1805292009-09-25 01:40:47 +0000431/// CreateCVRType - Get the qualified type from the cache or create
Sanjiv Guptaf58c27a2008-06-07 04:46:53 +0000432/// a new one if necessary.
Devang Patel17800552010-03-09 00:44:50 +0000433llvm::DIType CGDebugInfo::CreateQualifiedType(QualType Ty, llvm::DIFile Unit) {
John McCalla1805292009-09-25 01:40:47 +0000434 QualifierCollector Qc;
435 const Type *T = Qc.strip(Ty);
436
437 // Ignore these qualifiers for now.
438 Qc.removeObjCGCAttr();
439 Qc.removeAddressSpace();
John McCallf85e1932011-06-15 23:02:42 +0000440 Qc.removeObjCLifetime();
John McCalla1805292009-09-25 01:40:47 +0000441
Chris Lattner9c85ba32008-11-10 06:08:34 +0000442 // We will create one Derived type for one qualifier and recurse to handle any
443 // additional ones.
Chris Lattner9c85ba32008-11-10 06:08:34 +0000444 unsigned Tag;
John McCalla1805292009-09-25 01:40:47 +0000445 if (Qc.hasConst()) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000446 Tag = llvm::dwarf::DW_TAG_const_type;
John McCalla1805292009-09-25 01:40:47 +0000447 Qc.removeConst();
448 } else if (Qc.hasVolatile()) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000449 Tag = llvm::dwarf::DW_TAG_volatile_type;
John McCalla1805292009-09-25 01:40:47 +0000450 Qc.removeVolatile();
451 } else if (Qc.hasRestrict()) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000452 Tag = llvm::dwarf::DW_TAG_restrict_type;
John McCalla1805292009-09-25 01:40:47 +0000453 Qc.removeRestrict();
454 } else {
455 assert(Qc.empty() && "Unknown type qualifier for debug info");
456 return getOrCreateType(QualType(T, 0), Unit);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000457 }
Mike Stump1eb44332009-09-09 15:08:12 +0000458
John McCall49f4e1c2010-12-10 11:01:00 +0000459 llvm::DIType FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
John McCalla1805292009-09-25 01:40:47 +0000460
Daniel Dunbar3845f862008-10-31 03:54:29 +0000461 // No need to fill in the Name, Line, Size, Alignment, Offset in case of
462 // CVR derived types.
Devang Patel16674e82011-02-22 18:56:36 +0000463 llvm::DIType DbgTy = DBuilder.createQualifiedType(Tag, FromTy);
Devang Patel823d8e92010-12-08 22:42:58 +0000464
Devang Patelca80a5f2009-10-20 19:55:01 +0000465 return DbgTy;
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000466}
467
Daniel Dunbar9df4bb32009-07-14 01:20:56 +0000468llvm::DIType CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000469 llvm::DIFile Unit) {
Devang Patelca80a5f2009-10-20 19:55:01 +0000470 llvm::DIType DbgTy =
Anders Carlssona031b352009-11-06 19:19:55 +0000471 CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
472 Ty->getPointeeType(), Unit);
Devang Patelca80a5f2009-10-20 19:55:01 +0000473 return DbgTy;
Daniel Dunbar9df4bb32009-07-14 01:20:56 +0000474}
475
Chris Lattner9c85ba32008-11-10 06:08:34 +0000476llvm::DIType CGDebugInfo::CreateType(const PointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000477 llvm::DIFile Unit) {
Anders Carlssona031b352009-11-06 19:19:55 +0000478 return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
479 Ty->getPointeeType(), Unit);
480}
481
Eric Christopher5d613b52012-01-25 02:06:59 +0000482// Creates a forward declaration for a RecordDecl in the given context.
483llvm::DIType CGDebugInfo::createRecordFwdDecl(const RecordDecl *RD,
484 llvm::DIDescriptor Ctx) {
485
486 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
487 unsigned Line = getLineNumber(RD->getLocation());
488 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
489
490 if (CXXDecl)
491 return DBuilder.createClassType(Ctx, RD->getName(), DefUnit,
492 Line, 0, 0, 0,
493 llvm::DIType::FlagFwdDecl,
494 llvm::DIType(), llvm::DIArray());
495 else if (RD->isStruct())
496 return DBuilder.createStructType(Ctx, RD->getName(), DefUnit,
497 Line, 0, 0, llvm::DIType::FlagFwdDecl,
498 llvm::DIArray());
499 else if (RD->isUnion())
500 return DBuilder.createUnionType(Ctx, RD->getName(), DefUnit,
501 Line, 0, 0, llvm::DIType::FlagFwdDecl,
502 llvm::DIArray());
503 else
504 llvm_unreachable("Unknown RecordDecl type!");
505}
506
Eric Christopher4ddca8a2012-01-20 22:10:15 +0000507// Walk up the context chain and create forward decls for record decls,
508// and normal descriptors for namespaces.
509llvm::DIDescriptor CGDebugInfo::createContextChain(const Decl *Context) {
510 if (!Context)
511 return TheCU;
512
513 // See if we already have the parent.
514 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator
515 I = RegionMap.find(Context);
516 if (I != RegionMap.end())
517 return llvm::DIDescriptor(dyn_cast_or_null<llvm::MDNode>(&*I->second));
518
519 // Check namespace.
520 if (const NamespaceDecl *NSDecl = dyn_cast<NamespaceDecl>(Context))
521 return llvm::DIDescriptor(getOrCreateNameSpace(NSDecl));
522
523 if (const RecordDecl *RD = dyn_cast<RecordDecl>(Context)) {
524 if (!RD->isDependentType()) {
Eric Christopher4ddca8a2012-01-20 22:10:15 +0000525 llvm::DIDescriptor FDContext =
526 createContextChain(cast<Decl>(RD->getDeclContext()));
Eric Christopher5d613b52012-01-25 02:06:59 +0000527 llvm::DIType Ty = createRecordFwdDecl(RD, FDContext);
Eric Christopher4ddca8a2012-01-20 22:10:15 +0000528
529 RegionMap[Context] = llvm::WeakVH(Ty);
530 return llvm::DIDescriptor(Ty);
531 }
532 }
533 return TheCU;
534}
535
Eric Christopheredc95922011-09-13 23:45:09 +0000536/// CreatePointeeType - Create Pointee type. If Pointee is a record
Devang Patelc69e1cf2010-09-30 19:05:55 +0000537/// then emit record's fwd if debug info size reduction is enabled.
538llvm::DIType CGDebugInfo::CreatePointeeType(QualType PointeeTy,
539 llvm::DIFile Unit) {
540 if (!CGM.getCodeGenOpts().LimitDebugInfo)
541 return getOrCreateType(PointeeTy, Unit);
Devang Patel41422512011-10-24 23:15:17 +0000542
543 // Limit debug info for the pointee type.
544
Eric Christopher973bbb62011-12-16 23:40:18 +0000545 // If we have an existing type, use that, it's still smaller than creating
546 // a new type.
547 llvm::DIType Ty = getTypeOrNull(PointeeTy);
548 if (Ty.Verify()) return Ty;
549
Devang Patel41422512011-10-24 23:15:17 +0000550 // Handle qualifiers.
551 if (PointeeTy.hasLocalQualifiers())
552 return CreateQualifiedType(PointeeTy, Unit);
553
Devang Patelc69e1cf2010-09-30 19:05:55 +0000554 if (const RecordType *RTy = dyn_cast<RecordType>(PointeeTy)) {
555 RecordDecl *RD = RTy->getDecl();
Devang Patelc69e1cf2010-09-30 19:05:55 +0000556 llvm::DIDescriptor FDContext =
John McCall8178df32011-02-22 22:38:33 +0000557 getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Eric Christopher5d613b52012-01-25 02:06:59 +0000558 return createRecordFwdDecl(RD, FDContext);
Devang Patelc69e1cf2010-09-30 19:05:55 +0000559 }
560 return getOrCreateType(PointeeTy, Unit);
561
562}
563
Anders Carlssona031b352009-11-06 19:19:55 +0000564llvm::DIType CGDebugInfo::CreatePointerLikeType(unsigned Tag,
565 const Type *Ty,
566 QualType PointeeTy,
Devang Patel17800552010-03-09 00:44:50 +0000567 llvm::DIFile Unit) {
Devang Patel823d8e92010-12-08 22:42:58 +0000568 if (Tag == llvm::dwarf::DW_TAG_reference_type)
Devang Patel16674e82011-02-22 18:56:36 +0000569 return DBuilder.createReferenceType(CreatePointeeType(PointeeTy, Unit));
Devang Patel823d8e92010-12-08 22:42:58 +0000570
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000571 // Bit size, align and offset of the type.
Anders Carlssona031b352009-11-06 19:19:55 +0000572 // Size is always the size of a pointer. We can't use getTypeSize here
573 // because that does not return the correct value for references.
Peter Collingbourne207f4d82011-03-18 22:38:29 +0000574 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000575 uint64_t Size = CGM.getContext().getTargetInfo().getPointerWidth(AS);
Anders Carlsson20f12a22009-12-06 18:00:51 +0000576 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Mike Stump1eb44332009-09-09 15:08:12 +0000577
Nick Lewycky7480d962011-11-10 00:34:02 +0000578 return DBuilder.createPointerType(CreatePointeeType(PointeeTy, Unit),
579 Size, Align);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000580}
581
Mike Stump9bc093c2009-05-14 02:03:51 +0000582llvm::DIType CGDebugInfo::CreateType(const BlockPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000583 llvm::DIFile Unit) {
Mike Stump9bc093c2009-05-14 02:03:51 +0000584 if (BlockLiteralGenericSet)
585 return BlockLiteralGeneric;
586
Chris Lattner5f9e2722011-07-23 10:55:15 +0000587 SmallVector<llvm::Value *, 8> EltTys;
Mike Stump9bc093c2009-05-14 02:03:51 +0000588 llvm::DIType FieldTy;
Mike Stump9bc093c2009-05-14 02:03:51 +0000589 QualType FType;
590 uint64_t FieldSize, FieldOffset;
591 unsigned FieldAlign;
Mike Stump9bc093c2009-05-14 02:03:51 +0000592 llvm::DIArray Elements;
593 llvm::DIType EltTy, DescTy;
594
595 FieldOffset = 0;
Anders Carlsson20f12a22009-12-06 18:00:51 +0000596 FType = CGM.getContext().UnsignedLongTy;
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000597 EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
598 EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
Mike Stump9bc093c2009-05-14 02:03:51 +0000599
Jay Foadc556ef22011-04-24 10:11:03 +0000600 Elements = DBuilder.getOrCreateArray(EltTys);
Mike Stump9bc093c2009-05-14 02:03:51 +0000601 EltTys.clear();
602
Devang Patele2472482010-09-29 21:05:52 +0000603 unsigned Flags = llvm::DIDescriptor::FlagAppleBlock;
Devang Patel8ab870d2010-05-12 23:46:38 +0000604 unsigned LineNo = getLineNumber(CurLoc);
Mike Stump3d363c52009-10-02 02:30:50 +0000605
Devang Patel16674e82011-02-22 18:56:36 +0000606 EltTy = DBuilder.createStructType(Unit, "__block_descriptor",
Devang Patel823d8e92010-12-08 22:42:58 +0000607 Unit, LineNo, FieldOffset, 0,
608 Flags, Elements);
Mike Stump1eb44332009-09-09 15:08:12 +0000609
Mike Stump9bc093c2009-05-14 02:03:51 +0000610 // Bit size, align and offset of the type.
Anders Carlsson20f12a22009-12-06 18:00:51 +0000611 uint64_t Size = CGM.getContext().getTypeSize(Ty);
Mike Stump1eb44332009-09-09 15:08:12 +0000612
Devang Patel16674e82011-02-22 18:56:36 +0000613 DescTy = DBuilder.createPointerType(EltTy, Size);
Mike Stump9bc093c2009-05-14 02:03:51 +0000614
615 FieldOffset = 0;
Anders Carlsson20f12a22009-12-06 18:00:51 +0000616 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000617 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
Anders Carlsson20f12a22009-12-06 18:00:51 +0000618 FType = CGM.getContext().IntTy;
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000619 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
620 EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
Benjamin Kramerd3651cc2010-04-24 20:26:20 +0000621 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000622 EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
Mike Stump9bc093c2009-05-14 02:03:51 +0000623
Anders Carlsson20f12a22009-12-06 18:00:51 +0000624 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Mike Stump9bc093c2009-05-14 02:03:51 +0000625 FieldTy = DescTy;
Anders Carlsson20f12a22009-12-06 18:00:51 +0000626 FieldSize = CGM.getContext().getTypeSize(Ty);
627 FieldAlign = CGM.getContext().getTypeAlign(Ty);
Devang Patel1d323e02011-06-24 22:00:59 +0000628 FieldTy = DBuilder.createMemberType(Unit, "__descriptor", Unit,
Devang Patel823d8e92010-12-08 22:42:58 +0000629 LineNo, FieldSize, FieldAlign,
630 FieldOffset, 0, FieldTy);
Mike Stump9bc093c2009-05-14 02:03:51 +0000631 EltTys.push_back(FieldTy);
632
633 FieldOffset += FieldSize;
Jay Foadc556ef22011-04-24 10:11:03 +0000634 Elements = DBuilder.getOrCreateArray(EltTys);
Mike Stump9bc093c2009-05-14 02:03:51 +0000635
Devang Patel16674e82011-02-22 18:56:36 +0000636 EltTy = DBuilder.createStructType(Unit, "__block_literal_generic",
Devang Patel823d8e92010-12-08 22:42:58 +0000637 Unit, LineNo, FieldOffset, 0,
638 Flags, Elements);
Mike Stump1eb44332009-09-09 15:08:12 +0000639
Mike Stump9bc093c2009-05-14 02:03:51 +0000640 BlockLiteralGenericSet = true;
Devang Patel16674e82011-02-22 18:56:36 +0000641 BlockLiteralGeneric = DBuilder.createPointerType(EltTy, Size);
Mike Stump9bc093c2009-05-14 02:03:51 +0000642 return BlockLiteralGeneric;
643}
644
Nick Lewycky7480d962011-11-10 00:34:02 +0000645llvm::DIType CGDebugInfo::CreateType(const TypedefType *Ty, llvm::DIFile Unit) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000646 // Typedefs are derived from some other type. If we have a typedef of a
647 // typedef, make sure to emit the whole chain.
648 llvm::DIType Src = getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit);
Devang Patel823d8e92010-12-08 22:42:58 +0000649 if (!Src.Verify())
650 return llvm::DIType();
Chris Lattner9c85ba32008-11-10 06:08:34 +0000651 // We don't set size information, but do specify where the typedef was
652 // declared.
Devang Patel8ab870d2010-05-12 23:46:38 +0000653 unsigned Line = getLineNumber(Ty->getDecl()->getLocation());
Devang Patelc4903122011-06-03 17:23:47 +0000654 const TypedefNameDecl *TyDecl = Ty->getDecl();
Nick Lewycky7480d962011-11-10 00:34:02 +0000655 llvm::DIDescriptor TypedefContext =
Devang Patelc4903122011-06-03 17:23:47 +0000656 getContextDescriptor(cast<Decl>(Ty->getDecl()->getDeclContext()));
657
658 return
Nick Lewycky7480d962011-11-10 00:34:02 +0000659 DBuilder.createTypedef(Src, TyDecl->getName(), Unit, Line, TypedefContext);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000660}
661
Chris Lattner9c85ba32008-11-10 06:08:34 +0000662llvm::DIType CGDebugInfo::CreateType(const FunctionType *Ty,
Devang Patel17800552010-03-09 00:44:50 +0000663 llvm::DIFile Unit) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000664 SmallVector<llvm::Value *, 16> EltTys;
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000665
Chris Lattner9c85ba32008-11-10 06:08:34 +0000666 // Add the result type at least.
667 EltTys.push_back(getOrCreateType(Ty->getResultType(), Unit));
Mike Stump1eb44332009-09-09 15:08:12 +0000668
Chris Lattner9c85ba32008-11-10 06:08:34 +0000669 // Set up remainder of arguments if there is a prototype.
670 // FIXME: IF NOT, HOW IS THIS REPRESENTED? llvm-gcc doesn't represent '...'!
Devang Patelaf164bb2010-10-06 20:51:45 +0000671 if (isa<FunctionNoProtoType>(Ty))
Devang Patel16674e82011-02-22 18:56:36 +0000672 EltTys.push_back(DBuilder.createUnspecifiedParameter());
Devang Patelaf164bb2010-10-06 20:51:45 +0000673 else if (const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(Ty)) {
Chris Lattner9c85ba32008-11-10 06:08:34 +0000674 for (unsigned i = 0, e = FTP->getNumArgs(); i != e; ++i)
675 EltTys.push_back(getOrCreateType(FTP->getArgType(i), Unit));
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000676 }
677
Jay Foadc556ef22011-04-24 10:11:03 +0000678 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(EltTys);
Mike Stump1eb44332009-09-09 15:08:12 +0000679
Devang Patel16674e82011-02-22 18:56:36 +0000680 llvm::DIType DbgTy = DBuilder.createSubroutineType(Unit, EltTypeArray);
Devang Patelca80a5f2009-10-20 19:55:01 +0000681 return DbgTy;
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000682}
683
Eric Christopher6faa5542012-01-26 01:57:13 +0000684
685void CGDebugInfo::
686CollectRecordStaticVars(const RecordDecl *RD, llvm::DIType FwdDecl) {
687
688 for (RecordDecl::decl_iterator I = RD->decls_begin(), E = RD->decls_end();
689 I != E; ++I)
690 if (const VarDecl *V = dyn_cast<VarDecl>(*I)) {
691 if (V->getInit()) {
692 const APValue *Value = V->evaluateValue();
693 if (Value && Value->isInt()) {
694 llvm::ConstantInt *CI
695 = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
696
697 // Create the descriptor for static variable.
698 llvm::DIFile VUnit = getOrCreateFile(V->getLocation());
699 StringRef VName = V->getName();
700 llvm::DIType VTy = getOrCreateType(V->getType(), VUnit);
701 // Do not use DIGlobalVariable for enums.
702 if (VTy.getTag() != llvm::dwarf::DW_TAG_enumeration_type) {
703 DBuilder.createStaticVariable(FwdDecl, VName, VName, VUnit,
704 getLineNumber(V->getLocation()),
705 VTy, true, CI);
706 }
707 }
708 }
709 }
710}
711
Chris Lattner5f9e2722011-07-23 10:55:15 +0000712llvm::DIType CGDebugInfo::createFieldType(StringRef name,
John McCall8178df32011-02-22 22:38:33 +0000713 QualType type,
Richard Smitha6b8b2c2011-10-10 18:28:20 +0000714 uint64_t sizeInBitsOverride,
John McCall8178df32011-02-22 22:38:33 +0000715 SourceLocation loc,
716 AccessSpecifier AS,
717 uint64_t offsetInBits,
Devang Patel1d323e02011-06-24 22:00:59 +0000718 llvm::DIFile tunit,
719 llvm::DIDescriptor scope) {
John McCall8178df32011-02-22 22:38:33 +0000720 llvm::DIType debugType = getOrCreateType(type, tunit);
721
722 // Get the location for the field.
723 llvm::DIFile file = getOrCreateFile(loc);
724 unsigned line = getLineNumber(loc);
725
726 uint64_t sizeInBits = 0;
727 unsigned alignInBits = 0;
728 if (!type->isIncompleteArrayType()) {
729 llvm::tie(sizeInBits, alignInBits) = CGM.getContext().getTypeInfo(type);
730
Richard Smitha6b8b2c2011-10-10 18:28:20 +0000731 if (sizeInBitsOverride)
732 sizeInBits = sizeInBitsOverride;
John McCall8178df32011-02-22 22:38:33 +0000733 }
734
735 unsigned flags = 0;
736 if (AS == clang::AS_private)
737 flags |= llvm::DIDescriptor::FlagPrivate;
738 else if (AS == clang::AS_protected)
739 flags |= llvm::DIDescriptor::FlagProtected;
740
Devang Patel1d323e02011-06-24 22:00:59 +0000741 return DBuilder.createMemberType(scope, name, file, line, sizeInBits,
742 alignInBits, offsetInBits, flags, debugType);
John McCall8178df32011-02-22 22:38:33 +0000743}
744
Devang Patel428deb52010-01-19 00:00:59 +0000745/// CollectRecordFields - A helper function to collect debug info for
746/// record fields. This is used while creating debug info entry for a Record.
747void CGDebugInfo::
John McCall8178df32011-02-22 22:38:33 +0000748CollectRecordFields(const RecordDecl *record, llvm::DIFile tunit,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000749 SmallVectorImpl<llvm::Value *> &elements,
Devang Patel1d323e02011-06-24 22:00:59 +0000750 llvm::DIType RecordTy) {
John McCall8178df32011-02-22 22:38:33 +0000751 unsigned fieldNo = 0;
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000752 const FieldDecl *LastFD = 0;
753 bool IsMsStruct = record->hasAttr<MsStructAttr>();
754
John McCall8178df32011-02-22 22:38:33 +0000755 const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
756 for (RecordDecl::field_iterator I = record->field_begin(),
757 E = record->field_end();
758 I != E; ++I, ++fieldNo) {
759 FieldDecl *field = *I;
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000760 if (IsMsStruct) {
761 // Zero-length bitfields following non-bitfield members are ignored
Fariborz Jahanian855a8e72011-05-03 20:21:04 +0000762 if (CGM.getContext().ZeroBitfieldFollowsNonBitfield((field), LastFD)) {
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000763 --fieldNo;
764 continue;
765 }
766 LastFD = field;
767 }
Devang Patel428deb52010-01-19 00:00:59 +0000768
Chris Lattner5f9e2722011-07-23 10:55:15 +0000769 StringRef name = field->getName();
John McCall8178df32011-02-22 22:38:33 +0000770 QualType type = field->getType();
771
772 // Ignore unnamed fields unless they're anonymous structs/unions.
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000773 if (name.empty() && !type->isRecordType()) {
774 LastFD = field;
Devang Patel428deb52010-01-19 00:00:59 +0000775 continue;
Fariborz Jahanianfbc3cc62011-04-28 23:43:23 +0000776 }
Devang Patel428deb52010-01-19 00:00:59 +0000777
Richard Smitha6b8b2c2011-10-10 18:28:20 +0000778 uint64_t SizeInBitsOverride = 0;
779 if (field->isBitField()) {
780 SizeInBitsOverride = field->getBitWidthValue(CGM.getContext());
781 assert(SizeInBitsOverride && "found named 0-width bitfield");
782 }
783
John McCall8178df32011-02-22 22:38:33 +0000784 llvm::DIType fieldType
Richard Smitha6b8b2c2011-10-10 18:28:20 +0000785 = createFieldType(name, type, SizeInBitsOverride,
John McCall8178df32011-02-22 22:38:33 +0000786 field->getLocation(), field->getAccess(),
Devang Patel1d323e02011-06-24 22:00:59 +0000787 layout.getFieldOffset(fieldNo), tunit, RecordTy);
Devang Patel428deb52010-01-19 00:00:59 +0000788
John McCall8178df32011-02-22 22:38:33 +0000789 elements.push_back(fieldType);
Devang Patel428deb52010-01-19 00:00:59 +0000790 }
791}
792
Devang Patela6da1922010-01-28 00:28:01 +0000793/// getOrCreateMethodType - CXXMethodDecl's type is a FunctionType. This
794/// function type is not updated to include implicit "this" pointer. Use this
795/// routine to get a method type which includes "this" pointer.
796llvm::DIType
797CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
Devang Patel17800552010-03-09 00:44:50 +0000798 llvm::DIFile Unit) {
Douglas Gregor5f970ee2010-05-04 18:18:31 +0000799 llvm::DIType FnTy
800 = getOrCreateType(QualType(Method->getType()->getAs<FunctionProtoType>(),
801 0),
802 Unit);
Devang Pateld774d1e2010-01-28 21:43:50 +0000803
Devang Patela6da1922010-01-28 00:28:01 +0000804 // Add "this" pointer.
Devang Patelab699792010-05-07 18:12:35 +0000805 llvm::DIArray Args = llvm::DICompositeType(FnTy).getTypeArray();
Devang Patela6da1922010-01-28 00:28:01 +0000806 assert (Args.getNumElements() && "Invalid number of arguments!");
807
Chris Lattner5f9e2722011-07-23 10:55:15 +0000808 SmallVector<llvm::Value *, 16> Elts;
Devang Patela6da1922010-01-28 00:28:01 +0000809
810 // First element is always return type. For 'void' functions it is NULL.
811 Elts.push_back(Args.getElement(0));
812
Eric Christopher2121cda2011-09-14 01:10:50 +0000813 if (!Method->isStatic()) {
814 // "this" pointer is always first argument.
815 QualType ThisPtr = Method->getThisType(CGM.getContext());
Devang Patelef8857d2011-10-28 21:12:13 +0000816
817 const CXXRecordDecl *RD = Method->getParent();
818 if (isa<ClassTemplateSpecializationDecl>(RD)) {
819 // Create pointer type directly in this case.
820 const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
821 QualType PointeeTy = ThisPtrTy->getPointeeType();
822 unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
823 uint64_t Size = CGM.getContext().getTargetInfo().getPointerWidth(AS);
824 uint64_t Align = CGM.getContext().getTypeAlign(ThisPtrTy);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +0000825 llvm::DIType PointeeType = getOrCreateType(PointeeTy, Unit);
Devang Patelef8857d2011-10-28 21:12:13 +0000826 llvm::DIType ThisPtrType =
827 DBuilder.createArtificialType
828 (DBuilder.createPointerType(PointeeType, Size, Align));
829 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
830 Elts.push_back(ThisPtrType);
831 } else {
832 llvm::DIType ThisPtrType =
833 DBuilder.createArtificialType(getOrCreateType(ThisPtr, Unit));
834 TypeCache[ThisPtr.getAsOpaquePtr()] = ThisPtrType;
835 Elts.push_back(ThisPtrType);
836 }
Eric Christopher2121cda2011-09-14 01:10:50 +0000837 }
Devang Patela6da1922010-01-28 00:28:01 +0000838
839 // Copy rest of the arguments.
840 for (unsigned i = 1, e = Args.getNumElements(); i != e; ++i)
841 Elts.push_back(Args.getElement(i));
842
Jay Foadc556ef22011-04-24 10:11:03 +0000843 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
Devang Patela6da1922010-01-28 00:28:01 +0000844
Devang Patel16674e82011-02-22 18:56:36 +0000845 return DBuilder.createSubroutineType(Unit, EltTypeArray);
Devang Patela6da1922010-01-28 00:28:01 +0000846}
847
Devang Patel58faf202010-10-22 17:11:50 +0000848/// isFunctionLocalClass - Return true if CXXRecordDecl is defined
849/// inside a function.
850static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
Nick Lewycky7480d962011-11-10 00:34:02 +0000851 if (const CXXRecordDecl *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
Devang Patel58faf202010-10-22 17:11:50 +0000852 return isFunctionLocalClass(NRD);
Nick Lewycky7480d962011-11-10 00:34:02 +0000853 if (isa<FunctionDecl>(RD->getDeclContext()))
Devang Patel58faf202010-10-22 17:11:50 +0000854 return true;
855 return false;
Devang Patel58faf202010-10-22 17:11:50 +0000856}
Nick Lewyckyd4c100e2011-11-09 04:25:21 +0000857
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000858/// CreateCXXMemberFunction - A helper function to create a DISubprogram for
859/// a single member function GlobalDecl.
860llvm::DISubprogram
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000861CGDebugInfo::CreateCXXMemberFunction(const CXXMethodDecl *Method,
Devang Patel17800552010-03-09 00:44:50 +0000862 llvm::DIFile Unit,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000863 llvm::DIType RecordTy) {
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000864 bool IsCtorOrDtor =
865 isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
866
Chris Lattner5f9e2722011-07-23 10:55:15 +0000867 StringRef MethodName = getFunctionName(Method);
Devang Patela6da1922010-01-28 00:28:01 +0000868 llvm::DIType MethodTy = getOrCreateMethodType(Method, Unit);
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000869
870 // Since a single ctor/dtor corresponds to multiple functions, it doesn't
871 // make sense to give a single ctor/dtor a linkage name.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000872 StringRef MethodLinkageName;
Devang Patel58faf202010-10-22 17:11:50 +0000873 if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
Anders Carlsson9a20d552010-06-22 16:16:50 +0000874 MethodLinkageName = CGM.getMangledName(Method);
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000875
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000876 // Get the location for the method.
Devang Patel8ab870d2010-05-12 23:46:38 +0000877 llvm::DIFile MethodDefUnit = getOrCreateFile(Method->getLocation());
878 unsigned MethodLine = getLineNumber(Method->getLocation());
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000879
880 // Collect virtual method info.
881 llvm::DIType ContainingType;
882 unsigned Virtuality = 0;
883 unsigned VIndex = 0;
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000884
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000885 if (Method->isVirtual()) {
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000886 if (Method->isPure())
887 Virtuality = llvm::dwarf::DW_VIRTUALITY_pure_virtual;
888 else
889 Virtuality = llvm::dwarf::DW_VIRTUALITY_virtual;
890
891 // It doesn't make sense to give a virtual destructor a vtable index,
892 // since a single destructor has two entries in the vtable.
893 if (!isa<CXXDestructorDecl>(Method))
Peter Collingbourne1d2b3172011-09-26 01:56:30 +0000894 VIndex = CGM.getVTableContext().getMethodVTableIndex(Method);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000895 ContainingType = RecordTy;
896 }
897
Devang Patele2472482010-09-29 21:05:52 +0000898 unsigned Flags = 0;
899 if (Method->isImplicit())
900 Flags |= llvm::DIDescriptor::FlagArtificial;
Devang Patel10a7a6a2010-09-29 21:46:16 +0000901 AccessSpecifier Access = Method->getAccess();
902 if (Access == clang::AS_private)
903 Flags |= llvm::DIDescriptor::FlagPrivate;
904 else if (Access == clang::AS_protected)
905 Flags |= llvm::DIDescriptor::FlagProtected;
Devang Pateld78a0192010-10-01 23:32:17 +0000906 if (const CXXConstructorDecl *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
907 if (CXXC->isExplicit())
908 Flags |= llvm::DIDescriptor::FlagExplicit;
909 } else if (const CXXConversionDecl *CXXC =
910 dyn_cast<CXXConversionDecl>(Method)) {
911 if (CXXC->isExplicit())
912 Flags |= llvm::DIDescriptor::FlagExplicit;
913 }
Devang Patel3951e712010-10-07 22:03:49 +0000914 if (Method->hasPrototype())
915 Flags |= llvm::DIDescriptor::FlagPrototyped;
Devang Pateld78a0192010-10-01 23:32:17 +0000916
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000917 llvm::DISubprogram SP =
Nick Lewycky7803ec82011-09-01 21:49:51 +0000918 DBuilder.createMethod(RecordTy, MethodName, MethodLinkageName,
Devang Patel823d8e92010-12-08 22:42:58 +0000919 MethodDefUnit, MethodLine,
920 MethodTy, /*isLocalToUnit=*/false,
921 /* isDefinition=*/ false,
922 Virtuality, VIndex, ContainingType,
923 Flags, CGM.getLangOptions().Optimize);
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000924
Eric Christopherdeae6a82011-11-17 23:45:00 +0000925 SPCache[Method->getCanonicalDecl()] = llvm::WeakVH(SP);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000926
927 return SP;
928}
929
Devang Patel4125fd22010-01-19 01:54:44 +0000930/// CollectCXXMemberFunctions - A helper function to collect debug info for
Eric Christopher7c9b2fd2012-01-12 01:26:51 +0000931/// C++ member functions. This is used while creating debug info entry for
Devang Patel4125fd22010-01-19 01:54:44 +0000932/// a Record.
933void CGDebugInfo::
Devang Patel17800552010-03-09 00:44:50 +0000934CollectCXXMemberFunctions(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000935 SmallVectorImpl<llvm::Value *> &EltTys,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000936 llvm::DIType RecordTy) {
Devang Patel239cec62010-02-01 21:39:52 +0000937 for(CXXRecordDecl::method_iterator I = RD->method_begin(),
938 E = RD->method_end(); I != E; ++I) {
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000939 const CXXMethodDecl *Method = *I;
Anders Carlssonbea9b232010-01-26 04:40:11 +0000940
Devang Pateld5322da2010-02-09 19:09:28 +0000941 if (Method->isImplicit() && !Method->isUsed())
Anders Carlssonbea9b232010-01-26 04:40:11 +0000942 continue;
Devang Patel4125fd22010-01-19 01:54:44 +0000943
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000944 EltTys.push_back(CreateCXXMemberFunction(Method, Unit, RecordTy));
Devang Patel4125fd22010-01-19 01:54:44 +0000945 }
946}
947
Devang Patel2ed8f002010-08-27 17:47:47 +0000948/// CollectCXXFriends - A helper function to collect debug info for
949/// C++ base classes. This is used while creating debug info entry for
950/// a Record.
951void CGDebugInfo::
952CollectCXXFriends(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000953 SmallVectorImpl<llvm::Value *> &EltTys,
Devang Patel2ed8f002010-08-27 17:47:47 +0000954 llvm::DIType RecordTy) {
Eric Christopher121c67d2012-01-12 01:26:58 +0000955 for (CXXRecordDecl::friend_iterator BI = RD->friend_begin(),
Devang Patel2ed8f002010-08-27 17:47:47 +0000956 BE = RD->friend_end(); BI != BE; ++BI) {
Nick Lewycky7803ec82011-09-01 21:49:51 +0000957 if ((*BI)->isUnsupportedFriend())
958 continue;
Devang Patel823d8e92010-12-08 22:42:58 +0000959 if (TypeSourceInfo *TInfo = (*BI)->getFriendType())
Devang Patel16674e82011-02-22 18:56:36 +0000960 EltTys.push_back(DBuilder.createFriend(RecordTy,
Devang Patel823d8e92010-12-08 22:42:58 +0000961 getOrCreateType(TInfo->getType(),
962 Unit)));
Devang Patel2ed8f002010-08-27 17:47:47 +0000963 }
964}
965
Devang Patela245c5b2010-01-25 23:32:18 +0000966/// CollectCXXBases - A helper function to collect debug info for
967/// C++ base classes. This is used while creating debug info entry for
968/// a Record.
969void CGDebugInfo::
Devang Patel17800552010-03-09 00:44:50 +0000970CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000971 SmallVectorImpl<llvm::Value *> &EltTys,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000972 llvm::DIType RecordTy) {
Devang Patela245c5b2010-01-25 23:32:18 +0000973
Devang Patel239cec62010-02-01 21:39:52 +0000974 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
975 for (CXXRecordDecl::base_class_const_iterator BI = RD->bases_begin(),
976 BE = RD->bases_end(); BI != BE; ++BI) {
Devang Patelca7daed2010-01-28 21:54:15 +0000977 unsigned BFlags = 0;
Devang Patel62c117d2011-04-04 20:36:06 +0000978 uint64_t BaseOffset;
Devang Patelca7daed2010-01-28 21:54:15 +0000979
980 const CXXRecordDecl *Base =
981 cast<CXXRecordDecl>(BI->getType()->getAs<RecordType>()->getDecl());
982
983 if (BI->isVirtual()) {
Anders Carlssonbba16072010-03-11 07:15:17 +0000984 // virtual base offset offset is -ve. The code generator emits dwarf
Devang Pateld5322da2010-02-09 19:09:28 +0000985 // expression where it expects +ve number.
Ken Dyck14c65ca2011-04-07 12:37:09 +0000986 BaseOffset =
Peter Collingbourne1d2b3172011-09-26 01:56:30 +0000987 0 - CGM.getVTableContext()
988 .getVirtualBaseOffsetOffset(RD, Base).getQuantity();
Devang Patele2472482010-09-29 21:05:52 +0000989 BFlags = llvm::DIDescriptor::FlagVirtual;
Devang Patelca7daed2010-01-28 21:54:15 +0000990 } else
Devang Patel62c117d2011-04-04 20:36:06 +0000991 BaseOffset = RL.getBaseClassOffsetInBits(Base);
Ken Dyck14c65ca2011-04-07 12:37:09 +0000992 // FIXME: Inconsistent units for BaseOffset. It is in bytes when
993 // BI->isVirtual() and bits when not.
Devang Patelca7daed2010-01-28 21:54:15 +0000994
995 AccessSpecifier Access = BI->getAccessSpecifier();
996 if (Access == clang::AS_private)
Devang Patele2472482010-09-29 21:05:52 +0000997 BFlags |= llvm::DIDescriptor::FlagPrivate;
Devang Patelca7daed2010-01-28 21:54:15 +0000998 else if (Access == clang::AS_protected)
Devang Patele2472482010-09-29 21:05:52 +0000999 BFlags |= llvm::DIDescriptor::FlagProtected;
Devang Patelca7daed2010-01-28 21:54:15 +00001000
Devang Patel823d8e92010-12-08 22:42:58 +00001001 llvm::DIType DTy =
Devang Patel16674e82011-02-22 18:56:36 +00001002 DBuilder.createInheritance(RecordTy,
Devang Patel823d8e92010-12-08 22:42:58 +00001003 getOrCreateType(BI->getType(), Unit),
Devang Patel62c117d2011-04-04 20:36:06 +00001004 BaseOffset, BFlags);
Devang Patelca7daed2010-01-28 21:54:15 +00001005 EltTys.push_back(DTy);
1006 }
Devang Patela245c5b2010-01-25 23:32:18 +00001007}
1008
Devang Patel5ecb1df2011-04-05 22:54:11 +00001009/// CollectTemplateParams - A helper function to collect template parameters.
Devang Patel9c1714b2011-04-05 17:30:54 +00001010llvm::DIArray CGDebugInfo::
Devang Patel5ecb1df2011-04-05 22:54:11 +00001011CollectTemplateParams(const TemplateParameterList *TPList,
1012 const TemplateArgumentList &TAList,
1013 llvm::DIFile Unit) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001014 SmallVector<llvm::Value *, 16> TemplateParams;
Devang Patelc5ce2972011-04-05 20:15:06 +00001015 for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1016 const TemplateArgument &TA = TAList[i];
Devang Patel5ecb1df2011-04-05 22:54:11 +00001017 const NamedDecl *ND = TPList->getParam(i);
Devang Patel9c1714b2011-04-05 17:30:54 +00001018 if (TA.getKind() == TemplateArgument::Type) {
1019 llvm::DIType TTy = getOrCreateType(TA.getAsType(), Unit);
1020 llvm::DITemplateTypeParameter TTP =
Devang Patelc5ce2972011-04-05 20:15:06 +00001021 DBuilder.createTemplateTypeParameter(TheCU, ND->getName(), TTy);
Devang Patel9c1714b2011-04-05 17:30:54 +00001022 TemplateParams.push_back(TTP);
1023 } else if (TA.getKind() == TemplateArgument::Integral) {
1024 llvm::DIType TTy = getOrCreateType(TA.getIntegralType(), Unit);
Devang Patel9c1714b2011-04-05 17:30:54 +00001025 llvm::DITemplateValueParameter TVP =
Devang Patelc5ce2972011-04-05 20:15:06 +00001026 DBuilder.createTemplateValueParameter(TheCU, ND->getName(), TTy,
1027 TA.getAsIntegral()->getZExtValue());
Devang Patel9c1714b2011-04-05 17:30:54 +00001028 TemplateParams.push_back(TVP);
1029 }
1030 }
Jay Foadc556ef22011-04-24 10:11:03 +00001031 return DBuilder.getOrCreateArray(TemplateParams);
Devang Patel9c1714b2011-04-05 17:30:54 +00001032}
1033
Devang Patel5ecb1df2011-04-05 22:54:11 +00001034/// CollectFunctionTemplateParams - A helper function to collect debug
1035/// info for function template parameters.
1036llvm::DIArray CGDebugInfo::
1037CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit) {
Eric Christopherab5278e2011-10-11 23:00:51 +00001038 if (FD->getTemplatedKind() ==
1039 FunctionDecl::TK_FunctionTemplateSpecialization) {
Devang Patel5ecb1df2011-04-05 22:54:11 +00001040 const TemplateParameterList *TList =
Eric Christopherab5278e2011-10-11 23:00:51 +00001041 FD->getTemplateSpecializationInfo()->getTemplate()
1042 ->getTemplateParameters();
Devang Patel5ecb1df2011-04-05 22:54:11 +00001043 return
1044 CollectTemplateParams(TList, *FD->getTemplateSpecializationArgs(), Unit);
1045 }
1046 return llvm::DIArray();
1047}
1048
1049/// CollectCXXTemplateParams - A helper function to collect debug info for
1050/// template parameters.
1051llvm::DIArray CGDebugInfo::
1052CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TSpecial,
1053 llvm::DIFile Unit) {
1054 llvm::PointerUnion<ClassTemplateDecl *,
1055 ClassTemplatePartialSpecializationDecl *>
1056 PU = TSpecial->getSpecializedTemplateOrPartial();
1057
1058 TemplateParameterList *TPList = PU.is<ClassTemplateDecl *>() ?
1059 PU.get<ClassTemplateDecl *>()->getTemplateParameters() :
1060 PU.get<ClassTemplatePartialSpecializationDecl *>()->getTemplateParameters();
1061 const TemplateArgumentList &TAList = TSpecial->getTemplateInstantiationArgs();
1062 return CollectTemplateParams(TPList, TAList, Unit);
1063}
1064
Devang Patel4ce3f202010-01-28 18:11:52 +00001065/// getOrCreateVTablePtrType - Return debug info descriptor for vtable.
Devang Patel17800552010-03-09 00:44:50 +00001066llvm::DIType CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile Unit) {
Devang Patel0804e6e2010-03-08 20:53:17 +00001067 if (VTablePtrType.isValid())
Devang Patel4ce3f202010-01-28 18:11:52 +00001068 return VTablePtrType;
1069
1070 ASTContext &Context = CGM.getContext();
1071
1072 /* Function type */
Devang Patel823d8e92010-12-08 22:42:58 +00001073 llvm::Value *STy = getOrCreateType(Context.IntTy, Unit);
Jay Foadc556ef22011-04-24 10:11:03 +00001074 llvm::DIArray SElements = DBuilder.getOrCreateArray(STy);
Devang Patel16674e82011-02-22 18:56:36 +00001075 llvm::DIType SubTy = DBuilder.createSubroutineType(Unit, SElements);
Devang Patel4ce3f202010-01-28 18:11:52 +00001076 unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
Devang Patel16674e82011-02-22 18:56:36 +00001077 llvm::DIType vtbl_ptr_type = DBuilder.createPointerType(SubTy, Size, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001078 "__vtbl_ptr_type");
Devang Patel16674e82011-02-22 18:56:36 +00001079 VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
Devang Patel4ce3f202010-01-28 18:11:52 +00001080 return VTablePtrType;
1081}
1082
Anders Carlsson046c2942010-04-17 20:15:18 +00001083/// getVTableName - Get vtable name for the given Class.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001084StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
Eric Christopher51cb75a2012-01-25 21:47:09 +00001085 // Construct gdb compatible name name.
Devang Patel239cec62010-02-01 21:39:52 +00001086 std::string Name = "_vptr$" + RD->getNameAsString();
Devang Patel4ce3f202010-01-28 18:11:52 +00001087
1088 // Copy this name on the side and use its reference.
Devang Patel89f05f82010-01-28 18:21:00 +00001089 char *StrPtr = DebugInfoNames.Allocate<char>(Name.length());
Devang Patel4ce3f202010-01-28 18:11:52 +00001090 memcpy(StrPtr, Name.data(), Name.length());
Chris Lattner5f9e2722011-07-23 10:55:15 +00001091 return StringRef(StrPtr, Name.length());
Devang Patel4ce3f202010-01-28 18:11:52 +00001092}
1093
1094
Anders Carlsson046c2942010-04-17 20:15:18 +00001095/// CollectVTableInfo - If the C++ class has vtable info then insert appropriate
Devang Patel4ce3f202010-01-28 18:11:52 +00001096/// debug info entry in EltTys vector.
1097void CGDebugInfo::
Anders Carlsson046c2942010-04-17 20:15:18 +00001098CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile Unit,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001099 SmallVectorImpl<llvm::Value *> &EltTys) {
Devang Patel239cec62010-02-01 21:39:52 +00001100 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Devang Patel4ce3f202010-01-28 18:11:52 +00001101
1102 // If there is a primary base then it will hold vtable info.
1103 if (RL.getPrimaryBase())
1104 return;
1105
1106 // If this class is not dynamic then there is not any vtable info to collect.
Devang Patel239cec62010-02-01 21:39:52 +00001107 if (!RD->isDynamicClass())
Devang Patel4ce3f202010-01-28 18:11:52 +00001108 return;
1109
1110 unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1111 llvm::DIType VPTR
Devang Patel1d323e02011-06-24 22:00:59 +00001112 = DBuilder.createMemberType(Unit, getVTableName(RD), Unit,
Devang Patel823d8e92010-12-08 22:42:58 +00001113 0, Size, 0, 0, 0,
1114 getOrCreateVTablePtrType(Unit));
Devang Patel4ce3f202010-01-28 18:11:52 +00001115 EltTys.push_back(VPTR);
1116}
1117
Devang Patelc69e1cf2010-09-30 19:05:55 +00001118/// getOrCreateRecordType - Emit record type's standalone debug info.
1119llvm::DIType CGDebugInfo::getOrCreateRecordType(QualType RTy,
1120 SourceLocation Loc) {
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001121 llvm::DIType T = getOrCreateType(RTy, getOrCreateFile(Loc));
Devang Patel16674e82011-02-22 18:56:36 +00001122 DBuilder.retainType(T);
Devang Patelc69e1cf2010-09-30 19:05:55 +00001123 return T;
1124}
1125
Devang Patel65e99f22009-02-25 01:36:11 +00001126/// CreateType - get structure or union type.
Devang Patel31f7d022011-01-17 22:23:07 +00001127llvm::DIType CGDebugInfo::CreateType(const RecordType *Ty) {
Devang Pateld6c5a262010-02-01 21:52:22 +00001128 RecordDecl *RD = Ty->getDecl();
Devang Patel31f7d022011-01-17 22:23:07 +00001129 llvm::DIFile Unit = getOrCreateFile(RD->getLocation());
Mike Stump1eb44332009-09-09 15:08:12 +00001130
Chris Lattner9c85ba32008-11-10 06:08:34 +00001131 // Get overall information about the record type for the debug info.
Devang Patel8ab870d2010-05-12 23:46:38 +00001132 llvm::DIFile DefUnit = getOrCreateFile(RD->getLocation());
1133 unsigned Line = getLineNumber(RD->getLocation());
Eric Christopherde983d82012-01-26 02:05:28 +00001134 StringRef RDName = RD->getName();
Mike Stump1eb44332009-09-09 15:08:12 +00001135
Chris Lattner9c85ba32008-11-10 06:08:34 +00001136 // Records and classes and unions can all be recursive. To handle them, we
1137 // first generate a debug descriptor for the struct as a forward declaration.
1138 // Then (if it is a definition) we go through and get debug info for all of
1139 // its members. Finally, we create a descriptor for the complete type (which
1140 // may refer to the forward decl if the struct is recursive) and replace all
1141 // uses of the forward declaration with the final definition.
Eric Christopher4ddca8a2012-01-20 22:10:15 +00001142
Eric Christopherde983d82012-01-26 02:05:28 +00001143 llvm::DIDescriptor RDContext;
Eric Christopher4ddca8a2012-01-20 22:10:15 +00001144 if (CGM.getCodeGenOpts().LimitDebugInfo)
Eric Christopherde983d82012-01-26 02:05:28 +00001145 RDContext = createContextChain(cast<Decl>(RD->getDeclContext()));
Eric Christopher4ddca8a2012-01-20 22:10:15 +00001146 else
Eric Christopherde983d82012-01-26 02:05:28 +00001147 RDContext = getContextDescriptor(cast<Decl>(RD->getDeclContext()));
Devang Patel0b897992010-07-08 19:56:29 +00001148
1149 // If this is just a forward declaration, construct an appropriately
1150 // marked node and just return it.
1151 if (!RD->getDefinition()) {
Devang Patel823d8e92010-12-08 22:42:58 +00001152 llvm::DIType FwdDecl =
Eric Christopherde983d82012-01-26 02:05:28 +00001153 DBuilder.createStructType(RDContext, RDName,
Devang Patel823d8e92010-12-08 22:42:58 +00001154 DefUnit, Line, 0, 0,
1155 llvm::DIDescriptor::FlagFwdDecl,
1156 llvm::DIArray());
Devang Patel0b897992010-07-08 19:56:29 +00001157
1158 return FwdDecl;
1159 }
Devang Pateld0f251b2010-01-20 23:56:40 +00001160
Devang Patel16674e82011-02-22 18:56:36 +00001161 llvm::DIType FwdDecl = DBuilder.createTemporaryType(DefUnit);
Mike Stump1eb44332009-09-09 15:08:12 +00001162
Devang Patelab699792010-05-07 18:12:35 +00001163 llvm::MDNode *MN = FwdDecl;
1164 llvm::TrackingVH<llvm::MDNode> FwdDeclNode = MN;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001165 // Otherwise, insert it into the TypeCache so that recursive uses will find
1166 // it.
Devang Patelab699792010-05-07 18:12:35 +00001167 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
Devang Patele4c1ea02010-03-11 20:01:48 +00001168 // Push the struct on region stack.
Eric Christopheraa2164c2011-09-29 00:00:45 +00001169 LexicalBlockStack.push_back(FwdDeclNode);
Devang Patelab699792010-05-07 18:12:35 +00001170 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001171
1172 // Convert all the elements.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001173 SmallVector<llvm::Value *, 16> EltTys;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001174
Eric Christopher027cb302012-01-26 01:57:29 +00001175 // Collect static variables with initializers.
1176 CollectRecordStaticVars(RD, FwdDecl);
1177 CollectRecordFields(RD, Unit, EltTys, FwdDecl);
1178
1179 // Collect C++ information.
Devang Pateld6c5a262010-02-01 21:52:22 +00001180 const CXXRecordDecl *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
Eric Christopher027cb302012-01-26 01:57:29 +00001181 llvm::DIArray TParamsArray;
Devang Patel3064afe2010-01-28 21:41:35 +00001182 if (CXXDecl) {
1183 CollectCXXBases(CXXDecl, Unit, EltTys, FwdDecl);
Anders Carlsson046c2942010-04-17 20:15:18 +00001184 CollectVTableInfo(CXXDecl, Unit, EltTys);
Devang Patel4125fd22010-01-19 01:54:44 +00001185 CollectCXXMemberFunctions(CXXDecl, Unit, EltTys, FwdDecl);
Devang Patel2ed8f002010-08-27 17:47:47 +00001186 CollectCXXFriends(CXXDecl, Unit, EltTys, FwdDecl);
Devang Patel9c1714b2011-04-05 17:30:54 +00001187 if (const ClassTemplateSpecializationDecl *TSpecial
1188 = dyn_cast<ClassTemplateSpecializationDecl>(RD))
1189 TParamsArray = CollectCXXTemplateParams(TSpecial, Unit);
Devang Patel823d8e92010-12-08 22:42:58 +00001190 }
Devang Patel0ac8f312010-01-28 00:54:21 +00001191
Eric Christopheraa2164c2011-09-29 00:00:45 +00001192 LexicalBlockStack.pop_back();
Devang Patel823d8e92010-12-08 22:42:58 +00001193 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator RI =
1194 RegionMap.find(Ty->getDecl());
1195 if (RI != RegionMap.end())
1196 RegionMap.erase(RI);
1197
Devang Patel823d8e92010-12-08 22:42:58 +00001198 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1199 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Jay Foadc556ef22011-04-24 10:11:03 +00001200 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Devang Patel823d8e92010-12-08 22:42:58 +00001201 llvm::MDNode *RealDecl = NULL;
1202
Devang Patel5c5b5872011-02-28 22:32:45 +00001203 if (RD->isUnion())
Devang Patel16674e82011-02-22 18:56:36 +00001204 RealDecl = DBuilder.createUnionType(RDContext, RDName, DefUnit, Line,
Devang Patel5c5b5872011-02-28 22:32:45 +00001205 Size, Align, 0, Elements);
1206 else if (CXXDecl) {
Devang Patel823d8e92010-12-08 22:42:58 +00001207 RDName = getClassName(RD);
1208 // A class's primary base or the class itself contains the vtable.
1209 llvm::MDNode *ContainingType = NULL;
Devang Pateld6c5a262010-02-01 21:52:22 +00001210 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Devang Patel5bc794f2010-10-14 22:59:23 +00001211 if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
1212 // Seek non virtual primary base root.
1213 while (1) {
1214 const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
1215 const CXXRecordDecl *PBT = BRL.getPrimaryBase();
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001216 if (PBT && !BRL.isPrimaryBaseVirtual())
Devang Patel5bc794f2010-10-14 22:59:23 +00001217 PBase = PBT;
1218 else
1219 break;
1220 }
Devang Patel0ac8f312010-01-28 00:54:21 +00001221 ContainingType =
Devang Patelab699792010-05-07 18:12:35 +00001222 getOrCreateType(QualType(PBase->getTypeForDecl(), 0), Unit);
Devang Patel5bc794f2010-10-14 22:59:23 +00001223 }
Devang Patel0ac8f312010-01-28 00:54:21 +00001224 else if (CXXDecl->isDynamicClass())
Devang Patelab699792010-05-07 18:12:35 +00001225 ContainingType = FwdDecl;
Devang Patel9c1714b2011-04-05 17:30:54 +00001226
Eric Christopher435e1062011-12-16 23:40:14 +00001227 // FIXME: This could be a struct type giving a default visibility different
1228 // than C++ class type, but needs llvm metadata changes first.
1229 RealDecl = DBuilder.createClassType(RDContext, RDName, DefUnit, Line,
1230 Size, Align, 0, 0, llvm::DIType(),
1231 Elements, ContainingType,
1232 TParamsArray);
1233 } else
Devang Patel5c5b5872011-02-28 22:32:45 +00001234 RealDecl = DBuilder.createStructType(RDContext, RDName, DefUnit, Line,
1235 Size, Align, 0, Elements);
Mike Stump1eb44332009-09-09 15:08:12 +00001236
Chris Lattner9c85ba32008-11-10 06:08:34 +00001237 // Now that we have a real decl for the struct, replace anything using the
1238 // old decl with the new one. This will recursively update the debug info.
Dan Gohman4cac5b42010-08-20 22:02:57 +00001239 llvm::DIType(FwdDeclNode).replaceAllUsesWith(RealDecl);
Eric Christopher4ddca8a2012-01-20 22:10:15 +00001240 RegionMap[Ty->getDecl()] = llvm::WeakVH(RealDecl);
Devang Patel823d8e92010-12-08 22:42:58 +00001241 return llvm::DIType(RealDecl);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001242}
1243
John McCallc12c5bb2010-05-15 11:32:37 +00001244/// CreateType - get objective-c object type.
1245llvm::DIType CGDebugInfo::CreateType(const ObjCObjectType *Ty,
1246 llvm::DIFile Unit) {
1247 // Ignore protocols.
1248 return getOrCreateType(Ty->getBaseType(), Unit);
1249}
1250
Devang Patel9ca36b62009-02-26 21:10:26 +00001251/// CreateType - get objective-c interface type.
1252llvm::DIType CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001253 llvm::DIFile Unit) {
Devang Pateld6c5a262010-02-01 21:52:22 +00001254 ObjCInterfaceDecl *ID = Ty->getDecl();
Douglas Gregora6a28972010-11-30 06:38:09 +00001255 if (!ID)
1256 return llvm::DIType();
Devang Patel9ca36b62009-02-26 21:10:26 +00001257
1258 // Get overall information about the record type for the debug info.
Devang Patel17800552010-03-09 00:44:50 +00001259 llvm::DIFile DefUnit = getOrCreateFile(ID->getLocation());
Devang Patel8ab870d2010-05-12 23:46:38 +00001260 unsigned Line = getLineNumber(ID->getLocation());
Devang Patel17800552010-03-09 00:44:50 +00001261 unsigned RuntimeLang = TheCU.getLanguage();
Chris Lattnerac7c8142009-05-02 01:13:16 +00001262
Eric Christopherd1ab1a22011-10-06 00:31:18 +00001263 // If this is just a forward declaration return a special forward-declaration
1264 // debug type since we won't be able to lay out the entire type.
Douglas Gregor7c1f1f12011-12-15 23:32:29 +00001265 ObjCInterfaceDecl *Def = ID->getDefinition();
1266 if (!Def) {
Devang Patel823d8e92010-12-08 22:42:58 +00001267 llvm::DIType FwdDecl =
Devang Patel16674e82011-02-22 18:56:36 +00001268 DBuilder.createStructType(Unit, ID->getName(),
Eric Christopherd5a3b782011-11-29 23:57:40 +00001269 DefUnit, Line, 0, 0,
1270 llvm::DIDescriptor::FlagFwdDecl,
Devang Patel823d8e92010-12-08 22:42:58 +00001271 llvm::DIArray(), RuntimeLang);
Dan Gohman45f7c782010-08-23 21:15:56 +00001272 return FwdDecl;
1273 }
Douglas Gregor7c1f1f12011-12-15 23:32:29 +00001274 ID = Def;
Dan Gohman45f7c782010-08-23 21:15:56 +00001275
Eric Christopher1cd1d742011-10-06 00:30:52 +00001276 // To handle a recursive interface, we first generate a debug descriptor
1277 // for the struct as a forward declaration. Then (if it is a definition)
1278 // we go through and get debug info for all of its members. Finally, we
1279 // create a descriptor for the complete type (which may refer to the
1280 // forward decl if the struct is recursive) and replace all uses of the
1281 // forward declaration with the final definition.
Devang Patel16674e82011-02-22 18:56:36 +00001282 llvm::DIType FwdDecl = DBuilder.createTemporaryType(DefUnit);
Mike Stump1eb44332009-09-09 15:08:12 +00001283
Devang Patelab699792010-05-07 18:12:35 +00001284 llvm::MDNode *MN = FwdDecl;
1285 llvm::TrackingVH<llvm::MDNode> FwdDeclNode = MN;
Devang Patel9ca36b62009-02-26 21:10:26 +00001286 // Otherwise, insert it into the TypeCache so that recursive uses will find
1287 // it.
Devang Patelab699792010-05-07 18:12:35 +00001288 TypeCache[QualType(Ty, 0).getAsOpaquePtr()] = FwdDecl;
Devang Patele4c1ea02010-03-11 20:01:48 +00001289 // Push the struct on region stack.
Eric Christopheraa2164c2011-09-29 00:00:45 +00001290 LexicalBlockStack.push_back(FwdDeclNode);
Devang Patelab699792010-05-07 18:12:35 +00001291 RegionMap[Ty->getDecl()] = llvm::WeakVH(FwdDecl);
Devang Patel9ca36b62009-02-26 21:10:26 +00001292
1293 // Convert all the elements.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001294 SmallVector<llvm::Value *, 16> EltTys;
Devang Patel9ca36b62009-02-26 21:10:26 +00001295
Devang Pateld6c5a262010-02-01 21:52:22 +00001296 ObjCInterfaceDecl *SClass = ID->getSuperClass();
Devang Patelfbe899f2009-03-10 21:30:26 +00001297 if (SClass) {
Mike Stump1eb44332009-09-09 15:08:12 +00001298 llvm::DIType SClassTy =
Anders Carlsson20f12a22009-12-06 18:00:51 +00001299 getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
Douglas Gregora6a28972010-11-30 06:38:09 +00001300 if (!SClassTy.isValid())
1301 return llvm::DIType();
1302
Mike Stump1eb44332009-09-09 15:08:12 +00001303 llvm::DIType InhTag =
Devang Patel16674e82011-02-22 18:56:36 +00001304 DBuilder.createInheritance(FwdDecl, SClassTy, 0, 0);
Devang Patelfbe899f2009-03-10 21:30:26 +00001305 EltTys.push_back(InhTag);
1306 }
1307
Devang Pateld6c5a262010-02-01 21:52:22 +00001308 const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
Devang Patel8c6f9c42011-09-19 18:54:16 +00001309 ObjCImplementationDecl *ImpD = ID->getImplementation();
Devang Patel9ca36b62009-02-26 21:10:26 +00001310 unsigned FieldNo = 0;
Fariborz Jahanian97477392010-10-01 00:01:53 +00001311 for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
Fariborz Jahanianfe8fdba2010-10-11 23:55:47 +00001312 Field = Field->getNextIvar(), ++FieldNo) {
Devang Patel9ca36b62009-02-26 21:10:26 +00001313 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
Douglas Gregora6a28972010-11-30 06:38:09 +00001314 if (!FieldTy.isValid())
1315 return llvm::DIType();
1316
Chris Lattner5f9e2722011-07-23 10:55:15 +00001317 StringRef FieldName = Field->getName();
Devang Patel9ca36b62009-02-26 21:10:26 +00001318
Devang Patelde135022009-04-27 22:40:36 +00001319 // Ignore unnamed fields.
Devang Patel73621622009-11-25 17:37:31 +00001320 if (FieldName.empty())
Devang Patelde135022009-04-27 22:40:36 +00001321 continue;
1322
Devang Patel9ca36b62009-02-26 21:10:26 +00001323 // Get the location for the field.
Devang Patel8ab870d2010-05-12 23:46:38 +00001324 llvm::DIFile FieldDefUnit = getOrCreateFile(Field->getLocation());
1325 unsigned FieldLine = getLineNumber(Field->getLocation());
Devang Patel99c20eb2009-03-20 18:24:39 +00001326 QualType FType = Field->getType();
1327 uint64_t FieldSize = 0;
1328 unsigned FieldAlign = 0;
Devang Patelc20482b2009-03-19 00:23:53 +00001329
Devang Patel99c20eb2009-03-20 18:24:39 +00001330 if (!FType->isIncompleteArrayType()) {
Mike Stump1eb44332009-09-09 15:08:12 +00001331
Devang Patel99c20eb2009-03-20 18:24:39 +00001332 // Bit size, align and offset of the type.
Richard Smitha6b8b2c2011-10-10 18:28:20 +00001333 FieldSize = Field->isBitField()
1334 ? Field->getBitWidthValue(CGM.getContext())
1335 : CGM.getContext().getTypeSize(FType);
1336 FieldAlign = CGM.getContext().getTypeAlign(FType);
Devang Patel99c20eb2009-03-20 18:24:39 +00001337 }
1338
Eric Christopherd1ab1a22011-10-06 00:31:18 +00001339 // We can't know the offset of our ivar in the structure if we're using
1340 // the non-fragile abi and the debugger should ignore the value anyways.
1341 // Call it the FieldNo+1 due to how debuggers use the information,
1342 // e.g. negating the value when it needs a lookup in the dynamic table.
1343 uint64_t FieldOffset = CGM.getLangOptions().ObjCNonFragileABI ? FieldNo+1
1344 : RL.getFieldOffset(FieldNo);
Mike Stump1eb44332009-09-09 15:08:12 +00001345
Devang Patelc20482b2009-03-19 00:23:53 +00001346 unsigned Flags = 0;
1347 if (Field->getAccessControl() == ObjCIvarDecl::Protected)
Devang Patele2472482010-09-29 21:05:52 +00001348 Flags = llvm::DIDescriptor::FlagProtected;
Devang Patelc20482b2009-03-19 00:23:53 +00001349 else if (Field->getAccessControl() == ObjCIvarDecl::Private)
Devang Patele2472482010-09-29 21:05:52 +00001350 Flags = llvm::DIDescriptor::FlagPrivate;
Mike Stump1eb44332009-09-09 15:08:12 +00001351
Chris Lattner5f9e2722011-07-23 10:55:15 +00001352 StringRef PropertyName;
1353 StringRef PropertyGetter;
1354 StringRef PropertySetter;
Eli Friedman10292cc2011-04-17 06:40:15 +00001355 unsigned PropertyAttributes = 0;
Devang Patel8c6f9c42011-09-19 18:54:16 +00001356 ObjCPropertyDecl *PD = NULL;
1357 if (ImpD)
1358 if (ObjCPropertyImplDecl *PImpD =
Eric Christopherab5278e2011-10-11 23:00:51 +00001359 ImpD->FindPropertyImplIvarDecl(Field->getIdentifier()))
1360 PD = PImpD->getPropertyDecl();
Devang Patel8c6f9c42011-09-19 18:54:16 +00001361 if (PD) {
Devang Patelfa936d82011-04-16 00:12:55 +00001362 PropertyName = PD->getName();
Devang Patel90c1eed2011-04-16 00:37:51 +00001363 PropertyGetter = getSelectorName(PD->getGetterName());
1364 PropertySetter = getSelectorName(PD->getSetterName());
Devang Patelfa936d82011-04-16 00:12:55 +00001365 PropertyAttributes = PD->getPropertyAttributes();
Devang Patel8c6f9c42011-09-19 18:54:16 +00001366 }
Devang Patelfa936d82011-04-16 00:12:55 +00001367 FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit,
1368 FieldLine, FieldSize, FieldAlign,
1369 FieldOffset, Flags, FieldTy,
1370 PropertyName, PropertyGetter,
1371 PropertySetter, PropertyAttributes);
Devang Patel9ca36b62009-02-26 21:10:26 +00001372 EltTys.push_back(FieldTy);
1373 }
Mike Stump1eb44332009-09-09 15:08:12 +00001374
Jay Foadc556ef22011-04-24 10:11:03 +00001375 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Devang Patel9ca36b62009-02-26 21:10:26 +00001376
Eric Christopheraa2164c2011-09-29 00:00:45 +00001377 LexicalBlockStack.pop_back();
Devang Patele4c1ea02010-03-11 20:01:48 +00001378 llvm::DenseMap<const Decl *, llvm::WeakVH>::iterator RI =
1379 RegionMap.find(Ty->getDecl());
1380 if (RI != RegionMap.end())
1381 RegionMap.erase(RI);
1382
Devang Patel9ca36b62009-02-26 21:10:26 +00001383 // Bit size, align and offset of the type.
Anders Carlsson20f12a22009-12-06 18:00:51 +00001384 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1385 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
Mike Stump1eb44332009-09-09 15:08:12 +00001386
Devang Patel707b1e92011-05-12 19:07:41 +00001387 unsigned Flags = 0;
Devang Patelf568b642011-05-12 21:14:54 +00001388 if (ID->getImplementation())
Devang Patelaad16092011-05-12 21:29:57 +00001389 Flags |= llvm::DIDescriptor::FlagObjcClassComplete;
Devang Patel707b1e92011-05-12 19:07:41 +00001390
Devang Patel823d8e92010-12-08 22:42:58 +00001391 llvm::DIType RealDecl =
Devang Patel16674e82011-02-22 18:56:36 +00001392 DBuilder.createStructType(Unit, ID->getName(), DefUnit,
Devang Patel707b1e92011-05-12 19:07:41 +00001393 Line, Size, Align, Flags,
Devang Patel823d8e92010-12-08 22:42:58 +00001394 Elements, RuntimeLang);
Devang Patel9ca36b62009-02-26 21:10:26 +00001395
1396 // Now that we have a real decl for the struct, replace anything using the
1397 // old decl with the new one. This will recursively update the debug info.
Dan Gohman4cac5b42010-08-20 22:02:57 +00001398 llvm::DIType(FwdDeclNode).replaceAllUsesWith(RealDecl);
Devang Patelab699792010-05-07 18:12:35 +00001399 RegionMap[ID] = llvm::WeakVH(RealDecl);
Devang Patelfe09eab2009-07-13 17:03:14 +00001400
Devang Patel9ca36b62009-02-26 21:10:26 +00001401 return RealDecl;
1402}
1403
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001404llvm::DIType CGDebugInfo::CreateType(const VectorType *Ty, llvm::DIFile Unit) {
Devang Patel70c23cd2010-02-23 22:59:39 +00001405 llvm::DIType ElementTy = getOrCreateType(Ty->getElementType(), Unit);
Devang Patel6cf37dd2011-04-08 21:56:52 +00001406 int64_t NumElems = Ty->getNumElements();
1407 int64_t LowerBound = 0;
1408 if (NumElems == 0)
1409 // If number of elements are not known then this is an unbounded array.
1410 // Use Low = 1, Hi = 0 to express such arrays.
1411 LowerBound = 1;
1412 else
Devang Patel70c23cd2010-02-23 22:59:39 +00001413 --NumElems;
Devang Patel70c23cd2010-02-23 22:59:39 +00001414
Devang Patel6cf37dd2011-04-08 21:56:52 +00001415 llvm::Value *Subscript = DBuilder.getOrCreateSubrange(LowerBound, NumElems);
Jay Foadc556ef22011-04-24 10:11:03 +00001416 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
Devang Patel70c23cd2010-02-23 22:59:39 +00001417
1418 uint64_t Size = CGM.getContext().getTypeSize(Ty);
1419 uint64_t Align = CGM.getContext().getTypeAlign(Ty);
1420
1421 return
Devang Patel16674e82011-02-22 18:56:36 +00001422 DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
Devang Patel70c23cd2010-02-23 22:59:39 +00001423}
1424
Chris Lattner9c85ba32008-11-10 06:08:34 +00001425llvm::DIType CGDebugInfo::CreateType(const ArrayType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001426 llvm::DIFile Unit) {
Anders Carlsson835c9092009-01-05 01:23:29 +00001427 uint64_t Size;
1428 uint64_t Align;
Mike Stump1eb44332009-09-09 15:08:12 +00001429
1430
Nuno Lopes010d5142009-01-28 00:35:17 +00001431 // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
Anders Carlsson835c9092009-01-05 01:23:29 +00001432 if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(Ty)) {
Anders Carlsson835c9092009-01-05 01:23:29 +00001433 Size = 0;
1434 Align =
Anders Carlsson20f12a22009-12-06 18:00:51 +00001435 CGM.getContext().getTypeAlign(CGM.getContext().getBaseElementType(VAT));
Nuno Lopes010d5142009-01-28 00:35:17 +00001436 } else if (Ty->isIncompleteArrayType()) {
1437 Size = 0;
Anders Carlsson20f12a22009-12-06 18:00:51 +00001438 Align = CGM.getContext().getTypeAlign(Ty->getElementType());
Devang Patelba690a42011-04-04 23:18:38 +00001439 } else if (Ty->isDependentSizedArrayType() || Ty->isIncompleteType()) {
Devang Patelae503df2011-04-01 19:02:33 +00001440 Size = 0;
1441 Align = 0;
Anders Carlsson835c9092009-01-05 01:23:29 +00001442 } else {
1443 // Size and align of the whole array, not the element type.
Anders Carlsson20f12a22009-12-06 18:00:51 +00001444 Size = CGM.getContext().getTypeSize(Ty);
1445 Align = CGM.getContext().getTypeAlign(Ty);
Anders Carlsson835c9092009-01-05 01:23:29 +00001446 }
Mike Stump1eb44332009-09-09 15:08:12 +00001447
Chris Lattner9c85ba32008-11-10 06:08:34 +00001448 // Add the dimensions of the array. FIXME: This loses CV qualifiers from
1449 // interior arrays, do we care? Why aren't nested arrays represented the
1450 // obvious/recursive way?
Chris Lattner5f9e2722011-07-23 10:55:15 +00001451 SmallVector<llvm::Value *, 8> Subscripts;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001452 QualType EltTy(Ty, 0);
Devang Patelcdf523c2010-10-06 18:30:00 +00001453 if (Ty->isIncompleteArrayType())
Chris Lattner9c85ba32008-11-10 06:08:34 +00001454 EltTy = Ty->getElementType();
Devang Patelcdf523c2010-10-06 18:30:00 +00001455 else {
1456 while ((Ty = dyn_cast<ArrayType>(EltTy))) {
Devang Patel6cf37dd2011-04-08 21:56:52 +00001457 int64_t UpperBound = 0;
1458 int64_t LowerBound = 0;
Nick Lewycky3894c072011-04-09 00:25:15 +00001459 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(Ty)) {
Devang Patelcdf523c2010-10-06 18:30:00 +00001460 if (CAT->getSize().getZExtValue())
Devang Patel6cf37dd2011-04-08 21:56:52 +00001461 UpperBound = CAT->getSize().getZExtValue() - 1;
Nick Lewycky3894c072011-04-09 00:25:15 +00001462 } else
Devang Patel6cf37dd2011-04-08 21:56:52 +00001463 // This is an unbounded array. Use Low = 1, Hi = 0 to express such
1464 // arrays.
1465 LowerBound = 1;
1466
Devang Patelcdf523c2010-10-06 18:30:00 +00001467 // FIXME: Verify this is right for VLAs.
Eric Christopherab5278e2011-10-11 23:00:51 +00001468 Subscripts.push_back(DBuilder.getOrCreateSubrange(LowerBound,
1469 UpperBound));
Devang Patelcdf523c2010-10-06 18:30:00 +00001470 EltTy = Ty->getElementType();
1471 }
Sanjiv Gupta507de852008-06-09 10:47:41 +00001472 }
Mike Stump1eb44332009-09-09 15:08:12 +00001473
Jay Foadc556ef22011-04-24 10:11:03 +00001474 llvm::DIArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001475
Devang Patelca80a5f2009-10-20 19:55:01 +00001476 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +00001477 DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
Devang Patel823d8e92010-12-08 22:42:58 +00001478 SubscriptArray);
Devang Patelca80a5f2009-10-20 19:55:01 +00001479 return DbgTy;
Chris Lattner9c85ba32008-11-10 06:08:34 +00001480}
1481
Anders Carlssona031b352009-11-06 19:19:55 +00001482llvm::DIType CGDebugInfo::CreateType(const LValueReferenceType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001483 llvm::DIFile Unit) {
Anders Carlssona031b352009-11-06 19:19:55 +00001484 return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type,
1485 Ty, Ty->getPointeeType(), Unit);
1486}
Chris Lattner9c85ba32008-11-10 06:08:34 +00001487
Douglas Gregor36b8ee62011-01-22 01:58:15 +00001488llvm::DIType CGDebugInfo::CreateType(const RValueReferenceType *Ty,
1489 llvm::DIFile Unit) {
1490 return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type,
1491 Ty, Ty->getPointeeType(), Unit);
1492}
1493
Anders Carlsson20f12a22009-12-06 18:00:51 +00001494llvm::DIType CGDebugInfo::CreateType(const MemberPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +00001495 llvm::DIFile U) {
Anders Carlsson20f12a22009-12-06 18:00:51 +00001496 QualType PointerDiffTy = CGM.getContext().getPointerDiffType();
1497 llvm::DIType PointerDiffDITy = getOrCreateType(PointerDiffTy, U);
1498
1499 if (!Ty->getPointeeType()->isFunctionType()) {
1500 // We have a data member pointer type.
1501 return PointerDiffDITy;
1502 }
1503
1504 // We have a member function pointer type. Treat it as a struct with two
1505 // ptrdiff_t members.
1506 std::pair<uint64_t, unsigned> Info = CGM.getContext().getTypeInfo(Ty);
1507
1508 uint64_t FieldOffset = 0;
Devang Patel823d8e92010-12-08 22:42:58 +00001509 llvm::Value *ElementTypes[2];
Anders Carlsson20f12a22009-12-06 18:00:51 +00001510
1511 // FIXME: This should probably be a function type instead.
1512 ElementTypes[0] =
Devang Patel1d323e02011-06-24 22:00:59 +00001513 DBuilder.createMemberType(U, "ptr", U, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001514 Info.first, Info.second, FieldOffset, 0,
1515 PointerDiffDITy);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001516 FieldOffset += Info.first;
1517
1518 ElementTypes[1] =
Devang Patel1d323e02011-06-24 22:00:59 +00001519 DBuilder.createMemberType(U, "ptr", U, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001520 Info.first, Info.second, FieldOffset, 0,
1521 PointerDiffDITy);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001522
Jay Foadc556ef22011-04-24 10:11:03 +00001523 llvm::DIArray Elements = DBuilder.getOrCreateArray(ElementTypes);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001524
Chris Lattner5f9e2722011-07-23 10:55:15 +00001525 return DBuilder.createStructType(U, StringRef("test"),
Devang Patel823d8e92010-12-08 22:42:58 +00001526 U, 0, FieldOffset,
1527 0, 0, Elements);
Anders Carlsson20f12a22009-12-06 18:00:51 +00001528}
1529
Eli Friedmanb001de72011-10-06 23:00:33 +00001530llvm::DIType CGDebugInfo::CreateType(const AtomicType *Ty,
1531 llvm::DIFile U) {
1532 // Ignore the atomic wrapping
1533 // FIXME: What is the correct representation?
1534 return getOrCreateType(Ty->getValueType(), U);
1535}
1536
Devang Patel6237cea2010-08-23 22:07:25 +00001537/// CreateEnumType - get enumeration type.
Devang Patel31f7d022011-01-17 22:23:07 +00001538llvm::DIType CGDebugInfo::CreateEnumType(const EnumDecl *ED) {
1539 llvm::DIFile Unit = getOrCreateFile(ED->getLocation());
Chris Lattner5f9e2722011-07-23 10:55:15 +00001540 SmallVector<llvm::Value *, 16> Enumerators;
Devang Patel6237cea2010-08-23 22:07:25 +00001541
1542 // Create DIEnumerator elements for each enumerator.
1543 for (EnumDecl::enumerator_iterator
1544 Enum = ED->enumerator_begin(), EnumEnd = ED->enumerator_end();
1545 Enum != EnumEnd; ++Enum) {
Devang Patel823d8e92010-12-08 22:42:58 +00001546 Enumerators.push_back(
Devang Patel16674e82011-02-22 18:56:36 +00001547 DBuilder.createEnumerator(Enum->getName(),
Devang Patel823d8e92010-12-08 22:42:58 +00001548 Enum->getInitVal().getZExtValue()));
Devang Patel6237cea2010-08-23 22:07:25 +00001549 }
1550
1551 // Return a CompositeType for the enum itself.
Jay Foadc556ef22011-04-24 10:11:03 +00001552 llvm::DIArray EltArray = DBuilder.getOrCreateArray(Enumerators);
Devang Patel6237cea2010-08-23 22:07:25 +00001553
1554 llvm::DIFile DefUnit = getOrCreateFile(ED->getLocation());
1555 unsigned Line = getLineNumber(ED->getLocation());
1556 uint64_t Size = 0;
Devang Patelffc52e72010-08-24 18:14:06 +00001557 uint64_t Align = 0;
1558 if (!ED->getTypeForDecl()->isIncompleteType()) {
1559 Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
1560 Align = CGM.getContext().getTypeAlign(ED->getTypeForDecl());
1561 }
Devang Patel4bc48872010-10-27 23:23:58 +00001562 llvm::DIDescriptor EnumContext =
John McCall8178df32011-02-22 22:38:33 +00001563 getContextDescriptor(cast<Decl>(ED->getDeclContext()));
Devang Patel6237cea2010-08-23 22:07:25 +00001564 llvm::DIType DbgTy =
Devang Patel16674e82011-02-22 18:56:36 +00001565 DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit, Line,
Devang Patel823d8e92010-12-08 22:42:58 +00001566 Size, Align, EltArray);
Devang Patel6237cea2010-08-23 22:07:25 +00001567 return DbgTy;
1568}
1569
Douglas Gregor840943d2009-12-21 20:18:30 +00001570static QualType UnwrapTypeForDebugInfo(QualType T) {
1571 do {
1572 QualType LastT = T;
1573 switch (T->getTypeClass()) {
1574 default:
1575 return T;
1576 case Type::TemplateSpecialization:
1577 T = cast<TemplateSpecializationType>(T)->desugar();
1578 break;
John McCallf4c73712011-01-19 06:33:43 +00001579 case Type::TypeOfExpr:
1580 T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
Douglas Gregor840943d2009-12-21 20:18:30 +00001581 break;
Douglas Gregor840943d2009-12-21 20:18:30 +00001582 case Type::TypeOf:
1583 T = cast<TypeOfType>(T)->getUnderlyingType();
1584 break;
1585 case Type::Decltype:
1586 T = cast<DecltypeType>(T)->getUnderlyingType();
1587 break;
Sean Huntca63c202011-05-24 22:41:36 +00001588 case Type::UnaryTransform:
1589 T = cast<UnaryTransformType>(T)->getUnderlyingType();
1590 break;
John McCall9d156a72011-01-06 01:58:22 +00001591 case Type::Attributed:
1592 T = cast<AttributedType>(T)->getEquivalentType();
John McCall14aa2172011-03-04 04:00:19 +00001593 break;
Abramo Bagnara465d41b2010-05-11 21:36:43 +00001594 case Type::Elaborated:
1595 T = cast<ElaboratedType>(T)->getNamedType();
Douglas Gregor840943d2009-12-21 20:18:30 +00001596 break;
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001597 case Type::Paren:
1598 T = cast<ParenType>(T)->getInnerType();
1599 break;
Douglas Gregor840943d2009-12-21 20:18:30 +00001600 case Type::SubstTemplateTypeParm:
1601 T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
1602 break;
Anders Carlssonebc32792011-03-06 16:43:04 +00001603 case Type::Auto:
1604 T = cast<AutoType>(T)->getDeducedType();
1605 break;
Douglas Gregor840943d2009-12-21 20:18:30 +00001606 }
1607
1608 assert(T != LastT && "Type unwrapping failed to unwrap!");
1609 if (T == LastT)
1610 return T;
1611 } while (true);
Anders Carlsson5b6117a2009-11-14 21:08:12 +00001612}
1613
Eric Christopher973bbb62011-12-16 23:40:18 +00001614/// getType - Get the type from the cache or return null type if it doesn't exist.
1615llvm::DIType CGDebugInfo::getTypeOrNull(QualType Ty) {
Mike Stump1eb44332009-09-09 15:08:12 +00001616
Douglas Gregor840943d2009-12-21 20:18:30 +00001617 // Unwrap the type as needed for debug information.
1618 Ty = UnwrapTypeForDebugInfo(Ty);
Eric Christopher973bbb62011-12-16 23:40:18 +00001619
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001620 // Check for existing entry.
Ted Kremenek590838b2010-03-29 18:29:57 +00001621 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001622 TypeCache.find(Ty.getAsOpaquePtr());
Daniel Dunbar65f13c32009-09-19 20:17:48 +00001623 if (it != TypeCache.end()) {
1624 // Verify that the debug info still exists.
1625 if (&*it->second)
1626 return llvm::DIType(cast<llvm::MDNode>(it->second));
1627 }
Daniel Dunbar03faac32009-09-19 19:27:14 +00001628
Eric Christopher973bbb62011-12-16 23:40:18 +00001629 return llvm::DIType();
1630}
1631
1632/// getOrCreateType - Get the type from the cache or create a new
1633/// one if necessary.
1634llvm::DIType CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile Unit) {
1635 if (Ty.isNull())
1636 return llvm::DIType();
1637
1638 // Unwrap the type as needed for debug information.
1639 Ty = UnwrapTypeForDebugInfo(Ty);
1640
1641 llvm::DIType T = getTypeOrNull(Ty);
1642 if (T.Verify()) return T;
1643
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001644 // Otherwise create the type.
1645 llvm::DIType Res = CreateTypeNode(Ty, Unit);
Anders Carlsson0dd57c62009-11-14 20:52:05 +00001646
1647 // And update the type cache.
Devang Patelab699792010-05-07 18:12:35 +00001648 TypeCache[Ty.getAsOpaquePtr()] = Res;
Daniel Dunbar23e81ba2009-09-19 19:27:24 +00001649 return Res;
Daniel Dunbar03faac32009-09-19 19:27:14 +00001650}
1651
Anders Carlsson0dd57c62009-11-14 20:52:05 +00001652/// CreateTypeNode - Create a new debug type node.
Nick Lewycky7b3819d2011-11-09 04:27:23 +00001653llvm::DIType CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile Unit) {
John McCalla1805292009-09-25 01:40:47 +00001654 // Handle qualifiers, which recursively handles what they refer to.
Douglas Gregora4923eb2009-11-16 21:35:15 +00001655 if (Ty.hasLocalQualifiers())
John McCalla1805292009-09-25 01:40:47 +00001656 return CreateQualifiedType(Ty, Unit);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001657
Douglas Gregor2101a822009-12-21 19:57:21 +00001658 const char *Diag = 0;
1659
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001660 // Work out details of type.
Chris Lattner9c85ba32008-11-10 06:08:34 +00001661 switch (Ty->getTypeClass()) {
Douglas Gregor72564e72009-02-26 23:50:07 +00001662#define TYPE(Class, Base)
1663#define ABSTRACT_TYPE(Class, Base)
1664#define NON_CANONICAL_TYPE(Class, Base)
1665#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1666#include "clang/AST/TypeNodes.def"
David Blaikieb219cfc2011-09-23 05:06:16 +00001667 llvm_unreachable("Dependent types cannot show up in debug information");
Argyrios Kyrtzidis1bb8a452009-08-19 01:28:17 +00001668
Anders Carlssonbfe69952009-11-06 18:24:04 +00001669 case Type::ExtVector:
Devang Patel70c23cd2010-02-23 22:59:39 +00001670 case Type::Vector:
1671 return CreateType(cast<VectorType>(Ty), Unit);
Daniel Dunbar9df4bb32009-07-14 01:20:56 +00001672 case Type::ObjCObjectPointer:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001673 return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
John McCallc12c5bb2010-05-15 11:32:37 +00001674 case Type::ObjCObject:
1675 return CreateType(cast<ObjCObjectType>(Ty), Unit);
Mike Stump1eb44332009-09-09 15:08:12 +00001676 case Type::ObjCInterface:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001677 return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001678 case Type::Builtin:
1679 return CreateType(cast<BuiltinType>(Ty));
1680 case Type::Complex:
1681 return CreateType(cast<ComplexType>(Ty));
1682 case Type::Pointer:
1683 return CreateType(cast<PointerType>(Ty), Unit);
Mike Stump9bc093c2009-05-14 02:03:51 +00001684 case Type::BlockPointer:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001685 return CreateType(cast<BlockPointerType>(Ty), Unit);
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001686 case Type::Typedef:
1687 return CreateType(cast<TypedefType>(Ty), Unit);
Douglas Gregor72564e72009-02-26 23:50:07 +00001688 case Type::Record:
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001689 return CreateType(cast<RecordType>(Ty));
Douglas Gregor72564e72009-02-26 23:50:07 +00001690 case Type::Enum:
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00001691 return CreateEnumType(cast<EnumType>(Ty)->getDecl());
Chris Lattner9c85ba32008-11-10 06:08:34 +00001692 case Type::FunctionProto:
1693 case Type::FunctionNoProto:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001694 return CreateType(cast<FunctionType>(Ty), Unit);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001695 case Type::ConstantArray:
1696 case Type::VariableArray:
1697 case Type::IncompleteArray:
Daniel Dunbar03faac32009-09-19 19:27:14 +00001698 return CreateType(cast<ArrayType>(Ty), Unit);
Anders Carlssona031b352009-11-06 19:19:55 +00001699
1700 case Type::LValueReference:
1701 return CreateType(cast<LValueReferenceType>(Ty), Unit);
Douglas Gregor36b8ee62011-01-22 01:58:15 +00001702 case Type::RValueReference:
1703 return CreateType(cast<RValueReferenceType>(Ty), Unit);
Anders Carlssona031b352009-11-06 19:19:55 +00001704
Anders Carlsson20f12a22009-12-06 18:00:51 +00001705 case Type::MemberPointer:
1706 return CreateType(cast<MemberPointerType>(Ty), Unit);
Douglas Gregor2101a822009-12-21 19:57:21 +00001707
Eli Friedmanb001de72011-10-06 23:00:33 +00001708 case Type::Atomic:
1709 return CreateType(cast<AtomicType>(Ty), Unit);
1710
John McCall9d156a72011-01-06 01:58:22 +00001711 case Type::Attributed:
Douglas Gregor2101a822009-12-21 19:57:21 +00001712 case Type::TemplateSpecialization:
Douglas Gregor2101a822009-12-21 19:57:21 +00001713 case Type::Elaborated:
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001714 case Type::Paren:
Douglas Gregor2101a822009-12-21 19:57:21 +00001715 case Type::SubstTemplateTypeParm:
Douglas Gregor2101a822009-12-21 19:57:21 +00001716 case Type::TypeOfExpr:
1717 case Type::TypeOf:
Douglas Gregor840943d2009-12-21 20:18:30 +00001718 case Type::Decltype:
Sean Huntca63c202011-05-24 22:41:36 +00001719 case Type::UnaryTransform:
Richard Smith34b41d92011-02-20 03:19:35 +00001720 case Type::Auto:
Douglas Gregor840943d2009-12-21 20:18:30 +00001721 llvm_unreachable("type should have been unwrapped!");
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001722 }
Douglas Gregor2101a822009-12-21 19:57:21 +00001723
1724 assert(Diag && "Fall through without a diagnostic?");
David Blaikied6471f72011-09-25 23:23:43 +00001725 unsigned DiagID = CGM.getDiags().getCustomDiagID(DiagnosticsEngine::Error,
Douglas Gregor2101a822009-12-21 19:57:21 +00001726 "debug information for %0 is not yet supported");
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +00001727 CGM.getDiags().Report(DiagID)
Douglas Gregor2101a822009-12-21 19:57:21 +00001728 << Diag;
1729 return llvm::DIType();
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001730}
1731
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001732/// CreateMemberType - Create new member and increase Offset by FType's size.
1733llvm::DIType CGDebugInfo::CreateMemberType(llvm::DIFile Unit, QualType FType,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001734 StringRef Name,
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001735 uint64_t *Offset) {
1736 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
1737 uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
1738 unsigned FieldAlign = CGM.getContext().getTypeAlign(FType);
Devang Patel1d323e02011-06-24 22:00:59 +00001739 llvm::DIType Ty = DBuilder.createMemberType(Unit, Name, Unit, 0,
Devang Patel823d8e92010-12-08 22:42:58 +00001740 FieldSize, FieldAlign,
1741 *Offset, 0, FieldTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001742 *Offset += FieldSize;
1743 return Ty;
1744}
1745
Devang Patel120bf322011-04-23 00:08:01 +00001746/// getFunctionDeclaration - Return debug info descriptor to describe method
1747/// declaration for the given method definition.
1748llvm::DISubprogram CGDebugInfo::getFunctionDeclaration(const Decl *D) {
1749 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
1750 if (!FD) return llvm::DISubprogram();
1751
1752 // Setup context.
1753 getContextDescriptor(cast<Decl>(D->getDeclContext()));
1754
Devang Patel22a5cdf2011-04-29 23:42:32 +00001755 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
Eric Christopherdeae6a82011-11-17 23:45:00 +00001756 MI = SPCache.find(FD->getCanonicalDecl());
Devang Patel22a5cdf2011-04-29 23:42:32 +00001757 if (MI != SPCache.end()) {
1758 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1759 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1760 return SP;
1761 }
1762
Devang Patel120bf322011-04-23 00:08:01 +00001763 for (FunctionDecl::redecl_iterator I = FD->redecls_begin(),
1764 E = FD->redecls_end(); I != E; ++I) {
1765 const FunctionDecl *NextFD = *I;
1766 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
Eric Christopherdeae6a82011-11-17 23:45:00 +00001767 MI = SPCache.find(NextFD->getCanonicalDecl());
Devang Patel120bf322011-04-23 00:08:01 +00001768 if (MI != SPCache.end()) {
1769 llvm::DISubprogram SP(dyn_cast_or_null<llvm::MDNode>(&*MI->second));
1770 if (SP.isSubprogram() && !llvm::DISubprogram(SP).isDefinition())
1771 return SP;
1772 }
1773 }
1774 return llvm::DISubprogram();
1775}
1776
Devang Patel1c296522011-05-31 20:46:46 +00001777// getOrCreateFunctionType - Construct DIType. If it is a c++ method, include
1778// implicit parameter "this".
Eric Christopherab5278e2011-10-11 23:00:51 +00001779llvm::DIType CGDebugInfo::getOrCreateFunctionType(const Decl * D,
1780 QualType FnType,
Devang Patel1c296522011-05-31 20:46:46 +00001781 llvm::DIFile F) {
1782 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D))
1783 return getOrCreateMethodType(Method, F);
Nick Lewycky7480d962011-11-10 00:34:02 +00001784 if (const ObjCMethodDecl *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
Devang Patelc478f212011-05-31 21:18:50 +00001785 // Add "self" and "_cmd"
Chris Lattner5f9e2722011-07-23 10:55:15 +00001786 SmallVector<llvm::Value *, 16> Elts;
Devang Patelc478f212011-05-31 21:18:50 +00001787
1788 // First element is always return type. For 'void' functions it is NULL.
Devang Pateld127bcb2011-05-31 22:21:11 +00001789 Elts.push_back(getOrCreateType(OMethod->getResultType(), F));
Devang Patelc478f212011-05-31 21:18:50 +00001790 // "self" pointer is always first argument.
1791 Elts.push_back(getOrCreateType(OMethod->getSelfDecl()->getType(), F));
1792 // "cmd" pointer is always second argument.
1793 Elts.push_back(getOrCreateType(OMethod->getCmdDecl()->getType(), F));
Devang Pateld127bcb2011-05-31 22:21:11 +00001794 // Get rest of the arguments.
Argyrios Kyrtzidis491306a2011-10-03 06:37:04 +00001795 for (ObjCMethodDecl::param_const_iterator PI = OMethod->param_begin(),
Devang Pateld127bcb2011-05-31 22:21:11 +00001796 PE = OMethod->param_end(); PI != PE; ++PI)
1797 Elts.push_back(getOrCreateType((*PI)->getType(), F));
1798
Devang Patelc478f212011-05-31 21:18:50 +00001799 llvm::DIArray EltTypeArray = DBuilder.getOrCreateArray(Elts);
1800 return DBuilder.createSubroutineType(F, EltTypeArray);
1801 }
Devang Patel1c296522011-05-31 20:46:46 +00001802 return getOrCreateType(FnType, F);
1803}
1804
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001805/// EmitFunctionStart - Constructs the debug code for entering a function -
1806/// "llvm.dbg.func.start.".
Devang Patel9c6c3a02010-01-14 00:36:21 +00001807void CGDebugInfo::EmitFunctionStart(GlobalDecl GD, QualType FnType,
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001808 llvm::Function *Fn,
Chris Lattner9c85ba32008-11-10 06:08:34 +00001809 CGBuilderTy &Builder) {
Mike Stump1eb44332009-09-09 15:08:12 +00001810
Chris Lattner5f9e2722011-07-23 10:55:15 +00001811 StringRef Name;
1812 StringRef LinkageName;
Devang Patel9c6c3a02010-01-14 00:36:21 +00001813
Eric Christopheraa2164c2011-09-29 00:00:45 +00001814 FnBeginRegionCount.push_back(LexicalBlockStack.size());
Devang Patel5a6fbcf2010-07-22 22:29:16 +00001815
Devang Patel9c6c3a02010-01-14 00:36:21 +00001816 const Decl *D = GD.getDecl();
Eric Christopher73fb3502011-10-13 21:45:18 +00001817
Devang Patel3951e712010-10-07 22:03:49 +00001818 unsigned Flags = 0;
Devang Patel0692f832010-10-11 21:58:41 +00001819 llvm::DIFile Unit = getOrCreateFile(CurLoc);
1820 llvm::DIDescriptor FDContext(Unit);
Devang Patel5ecb1df2011-04-05 22:54:11 +00001821 llvm::DIArray TParamsArray;
Devang Patel9c6c3a02010-01-14 00:36:21 +00001822 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
Eric Christopherbf979472011-11-14 18:55:02 +00001823 // If there is a DISubprogram for this function available then use it.
Devang Patel4125fd22010-01-19 01:54:44 +00001824 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH>::iterator
Eric Christopherdeae6a82011-11-17 23:45:00 +00001825 FI = SPCache.find(FD->getCanonicalDecl());
Devang Patel4125fd22010-01-19 01:54:44 +00001826 if (FI != SPCache.end()) {
Gabor Greif38c9b172010-09-18 13:00:17 +00001827 llvm::DIDescriptor SP(dyn_cast_or_null<llvm::MDNode>(&*FI->second));
Devang Patelab699792010-05-07 18:12:35 +00001828 if (SP.isSubprogram() && llvm::DISubprogram(SP).isDefinition()) {
1829 llvm::MDNode *SPN = SP;
Eric Christopheraa2164c2011-09-29 00:00:45 +00001830 LexicalBlockStack.push_back(SPN);
Devang Patelab699792010-05-07 18:12:35 +00001831 RegionMap[D] = llvm::WeakVH(SP);
Devang Patel4125fd22010-01-19 01:54:44 +00001832 return;
1833 }
1834 }
Devang Patel9c6c3a02010-01-14 00:36:21 +00001835 Name = getFunctionName(FD);
1836 // Use mangled name as linkage name for c/c++ functions.
Devang Patela87a2b22011-05-02 22:49:30 +00001837 if (!Fn->hasInternalLinkage())
Devang Patel2df74c02011-05-02 22:37:48 +00001838 LinkageName = CGM.getMangledName(GD);
Devang Patel58faf202010-10-22 17:11:50 +00001839 if (LinkageName == Name)
Chris Lattner5f9e2722011-07-23 10:55:15 +00001840 LinkageName = StringRef();
Devang Patel3951e712010-10-07 22:03:49 +00001841 if (FD->hasPrototype())
1842 Flags |= llvm::DIDescriptor::FlagPrototyped;
Devang Patel0692f832010-10-11 21:58:41 +00001843 if (const NamespaceDecl *NSDecl =
1844 dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
Devang Patel170cef32010-12-09 00:33:05 +00001845 FDContext = getOrCreateNameSpace(NSDecl);
Devang Patelbc6a1912011-05-17 00:20:09 +00001846 else if (const RecordDecl *RDecl =
1847 dyn_cast_or_null<RecordDecl>(FD->getDeclContext()))
1848 FDContext = getContextDescriptor(cast<Decl>(RDecl->getDeclContext()));
Devang Patel5ecb1df2011-04-05 22:54:11 +00001849
1850 // Collect template parameters.
1851 TParamsArray = CollectFunctionTemplateParams(FD, Unit);
David Chisnall70b9b442010-09-02 17:16:32 +00001852 } else if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D)) {
David Chisnall52044a22010-09-02 18:01:51 +00001853 Name = getObjCMethodName(OMD);
Devang Patel3951e712010-10-07 22:03:49 +00001854 Flags |= llvm::DIDescriptor::FlagPrototyped;
Devang Patel9c6c3a02010-01-14 00:36:21 +00001855 } else {
Devang Patel58faf202010-10-22 17:11:50 +00001856 // Use llvm function name.
Devang Patel9c6c3a02010-01-14 00:36:21 +00001857 Name = Fn->getName();
Devang Patel3951e712010-10-07 22:03:49 +00001858 Flags |= llvm::DIDescriptor::FlagPrototyped;
Devang Patel9c6c3a02010-01-14 00:36:21 +00001859 }
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001860 if (!Name.empty() && Name[0] == '\01')
1861 Name = Name.substr(1);
Mike Stump1eb44332009-09-09 15:08:12 +00001862
Devang Patel970c6182010-04-24 00:49:16 +00001863 // It is expected that CurLoc is set before using EmitFunctionStart.
1864 // Usually, CurLoc points to the left bracket location of compound
1865 // statement representing function body.
Devang Patel8ab870d2010-05-12 23:46:38 +00001866 unsigned LineNo = getLineNumber(CurLoc);
Devang Patele2472482010-09-29 21:05:52 +00001867 if (D->isImplicit())
1868 Flags |= llvm::DIDescriptor::FlagArtificial;
Devang Patel120bf322011-04-23 00:08:01 +00001869 llvm::DISubprogram SPDecl = getFunctionDeclaration(D);
Chris Lattner9c85ba32008-11-10 06:08:34 +00001870 llvm::DISubprogram SP =
Devang Patel16674e82011-02-22 18:56:36 +00001871 DBuilder.createFunction(FDContext, Name, LinkageName, Unit,
Devang Patel1c296522011-05-31 20:46:46 +00001872 LineNo, getOrCreateFunctionType(D, FnType, Unit),
Devang Patel823d8e92010-12-08 22:42:58 +00001873 Fn->hasInternalLinkage(), true/*definition*/,
Devang Patel5ecb1df2011-04-05 22:54:11 +00001874 Flags, CGM.getLangOptions().Optimize, Fn,
Devang Patel120bf322011-04-23 00:08:01 +00001875 TParamsArray, SPDecl);
Mike Stump1eb44332009-09-09 15:08:12 +00001876
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001877 // Push function on region stack.
Devang Patelab699792010-05-07 18:12:35 +00001878 llvm::MDNode *SPN = SP;
Eric Christopheraa2164c2011-09-29 00:00:45 +00001879 LexicalBlockStack.push_back(SPN);
Devang Patelab699792010-05-07 18:12:35 +00001880 RegionMap[D] = llvm::WeakVH(SP);
Eric Christopher69a1b742011-09-29 00:00:37 +00001881}
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001882
Eric Christopher5321bc42011-09-29 00:00:41 +00001883/// EmitLocation - Emit metadata to indicate a change in line/column
1884/// information in the source file.
Eric Christopher73fb3502011-10-13 21:45:18 +00001885void CGDebugInfo::EmitLocation(CGBuilderTy &Builder, SourceLocation Loc) {
1886
1887 // Update our current location
1888 setLocation(Loc);
1889
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +00001890 if (CurLoc.isInvalid() || CurLoc.isMacroID()) return;
Mike Stump1eb44332009-09-09 15:08:12 +00001891
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00001892 // Don't bother if things are the same as last time.
Anders Carlsson20f12a22009-12-06 18:00:51 +00001893 SourceManager &SM = CGM.getContext().getSourceManager();
Eric Christopher73fb3502011-10-13 21:45:18 +00001894 if (CurLoc == PrevLoc ||
Chandler Carruth40278532011-07-25 16:49:02 +00001895 SM.getExpansionLoc(CurLoc) == SM.getExpansionLoc(PrevLoc))
Devang Patel4800ea62010-04-05 21:09:15 +00001896 // New Builder may not be in sync with CGDebugInfo.
1897 if (!Builder.getCurrentDebugLocation().isUnknown())
1898 return;
Eric Christopher414ee4b2011-09-29 00:00:35 +00001899
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00001900 // Update last state.
1901 PrevLoc = CurLoc;
1902
Eric Christopheraa2164c2011-09-29 00:00:45 +00001903 llvm::MDNode *Scope = LexicalBlockStack.back();
Devang Patel8ab870d2010-05-12 23:46:38 +00001904 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(CurLoc),
1905 getColumnNumber(CurLoc),
Chris Lattnere541d012010-04-02 20:21:43 +00001906 Scope));
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00001907}
1908
Eric Christopher73fb3502011-10-13 21:45:18 +00001909/// CreateLexicalBlock - Creates a new lexical block node and pushes it on
1910/// the stack.
1911void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
Devang Patel8fae0602009-11-13 19:10:24 +00001912 llvm::DIDescriptor D =
Eric Christopher73fb3502011-10-13 21:45:18 +00001913 DBuilder.createLexicalBlock(LexicalBlockStack.empty() ?
1914 llvm::DIDescriptor() :
1915 llvm::DIDescriptor(LexicalBlockStack.back()),
1916 getOrCreateFile(CurLoc),
1917 getLineNumber(CurLoc),
1918 getColumnNumber(CurLoc));
Devang Patelab699792010-05-07 18:12:35 +00001919 llvm::MDNode *DN = D;
Eric Christopheraa2164c2011-09-29 00:00:45 +00001920 LexicalBlockStack.push_back(DN);
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00001921}
1922
Eric Christopher73fb3502011-10-13 21:45:18 +00001923/// EmitLexicalBlockStart - Constructs the debug code for entering a declarative
1924/// region - beginning of a DW_TAG_lexical_block.
1925void CGDebugInfo::EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc) {
1926 // Set our current location.
1927 setLocation(Loc);
1928
1929 // Create a new lexical block and push it on the stack.
1930 CreateLexicalBlock(Loc);
1931
1932 // Emit a line table change for the current location inside the new scope.
1933 Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(getLineNumber(Loc),
1934 getColumnNumber(Loc),
1935 LexicalBlockStack.back()));
1936}
1937
Eric Christopheraa2164c2011-09-29 00:00:45 +00001938/// EmitLexicalBlockEnd - Constructs the debug code for exiting a declarative
Eric Christopher43202ae2011-09-26 15:03:22 +00001939/// region - end of a DW_TAG_lexical_block.
Eric Christopher73fb3502011-10-13 21:45:18 +00001940void CGDebugInfo::EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc) {
Eric Christopheraa2164c2011-09-29 00:00:45 +00001941 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Daniel Dunbar5273f512008-10-17 01:07:56 +00001942
Eric Christopher73fb3502011-10-13 21:45:18 +00001943 // Provide an entry in the line table for the end of the block.
1944 EmitLocation(Builder, Loc);
Mike Stump1eb44332009-09-09 15:08:12 +00001945
Eric Christopheraa2164c2011-09-29 00:00:45 +00001946 LexicalBlockStack.pop_back();
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00001947}
1948
Devang Patel5a6fbcf2010-07-22 22:29:16 +00001949/// EmitFunctionEnd - Constructs the debug code for exiting a function.
1950void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder) {
Eric Christopheraa2164c2011-09-29 00:00:45 +00001951 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Devang Patel5a6fbcf2010-07-22 22:29:16 +00001952 unsigned RCount = FnBeginRegionCount.back();
Eric Christopheraa2164c2011-09-29 00:00:45 +00001953 assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
Devang Patel5a6fbcf2010-07-22 22:29:16 +00001954
1955 // Pop all regions for this function.
Eric Christopheraa2164c2011-09-29 00:00:45 +00001956 while (LexicalBlockStack.size() != RCount)
Eric Christopher73fb3502011-10-13 21:45:18 +00001957 EmitLexicalBlockEnd(Builder, CurLoc);
Devang Patel5a6fbcf2010-07-22 22:29:16 +00001958 FnBeginRegionCount.pop_back();
1959}
1960
Devang Patel809b9bb2010-02-10 18:49:08 +00001961// EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
1962// See BuildByRefType.
1963llvm::DIType CGDebugInfo::EmitTypeForVarWithBlocksAttr(const ValueDecl *VD,
1964 uint64_t *XOffset) {
1965
Chris Lattner5f9e2722011-07-23 10:55:15 +00001966 SmallVector<llvm::Value *, 5> EltTys;
Devang Patel809b9bb2010-02-10 18:49:08 +00001967 QualType FType;
1968 uint64_t FieldSize, FieldOffset;
1969 unsigned FieldAlign;
1970
Devang Patel17800552010-03-09 00:44:50 +00001971 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Devang Patel809b9bb2010-02-10 18:49:08 +00001972 QualType Type = VD->getType();
1973
1974 FieldOffset = 0;
1975 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001976 EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
1977 EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
Devang Patel809b9bb2010-02-10 18:49:08 +00001978 FType = CGM.getContext().IntTy;
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001979 EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
1980 EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
1981
John McCall6b5a61b2011-02-07 10:33:21 +00001982 bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type);
Devang Patel809b9bb2010-02-10 18:49:08 +00001983 if (HasCopyAndDispose) {
1984 FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00001985 EltTys.push_back(CreateMemberType(Unit, FType, "__copy_helper",
1986 &FieldOffset));
1987 EltTys.push_back(CreateMemberType(Unit, FType, "__destroy_helper",
1988 &FieldOffset));
Devang Patel809b9bb2010-02-10 18:49:08 +00001989 }
1990
1991 CharUnits Align = CGM.getContext().getDeclAlign(VD);
Ken Dyck573be632011-04-22 17:34:18 +00001992 if (Align > CGM.getContext().toCharUnitsFromBits(
Douglas Gregorbcfd1f52011-09-02 00:18:52 +00001993 CGM.getContext().getTargetInfo().getPointerAlign(0))) {
Ken Dyck573be632011-04-22 17:34:18 +00001994 CharUnits FieldOffsetInBytes
1995 = CGM.getContext().toCharUnitsFromBits(FieldOffset);
1996 CharUnits AlignedOffsetInBytes
1997 = FieldOffsetInBytes.RoundUpToAlignment(Align);
1998 CharUnits NumPaddingBytes
1999 = AlignedOffsetInBytes - FieldOffsetInBytes;
Devang Patel809b9bb2010-02-10 18:49:08 +00002000
Ken Dyck573be632011-04-22 17:34:18 +00002001 if (NumPaddingBytes.isPositive()) {
2002 llvm::APInt pad(32, NumPaddingBytes.getQuantity());
Devang Patel809b9bb2010-02-10 18:49:08 +00002003 FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
2004 pad, ArrayType::Normal, 0);
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002005 EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
Devang Patel809b9bb2010-02-10 18:49:08 +00002006 }
2007 }
2008
2009 FType = Type;
Benjamin Kramer48c70f62010-04-24 20:19:58 +00002010 llvm::DIType FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
Devang Patel809b9bb2010-02-10 18:49:08 +00002011 FieldSize = CGM.getContext().getTypeSize(FType);
Ken Dyck573be632011-04-22 17:34:18 +00002012 FieldAlign = CGM.getContext().toBits(Align);
Devang Patel809b9bb2010-02-10 18:49:08 +00002013
2014 *XOffset = FieldOffset;
Devang Patel1d323e02011-06-24 22:00:59 +00002015 FieldTy = DBuilder.createMemberType(Unit, VD->getName(), Unit,
Devang Patel823d8e92010-12-08 22:42:58 +00002016 0, FieldSize, FieldAlign,
2017 FieldOffset, 0, FieldTy);
Devang Patel809b9bb2010-02-10 18:49:08 +00002018 EltTys.push_back(FieldTy);
2019 FieldOffset += FieldSize;
2020
Jay Foadc556ef22011-04-24 10:11:03 +00002021 llvm::DIArray Elements = DBuilder.getOrCreateArray(EltTys);
Devang Patel809b9bb2010-02-10 18:49:08 +00002022
Devang Patele2472482010-09-29 21:05:52 +00002023 unsigned Flags = llvm::DIDescriptor::FlagBlockByrefStruct;
Devang Patel809b9bb2010-02-10 18:49:08 +00002024
Devang Patel16674e82011-02-22 18:56:36 +00002025 return DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0, Flags,
Devang Patel823d8e92010-12-08 22:42:58 +00002026 Elements);
Devang Patel809b9bb2010-02-10 18:49:08 +00002027}
Devang Patel823d8e92010-12-08 22:42:58 +00002028
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00002029/// EmitDeclare - Emit local variable declaration debug info.
Devang Patel239cec62010-02-01 21:39:52 +00002030void CGDebugInfo::EmitDeclare(const VarDecl *VD, unsigned Tag,
Devang Patel093ac462011-03-03 20:13:15 +00002031 llvm::Value *Storage,
2032 unsigned ArgNo, CGBuilderTy &Builder) {
Eric Christopheraa2164c2011-09-29 00:00:45 +00002033 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Daniel Dunbar5273f512008-10-17 01:07:56 +00002034
Devang Patel17800552010-03-09 00:44:50 +00002035 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Devang Patel809b9bb2010-02-10 18:49:08 +00002036 llvm::DIType Ty;
2037 uint64_t XOffset = 0;
2038 if (VD->hasAttr<BlocksAttr>())
2039 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2040 else
2041 Ty = getOrCreateType(VD->getType(), Unit);
Chris Lattner650cea92009-05-05 04:57:08 +00002042
Devang Patelf4e54a22010-05-07 23:05:55 +00002043 // If there is not any debug info for type then do not emit debug info
2044 // for this variable.
2045 if (!Ty)
2046 return;
2047
Devang Patel34753802011-02-16 01:11:51 +00002048 if (llvm::Argument *Arg = dyn_cast<llvm::Argument>(Storage)) {
2049 // If Storage is an aggregate returned as 'sret' then let debugger know
2050 // about this.
Devang Patel0691f932011-02-10 00:40:52 +00002051 if (Arg->hasStructRetAttr())
Devang Patel16674e82011-02-22 18:56:36 +00002052 Ty = DBuilder.createReferenceType(Ty);
Devang Patel34753802011-02-16 01:11:51 +00002053 else if (CXXRecordDecl *Record = VD->getType()->getAsCXXRecordDecl()) {
2054 // If an aggregate variable has non trivial destructor or non trivial copy
2055 // constructor than it is pass indirectly. Let debug info know about this
2056 // by using reference of the aggregate type as a argument type.
Eric Christopherab5278e2011-10-11 23:00:51 +00002057 if (!Record->hasTrivialCopyConstructor() ||
2058 !Record->hasTrivialDestructor())
Devang Patel16674e82011-02-22 18:56:36 +00002059 Ty = DBuilder.createReferenceType(Ty);
Devang Patel34753802011-02-16 01:11:51 +00002060 }
2061 }
Devang Patel0691f932011-02-10 00:40:52 +00002062
Chris Lattner9c85ba32008-11-10 06:08:34 +00002063 // Get location information.
Devang Patel8ab870d2010-05-12 23:46:38 +00002064 unsigned Line = getLineNumber(VD->getLocation());
2065 unsigned Column = getColumnNumber(VD->getLocation());
Devang Patelaca745b2010-09-29 23:09:21 +00002066 unsigned Flags = 0;
2067 if (VD->isImplicit())
2068 Flags |= llvm::DIDescriptor::FlagArtificial;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002069 llvm::MDNode *Scope = LexicalBlockStack.back();
Devang Patelcebbedd2010-10-12 23:24:54 +00002070
Chris Lattner5f9e2722011-07-23 10:55:15 +00002071 StringRef Name = VD->getName();
Devang Patelcebbedd2010-10-12 23:24:54 +00002072 if (!Name.empty()) {
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002073 if (VD->hasAttr<BlocksAttr>()) {
2074 CharUnits offset = CharUnits::fromQuantity(32);
Chris Lattner5f9e2722011-07-23 10:55:15 +00002075 SmallVector<llvm::Value *, 9> addr;
Chris Lattner2acc6e32011-07-18 04:24:23 +00002076 llvm::Type *Int64Ty = llvm::Type::getInt64Ty(CGM.getLLVMContext());
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002077 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002078 // offset of __forwarding field
Ken Dyck0ebce0e2011-04-22 17:41:34 +00002079 offset = CGM.getContext().toCharUnitsFromBits(
Douglas Gregorbcfd1f52011-09-02 00:18:52 +00002080 CGM.getContext().getTargetInfo().getPointerWidth(0));
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002081 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002082 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2083 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002084 // offset of x field
Ken Dyck0ebce0e2011-04-22 17:41:34 +00002085 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002086 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
2087
2088 // Create the descriptor for the variable.
2089 llvm::DIVariable D =
Devang Patel16674e82011-02-22 18:56:36 +00002090 DBuilder.createComplexVariable(Tag,
Eric Christopherab5278e2011-10-11 23:00:51 +00002091 llvm::DIDescriptor(Scope),
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002092 VD->getName(), Unit, Line, Ty,
Jay Foadc556ef22011-04-24 10:11:03 +00002093 addr, ArgNo);
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002094
2095 // Insert an llvm.dbg.declare into the current block.
Eric Christopher73fb3502011-10-13 21:45:18 +00002096 // Insert an llvm.dbg.declare into the current block.
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002097 llvm::Instruction *Call =
Devang Patel16674e82011-02-22 18:56:36 +00002098 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
Devang Patelb1fd0eb2011-01-11 00:30:27 +00002099 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
2100 return;
2101 }
2102 // Create the descriptor for the variable.
Devang Patelcebbedd2010-10-12 23:24:54 +00002103 llvm::DIVariable D =
Devang Patel16674e82011-02-22 18:56:36 +00002104 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
Devang Patel823d8e92010-12-08 22:42:58 +00002105 Name, Unit, Line, Ty,
Devang Patel093ac462011-03-03 20:13:15 +00002106 CGM.getLangOptions().Optimize, Flags, ArgNo);
Devang Patelcebbedd2010-10-12 23:24:54 +00002107
2108 // Insert an llvm.dbg.declare into the current block.
2109 llvm::Instruction *Call =
Devang Patel16674e82011-02-22 18:56:36 +00002110 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
Devang Patelcebbedd2010-10-12 23:24:54 +00002111 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Devang Patelf4dd9622010-10-29 16:21:19 +00002112 return;
Devang Patelcebbedd2010-10-12 23:24:54 +00002113 }
2114
2115 // If VD is an anonymous union then Storage represents value for
2116 // all union fields.
John McCall8178df32011-02-22 22:38:33 +00002117 if (const RecordType *RT = dyn_cast<RecordType>(VD->getType())) {
2118 const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
2119 if (RD->isUnion()) {
2120 for (RecordDecl::field_iterator I = RD->field_begin(),
2121 E = RD->field_end();
2122 I != E; ++I) {
2123 FieldDecl *Field = *I;
2124 llvm::DIType FieldTy = getOrCreateType(Field->getType(), Unit);
Chris Lattner5f9e2722011-07-23 10:55:15 +00002125 StringRef FieldName = Field->getName();
Devang Patelcebbedd2010-10-12 23:24:54 +00002126
John McCall8178df32011-02-22 22:38:33 +00002127 // Ignore unnamed fields. Do not ignore unnamed records.
2128 if (FieldName.empty() && !isa<RecordType>(Field->getType()))
2129 continue;
Devang Patelcebbedd2010-10-12 23:24:54 +00002130
John McCall8178df32011-02-22 22:38:33 +00002131 // Use VarDecl's Tag, Scope and Line number.
2132 llvm::DIVariable D =
2133 DBuilder.createLocalVariable(Tag, llvm::DIDescriptor(Scope),
2134 FieldName, Unit, Line, FieldTy,
Devang Patel093ac462011-03-03 20:13:15 +00002135 CGM.getLangOptions().Optimize, Flags,
2136 ArgNo);
Devang Patelcebbedd2010-10-12 23:24:54 +00002137
John McCall8178df32011-02-22 22:38:33 +00002138 // Insert an llvm.dbg.declare into the current block.
2139 llvm::Instruction *Call =
2140 DBuilder.insertDeclare(Storage, D, Builder.GetInsertBlock());
John McCall8178df32011-02-22 22:38:33 +00002141 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column, Scope));
Devang Patelcebbedd2010-10-12 23:24:54 +00002142 }
John McCall8178df32011-02-22 22:38:33 +00002143 }
2144 }
Sanjiv Guptacc9b1632008-05-30 10:30:31 +00002145}
2146
Devang Patele2d01912011-04-25 23:43:36 +00002147void CGDebugInfo::EmitDeclareOfAutoVariable(const VarDecl *VD,
2148 llvm::Value *Storage,
2149 CGBuilderTy &Builder) {
2150 EmitDeclare(VD, llvm::dwarf::DW_TAG_auto_variable, Storage, 0, Builder);
2151}
Mike Stumpb1a6e682009-09-30 02:43:10 +00002152
Devang Patele2d01912011-04-25 23:43:36 +00002153void CGDebugInfo::EmitDeclareOfBlockDeclRefVariable(
2154 const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
2155 const CGBlockInfo &blockInfo) {
Eric Christopheraa2164c2011-09-29 00:00:45 +00002156 assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
Devang Patele2d01912011-04-25 23:43:36 +00002157
Devang Patel2b594b92010-04-26 23:28:46 +00002158 if (Builder.GetInsertBlock() == 0)
Mike Stumpb1a6e682009-09-30 02:43:10 +00002159 return;
Devang Patele2d01912011-04-25 23:43:36 +00002160
John McCall6b5a61b2011-02-07 10:33:21 +00002161 bool isByRef = VD->hasAttr<BlocksAttr>();
Devang Patele2d01912011-04-25 23:43:36 +00002162
Mike Stumpb1a6e682009-09-30 02:43:10 +00002163 uint64_t XOffset = 0;
Devang Patel17800552010-03-09 00:44:50 +00002164 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Devang Patel809b9bb2010-02-10 18:49:08 +00002165 llvm::DIType Ty;
John McCall6b5a61b2011-02-07 10:33:21 +00002166 if (isByRef)
Devang Patel809b9bb2010-02-10 18:49:08 +00002167 Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset);
2168 else
2169 Ty = getOrCreateType(VD->getType(), Unit);
Mike Stumpb1a6e682009-09-30 02:43:10 +00002170
2171 // Get location information.
Devang Patel8ab870d2010-05-12 23:46:38 +00002172 unsigned Line = getLineNumber(VD->getLocation());
2173 unsigned Column = getColumnNumber(VD->getLocation());
Mike Stumpb1a6e682009-09-30 02:43:10 +00002174
John McCall6b5a61b2011-02-07 10:33:21 +00002175 const llvm::TargetData &target = CGM.getTargetData();
2176
2177 CharUnits offset = CharUnits::fromQuantity(
2178 target.getStructLayout(blockInfo.StructureType)
2179 ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
2180
Chris Lattner5f9e2722011-07-23 10:55:15 +00002181 SmallVector<llvm::Value *, 9> addr;
Chris Lattner2acc6e32011-07-18 04:24:23 +00002182 llvm::Type *Int64Ty = llvm::Type::getInt64Ty(CGM.getLLVMContext());
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002183 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Chris Lattner14b1a362010-01-25 03:29:35 +00002184 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
John McCall6b5a61b2011-02-07 10:33:21 +00002185 if (isByRef) {
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002186 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2187 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Ken Dyck199c3d62010-01-11 17:06:35 +00002188 // offset of __forwarding field
Eric Christopherab5278e2011-10-11 23:00:51 +00002189 offset = CGM.getContext()
2190 .toCharUnitsFromBits(target.getPointerSizeInBits());
Chris Lattner14b1a362010-01-25 03:29:35 +00002191 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
Devang Patel4a4e2ef2011-02-18 23:29:22 +00002192 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpDeref));
2193 addr.push_back(llvm::ConstantInt::get(Int64Ty, llvm::DIBuilder::OpPlus));
Ken Dyck199c3d62010-01-11 17:06:35 +00002194 // offset of x field
Ken Dyck0ebce0e2011-04-22 17:41:34 +00002195 offset = CGM.getContext().toCharUnitsFromBits(XOffset);
Chris Lattner14b1a362010-01-25 03:29:35 +00002196 addr.push_back(llvm::ConstantInt::get(Int64Ty, offset.getQuantity()));
Mike Stumpb1a6e682009-09-30 02:43:10 +00002197 }
2198
2199 // Create the descriptor for the variable.
2200 llvm::DIVariable D =
Devang Patele2d01912011-04-25 23:43:36 +00002201 DBuilder.createComplexVariable(llvm::dwarf::DW_TAG_auto_variable,
Eric Christopheraa2164c2011-09-29 00:00:45 +00002202 llvm::DIDescriptor(LexicalBlockStack.back()),
Jay Foadc556ef22011-04-24 10:11:03 +00002203 VD->getName(), Unit, Line, Ty, addr);
Mike Stumpb1a6e682009-09-30 02:43:10 +00002204 // Insert an llvm.dbg.declare into the current block.
Eric Christopher73fb3502011-10-13 21:45:18 +00002205 llvm::Instruction *Call =
Devang Patel50811d22011-04-25 23:52:27 +00002206 DBuilder.insertDeclare(Storage, D, Builder.GetInsertPoint());
Eric Christopher73fb3502011-10-13 21:45:18 +00002207 Call->setDebugLoc(llvm::DebugLoc::get(Line, Column,
2208 LexicalBlockStack.back()));
Mike Stumpb1a6e682009-09-30 02:43:10 +00002209}
2210
Chris Lattner9c85ba32008-11-10 06:08:34 +00002211/// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
2212/// variable declaration.
Devang Pateld6c5a262010-02-01 21:52:22 +00002213void CGDebugInfo::EmitDeclareOfArgVariable(const VarDecl *VD, llvm::Value *AI,
Devang Patel093ac462011-03-03 20:13:15 +00002214 unsigned ArgNo,
Devang Patel34753802011-02-16 01:11:51 +00002215 CGBuilderTy &Builder) {
Devang Patel093ac462011-03-03 20:13:15 +00002216 EmitDeclare(VD, llvm::dwarf::DW_TAG_arg_variable, AI, ArgNo, Builder);
Chris Lattner9c85ba32008-11-10 06:08:34 +00002217}
2218
John McCall8178df32011-02-22 22:38:33 +00002219namespace {
2220 struct BlockLayoutChunk {
2221 uint64_t OffsetInBits;
2222 const BlockDecl::Capture *Capture;
2223 };
2224 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
2225 return l.OffsetInBits < r.OffsetInBits;
2226 }
2227}
Chris Lattner9c85ba32008-11-10 06:08:34 +00002228
John McCall8178df32011-02-22 22:38:33 +00002229void CGDebugInfo::EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
2230 llvm::Value *addr,
2231 CGBuilderTy &Builder) {
2232 ASTContext &C = CGM.getContext();
2233 const BlockDecl *blockDecl = block.getBlockDecl();
2234
2235 // Collect some general information about the block's location.
2236 SourceLocation loc = blockDecl->getCaretLocation();
2237 llvm::DIFile tunit = getOrCreateFile(loc);
2238 unsigned line = getLineNumber(loc);
2239 unsigned column = getColumnNumber(loc);
2240
2241 // Build the debug-info type for the block literal.
Nick Lewycky7d4b1592011-05-02 01:41:48 +00002242 getContextDescriptor(cast<Decl>(blockDecl->getDeclContext()));
John McCall8178df32011-02-22 22:38:33 +00002243
2244 const llvm::StructLayout *blockLayout =
2245 CGM.getTargetData().getStructLayout(block.StructureType);
2246
Chris Lattner5f9e2722011-07-23 10:55:15 +00002247 SmallVector<llvm::Value*, 16> fields;
John McCall8178df32011-02-22 22:38:33 +00002248 fields.push_back(createFieldType("__isa", C.VoidPtrTy, 0, loc, AS_public,
2249 blockLayout->getElementOffsetInBits(0),
Devang Patel1d323e02011-06-24 22:00:59 +00002250 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002251 fields.push_back(createFieldType("__flags", C.IntTy, 0, loc, AS_public,
2252 blockLayout->getElementOffsetInBits(1),
Devang Patel1d323e02011-06-24 22:00:59 +00002253 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002254 fields.push_back(createFieldType("__reserved", C.IntTy, 0, loc, AS_public,
2255 blockLayout->getElementOffsetInBits(2),
Devang Patel1d323e02011-06-24 22:00:59 +00002256 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002257 fields.push_back(createFieldType("__FuncPtr", C.VoidPtrTy, 0, loc, AS_public,
2258 blockLayout->getElementOffsetInBits(3),
Devang Patel1d323e02011-06-24 22:00:59 +00002259 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002260 fields.push_back(createFieldType("__descriptor",
2261 C.getPointerType(block.NeedsCopyDispose ?
2262 C.getBlockDescriptorExtendedType() :
2263 C.getBlockDescriptorType()),
2264 0, loc, AS_public,
2265 blockLayout->getElementOffsetInBits(4),
Devang Patel1d323e02011-06-24 22:00:59 +00002266 tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002267
2268 // We want to sort the captures by offset, not because DWARF
2269 // requires this, but because we're paranoid about debuggers.
Chris Lattner5f9e2722011-07-23 10:55:15 +00002270 SmallVector<BlockLayoutChunk, 8> chunks;
John McCall8178df32011-02-22 22:38:33 +00002271
2272 // 'this' capture.
2273 if (blockDecl->capturesCXXThis()) {
2274 BlockLayoutChunk chunk;
2275 chunk.OffsetInBits =
2276 blockLayout->getElementOffsetInBits(block.CXXThisIndex);
2277 chunk.Capture = 0;
2278 chunks.push_back(chunk);
2279 }
2280
2281 // Variable captures.
2282 for (BlockDecl::capture_const_iterator
2283 i = blockDecl->capture_begin(), e = blockDecl->capture_end();
2284 i != e; ++i) {
2285 const BlockDecl::Capture &capture = *i;
2286 const VarDecl *variable = capture.getVariable();
2287 const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
2288
2289 // Ignore constant captures.
2290 if (captureInfo.isConstant())
2291 continue;
2292
2293 BlockLayoutChunk chunk;
2294 chunk.OffsetInBits =
2295 blockLayout->getElementOffsetInBits(captureInfo.getIndex());
2296 chunk.Capture = &capture;
2297 chunks.push_back(chunk);
2298 }
2299
2300 // Sort by offset.
2301 llvm::array_pod_sort(chunks.begin(), chunks.end());
2302
Chris Lattner5f9e2722011-07-23 10:55:15 +00002303 for (SmallVectorImpl<BlockLayoutChunk>::iterator
John McCall8178df32011-02-22 22:38:33 +00002304 i = chunks.begin(), e = chunks.end(); i != e; ++i) {
2305 uint64_t offsetInBits = i->OffsetInBits;
2306 const BlockDecl::Capture *capture = i->Capture;
2307
2308 // If we have a null capture, this must be the C++ 'this' capture.
2309 if (!capture) {
2310 const CXXMethodDecl *method =
2311 cast<CXXMethodDecl>(blockDecl->getNonClosureContext());
2312 QualType type = method->getThisType(C);
2313
2314 fields.push_back(createFieldType("this", type, 0, loc, AS_public,
Devang Patel1d323e02011-06-24 22:00:59 +00002315 offsetInBits, tunit, tunit));
John McCall8178df32011-02-22 22:38:33 +00002316 continue;
2317 }
2318
2319 const VarDecl *variable = capture->getVariable();
Chris Lattner5f9e2722011-07-23 10:55:15 +00002320 StringRef name = variable->getName();
John McCalld113a6f2011-03-02 06:57:14 +00002321
2322 llvm::DIType fieldType;
2323 if (capture->isByRef()) {
2324 std::pair<uint64_t,unsigned> ptrInfo = C.getTypeInfo(C.VoidPtrTy);
2325
2326 // FIXME: this creates a second copy of this type!
2327 uint64_t xoffset;
2328 fieldType = EmitTypeForVarWithBlocksAttr(variable, &xoffset);
2329 fieldType = DBuilder.createPointerType(fieldType, ptrInfo.first);
Devang Patel1d323e02011-06-24 22:00:59 +00002330 fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
John McCalld113a6f2011-03-02 06:57:14 +00002331 ptrInfo.first, ptrInfo.second,
2332 offsetInBits, 0, fieldType);
2333 } else {
2334 fieldType = createFieldType(name, variable->getType(), 0,
Devang Patel1d323e02011-06-24 22:00:59 +00002335 loc, AS_public, offsetInBits, tunit, tunit);
John McCalld113a6f2011-03-02 06:57:14 +00002336 }
2337 fields.push_back(fieldType);
John McCall8178df32011-02-22 22:38:33 +00002338 }
2339
2340 llvm::SmallString<36> typeName;
2341 llvm::raw_svector_ostream(typeName)
2342 << "__block_literal_" << CGM.getUniqueBlockCount();
2343
Jay Foadc556ef22011-04-24 10:11:03 +00002344 llvm::DIArray fieldsArray = DBuilder.getOrCreateArray(fields);
John McCall8178df32011-02-22 22:38:33 +00002345
2346 llvm::DIType type =
2347 DBuilder.createStructType(tunit, typeName.str(), tunit, line,
2348 CGM.getContext().toBits(block.BlockSize),
2349 CGM.getContext().toBits(block.BlockAlign),
2350 0, fieldsArray);
2351 type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
2352
2353 // Get overall information about the block.
2354 unsigned flags = llvm::DIDescriptor::FlagArtificial;
Eric Christopheraa2164c2011-09-29 00:00:45 +00002355 llvm::MDNode *scope = LexicalBlockStack.back();
Chris Lattner5f9e2722011-07-23 10:55:15 +00002356 StringRef name = ".block_descriptor";
John McCall8178df32011-02-22 22:38:33 +00002357
2358 // Create the descriptor for the parameter.
2359 llvm::DIVariable debugVar =
2360 DBuilder.createLocalVariable(llvm::dwarf::DW_TAG_arg_variable,
2361 llvm::DIDescriptor(scope),
2362 name, tunit, line, type,
Devang Patel093ac462011-03-03 20:13:15 +00002363 CGM.getLangOptions().Optimize, flags,
2364 cast<llvm::Argument>(addr)->getArgNo() + 1);
John McCall8178df32011-02-22 22:38:33 +00002365
2366 // Insert an llvm.dbg.value into the current block.
2367 llvm::Instruction *declare =
2368 DBuilder.insertDbgValueIntrinsic(addr, 0, debugVar,
2369 Builder.GetInsertBlock());
2370 declare->setDebugLoc(llvm::DebugLoc::get(line, column, scope));
2371}
Chris Lattner9c85ba32008-11-10 06:08:34 +00002372
Sanjiv Gupta686226b2008-06-05 08:59:10 +00002373/// EmitGlobalVariable - Emit information about a global variable.
Mike Stump1eb44332009-09-09 15:08:12 +00002374void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Devang Pateleb6d79b2010-02-01 21:34:11 +00002375 const VarDecl *D) {
Sanjiv Gupta686226b2008-06-05 08:59:10 +00002376 // Create global variable debug descriptor.
Devang Patel17800552010-03-09 00:44:50 +00002377 llvm::DIFile Unit = getOrCreateFile(D->getLocation());
Devang Patel8ab870d2010-05-12 23:46:38 +00002378 unsigned LineNo = getLineNumber(D->getLocation());
Chris Lattner8ec03f52008-11-24 03:54:41 +00002379
Eric Christopher73fb3502011-10-13 21:45:18 +00002380 setLocation(D->getLocation());
2381
Devang Pateleb6d79b2010-02-01 21:34:11 +00002382 QualType T = D->getType();
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002383 if (T->isIncompleteArrayType()) {
Mike Stump1eb44332009-09-09 15:08:12 +00002384
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002385 // CodeGen turns int[] into int[1] so we'll do the same here.
2386 llvm::APSInt ConstVal(32);
Mike Stump1eb44332009-09-09 15:08:12 +00002387
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002388 ConstVal = 1;
Anders Carlsson20f12a22009-12-06 18:00:51 +00002389 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
Mike Stump1eb44332009-09-09 15:08:12 +00002390
Anders Carlsson20f12a22009-12-06 18:00:51 +00002391 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
Nick Lewyckyd4c100e2011-11-09 04:25:21 +00002392 ArrayType::Normal, 0);
Anders Carlsson4d6e8dd2008-11-26 17:40:42 +00002393 }
Chris Lattner5f9e2722011-07-23 10:55:15 +00002394 StringRef DeclName = D->getName();
2395 StringRef LinkageName;
Devang Pateleb4c45b2011-02-09 19:16:38 +00002396 if (D->getDeclContext() && !isa<FunctionDecl>(D->getDeclContext())
2397 && !isa<ObjCMethodDecl>(D->getDeclContext()))
Devang Patel8b90a782010-05-13 23:52:37 +00002398 LinkageName = Var->getName();
Devang Patel58faf202010-10-22 17:11:50 +00002399 if (LinkageName == DeclName)
Chris Lattner5f9e2722011-07-23 10:55:15 +00002400 LinkageName = StringRef();
Devang Pateleb6d79b2010-02-01 21:34:11 +00002401 llvm::DIDescriptor DContext =
Devang Patel170cef32010-12-09 00:33:05 +00002402 getContextDescriptor(dyn_cast<Decl>(D->getDeclContext()));
Devang Patel16674e82011-02-22 18:56:36 +00002403 DBuilder.createStaticVariable(DContext, DeclName, LinkageName,
Devang Patel823d8e92010-12-08 22:42:58 +00002404 Unit, LineNo, getOrCreateType(T, Unit),
2405 Var->hasInternalLinkage(), Var);
Sanjiv Gupta686226b2008-06-05 08:59:10 +00002406}
2407
Devang Patel9ca36b62009-02-26 21:10:26 +00002408/// EmitGlobalVariable - Emit information about an objective-c interface.
Mike Stump1eb44332009-09-09 15:08:12 +00002409void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
Devang Pateld6c5a262010-02-01 21:52:22 +00002410 ObjCInterfaceDecl *ID) {
Devang Patel9ca36b62009-02-26 21:10:26 +00002411 // Create global variable debug descriptor.
Devang Patel17800552010-03-09 00:44:50 +00002412 llvm::DIFile Unit = getOrCreateFile(ID->getLocation());
Devang Patel8ab870d2010-05-12 23:46:38 +00002413 unsigned LineNo = getLineNumber(ID->getLocation());
Devang Patel9ca36b62009-02-26 21:10:26 +00002414
Chris Lattner5f9e2722011-07-23 10:55:15 +00002415 StringRef Name = ID->getName();
Devang Patel9ca36b62009-02-26 21:10:26 +00002416
Devang Pateld6c5a262010-02-01 21:52:22 +00002417 QualType T = CGM.getContext().getObjCInterfaceType(ID);
Devang Patel9ca36b62009-02-26 21:10:26 +00002418 if (T->isIncompleteArrayType()) {
Mike Stump1eb44332009-09-09 15:08:12 +00002419
Devang Patel9ca36b62009-02-26 21:10:26 +00002420 // CodeGen turns int[] into int[1] so we'll do the same here.
2421 llvm::APSInt ConstVal(32);
Mike Stump1eb44332009-09-09 15:08:12 +00002422
Devang Patel9ca36b62009-02-26 21:10:26 +00002423 ConstVal = 1;
Anders Carlsson20f12a22009-12-06 18:00:51 +00002424 QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
Mike Stump1eb44332009-09-09 15:08:12 +00002425
Anders Carlsson20f12a22009-12-06 18:00:51 +00002426 T = CGM.getContext().getConstantArrayType(ET, ConstVal,
Devang Patel9ca36b62009-02-26 21:10:26 +00002427 ArrayType::Normal, 0);
2428 }
2429
Devang Patel16674e82011-02-22 18:56:36 +00002430 DBuilder.createGlobalVariable(Name, Unit, LineNo,
Devang Patel823d8e92010-12-08 22:42:58 +00002431 getOrCreateType(T, Unit),
2432 Var->hasInternalLinkage(), Var);
Devang Patel9ca36b62009-02-26 21:10:26 +00002433}
Devang Patelabb485f2010-02-01 19:16:32 +00002434
Devang Patel25c2c8f2010-08-10 17:53:33 +00002435/// EmitGlobalVariable - Emit global variable's debug info.
2436void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD,
John McCall189d6ef2010-10-09 01:34:31 +00002437 llvm::Constant *Init) {
Devang Patel8d308382010-08-10 07:24:25 +00002438 // Create the descriptor for the variable.
2439 llvm::DIFile Unit = getOrCreateFile(VD->getLocation());
Chris Lattner5f9e2722011-07-23 10:55:15 +00002440 StringRef Name = VD->getName();
Devang Patel0317ab02010-08-10 18:27:15 +00002441 llvm::DIType Ty = getOrCreateType(VD->getType(), Unit);
Devang Patel6237cea2010-08-23 22:07:25 +00002442 if (const EnumConstantDecl *ECD = dyn_cast<EnumConstantDecl>(VD)) {
2443 if (const EnumDecl *ED = dyn_cast<EnumDecl>(ECD->getDeclContext()))
Devang Patel31f7d022011-01-17 22:23:07 +00002444 Ty = CreateEnumType(ED);
Devang Patel6237cea2010-08-23 22:07:25 +00002445 }
Devang Patel0317ab02010-08-10 18:27:15 +00002446 // Do not use DIGlobalVariable for enums.
2447 if (Ty.getTag() == llvm::dwarf::DW_TAG_enumeration_type)
2448 return;
Devang Patel16674e82011-02-22 18:56:36 +00002449 DBuilder.createStaticVariable(Unit, Name, Name, Unit,
Devang Patel823d8e92010-12-08 22:42:58 +00002450 getLineNumber(VD->getLocation()),
2451 Ty, true, Init);
Devang Patel8d308382010-08-10 07:24:25 +00002452}
2453
Devang Patelabb485f2010-02-01 19:16:32 +00002454/// getOrCreateNamesSpace - Return namespace descriptor for the given
2455/// namespace decl.
2456llvm::DINameSpace
Devang Patel170cef32010-12-09 00:33:05 +00002457CGDebugInfo::getOrCreateNameSpace(const NamespaceDecl *NSDecl) {
Devang Patelabb485f2010-02-01 19:16:32 +00002458 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH>::iterator I =
2459 NameSpaceCache.find(NSDecl);
2460 if (I != NameSpaceCache.end())
2461 return llvm::DINameSpace(cast<llvm::MDNode>(I->second));
2462
Devang Patel8ab870d2010-05-12 23:46:38 +00002463 unsigned LineNo = getLineNumber(NSDecl->getLocation());
Devang Patel8c376682010-10-28 19:12:46 +00002464 llvm::DIFile FileD = getOrCreateFile(NSDecl->getLocation());
Devang Patelabb485f2010-02-01 19:16:32 +00002465 llvm::DIDescriptor Context =
Devang Patel170cef32010-12-09 00:33:05 +00002466 getContextDescriptor(dyn_cast<Decl>(NSDecl->getDeclContext()));
Devang Patelabb485f2010-02-01 19:16:32 +00002467 llvm::DINameSpace NS =
Devang Patel16674e82011-02-22 18:56:36 +00002468 DBuilder.createNameSpace(Context, NSDecl->getName(), FileD, LineNo);
Devang Patelab699792010-05-07 18:12:35 +00002469 NameSpaceCache[NSDecl] = llvm::WeakVH(NS);
Devang Patelabb485f2010-02-01 19:16:32 +00002470 return NS;
2471}
Devang Patele80d5672011-03-23 16:29:39 +00002472
2473/// UpdateCompletedType - Update type cache because the type is now
2474/// translated.
2475void CGDebugInfo::UpdateCompletedType(const TagDecl *TD) {
2476 QualType Ty = CGM.getContext().getTagDeclType(TD);
2477
2478 // If the type exist in type cache then remove it from the cache.
2479 // There is no need to prepare debug info for the completed type
2480 // right now. It will be generated on demand lazily.
2481 llvm::DenseMap<void *, llvm::WeakVH>::iterator it =
2482 TypeCache.find(Ty.getAsOpaquePtr());
2483 if (it != TypeCache.end())
2484 TypeCache.erase(it);
2485}