Coverage Report

Created: 2021-09-21 08:58

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/CodeGen/CGDebugInfo.h
Line
Count
Source (jump to first uncovered line)
1
//===--- CGDebugInfo.h - DebugInfo for LLVM CodeGen -------------*- C++ -*-===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
// This is the source-level debug info generator for llvm translation.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#ifndef LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H
14
#define LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H
15
16
#include "CGBuilder.h"
17
#include "clang/AST/DeclCXX.h"
18
#include "clang/AST/Expr.h"
19
#include "clang/AST/ExternalASTSource.h"
20
#include "clang/AST/PrettyPrinter.h"
21
#include "clang/AST/Type.h"
22
#include "clang/AST/TypeOrdering.h"
23
#include "clang/Basic/CodeGenOptions.h"
24
#include "clang/Basic/Module.h"
25
#include "clang/Basic/SourceLocation.h"
26
#include "llvm/ADT/DenseMap.h"
27
#include "llvm/ADT/DenseSet.h"
28
#include "llvm/ADT/Optional.h"
29
#include "llvm/IR/DIBuilder.h"
30
#include "llvm/IR/DebugInfo.h"
31
#include "llvm/IR/ValueHandle.h"
32
#include "llvm/Support/Allocator.h"
33
34
namespace llvm {
35
class MDNode;
36
}
37
38
namespace clang {
39
class ClassTemplateSpecializationDecl;
40
class GlobalDecl;
41
class ModuleMap;
42
class ObjCInterfaceDecl;
43
class ObjCIvarDecl;
44
class UsingDecl;
45
class VarDecl;
46
enum class DynamicInitKind : unsigned;
47
48
namespace CodeGen {
49
class CodeGenModule;
50
class CodeGenFunction;
51
class CGBlockInfo;
52
53
/// This class gathers all debug information during compilation and is
54
/// responsible for emitting to llvm globals or pass directly to the
55
/// backend.
56
class CGDebugInfo {
57
  friend class ApplyDebugLocation;
58
  friend class SaveAndRestoreLocation;
59
  CodeGenModule &CGM;
60
  const codegenoptions::DebugInfoKind DebugKind;
61
  bool DebugTypeExtRefs;
62
  llvm::DIBuilder DBuilder;
63
  llvm::DICompileUnit *TheCU = nullptr;
64
  ModuleMap *ClangModuleMap = nullptr;
65
  ASTSourceDescriptor PCHDescriptor;
66
  SourceLocation CurLoc;
67
  llvm::MDNode *CurInlinedAt = nullptr;
68
  llvm::DIType *VTablePtrType = nullptr;
69
  llvm::DIType *ClassTy = nullptr;
70
  llvm::DICompositeType *ObjTy = nullptr;
71
  llvm::DIType *SelTy = nullptr;
72
#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
73
  llvm::DIType *SingletonId = nullptr;
74
#include "clang/Basic/OpenCLImageTypes.def"
75
  llvm::DIType *OCLSamplerDITy = nullptr;
76
  llvm::DIType *OCLEventDITy = nullptr;
77
  llvm::DIType *OCLClkEventDITy = nullptr;
78
  llvm::DIType *OCLQueueDITy = nullptr;
79
  llvm::DIType *OCLNDRangeDITy = nullptr;
80
  llvm::DIType *OCLReserveIDDITy = nullptr;
81
#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
82
  llvm::DIType *Id##Ty = nullptr;
83
#include "clang/Basic/OpenCLExtensionTypes.def"
84
85
  /// Cache of previously constructed Types.
86
  llvm::DenseMap<const void *, llvm::TrackingMDRef> TypeCache;
87
88
  std::map<llvm::StringRef, llvm::StringRef, std::greater<llvm::StringRef>>
89
      DebugPrefixMap;
90
91
  /// Cache that maps VLA types to size expressions for that type,
92
  /// represented by instantiated Metadata nodes.
93
  llvm::SmallDenseMap<QualType, llvm::Metadata *> SizeExprCache;
94
95
  /// Callbacks to use when printing names and types.
96
  class PrintingCallbacks final : public clang::PrintingCallbacks {
97
    const CGDebugInfo &Self;
98
99
  public:
100
10.4k
    PrintingCallbacks(const CGDebugInfo &Self) : Self(Self) {}
101
5.33k
    std::string remapPath(StringRef Path) const override {
102
5.33k
      return Self.remapDIPath(Path);
103
5.33k
    }
104
  };
105
  PrintingCallbacks PrintCB = {*this};
106
107
  struct ObjCInterfaceCacheEntry {
108
    const ObjCInterfaceType *Type;
109
    llvm::DIType *Decl;
110
    llvm::DIFile *Unit;
111
    ObjCInterfaceCacheEntry(const ObjCInterfaceType *Type, llvm::DIType *Decl,
112
                            llvm::DIFile *Unit)
113
2.92k
        : Type(Type), Decl(Decl), Unit(Unit) {}
114
  };
115
116
  /// Cache of previously constructed interfaces which may change.
117
  llvm::SmallVector<ObjCInterfaceCacheEntry, 32> ObjCInterfaceCache;
118
119
  /// Cache of forward declarations for methods belonging to the interface.
120
  /// The extra bit on the DISubprogram specifies whether a method is
121
  /// "objc_direct".
122
  llvm::DenseMap<const ObjCInterfaceDecl *,
123
                 std::vector<llvm::PointerIntPair<llvm::DISubprogram *, 1>>>
124
      ObjCMethodCache;
125
126
  /// Cache of references to clang modules and precompiled headers.
127
  llvm::DenseMap<const Module *, llvm::TrackingMDRef> ModuleCache;
128
129
  /// List of interfaces we want to keep even if orphaned.
130
  std::vector<void *> RetainedTypes;
131
132
  /// Cache of forward declared types to RAUW at the end of compilation.
133
  std::vector<std::pair<const TagType *, llvm::TrackingMDRef>> ReplaceMap;
134
135
  /// Cache of replaceable forward declarations (functions and
136
  /// variables) to RAUW at the end of compilation.
137
  std::vector<std::pair<const DeclaratorDecl *, llvm::TrackingMDRef>>
138
      FwdDeclReplaceMap;
139
140
  /// Keep track of our current nested lexical block.
141
  std::vector<llvm::TypedTrackingMDRef<llvm::DIScope>> LexicalBlockStack;
142
  llvm::DenseMap<const Decl *, llvm::TrackingMDRef> RegionMap;
143
  /// Keep track of LexicalBlockStack counter at the beginning of a
144
  /// function. This is used to pop unbalanced regions at the end of a
145
  /// function.
146
  std::vector<unsigned> FnBeginRegionCount;
147
148
  /// This is a storage for names that are constructed on demand. For
149
  /// example, C++ destructors, C++ operators etc..
150
  llvm::BumpPtrAllocator DebugInfoNames;
151
  StringRef CWDName;
152
153
  llvm::DenseMap<const char *, llvm::TrackingMDRef> DIFileCache;
154
  llvm::DenseMap<const FunctionDecl *, llvm::TrackingMDRef> SPCache;
155
  /// Cache declarations relevant to DW_TAG_imported_declarations (C++
156
  /// using declarations) that aren't covered by other more specific caches.
157
  llvm::DenseMap<const Decl *, llvm::TrackingMDRef> DeclCache;
158
  llvm::DenseMap<const NamespaceDecl *, llvm::TrackingMDRef> NamespaceCache;
159
  llvm::DenseMap<const NamespaceAliasDecl *, llvm::TrackingMDRef>
160
      NamespaceAliasCache;
161
  llvm::DenseMap<const Decl *, llvm::TypedTrackingMDRef<llvm::DIDerivedType>>
162
      StaticDataMemberCache;
163
164
  using ParamDecl2StmtTy = llvm::DenseMap<const ParmVarDecl *, const Stmt *>;
165
  using Param2DILocTy =
166
      llvm::DenseMap<const ParmVarDecl *, llvm::DILocalVariable *>;
167
168
  /// The key is coroutine real parameters, value is coroutine move parameters.
169
  ParamDecl2StmtTy CoroutineParameterMappings;
170
  /// The key is coroutine real parameters, value is DIVariable in LLVM IR.
171
  Param2DILocTy ParamDbgMappings;
172
173
  /// Helper functions for getOrCreateType.
174
  /// @{
175
  /// Currently the checksum of an interface includes the number of
176
  /// ivars and property accessors.
177
  llvm::DIType *CreateType(const BuiltinType *Ty);
178
  llvm::DIType *CreateType(const ComplexType *Ty);
179
  llvm::DIType *CreateType(const AutoType *Ty);
180
  llvm::DIType *CreateType(const ExtIntType *Ty);
181
  llvm::DIType *CreateQualifiedType(QualType Ty, llvm::DIFile *Fg);
182
  llvm::DIType *CreateQualifiedType(const FunctionProtoType *Ty,
183
                                    llvm::DIFile *Fg);
184
  llvm::DIType *CreateType(const TypedefType *Ty, llvm::DIFile *Fg);
185
  llvm::DIType *CreateType(const TemplateSpecializationType *Ty,
186
                           llvm::DIFile *Fg);
187
  llvm::DIType *CreateType(const ObjCObjectPointerType *Ty, llvm::DIFile *F);
188
  llvm::DIType *CreateType(const PointerType *Ty, llvm::DIFile *F);
189
  llvm::DIType *CreateType(const BlockPointerType *Ty, llvm::DIFile *F);
190
  llvm::DIType *CreateType(const FunctionType *Ty, llvm::DIFile *F);
191
  /// Get structure or union type.
192
  llvm::DIType *CreateType(const RecordType *Tyg);
193
  llvm::DIType *CreateTypeDefinition(const RecordType *Ty);
194
  llvm::DICompositeType *CreateLimitedType(const RecordType *Ty);
195
  void CollectContainingType(const CXXRecordDecl *RD,
196
                             llvm::DICompositeType *CT);
197
  /// Get Objective-C interface type.
198
  llvm::DIType *CreateType(const ObjCInterfaceType *Ty, llvm::DIFile *F);
199
  llvm::DIType *CreateTypeDefinition(const ObjCInterfaceType *Ty,
200
                                     llvm::DIFile *F);
201
  /// Get Objective-C object type.
202
  llvm::DIType *CreateType(const ObjCObjectType *Ty, llvm::DIFile *F);
203
  llvm::DIType *CreateType(const ObjCTypeParamType *Ty, llvm::DIFile *Unit);
204
205
  llvm::DIType *CreateType(const VectorType *Ty, llvm::DIFile *F);
206
  llvm::DIType *CreateType(const ConstantMatrixType *Ty, llvm::DIFile *F);
207
  llvm::DIType *CreateType(const ArrayType *Ty, llvm::DIFile *F);
208
  llvm::DIType *CreateType(const LValueReferenceType *Ty, llvm::DIFile *F);
209
  llvm::DIType *CreateType(const RValueReferenceType *Ty, llvm::DIFile *Unit);
210
  llvm::DIType *CreateType(const MemberPointerType *Ty, llvm::DIFile *F);
211
  llvm::DIType *CreateType(const AtomicType *Ty, llvm::DIFile *F);
212
  llvm::DIType *CreateType(const PipeType *Ty, llvm::DIFile *F);
213
  /// Get enumeration type.
214
  llvm::DIType *CreateEnumType(const EnumType *Ty);
215
  llvm::DIType *CreateTypeDefinition(const EnumType *Ty);
216
  /// Look up the completed type for a self pointer in the TypeCache and
217
  /// create a copy of it with the ObjectPointer and Artificial flags
218
  /// set. If the type is not cached, a new one is created. This should
219
  /// never happen though, since creating a type for the implicit self
220
  /// argument implies that we already parsed the interface definition
221
  /// and the ivar declarations in the implementation.
222
  llvm::DIType *CreateSelfType(const QualType &QualTy, llvm::DIType *Ty);
223
  /// @}
224
225
  /// Get the type from the cache or return null type if it doesn't
226
  /// exist.
227
  llvm::DIType *getTypeOrNull(const QualType);
228
  /// Return the debug type for a C++ method.
229
  /// \arg CXXMethodDecl is of FunctionType. This function type is
230
  /// not updated to include implicit \c this pointer. Use this routine
231
  /// to get a method type which includes \c this pointer.
232
  llvm::DISubroutineType *getOrCreateMethodType(const CXXMethodDecl *Method,
233
                                                llvm::DIFile *F, bool decl);
234
  llvm::DISubroutineType *
235
  getOrCreateInstanceMethodType(QualType ThisPtr, const FunctionProtoType *Func,
236
                                llvm::DIFile *Unit, bool decl);
237
  llvm::DISubroutineType *
238
  getOrCreateFunctionType(const Decl *D, QualType FnType, llvm::DIFile *F);
239
  /// \return debug info descriptor for vtable.
240
  llvm::DIType *getOrCreateVTablePtrType(llvm::DIFile *F);
241
242
  /// \return namespace descriptor for the given namespace decl.
243
  llvm::DINamespace *getOrCreateNamespace(const NamespaceDecl *N);
244
  llvm::DIType *CreatePointerLikeType(llvm::dwarf::Tag Tag, const Type *Ty,
245
                                      QualType PointeeTy, llvm::DIFile *F);
246
  llvm::DIType *getOrCreateStructPtrType(StringRef Name, llvm::DIType *&Cache);
247
248
  /// A helper function to create a subprogram for a single member
249
  /// function GlobalDecl.
250
  llvm::DISubprogram *CreateCXXMemberFunction(const CXXMethodDecl *Method,
251
                                              llvm::DIFile *F,
252
                                              llvm::DIType *RecordTy);
253
254
  /// A helper function to collect debug info for C++ member
255
  /// functions. This is used while creating debug info entry for a
256
  /// Record.
257
  void CollectCXXMemberFunctions(const CXXRecordDecl *Decl, llvm::DIFile *F,
258
                                 SmallVectorImpl<llvm::Metadata *> &E,
259
                                 llvm::DIType *T);
260
261
  /// A helper function to collect debug info for C++ base
262
  /// classes. This is used while creating debug info entry for a
263
  /// Record.
264
  void CollectCXXBases(const CXXRecordDecl *Decl, llvm::DIFile *F,
265
                       SmallVectorImpl<llvm::Metadata *> &EltTys,
266
                       llvm::DIType *RecordTy);
267
268
  /// Helper function for CollectCXXBases.
269
  /// Adds debug info entries for types in Bases that are not in SeenTypes.
270
  void CollectCXXBasesAux(
271
      const CXXRecordDecl *RD, llvm::DIFile *Unit,
272
      SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
273
      const CXXRecordDecl::base_class_const_range &Bases,
274
      llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
275
      llvm::DINode::DIFlags StartingFlags);
276
277
  struct TemplateArgs {
278
    const TemplateParameterList *TList;
279
    llvm::ArrayRef<TemplateArgument> Args;
280
  };
281
  /// A helper function to collect template parameters.
282
  llvm::DINodeArray CollectTemplateParams(Optional<TemplateArgs> Args,
283
                                          llvm::DIFile *Unit);
284
  /// A helper function to collect debug info for function template
285
  /// parameters.
286
  llvm::DINodeArray CollectFunctionTemplateParams(const FunctionDecl *FD,
287
                                                  llvm::DIFile *Unit);
288
289
  /// A helper function to collect debug info for function template
290
  /// parameters.
291
  llvm::DINodeArray CollectVarTemplateParams(const VarDecl *VD,
292
                                             llvm::DIFile *Unit);
293
294
  Optional<TemplateArgs> GetTemplateArgs(const VarDecl *) const;
295
  Optional<TemplateArgs> GetTemplateArgs(const RecordDecl *) const;
296
  Optional<TemplateArgs> GetTemplateArgs(const FunctionDecl *) const;
297
298
  /// A helper function to collect debug info for template
299
  /// parameters.
300
  llvm::DINodeArray CollectCXXTemplateParams(const RecordDecl *TS,
301
                                             llvm::DIFile *F);
302
303
  /// A helper function to collect debug info for btf_tag annotations.
304
  llvm::DINodeArray CollectBTFTagAnnotations(const Decl *D);
305
306
  llvm::DIType *createFieldType(StringRef name, QualType type,
307
                                SourceLocation loc, AccessSpecifier AS,
308
                                uint64_t offsetInBits, uint32_t AlignInBits,
309
                                llvm::DIFile *tunit, llvm::DIScope *scope,
310
                                const RecordDecl *RD = nullptr,
311
                                llvm::DINodeArray Annotations = nullptr);
312
313
  llvm::DIType *createFieldType(StringRef name, QualType type,
314
                                SourceLocation loc, AccessSpecifier AS,
315
                                uint64_t offsetInBits, llvm::DIFile *tunit,
316
                                llvm::DIScope *scope,
317
842
                                const RecordDecl *RD = nullptr) {
318
842
    return createFieldType(name, type, loc, AS, offsetInBits, 0, tunit, scope,
319
842
                           RD);
320
842
  }
321
322
  /// Create new bit field member.
323
  llvm::DIType *createBitFieldType(const FieldDecl *BitFieldDecl,
324
                                   llvm::DIScope *RecordTy,
325
                                   const RecordDecl *RD);
326
327
  /// Helpers for collecting fields of a record.
328
  /// @{
329
  void CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
330
                                 SmallVectorImpl<llvm::Metadata *> &E,
331
                                 llvm::DIType *RecordTy);
332
  llvm::DIDerivedType *CreateRecordStaticField(const VarDecl *Var,
333
                                               llvm::DIType *RecordTy,
334
                                               const RecordDecl *RD);
335
  void CollectRecordNormalField(const FieldDecl *Field, uint64_t OffsetInBits,
336
                                llvm::DIFile *F,
337
                                SmallVectorImpl<llvm::Metadata *> &E,
338
                                llvm::DIType *RecordTy, const RecordDecl *RD);
339
  void CollectRecordNestedType(const TypeDecl *RD,
340
                               SmallVectorImpl<llvm::Metadata *> &E);
341
  void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile *F,
342
                           SmallVectorImpl<llvm::Metadata *> &E,
343
                           llvm::DICompositeType *RecordTy);
344
345
  /// If the C++ class has vtable info then insert appropriate debug
346
  /// info entry in EltTys vector.
347
  void CollectVTableInfo(const CXXRecordDecl *Decl, llvm::DIFile *F,
348
                         SmallVectorImpl<llvm::Metadata *> &EltTys);
349
  /// @}
350
351
  /// Create a new lexical block node and push it on the stack.
352
  void CreateLexicalBlock(SourceLocation Loc);
353
354
  /// If target-specific LLVM \p AddressSpace directly maps to target-specific
355
  /// DWARF address space, appends extended dereferencing mechanism to complex
356
  /// expression \p Expr. Otherwise, does nothing.
357
  ///
358
  /// Extended dereferencing mechanism is has the following format:
359
  ///     DW_OP_constu <DWARF Address Space> DW_OP_swap DW_OP_xderef
360
  void AppendAddressSpaceXDeref(unsigned AddressSpace,
361
                                SmallVectorImpl<int64_t> &Expr) const;
362
363
  /// A helper function to collect debug info for the default elements of a
364
  /// block.
365
  ///
366
  /// \returns The next available field offset after the default elements.
367
  uint64_t collectDefaultElementTypesForBlockPointer(
368
      const BlockPointerType *Ty, llvm::DIFile *Unit,
369
      llvm::DIDerivedType *DescTy, unsigned LineNo,
370
      SmallVectorImpl<llvm::Metadata *> &EltTys);
371
372
  /// A helper function to collect debug info for the default fields of a
373
  /// block.
374
  void collectDefaultFieldsForBlockLiteralDeclare(
375
      const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
376
      const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
377
      SmallVectorImpl<llvm::Metadata *> &Fields);
378
379
public:
380
  CGDebugInfo(CodeGenModule &CGM);
381
  ~CGDebugInfo();
382
383
  void finalize();
384
385
  /// Remap a given path with the current debug prefix map
386
  std::string remapDIPath(StringRef) const;
387
388
  /// Register VLA size expression debug node with the qualified type.
389
42
  void registerVLASizeExpression(QualType Ty, llvm::Metadata *SizeExpr) {
390
42
    SizeExprCache[Ty] = SizeExpr;
391
42
  }
392
393
  /// Module debugging: Support for building PCMs.
394
  /// @{
395
  /// Set the main CU's DwoId field to \p Signature.
396
  void setDwoId(uint64_t Signature);
397
398
  /// When generating debug information for a clang module or
399
  /// precompiled header, this module map will be used to determine
400
  /// the module of origin of each Decl.
401
261
  void setModuleMap(ModuleMap &MMap) { ClangModuleMap = &MMap; }
402
403
  /// When generating debug information for a clang module or
404
  /// precompiled header, this module map will be used to determine
405
  /// the module of origin of each Decl.
406
261
  void setPCHDescriptor(ASTSourceDescriptor PCH) { PCHDescriptor = PCH; }
407
  /// @}
408
409
  /// Update the current source location. If \arg loc is invalid it is
410
  /// ignored.
411
  void setLocation(SourceLocation Loc);
412
413
  /// Return the current source location. This does not necessarily correspond
414
  /// to the IRBuilder's current DebugLoc.
415
3
  SourceLocation getLocation() const { return CurLoc; }
416
417
  /// Update the current inline scope. All subsequent calls to \p EmitLocation
418
  /// will create a location with this inlinedAt field.
419
6
  void setInlinedAt(llvm::MDNode *InlinedAt) { CurInlinedAt = InlinedAt; }
420
421
  /// \return the current inline scope.
422
11.8k
  llvm::MDNode *getInlinedAt() const { return CurInlinedAt; }
423
424
  // Converts a SourceLocation to a DebugLoc
425
  llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Loc);
