1 //===--- CGDebugInfo.h - DebugInfo for LLVM CodeGen -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the source level debug info generator for llvm translation.
12 //===----------------------------------------------------------------------===//
14 #ifndef CLANG_CODEGEN_CGDEBUGINFO_H
15 #define CLANG_CODEGEN_CGDEBUGINFO_H
17 #include "CGBuilder.h"
18 #include "clang/AST/Expr.h"
19 #include "clang/AST/Type.h"
20 #include "clang/Basic/SourceLocation.h"
21 #include "clang/Frontend/CodeGenOptions.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/DIBuilder.h"
24 #include "llvm/DebugInfo.h"
25 #include "llvm/Support/Allocator.h"
26 #include "llvm/Support/ValueHandle.h"
35 class ObjCInterfaceDecl;
37 class ClassTemplateSpecializationDecl;
43 class CodeGenFunction;
46 /// CGDebugInfo - This class gathers all debug information during compilation
47 /// and is responsible for emitting to llvm globals or pass directly to
50 friend class NoLocation;
51 friend class ArtificialLocation;
53 const CodeGenOptions::DebugInfoKind DebugKind;
54 llvm::DIBuilder DBuilder;
55 llvm::DICompileUnit TheCU;
56 SourceLocation CurLoc, PrevLoc;
57 llvm::DIType VTablePtrType;
59 llvm::DICompositeType ObjTy;
61 llvm::DIType OCLImage1dDITy, OCLImage1dArrayDITy, OCLImage1dBufferDITy;
62 llvm::DIType OCLImage2dDITy, OCLImage2dArrayDITy;
63 llvm::DIType OCLImage3dDITy;
64 llvm::DIType OCLEventDITy;
65 llvm::DIType BlockLiteralGeneric;
67 /// TypeCache - Cache of previously constructed Types.
68 llvm::DenseMap<void *, llvm::WeakVH> TypeCache;
70 /// ObjCInterfaceCache - Cache of previously constructed interfaces
71 /// which may change. Storing a pair of DIType and checksum.
72 llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned> > ObjCInterfaceCache;
74 /// RetainedTypes - list of interfaces we want to keep even if orphaned.
75 std::vector<void *> RetainedTypes;
77 /// CompleteTypeCache - Cache of previously constructed complete RecordTypes.
78 llvm::DenseMap<void *, llvm::WeakVH> CompletedTypeCache;
80 /// ReplaceMap - Cache of forward declared types to RAUW at the end of
82 std::vector<std::pair<void *, llvm::WeakVH> >ReplaceMap;
84 // LexicalBlockStack - Keep track of our current nested lexical block.
85 std::vector<llvm::TrackingVH<llvm::MDNode> > LexicalBlockStack;
86 llvm::DenseMap<const Decl *, llvm::WeakVH> RegionMap;
87 // FnBeginRegionCount - Keep track of LexicalBlockStack counter at the
88 // beginning of a function. This is used to pop unbalanced regions at
89 // the end of a function.
90 std::vector<unsigned> FnBeginRegionCount;
92 /// DebugInfoNames - This is a storage for names that are
93 /// constructed on demand. For example, C++ destructors, C++ operators etc..
94 llvm::BumpPtrAllocator DebugInfoNames;
97 llvm::DenseMap<const char *, llvm::WeakVH> DIFileCache;
98 llvm::DenseMap<const FunctionDecl *, llvm::WeakVH> SPCache;
99 /// \brief Cache declarations relevant to DW_TAG_imported_declarations (C++
100 /// using declarations) that aren't covered by other more specific caches.
101 llvm::DenseMap<const Decl *, llvm::WeakVH> DeclCache;
102 llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH> NameSpaceCache;
103 llvm::DenseMap<const NamespaceAliasDecl *, llvm::WeakVH> NamespaceAliasCache;
104 llvm::DenseMap<const Decl *, llvm::WeakVH> StaticDataMemberCache;
106 /// Helper functions for getOrCreateType.
107 unsigned Checksum(const ObjCInterfaceDecl *InterfaceDecl);
108 llvm::DIType CreateType(const BuiltinType *Ty);
109 llvm::DIType CreateType(const ComplexType *Ty);
110 llvm::DIType CreateQualifiedType(QualType Ty, llvm::DIFile F, bool Declaration);
111 llvm::DIType CreateType(const TypedefType *Ty, llvm::DIFile F, bool Declaration);
112 llvm::DIType CreateType(const ObjCObjectPointerType *Ty,
114 llvm::DIType CreateType(const PointerType *Ty, llvm::DIFile F);
115 llvm::DIType CreateType(const BlockPointerType *Ty, llvm::DIFile F);
116 llvm::DIType CreateType(const FunctionType *Ty, llvm::DIFile F);
117 llvm::DIType CreateType(const RecordType *Ty, bool Declaration);
118 llvm::DIType CreateTypeDefinition(const RecordType *Ty);
119 llvm::DIType CreateLimitedType(const RecordType *Ty);
120 llvm::DIType CreateType(const ObjCInterfaceType *Ty, llvm::DIFile F);
121 llvm::DIType CreateType(const ObjCObjectType *Ty, llvm::DIFile F);
122 llvm::DIType CreateType(const VectorType *Ty, llvm::DIFile F);
123 llvm::DIType CreateType(const ArrayType *Ty, llvm::DIFile F);
124 llvm::DIType CreateType(const LValueReferenceType *Ty, llvm::DIFile F);
125 llvm::DIType CreateType(const RValueReferenceType *Ty, llvm::DIFile Unit);
126 llvm::DIType CreateType(const MemberPointerType *Ty, llvm::DIFile F);
127 llvm::DIType CreateType(const AtomicType *Ty, llvm::DIFile F);
128 llvm::DIType CreateEnumType(const EnumDecl *ED);
129 llvm::DIType CreateSelfType(const QualType &QualTy, llvm::DIType Ty);
130 llvm::DIType getTypeOrNull(const QualType);
131 llvm::DIType getCompletedTypeOrNull(const QualType);
132 llvm::DICompositeType getOrCreateMethodType(const CXXMethodDecl *Method,
134 llvm::DICompositeType getOrCreateInstanceMethodType(
135 QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit);
136 llvm::DICompositeType getOrCreateFunctionType(const Decl *D, QualType FnType,
138 llvm::DIType getOrCreateVTablePtrType(llvm::DIFile F);
139 llvm::DINameSpace getOrCreateNameSpace(const NamespaceDecl *N);
140 llvm::DIType getOrCreateTypeDeclaration(QualType PointeeTy, llvm::DIFile F);
141 llvm::DIType CreatePointerLikeType(unsigned Tag,
142 const Type *Ty, QualType PointeeTy,
145 llvm::Value *getCachedInterfaceTypeOrNull(const QualType Ty);
146 llvm::DIType getOrCreateStructPtrType(StringRef Name, llvm::DIType &Cache);
148 llvm::DISubprogram CreateCXXMemberFunction(const CXXMethodDecl *Method,
150 llvm::DIType RecordTy);
152 void CollectCXXMemberFunctions(const CXXRecordDecl *Decl,
154 SmallVectorImpl<llvm::Value *> &E,
157 void CollectCXXFriends(const CXXRecordDecl *Decl,
159 SmallVectorImpl<llvm::Value *> &EltTys,
160 llvm::DIType RecordTy);
162 void CollectCXXBases(const CXXRecordDecl *Decl,
164 SmallVectorImpl<llvm::Value *> &EltTys,
165 llvm::DIType RecordTy);
168 CollectTemplateParams(const TemplateParameterList *TPList,
169 ArrayRef<TemplateArgument> TAList,
172 CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit);
174 CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TS,
177 llvm::DIType createFieldType(StringRef name, QualType type,
178 uint64_t sizeInBitsOverride, SourceLocation loc,
179 AccessSpecifier AS, uint64_t offsetInBits,
181 llvm::DIDescriptor scope);
183 // Helpers for collecting fields of a record.
184 void CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
185 SmallVectorImpl<llvm::Value *> &E,
186 llvm::DIType RecordTy);
187 void CollectRecordStaticField(const VarDecl *Var,
188 SmallVectorImpl<llvm::Value *> &E,
189 llvm::DIType RecordTy);
190 void CollectRecordNormalField(const FieldDecl *Field, uint64_t OffsetInBits,
192 SmallVectorImpl<llvm::Value *> &E,
193 llvm::DIType RecordTy);
194 void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile F,
195 SmallVectorImpl<llvm::Value *> &E,
196 llvm::DIType RecordTy);
198 void CollectVTableInfo(const CXXRecordDecl *Decl,
200 SmallVectorImpl<llvm::Value *> &EltTys);
202 // CreateLexicalBlock - Create a new lexical block node and push it on
204 void CreateLexicalBlock(SourceLocation Loc);
207 CGDebugInfo(CodeGenModule &CGM);
212 /// setLocation - Update the current source location. If \arg loc is
213 /// invalid it is ignored.
214 void setLocation(SourceLocation Loc);
216 /// getLocation - Return the current source location.
217 SourceLocation getLocation() const { return CurLoc; }
219 /// EmitLocation - Emit metadata to indicate a change in line/column
220 /// information in the source file.
221 /// \param ForceColumnInfo Assume DebugColumnInfo option is true.
222 void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
223 bool ForceColumnInfo = false);
225 /// EmitFunctionStart - Emit a call to llvm.dbg.function.start to indicate
226 /// start of a new function.
227 void EmitFunctionStart(GlobalDecl GD, QualType FnType,
228 llvm::Function *Fn, CGBuilderTy &Builder);
230 /// EmitFunctionEnd - Constructs the debug code for exiting a function.
231 void EmitFunctionEnd(CGBuilderTy &Builder);
233 /// EmitLexicalBlockStart - Emit metadata to indicate the beginning of a
234 /// new lexical block and push the block onto the stack.
235 void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc);
237 /// EmitLexicalBlockEnd - Emit metadata to indicate the end of a new lexical
238 /// block and pop the current block.
239 void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc);
241 /// EmitDeclareOfAutoVariable - Emit call to llvm.dbg.declare for an automatic
242 /// variable declaration.
243 void EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI,
244 CGBuilderTy &Builder);
246 /// EmitDeclareOfBlockDeclRefVariable - Emit call to llvm.dbg.declare for an
247 /// imported variable declaration in a block.
248 void EmitDeclareOfBlockDeclRefVariable(const VarDecl *variable,
249 llvm::Value *storage,
250 CGBuilderTy &Builder,
251 const CGBlockInfo &blockInfo);
253 /// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
254 /// variable declaration.
255 void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI,
256 unsigned ArgNo, CGBuilderTy &Builder);
258 /// EmitDeclareOfBlockLiteralArgVariable - Emit call to
259 /// llvm.dbg.declare for the block-literal argument to a block
260 /// invocation function.
261 void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
263 llvm::Value *LocalAddr,
264 CGBuilderTy &Builder);
266 /// EmitGlobalVariable - Emit information about a global variable.
267 void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
269 /// EmitGlobalVariable - Emit information about an objective-c interface.
270 void EmitGlobalVariable(llvm::GlobalVariable *GV, ObjCInterfaceDecl *Decl);
272 /// EmitGlobalVariable - Emit global variable's debug info.
273 void EmitGlobalVariable(const ValueDecl *VD, llvm::Constant *Init);
275 /// \brief - Emit C++ using directive.
276 void EmitUsingDirective(const UsingDirectiveDecl &UD);
278 /// \brief - Emit C++ using declaration.
279 void EmitUsingDecl(const UsingDecl &UD);
281 /// \brief - Emit C++ namespace alias.
282 llvm::DIImportedEntity EmitNamespaceAlias(const NamespaceAliasDecl &NA);
284 /// getOrCreateRecordType - Emit record type's standalone debug info.
285 llvm::DIType getOrCreateRecordType(QualType Ty, SourceLocation L);
287 /// getOrCreateInterfaceType - Emit an objective c interface type standalone
289 llvm::DIType getOrCreateInterfaceType(QualType Ty,
292 void completeType(const RecordDecl *RD);
293 void completeRequiredType(const RecordDecl *RD);
297 /// EmitDeclare - Emit call to llvm.dbg.declare for a variable declaration.
298 void EmitDeclare(const VarDecl *decl, unsigned Tag, llvm::Value *AI,
299 unsigned ArgNo, CGBuilderTy &Builder);
301 // EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
302 // See BuildByRefType.
303 llvm::DIType EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
306 /// getContextDescriptor - Get context info for the decl.
307 llvm::DIScope getContextDescriptor(const Decl *Decl);
309 llvm::DIScope getCurrentContextDescriptor(const Decl *Decl);
311 /// \brief Create a forward decl for a RecordType in a given context.
312 llvm::DIType getOrCreateRecordFwdDecl(const RecordDecl *, llvm::DIDescriptor);
314 /// createContextChain - Create a set of decls for the context chain.
315 llvm::DIDescriptor createContextChain(const Decl *Decl);
317 /// getCurrentDirname - Return current directory name.
318 StringRef getCurrentDirname();
320 /// CreateCompileUnit - Create new compile unit.
321 void CreateCompileUnit();
323 /// getOrCreateFile - Get the file debug info descriptor for the input
325 llvm::DIFile getOrCreateFile(SourceLocation Loc);
327 /// getOrCreateMainFile - Get the file info for main compile unit.
328 llvm::DIFile getOrCreateMainFile();
330 /// getOrCreateType - Get the type from the cache or create a new type if
332 llvm::DIType getOrCreateType(QualType Ty, llvm::DIFile F, bool Declaration = false);
334 /// getOrCreateLimitedType - Get the type from the cache or create a new
335 /// partial type if necessary.
336 llvm::DIType getOrCreateLimitedType(const RecordType *Ty, llvm::DIFile F);
338 /// CreateTypeNode - Create type metadata for a source language type.
339 llvm::DIType CreateTypeNode(QualType Ty, llvm::DIFile F, bool Declaration);
341 /// getObjCInterfaceDecl - return the underlying ObjCInterfaceDecl
342 /// if Ty is an ObjCInterface or a pointer to one.
343 ObjCInterfaceDecl* getObjCInterfaceDecl(QualType Ty);
345 /// CreateMemberType - Create new member and increase Offset by FType's size.
346 llvm::DIType CreateMemberType(llvm::DIFile Unit, QualType FType,
347 StringRef Name, uint64_t *Offset);
349 /// \brief Retrieve the DIDescriptor, if any, for the canonical form of this
351 llvm::DIDescriptor getDeclarationOrDefinition(const Decl *D);
353 /// getFunctionDeclaration - Return debug info descriptor to describe method
354 /// declaration for the given method definition.
355 llvm::DISubprogram getFunctionDeclaration(const Decl *D);
357 /// getStaticDataMemberDeclaration - Return debug info descriptor to
358 /// describe in-class static data member declaration for the given
359 /// out-of-class definition.
360 llvm::DIDerivedType getStaticDataMemberDeclaration(const Decl *D);
362 /// getFunctionName - Get function name for the given FunctionDecl. If the
363 /// name is constructred on demand (e.g. C++ destructor) then the name
364 /// is stored on the side.
365 StringRef getFunctionName(const FunctionDecl *FD);
367 /// getObjCMethodName - Returns the unmangled name of an Objective-C method.
368 /// This is the display name for the debugging info.
369 StringRef getObjCMethodName(const ObjCMethodDecl *FD);
371 /// getSelectorName - Return selector name. This is used for debugging
373 StringRef getSelectorName(Selector S);
375 /// getClassName - Get class name including template argument list.
376 StringRef getClassName(const RecordDecl *RD);
378 /// getVTableName - Get vtable name for the given Class.
379 StringRef getVTableName(const CXXRecordDecl *Decl);
381 /// getLineNumber - Get line number for the location. If location is invalid
382 /// then use current location.
383 unsigned getLineNumber(SourceLocation Loc);
385 /// getColumnNumber - Get column number for the location. If location is
386 /// invalid then use current location.
387 /// \param Force Assume DebugColumnInfo option is true.
388 unsigned getColumnNumber(SourceLocation Loc, bool Force=false);
391 /// NoLocation - An RAII object that temporarily disables debug
392 /// locations. This is useful for emitting instructions that should be
393 /// counted towards the function prologue.
395 SourceLocation SavedLoc;
397 CGBuilderTy &Builder;
399 NoLocation(CodeGenFunction &CGF, CGBuilderTy &B);
400 /// ~NoLocation - Autorestore everything back to normal.
404 /// ArtificialLocation - An RAII object that temporarily switches to
405 /// an artificial debug location that has a valid scope, but no line
406 /// information. This is useful when emitting compiler-generated
407 /// helper functions that have no source location associated with
408 /// them. The DWARF specification allows the compiler to use the
409 /// special line number 0 to indicate code that can not be attributed
410 /// to any source location.
412 /// This is necessary because passing an empty SourceLocation to
413 /// CGDebugInfo::setLocation() will result in the last valid location
415 class ArtificialLocation {
416 SourceLocation SavedLoc;
418 CGBuilderTy &Builder;
420 ArtificialLocation(CodeGenFunction &CGF, CGBuilderTy &B);
422 /// Set the current location to line 0, but within the current scope
423 /// (= the top of the LexicalBlockStack).
426 /// ~ArtificialLocation - Autorestore everything back to normal.
427 ~ArtificialLocation();
431 } // namespace CodeGen