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