426
427
  /// Emit metadata to indicate a change in line/column information in
428
  /// the source file. If the location is invalid, the previous
429
  /// location will be reused.
430
  void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc);
431
432
  /// Emit a call to llvm.dbg.function.start to indicate
433
  /// start of a new function.
434
  /// \param Loc       The location of the function header.
435
  /// \param ScopeLoc  The location of the function body.
436
  void emitFunctionStart(GlobalDecl GD, SourceLocation Loc,
437
                         SourceLocation ScopeLoc, QualType FnType,
438
                         llvm::Function *Fn, bool CurFnIsThunk);
439
440
  /// Start a new scope for an inlined function.
441
  void EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD);
442
  /// End an inlined function scope.
443
  void EmitInlineFunctionEnd(CGBuilderTy &Builder);
444
445
  /// Emit debug info for a function declaration.
446
  /// \p Fn is set only when a declaration for a debug call site gets created.
447
  void EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc,
448
                        QualType FnType, llvm::Function *Fn = nullptr);
449
450
  /// Emit debug info for an extern function being called.
451
  /// This is needed for call site debug info.
452
  void EmitFuncDeclForCallSite(llvm::CallBase *CallOrInvoke,
453
                               QualType CalleeType,
454
                               const FunctionDecl *CalleeDecl);
