1 //===--- CGDebugInfo.h - DebugInfo for LLVM CodeGen -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the source-level debug info generator for llvm translation.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H
15 #define LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H
17 #include "CGBuilder.h"
18 #include "clang/AST/DeclCXX.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/ExternalASTSource.h"
21 #include "clang/AST/Type.h"
22 #include "clang/AST/TypeOrdering.h"
23 #include "clang/Basic/CodeGenOptions.h"
24 #include "clang/Basic/SourceLocation.h"
25 #include "llvm/ADT/DenseMap.h"
26 #include "llvm/ADT/DenseSet.h"
27 #include "llvm/ADT/Optional.h"
28 #include "llvm/IR/DIBuilder.h"
29 #include "llvm/IR/DebugInfo.h"
30 #include "llvm/IR/ValueHandle.h"
31 #include "llvm/Support/Allocator.h"
38 class ClassTemplateSpecializationDecl;
41 class ObjCInterfaceDecl;
48 class CodeGenFunction;
51 /// This class gathers all debug information during compilation and is
52 /// responsible for emitting to llvm globals or pass directly to the
55 friend class ApplyDebugLocation;
56 friend class SaveAndRestoreLocation;
58 const codegenoptions::DebugInfoKind DebugKind;
59 bool DebugTypeExtRefs;
60 llvm::DIBuilder DBuilder;
61 llvm::DICompileUnit *TheCU = nullptr;
62 ModuleMap *ClangModuleMap = nullptr;
63 ExternalASTSource::ASTSourceDescriptor PCHDescriptor;
64 SourceLocation CurLoc;
65 llvm::MDNode *CurInlinedAt = nullptr;
66 llvm::DIType *VTablePtrType = nullptr;
67 llvm::DIType *ClassTy = nullptr;
68 llvm::DICompositeType *ObjTy = nullptr;
69 llvm::DIType *SelTy = nullptr;
70 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
71 llvm::DIType *SingletonId = nullptr;
72 #include "clang/Basic/OpenCLImageTypes.def"
73 llvm::DIType *OCLSamplerDITy = nullptr;
74 llvm::DIType *OCLEventDITy = nullptr;
75 llvm::DIType *OCLClkEventDITy = nullptr;
76 llvm::DIType *OCLQueueDITy = nullptr;
77 llvm::DIType *OCLNDRangeDITy = nullptr;
78 llvm::DIType *OCLReserveIDDITy = nullptr;
79 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
80 llvm::DIType *Id##Ty = nullptr;
81 #include "clang/Basic/OpenCLExtensionTypes.def"
83 /// Cache of previously constructed Types.
84 llvm::DenseMap<const void *, llvm::TrackingMDRef> TypeCache;
86 llvm::SmallDenseMap<llvm::StringRef, llvm::StringRef> DebugPrefixMap;
88 /// Cache that maps VLA types to size expressions for that type,
89 /// represented by instantiated Metadata nodes.
90 llvm::SmallDenseMap<QualType, llvm::Metadata *> SizeExprCache;
92 struct ObjCInterfaceCacheEntry {
93 const ObjCInterfaceType *Type;
96 ObjCInterfaceCacheEntry(const ObjCInterfaceType *Type, llvm::DIType *Decl,
98 : Type(Type), Decl(Decl), Unit(Unit) {}
101 /// Cache of previously constructed interfaces which may change.
102 llvm::SmallVector<ObjCInterfaceCacheEntry, 32> ObjCInterfaceCache;
104 /// Cache of forward declarations for methods belonging to the interface.
105 llvm::DenseMap<const ObjCInterfaceDecl *, std::vector<llvm::DISubprogram *>>
108 /// Cache of references to clang modules and precompiled headers.
109 llvm::DenseMap<const Module *, llvm::TrackingMDRef> ModuleCache;
111 /// List of interfaces we want to keep even if orphaned.
112 std::vector<void *> RetainedTypes;
114 /// Cache of forward declared types to RAUW at the end of compilation.
115 std::vector<std::pair<const TagType *, llvm::TrackingMDRef>> ReplaceMap;
117 /// Cache of replaceable forward declarations (functions and
118 /// variables) to RAUW at the end of compilation.
119 std::vector<std::pair<const DeclaratorDecl *, llvm::TrackingMDRef>>
122 /// Keep track of our current nested lexical block.
123 std::vector<llvm::TypedTrackingMDRef<llvm::DIScope>> LexicalBlockStack;
124 llvm::DenseMap<const Decl *, llvm::TrackingMDRef> RegionMap;
125 /// Keep track of LexicalBlockStack counter at the beginning of a
126 /// function. This is used to pop unbalanced regions at the end of a
128 std::vector<unsigned> FnBeginRegionCount;
130 /// This is a storage for names that are constructed on demand. For
131 /// example, C++ destructors, C++ operators etc..
132 llvm::BumpPtrAllocator DebugInfoNames;
135 llvm::DenseMap<const char *, llvm::TrackingMDRef> DIFileCache;
136 llvm::DenseMap<const FunctionDecl *, llvm::TrackingMDRef> SPCache;
137 /// Cache declarations relevant to DW_TAG_imported_declarations (C++
138 /// using declarations) that aren't covered by other more specific caches.
139 llvm::DenseMap<const Decl *, llvm::TrackingMDRef> DeclCache;
140 llvm::DenseMap<const NamespaceDecl *, llvm::TrackingMDRef> NamespaceCache;
141 llvm::DenseMap<const NamespaceAliasDecl *, llvm::TrackingMDRef>
143 llvm::DenseMap<const Decl *, llvm::TypedTrackingMDRef<llvm::DIDerivedType>>
144 StaticDataMemberCache;
146 /// Helper functions for getOrCreateType.
148 /// Currently the checksum of an interface includes the number of
149 /// ivars and property accessors.
150 llvm::DIType *CreateType(const BuiltinType *Ty);
151 llvm::DIType *CreateType(const ComplexType *Ty);
152 llvm::DIType *CreateQualifiedType(QualType Ty, llvm::DIFile *Fg);
153 llvm::DIType *CreateType(const TypedefType *Ty, llvm::DIFile *Fg);
154 llvm::DIType *CreateType(const TemplateSpecializationType *Ty,
156 llvm::DIType *CreateType(const ObjCObjectPointerType *Ty, llvm::DIFile *F);
157 llvm::DIType *CreateType(const PointerType *Ty, llvm::DIFile *F);
158 llvm::DIType *CreateType(const BlockPointerType *Ty, llvm::DIFile *F);
159 llvm::DIType *CreateType(const FunctionType *Ty, llvm::DIFile *F);
160 /// Get structure or union type.
161 llvm::DIType *CreateType(const RecordType *Tyg);
162 llvm::DIType *CreateTypeDefinition(const RecordType *Ty);
163 llvm::DICompositeType *CreateLimitedType(const RecordType *Ty);
164 void CollectContainingType(const CXXRecordDecl *RD,
165 llvm::DICompositeType *CT);
166 /// Get Objective-C interface type.
167 llvm::DIType *CreateType(const ObjCInterfaceType *Ty, llvm::DIFile *F);
168 llvm::DIType *CreateTypeDefinition(const ObjCInterfaceType *Ty,
170 /// Get Objective-C object type.
171 llvm::DIType *CreateType(const ObjCObjectType *Ty, llvm::DIFile *F);
172 llvm::DIType *CreateType(const ObjCTypeParamType *Ty, llvm::DIFile *Unit);
174 llvm::DIType *CreateType(const VectorType *Ty, llvm::DIFile *F);
175 llvm::DIType *CreateType(const ArrayType *Ty, llvm::DIFile *F);
176 llvm::DIType *CreateType(const LValueReferenceType *Ty, llvm::DIFile *F);
177 llvm::DIType *CreateType(const RValueReferenceType *Ty, llvm::DIFile *Unit);
178 llvm::DIType *CreateType(const MemberPointerType *Ty, llvm::DIFile *F);
179 llvm::DIType *CreateType(const AtomicType *Ty, llvm::DIFile *F);
180 llvm::DIType *CreateType(const PipeType *Ty, llvm::DIFile *F);
181 /// Get enumeration type.
182 llvm::DIType *CreateEnumType(const EnumType *Ty);
183 llvm::DIType *CreateTypeDefinition(const EnumType *Ty);
184 /// Look up the completed type for a self pointer in the TypeCache and
185 /// create a copy of it with the ObjectPointer and Artificial flags
186 /// set. If the type is not cached, a new one is created. This should
187 /// never happen though, since creating a type for the implicit self
188 /// argument implies that we already parsed the interface definition
189 /// and the ivar declarations in the implementation.
190 llvm::DIType *CreateSelfType(const QualType &QualTy, llvm::DIType *Ty);
193 /// Get the type from the cache or return null type if it doesn't
195 llvm::DIType *getTypeOrNull(const QualType);
196 /// Return the debug type for a C++ method.
197 /// \arg CXXMethodDecl is of FunctionType. This function type is
198 /// not updated to include implicit \c this pointer. Use this routine
199 /// to get a method type which includes \c this pointer.
200 llvm::DISubroutineType *getOrCreateMethodType(const CXXMethodDecl *Method,
202 llvm::DISubroutineType *
203 getOrCreateInstanceMethodType(QualType ThisPtr, const FunctionProtoType *Func,
205 llvm::DISubroutineType *
206 getOrCreateFunctionType(const Decl *D, QualType FnType, llvm::DIFile *F);
207 /// \return debug info descriptor for vtable.
208 llvm::DIType *getOrCreateVTablePtrType(llvm::DIFile *F);
210 /// \return namespace descriptor for the given namespace decl.
211 llvm::DINamespace *getOrCreateNamespace(const NamespaceDecl *N);
212 llvm::DIType *CreatePointerLikeType(llvm::dwarf::Tag Tag, const Type *Ty,
213 QualType PointeeTy, llvm::DIFile *F);
214 llvm::DIType *getOrCreateStructPtrType(StringRef Name, llvm::DIType *&Cache);
216 /// A helper function to create a subprogram for a single member
217 /// function GlobalDecl.
218 llvm::DISubprogram *CreateCXXMemberFunction(const CXXMethodDecl *Method,
220 llvm::DIType *RecordTy);
222 /// A helper function to collect debug info for C++ member
223 /// functions. This is used while creating debug info entry for a
225 void CollectCXXMemberFunctions(const CXXRecordDecl *Decl, llvm::DIFile *F,
226 SmallVectorImpl<llvm::Metadata *> &E,
229 /// A helper function to collect debug info for C++ base
230 /// classes. This is used while creating debug info entry for a
232 void CollectCXXBases(const CXXRecordDecl *Decl, llvm::DIFile *F,
233 SmallVectorImpl<llvm::Metadata *> &EltTys,
234 llvm::DIType *RecordTy);
236 /// Helper function for CollectCXXBases.
237 /// Adds debug info entries for types in Bases that are not in SeenTypes.
238 void CollectCXXBasesAux(
239 const CXXRecordDecl *RD, llvm::DIFile *Unit,
240 SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
241 const CXXRecordDecl::base_class_const_range &Bases,
242 llvm::DenseSet<CanonicalDeclPtr<const CXXRecordDecl>> &SeenTypes,
243 llvm::DINode::DIFlags StartingFlags);
245 /// A helper function to collect template parameters.
246 llvm::DINodeArray CollectTemplateParams(const TemplateParameterList *TPList,
247 ArrayRef<TemplateArgument> TAList,
249 /// A helper function to collect debug info for function template
251 llvm::DINodeArray CollectFunctionTemplateParams(const FunctionDecl *FD,
254 /// A helper function to collect debug info for function template
256 llvm::DINodeArray CollectVarTemplateParams(const VarDecl *VD,
259 /// A helper function to collect debug info for template
262 CollectCXXTemplateParams(const ClassTemplateSpecializationDecl *TS,
265 llvm::DIType *createFieldType(StringRef name, QualType type,
266 SourceLocation loc, AccessSpecifier AS,
267 uint64_t offsetInBits, uint32_t AlignInBits,
268 llvm::DIFile *tunit, llvm::DIScope *scope,
269 const RecordDecl *RD = nullptr);
271 llvm::DIType *createFieldType(StringRef name, QualType type,
272 SourceLocation loc, AccessSpecifier AS,
273 uint64_t offsetInBits, llvm::DIFile *tunit,
274 llvm::DIScope *scope,
275 const RecordDecl *RD = nullptr) {
276 return createFieldType(name, type, loc, AS, offsetInBits, 0, tunit, scope,
280 /// Create new bit field member.
281 llvm::DIType *createBitFieldType(const FieldDecl *BitFieldDecl,
282 llvm::DIScope *RecordTy,
283 const RecordDecl *RD);
285 /// Helpers for collecting fields of a record.
287 void CollectRecordLambdaFields(const CXXRecordDecl *CXXDecl,
288 SmallVectorImpl<llvm::Metadata *> &E,
289 llvm::DIType *RecordTy);
290 llvm::DIDerivedType *CreateRecordStaticField(const VarDecl *Var,
291 llvm::DIType *RecordTy,
292 const RecordDecl *RD);
293 void CollectRecordNormalField(const FieldDecl *Field, uint64_t OffsetInBits,
295 SmallVectorImpl<llvm::Metadata *> &E,
296 llvm::DIType *RecordTy, const RecordDecl *RD);
297 void CollectRecordNestedType(const TypeDecl *RD,
298 SmallVectorImpl<llvm::Metadata *> &E);
299 void CollectRecordFields(const RecordDecl *Decl, llvm::DIFile *F,
300 SmallVectorImpl<llvm::Metadata *> &E,
301 llvm::DICompositeType *RecordTy);
303 /// If the C++ class has vtable info then insert appropriate debug
304 /// info entry in EltTys vector.
305 void CollectVTableInfo(const CXXRecordDecl *Decl, llvm::DIFile *F,
306 SmallVectorImpl<llvm::Metadata *> &EltTys,
307 llvm::DICompositeType *RecordTy);
310 /// Create a new lexical block node and push it on the stack.
311 void CreateLexicalBlock(SourceLocation Loc);
313 /// If target-specific LLVM \p AddressSpace directly maps to target-specific
314 /// DWARF address space, appends extended dereferencing mechanism to complex
315 /// expression \p Expr. Otherwise, does nothing.
317 /// Extended dereferencing mechanism is has the following format:
318 /// DW_OP_constu <DWARF Address Space> DW_OP_swap DW_OP_xderef
319 void AppendAddressSpaceXDeref(unsigned AddressSpace,
320 SmallVectorImpl<int64_t> &Expr) const;
322 /// A helper function to collect debug info for the default elements of a
325 /// \returns The next available field offset after the default elements.
326 uint64_t collectDefaultElementTypesForBlockPointer(
327 const BlockPointerType *Ty, llvm::DIFile *Unit,
328 llvm::DIDerivedType *DescTy, unsigned LineNo,
329 SmallVectorImpl<llvm::Metadata *> &EltTys);
331 /// A helper function to collect debug info for the default fields of a
333 void collectDefaultFieldsForBlockLiteralDeclare(
334 const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
335 const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
336 SmallVectorImpl<llvm::Metadata *> &Fields);
339 CGDebugInfo(CodeGenModule &CGM);
344 /// Remap a given path with the current debug prefix map
345 std::string remapDIPath(StringRef) const;
347 /// Register VLA size expression debug node with the qualified type.
348 void registerVLASizeExpression(QualType Ty, llvm::Metadata *SizeExpr) {
349 SizeExprCache[Ty] = SizeExpr;
352 /// Module debugging: Support for building PCMs.
354 /// Set the main CU's DwoId field to \p Signature.
355 void setDwoId(uint64_t Signature);
357 /// When generating debug information for a clang module or
358 /// precompiled header, this module map will be used to determine
359 /// the module of origin of each Decl.
360 void setModuleMap(ModuleMap &MMap) { ClangModuleMap = &MMap; }
362 /// When generating debug information for a clang module or
363 /// precompiled header, this module map will be used to determine
364 /// the module of origin of each Decl.
365 void setPCHDescriptor(ExternalASTSource::ASTSourceDescriptor PCH) {
370 /// Update the current source location. If \arg loc is invalid it is
372 void setLocation(SourceLocation Loc);
374 /// Return the current source location. This does not necessarily correspond
375 /// to the IRBuilder's current DebugLoc.
376 SourceLocation getLocation() const { return CurLoc; }
378 /// Update the current inline scope. All subsequent calls to \p EmitLocation
379 /// will create a location with this inlinedAt field.
380 void setInlinedAt(llvm::MDNode *InlinedAt) { CurInlinedAt = InlinedAt; }
382 /// \return the current inline scope.
383 llvm::MDNode *getInlinedAt() const { return CurInlinedAt; }
385 // Converts a SourceLocation to a DebugLoc
386 llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Loc);
388 /// Emit metadata to indicate a change in line/column information in
389 /// the source file. If the location is invalid, the previous
390 /// location will be reused.
391 void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc);
393 /// Emit a call to llvm.dbg.function.start to indicate
394 /// start of a new function.
395 /// \param Loc The location of the function header.
396 /// \param ScopeLoc The location of the function body.
397 void EmitFunctionStart(GlobalDecl GD, SourceLocation Loc,
398 SourceLocation ScopeLoc, QualType FnType,
399 llvm::Function *Fn, bool CurFnIsThunk,
400 CGBuilderTy &Builder);
402 /// Start a new scope for an inlined function.
403 void EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD);
404 /// End an inlined function scope.
405 void EmitInlineFunctionEnd(CGBuilderTy &Builder);
407 /// Emit debug info for a function declaration.
408 void EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc, QualType FnType);
410 /// Constructs the debug code for exiting a function.
411 void EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn);
413 /// Emit metadata to indicate the beginning of a new lexical block
414 /// and push the block onto the stack.
415 void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc);
417 /// Emit metadata to indicate the end of a new lexical block and pop
418 /// the current block.
419 void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc);
421 /// Emit call to \c llvm.dbg.declare for an automatic variable
423 /// Returns a pointer to the DILocalVariable associated with the
424 /// llvm.dbg.declare, or nullptr otherwise.
425 llvm::DILocalVariable *EmitDeclareOfAutoVariable(const VarDecl *Decl,
427 CGBuilderTy &Builder);
429 /// Emit call to \c llvm.dbg.declare for an imported variable
430 /// declaration in a block.
431 void EmitDeclareOfBlockDeclRefVariable(
432 const VarDecl *variable, llvm::Value *storage, CGBuilderTy &Builder,
433 const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint = nullptr);
435 /// Emit call to \c llvm.dbg.declare for an argument variable
437 void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI,
438 unsigned ArgNo, CGBuilderTy &Builder);
440 /// Emit call to \c llvm.dbg.declare for the block-literal argument
441 /// to a block invocation function.
442 void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block,
443 StringRef Name, unsigned ArgNo,
444 llvm::AllocaInst *LocalAddr,
445 CGBuilderTy &Builder);
447 /// Emit information about a global variable.
448 void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl);
450 /// Emit a constant global variable's debug info.
451 void EmitGlobalVariable(const ValueDecl *VD, const APValue &Init);
453 /// Emit C++ using directive.
454 void EmitUsingDirective(const UsingDirectiveDecl &UD);
456 /// Emit the type explicitly casted to.
457 void EmitExplicitCastType(QualType Ty);
459 /// Emit C++ using declaration.
460 void EmitUsingDecl(const UsingDecl &UD);
462 /// Emit an @import declaration.
463 void EmitImportDecl(const ImportDecl &ID);
465 /// Emit C++ namespace alias.
466 llvm::DIImportedEntity *EmitNamespaceAlias(const NamespaceAliasDecl &NA);
468 /// Emit record type's standalone debug info.
469 llvm::DIType *getOrCreateRecordType(QualType Ty, SourceLocation L);
471 /// Emit an Objective-C interface type standalone debug info.
472 llvm::DIType *getOrCreateInterfaceType(QualType Ty, SourceLocation Loc);
474 /// Emit standalone debug info for a type.
475 llvm::DIType *getOrCreateStandaloneType(QualType Ty, SourceLocation Loc);
477 void completeType(const EnumDecl *ED);
478 void completeType(const RecordDecl *RD);
479 void completeRequiredType(const RecordDecl *RD);
480 void completeClassData(const RecordDecl *RD);
481 void completeClass(const RecordDecl *RD);
483 void completeTemplateDefinition(const ClassTemplateSpecializationDecl &SD);
484 void completeUnusedClass(const CXXRecordDecl &D);
486 /// Create debug info for a macro defined by a #define directive or a macro
487 /// undefined by a #undef directive.
488 llvm::DIMacro *CreateMacro(llvm::DIMacroFile *Parent, unsigned MType,
489 SourceLocation LineLoc, StringRef Name,
492 /// Create debug info for a file referenced by an #include directive.
493 llvm::DIMacroFile *CreateTempMacroFile(llvm::DIMacroFile *Parent,
494 SourceLocation LineLoc,
495 SourceLocation FileLoc);
498 /// Emit call to llvm.dbg.declare for a variable declaration.
499 /// Returns a pointer to the DILocalVariable associated with the
500 /// llvm.dbg.declare, or nullptr otherwise.
501 llvm::DILocalVariable *EmitDeclare(const VarDecl *decl, llvm::Value *AI,
502 llvm::Optional<unsigned> ArgNo,
503 CGBuilderTy &Builder);
505 struct BlockByRefType {
506 /// The wrapper struct used inside the __block_literal struct.
507 llvm::DIType *BlockByRefWrapper;
508 /// The type as it appears in the source code.
509 llvm::DIType *WrappedType;
512 /// Build up structure info for the byref. See \a BuildByRefType.
513 BlockByRefType EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
516 /// Get context info for the DeclContext of \p Decl.
517 llvm::DIScope *getDeclContextDescriptor(const Decl *D);
518 /// Get context info for a given DeclContext \p Decl.
519 llvm::DIScope *getContextDescriptor(const Decl *Context,
520 llvm::DIScope *Default);
522 llvm::DIScope *getCurrentContextDescriptor(const Decl *Decl);
524 /// Create a forward decl for a RecordType in a given context.
525 llvm::DICompositeType *getOrCreateRecordFwdDecl(const RecordType *,
528 /// Return current directory name.
529 StringRef getCurrentDirname();
531 /// Create new compile unit.
532 void CreateCompileUnit();
534 /// Compute the file checksum debug info for input file ID.
535 Optional<llvm::DIFile::ChecksumKind>
536 computeChecksum(FileID FID, SmallString<32> &Checksum) const;
538 /// Get the source of the given file ID.
539 Optional<StringRef> getSource(const SourceManager &SM, FileID FID);
541 /// Convenience function to get the file debug info descriptor for the input
543 llvm::DIFile *getOrCreateFile(SourceLocation Loc);
545 /// Create a file debug info descriptor for a source file.
547 createFile(StringRef FileName,
548 Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
549 Optional<StringRef> Source);
551 /// Get the type from the cache or create a new type if necessary.
552 llvm::DIType *getOrCreateType(QualType Ty, llvm::DIFile *Fg);
554 /// Get a reference to a clang module. If \p CreateSkeletonCU is true,
555 /// this also creates a split dwarf skeleton compile unit.
557 getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
558 bool CreateSkeletonCU);
560 /// DebugTypeExtRefs: If \p D originated in a clang module, return it.
561 llvm::DIModule *getParentModuleOrNull(const Decl *D);
563 /// Get the type from the cache or create a new partial type if
565 llvm::DICompositeType *getOrCreateLimitedType(const RecordType *Ty,
568 /// Create type metadata for a source language type.
569 llvm::DIType *CreateTypeNode(QualType Ty, llvm::DIFile *Fg);
571 /// Create new member and increase Offset by FType's size.
572 llvm::DIType *CreateMemberType(llvm::DIFile *Unit, QualType FType,
573 StringRef Name, uint64_t *Offset);
575 /// Retrieve the DIDescriptor, if any, for the canonical form of this
577 llvm::DINode *getDeclarationOrDefinition(const Decl *D);
579 /// \return debug info descriptor to describe method
580 /// declaration for the given method definition.
581 llvm::DISubprogram *getFunctionDeclaration(const Decl *D);
583 /// \return debug info descriptor to describe in-class static data
584 /// member declaration for the given out-of-class definition. If D
585 /// is an out-of-class definition of a static data member of a
586 /// class, find its corresponding in-class declaration.
587 llvm::DIDerivedType *
588 getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D);
590 /// Helper that either creates a forward declaration or a stub.
591 llvm::DISubprogram *getFunctionFwdDeclOrStub(GlobalDecl GD, bool Stub);
593 /// Create a subprogram describing the forward declaration
594 /// represented in the given FunctionDecl wrapped in a GlobalDecl.
595 llvm::DISubprogram *getFunctionForwardDeclaration(GlobalDecl GD);
597 /// Create a DISubprogram describing the function
598 /// represented in the given FunctionDecl wrapped in a GlobalDecl.
599 llvm::DISubprogram *getFunctionStub(GlobalDecl GD);
601 /// Create a global variable describing the forward declaration
602 /// represented in the given VarDecl.
603 llvm::DIGlobalVariable *
604 getGlobalVariableForwardDeclaration(const VarDecl *VD);
606 /// Return a global variable that represents one of the collection of global
607 /// variables created for an anonmyous union.
609 /// Recursively collect all of the member fields of a global
610 /// anonymous decl and create static variables for them. The first
611 /// time this is called it needs to be on a union and then from
612 /// there we can have additional unnamed fields.
613 llvm::DIGlobalVariableExpression *
614 CollectAnonRecordDecls(const RecordDecl *RD, llvm::DIFile *Unit,
615 unsigned LineNo, StringRef LinkageName,
616 llvm::GlobalVariable *Var, llvm::DIScope *DContext);
619 /// Return flags which enable debug info emission for call sites, provided
620 /// that it is supported and enabled.
621 llvm::DINode::DIFlags getCallSiteRelatedAttrs() const;
623 /// Get the printing policy for producing names for debug info.
624 PrintingPolicy getPrintingPolicy() const;
626 /// Get function name for the given FunctionDecl. If the name is
627 /// constructed on demand (e.g., C++ destructor) then the name is
628 /// stored on the side.
629 StringRef getFunctionName(const FunctionDecl *FD);
631 /// Returns the unmangled name of an Objective-C method.
632 /// This is the display name for the debugging info.
633 StringRef getObjCMethodName(const ObjCMethodDecl *FD);
635 /// Return selector name. This is used for debugging
637 StringRef getSelectorName(Selector S);
639 /// Get class name including template argument list.
640 StringRef getClassName(const RecordDecl *RD);
642 /// Get the vtable name for the given class.
643 StringRef getVTableName(const CXXRecordDecl *Decl);
645 /// Get line number for the location. If location is invalid
646 /// then use current location.
647 unsigned getLineNumber(SourceLocation Loc);
649 /// Get column number for the location. If location is
650 /// invalid then use current location.
651 /// \param Force Assume DebugColumnInfo option is true.
652 unsigned getColumnNumber(SourceLocation Loc, bool Force = false);
654 /// Collect various properties of a FunctionDecl.
655 /// \param GD A GlobalDecl whose getDecl() must return a FunctionDecl.
656 void collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
657 StringRef &Name, StringRef &LinkageName,
658 llvm::DIScope *&FDContext,
659 llvm::DINodeArray &TParamsArray,
660 llvm::DINode::DIFlags &Flags);
662 /// Collect various properties of a VarDecl.
663 void collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
664 unsigned &LineNo, QualType &T, StringRef &Name,
665 StringRef &LinkageName,
666 llvm::MDTuple *&TemplateParameters,
667 llvm::DIScope *&VDContext);
669 /// Allocate a copy of \p A using the DebugInfoNames allocator
670 /// and return a reference to it. If multiple arguments are given the strings
671 /// are concatenated.
672 StringRef internString(StringRef A, StringRef B = StringRef()) {
673 char *Data = DebugInfoNames.Allocate<char>(A.size() + B.size());
675 std::memcpy(Data, A.data(), A.size());
677 std::memcpy(Data + A.size(), B.data(), B.size());
678 return StringRef(Data, A.size() + B.size());
682 /// A scoped helper to set the current debug location to the specified
683 /// location or preferred location of the specified Expr.
684 class ApplyDebugLocation {
686 void init(SourceLocation TemporaryLocation, bool DefaultToEmpty = false);
687 ApplyDebugLocation(CodeGenFunction &CGF, bool DefaultToEmpty,
688 SourceLocation TemporaryLocation);
690 llvm::DebugLoc OriginalLocation;
691 CodeGenFunction *CGF;
694 /// Set the location to the (valid) TemporaryLocation.
695 ApplyDebugLocation(CodeGenFunction &CGF, SourceLocation TemporaryLocation);
696 ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E);
697 ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc);
698 ApplyDebugLocation(ApplyDebugLocation &&Other) : CGF(Other.CGF) {
702 ~ApplyDebugLocation();
704 /// Apply TemporaryLocation if it is valid. Otherwise switch
705 /// to an artificial debug location that has a valid scope, but no
706 /// line information.
708 /// Artificial locations are useful when emitting compiler-generated
709 /// helper functions that have no source location associated with
710 /// them. The DWARF specification allows the compiler to use the
711 /// special line number 0 to indicate code that can not be
712 /// attributed to any source location. Note that passing an empty
713 /// SourceLocation to CGDebugInfo::setLocation() will result in the
714 /// last valid location being reused.
715 static ApplyDebugLocation CreateArtificial(CodeGenFunction &CGF) {
716 return ApplyDebugLocation(CGF, false, SourceLocation());
718 /// Apply TemporaryLocation if it is valid. Otherwise switch
719 /// to an artificial debug location that has a valid scope, but no
720 /// line information.
721 static ApplyDebugLocation
722 CreateDefaultArtificial(CodeGenFunction &CGF,
723 SourceLocation TemporaryLocation) {
724 return ApplyDebugLocation(CGF, false, TemporaryLocation);
727 /// Set the IRBuilder to not attach debug locations. Note that
728 /// passing an empty SourceLocation to \a CGDebugInfo::setLocation()
729 /// will result in the last valid location being reused. Note that
730 /// all instructions that do not have a location at the beginning of
731 /// a function are counted towards to function prologue.
732 static ApplyDebugLocation CreateEmpty(CodeGenFunction &CGF) {
733 return ApplyDebugLocation(CGF, true, SourceLocation());
737 /// A scoped helper to set the current debug location to an inlined location.
738 class ApplyInlineDebugLocation {
739 SourceLocation SavedLocation;
740 CodeGenFunction *CGF;
743 /// Set up the CodeGenFunction's DebugInfo to produce inline locations for the
744 /// function \p InlinedFn. The current debug location becomes the inlined call
745 /// site of the inlined function.
746 ApplyInlineDebugLocation(CodeGenFunction &CGF, GlobalDecl InlinedFn);
747 /// Restore everything back to the original state.
748 ~ApplyInlineDebugLocation();
751 } // namespace CodeGen
754 #endif // LLVM_CLANG_LIB_CODEGEN_CGDEBUGINFO_H