blob: 0443dc338858e52d8b7918061c8f18761e2347e4 [file] [log] [blame]
Daniel Dunbar3845f862008-10-31 03:54:29 +00001//===--- CGDebugInfo.h - DebugInfo for LLVM CodeGen -------------*- C++ -*-===//
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +00002//
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//
Mike Stump1eb44332009-09-09 15:08:12 +000010// This is the source level debug info generator for llvm translation.
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000011//
12//===----------------------------------------------------------------------===//
13
14#ifndef CLANG_CODEGEN_CGDEBUGINFO_H
15#define CLANG_CODEGEN_CGDEBUGINFO_H
16
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000017#include "clang/AST/Type.h"
Mike Stumpb1a6e682009-09-30 02:43:10 +000018#include "clang/AST/Expr.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000019#include "clang/Basic/SourceLocation.h"
Chris Lattner9c85ba32008-11-10 06:08:34 +000020#include "llvm/ADT/DenseMap.h"
21#include "llvm/Analysis/DebugInfo.h"
Daniel Dunbar23e81ba2009-09-19 19:27:24 +000022#include "llvm/Support/ValueHandle.h"
Devang Patel9c6c3a02010-01-14 00:36:21 +000023#include "llvm/Support/Allocator.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000024
Daniel Dunbar45d196b2008-11-01 01:53:16 +000025#include "CGBuilder.h"
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000026
Daniel Dunbar23e81ba2009-09-19 19:27:24 +000027namespace llvm {
28 class MDNode;
29}
30
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000031namespace clang {
Sanjiv Guptacc9b1632008-05-30 10:30:31 +000032 class VarDecl;
Devang Patel9ca36b62009-02-26 21:10:26 +000033 class ObjCInterfaceDecl;
Daniel Dunbar45d196b2008-11-01 01:53:16 +000034
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000035namespace CodeGen {
36 class CodeGenModule;
Mike Stumpb1a6e682009-09-30 02:43:10 +000037 class CodeGenFunction;
Devang Patel9c6c3a02010-01-14 00:36:21 +000038 class GlobalDecl;
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000039
Mike Stump1eb44332009-09-09 15:08:12 +000040/// CGDebugInfo - This class gathers all debug information during compilation
41/// and is responsible for emitting to llvm globals or pass directly to
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000042/// the backend.
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +000043class CGDebugInfo {
Anders Carlsson20f12a22009-12-06 18:00:51 +000044 CodeGenModule &CGM;
Chris Lattner9c85ba32008-11-10 06:08:34 +000045 llvm::DIFactory DebugFactory;
Devang Patel17800552010-03-09 00:44:50 +000046 llvm::DICompileUnit TheCU;
Chris Lattner9c85ba32008-11-10 06:08:34 +000047 SourceLocation CurLoc, PrevLoc;
Devang Patel4ce3f202010-01-28 18:11:52 +000048 llvm::DIType VTablePtrType;
Devang Patel17800552010-03-09 00:44:50 +000049
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000050 /// TypeCache - Cache of previously constructed Types.
Ted Kremenek590838b2010-03-29 18:29:57 +000051 llvm::DenseMap<void *, llvm::WeakVH> TypeCache;
Mike Stump1eb44332009-09-09 15:08:12 +000052
Mike Stump9bc093c2009-05-14 02:03:51 +000053 bool BlockLiteralGenericSet;
54 llvm::DIType BlockLiteralGeneric;
55
Devang Patel8fae0602009-11-13 19:10:24 +000056 std::vector<llvm::TrackingVH<llvm::MDNode> > RegionStack;
Devang Patel3dd96a12010-01-29 18:11:03 +000057 llvm::DenseMap<const Decl *, llvm::WeakVH> RegionMap;
Devang Patel5a6fbcf2010-07-22 22:29:16 +000058 // FnBeginRegionCount - Keep track of RegionStack counter at the beginning
59 // of a function. This is used to pop unbalanced regions at the end of a
60 // function.
61 std::vector<unsigned> FnBeginRegionCount;
62
63 /// LineDirectiveFiles - This stack is used to keep track of
64 /// scopes introduced by #line directives.
65 std::vector<const char *> LineDirectiveFiles;
Eli Friedman3f2af102008-05-22 01:40:10 +000066
Devang Patel89f05f82010-01-28 18:21:00 +000067 /// DebugInfoNames - This is a storage for names that are
Devang Patel9c6c3a02010-01-14 00:36:21 +000068 /// constructed on demand. For example, C++ destructors, C++ operators etc..
Devang Patel89f05f82010-01-28 18:21:00 +000069 llvm::BumpPtrAllocator DebugInfoNames;
Devang Patelac4d13c2010-07-27 15:17:16 +000070 llvm::StringRef CWDName;
Devang Patel9c6c3a02010-01-14 00:36:21 +000071
Ted Kremenek9c250392010-03-30 00:27:51 +000072 llvm::DenseMap<const char *, llvm::WeakVH> DIFileCache;
Devang Patel4125fd22010-01-19 01:54:44 +000073 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH> SPCache;
Devang Patelabb485f2010-02-01 19:16:32 +000074 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH> NameSpaceCache;
Devang Patel4125fd22010-01-19 01:54:44 +000075
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +000076 /// Helper functions for getOrCreateType.
Devang Patel17800552010-03-09 00:44:50 +000077 llvm::DIType CreateType(const BuiltinType *Ty, llvm::DIFile F);
78 llvm::DIType CreateType(const ComplexType *Ty, llvm::DIFile F);
79 llvm::DIType CreateQualifiedType(QualType Ty, llvm::DIFile F);
80 llvm::DIType CreateType(const TypedefType *Ty, llvm::DIFile F);
Mike Stump1eb44332009-09-09 15:08:12 +000081 llvm::DIType CreateType(const ObjCObjectPointerType *Ty,
Devang Patel17800552010-03-09 00:44:50 +000082 llvm::DIFile F);
83 llvm::DIType CreateType(const PointerType *Ty, llvm::DIFile F);
84 llvm::DIType CreateType(const BlockPointerType *Ty, llvm::DIFile F);
85 llvm::DIType CreateType(const FunctionType *Ty, llvm::DIFile F);
86 llvm::DIType CreateType(const TagType *Ty, llvm::DIFile F);
87 llvm::DIType CreateType(const RecordType *Ty, llvm::DIFile F);
88 llvm::DIType CreateType(const ObjCInterfaceType *Ty, llvm::DIFile F);
John McCallc12c5bb2010-05-15 11:32:37 +000089 llvm::DIType CreateType(const ObjCObjectType *Ty, llvm::DIFile F);
Devang Patel17800552010-03-09 00:44:50 +000090 llvm::DIType CreateType(const EnumType *Ty, llvm::DIFile F);
91 llvm::DIType CreateType(const VectorType *Ty, llvm::DIFile F);
92 llvm::DIType CreateType(const ArrayType *Ty, llvm::DIFile F);
93 llvm::DIType CreateType(const LValueReferenceType *Ty, llvm::DIFile F);
94 llvm::DIType CreateType(const MemberPointerType *Ty, llvm::DIFile F);
Devang Patela6da1922010-01-28 00:28:01 +000095 llvm::DIType getOrCreateMethodType(const CXXMethodDecl *Method,
Devang Patel17800552010-03-09 00:44:50 +000096 llvm::DIFile F);
97 llvm::DIType getOrCreateVTablePtrType(llvm::DIFile F);
Devang Patelabb485f2010-02-01 19:16:32 +000098 llvm::DINameSpace getOrCreateNameSpace(const NamespaceDecl *N,
99 llvm::DIDescriptor Unit);
100
Anders Carlssona031b352009-11-06 19:19:55 +0000101 llvm::DIType CreatePointerLikeType(unsigned Tag,
102 const Type *Ty, QualType PointeeTy,
Devang Patel17800552010-03-09 00:44:50 +0000103 llvm::DIFile F);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000104
Anders Carlsson4433f1c2010-01-26 05:19:50 +0000105 llvm::DISubprogram CreateCXXMemberFunction(const CXXMethodDecl *Method,
Devang Patel17800552010-03-09 00:44:50 +0000106 llvm::DIFile F,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000107 llvm::DIType RecordTy);
Anders Carlssond6f9a0d2010-01-26 04:49:33 +0000108
Devang Patel4125fd22010-01-19 01:54:44 +0000109 void CollectCXXMemberFunctions(const CXXRecordDecl *Decl,
Devang Patel17800552010-03-09 00:44:50 +0000110 llvm::DIFile F,
Devang Patel4125fd22010-01-19 01:54:44 +0000111 llvm::SmallVectorImpl<llvm::DIDescriptor> &E,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000112 llvm::DIType T);
Devang Patela245c5b2010-01-25 23:32:18 +0000113 void CollectCXXBases(const CXXRecordDecl *Decl,
Devang Patel17800552010-03-09 00:44:50 +0000114 llvm::DIFile F,
Devang Patela245c5b2010-01-25 23:32:18 +0000115 llvm::SmallVectorImpl<llvm::DIDescriptor> &EltTys,
Dan Gohman4cac5b42010-08-20 22:02:57 +0000116 llvm::DIType RecordTy);
Devang Patela245c5b2010-01-25 23:32:18 +0000117
118
Devang Patel17800552010-03-09 00:44:50 +0000119 void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile F,
Devang Patel428deb52010-01-19 00:00:59 +0000120 llvm::SmallVectorImpl<llvm::DIDescriptor> &E);
Devang Patel4ce3f202010-01-28 18:11:52 +0000121
Anders Carlsson046c2942010-04-17 20:15:18 +0000122 void CollectVTableInfo(const CXXRecordDecl *Decl,
Devang Patel17800552010-03-09 00:44:50 +0000123 llvm::DIFile F,
Devang Patel4ce3f202010-01-28 18:11:52 +0000124 llvm::SmallVectorImpl<llvm::DIDescriptor> &EltTys);
125
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000126public:
Anders Carlsson20f12a22009-12-06 18:00:51 +0000127 CGDebugInfo(CodeGenModule &CGM);
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000128 ~CGDebugInfo();
129
Daniel Dunbar66031a52008-10-17 16:15:48 +0000130 /// setLocation - Update the current source location. If \arg loc is
131 /// invalid it is ignored.
Chris Lattner9c85ba32008-11-10 06:08:34 +0000132 void setLocation(SourceLocation Loc);
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000133
134 /// EmitStopPoint - Emit a call to llvm.dbg.stoppoint to indicate a change of
135 /// source line.
Devang Patel4d939e62010-07-20 22:20:10 +0000136 void EmitStopPoint(CGBuilderTy &Builder);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000137
138 /// EmitFunctionStart - Emit a call to llvm.dbg.function.start to indicate
Daniel Dunbar2284ac92008-10-18 18:22:23 +0000139 /// start of a new function.
Devang Patel9c6c3a02010-01-14 00:36:21 +0000140 void EmitFunctionStart(GlobalDecl GD, QualType FnType,
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000141 llvm::Function *Fn, CGBuilderTy &Builder);
Mike Stump1eb44332009-09-09 15:08:12 +0000142
Devang Patel5a6fbcf2010-07-22 22:29:16 +0000143 /// EmitFunctionEnd - Constructs the debug code for exiting a function.
144 void EmitFunctionEnd(CGBuilderTy &Builder);
145
146 /// UpdateLineDirectiveRegion - Update region stack only if #line directive
147 /// has introduced scope change.
148 void UpdateLineDirectiveRegion(CGBuilderTy &Builder);
149
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000150 /// EmitRegionStart - Emit a call to llvm.dbg.region.start to indicate start
Mike Stump1eb44332009-09-09 15:08:12 +0000151 /// of a new block.
Devang Patel4d939e62010-07-20 22:20:10 +0000152 void EmitRegionStart(CGBuilderTy &Builder);
Mike Stump1eb44332009-09-09 15:08:12 +0000153
154 /// EmitRegionEnd - Emit call to llvm.dbg.region.end to indicate end of a
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000155 /// block.
Devang Patel4d939e62010-07-20 22:20:10 +0000156 void EmitRegionEnd(CGBuilderTy &Builder);
Sanjiv Guptacc9b1632008-05-30 10:30:31 +0000157
Chris Lattner9c85ba32008-11-10 06:08:34 +0000158 /// EmitDeclareOfAutoVariable - Emit call to llvm.dbg.declare for an automatic
159 /// variable declaration.
160 void EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI,
161 CGBuilderTy &Builder);
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000162
Mike Stumpb1a6e682009-09-30 02:43:10 +0000163 /// EmitDeclareOfBlockDeclRefVariable - Emit call to llvm.dbg.declare for an
164 /// imported variable declaration in a block.
165 void EmitDeclareOfBlockDeclRefVariable(const BlockDeclRefExpr *BDRE,
166 llvm::Value *AI,
167 CGBuilderTy &Builder,
168 CodeGenFunction *CGF);
169
Chris Lattner9c85ba32008-11-10 06:08:34 +0000170 /// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
171 /// variable declaration.
172 void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI,
173 CGBuilderTy &Builder);
Mike Stump1eb44332009-09-09 15:08:12 +0000174
Sanjiv Gupta686226b2008-06-05 08:59:10 +0000175 /// EmitGlobalVariable - Emit information about a global variable.
Chris Lattner9c85ba32008-11-10 06:08:34 +0000176 void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
Devang Patel9ca36b62009-02-26 21:10:26 +0000177
178 /// EmitGlobalVariable - Emit information about an objective-c interface.
179 void EmitGlobalVariable(llvm::GlobalVariable *GV, ObjCInterfaceDecl *Decl);
Mike Stump1eb44332009-09-09 15:08:12 +0000180
Devang Patel25c2c8f2010-08-10 17:53:33 +0000181 /// EmitGlobalVariable - Emit global variable's debug info.
182 void EmitGlobalVariable(const ValueDecl *VD, llvm::ConstantInt *Init,
Devang Patel8d308382010-08-10 07:24:25 +0000183 CGBuilderTy &Builder);
184
Chris Lattner86cd8af2008-11-03 09:11:11 +0000185private:
Chris Lattner9c85ba32008-11-10 06:08:34 +0000186 /// EmitDeclare - Emit call to llvm.dbg.declare for a variable declaration.
187 void EmitDeclare(const VarDecl *decl, unsigned Tag, llvm::Value *AI,
188 CGBuilderTy &Builder);
Mike Stump1eb44332009-09-09 15:08:12 +0000189
Mike Stumpb1a6e682009-09-30 02:43:10 +0000190 /// EmitDeclare - Emit call to llvm.dbg.declare for a variable declaration.
191 void EmitDeclare(const BlockDeclRefExpr *BDRE, unsigned Tag, llvm::Value *AI,
192 CGBuilderTy &Builder, CodeGenFunction *CGF);
Mike Stump1eb44332009-09-09 15:08:12 +0000193
Devang Patel809b9bb2010-02-10 18:49:08 +0000194 // EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
195 // See BuildByRefType.
196 llvm::DIType EmitTypeForVarWithBlocksAttr(const ValueDecl *VD,
197 uint64_t *OffSet);
198
Devang Patel33583052010-01-28 23:15:27 +0000199 /// getContextDescriptor - Get context info for the decl.
Devang Patel3dd96a12010-01-29 18:11:03 +0000200 llvm::DIDescriptor getContextDescriptor(const Decl *Decl,
Devang Patel33583052010-01-28 23:15:27 +0000201 llvm::DIDescriptor &CU);
Devang Patel979ec2e2009-10-06 00:35:31 +0000202
Devang Patelac4d13c2010-07-27 15:17:16 +0000203 /// getCurrentDirname - Return current directory name.
204 llvm::StringRef getCurrentDirname();
205
Devang Patel17800552010-03-09 00:44:50 +0000206 /// CreateCompileUnit - Create new compile unit.
207 void CreateCompileUnit();
208
209 /// getOrCreateFile - Get the file debug info descriptor for the input
210 /// location.
211 llvm::DIFile getOrCreateFile(SourceLocation Loc);
Sanjiv Gupta1c6a38b2008-05-25 05:15:42 +0000212
213 /// getOrCreateType - Get the type from the cache or create a new type if
214 /// necessary.
Devang Patel17800552010-03-09 00:44:50 +0000215 llvm::DIType getOrCreateType(QualType Ty, llvm::DIFile F);
Daniel Dunbar03faac32009-09-19 19:27:14 +0000216
217 /// CreateTypeNode - Create type metadata for a source language type.
Devang Patel17800552010-03-09 00:44:50 +0000218 llvm::DIType CreateTypeNode(QualType Ty, llvm::DIFile F);
Devang Patel9c6c3a02010-01-14 00:36:21 +0000219
Benjamin Kramerd3651cc2010-04-24 20:26:20 +0000220 /// CreateMemberType - Create new member and increase Offset by FType's size.
Benjamin Kramer48c70f62010-04-24 20:19:58 +0000221 llvm::DIType CreateMemberType(llvm::DIFile Unit, QualType FType,
222 llvm::StringRef Name, uint64_t *Offset);
223
Devang Patel9c6c3a02010-01-14 00:36:21 +0000224 /// getFunctionName - Get function name for the given FunctionDecl. If the
225 /// name is constructred on demand (e.g. C++ destructor) then the name
226 /// is stored on the side.
227 llvm::StringRef getFunctionName(const FunctionDecl *FD);
Devang Patel4ce3f202010-01-28 18:11:52 +0000228
Devang Patel700a1cb2010-07-20 20:24:18 +0000229 /// getClassName - Get class name including template argument list.
230 llvm::StringRef getClassName(RecordDecl *RD);
231
Anders Carlsson046c2942010-04-17 20:15:18 +0000232 /// getVTableName - Get vtable name for the given Class.
233 llvm::StringRef getVTableName(const CXXRecordDecl *Decl);
Devang Patel4ce3f202010-01-28 18:11:52 +0000234
Devang Patel8ab870d2010-05-12 23:46:38 +0000235 /// getLineNumber - Get line number for the location. If location is invalid
236 /// then use current location.
237 unsigned getLineNumber(SourceLocation Loc);
238
239 /// getColumnNumber - Get column number for the location. If location is
240 /// invalid then use current location.
241 unsigned getColumnNumber(SourceLocation Loc);
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000242};
243} // namespace CodeGen
244} // namespace clang
245
Devang Patelbbd9fa42009-10-06 18:36:08 +0000246
Sanjiv Guptae8b9f5b2008-05-08 08:54:20 +0000247#endif