455
456
  /// Constructs the debug code for exiting a function.
457
  void EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn);
458
459
  /// Emit metadata to indicate the beginning of a new lexical block
460
  /// and push the block onto the stack.
461
  void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc);
462
463
  /// Emit metadata to indicate the end of a new lexical block and pop
464
  /// the current block.
465
  void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc);
466
467
  /// Emit call to \c llvm.dbg.declare for an automatic variable
468
  /// declaration.
469
  /// Returns a pointer to the DILocalVariable associated with the
470
  /// llvm.dbg.declare, or nullptr otherwise.
471
  llvm::DILocalVariable *
472
  EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI,
473
                            CGBuilderTy &Builder,
474
                            const bool UsePointerValue = false);
475
476
  /// Emit call to \c llvm.dbg.label for an label.
477
  void EmitLabel(const LabelDecl *D, CGBuilderTy &Builder);
478
479
  /// Emit call to \c llvm.dbg.declare for an imported variable
480
  /// declaration in a block.
481
  void EmitDeclareOfBlockDeclRefVariable(
482
      const VarDecl *variable, llvm::Value *storage, CGBuilderTy &Builder,
483
      const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint = nullptr);
484
485
  /// Emit call to \c llvm.dbg.declare for an argument variable
486
  /// declaration.
