Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 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 | // |
Alp Toker | 9907f08 | 2014-07-09 14:06:35 +0000 | [diff] [blame] | 10 | // This is the source-level debug info generator for llvm translation. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Benjamin Kramer | 2f5db8b | 2014-08-13 16:25:19 +0000 | [diff] [blame] | 14 | #ifndef LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H |
| 15 | #define LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 16 | |
| 17 | #include "CGBuilder.h" |
| 18 | #include "clang/AST/Expr.h" |
| 19 | #include "clang/AST/Type.h" |
| 20 | #include "clang/Basic/SourceLocation.h" |
Eric Christopher | 75e1768 | 2013-05-16 00:45:23 +0000 | [diff] [blame] | 21 | #include "clang/Frontend/CodeGenOptions.h" |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 22 | #include "llvm/ADT/DenseMap.h" |
Chandler Carruth | 7c58254 | 2014-03-06 00:22:29 +0000 | [diff] [blame] | 23 | #include "llvm/IR/DIBuilder.h" |
Chandler Carruth | 0654bac | 2014-03-06 00:46:56 +0000 | [diff] [blame] | 24 | #include "llvm/IR/DebugInfo.h" |
Chandler Carruth | 61743af | 2014-03-04 11:18:19 +0000 | [diff] [blame] | 25 | #include "llvm/IR/ValueHandle.h" |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 26 | #include "llvm/Support/Allocator.h" |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 27 | |
| 28 | namespace llvm { |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 29 | class MDNode; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 30 | } |
| 31 | |
| 32 | namespace clang { |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 33 | class CXXMethodDecl; |
| 34 | class VarDecl; |
| 35 | class ObjCInterfaceDecl; |
| 36 | class ObjCIvarDecl; |
| 37 | class ClassTemplateSpecializationDecl; |
| 38 | class GlobalDecl; |
| 39 | class UsingDecl; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 40 | |
| 41 | namespace CodeGen { |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 42 | class CodeGenModule; |
| 43 | class CodeGenFunction; |
| 44 | class CGBlockInfo; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 45 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 46 | /// This class gathers all debug information during compilation and is |
| 47 | /// responsible for emitting to llvm globals or pass directly to the |
| 48 | /// backend. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 49 | class CGDebugInfo { |
Adrian Prantl | 39428e7 | 2015-02-03 18:40:42 +0000 | [diff] [blame] | 50 | friend class ApplyDebugLocation; |
Adrian Prantl | d1b151e | 2014-01-17 00:15:10 +0000 | [diff] [blame] | 51 | friend class SaveAndRestoreLocation; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 52 | CodeGenModule &CGM; |
Eric Christopher | cbf5701 | 2013-05-20 19:59:06 +0000 | [diff] [blame] | 53 | const CodeGenOptions::DebugInfoKind DebugKind; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 54 | llvm::DIBuilder DBuilder; |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 55 | llvm::DICompileUnit *TheCU = nullptr; |
David Blaikie | 66e4197 | 2015-01-14 07:38:27 +0000 | [diff] [blame] | 56 | SourceLocation CurLoc; |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 57 | llvm::DIType *VTablePtrType = nullptr; |
| 58 | llvm::DIType *ClassTy = nullptr; |
| 59 | llvm::DICompositeType *ObjTy = nullptr; |
| 60 | llvm::DIType *SelTy = nullptr; |
| 61 | llvm::DIType *OCLImage1dDITy = nullptr; |
| 62 | llvm::DIType *OCLImage1dArrayDITy = nullptr; |
| 63 | llvm::DIType *OCLImage1dBufferDITy = nullptr; |
| 64 | llvm::DIType *OCLImage2dDITy = nullptr; |
| 65 | llvm::DIType *OCLImage2dArrayDITy = nullptr; |
| 66 | llvm::DIType *OCLImage3dDITy = nullptr; |
| 67 | llvm::DIType *OCLEventDITy = nullptr; |
Eric Christopher | d78d4c9 | 2013-05-16 00:52:23 +0000 | [diff] [blame] | 68 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 69 | /// Cache of previously constructed Types. |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 70 | llvm::DenseMap<const void *, llvm::TrackingMDRef> TypeCache; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 71 | |
David Blaikie | ef8a951 | 2014-05-05 23:23:53 +0000 | [diff] [blame] | 72 | struct ObjCInterfaceCacheEntry { |
| 73 | const ObjCInterfaceType *Type; |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 74 | llvm::DIType *Decl; |
| 75 | llvm::DIFile *Unit; |
| 76 | ObjCInterfaceCacheEntry(const ObjCInterfaceType *Type, llvm::DIType *Decl, |
| 77 | llvm::DIFile *Unit) |
David Blaikie | ef8a951 | 2014-05-05 23:23:53 +0000 | [diff] [blame] | 78 | : Type(Type), Decl(Decl), Unit(Unit) {} |
| 79 | }; |
| 80 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 81 | /// Cache of previously constructed interfaces which may change. |
David Blaikie | ef8a951 | 2014-05-05 23:23:53 +0000 | [diff] [blame] | 82 | llvm::SmallVector<ObjCInterfaceCacheEntry, 32> ObjCInterfaceCache; |
Adrian Prantl | a03a85a | 2013-03-06 22:03:30 +0000 | [diff] [blame] | 83 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 84 | /// Cache of references to AST files such as PCHs or modules. |
Adrian Prantl | c4bb47e | 2015-06-30 17:39:51 +0000 | [diff] [blame] | 85 | llvm::DenseMap<uint64_t, llvm::DIModule *> ModuleRefCache; |
| 86 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 87 | /// List of interfaces we want to keep even if orphaned. |
Adrian Prantl | 73409ce | 2013-03-11 18:33:46 +0000 | [diff] [blame] | 88 | std::vector<void *> RetainedTypes; |
| 89 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 90 | /// Cache of forward declared types to RAUW at the end of |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 91 | /// compilation. |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 92 | std::vector<std::pair<const TagType *, llvm::TrackingMDRef>> ReplaceMap; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 93 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 94 | /// Cache of replaceable forward declarartions (functions and |
Frederic Riss | d253ed6 | 2014-11-18 03:40:51 +0000 | [diff] [blame] | 95 | /// variables) to RAUW at the end of compilation. |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 96 | std::vector<std::pair<const DeclaratorDecl *, llvm::TrackingMDRef>> |
| 97 | FwdDeclReplaceMap; |
Frederic Riss | d253ed6 | 2014-11-18 03:40:51 +0000 | [diff] [blame] | 98 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 99 | /// Keep track of our current nested lexical block. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 100 | std::vector<llvm::TypedTrackingMDRef<llvm::DIScope>> LexicalBlockStack; |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 101 | llvm::DenseMap<const Decl *, llvm::TrackingMDRef> RegionMap; |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 102 | /// Keep track of LexicalBlockStack counter at the beginning of a |
| 103 | /// function. This is used to pop unbalanced regions at the end of a |
| 104 | /// function. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 105 | std::vector<unsigned> FnBeginRegionCount; |
| 106 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 107 | /// This is a storage for names that are constructed on demand. For |
| 108 | /// example, C++ destructors, C++ operators etc.. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 109 | llvm::BumpPtrAllocator DebugInfoNames; |
| 110 | StringRef CWDName; |
| 111 | |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 112 | llvm::DenseMap<const char *, llvm::TrackingMDRef> DIFileCache; |
| 113 | llvm::DenseMap<const FunctionDecl *, llvm::TrackingMDRef> SPCache; |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 114 | /// Cache declarations relevant to DW_TAG_imported_declarations (C++ |
David Blaikie | bd48376 | 2013-05-20 04:58:53 +0000 | [diff] [blame] | 115 | /// using declarations) that aren't covered by other more specific caches. |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 116 | llvm::DenseMap<const Decl *, llvm::TrackingMDRef> DeclCache; |
| 117 | llvm::DenseMap<const NamespaceDecl *, llvm::TrackingMDRef> NameSpaceCache; |
| 118 | llvm::DenseMap<const NamespaceAliasDecl *, llvm::TrackingMDRef> |
| 119 | NamespaceAliasCache; |
Duncan P. N. Exon Smith | ac346ba | 2015-07-24 18:05:58 +0000 | [diff] [blame^] | 120 | llvm::DenseMap<const Decl *, llvm::TypedTrackingMDRef<llvm::DIDerivedType>> |
| 121 | StaticDataMemberCache; |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 122 | |
| 123 | /// Helper functions for getOrCreateType. |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 124 | /// @{ |
| 125 | /// Currently the checksum of an interface includes the number of |
| 126 | /// ivars and property accessors. |
Adrian Prantl | a03a85a | 2013-03-06 22:03:30 +0000 | [diff] [blame] | 127 | unsigned Checksum(const ObjCInterfaceDecl *InterfaceDecl); |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 128 | llvm::DIType *CreateType(const BuiltinType *Ty); |
| 129 | llvm::DIType *CreateType(const ComplexType *Ty); |
| 130 | llvm::DIType *CreateQualifiedType(QualType Ty, llvm::DIFile *Fg); |
| 131 | llvm::DIType *CreateType(const TypedefType *Ty, llvm::DIFile *Fg); |
| 132 | llvm::DIType *CreateType(const TemplateSpecializationType *Ty, |
| 133 | llvm::DIFile *Fg); |
| 134 | llvm::DIType *CreateType(const ObjCObjectPointerType *Ty, llvm::DIFile *F); |
| 135 | llvm::DIType *CreateType(const PointerType *Ty, llvm::DIFile *F); |
| 136 | llvm::DIType *CreateType(const BlockPointerType *Ty, llvm::DIFile *F); |
| 137 | llvm::DIType *CreateType(const FunctionType *Ty, llvm::DIFile *F); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 138 | /// Get structure or union type. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 139 | llvm::DIType *CreateType(const RecordType *Tyg); |
| 140 | llvm::DIType *CreateTypeDefinition(const RecordType *Ty); |
| 141 | llvm::DICompositeType *CreateLimitedType(const RecordType *Ty); |
Duncan P. N. Exon Smith | 4078ad4 | 2015-04-16 16:36:45 +0000 | [diff] [blame] | 142 | void CollectContainingType(const CXXRecordDecl *RD, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 143 | llvm::DICompositeType *CT); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 144 | /// Get Objective-C interface type. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 145 | llvm::DIType *CreateType(const ObjCInterfaceType *Ty, llvm::DIFile *F); |
| 146 | llvm::DIType *CreateTypeDefinition(const ObjCInterfaceType *Ty, |
| 147 | llvm::DIFile *F); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 148 | /// Get Objective-C object type. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 149 | llvm::DIType *CreateType(const ObjCObjectType *Ty, llvm::DIFile *F); |
| 150 | llvm::DIType *CreateType(const VectorType *Ty, llvm::DIFile *F); |
| 151 | llvm::DIType *CreateType(const ArrayType *Ty, llvm::DIFile *F); |
| 152 | llvm::DIType *CreateType(const LValueReferenceType *Ty, llvm::DIFile *F); |
| 153 | llvm::DIType *CreateType(const RValueReferenceType *Ty, llvm::DIFile *Unit); |
| 154 | llvm::DIType *CreateType(const MemberPointerType *Ty, llvm::DIFile *F); |
| 155 | llvm::DIType *CreateType(const AtomicType *Ty, llvm::DIFile *F); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 156 | /// Get enumeration type. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 157 | llvm::DIType *CreateEnumType(const EnumType *Ty); |
| 158 | llvm::DIType *CreateTypeDefinition(const EnumType *Ty); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 159 | /// Look up the completed type for a self pointer in the TypeCache and |
| 160 | /// create a copy of it with the ObjectPointer and Artificial flags |
| 161 | /// set. If the type is not cached, a new one is created. This should |
| 162 | /// never happen though, since creating a type for the implicit self |
| 163 | /// argument implies that we already parsed the interface definition |
| 164 | /// and the ivar declarations in the implementation. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 165 | llvm::DIType *CreateSelfType(const QualType &QualTy, llvm::DIType *Ty); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 166 | /// @} |
| 167 | |
| 168 | /// Get the type from the cache or return null type if it doesn't |
| 169 | /// exist. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 170 | llvm::DIType *getTypeOrNull(const QualType); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 171 | /// Return the debug type for a C++ method. |
| 172 | /// \arg CXXMethodDecl is of FunctionType. This function type is |
| 173 | /// not updated to include implicit \c this pointer. Use this routine |
| 174 | /// to get a method type which includes \c this pointer. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 175 | llvm::DISubroutineType *getOrCreateMethodType(const CXXMethodDecl *Method, |
| 176 | llvm::DIFile *F); |
| 177 | llvm::DISubroutineType * |
Duncan P. N. Exon Smith | 4078ad4 | 2015-04-16 16:36:45 +0000 | [diff] [blame] | 178 | getOrCreateInstanceMethodType(QualType ThisPtr, const FunctionProtoType *Func, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 179 | llvm::DIFile *Unit); |
| 180 | llvm::DISubroutineType * |
| 181 | getOrCreateFunctionType(const Decl *D, QualType FnType, llvm::DIFile *F); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 182 | /// \return debug info descriptor for vtable. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 183 | llvm::DIType *getOrCreateVTablePtrType(llvm::DIFile *F); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 184 | /// \return namespace descriptor for the given namespace decl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 185 | llvm::DINamespace *getOrCreateNameSpace(const NamespaceDecl *N); |
| 186 | llvm::DIType *getOrCreateTypeDeclaration(QualType PointeeTy, llvm::DIFile *F); |
| 187 | llvm::DIType *CreatePointerLikeType(llvm::dwarf::Tag Tag, const Type *Ty, |
| 188 | QualType PointeeTy, llvm::DIFile *F); |
Guy Benyei | d8a08ea | 2012-12-18 14:38:23 +0000 | [diff] [blame] | 189 | |
Adrian Prantl | 73409ce | 2013-03-11 18:33:46 +0000 | [diff] [blame] | 190 | llvm::Value *getCachedInterfaceTypeOrNull(const QualType Ty); |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 191 | llvm::DIType *getOrCreateStructPtrType(StringRef Name, llvm::DIType *&Cache); |
Guy Benyei | d8a08ea | 2012-12-18 14:38:23 +0000 | [diff] [blame] | 192 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 193 | /// A helper function to create a subprogram for a single member |
| 194 | /// function GlobalDecl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 195 | llvm::DISubprogram *CreateCXXMemberFunction(const CXXMethodDecl *Method, |
| 196 | llvm::DIFile *F, |
| 197 | llvm::DIType *RecordTy); |
Eric Christopher | d78d4c9 | 2013-05-16 00:52:23 +0000 | [diff] [blame] | 198 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 199 | /// A helper function to collect debug info for C++ member |
| 200 | /// functions. This is used while creating debug info entry for a |
| 201 | /// Record. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 202 | void CollectCXXMemberFunctions(const CXXRecordDecl *Decl, llvm::DIFile *F, |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 203 | SmallVectorImpl<llvm::Metadata *> &E, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 204 | llvm::DIType *T); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 205 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 206 | /// A helper function to collect debug info for C++ base |
| 207 | /// classes. This is used while creating debug info entry for a |
| 208 | /// Record. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 209 | void CollectCXXBases(const CXXRecordDecl *Decl, llvm::DIFile *F, |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 210 | SmallVectorImpl<llvm::Metadata *> &EltTys, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 211 | llvm::DIType *RecordTy); |
Eric Christopher | d78d4c9 | 2013-05-16 00:52:23 +0000 | [diff] [blame] | 212 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 213 | /// A helper function to collect template parameters. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 214 | llvm::DINodeArray CollectTemplateParams(const TemplateParameterList *TPList, |
| 215 | ArrayRef<TemplateArgument> TAList, |
| 216 | llvm::DIFile *Unit); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 217 | /// A helper function to collect debug info for function template |
| 218 | /// parameters. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 219 | llvm::DINodeArray CollectFunctionTemplateParams(const FunctionDecl *FD, |
| 220 | llvm::DIFile *Unit); |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 221 | |
| 222 | /// A helper function to collect debug info for template |
| 223 | /// parameters. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 224 | llvm::DINodeArray |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 225 | CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TS, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 226 | llvm::DIFile *F); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 227 | |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 228 | llvm::DIType *createFieldType(StringRef name, QualType type, |
Duncan P. N. Exon Smith | 0b6c369 | 2015-04-20 18:51:48 +0000 | [diff] [blame] | 229 | uint64_t sizeInBitsOverride, SourceLocation loc, |
| 230 | AccessSpecifier AS, uint64_t offsetInBits, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 231 | llvm::DIFile *tunit, llvm::DIScope *scope, |
Duncan P. N. Exon Smith | 0b6c369 | 2015-04-20 18:51:48 +0000 | [diff] [blame] | 232 | const RecordDecl *RD = nullptr); |
Eric Christopher | 91a3190 | 2013-01-16 01:22:32 +0000 | [diff] [blame] | 233 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 234 | /// Helpers for collecting fields of a record. |
| 235 | /// @{ |
Eric Christopher | 91a3190 | 2013-01-16 01:22:32 +0000 | [diff] [blame] | 236 | void CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl, |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 237 | SmallVectorImpl<llvm::Metadata *> &E, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 238 | llvm::DIType *RecordTy); |
| 239 | llvm::DIDerivedType *CreateRecordStaticField(const VarDecl *Var, |
| 240 | llvm::DIType *RecordTy, |
Duncan P. N. Exon Smith | c09c548 | 2015-04-20 21:17:26 +0000 | [diff] [blame] | 241 | const RecordDecl *RD); |
Eric Christopher | 91a3190 | 2013-01-16 01:22:32 +0000 | [diff] [blame] | 242 | void CollectRecordNormalField(const FieldDecl *Field, uint64_t OffsetInBits, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 243 | llvm::DIFile *F, |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 244 | SmallVectorImpl<llvm::Metadata *> &E, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 245 | llvm::DIType *RecordTy, const RecordDecl *RD); |
| 246 | void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile *F, |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 247 | SmallVectorImpl<llvm::Metadata *> &E, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 248 | llvm::DICompositeType *RecordTy); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 249 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 250 | /// If the C++ class has vtable info then insert appropriate debug |
| 251 | /// info entry in EltTys vector. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 252 | void CollectVTableInfo(const CXXRecordDecl *Decl, llvm::DIFile *F, |
Duncan P. N. Exon Smith | fb49491 | 2014-12-09 18:39:32 +0000 | [diff] [blame] | 253 | SmallVectorImpl<llvm::Metadata *> &EltTys); |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 254 | /// @} |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 255 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 256 | /// Create a new lexical block node and push it on the stack. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 257 | void CreateLexicalBlock(SourceLocation Loc); |
Eric Christopher | d78d4c9 | 2013-05-16 00:52:23 +0000 | [diff] [blame] | 258 | |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 259 | public: |
| 260 | CGDebugInfo(CodeGenModule &CGM); |
| 261 | ~CGDebugInfo(); |
| 262 | |
| 263 | void finalize(); |
| 264 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 265 | /// Update the current source location. If \arg loc is invalid it is |
| 266 | /// ignored. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 267 | void setLocation(SourceLocation Loc); |
| 268 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 269 | /// Emit metadata to indicate a change in line/column information in |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 270 | /// the source file. If the location is invalid, the previous |
| 271 | /// location will be reused. |
David Blaikie | 835afb2 | 2015-01-21 23:08:17 +0000 | [diff] [blame] | 272 | void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 273 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 274 | /// Emit a call to llvm.dbg.function.start to indicate |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 275 | /// start of a new function. |
Adrian Prantl | 42d71b9 | 2014-04-10 23:21:53 +0000 | [diff] [blame] | 276 | /// \param Loc The location of the function header. |
| 277 | /// \param ScopeLoc The location of the function body. |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 278 | void EmitFunctionStart(GlobalDecl GD, SourceLocation Loc, |
| 279 | SourceLocation ScopeLoc, QualType FnType, |
| 280 | llvm::Function *Fn, CGBuilderTy &Builder); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 281 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 282 | /// Constructs the debug code for exiting a function. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 283 | void EmitFunctionEnd(CGBuilderTy &Builder); |
| 284 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 285 | /// Emit metadata to indicate the beginning of a new lexical block |
| 286 | /// and push the block onto the stack. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 287 | void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc); |
| 288 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 289 | /// Emit metadata to indicate the end of a new lexical block and pop |
| 290 | /// the current block. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 291 | void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc); |
| 292 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 293 | /// Emit call to \c llvm.dbg.declare for an automatic variable |
| 294 | /// declaration. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 295 | void EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI, |
| 296 | CGBuilderTy &Builder); |
| 297 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 298 | /// Emit call to \c llvm.dbg.declare for an imported variable |
| 299 | /// declaration in a block. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 300 | void EmitDeclareOfBlockDeclRefVariable(const VarDecl *variable, |
| 301 | llvm::Value *storage, |
| 302 | CGBuilderTy &Builder, |
Adrian Prantl | 88eec39 | 2014-11-21 00:35:25 +0000 | [diff] [blame] | 303 | const CGBlockInfo &blockInfo, |
| 304 | llvm::Instruction *InsertPoint = 0); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 305 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 306 | /// Emit call to \c llvm.dbg.declare for an argument variable |
| 307 | /// declaration. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 308 | void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI, |
| 309 | unsigned ArgNo, CGBuilderTy &Builder); |
| 310 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 311 | /// Emit call to \c llvm.dbg.declare for the block-literal argument |
| 312 | /// to a block invocation function. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 313 | void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block, |
David Blaikie | 77bbb5f | 2014-08-08 17:10:14 +0000 | [diff] [blame] | 314 | llvm::Value *Arg, unsigned ArgNo, |
Adrian Prantl | 51936dd | 2013-03-14 17:53:33 +0000 | [diff] [blame] | 315 | llvm::Value *LocalAddr, |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 316 | CGBuilderTy &Builder); |
| 317 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 318 | /// Emit information about a global variable. |
Yunzhong Gao | 0ebf1bb | 2013-08-30 08:53:09 +0000 | [diff] [blame] | 319 | void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 320 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 321 | /// Emit global variable's debug info. |
Yunzhong Gao | 0ebf1bb | 2013-08-30 08:53:09 +0000 | [diff] [blame] | 322 | void EmitGlobalVariable(const ValueDecl *VD, llvm::Constant *Init); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 323 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 324 | /// Emit C++ using directive. |
David Blaikie | 9f88fe8 | 2013-04-22 06:13:21 +0000 | [diff] [blame] | 325 | void EmitUsingDirective(const UsingDirectiveDecl &UD); |
| 326 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 327 | /// Emit the type explicitly casted to. |
David Blaikie | 66088d5 | 2014-09-24 17:01:27 +0000 | [diff] [blame] | 328 | void EmitExplicitCastType(QualType Ty); |
| 329 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 330 | /// Emit C++ using declaration. |
David Blaikie | bd48376 | 2013-05-20 04:58:53 +0000 | [diff] [blame] | 331 | void EmitUsingDecl(const UsingDecl &UD); |
| 332 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 333 | /// Emit an @import declaration. |
Adrian Prantl | c4bb47e | 2015-06-30 17:39:51 +0000 | [diff] [blame] | 334 | void EmitImportDecl(const ImportDecl &ID); |
| 335 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 336 | /// Emit C++ namespace alias. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 337 | llvm::DIImportedEntity *EmitNamespaceAlias(const NamespaceAliasDecl &NA); |
David Blaikie | f121b93 | 2013-05-20 22:50:41 +0000 | [diff] [blame] | 338 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 339 | /// Emit record type's standalone debug info. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 340 | llvm::DIType *getOrCreateRecordType(QualType Ty, SourceLocation L); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 341 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 342 | /// Emit an Objective-C interface type standalone debug info. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 343 | llvm::DIType *getOrCreateInterfaceType(QualType Ty, SourceLocation Loc); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 344 | |
David Blaikie | 483a9da | 2014-05-06 18:35:21 +0000 | [diff] [blame] | 345 | void completeType(const EnumDecl *ED); |
David Blaikie | b2e86eb | 2013-08-15 20:49:17 +0000 | [diff] [blame] | 346 | void completeType(const RecordDecl *RD); |
| 347 | void completeRequiredType(const RecordDecl *RD); |
David Blaikie | 6943dea | 2013-08-20 01:28:15 +0000 | [diff] [blame] | 348 | void completeClassData(const RecordDecl *RD); |
David Blaikie | b8f2fbb | 2013-06-21 00:40:50 +0000 | [diff] [blame] | 349 | |
David Blaikie | 0e716b4 | 2014-03-03 23:48:23 +0000 | [diff] [blame] | 350 | void completeTemplateDefinition(const ClassTemplateSpecializationDecl &SD); |
| 351 | |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 352 | private: |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 353 | /// Emit call to llvm.dbg.declare for a variable declaration. |
Ed Maste | da70602 | 2014-05-07 12:49:30 +0000 | [diff] [blame] | 354 | /// Tag accepts custom types DW_TAG_arg_variable and DW_TAG_auto_variable, |
| 355 | /// otherwise would be of type llvm::dwarf::Tag. |
Duncan P. N. Exon Smith | f796a1d | 2015-02-03 21:25:34 +0000 | [diff] [blame] | 356 | void EmitDeclare(const VarDecl *decl, llvm::dwarf::Tag Tag, llvm::Value *AI, |
| 357 | unsigned ArgNo, CGBuilderTy &Builder); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 358 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 359 | /// Build up structure info for the byref. See \a BuildByRefType. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 360 | llvm::DIType *EmitTypeForVarWithBlocksAttr(const VarDecl *VD, |
Duncan P. N. Exon Smith | 0b6c369 | 2015-04-20 18:51:48 +0000 | [diff] [blame] | 361 | uint64_t *OffSet); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 362 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 363 | /// Get context info for the decl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 364 | llvm::DIScope *getContextDescriptor(const Decl *Decl); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 365 | |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 366 | llvm::DIScope *getCurrentContextDescriptor(const Decl *Decl); |
David Blaikie | bd48376 | 2013-05-20 04:58:53 +0000 | [diff] [blame] | 367 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 368 | /// Create a forward decl for a RecordType in a given context. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 369 | llvm::DICompositeType *getOrCreateRecordFwdDecl(const RecordType *, |
| 370 | llvm::DIScope *); |
Eric Christopher | d78d4c9 | 2013-05-16 00:52:23 +0000 | [diff] [blame] | 371 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 372 | /// Return current directory name. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 373 | StringRef getCurrentDirname(); |
| 374 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 375 | /// Create new compile unit. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 376 | void CreateCompileUnit(); |
| 377 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 378 | /// Get the file debug info descriptor for the input location. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 379 | llvm::DIFile *getOrCreateFile(SourceLocation Loc); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 380 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 381 | /// Get the file info for main compile unit. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 382 | llvm::DIFile *getOrCreateMainFile(); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 383 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 384 | /// Get the type from the cache or create a new type if necessary. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 385 | llvm::DIType *getOrCreateType(QualType Ty, llvm::DIFile *Fg); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 386 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 387 | /// Get a reference to a clang module. |
Adrian Prantl | c4bb47e | 2015-06-30 17:39:51 +0000 | [diff] [blame] | 388 | llvm::DIModule * |
| 389 | getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod); |
| 390 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 391 | /// Get the type from the cache or create a new partial type if |
| 392 | /// necessary. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 393 | llvm::DIType *getOrCreateLimitedType(const RecordType *Ty, llvm::DIFile *F); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 394 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 395 | /// Create type metadata for a source language type. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 396 | llvm::DIType *CreateTypeNode(QualType Ty, llvm::DIFile *Fg); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 397 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 398 | /// Return the underlying ObjCInterfaceDecl if \arg Ty is an |
| 399 | /// ObjCInterface or a pointer to one. |
| 400 | ObjCInterfaceDecl *getObjCInterfaceDecl(QualType Ty); |
Adrian Prantl | a03a85a | 2013-03-06 22:03:30 +0000 | [diff] [blame] | 401 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 402 | /// Create new member and increase Offset by FType's size. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 403 | llvm::DIType *CreateMemberType(llvm::DIFile *Unit, QualType FType, |
Duncan P. N. Exon Smith | 0b6c369 | 2015-04-20 18:51:48 +0000 | [diff] [blame] | 404 | StringRef Name, uint64_t *Offset); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 405 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 406 | /// Retrieve the DIDescriptor, if any, for the canonical form of this |
David Blaikie | bd48376 | 2013-05-20 04:58:53 +0000 | [diff] [blame] | 407 | /// declaration. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 408 | llvm::DINode *getDeclarationOrDefinition(const Decl *D); |
David Blaikie | bd48376 | 2013-05-20 04:58:53 +0000 | [diff] [blame] | 409 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 410 | /// \return debug info descriptor to describe method |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 411 | /// declaration for the given method definition. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 412 | llvm::DISubprogram *getFunctionDeclaration(const Decl *D); |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 413 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 414 | /// \return debug info descriptor to describe in-class static data |
| 415 | /// member declaration for the given out-of-class definition. If D |
| 416 | /// is an out-of-class definition of a static data member of a |
| 417 | /// class, find its corresponding in-class declaration. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 418 | llvm::DIDerivedType * |
David Blaikie | 6943dea | 2013-08-20 01:28:15 +0000 | [diff] [blame] | 419 | getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D); |
Eric Christopher | 91a3190 | 2013-01-16 01:22:32 +0000 | [diff] [blame] | 420 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 421 | /// Create a subprogram describing the forward declaration |
| 422 | /// represented in the given FunctionDecl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 423 | llvm::DISubprogram *getFunctionForwardDeclaration(const FunctionDecl *FD); |
Frederic Riss | d253ed6 | 2014-11-18 03:40:51 +0000 | [diff] [blame] | 424 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 425 | /// Create a global variable describing the forward decalration |
Duncan P. N. Exon Smith | dadc2b6 | 2015-04-21 18:43:54 +0000 | [diff] [blame] | 426 | /// represented in the given VarDecl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 427 | llvm::DIGlobalVariable * |
Duncan P. N. Exon Smith | dadc2b6 | 2015-04-21 18:43:54 +0000 | [diff] [blame] | 428 | getGlobalVariableForwardDeclaration(const VarDecl *VD); |
Frederic Riss | d253ed6 | 2014-11-18 03:40:51 +0000 | [diff] [blame] | 429 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 430 | /// \brief Return a global variable that represents one of the |
| 431 | /// collection of global variables created for an anonmyous union. |
| 432 | /// |
| 433 | /// Recursively collect all of the member fields of a global |
| 434 | /// anonymous decl and create static variables for them. The first |
| 435 | /// time this is called it needs to be on a union and then from |
| 436 | /// there we can have additional unnamed fields. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 437 | llvm::DIGlobalVariable * |
| 438 | CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile *Unit, |
Duncan P. N. Exon Smith | 4078ad4 | 2015-04-16 16:36:45 +0000 | [diff] [blame] | 439 | unsigned LineNo, StringRef LinkageName, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 440 | llvm::GlobalVariable *Var, llvm::DIScope *DContext); |
Eric Christopher | cab9fae | 2014-04-10 05:20:00 +0000 | [diff] [blame] | 441 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 442 | /// Get function name for the given FunctionDecl. If the name is |
| 443 | /// constructed on demand (e.g., C++ destructor) then the name is |
| 444 | /// stored on the side. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 445 | StringRef getFunctionName(const FunctionDecl *FD); |
| 446 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 447 | /// Returns the unmangled name of an Objective-C method. |
Eric Christopher | d78d4c9 | 2013-05-16 00:52:23 +0000 | [diff] [blame] | 448 | /// This is the display name for the debugging info. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 449 | StringRef getObjCMethodName(const ObjCMethodDecl *FD); |
| 450 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 451 | /// Return selector name. This is used for debugging |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 452 | /// info. |
| 453 | StringRef getSelectorName(Selector S); |
| 454 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 455 | /// Get class name including template argument list. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 456 | StringRef getClassName(const RecordDecl *RD); |
| 457 | |
Adrian Prantl | 3e8bad4 | 2015-07-08 21:18:34 +0000 | [diff] [blame] | 458 | /// Get the vtable name for the given class. |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 459 | StringRef getVTableName(const CXXRecordDecl *Decl); |
| 460 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 461 | /// Get line number for the location. If location is invalid |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 462 | /// then use current location. |
| 463 | unsigned getLineNumber(SourceLocation Loc); |
| 464 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 465 | /// Get column number for the location. If location is |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 466 | /// invalid then use current location. |
Adrian Prantl | c782242 | 2013-03-12 20:43:25 +0000 | [diff] [blame] | 467 | /// \param Force Assume DebugColumnInfo option is true. |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 468 | unsigned getColumnNumber(SourceLocation Loc, bool Force = false); |
Benjamin Kramer | 1b18a5e | 2013-09-09 16:39:06 +0000 | [diff] [blame] | 469 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 470 | /// Collect various properties of a FunctionDecl. |
Frederic Riss | 9db79f1 | 2014-11-18 03:40:46 +0000 | [diff] [blame] | 471 | /// \param GD A GlobalDecl whose getDecl() must return a FunctionDecl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 472 | void collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit, |
Frederic Riss | 9db79f1 | 2014-11-18 03:40:46 +0000 | [diff] [blame] | 473 | StringRef &Name, StringRef &LinkageName, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 474 | llvm::DIScope *&FDContext, |
| 475 | llvm::DINodeArray &TParamsArray, |
Duncan P. N. Exon Smith | 8e47da4 | 2015-04-21 20:07:29 +0000 | [diff] [blame] | 476 | unsigned &Flags); |
Frederic Riss | 9db79f1 | 2014-11-18 03:40:46 +0000 | [diff] [blame] | 477 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 478 | /// Collect various properties of a VarDecl. |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 479 | void collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit, |
Duncan P. N. Exon Smith | 4078ad4 | 2015-04-16 16:36:45 +0000 | [diff] [blame] | 480 | unsigned &LineNo, QualType &T, StringRef &Name, |
Duncan P. N. Exon Smith | 9dd4e4e | 2015-04-29 16:40:08 +0000 | [diff] [blame] | 481 | StringRef &LinkageName, llvm::DIScope *&VDContext); |
Frederic Riss | 9db79f1 | 2014-11-18 03:40:46 +0000 | [diff] [blame] | 482 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 483 | /// Allocate a copy of \p A using the DebugInfoNames allocator |
Benjamin Kramer | 1b18a5e | 2013-09-09 16:39:06 +0000 | [diff] [blame] | 484 | /// and return a reference to it. If multiple arguments are given the strings |
| 485 | /// are concatenated. |
| 486 | StringRef internString(StringRef A, StringRef B = StringRef()) { |
| 487 | char *Data = DebugInfoNames.Allocate<char>(A.size() + B.size()); |
| 488 | std::memcpy(Data, A.data(), A.size()); |
| 489 | std::memcpy(Data + A.size(), B.data(), B.size()); |
| 490 | return StringRef(Data, A.size() + B.size()); |
| 491 | } |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 492 | }; |
Adrian Prantl | 2e0637f | 2013-07-18 00:28:02 +0000 | [diff] [blame] | 493 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 494 | /// A scoped helper to set the current debug location to the specified |
Adrian Prantl | 6693d08 | 2015-02-03 18:40:38 +0000 | [diff] [blame] | 495 | /// location or preferred location of the specified Expr. |
David Blaikie | 66e4197 | 2015-01-14 07:38:27 +0000 | [diff] [blame] | 496 | class ApplyDebugLocation { |
David Blaikie | 9b47966 | 2015-01-25 01:19:10 +0000 | [diff] [blame] | 497 | private: |
Adrian Prantl | 95b24e9 | 2015-02-03 20:00:54 +0000 | [diff] [blame] | 498 | void init(SourceLocation TemporaryLocation, bool DefaultToEmpty = false); |
| 499 | ApplyDebugLocation(CodeGenFunction &CGF, bool DefaultToEmpty, |
| 500 | SourceLocation TemporaryLocation); |
David Blaikie | 9b47966 | 2015-01-25 01:19:10 +0000 | [diff] [blame] | 501 | |
David Blaikie | 66e4197 | 2015-01-14 07:38:27 +0000 | [diff] [blame] | 502 | llvm::DebugLoc OriginalLocation; |
| 503 | CodeGenFunction &CGF; |
Adrian Prantl | 39428e7 | 2015-02-03 18:40:42 +0000 | [diff] [blame] | 504 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 505 | public: |
| 506 | /// Set the location to the (valid) TemporaryLocation. |
Adrian Prantl | 39428e7 | 2015-02-03 18:40:42 +0000 | [diff] [blame] | 507 | ApplyDebugLocation(CodeGenFunction &CGF, SourceLocation TemporaryLocation); |
Adrian Prantl | 95b24e9 | 2015-02-03 20:00:54 +0000 | [diff] [blame] | 508 | ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E); |
| 509 | ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc); |
| 510 | |
| 511 | ~ApplyDebugLocation(); |
| 512 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 513 | /// \brief Apply TemporaryLocation if it is valid. Otherwise switch |
| 514 | /// to an artificial debug location that has a valid scope, but no |
| 515 | /// line information. |
Adrian Prantl | 39428e7 | 2015-02-03 18:40:42 +0000 | [diff] [blame] | 516 | /// |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 517 | /// Artificial locations are useful when emitting compiler-generated |
| 518 | /// helper functions that have no source location associated with |
| 519 | /// them. The DWARF specification allows the compiler to use the |
| 520 | /// special line number 0 to indicate code that can not be |
| 521 | /// attributed to any source location. Note that passing an empty |
| 522 | /// SourceLocation to CGDebugInfo::setLocation() will result in the |
| 523 | /// last valid location being reused. |
Adrian Prantl | 95b24e9 | 2015-02-03 20:00:54 +0000 | [diff] [blame] | 524 | static ApplyDebugLocation CreateArtificial(CodeGenFunction &CGF) { |
| 525 | return ApplyDebugLocation(CGF, false, SourceLocation()); |
| 526 | } |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 527 | /// \brief Apply TemporaryLocation if it is valid. Otherwise switch |
| 528 | /// to an artificial debug location that has a valid scope, but no |
| 529 | /// line information. |
| 530 | static ApplyDebugLocation |
| 531 | CreateDefaultArtificial(CodeGenFunction &CGF, |
| 532 | SourceLocation TemporaryLocation) { |
Adrian Prantl | 95b24e9 | 2015-02-03 20:00:54 +0000 | [diff] [blame] | 533 | return ApplyDebugLocation(CGF, false, TemporaryLocation); |
| 534 | } |
| 535 | |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 536 | /// Set the IRBuilder to not attach debug locations. Note that |
| 537 | /// passing an empty SourceLocation to \a CGDebugInfo::setLocation() |
| 538 | /// will result in the last valid location being reused. Note that |
| 539 | /// all instructions that do not have a location at the beginning of |
| 540 | /// a function are counted towards to funciton prologue. |
Adrian Prantl | 95b24e9 | 2015-02-03 20:00:54 +0000 | [diff] [blame] | 541 | static ApplyDebugLocation CreateEmpty(CodeGenFunction &CGF) { |
| 542 | return ApplyDebugLocation(CGF, true, SourceLocation()); |
| 543 | } |
| 544 | |
| 545 | /// \brief Apply TemporaryLocation if it is valid. Otherwise set the IRBuilder |
| 546 | /// to not attach debug locations. |
Adrian Prantl | 8f0bd5a | 2015-07-08 20:53:55 +0000 | [diff] [blame] | 547 | static ApplyDebugLocation |
| 548 | CreateDefaultEmpty(CodeGenFunction &CGF, SourceLocation TemporaryLocation) { |
Adrian Prantl | 95b24e9 | 2015-02-03 20:00:54 +0000 | [diff] [blame] | 549 | return ApplyDebugLocation(CGF, true, TemporaryLocation); |
| 550 | } |
Adrian Prantl | 2e0637f | 2013-07-18 00:28:02 +0000 | [diff] [blame] | 551 | }; |
| 552 | |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 553 | } // namespace CodeGen |
| 554 | } // namespace clang |
| 555 | |
Guy Benyei | 11169dd | 2012-12-18 14:30:41 +0000 | [diff] [blame] | 556 | #endif |