blob: 5050ca0ad3fa0dcd16d21fd00f6321f91db06537 [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- 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 Toker9907f082014-07-09 14:06:35 +000010// This is the source-level debug info generator for llvm translation.
Guy Benyei11169dd2012-12-18 14:30:41 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H
15#define LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H
Guy Benyei11169dd2012-12-18 14:30:41 +000016
17#include "CGBuilder.h"
Bob Haarmandff36732016-10-25 22:19:32 +000018#include "clang/AST/DeclCXX.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000019#include "clang/AST/Expr.h"
Adrian Prantlaa5d08d2016-01-22 21:14:41 +000020#include "clang/AST/ExternalASTSource.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000021#include "clang/AST/Type.h"
22#include "clang/Basic/SourceLocation.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000023#include "clang/Frontend/CodeGenOptions.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000024#include "llvm/ADT/DenseMap.h"
Bob Haarmandff36732016-10-25 22:19:32 +000025#include "llvm/ADT/DenseSet.h"
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +000026#include "llvm/ADT/Optional.h"
Chandler Carruth7c582542014-03-06 00:22:29 +000027#include "llvm/IR/DIBuilder.h"
Chandler Carruth0654bac2014-03-06 00:46:56 +000028#include "llvm/IR/DebugInfo.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000029#include "llvm/IR/ValueHandle.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000030#include "llvm/Support/Allocator.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000031
32namespace llvm {
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000033class MDNode;
Guy Benyei11169dd2012-12-18 14:30:41 +000034}
35
36namespace clang {
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000037class ClassTemplateSpecializationDecl;
38class GlobalDecl;
Adrian Prantl9402cef2015-09-20 16:51:35 +000039class ModuleMap;
40class ObjCInterfaceDecl;
41class ObjCIvarDecl;
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000042class UsingDecl;
Adrian Prantl9402cef2015-09-20 16:51:35 +000043class VarDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +000044
45namespace CodeGen {
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000046class CodeGenModule;
47class CodeGenFunction;
48class CGBlockInfo;
Guy Benyei11169dd2012-12-18 14:30:41 +000049
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000050/// This class gathers all debug information during compilation and is
51/// responsible for emitting to llvm globals or pass directly to the
52/// backend.
Guy Benyei11169dd2012-12-18 14:30:41 +000053class CGDebugInfo {
Adrian Prantl39428e72015-02-03 18:40:42 +000054 friend class ApplyDebugLocation;
Adrian Prantld1b151e2014-01-17 00:15:10 +000055 friend class SaveAndRestoreLocation;
Guy Benyei11169dd2012-12-18 14:30:41 +000056 CodeGenModule &CGM;
Benjamin Kramer8c305922016-02-02 11:06:51 +000057 const codegenoptions::DebugInfoKind DebugKind;
Adrian Prantl6b21ab22015-08-27 19:46:20 +000058 bool DebugTypeExtRefs;
Guy Benyei11169dd2012-12-18 14:30:41 +000059 llvm::DIBuilder DBuilder;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +000060 llvm::DICompileUnit *TheCU = nullptr;
Adrian Prantl9402cef2015-09-20 16:51:35 +000061 ModuleMap *ClangModuleMap = nullptr;
Adrian Prantlaa5d08d2016-01-22 21:14:41 +000062 ExternalASTSource::ASTSourceDescriptor PCHDescriptor;
David Blaikie66e41972015-01-14 07:38:27 +000063 SourceLocation CurLoc;
Adrian Prantlb7acfc02017-02-27 21:30:05 +000064 llvm::MDNode *CurInlinedAt = nullptr;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +000065 llvm::DIType *VTablePtrType = nullptr;
66 llvm::DIType *ClassTy = nullptr;
67 llvm::DICompositeType *ObjTy = nullptr;
68 llvm::DIType *SelTy = nullptr;
Alexey Bader954ba212016-04-08 13:40:33 +000069#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
70 llvm::DIType *SingletonId = nullptr;
Alexey Baderb62f1442016-04-13 08:33:41 +000071#include "clang/Basic/OpenCLImageTypes.def"
Yaxun Liu0bc4b2d2016-07-28 19:26:30 +000072 llvm::DIType *OCLSamplerDITy = nullptr;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +000073 llvm::DIType *OCLEventDITy = nullptr;
Alexey Bader9c8453f2015-09-15 11:18:52 +000074 llvm::DIType *OCLClkEventDITy = nullptr;
75 llvm::DIType *OCLQueueDITy = nullptr;
76 llvm::DIType *OCLNDRangeDITy = nullptr;
77 llvm::DIType *OCLReserveIDDITy = nullptr;
Eric Christopherd78d4c92013-05-16 00:52:23 +000078
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000079 /// Cache of previously constructed Types.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +000080 llvm::DenseMap<const void *, llvm::TrackingMDRef> TypeCache;
Guy Benyei11169dd2012-12-18 14:30:41 +000081
Saleem Abdulrasool436256a2015-10-12 20:21:08 +000082 llvm::SmallDenseMap<llvm::StringRef, llvm::StringRef> DebugPrefixMap;
83
David Blaikieef8a9512014-05-05 23:23:53 +000084 struct ObjCInterfaceCacheEntry {
85 const ObjCInterfaceType *Type;
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +000086 llvm::DIType *Decl;
87 llvm::DIFile *Unit;
88 ObjCInterfaceCacheEntry(const ObjCInterfaceType *Type, llvm::DIType *Decl,
89 llvm::DIFile *Unit)
David Blaikieef8a9512014-05-05 23:23:53 +000090 : Type(Type), Decl(Decl), Unit(Unit) {}
91 };
92
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000093 /// Cache of previously constructed interfaces which may change.
David Blaikieef8a9512014-05-05 23:23:53 +000094 llvm::SmallVector<ObjCInterfaceCacheEntry, 32> ObjCInterfaceCache;
Adrian Prantla03a85a2013-03-06 22:03:30 +000095
Adrian Prantl201e10d2015-09-18 21:06:14 +000096 /// Cache of references to clang modules and precompiled headers.
Adrian Prantleb66a262015-09-24 16:10:04 +000097 llvm::DenseMap<const Module *, llvm::TrackingMDRef> ModuleCache;
Adrian Prantlc4bb47e2015-06-30 17:39:51 +000098
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +000099 /// List of interfaces we want to keep even if orphaned.
Adrian Prantl73409ce2013-03-11 18:33:46 +0000100 std::vector<void *> RetainedTypes;
101
Victor Leschukb3e7d682016-09-30 06:39:48 +0000102 /// Cache of forward declared types to RAUW at the end of compilation.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000103 std::vector<std::pair<const TagType *, llvm::TrackingMDRef>> ReplaceMap;
Guy Benyei11169dd2012-12-18 14:30:41 +0000104
Craig Topperc8ad41e2016-02-07 06:39:23 +0000105 /// Cache of replaceable forward declarations (functions and
Frederic Rissd253ed62014-11-18 03:40:51 +0000106 /// variables) to RAUW at the end of compilation.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000107 std::vector<std::pair<const DeclaratorDecl *, llvm::TrackingMDRef>>
108 FwdDeclReplaceMap;
Frederic Rissd253ed62014-11-18 03:40:51 +0000109
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000110 /// Keep track of our current nested lexical block.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000111 std::vector<llvm::TypedTrackingMDRef<llvm::DIScope>> LexicalBlockStack;
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000112 llvm::DenseMap<const Decl *, llvm::TrackingMDRef> RegionMap;
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000113 /// Keep track of LexicalBlockStack counter at the beginning of a
114 /// function. This is used to pop unbalanced regions at the end of a
115 /// function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000116 std::vector<unsigned> FnBeginRegionCount;
117
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000118 /// This is a storage for names that are constructed on demand. For
119 /// example, C++ destructors, C++ operators etc..
Guy Benyei11169dd2012-12-18 14:30:41 +0000120 llvm::BumpPtrAllocator DebugInfoNames;
121 StringRef CWDName;
122
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000123 llvm::DenseMap<const char *, llvm::TrackingMDRef> DIFileCache;
124 llvm::DenseMap<const FunctionDecl *, llvm::TrackingMDRef> SPCache;
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000125 /// Cache declarations relevant to DW_TAG_imported_declarations (C++
David Blaikiebd483762013-05-20 04:58:53 +0000126 /// using declarations) that aren't covered by other more specific caches.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000127 llvm::DenseMap<const Decl *, llvm::TrackingMDRef> DeclCache;
128 llvm::DenseMap<const NamespaceDecl *, llvm::TrackingMDRef> NameSpaceCache;
129 llvm::DenseMap<const NamespaceAliasDecl *, llvm::TrackingMDRef>
130 NamespaceAliasCache;
Duncan P. N. Exon Smithac346ba2015-07-24 18:05:58 +0000131 llvm::DenseMap<const Decl *, llvm::TypedTrackingMDRef<llvm::DIDerivedType>>
132 StaticDataMemberCache;
Benjamin Kramer2811b042015-10-15 16:46:25 +0000133
134 /// Helper functions for getOrCreateType.
135 /// @{
136 /// Currently the checksum of an interface includes the number of
137 /// ivars and property accessors.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000138 llvm::DIType *CreateType(const BuiltinType *Ty);
139 llvm::DIType *CreateType(const ComplexType *Ty);
140 llvm::DIType *CreateQualifiedType(QualType Ty, llvm::DIFile *Fg);
141 llvm::DIType *CreateType(const TypedefType *Ty, llvm::DIFile *Fg);
142 llvm::DIType *CreateType(const TemplateSpecializationType *Ty,
143 llvm::DIFile *Fg);
144 llvm::DIType *CreateType(const ObjCObjectPointerType *Ty, llvm::DIFile *F);
145 llvm::DIType *CreateType(const PointerType *Ty, llvm::DIFile *F);
146 llvm::DIType *CreateType(const BlockPointerType *Ty, llvm::DIFile *F);
147 llvm::DIType *CreateType(const FunctionType *Ty, llvm::DIFile *F);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000148 /// Get structure or union type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000149 llvm::DIType *CreateType(const RecordType *Tyg);
150 llvm::DIType *CreateTypeDefinition(const RecordType *Ty);
151 llvm::DICompositeType *CreateLimitedType(const RecordType *Ty);
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000152 void CollectContainingType(const CXXRecordDecl *RD,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000153 llvm::DICompositeType *CT);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000154 /// Get Objective-C interface type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000155 llvm::DIType *CreateType(const ObjCInterfaceType *Ty, llvm::DIFile *F);
156 llvm::DIType *CreateTypeDefinition(const ObjCInterfaceType *Ty,
157 llvm::DIFile *F);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000158 /// Get Objective-C object type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000159 llvm::DIType *CreateType(const ObjCObjectType *Ty, llvm::DIFile *F);
Manman Rene6be26c2016-09-13 17:25:08 +0000160 llvm::DIType *CreateType(const ObjCTypeParamType *Ty, llvm::DIFile *Unit);
161
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000162 llvm::DIType *CreateType(const VectorType *Ty, llvm::DIFile *F);
163 llvm::DIType *CreateType(const ArrayType *Ty, llvm::DIFile *F);
164 llvm::DIType *CreateType(const LValueReferenceType *Ty, llvm::DIFile *F);
165 llvm::DIType *CreateType(const RValueReferenceType *Ty, llvm::DIFile *Unit);
166 llvm::DIType *CreateType(const MemberPointerType *Ty, llvm::DIFile *F);
167 llvm::DIType *CreateType(const AtomicType *Ty, llvm::DIFile *F);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000168 llvm::DIType *CreateType(const PipeType *Ty, llvm::DIFile *F);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000169 /// Get enumeration type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000170 llvm::DIType *CreateEnumType(const EnumType *Ty);
171 llvm::DIType *CreateTypeDefinition(const EnumType *Ty);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000172 /// Look up the completed type for a self pointer in the TypeCache and
173 /// create a copy of it with the ObjectPointer and Artificial flags
174 /// set. If the type is not cached, a new one is created. This should
175 /// never happen though, since creating a type for the implicit self
176 /// argument implies that we already parsed the interface definition
177 /// and the ivar declarations in the implementation.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000178 llvm::DIType *CreateSelfType(const QualType &QualTy, llvm::DIType *Ty);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000179 /// @}
180
181 /// Get the type from the cache or return null type if it doesn't
182 /// exist.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000183 llvm::DIType *getTypeOrNull(const QualType);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000184 /// Return the debug type for a C++ method.
185 /// \arg CXXMethodDecl is of FunctionType. This function type is
186 /// not updated to include implicit \c this pointer. Use this routine
187 /// to get a method type which includes \c this pointer.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000188 llvm::DISubroutineType *getOrCreateMethodType(const CXXMethodDecl *Method,
189 llvm::DIFile *F);
190 llvm::DISubroutineType *
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000191 getOrCreateInstanceMethodType(QualType ThisPtr, const FunctionProtoType *Func,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000192 llvm::DIFile *Unit);
193 llvm::DISubroutineType *
194 getOrCreateFunctionType(const Decl *D, QualType FnType, llvm::DIFile *F);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000195 /// \return debug info descriptor for vtable.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000196 llvm::DIType *getOrCreateVTablePtrType(llvm::DIFile *F);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000197 /// \return namespace descriptor for the given namespace decl.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000198 llvm::DINamespace *getOrCreateNameSpace(const NamespaceDecl *N);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000199 llvm::DIType *CreatePointerLikeType(llvm::dwarf::Tag Tag, const Type *Ty,
200 QualType PointeeTy, llvm::DIFile *F);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000201 llvm::DIType *getOrCreateStructPtrType(StringRef Name, llvm::DIType *&Cache);
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000202
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000203 /// A helper function to create a subprogram for a single member
204 /// function GlobalDecl.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000205 llvm::DISubprogram *CreateCXXMemberFunction(const CXXMethodDecl *Method,
206 llvm::DIFile *F,
207 llvm::DIType *RecordTy);
Eric Christopherd78d4c92013-05-16 00:52:23 +0000208
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000209 /// A helper function to collect debug info for C++ member
210 /// functions. This is used while creating debug info entry for a
211 /// Record.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000212 void CollectCXXMemberFunctions(const CXXRecordDecl *Decl, llvm::DIFile *F,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000213 SmallVectorImpl<llvm::Metadata *> &E,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000214 llvm::DIType *T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000215
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000216 /// A helper function to collect debug info for C++ base
217 /// classes. This is used while creating debug info entry for a
218 /// Record.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000219 void CollectCXXBases(const CXXRecordDecl *Decl, llvm::DIFile *F,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000220 SmallVectorImpl<llvm::Metadata *> &EltTys,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000221 llvm::DIType *RecordTy);
Eric Christopherd78d4c92013-05-16 00:52:23 +0000222
Bob Haarmandff36732016-10-25 22:19:32 +0000223 /// Helper function for CollectCXXBases.
224 /// Adds debug info entries for types in Bases that are not in SeenTypes.
225 void CollectCXXBasesAux(const CXXRecordDecl *RD, llvm::DIFile *Unit,
226 SmallVectorImpl<llvm::Metadata *> &EltTys,
227 llvm::DIType *RecordTy,
228 const CXXRecordDecl::base_class_const_range &Bases,
229 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
230 llvm::DINode::DIFlags StartingFlags);
231
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000232 /// A helper function to collect template parameters.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000233 llvm::DINodeArray CollectTemplateParams(const TemplateParameterList *TPList,
234 ArrayRef<TemplateArgument> TAList,
235 llvm::DIFile *Unit);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000236 /// A helper function to collect debug info for function template
237 /// parameters.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000238 llvm::DINodeArray CollectFunctionTemplateParams(const FunctionDecl *FD,
239 llvm::DIFile *Unit);
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000240
241 /// A helper function to collect debug info for template
242 /// parameters.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000243 llvm::DINodeArray
Guy Benyei11169dd2012-12-18 14:30:41 +0000244 CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TS,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000245 llvm::DIFile *F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000246
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000247 llvm::DIType *createFieldType(StringRef name, QualType type,
David Majnemerb4b671e2016-06-30 03:01:59 +0000248 SourceLocation loc, AccessSpecifier AS,
Victor Leschuka7ece032016-10-20 00:13:19 +0000249 uint64_t offsetInBits,
250 uint32_t AlignInBits,
251 llvm::DIFile *tunit, llvm::DIScope *scope,
252 const RecordDecl *RD = nullptr);
253
254 llvm::DIType *createFieldType(StringRef name, QualType type,
255 SourceLocation loc, AccessSpecifier AS,
David Majnemerb4b671e2016-06-30 03:01:59 +0000256 uint64_t offsetInBits, llvm::DIFile *tunit,
257 llvm::DIScope *scope,
Victor Leschuka7ece032016-10-20 00:13:19 +0000258 const RecordDecl *RD = nullptr) {
259 return createFieldType(name, type, loc, AS, offsetInBits, 0, tunit, scope,
260 RD);
261 }
Eric Christopher91a31902013-01-16 01:22:32 +0000262
David Majnemerb4b671e2016-06-30 03:01:59 +0000263 /// Create new bit field member.
264 llvm::DIType *createBitFieldType(const FieldDecl *BitFieldDecl,
265 llvm::DIScope *RecordTy,
266 const RecordDecl *RD);
267
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000268 /// Helpers for collecting fields of a record.
269 /// @{
Eric Christopher91a31902013-01-16 01:22:32 +0000270 void CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000271 SmallVectorImpl<llvm::Metadata *> &E,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000272 llvm::DIType *RecordTy);
273 llvm::DIDerivedType *CreateRecordStaticField(const VarDecl *Var,
274 llvm::DIType *RecordTy,
Duncan P. N. Exon Smithc09c5482015-04-20 21:17:26 +0000275 const RecordDecl *RD);
Eric Christopher91a31902013-01-16 01:22:32 +0000276 void CollectRecordNormalField(const FieldDecl *Field, uint64_t OffsetInBits,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000277 llvm::DIFile *F,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000278 SmallVectorImpl<llvm::Metadata *> &E,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000279 llvm::DIType *RecordTy, const RecordDecl *RD);
Adrian McCarthyab1e7862016-07-21 18:43:20 +0000280 void CollectRecordNestedRecord(const RecordDecl *RD,
281 SmallVectorImpl<llvm::Metadata *> &E);
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000282 void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile *F,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000283 SmallVectorImpl<llvm::Metadata *> &E,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000284 llvm::DICompositeType *RecordTy);
Guy Benyei11169dd2012-12-18 14:30:41 +0000285
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000286 /// If the C++ class has vtable info then insert appropriate debug
287 /// info entry in EltTys vector.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000288 void CollectVTableInfo(const CXXRecordDecl *Decl, llvm::DIFile *F,
Reid Klecknerdc124992016-08-31 16:11:43 +0000289 SmallVectorImpl<llvm::Metadata *> &EltTys,
290 llvm::DICompositeType *RecordTy);
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000291 /// @}
Guy Benyei11169dd2012-12-18 14:30:41 +0000292
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000293 /// Create a new lexical block node and push it on the stack.
Guy Benyei11169dd2012-12-18 14:30:41 +0000294 void CreateLexicalBlock(SourceLocation Loc);
Eric Christopherd78d4c92013-05-16 00:52:23 +0000295
Konstantin Zhuravlyov2b4917f2017-03-09 18:06:23 +0000296 /// If target-specific LLVM \p AddressSpace directly maps to target-specific
297 /// DWARF address space, appends extended dereferencing mechanism to complex
298 /// expression \p Expr. Otherwise, does nothing.
299 ///
300 /// Extended dereferencing mechanism is has the following format:
301 /// DW_OP_constu <DWARF Address Space> DW_OP_swap DW_OP_xderef
302 void AppendAddressSpaceXDeref(unsigned AddressSpace,
303 SmallVectorImpl<int64_t> &Expr) const;
304
Guy Benyei11169dd2012-12-18 14:30:41 +0000305public:
306 CGDebugInfo(CodeGenModule &CGM);
307 ~CGDebugInfo();
308
309 void finalize();
310
Adrian Prantlaa5d08d2016-01-22 21:14:41 +0000311 /// Module debugging: Support for building PCMs.
312 /// @{
Adrian Prantla5206ce2015-09-22 23:26:43 +0000313 /// Set the main CU's DwoId field to \p Signature.
314 void setDwoId(uint64_t Signature);
315
Adrian Prantl9402cef2015-09-20 16:51:35 +0000316 /// When generating debug information for a clang module or
317 /// precompiled header, this module map will be used to determine
318 /// the module of origin of each Decl.
319 void setModuleMap(ModuleMap &MMap) { ClangModuleMap = &MMap; }
320
Adrian Prantlaa5d08d2016-01-22 21:14:41 +0000321 /// When generating debug information for a clang module or
322 /// precompiled header, this module map will be used to determine
323 /// the module of origin of each Decl.
324 void setPCHDescriptor(ExternalASTSource::ASTSourceDescriptor PCH) {
325 PCHDescriptor = PCH;
326 }
327 /// @}
328
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000329 /// Update the current source location. If \arg loc is invalid it is
330 /// ignored.
Guy Benyei11169dd2012-12-18 14:30:41 +0000331 void setLocation(SourceLocation Loc);
332
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000333 /// Return the current source location. This does not necessarily correspond
334 /// to the IRBuilder's current DebugLoc.
335 SourceLocation getLocation() const { return CurLoc; }
336
337 /// Update the current inline scope. All subsequent calls to \p EmitLocation
338 /// will create a location with this inlinedAt field.
339 void setInlinedAt(llvm::MDNode *InlinedAt) { CurInlinedAt = InlinedAt; }
340
341 /// \return the current inline scope.
342 llvm::MDNode *getInlinedAt() const { return CurInlinedAt; }
343
Amara Emerson652795d2016-11-10 14:44:30 +0000344 // Converts a SourceLocation to a DebugLoc
345 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Loc);
346
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000347 /// Emit metadata to indicate a change in line/column information in
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000348 /// the source file. If the location is invalid, the previous
349 /// location will be reused.
David Blaikie835afb22015-01-21 23:08:17 +0000350 void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000351
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000352 /// Emit a call to llvm.dbg.function.start to indicate
Guy Benyei11169dd2012-12-18 14:30:41 +0000353 /// start of a new function.
Adrian Prantl42d71b92014-04-10 23:21:53 +0000354 /// \param Loc The location of the function header.
355 /// \param ScopeLoc The location of the function body.
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000356 void EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
357 SourceLocation ScopeLoc, QualType FnType,
358 llvm::Function *Fn, CGBuilderTy &Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +0000359
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000360 /// Start a new scope for an inlined function.
361 void EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD);
362 /// End an inlined function scope.
363 void EmitInlineFunctionEnd(CGBuilderTy &Builder);
364
Adrian Prantl748a6cd2015-09-08 20:41:52 +0000365 /// Emit debug info for a function declaration.
366 void EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc, QualType FnType);
367
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000368 /// Constructs the debug code for exiting a function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000369 void EmitFunctionEnd(CGBuilderTy &Builder);
370
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000371 /// Emit metadata to indicate the beginning of a new lexical block
372 /// and push the block onto the stack.
Guy Benyei11169dd2012-12-18 14:30:41 +0000373 void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc);
374
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000375 /// Emit metadata to indicate the end of a new lexical block and pop
376 /// the current block.
Guy Benyei11169dd2012-12-18 14:30:41 +0000377 void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc);
378
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000379 /// Emit call to \c llvm.dbg.declare for an automatic variable
380 /// declaration.
Guy Benyei11169dd2012-12-18 14:30:41 +0000381 void EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI,
382 CGBuilderTy &Builder);
383
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000384 /// Emit call to \c llvm.dbg.declare for an imported variable
385 /// declaration in a block.
Guy Benyei11169dd2012-12-18 14:30:41 +0000386 void EmitDeclareOfBlockDeclRefVariable(const VarDecl *variable,
387 llvm::Value *storage,
388 CGBuilderTy &Builder,
Adrian Prantl88eec392014-11-21 00:35:25 +0000389 const CGBlockInfo &blockInfo,
Hans Wennborg59dbe862015-09-29 20:56:43 +0000390 llvm::Instruction *InsertPoint = nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +0000391
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000392 /// Emit call to \c llvm.dbg.declare for an argument variable
393 /// declaration.
Guy Benyei11169dd2012-12-18 14:30:41 +0000394 void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI,
395 unsigned ArgNo, CGBuilderTy &Builder);
396
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000397 /// Emit call to \c llvm.dbg.declare for the block-literal argument
398 /// to a block invocation function.
Guy Benyei11169dd2012-12-18 14:30:41 +0000399 void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
David Blaikie77bbb5f2014-08-08 17:10:14 +0000400 llvm::Value *Arg, unsigned ArgNo,
Adrian Prantl51936dd2013-03-14 17:53:33 +0000401 llvm::Value *LocalAddr,
Guy Benyei11169dd2012-12-18 14:30:41 +0000402 CGBuilderTy &Builder);
403
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000404 /// Emit information about a global variable.
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +0000405 void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000406
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +0000407 /// Emit a constant global variable's debug info.
408 void EmitGlobalVariable(const ValueDecl *VD, const APValue &Init);
Guy Benyei11169dd2012-12-18 14:30:41 +0000409
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000410 /// Emit C++ using directive.
David Blaikie9f88fe82013-04-22 06:13:21 +0000411 void EmitUsingDirective(const UsingDirectiveDecl &UD);
412
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000413 /// Emit the type explicitly casted to.
David Blaikie66088d52014-09-24 17:01:27 +0000414 void EmitExplicitCastType(QualType Ty);
415
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000416 /// Emit C++ using declaration.
David Blaikiebd483762013-05-20 04:58:53 +0000417 void EmitUsingDecl(const UsingDecl &UD);
418
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000419 /// Emit an @import declaration.
Adrian Prantlc4bb47e2015-06-30 17:39:51 +0000420 void EmitImportDecl(const ImportDecl &ID);
421
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000422 /// Emit C++ namespace alias.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000423 llvm::DIImportedEntity *EmitNamespaceAlias(const NamespaceAliasDecl &NA);
David Blaikief121b932013-05-20 22:50:41 +0000424
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000425 /// Emit record type's standalone debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000426 llvm::DIType *getOrCreateRecordType(QualType Ty, SourceLocation L);
Guy Benyei11169dd2012-12-18 14:30:41 +0000427
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000428 /// Emit an Objective-C interface type standalone debug info.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000429 llvm::DIType *getOrCreateInterfaceType(QualType Ty, SourceLocation Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000430
Adrian Prantlad9a195e2015-08-27 21:21:19 +0000431 /// Emit standalone debug info for a type.
432 llvm::DIType *getOrCreateStandaloneType(QualType Ty, SourceLocation Loc);
433
David Blaikie483a9da2014-05-06 18:35:21 +0000434 void completeType(const EnumDecl *ED);
David Blaikieb2e86eb2013-08-15 20:49:17 +0000435 void completeType(const RecordDecl *RD);
436 void completeRequiredType(const RecordDecl *RD);
David Blaikie6943dea2013-08-20 01:28:15 +0000437 void completeClassData(const RecordDecl *RD);
David Blaikieb11c8732017-01-30 06:36:08 +0000438 void completeClass(const RecordDecl *RD);
David Blaikieb8f2fbb2013-06-21 00:40:50 +0000439
David Blaikie0e716b42014-03-03 23:48:23 +0000440 void completeTemplateDefinition(const ClassTemplateSpecializationDecl &SD);
David Blaikie1ac9c982017-04-11 21:13:37 +0000441 void completeUnusedClass(const CXXRecordDecl &D);
David Blaikie0e716b42014-03-03 23:48:23 +0000442
Amjad Aboud546bc112017-02-09 22:07:24 +0000443 /// Create debug info for a macro defined by a #define directive or a macro
444 /// undefined by a #undef directive.
445 llvm::DIMacro *CreateMacro(llvm::DIMacroFile *Parent, unsigned MType,
446 SourceLocation LineLoc, StringRef Name,
447 StringRef Value);
448
449 /// Create debug info for a file referenced by an #include directive.
450 llvm::DIMacroFile *CreateTempMacroFile(llvm::DIMacroFile *Parent,
451 SourceLocation LineLoc,
452 SourceLocation FileLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000453private:
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000454 /// Emit call to llvm.dbg.declare for a variable declaration.
Duncan P. N. Exon Smithe4306542015-07-31 17:56:14 +0000455 void EmitDeclare(const VarDecl *decl, llvm::Value *AI,
456 llvm::Optional<unsigned> ArgNo, CGBuilderTy &Builder);
Guy Benyei11169dd2012-12-18 14:30:41 +0000457
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000458 /// Build up structure info for the byref. See \a BuildByRefType.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000459 llvm::DIType *EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000460 uint64_t *OffSet);
Guy Benyei11169dd2012-12-18 14:30:41 +0000461
Adrian Prantl6ec370a2015-09-10 18:39:45 +0000462 /// Get context info for the DeclContext of \p Decl.
463 llvm::DIScope *getDeclContextDescriptor(const Decl *D);
464 /// Get context info for a given DeclContext \p Decl.
465 llvm::DIScope *getContextDescriptor(const Decl *Context,
466 llvm::DIScope *Default);
Guy Benyei11169dd2012-12-18 14:30:41 +0000467
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000468 llvm::DIScope *getCurrentContextDescriptor(const Decl *Decl);
David Blaikiebd483762013-05-20 04:58:53 +0000469
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000470 /// Create a forward decl for a RecordType in a given context.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000471 llvm::DICompositeType *getOrCreateRecordFwdDecl(const RecordType *,
472 llvm::DIScope *);
Eric Christopherd78d4c92013-05-16 00:52:23 +0000473
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000474 /// Return current directory name.
Guy Benyei11169dd2012-12-18 14:30:41 +0000475 StringRef getCurrentDirname();
476
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000477 /// Create new compile unit.
Guy Benyei11169dd2012-12-18 14:30:41 +0000478 void CreateCompileUnit();
479
Saleem Abdulrasool436256a2015-10-12 20:21:08 +0000480 /// Remap a given path with the current debug prefix map
481 std::string remapDIPath(StringRef) const;
482
Amjad Aboude2aab8c2016-12-25 10:12:27 +0000483 /// Compute the file checksum debug info for input file ID.
484 llvm::DIFile::ChecksumKind computeChecksum(FileID FID,
485 SmallString<32> &Checksum) const;
486
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000487 /// Get the file debug info descriptor for the input location.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000488 llvm::DIFile *getOrCreateFile(SourceLocation Loc);
Guy Benyei11169dd2012-12-18 14:30:41 +0000489
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000490 /// Get the file info for main compile unit.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000491 llvm::DIFile *getOrCreateMainFile();
Guy Benyei11169dd2012-12-18 14:30:41 +0000492
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000493 /// Get the type from the cache or create a new type if necessary.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000494 llvm::DIType *getOrCreateType(QualType Ty, llvm::DIFile *Fg);
Guy Benyei11169dd2012-12-18 14:30:41 +0000495
Adrian Prantl66689202015-09-18 23:01:45 +0000496 /// Get a reference to a clang module. If \p CreateSkeletonCU is true,
497 /// this also creates a split dwarf skeleton compile unit.
Adrian Prantlc4bb47e2015-06-30 17:39:51 +0000498 llvm::DIModule *
Adrian Prantl66689202015-09-18 23:01:45 +0000499 getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
500 bool CreateSkeletonCU);
Adrian Prantlc4bb47e2015-06-30 17:39:51 +0000501
Adrian Prantl5c8bd882015-09-11 17:23:08 +0000502 /// DebugTypeExtRefs: If \p D originated in a clang module, return it.
503 llvm::DIModule *getParentModuleOrNull(const Decl *D);
504
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000505 /// Get the type from the cache or create a new partial type if
506 /// necessary.
Duncan P. N. Exon Smithbd210e62015-07-24 20:34:41 +0000507 llvm::DICompositeType *getOrCreateLimitedType(const RecordType *Ty,
508 llvm::DIFile *F);
Guy Benyei11169dd2012-12-18 14:30:41 +0000509
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000510 /// Create type metadata for a source language type.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000511 llvm::DIType *CreateTypeNode(QualType Ty, llvm::DIFile *Fg);
Guy Benyei11169dd2012-12-18 14:30:41 +0000512
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000513 /// Create new member and increase Offset by FType's size.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000514 llvm::DIType *CreateMemberType(llvm::DIFile *Unit, QualType FType,
Duncan P. N. Exon Smith0b6c3692015-04-20 18:51:48 +0000515 StringRef Name, uint64_t *Offset);
Guy Benyei11169dd2012-12-18 14:30:41 +0000516
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000517 /// Retrieve the DIDescriptor, if any, for the canonical form of this
David Blaikiebd483762013-05-20 04:58:53 +0000518 /// declaration.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000519 llvm::DINode *getDeclarationOrDefinition(const Decl *D);
David Blaikiebd483762013-05-20 04:58:53 +0000520
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000521 /// \return debug info descriptor to describe method
Guy Benyei11169dd2012-12-18 14:30:41 +0000522 /// declaration for the given method definition.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000523 llvm::DISubprogram *getFunctionDeclaration(const Decl *D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000524
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000525 /// \return debug info descriptor to describe in-class static data
526 /// member declaration for the given out-of-class definition. If D
527 /// is an out-of-class definition of a static data member of a
528 /// class, find its corresponding in-class declaration.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000529 llvm::DIDerivedType *
David Blaikie6943dea2013-08-20 01:28:15 +0000530 getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D);
Eric Christopher91a31902013-01-16 01:22:32 +0000531
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000532 /// Helper that either creates a forward declaration or a stub.
533 llvm::DISubprogram *getFunctionFwdDeclOrStub(GlobalDecl GD, bool Stub);
Frederic Rissd253ed62014-11-18 03:40:51 +0000534
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000535 /// Create a subprogram describing the forward declaration
536 /// represented in the given FunctionDecl wrapped in a GlobalDecl.
537 llvm::DISubprogram *getFunctionForwardDeclaration(GlobalDecl GD);
538
539 /// Create a DISubprogram describing the function
540 /// represented in the given FunctionDecl wrapped in a GlobalDecl.
541 llvm::DISubprogram *getFunctionStub(GlobalDecl GD);
542
543 /// Create a global variable describing the forward declaration
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +0000544 /// represented in the given VarDecl.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000545 llvm::DIGlobalVariable *
Duncan P. N. Exon Smithdadc2b62015-04-21 18:43:54 +0000546 getGlobalVariableForwardDeclaration(const VarDecl *VD);
Frederic Rissd253ed62014-11-18 03:40:51 +0000547
Adrian Prantl5f4740d2016-12-20 02:10:02 +0000548 /// Return a global variable that represents one of the collection of global
549 /// variables created for an anonmyous union.
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000550 ///
551 /// Recursively collect all of the member fields of a global
552 /// anonymous decl and create static variables for them. The first
553 /// time this is called it needs to be on a union and then from
554 /// there we can have additional unnamed fields.
Adrian Prantl5f4740d2016-12-20 02:10:02 +0000555 llvm::DIGlobalVariableExpression *
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000556 CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile *Unit,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000557 unsigned LineNo, StringRef LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000558 llvm::GlobalVariable *Var, llvm::DIScope *DContext);
Eric Christophercab9fae2014-04-10 05:20:00 +0000559
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000560 /// Get function name for the given FunctionDecl. If the name is
561 /// constructed on demand (e.g., C++ destructor) then the name is
562 /// stored on the side.
Guy Benyei11169dd2012-12-18 14:30:41 +0000563 StringRef getFunctionName(const FunctionDecl *FD);
564
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000565 /// Returns the unmangled name of an Objective-C method.
Eric Christopherd78d4c92013-05-16 00:52:23 +0000566 /// This is the display name for the debugging info.
Guy Benyei11169dd2012-12-18 14:30:41 +0000567 StringRef getObjCMethodName(const ObjCMethodDecl *FD);
568
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000569 /// Return selector name. This is used for debugging
Guy Benyei11169dd2012-12-18 14:30:41 +0000570 /// info.
571 StringRef getSelectorName(Selector S);
572
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000573 /// Get class name including template argument list.
Guy Benyei11169dd2012-12-18 14:30:41 +0000574 StringRef getClassName(const RecordDecl *RD);
575
Adrian Prantl3e8bad42015-07-08 21:18:34 +0000576 /// Get the vtable name for the given class.
Guy Benyei11169dd2012-12-18 14:30:41 +0000577 StringRef getVTableName(const CXXRecordDecl *Decl);
578
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000579 /// Get line number for the location. If location is invalid
Guy Benyei11169dd2012-12-18 14:30:41 +0000580 /// then use current location.
581 unsigned getLineNumber(SourceLocation Loc);
582
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000583 /// Get column number for the location. If location is
Guy Benyei11169dd2012-12-18 14:30:41 +0000584 /// invalid then use current location.
Adrian Prantlc7822422013-03-12 20:43:25 +0000585 /// \param Force Assume DebugColumnInfo option is true.
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000586 unsigned getColumnNumber(SourceLocation Loc, bool Force = false);
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000587
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000588 /// Collect various properties of a FunctionDecl.
Frederic Riss9db79f12014-11-18 03:40:46 +0000589 /// \param GD A GlobalDecl whose getDecl() must return a FunctionDecl.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000590 void collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
Frederic Riss9db79f12014-11-18 03:40:46 +0000591 StringRef &Name, StringRef &LinkageName,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000592 llvm::DIScope *&FDContext,
593 llvm::DINodeArray &TParamsArray,
Leny Kholodov80c047d2016-09-06 10:48:04 +0000594 llvm::DINode::DIFlags &Flags);
Frederic Riss9db79f12014-11-18 03:40:46 +0000595
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000596 /// Collect various properties of a VarDecl.
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000597 void collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
Duncan P. N. Exon Smith4078ad42015-04-16 16:36:45 +0000598 unsigned &LineNo, QualType &T, StringRef &Name,
Duncan P. N. Exon Smith9dd4e4e2015-04-29 16:40:08 +0000599 StringRef &LinkageName, llvm::DIScope *&VDContext);
Frederic Riss9db79f12014-11-18 03:40:46 +0000600
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000601 /// Allocate a copy of \p A using the DebugInfoNames allocator
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000602 /// and return a reference to it. If multiple arguments are given the strings
603 /// are concatenated.
604 StringRef internString(StringRef A, StringRef B = StringRef()) {
605 char *Data = DebugInfoNames.Allocate<char>(A.size() + B.size());
Chandler Carrutha91ba122015-08-04 03:53:00 +0000606 if (!A.empty())
607 std::memcpy(Data, A.data(), A.size());
608 if (!B.empty())
609 std::memcpy(Data + A.size(), B.data(), B.size());
Benjamin Kramer1b18a5e2013-09-09 16:39:06 +0000610 return StringRef(Data, A.size() + B.size());
611 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000612};
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000613
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000614/// A scoped helper to set the current debug location to the specified
Adrian Prantl6693d082015-02-03 18:40:38 +0000615/// location or preferred location of the specified Expr.
David Blaikie66e41972015-01-14 07:38:27 +0000616class ApplyDebugLocation {
David Blaikie9b479662015-01-25 01:19:10 +0000617private:
Adrian Prantl95b24e92015-02-03 20:00:54 +0000618 void init(SourceLocation TemporaryLocation, bool DefaultToEmpty = false);
619 ApplyDebugLocation(CodeGenFunction &CGF, bool DefaultToEmpty,
620 SourceLocation TemporaryLocation);
David Blaikie9b479662015-01-25 01:19:10 +0000621
David Blaikie66e41972015-01-14 07:38:27 +0000622 llvm::DebugLoc OriginalLocation;
David Blaikied7057d92015-08-12 23:49:57 +0000623 CodeGenFunction *CGF;
Adrian Prantl39428e72015-02-03 18:40:42 +0000624
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000625public:
626 /// Set the location to the (valid) TemporaryLocation.
Adrian Prantl39428e72015-02-03 18:40:42 +0000627 ApplyDebugLocation(CodeGenFunction &CGF, SourceLocation TemporaryLocation);
Adrian Prantl95b24e92015-02-03 20:00:54 +0000628 ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E);
629 ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc);
David Blaikied7057d92015-08-12 23:49:57 +0000630 ApplyDebugLocation(ApplyDebugLocation &&Other) : CGF(Other.CGF) {
631 Other.CGF = nullptr;
632 }
Adrian Prantl95b24e92015-02-03 20:00:54 +0000633
634 ~ApplyDebugLocation();
635
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000636 /// \brief Apply TemporaryLocation if it is valid. Otherwise switch
637 /// to an artificial debug location that has a valid scope, but no
638 /// line information.
Adrian Prantl39428e72015-02-03 18:40:42 +0000639 ///
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000640 /// Artificial locations are useful when emitting compiler-generated
641 /// helper functions that have no source location associated with
642 /// them. The DWARF specification allows the compiler to use the
643 /// special line number 0 to indicate code that can not be
644 /// attributed to any source location. Note that passing an empty
645 /// SourceLocation to CGDebugInfo::setLocation() will result in the
646 /// last valid location being reused.
Adrian Prantl95b24e92015-02-03 20:00:54 +0000647 static ApplyDebugLocation CreateArtificial(CodeGenFunction &CGF) {
648 return ApplyDebugLocation(CGF, false, SourceLocation());
649 }
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000650 /// \brief Apply TemporaryLocation if it is valid. Otherwise switch
651 /// to an artificial debug location that has a valid scope, but no
652 /// line information.
653 static ApplyDebugLocation
654 CreateDefaultArtificial(CodeGenFunction &CGF,
655 SourceLocation TemporaryLocation) {
Adrian Prantl95b24e92015-02-03 20:00:54 +0000656 return ApplyDebugLocation(CGF, false, TemporaryLocation);
657 }
658
Adrian Prantl8f0bd5a2015-07-08 20:53:55 +0000659 /// Set the IRBuilder to not attach debug locations. Note that
660 /// passing an empty SourceLocation to \a CGDebugInfo::setLocation()
661 /// will result in the last valid location being reused. Note that
662 /// all instructions that do not have a location at the beginning of
Eric Christopherbe528662015-12-16 23:10:46 +0000663 /// a function are counted towards to function prologue.
Adrian Prantl95b24e92015-02-03 20:00:54 +0000664 static ApplyDebugLocation CreateEmpty(CodeGenFunction &CGF) {
665 return ApplyDebugLocation(CGF, true, SourceLocation());
666 }
667
Adrian Prantl2e0637f2013-07-18 00:28:02 +0000668};
669
Adrian Prantlb7acfc02017-02-27 21:30:05 +0000670/// A scoped helper to set the current debug location to an inlined location.
671class ApplyInlineDebugLocation {
672 SourceLocation SavedLocation;
673 CodeGenFunction *CGF;
674
675public:
676 /// Set up the CodeGenFunction's DebugInfo to produce inline locations for the
677 /// function \p InlinedFn. The current debug location becomes the inlined call
678 /// site of the inlined function.
679 ApplyInlineDebugLocation(CodeGenFunction &CGF, GlobalDecl InlinedFn);
680 /// Restore everything back to the orginial state.
681 ~ApplyInlineDebugLocation();
682};
683
Guy Benyei11169dd2012-12-18 14:30:41 +0000684} // namespace CodeGen
685} // namespace clang
686
Hans Wennborg59dbe862015-09-29 20:56:43 +0000687#endif // LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H