487
  llvm::DILocalVariable *EmitDeclareOfArgVariable(const VarDecl *Decl,
488
                                                  llvm::Value *AI,
489
                                                  unsigned ArgNo,
490
                                                  CGBuilderTy &Builder);
491
492
  /// Emit call to \c llvm.dbg.declare for the block-literal argument
493
  /// to a block invocation function.
494
  void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
495
                                            StringRef Name, unsigned ArgNo,
496
                                            llvm::AllocaInst *LocalAddr,
497
                                            CGBuilderTy &Builder);
498
499
  /// Emit information about a global variable.
500
  void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
501
502
  /// Emit a constant global variable's debug info.
503
  void EmitGlobalVariable(const ValueDecl *VD, const APValue &Init);
504
505
  /// Emit information about an external variable.
506
  void EmitExternalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
507
508
  /// Emit C++ using directive.
509
  void EmitUsingDirective(const UsingDirectiveDecl &UD);
510
511
  /// Emit the type explicitly casted to.
512
  void EmitExplicitCastType(QualType Ty);
513
514
  /// Emit the type even if it might not be used.
515
  void EmitAndRetainType(QualType Ty);
516
517
  /// Emit a shadow decl brought in by a using or using-enum
518
  void EmitUsingShadowDecl(const UsingShadowDecl &USD);
