1 //===--- CGDebugInfo.h - DebugInfo for LLVM CodeGen -------------*- C++ -*-===//
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 is the source level debug info generator for llvm translation.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef CLANG_CODEGEN_CGDEBUGINFO_H
15 #define CLANG_CODEGEN_CGDEBUGINFO_H
16 
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"
27 
28 namespace llvm {
29   class MDNode;
30 }
31 
32 namespace clang {
33   class CXXMethodDecl;
34   class VarDecl;
35   class ObjCInterfaceDecl;
36   class ObjCIvarDecl;
37   class ClassTemplateSpecializationDecl;
38   class GlobalDecl;
39   class UsingDecl;
40 
41 namespace CodeGen {
42   class CodeGenModule;
43   class CodeGenFunction;
44   class CGBlockInfo;
45 
46 /// CGDebugInfo - This class gathers all debug information during compilation
47 /// and is responsible for emitting to llvm globals or pass directly to
48 /// the backend.
49 class CGDebugInfo {
50   CodeGenModule &CGM;
51   const CodeGenOptions::DebugInfoKind DebugKind;
52   llvm::DIBuilder DBuilder;
53   llvm::DICompileUnit TheCU;
54   SourceLocation CurLoc, PrevLoc;
55   llvm::DIType VTablePtrType;
56   llvm::DIType ClassTy;
57   llvm::DICompositeType ObjTy;
58   llvm::DIType SelTy;
59   llvm::DIType OCLImage1dDITy, OCLImage1dArrayDITy, OCLImage1dBufferDITy;
60   llvm::DIType OCLImage2dDITy, OCLImage2dArrayDITy;
61   llvm::DIType OCLImage3dDITy;
62   llvm::DIType OCLEventDITy;
63 
64   /// TypeCache - Cache of previously constructed Types.
65   llvm::DenseMap<void *, llvm::WeakVH> TypeCache;
66 
67   /// ObjCInterfaceCache - Cache of previously constructed interfaces
68   /// which may change. Storing a pair of DIType and checksum.
69   llvm::DenseMap<void *, std::pair<llvm::WeakVH, unsigned > >
70     ObjCInterfaceCache;
71 
72   /// RetainedTypes - list of interfaces we want to keep even if orphaned.
73   std::vector<void *> RetainedTypes;
74 
75   /// CompleteTypeCache - Cache of previously constructed complete RecordTypes.
76   llvm::DenseMap<void *, llvm::WeakVH> CompletedTypeCache;
77 
78   /// ReplaceMap - Cache of forward declared types to RAUW at the end of
79   /// compilation.
80   std::vector<std::pair<void *, llvm::WeakVH> >ReplaceMap;
81 
82   bool BlockLiteralGenericSet;
83   llvm::DIType BlockLiteralGeneric;
84 
85   // LexicalBlockStack - Keep track of our current nested lexical block.
86   std::vector<llvm::TrackingVH<llvm::MDNode> > LexicalBlockStack;
87   llvm::DenseMap<const Decl *, llvm::WeakVH> RegionMap;
88   // FnBeginRegionCount - Keep track of LexicalBlockStack counter at the
89   // beginning of a function. This is used to pop unbalanced regions at
90   // the end of a function.
91   std::vector<unsigned> FnBeginRegionCount;
92 
93   /// DebugInfoNames - This is a storage for names that are
94   /// constructed on demand. For example, C++ destructors, C++ operators etc..
95   llvm::BumpPtrAllocator DebugInfoNames;
96   StringRef CWDName;
97 
98   llvm::DenseMap<const char *, llvm::WeakVH> DIFileCache;
99   llvm::DenseMap<const FunctionDecl *, llvm::WeakVH> SPCache;
100   /// \brief Cache declarations relevant to DW_TAG_imported_declarations (C++
101   /// using declarations) that aren't covered by other more specific caches.
102   llvm::DenseMap<const Decl *, llvm::WeakVH> DeclCache;
103   llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH> NameSpaceCache;
104   llvm::DenseMap<const NamespaceAliasDecl *, llvm::WeakVH> NamespaceAliasCache;
105   llvm::DenseMap<const Decl *, llvm::WeakVH> StaticDataMemberCache;
106 
107   /// Helper functions for getOrCreateType.
108   unsigned Checksum(const ObjCInterfaceDecl *InterfaceDecl);
109   llvm::DIType CreateType(const BuiltinType *Ty);
110   llvm::DIType CreateType(const ComplexType *Ty);
111   llvm::DIType CreateQualifiedType(QualType Ty, llvm::DIFile F, bool Declaration);
112   llvm::DIType CreateType(const TypedefType *Ty, llvm::DIFile F, bool Declaration);
113   llvm::DIType CreateType(const ObjCObjectPointerType *Ty,
114                           llvm::DIFile F);
115   llvm::DIType CreateType(const PointerType *Ty, llvm::DIFile F);
116   llvm::DIType CreateType(const BlockPointerType *Ty, llvm::DIFile F);
117   llvm::DIType CreateType(const FunctionType *Ty, llvm::DIFile F);
118   llvm::DIType CreateType(const RecordType *Ty, bool Declaration);
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,
133                                               llvm::DIFile F);
134   llvm::DICompositeType getOrCreateInstanceMethodType(
135       QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit);
136   llvm::DICompositeType getOrCreateFunctionType(const Decl *D, QualType FnType,
137                                                 llvm::DIFile F);
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,
143                                      llvm::DIFile F);
144 
145   llvm::Value *getCachedInterfaceTypeOrNull(const QualType Ty);
146   llvm::DIType getOrCreateStructPtrType(StringRef Name, llvm::DIType &Cache);
147 
148   llvm::DISubprogram CreateCXXMemberFunction(const CXXMethodDecl *Method,
149                                              llvm::DIFile F,
150                                              llvm::DIType RecordTy);
151 
152   void CollectCXXMemberFunctions(const CXXRecordDecl *Decl,
153                                  llvm::DIFile F,
154                                  SmallVectorImpl<llvm::Value *> &E,
155                                  llvm::DIType T);
156 
157   void CollectCXXFriends(const CXXRecordDecl *Decl,
158                        llvm::DIFile F,
159                        SmallVectorImpl<llvm::Value *> &EltTys,
160                        llvm::DIType RecordTy);
161 
162   void CollectCXXBases(const CXXRecordDecl *Decl,
163                        llvm::DIFile F,
164                        SmallVectorImpl<llvm::Value *> &EltTys,
165                        llvm::DIType RecordTy);
166 
167   llvm::DIArray
168   CollectTemplateParams(const TemplateParameterList *TPList,
169                         const TemplateArgumentList &TAList,
170                         llvm::DIFile Unit);
171   llvm::DIArray
172   CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit);
173   llvm::DIArray
174   CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TS,
175                            llvm::DIFile F);
176 
177   llvm::DIType createFieldType(StringRef name, QualType type,
178                                uint64_t sizeInBitsOverride, SourceLocation loc,
179                                AccessSpecifier AS, uint64_t offsetInBits,
180                                llvm::DIFile tunit,
181                                llvm::DIDescriptor scope);
182 
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,
191                                 llvm::DIFile F,
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);
197 
198   void CollectVTableInfo(const CXXRecordDecl *Decl,
199                          llvm::DIFile F,
200                          SmallVectorImpl<llvm::Value *> &EltTys);
201 
202   // CreateLexicalBlock - Create a new lexical block node and push it on
203   // the stack.
204   void CreateLexicalBlock(SourceLocation Loc);
205 
206 public:
207   CGDebugInfo(CodeGenModule &CGM);
208   ~CGDebugInfo();
209 
210   void finalize();
211 
212   /// setLocation - Update the current source location. If \arg loc is
213   /// invalid it is ignored.
214   void setLocation(SourceLocation Loc);
215 
216   /// getLocation - Return the current source location.
217   SourceLocation getLocation() const { return CurLoc; }
218 
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);
224 
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);
229 
230   /// EmitFunctionEnd - Constructs the debug code for exiting a function.
231   void EmitFunctionEnd(CGBuilderTy &Builder);
232 
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);
236 
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);
240 
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);
245 
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);
252 
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);
257 
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,
262                                             llvm::Value *Arg,
263                                             llvm::Value *LocalAddr,
264                                             CGBuilderTy &Builder);
265 
266   /// EmitGlobalVariable - Emit information about a global variable.
267   void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
268 
269   /// EmitGlobalVariable - Emit information about an objective-c interface.
270   void EmitGlobalVariable(llvm::GlobalVariable *GV, ObjCInterfaceDecl *Decl);
271 
272   /// EmitGlobalVariable - Emit global variable's debug info.
273   void EmitGlobalVariable(const ValueDecl *VD, llvm::Constant *Init);
274 
275   /// \brief - Emit C++ using directive.
276   void EmitUsingDirective(const UsingDirectiveDecl &UD);
277 
278   /// \brief - Emit C++ using declaration.
279   void EmitUsingDecl(const UsingDecl &UD);
280 
281   /// \brief - Emit C++ namespace alias.
282   llvm::DIImportedEntity EmitNamespaceAlias(const NamespaceAliasDecl &NA);
283 
284   /// getOrCreateRecordType - Emit record type's standalone debug info.
285   llvm::DIType getOrCreateRecordType(QualType Ty, SourceLocation L);
286 
287   /// getOrCreateInterfaceType - Emit an objective c interface type standalone
288   /// debug info.
289   llvm::DIType getOrCreateInterfaceType(QualType Ty,
290                                         SourceLocation Loc);
291 
292 private:
293   /// EmitDeclare - Emit call to llvm.dbg.declare for a variable declaration.
294   void EmitDeclare(const VarDecl *decl, unsigned Tag, llvm::Value *AI,
295                    unsigned ArgNo, CGBuilderTy &Builder);
296 
297   // EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
298   // See BuildByRefType.
299   llvm::DIType EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
300                                             uint64_t *OffSet);
301 
302   /// getContextDescriptor - Get context info for the decl.
303   llvm::DIScope getContextDescriptor(const Decl *Decl);
304 
305   llvm::DIScope getCurrentContextDescriptor(const Decl *Decl);
306 
307   /// createRecordFwdDecl - Create a forward decl for a RecordType in a given
308   /// context.
309   llvm::DIType createRecordFwdDecl(const RecordDecl *, llvm::DIDescriptor);
310 
311   /// createContextChain - Create a set of decls for the context chain.
312   llvm::DIDescriptor createContextChain(const Decl *Decl);
313 
314   /// getCurrentDirname - Return current directory name.
315   StringRef getCurrentDirname();
316 
317   /// CreateCompileUnit - Create new compile unit.
318   void CreateCompileUnit();
319 
320   /// getOrCreateFile - Get the file debug info descriptor for the input
321   /// location.
322   llvm::DIFile getOrCreateFile(SourceLocation Loc);
323 
324   /// getOrCreateMainFile - Get the file info for main compile unit.
325   llvm::DIFile getOrCreateMainFile();
326 
327   /// getOrCreateType - Get the type from the cache or create a new type if
328   /// necessary.
329   llvm::DIType getOrCreateType(QualType Ty, llvm::DIFile F, bool Declaration = false);
330 
331   /// getOrCreateLimitedType - Get the type from the cache or create a new
332   /// partial type if necessary.
333   llvm::DIType getOrCreateLimitedType(QualType Ty, llvm::DIFile F);
334 
335   /// CreateTypeNode - Create type metadata for a source language type.
336   llvm::DIType CreateTypeNode(QualType Ty, llvm::DIFile F, bool Declaration);
337 
338   /// getObjCInterfaceDecl - return the underlying ObjCInterfaceDecl
339   /// if Ty is an ObjCInterface or a pointer to one.
340   ObjCInterfaceDecl* getObjCInterfaceDecl(QualType Ty);
341 
342   /// CreateLimitedTypeNode - Create type metadata for a source language
343   /// type, but only partial types for records.
344   llvm::DIType CreateLimitedTypeNode(QualType Ty, llvm::DIFile F);
345 
346   /// CreateMemberType - Create new member and increase Offset by FType's size.
347   llvm::DIType CreateMemberType(llvm::DIFile Unit, QualType FType,
348                                 StringRef Name, uint64_t *Offset);
349 
350   /// \brief Retrieve the DIDescriptor, if any, for the canonical form of this
351   /// declaration.
352   llvm::DIDescriptor getDeclarationOrDefinition(const Decl *D);
353 
354   /// getFunctionDeclaration - Return debug info descriptor to describe method
355   /// declaration for the given method definition.
356   llvm::DISubprogram getFunctionDeclaration(const Decl *D);
357 
358   /// getStaticDataMemberDeclaration - Return debug info descriptor to
359   /// describe in-class static data member declaration for the given
360   /// out-of-class definition.
361   llvm::DIDerivedType getStaticDataMemberDeclaration(const Decl *D);
362 
363   /// getFunctionName - Get function name for the given FunctionDecl. If the
364   /// name is constructred on demand (e.g. C++ destructor) then the name
365   /// is stored on the side.
366   StringRef getFunctionName(const FunctionDecl *FD);
367 
368   /// getObjCMethodName - Returns the unmangled name of an Objective-C method.
369   /// This is the display name for the debugging info.
370   StringRef getObjCMethodName(const ObjCMethodDecl *FD);
371 
372   /// getSelectorName - Return selector name. This is used for debugging
373   /// info.
374   StringRef getSelectorName(Selector S);
375 
376   /// getClassName - Get class name including template argument list.
377   StringRef getClassName(const RecordDecl *RD);
378 
379   /// getVTableName - Get vtable name for the given Class.
380   StringRef getVTableName(const CXXRecordDecl *Decl);
381 
382   /// getLineNumber - Get line number for the location. If location is invalid
383   /// then use current location.
384   unsigned getLineNumber(SourceLocation Loc);
385 
386   /// getColumnNumber - Get column number for the location. If location is
387   /// invalid then use current location.
388   /// \param Force  Assume DebugColumnInfo option is true.
389   unsigned getColumnNumber(SourceLocation Loc, bool Force=false);
390 };
391 } // namespace CodeGen
392 } // namespace clang
393 
394 
395 #endif
396