granicus.if.org Git - clang/blob - lib/CodeGen/CGDebugInfo.h

   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/IR/DIBuilder.h"
  24 #include "llvm/IR/DebugInfo.h"
  25 #include "llvm/IR/ValueHandle.h"
  26 #include "llvm/Support/Allocator.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   friend class ArtificialLocation;
  51   friend class SaveAndRestoreLocation;
  52   CodeGenModule &CGM;
  53   const CodeGenOptions::DebugInfoKind DebugKind;
  54   llvm::DIBuilder DBuilder;
  55   llvm::DICompileUnit TheCU;
  56   SourceLocation CurLoc, PrevLoc;
  57   llvm::DIType VTablePtrType;
  58   llvm::DIType ClassTy;
  59   llvm::DICompositeType ObjTy;
  60   llvm::DIType SelTy;
  61   llvm::DIType OCLImage1dDITy, OCLImage1dArrayDITy, OCLImage1dBufferDITy;
  62   llvm::DIType OCLImage2dDITy, OCLImage2dArrayDITy;
  63   llvm::DIType OCLImage3dDITy;
  64   llvm::DIType OCLEventDITy;
  65   llvm::DIType BlockLiteralGeneric;
  66
  67   /// TypeCache - Cache of previously constructed Types.
  68   llvm::DenseMap<const void *, llvm::WeakVH> TypeCache;
  69
  70   struct ObjCInterfaceCacheEntry {
  71     const ObjCInterfaceType *Type;
  72     llvm::DIType Decl;
  73     llvm::DIFile Unit;
  74     ObjCInterfaceCacheEntry(const ObjCInterfaceType *Type, llvm::DIType Decl,
  75                             llvm::DIFile Unit)
  76         : Type(Type), Decl(Decl), Unit(Unit) {}
  77   };
  78
  79   /// ObjCInterfaceCache - Cache of previously constructed interfaces
  80   /// which may change.
  81   llvm::SmallVector<ObjCInterfaceCacheEntry, 32> ObjCInterfaceCache;
  82
  83   /// RetainedTypes - list of interfaces we want to keep even if orphaned.
  84   std::vector<void *> RetainedTypes;
  85
  86   /// ReplaceMap - Cache of forward declared types to RAUW at the end of
  87   /// compilation.
  88   std::vector<std::pair<const TagType *, llvm::WeakVH>> ReplaceMap;
  89
  90   // LexicalBlockStack - Keep track of our current nested lexical block.
  91   std::vector<llvm::TrackingVH<llvm::MDNode> > LexicalBlockStack;
  92   llvm::DenseMap<const Decl *, llvm::WeakVH> RegionMap;
  93   // FnBeginRegionCount - Keep track of LexicalBlockStack counter at the
  94   // beginning of a function. This is used to pop unbalanced regions at
  95   // the end of a function.
  96   std::vector<unsigned> FnBeginRegionCount;
  97
  98   /// DebugInfoNames - This is a storage for names that are
  99   /// constructed on demand. For example, C++ destructors, C++ operators etc..
 100   llvm::BumpPtrAllocator DebugInfoNames;
 101   StringRef CWDName;
 102
 103   llvm::DenseMap<const char *, llvm::WeakVH> DIFileCache;
 104   llvm::DenseMap<const FunctionDecl *, llvm::WeakVH> SPCache;
 105   /// \brief Cache declarations relevant to DW_TAG_imported_declarations (C++
 106   /// using declarations) that aren't covered by other more specific caches.
 107   llvm::DenseMap<const Decl *, llvm::WeakVH> DeclCache;
 108   llvm::DenseMap<const NamespaceDecl *, llvm::WeakVH> NameSpaceCache;
 109   llvm::DenseMap<const NamespaceAliasDecl *, llvm::WeakVH> NamespaceAliasCache;
 110   llvm::DenseMap<const Decl *, llvm::WeakVH> StaticDataMemberCache;
 111
 112   /// Helper functions for getOrCreateType.
 113   unsigned Checksum(const ObjCInterfaceDecl *InterfaceDecl);
 114   llvm::DIType CreateType(const BuiltinType *Ty);
 115   llvm::DIType CreateType(const ComplexType *Ty);
 116   llvm::DIType CreateQualifiedType(QualType Ty, llvm::DIFile Fg);
 117   llvm::DIType CreateType(const TypedefType *Ty, llvm::DIFile Fg);
 118   llvm::DIType CreateType(const TemplateSpecializationType *Ty, llvm::DIFile Fg);
 119   llvm::DIType CreateType(const ObjCObjectPointerType *Ty,
 120                           llvm::DIFile F);
 121   llvm::DIType CreateType(const PointerType *Ty, llvm::DIFile F);
 122   llvm::DIType CreateType(const BlockPointerType *Ty, llvm::DIFile F);
 123   llvm::DIType CreateType(const FunctionType *Ty, llvm::DIFile F);
 124   llvm::DIType CreateType(const RecordType *Tyg);
 125   llvm::DIType CreateTypeDefinition(const RecordType *Ty);
 126   llvm::DICompositeType CreateLimitedType(const RecordType *Ty);
 127   void CollectContainingType(const CXXRecordDecl *RD, llvm::DICompositeType CT);
 128   llvm::DIType CreateType(const ObjCInterfaceType *Ty, llvm::DIFile F);
 129   llvm::DIType CreateTypeDefinition(const ObjCInterfaceType *Ty, llvm::DIFile F);
 130   llvm::DIType CreateType(const ObjCObjectType *Ty, llvm::DIFile F);
 131   llvm::DIType CreateType(const VectorType *Ty, llvm::DIFile F);
 132   llvm::DIType CreateType(const ArrayType *Ty, llvm::DIFile F);
 133   llvm::DIType CreateType(const LValueReferenceType *Ty, llvm::DIFile F);
 134   llvm::DIType CreateType(const RValueReferenceType *Ty, llvm::DIFile Unit);
 135   llvm::DIType CreateType(const MemberPointerType *Ty, llvm::DIFile F);
 136   llvm::DIType CreateType(const AtomicType *Ty, llvm::DIFile F);
 137   llvm::DIType CreateEnumType(const EnumType *Ty);
 138   llvm::DIType CreateSelfType(const QualType &QualTy, llvm::DIType Ty);
 139   llvm::DIType getTypeOrNull(const QualType);
 140   llvm::DICompositeType getOrCreateMethodType(const CXXMethodDecl *Method,
 141                                               llvm::DIFile F);
 142   llvm::DICompositeType getOrCreateInstanceMethodType(
 143       QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile Unit);
 144   llvm::DICompositeType getOrCreateFunctionType(const Decl *D, QualType FnType,
 145                                                 llvm::DIFile F);
 146   llvm::DIType getOrCreateVTablePtrType(llvm::DIFile F);
 147   llvm::DINameSpace getOrCreateNameSpace(const NamespaceDecl *N);
 148   llvm::DIType getOrCreateTypeDeclaration(QualType PointeeTy, llvm::DIFile F);
 149   llvm::DIType CreatePointerLikeType(unsigned Tag,
 150                                      const Type *Ty, QualType PointeeTy,
 151                                      llvm::DIFile F);
 152
 153   llvm::Value *getCachedInterfaceTypeOrNull(const QualType Ty);
 154   llvm::DIType getOrCreateStructPtrType(StringRef Name, llvm::DIType &Cache);
 155
 156   llvm::DISubprogram CreateCXXMemberFunction(const CXXMethodDecl *Method,
 157                                              llvm::DIFile F,
 158                                              llvm::DIType RecordTy);
 159
 160   void CollectCXXMemberFunctions(const CXXRecordDecl *Decl,
 161                                  llvm::DIFile F,
 162                                  SmallVectorImpl<llvm::Value *> &E,
 163                                  llvm::DIType T);
 164
 165   void CollectCXXBases(const CXXRecordDecl *Decl,
 166                        llvm::DIFile F,
 167                        SmallVectorImpl<llvm::Value *> &EltTys,
 168                        llvm::DIType RecordTy);
 169
 170   llvm::DIArray
 171   CollectTemplateParams(const TemplateParameterList *TPList,
 172                         ArrayRef<TemplateArgument> TAList,
 173                         llvm::DIFile Unit);
 174   llvm::DIArray
 175   CollectFunctionTemplateParams(const FunctionDecl *FD, llvm::DIFile Unit);
 176   llvm::DIArray
 177   CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TS,
 178                            llvm::DIFile F);
 179
 180   llvm::DIType createFieldType(StringRef name, QualType type,
 181                                uint64_t sizeInBitsOverride, SourceLocation loc,
 182                                AccessSpecifier AS, uint64_t offsetInBits,
 183                                llvm::DIFile tunit,
 184                                llvm::DIScope scope);
 185
 186   // Helpers for collecting fields of a record.
 187   void CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
 188                                  SmallVectorImpl<llvm::Value *> &E,
 189                                  llvm::DIType RecordTy);
 190   llvm::DIDerivedType CreateRecordStaticField(const VarDecl *Var,
 191                                               llvm::DIType RecordTy);
 192   void CollectRecordNormalField(const FieldDecl *Field, uint64_t OffsetInBits,
 193                                 llvm::DIFile F,
 194                                 SmallVectorImpl<llvm::Value *> &E,
 195                                 llvm::DIType RecordTy);
 196   void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile F,
 197                            SmallVectorImpl<llvm::Value *> &E,
 198                            llvm::DICompositeType RecordTy);
 199
 200   void CollectVTableInfo(const CXXRecordDecl *Decl,
 201                          llvm::DIFile F,
 202                          SmallVectorImpl<llvm::Value *> &EltTys);
 203
 204   // CreateLexicalBlock - Create a new lexical block node and push it on
 205   // the stack.
 206   void CreateLexicalBlock(SourceLocation Loc);
 207
 208 public:
 209   CGDebugInfo(CodeGenModule &CGM);
 210   ~CGDebugInfo();
 211
 212   void finalize();
 213
 214   /// setLocation - Update the current source location. If \arg loc is
 215   /// invalid it is ignored.
 216   void setLocation(SourceLocation Loc);
 217
 218   /// getLocation - Return the current source location.
 219   SourceLocation getLocation() const { return CurLoc; }
 220
 221   /// EmitLocation - Emit metadata to indicate a change in line/column
 222   /// information in the source file.
 223   /// \param ForceColumnInfo  Assume DebugColumnInfo option is true.
 224   void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc,
 225                     bool ForceColumnInfo = false);
 226
 227   /// EmitFunctionStart - Emit a call to llvm.dbg.function.start to indicate
 228   /// start of a new function.
 229   /// \param Loc       The location of the function header.
 230   /// \param ScopeLoc  The location of the function body.
 231   void EmitFunctionStart(GlobalDecl GD,
 232                          SourceLocation Loc, SourceLocation ScopeLoc,
 233                          QualType FnType, llvm::Function *Fn,
 234                          CGBuilderTy &Builder);
 235
 236   /// EmitFunctionEnd - Constructs the debug code for exiting a function.
 237   void EmitFunctionEnd(CGBuilderTy &Builder);
 238
 239   /// EmitLexicalBlockStart - Emit metadata to indicate the beginning of a
 240   /// new lexical block and push the block onto the stack.
 241   void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc);
 242
 243   /// EmitLexicalBlockEnd - Emit metadata to indicate the end of a new lexical
 244   /// block and pop the current block.
 245   void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc);
 246
 247   /// EmitDeclareOfAutoVariable - Emit call to llvm.dbg.declare for an automatic
 248   /// variable declaration.
 249   void EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI,
 250                                  CGBuilderTy &Builder);
 251
 252   /// EmitDeclareOfBlockDeclRefVariable - Emit call to llvm.dbg.declare for an
 253   /// imported variable declaration in a block.
 254   void EmitDeclareOfBlockDeclRefVariable(const VarDecl *variable,
 255                                          llvm::Value *storage,
 256                                          CGBuilderTy &Builder,
 257                                          const CGBlockInfo &blockInfo);
 258
 259   /// EmitDeclareOfArgVariable - Emit call to llvm.dbg.declare for an argument
 260   /// variable declaration.
 261   void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI,
 262                                 unsigned ArgNo, CGBuilderTy &Builder);
 263
 264   /// EmitDeclareOfBlockLiteralArgVariable - Emit call to
 265   /// llvm.dbg.declare for the block-literal argument to a block
 266   /// invocation function.
 267   void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
 268                                             llvm::Value *Arg,
 269                                             llvm::Value *LocalAddr,
 270                                             CGBuilderTy &Builder);
 271
 272   /// EmitGlobalVariable - Emit information about a global variable.
 273   void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
 274
 275   /// EmitGlobalVariable - Emit information about an objective-c interface.
 276   void EmitGlobalVariable(llvm::GlobalVariable *GV, ObjCInterfaceDecl *Decl);
 277
 278   /// EmitGlobalVariable - Emit global variable's debug info.
 279   void EmitGlobalVariable(const ValueDecl *VD, llvm::Constant *Init);
 280
 281   /// \brief - Emit C++ using directive.
 282   void EmitUsingDirective(const UsingDirectiveDecl &UD);
 283
 284   /// \brief - Emit C++ using declaration.
 285   void EmitUsingDecl(const UsingDecl &UD);
 286
 287   /// \brief - Emit C++ namespace alias.
 288   llvm::DIImportedEntity EmitNamespaceAlias(const NamespaceAliasDecl &NA);
 289
 290   /// getOrCreateRecordType - Emit record type's standalone debug info.
 291   llvm::DIType getOrCreateRecordType(QualType Ty, SourceLocation L);
 292
 293   /// getOrCreateInterfaceType - Emit an objective c interface type standalone
 294   /// debug info.
 295   llvm::DIType getOrCreateInterfaceType(QualType Ty,
 296                                         SourceLocation Loc);
 297
 298   void completeType(const RecordDecl *RD);
 299   void completeRequiredType(const RecordDecl *RD);
 300   void completeClassData(const RecordDecl *RD);
 301
 302   void completeTemplateDefinition(const ClassTemplateSpecializationDecl &SD);
 303
 304 private:
 305   /// EmitDeclare - Emit call to llvm.dbg.declare for a variable declaration.
 306   void EmitDeclare(const VarDecl *decl, unsigned Tag, llvm::Value *AI,
 307                    unsigned ArgNo, CGBuilderTy &Builder);
 308
 309   // EmitTypeForVarWithBlocksAttr - Build up structure info for the byref.
 310   // See BuildByRefType.
 311   llvm::DIType EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
 312                                             uint64_t *OffSet);
 313
 314   /// getContextDescriptor - Get context info for the decl.
 315   llvm::DIScope getContextDescriptor(const Decl *Decl);
 316
 317   llvm::DIScope getCurrentContextDescriptor(const Decl *Decl);
 318
 319   /// \brief Create a forward decl for a RecordType in a given context.
 320   llvm::DICompositeType getOrCreateRecordFwdDecl(const RecordType *,
 321                                                  llvm::DIDescriptor);
 322
 323   /// createContextChain - Create a set of decls for the context chain.
 324   llvm::DIDescriptor createContextChain(const Decl *Decl);
 325
 326   /// getCurrentDirname - Return current directory name.
 327   StringRef getCurrentDirname();
 328
 329   /// CreateCompileUnit - Create new compile unit.
 330   void CreateCompileUnit();
 331
 332   /// getOrCreateFile - Get the file debug info descriptor for the input
 333   /// location.
 334   llvm::DIFile getOrCreateFile(SourceLocation Loc);
 335
 336   /// getOrCreateMainFile - Get the file info for main compile unit.
 337   llvm::DIFile getOrCreateMainFile();
 338
 339   /// getOrCreateType - Get the type from the cache or create a new type if
 340   /// necessary.
 341   llvm::DIType getOrCreateType(QualType Ty, llvm::DIFile Fg);
 342
 343   /// getOrCreateLimitedType - Get the type from the cache or create a new
 344   /// partial type if necessary.
 345   llvm::DIType getOrCreateLimitedType(const RecordType *Ty, llvm::DIFile F);
 346
 347   /// CreateTypeNode - Create type metadata for a source language type.
 348   llvm::DIType CreateTypeNode(QualType Ty, llvm::DIFile Fg);
 349
 350   /// getObjCInterfaceDecl - return the underlying ObjCInterfaceDecl
 351   /// if Ty is an ObjCInterface or a pointer to one.
 352   ObjCInterfaceDecl* getObjCInterfaceDecl(QualType Ty);
 353
 354   /// CreateMemberType - Create new member and increase Offset by FType's size.
 355   llvm::DIType CreateMemberType(llvm::DIFile Unit, QualType FType,
 356                                 StringRef Name, uint64_t *Offset);
 357
 358   /// \brief Retrieve the DIScope, if any, for the canonical form of this
 359   /// declaration.
 360   llvm::DIScope getDeclarationOrDefinition(const Decl *D);
 361
 362   /// getFunctionDeclaration - Return debug info descriptor to describe method
 363   /// declaration for the given method definition.
 364   llvm::DISubprogram getFunctionDeclaration(const Decl *D);
 365
 366   /// Return debug info descriptor to describe in-class static data member
 367   /// declaration for the given out-of-class definition.
 368   llvm::DIDerivedType
 369   getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D);
 370
 371   /// Return a global variable that represents one of the collection of
 372   /// global variables created for an anonmyous union.
 373   llvm::DIGlobalVariable
 374   CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile Unit, unsigned LineNo,
 375                          StringRef LinkageName, llvm::GlobalVariable *Var,
 376                          llvm::DIDescriptor DContext);
 377
 378   /// getFunctionName - Get function name for the given FunctionDecl. If the
 379   /// name is constructed on demand (e.g. C++ destructor) then the name
 380   /// is stored on the side.
 381   StringRef getFunctionName(const FunctionDecl *FD);
 382
 383   /// getObjCMethodName - Returns the unmangled name of an Objective-C method.
 384   /// This is the display name for the debugging info.
 385   StringRef getObjCMethodName(const ObjCMethodDecl *FD);
 386
 387   /// getSelectorName - Return selector name. This is used for debugging
 388   /// info.
 389   StringRef getSelectorName(Selector S);
 390
 391   /// getClassName - Get class name including template argument list.
 392   StringRef getClassName(const RecordDecl *RD);
 393
 394   /// getVTableName - Get vtable name for the given Class.
 395   StringRef getVTableName(const CXXRecordDecl *Decl);
 396
 397   /// getLineNumber - Get line number for the location. If location is invalid
 398   /// then use current location.
 399   unsigned getLineNumber(SourceLocation Loc);
 400
 401   /// getColumnNumber - Get column number for the location. If location is
 402   /// invalid then use current location.
 403   /// \param Force  Assume DebugColumnInfo option is true.
 404   unsigned getColumnNumber(SourceLocation Loc, bool Force=false);
 405
 406   /// internString - Allocate a copy of \p A using the DebugInfoNames allocator
 407   /// and return a reference to it. If multiple arguments are given the strings
 408   /// are concatenated.
 409   StringRef internString(StringRef A, StringRef B = StringRef()) {
 410     char *Data = DebugInfoNames.Allocate<char>(A.size() + B.size());
 411     std::memcpy(Data, A.data(), A.size());
 412     std::memcpy(Data + A.size(), B.data(), B.size());
 413     return StringRef(Data, A.size() + B.size());
 414   }
 415 };
 416
 417 /// SaveAndRestoreLocation - An RAII object saves the current location
 418 /// and automatically restores it to the original value.
 419 class SaveAndRestoreLocation {
 420 protected:
 421   SourceLocation SavedLoc;
 422   CGDebugInfo *DI;
 423   CGBuilderTy &Builder;
 424 public:
 425   SaveAndRestoreLocation(CodeGenFunction &CGF, CGBuilderTy &B);
 426   /// Autorestore everything back to normal.
 427   ~SaveAndRestoreLocation();
 428 };
 429
 430 /// NoLocation - An RAII object that temporarily disables debug
 431 /// locations. This is useful for emitting instructions that should be
 432 /// counted towards the function prologue.
 433 class NoLocation : public SaveAndRestoreLocation {
 434 public:
 435   NoLocation(CodeGenFunction &CGF, CGBuilderTy &B);
 436   /// Autorestore everything back to normal.
 437   ~NoLocation();
 438 };
 439
 440 /// ArtificialLocation - An RAII object that temporarily switches to
 441 /// an artificial debug location that has a valid scope, but no line
 442 /// information. This is useful when emitting compiler-generated
 443 /// helper functions that have no source location associated with
 444 /// them. The DWARF specification allows the compiler to use the
 445 /// special line number 0 to indicate code that can not be attributed
 446 /// to any source location.
 447 ///
 448 /// This is necessary because passing an empty SourceLocation to
 449 /// CGDebugInfo::setLocation() will result in the last valid location
 450 /// being reused.
 451 class ArtificialLocation : public SaveAndRestoreLocation {
 452 public:
 453   ArtificialLocation(CodeGenFunction &CGF, CGBuilderTy &B);
 454
 455   /// Set the current location to line 0, but within the current scope
 456   /// (= the top of the LexicalBlockStack).
 457   void Emit();
 458
 459   /// Autorestore everything back to normal.
 460   ~ArtificialLocation();
 461 };
 462
 463
 464 } // namespace CodeGen
 465 } // namespace clang
 466
 467
 468 #endif