519
520
  /// Emit C++ using declaration.
521
  void EmitUsingDecl(const UsingDecl &UD);
522
523
  /// Emit C++ using-enum declaration.
524
  void EmitUsingEnumDecl(const UsingEnumDecl &UD);
525
526
  /// Emit an @import declaration.
527
  void EmitImportDecl(const ImportDecl &ID);
528
529
  /// Emit C++ namespace alias.
530
  llvm::DIImportedEntity *EmitNamespaceAlias(const NamespaceAliasDecl &NA);
531
532
  /// Emit record type's standalone debug info.
533
  llvm::DIType *getOrCreateRecordType(QualType Ty, SourceLocation L);
534
535
  /// Emit an Objective-C interface type standalone debug info.
536
  llvm::DIType *getOrCreateInterfaceType(QualType Ty, SourceLocation Loc);
537
538
  /// Emit standalone debug info for a type.
539
  llvm::DIType *getOrCreateStandaloneType(QualType Ty, SourceLocation Loc);
540
541
  /// Add heapallocsite metadata for MSAllocator calls.
542
  void addHeapAllocSiteMetadata(llvm::CallBase *CallSite, QualType AllocatedTy,
543
                                SourceLocation Loc);
544
545
  void completeType(const EnumDecl *ED);
546
  void completeType(const RecordDecl *RD);
