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