547
  void completeRequiredType(const RecordDecl *RD);
548
  void completeClassData(const RecordDecl *RD);
549
  void completeClass(const RecordDecl *RD);
550
551
  void completeTemplateDefinition(const ClassTemplateSpecializationDecl &SD);
552
  void completeUnusedClass(const CXXRecordDecl &D);
553
554
  /// Create debug info for a macro defined by a #define directive or a macro
555
  /// undefined by a #undef directive.
556
  llvm::DIMacro *CreateMacro(llvm::DIMacroFile *Parent, unsigned MType,
557
                             SourceLocation LineLoc, StringRef Name,
558
                             StringRef Value);
559
560
  /// Create debug info for a file referenced by an #include directive.
561
  llvm::DIMacroFile *CreateTempMacroFile(llvm::DIMacroFile *Parent,
562
                                         SourceLocation LineLoc,
563
                                         SourceLocation FileLoc);
564
565
102k
  Param2DILocTy &getParamDbgMappings() { return ParamDbgMappings; }
566
3
  ParamDecl2StmtTy &getCoroutineParameterMappings() {
567
3
    return CoroutineParameterMappings;
568
3
  }
569
570
private:
571
  /// Emit call to llvm.dbg.declare for a variable declaration.
572
  /// Returns a pointer to the DILocalVariable associated with the
573
  /// llvm.dbg.declare, or nullptr otherwise.
574
  llvm::DILocalVariable *EmitDeclare(const VarDecl *decl, llvm::Value *AI,
575
                                     llvm::Optional<unsigned> ArgNo,
576
                                     CGBuilderTy &Builder,
577
                                     const bool UsePointerValue = false);
578
579
  struct BlockByRefType {
580
    /// The wrapper struct used inside the __block_literal struct.
581
    llvm::DIType *BlockByRefWrapper;
582
    /// The type as it appears in the source code.
583
    llvm::DIType *WrappedType;
584
  };
585
586
  std::string GetName(const Decl*, bool Qualified = false) const;
587
588
  /// Build up structure info for the byref.  See \a BuildByRefType.
589
  BlockByRefType EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
590
                                              uint64_t *OffSet);
591
592
  /// Get context info for the DeclContext of \p Decl.
593
  llvm::DIScope *getDeclContextDescriptor(const Decl *D);
594
  /// Get context info for a given DeclContext \p Decl.
595
  llvm::DIScope *getContextDescriptor(const Decl *Context,
596
                                      llvm::DIScope *Default);
597
598
  llvm::DIScope *getCurrentContextDescriptor(const Decl *Decl);
599
600
  /// Create a forward decl for a RecordType in a given context.
601
  llvm::DICompositeType *getOrCreateRecordFwdDecl(const RecordType *,
602
                                                  llvm::DIScope *);
603
604
  /// Return current directory name.
605
  StringRef getCurrentDirname();
606
607
  /// Create new compile unit.
608
  void CreateCompileUnit();
609
610
  /// Compute the file checksum debug info for input file ID.
611
  Optional<llvm::DIFile::ChecksumKind>
612
  computeChecksum(FileID FID, SmallString<32> &Checksum) const;
613
614
  /// Get the source of the given file ID.
615
  Optional<StringRef> getSource(const SourceManager &SM, FileID FID);
616
617
  /// Convenience function to get the file debug info descriptor for the input
618
  /// location.
619
  llvm::DIFile *getOrCreateFile(SourceLocation Loc);
620
621
  /// Create a file debug info descriptor for a source file.
622
  llvm::DIFile *
623
  createFile(StringRef FileName,
624
             Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
625
             Optional<StringRef> Source);
626
627
  /// Get the type from the cache or create a new type if necessary.
628
  llvm::DIType *getOrCreateType(QualType Ty, llvm::DIFile *Fg);
629
630
  /// Get a reference to a clang module.  If \p CreateSkeletonCU is true,
631
  /// this also creates a split dwarf skeleton compile unit.
632
  llvm::DIModule *getOrCreateModuleRef(ASTSourceDescriptor Mod,
633
                                       bool CreateSkeletonCU);
634
635
  /// DebugTypeExtRefs: If \p D originated in a clang module, return it.
636
  llvm::DIModule *getParentModuleOrNull(const Decl *D);
637
638
  /// Get the type from the cache or create a new partial type if
639
  /// necessary.
640
  llvm::DICompositeType *getOrCreateLimitedType(const RecordType *Ty);
641
642
  /// Create type metadata for a source language type.
643
  llvm::DIType *CreateTypeNode(QualType Ty, llvm::DIFile *Fg);
644
645
  /// Create new member and increase Offset by FType's size.
646
  llvm::DIType *CreateMemberType(llvm::DIFile *Unit, QualType FType,
647
                                 StringRef Name, uint64_t *Offset);
648
649
  /// Retrieve the DIDescriptor, if any, for the canonical form of this
650
  /// declaration.
651
  llvm::DINode *getDeclarationOrDefinition(const Decl *D);
652
653
  /// \return debug info descriptor to describe method
654
  /// declaration for the given method definition.
655
  llvm::DISubprogram *getFunctionDeclaration(const Decl *D);
656
657
  /// \return          debug info descriptor to the describe method declaration
658
  ///                  for the given method definition.
659
  /// \param FnType    For Objective-C methods, their type.
660
  /// \param LineNo    The declaration's line number.
661
  /// \param Flags     The DIFlags for the method declaration.
662
  /// \param SPFlags   The subprogram-spcific flags for the method declaration.
663
  llvm::DISubprogram *
664
  getObjCMethodDeclaration(const Decl *D, llvm::DISubroutineType *FnType,
665
                           unsigned LineNo, llvm::DINode::DIFlags Flags,
666
                           llvm::DISubprogram::DISPFlags SPFlags);
667
668
  /// \return debug info descriptor to describe in-class static data
669
  /// member declaration for the given out-of-class definition.  If D
670
  /// is an out-of-class definition of a static data member of a
671
  /// class, find its corresponding in-class declaration.
672
  llvm::DIDerivedType *
673
  getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D);
674
675
  /// Helper that either creates a forward declaration or a stub.
676
  llvm::DISubprogram *getFunctionFwdDeclOrStub(GlobalDecl GD, bool Stub);
677
678
  /// Create a subprogram describing the forward declaration
679
  /// represented in the given FunctionDecl wrapped in a GlobalDecl.
680
  llvm::DISubprogram *getFunctionForwardDeclaration(GlobalDecl GD);
681
682
  /// Create a DISubprogram describing the function
683
  /// represented in the given FunctionDecl wrapped in a GlobalDecl.
684
  llvm::DISubprogram *getFunctionStub(GlobalDecl GD);
685
686
  /// Create a global variable describing the forward declaration
687
  /// represented in the given VarDecl.
688
  llvm::DIGlobalVariable *
689
  getGlobalVariableForwardDeclaration(const VarDecl *VD);
690
691
  /// Return a global variable that represents one of the collection of global
692
  /// variables created for an anonmyous union.
693
  ///
694
  /// Recursively collect all of the member fields of a global
695
  /// anonymous decl and create static variables for them. The first
696
  /// time this is called it needs to be on a union and then from
697
  /// there we can have additional unnamed fields.
698
  llvm::DIGlobalVariableExpression *
699
  CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile *Unit,
700
                         unsigned LineNo, StringRef LinkageName,
701
                         llvm::GlobalVariable *Var, llvm::DIScope *DContext);
702
703
704
  /// Return flags which enable debug info emission for call sites, provided
705
  /// that it is supported and enabled.
706
  llvm::DINode::DIFlags getCallSiteRelatedAttrs() const;
707
708
  /// Get the printing policy for producing names for debug info.
709
  PrintingPolicy getPrintingPolicy() const;
710
711
  /// Get function name for the given FunctionDecl. If the name is
712
  /// constructed on demand (e.g., C++ destructor) then the name is
713
  /// stored on the side.
714
  StringRef getFunctionName(const FunctionDecl *FD);
715
716
  /// Returns the unmangled name of an Objective-C method.
717
  /// This is the display name for the debugging info.
718
  StringRef getObjCMethodName(const ObjCMethodDecl *FD);
719
720
  /// Return selector name. This is used for debugging
721
  /// info.
722
  StringRef getSelectorName(Selector S);
723
724
  /// Get class name including template argument list.
725
  StringRef getClassName(const RecordDecl *RD);
726
727
  /// Get the vtable name for the given class.
728
  StringRef getVTableName(const CXXRecordDecl *Decl);
729
730
  /// Get the name to use in the debug info for a dynamic initializer or atexit
731
  /// stub function.
732
  StringRef getDynamicInitializerName(const VarDecl *VD,
733
                                      DynamicInitKind StubKind,
734
                                      llvm::Function *InitFn);
735
736
  /// Get line number for the location. If location is invalid
737
  /// then use current location.
738
  unsigned getLineNumber(SourceLocation Loc);
739
740
  /// Get column number for the location. If location is
741
  /// invalid then use current location.
742
  /// \param Force  Assume DebugColumnInfo option is true.
743
  unsigned getColumnNumber(SourceLocation Loc, bool Force = false);
744
745
  /// Collect various properties of a FunctionDecl.
746
  /// \param GD  A GlobalDecl whose getDecl() must return a FunctionDecl.
747
  void collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
748
                                StringRef &Name, StringRef &LinkageName,
749
                                llvm::DIScope *&FDContext,
750
                                llvm::DINodeArray &TParamsArray,
751
                                llvm::DINode::DIFlags &Flags);
752
753
  /// Collect various properties of a VarDecl.
754
  void collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
755
                           unsigned &LineNo, QualType &T, StringRef &Name,
756
                           StringRef &LinkageName,
757
                           llvm::MDTuple *&TemplateParameters,
758
                           llvm::DIScope *&VDContext);
759
760
  /// Allocate a copy of \p A using the DebugInfoNames allocator
761
  /// and return a reference to it. If multiple arguments are given the strings
762
  /// are concatenated.
763
759k
  StringRef internString(StringRef A, StringRef B = StringRef()) {
764
759k
    char *Data = DebugInfoNames.Allocate<char>(A.size() + B.size());
765
759k
    if (!A.empty())
766
759k
      std::memcpy(Data, A.data(), A.size());
767
759k
    if (!B.empty())
768
880
      std::memcpy(Data + A.size(), B.data(), B.size());
769
759k
    return StringRef(Data, A.size() + B.size());
770
759k
  }
771
};
772
773
/// A scoped helper to set the current debug location to the specified
774
/// location or preferred location of the specified Expr.
775
class ApplyDebugLocation {
776
private:
777
  void init(SourceLocation TemporaryLocation, bool DefaultToEmpty = false);
778
  ApplyDebugLocation(CodeGenFunction &CGF, bool DefaultToEmpty,
779
                     SourceLocation TemporaryLocation);
780
781
  llvm::DebugLoc OriginalLocation;
782
  CodeGenFunction *CGF;
783
784
public:
785
  /// Set the location to the (valid) TemporaryLocation.
786
  ApplyDebugLocation(CodeGenFunction &CGF, SourceLocation TemporaryLocation);
787
  ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E);
788
  ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc);
789
1.25k
  ApplyDebugLocation(ApplyDebugLocation &&Other) : CGF(Other.CGF) {
790
1.25k
    Other.CGF = nullptr;
791
1.25k
  }
792
0
  ApplyDebugLocation &operator=(ApplyDebugLocation &&) = default;
793
794
  ~ApplyDebugLocation();
795
796
  /// Apply TemporaryLocation if it is valid. Otherwise switch
797
  /// to an artificial debug location that has a valid scope, but no
798
  /// line information.
799
  ///
800
  /// Artificial locations are useful when emitting compiler-generated
801
  /// helper functions that have no source location associated with
802
  /// them. The DWARF specification allows the compiler to use the
803
  /// special line number 0 to indicate code that can not be
804
  /// attributed to any source location. Note that passing an empty
805
  /// SourceLocation to CGDebugInfo::setLocation() will result in the
806
  /// last valid location being reused.
807
11.5k
  static ApplyDebugLocation CreateArtificial(CodeGenFunction &CGF) {
808
11.5k
    return ApplyDebugLocation(CGF, false, SourceLocation());
809
11.5k
  }
810
  /// Apply TemporaryLocation if it is valid. Otherwise switch
811
  /// to an artificial debug location that has a valid scope, but no
812
  /// line information.
813
  static ApplyDebugLocation
814
  CreateDefaultArtificial(CodeGenFunction &CGF,
815
275k
                          SourceLocation TemporaryLocation) {
816
275k
    return ApplyDebugLocation(CGF, false, TemporaryLocation);
817
275k
  }
818
819
  /// Set the IRBuilder to not attach debug locations.  Note that
820
  /// passing an empty SourceLocation to \a CGDebugInfo::setLocation()
821
  /// will result in the last valid location being reused.  Note that
822
  /// all instructions that do not have a location at the beginning of
823
  /// a function are counted towards to function prologue.
824
35.2k
  static ApplyDebugLocation CreateEmpty(CodeGenFunction &CGF) {
825
35.2k
    return ApplyDebugLocation(CGF, true, SourceLocation());
826
35.2k
  }
827
};
828
829
/// A scoped helper to set the current debug location to an inlined location.
830
class ApplyInlineDebugLocation {
831
  SourceLocation SavedLocation;
832
  CodeGenFunction *CGF;
833
834
public:
835
  /// Set up the CodeGenFunction's DebugInfo to produce inline locations for the
836
  /// function \p InlinedFn. The current debug location becomes the inlined call
837
  /// site of the inlined function.
838
  ApplyInlineDebugLocation(CodeGenFunction &CGF, GlobalDecl InlinedFn);
839
  /// Restore everything back to the original state.
840
  ~ApplyInlineDebugLocation();
841
};
842
843
} // namespace CodeGen
844
} // namespace clang
845
846
#endif // LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H