DebugInfo.cpp File Reference

#include "llvm-c/DebugInfo.h"
#include "LLVMContextImpl.h"
#include "llvm/ADT/APSInt.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DIBuilder.h"
#include "llvm/IR/DebugInfo.h"
#include "llvm/IR/DebugInfoMetadata.h"
#include "llvm/IR/DebugLoc.h"
#include "llvm/IR/DebugProgramInstruction.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GVMaterializer.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Metadata.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/PassManager.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/TimeProfiler.h"
#include <algorithm>
#include <cassert>
#include <optional>
#include <utility>
#include "llvm/BinaryFormat/Dwarf.def"
#include "llvm/IR/Metadata.def"

Go to the source code of this file.

Macros
#define	HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR)
#define	HANDLE_METADATA_LEAF(CLASS)
#define	DEBUG_TYPE   "assignment-tracking"

Functions
template<bool DbgAssignAndValuesOnly>
static void	findDbgIntrinsics (Value *V, SmallVectorImpl< DbgVariableRecord * > &DbgVariableRecords)
static MDNode *	updateLoopMetadataDebugLocationsImpl (MDNode *OrigLoopID, function_ref< Metadata *(Metadata *)> Updater)
static bool	isDILocationReachable (SmallPtrSetImpl< Metadata * > &Visited, SmallPtrSetImpl< Metadata * > &Reachable, Metadata *MD)
	Return true if a node is a DILocation or if a DILocation is indirectly referenced by one of the node's children.
static bool	isAllDILocation (SmallPtrSetImpl< Metadata * > &Visited, SmallPtrSetImpl< Metadata * > &AllDILocation, const SmallPtrSetImpl< Metadata * > &DIReachable, Metadata *MD)
static Metadata *	stripLoopMDLoc (const SmallPtrSetImpl< Metadata * > &AllDILocation, const SmallPtrSetImpl< Metadata * > &DIReachable, Metadata *MD)
static MDNode *	stripDebugLocFromLoopID (MDNode *N)
static unsigned	map_from_llvmDWARFsourcelanguage (LLVMDWARFSourceLanguage lang)
template<typename DIT>
DIT *	unwrapDI (LLVMMetadataRef Ref)
static DINode::DIFlags	map_from_llvmDIFlags (LLVMDIFlags Flags)
static LLVMDIFlags	map_to_llvmDIFlags (DINode::DIFlags Flags)
static DISubprogram::DISPFlags	pack_into_DISPFlags (bool IsLocalToUnit, bool IsDefinition, bool IsOptimized)
unsigned	LLVMDebugMetadataVersion ()
	The current debug metadata version number.
LLVMDIBuilderRef	LLVMCreateDIBuilderDisallowUnresolved (LLVMModuleRef M)
	Construct a builder for a module, and do not allow for unresolved nodes attached to the module.
LLVMDIBuilderRef	LLVMCreateDIBuilder (LLVMModuleRef M)
	Construct a builder for a module and collect unresolved nodes attached to the module in order to resolve cycles during a call to LLVMDIBuilderFinalize.
unsigned	LLVMGetModuleDebugMetadataVersion (LLVMModuleRef M)
	The version of debug metadata that's present in the provided Module.
LLVMBool	LLVMStripModuleDebugInfo (LLVMModuleRef M)
	Strip debug info in the module if it exists.
void	LLVMDisposeDIBuilder (LLVMDIBuilderRef Builder)
	Deallocates the DIBuilder and everything it owns.
void	LLVMDIBuilderFinalize (LLVMDIBuilderRef Builder)
	Construct any deferred debug info descriptors.
void	LLVMDIBuilderFinalizeSubprogram (LLVMDIBuilderRef Builder, LLVMMetadataRef subprogram)
	Finalize a specific subprogram.
LLVMMetadataRef	LLVMDIBuilderCreateCompileUnit (LLVMDIBuilderRef Builder, LLVMDWARFSourceLanguage Lang, LLVMMetadataRef FileRef, const char *Producer, size_t ProducerLen, LLVMBool isOptimized, const char *Flags, size_t FlagsLen, unsigned RuntimeVer, const char *SplitName, size_t SplitNameLen, LLVMDWARFEmissionKind Kind, unsigned DWOId, LLVMBool SplitDebugInlining, LLVMBool DebugInfoForProfiling, const char *SysRoot, size_t SysRootLen, const char *SDK, size_t SDKLen)
	A CompileUnit provides an anchor for all debugging information generated during this instance of compilation.
LLVMMetadataRef	LLVMDIBuilderCreateFile (LLVMDIBuilderRef Builder, const char *Filename, size_t FilenameLen, const char *Directory, size_t DirectoryLen)
	Create a file descriptor to hold debugging information for a file.
LLVMMetadataRef	LLVMDIBuilderCreateModule (LLVMDIBuilderRef Builder, LLVMMetadataRef ParentScope, const char *Name, size_t NameLen, const char *ConfigMacros, size_t ConfigMacrosLen, const char *IncludePath, size_t IncludePathLen, const char *APINotesFile, size_t APINotesFileLen)
	Creates a new descriptor for a module with the specified parent scope.
LLVMMetadataRef	LLVMDIBuilderCreateNameSpace (LLVMDIBuilderRef Builder, LLVMMetadataRef ParentScope, const char *Name, size_t NameLen, LLVMBool ExportSymbols)
	Creates a new descriptor for a namespace with the specified parent scope.
LLVMMetadataRef	LLVMDIBuilderCreateFunction (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, const char *LinkageName, size_t LinkageNameLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty, LLVMBool IsLocalToUnit, LLVMBool IsDefinition, unsigned ScopeLine, LLVMDIFlags Flags, LLVMBool IsOptimized)
	Create a new descriptor for the specified subprogram.
LLVMMetadataRef	LLVMDIBuilderCreateLexicalBlock (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line, unsigned Col)
	Create a descriptor for a lexical block with the specified parent context.
LLVMMetadataRef	LLVMDIBuilderCreateLexicalBlockFile (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Discriminator)
	Create a descriptor for a lexical block with a new file attached.
LLVMMetadataRef	LLVMDIBuilderCreateImportedModuleFromNamespace (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef NS, LLVMMetadataRef File, unsigned Line)
	Create a descriptor for an imported namespace.
LLVMMetadataRef	LLVMDIBuilderCreateImportedModuleFromAlias (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef ImportedEntity, LLVMMetadataRef File, unsigned Line, LLVMMetadataRef *Elements, unsigned NumElements)
	Create a descriptor for an imported module that aliases another imported entity descriptor.
LLVMMetadataRef	LLVMDIBuilderCreateImportedModuleFromModule (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef M, LLVMMetadataRef File, unsigned Line, LLVMMetadataRef *Elements, unsigned NumElements)
	Create a descriptor for an imported module.
LLVMMetadataRef	LLVMDIBuilderCreateImportedDeclaration (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, LLVMMetadataRef Decl, LLVMMetadataRef File, unsigned Line, const char *Name, size_t NameLen, LLVMMetadataRef *Elements, unsigned NumElements)
	Create a descriptor for an imported function, type, or variable.
LLVMMetadataRef	LLVMDIBuilderCreateDebugLocation (LLVMContextRef Ctx, unsigned Line, unsigned Column, LLVMMetadataRef Scope, LLVMMetadataRef InlinedAt)
	Creates a new DebugLocation that describes a source location.
unsigned	LLVMDILocationGetLine (LLVMMetadataRef Location)
	Get the line number of this debug location.
unsigned	LLVMDILocationGetColumn (LLVMMetadataRef Location)
	Get the column number of this debug location.
LLVMMetadataRef	LLVMDILocationGetScope (LLVMMetadataRef Location)
	Get the local scope associated with this debug location.
LLVMMetadataRef	LLVMDILocationGetInlinedAt (LLVMMetadataRef Location)
	Get the "inline at" location associated with this debug location.
LLVMMetadataRef	LLVMDIScopeGetFile (LLVMMetadataRef Scope)
	Get the metadata of the file associated with a given scope.
const char *	LLVMDIFileGetDirectory (LLVMMetadataRef File, unsigned *Len)
	Get the directory of a given file.
const char *	LLVMDIFileGetFilename (LLVMMetadataRef File, unsigned *Len)
	Get the name of a given file.
const char *	LLVMDIFileGetSource (LLVMMetadataRef File, unsigned *Len)
	Get the source of a given file.
LLVMMetadataRef	LLVMDIBuilderCreateMacro (LLVMDIBuilderRef Builder, LLVMMetadataRef ParentMacroFile, unsigned Line, LLVMDWARFMacinfoRecordType RecordType, const char *Name, size_t NameLen, const char *Value, size_t ValueLen)
	Create debugging information entry for a macro.
LLVMMetadataRef	LLVMDIBuilderCreateTempMacroFile (LLVMDIBuilderRef Builder, LLVMMetadataRef ParentMacroFile, unsigned Line, LLVMMetadataRef File)
	Create debugging information temporary entry for a macro file.
LLVMMetadataRef	LLVMDIBuilderCreateEnumerator (LLVMDIBuilderRef Builder, const char *Name, size_t NameLen, int64_t Value, LLVMBool IsUnsigned)
	Create debugging information entry for an enumerator.
LLVMMetadataRef	LLVMDIBuilderCreateEnumeratorOfArbitraryPrecision (LLVMDIBuilderRef Builder, const char *Name, size_t NameLen, uint64_t SizeInBits, const uint64_t Words[], LLVMBool IsUnsigned)
	Create debugging information entry for an enumerator of arbitrary precision.
LLVMMetadataRef	LLVMDIBuilderCreateEnumerationType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits, uint32_t AlignInBits, LLVMMetadataRef *Elements, unsigned NumElements, LLVMMetadataRef ClassTy)
	Create debugging information entry for an enumeration.
LLVMMetadataRef	LLVMDIBuilderCreateSetType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits, uint32_t AlignInBits, LLVMMetadataRef BaseTy)
	Create debugging information entry for a set.
LLVMMetadataRef	LLVMDIBuilderCreateSubrangeType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, unsigned LineNo, LLVMMetadataRef File, uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags, LLVMMetadataRef BaseTy, LLVMMetadataRef LowerBound, LLVMMetadataRef UpperBound, LLVMMetadataRef Stride, LLVMMetadataRef Bias)
	Create a descriptor for a subrange with dynamic bounds.
PointerUnion< DIExpression *, DIVariable * >	unwrapExprVar (LLVMMetadataRef MD)
	MD may be nullptr, a DIExpression or DIVariable.
LLVMMetadataRef	LLVMDIBuilderCreateDynamicArrayType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, unsigned LineNo, LLVMMetadataRef File, uint64_t Size, uint32_t AlignInBits, LLVMMetadataRef Ty, LLVMMetadataRef *Subscripts, unsigned NumSubscripts, LLVMMetadataRef DataLocation, LLVMMetadataRef Associated, LLVMMetadataRef Allocated, LLVMMetadataRef Rank, LLVMMetadataRef BitStride)
	Create debugging information entry for a dynamic array.
void	LLVMReplaceArrays (LLVMDIBuilderRef Builder, LLVMMetadataRef *T, LLVMMetadataRef *Elements, unsigned NumElements)
	Replace arrays.
LLVMMetadataRef	LLVMDIBuilderCreateUnionType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags, LLVMMetadataRef *Elements, unsigned NumElements, unsigned RunTimeLang, const char *UniqueId, size_t UniqueIdLen)
	Create debugging information entry for a union.
LLVMMetadataRef	LLVMDIBuilderCreateArrayType (LLVMDIBuilderRef Builder, uint64_t Size, uint32_t AlignInBits, LLVMMetadataRef Ty, LLVMMetadataRef *Subscripts, unsigned NumSubscripts)
	Create debugging information entry for an array.
LLVMMetadataRef	LLVMDIBuilderCreateVectorType (LLVMDIBuilderRef Builder, uint64_t Size, uint32_t AlignInBits, LLVMMetadataRef Ty, LLVMMetadataRef *Subscripts, unsigned NumSubscripts)
	Create debugging information entry for a vector type.
LLVMMetadataRef	LLVMDIBuilderCreateBasicType (LLVMDIBuilderRef Builder, const char *Name, size_t NameLen, uint64_t SizeInBits, LLVMDWARFTypeEncoding Encoding, LLVMDIFlags Flags)
	Create debugging information entry for a basic type.
LLVMMetadataRef	LLVMDIBuilderCreatePointerType (LLVMDIBuilderRef Builder, LLVMMetadataRef PointeeTy, uint64_t SizeInBits, uint32_t AlignInBits, unsigned AddressSpace, const char *Name, size_t NameLen)
	Create debugging information entry for a pointer.
LLVMMetadataRef	LLVMDIBuilderCreateStructType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags, LLVMMetadataRef DerivedFrom, LLVMMetadataRef *Elements, unsigned NumElements, unsigned RunTimeLang, LLVMMetadataRef VTableHolder, const char *UniqueId, size_t UniqueIdLen)
	Create debugging information entry for a struct.
LLVMMetadataRef	LLVMDIBuilderCreateMemberType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags, LLVMMetadataRef Ty)
	Create debugging information entry for a member.
LLVMMetadataRef	LLVMDIBuilderCreateUnspecifiedType (LLVMDIBuilderRef Builder, const char *Name, size_t NameLen)
	Create a DWARF unspecified type.
LLVMMetadataRef	LLVMDIBuilderCreateStaticMemberType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, LLVMMetadataRef Type, LLVMDIFlags Flags, LLVMValueRef ConstantVal, uint32_t AlignInBits)
	Create debugging information entry for a C++ static data member.
LLVMMetadataRef	LLVMDIBuilderCreateObjCIVar (LLVMDIBuilderRef Builder, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags, LLVMMetadataRef Ty, LLVMMetadataRef PropertyNode)
	Create debugging information entry for Objective-C instance variable.
LLVMMetadataRef	LLVMDIBuilderCreateObjCProperty (LLVMDIBuilderRef Builder, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNo, const char *GetterName, size_t GetterNameLen, const char *SetterName, size_t SetterNameLen, unsigned PropertyAttributes, LLVMMetadataRef Ty)
	Create debugging information entry for Objective-C property.
LLVMMetadataRef	LLVMDIBuilderCreateObjectPointerType (LLVMDIBuilderRef Builder, LLVMMetadataRef Type, LLVMBool Implicit)
	Create a uniqued DIType* clone with FlagObjectPointer.
LLVMMetadataRef	LLVMDIBuilderCreateTypedef (LLVMDIBuilderRef Builder, LLVMMetadataRef Type, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Scope, uint32_t AlignInBits)
	Create debugging information entry for a typedef.
LLVMMetadataRef	LLVMDIBuilderCreateInheritance (LLVMDIBuilderRef Builder, LLVMMetadataRef Ty, LLVMMetadataRef BaseTy, uint64_t BaseOffset, uint32_t VBPtrOffset, LLVMDIFlags Flags)
	Create debugging information entry to establish inheritance relationship between two types.
LLVMMetadataRef	LLVMDIBuilderCreateForwardDecl (LLVMDIBuilderRef Builder, unsigned Tag, const char *Name, size_t NameLen, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line, unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits, const char *UniqueIdentifier, size_t UniqueIdentifierLen)
	Create a permanent forward-declared type.
LLVMMetadataRef	LLVMDIBuilderCreateReplaceableCompositeType (LLVMDIBuilderRef Builder, unsigned Tag, const char *Name, size_t NameLen, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line, unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags, const char *UniqueIdentifier, size_t UniqueIdentifierLen)
	Create a temporary forward-declared type.
LLVMMetadataRef	LLVMDIBuilderCreateQualifiedType (LLVMDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Type)
	Create debugging information entry for a qualified type, e.g.
LLVMMetadataRef	LLVMDIBuilderCreateReferenceType (LLVMDIBuilderRef Builder, unsigned Tag, LLVMMetadataRef Type)
	Create debugging information entry for a c++ style reference or rvalue reference type.
LLVMMetadataRef	LLVMDIBuilderCreateNullPtrType (LLVMDIBuilderRef Builder)
	Create C++11 nullptr type.
LLVMMetadataRef	LLVMDIBuilderCreateMemberPointerType (LLVMDIBuilderRef Builder, LLVMMetadataRef PointeeType, LLVMMetadataRef ClassType, uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags)
	Create debugging information entry for a pointer to member.
LLVMMetadataRef	LLVMDIBuilderCreateBitFieldMemberType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits, uint64_t OffsetInBits, uint64_t StorageOffsetInBits, LLVMDIFlags Flags, LLVMMetadataRef Type)
	Create debugging information entry for a bit field member.
LLVMMetadataRef	LLVMDIBuilderCreateClassType (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags, LLVMMetadataRef DerivedFrom, LLVMMetadataRef *Elements, unsigned NumElements, LLVMMetadataRef VTableHolder, LLVMMetadataRef TemplateParamsNode, const char *UniqueIdentifier, size_t UniqueIdentifierLen)
	Create debugging information entry for a class.
LLVMMetadataRef	LLVMDIBuilderCreateArtificialType (LLVMDIBuilderRef Builder, LLVMMetadataRef Type)
	Create a uniqued DIType* clone with FlagArtificial set.
uint16_t	LLVMGetDINodeTag (LLVMMetadataRef MD)
	Get the dwarf::Tag of a DINode.
const char *	LLVMDITypeGetName (LLVMMetadataRef DType, size_t *Length)
	Get the name of this DIType.
uint64_t	LLVMDITypeGetSizeInBits (LLVMMetadataRef DType)
	Get the size of this DIType in bits.
uint64_t	LLVMDITypeGetOffsetInBits (LLVMMetadataRef DType)
	Get the offset of this DIType in bits.
uint32_t	LLVMDITypeGetAlignInBits (LLVMMetadataRef DType)
	Get the alignment of this DIType in bits.
unsigned	LLVMDITypeGetLine (LLVMMetadataRef DType)
	Get the source line where this DIType is declared.
LLVMDIFlags	LLVMDITypeGetFlags (LLVMMetadataRef DType)
	Get the flags associated with this DIType.
LLVMMetadataRef	LLVMDIBuilderGetOrCreateTypeArray (LLVMDIBuilderRef Builder, LLVMMetadataRef *Types, size_t Length)
	Create a type array.
LLVMMetadataRef	LLVMDIBuilderCreateSubroutineType (LLVMDIBuilderRef Builder, LLVMMetadataRef File, LLVMMetadataRef *ParameterTypes, unsigned NumParameterTypes, LLVMDIFlags Flags)
	Create subroutine type.
LLVMMetadataRef	LLVMDIBuilderCreateExpression (LLVMDIBuilderRef Builder, uint64_t *Addr, size_t Length)
	Create a new descriptor for the specified variable which has a complex address expression for its address.
LLVMMetadataRef	LLVMDIBuilderCreateConstantValueExpression (LLVMDIBuilderRef Builder, uint64_t Value)
	Create a new descriptor for the specified variable that does not have an address, but does have a constant value.
LLVMMetadataRef	LLVMDIBuilderCreateGlobalVariableExpression (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, const char *Linkage, size_t LinkLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit, LLVMMetadataRef Expr, LLVMMetadataRef Decl, uint32_t AlignInBits)
	Create a new descriptor for the specified variable.
LLVMMetadataRef	LLVMDIGlobalVariableExpressionGetVariable (LLVMMetadataRef GVE)
	Retrieves the DIVariable associated with this global variable expression.
LLVMMetadataRef	LLVMDIGlobalVariableExpressionGetExpression (LLVMMetadataRef GVE)
	Retrieves the DIExpression associated with this global variable expression.
LLVMMetadataRef	LLVMDIVariableGetFile (LLVMMetadataRef Var)
	Get the metadata of the file associated with a given variable.
LLVMMetadataRef	LLVMDIVariableGetScope (LLVMMetadataRef Var)
	Get the metadata of the scope associated with a given variable.
unsigned	LLVMDIVariableGetLine (LLVMMetadataRef Var)
	Get the source line where this DIVariable is declared.
LLVMMetadataRef	LLVMTemporaryMDNode (LLVMContextRef Ctx, LLVMMetadataRef *Data, size_t Count)
	Create a new temporary MDNode.
void	LLVMDisposeTemporaryMDNode (LLVMMetadataRef TempNode)
	Deallocate a temporary node.
void	LLVMMetadataReplaceAllUsesWith (LLVMMetadataRef TargetMetadata, LLVMMetadataRef Replacement)
	Replace all uses of temporary metadata.
LLVMMetadataRef	LLVMDIBuilderCreateTempGlobalVariableFwdDecl (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, const char *Linkage, size_t LnkLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit, LLVMMetadataRef Decl, uint32_t AlignInBits)
	Create a new descriptor for the specified global variable that is temporary and meant to be RAUWed.
LLVMDbgRecordRef	LLVMDIBuilderInsertDeclareRecordBefore (LLVMDIBuilderRef Builder, LLVMValueRef Storage, LLVMMetadataRef VarInfo, LLVMMetadataRef Expr, LLVMMetadataRef DL, LLVMValueRef Instr)
	Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
LLVMDbgRecordRef	LLVMDIBuilderInsertDeclareRecordAtEnd (LLVMDIBuilderRef Builder, LLVMValueRef Storage, LLVMMetadataRef VarInfo, LLVMMetadataRef Expr, LLVMMetadataRef DL, LLVMBasicBlockRef Block)
	Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
LLVMDbgRecordRef	LLVMDIBuilderInsertDbgValueRecordBefore (LLVMDIBuilderRef Builder, LLVMValueRef Val, LLVMMetadataRef VarInfo, LLVMMetadataRef Expr, LLVMMetadataRef DebugLoc, LLVMValueRef Instr)
	Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
LLVMDbgRecordRef	LLVMDIBuilderInsertDbgValueRecordAtEnd (LLVMDIBuilderRef Builder, LLVMValueRef Val, LLVMMetadataRef VarInfo, LLVMMetadataRef Expr, LLVMMetadataRef DebugLoc, LLVMBasicBlockRef Block)
	Only use in "new debug format" (LLVMIsNewDbgInfoFormat() is true).
LLVMMetadataRef	LLVMDIBuilderCreateAutoVariable (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty, LLVMBool AlwaysPreserve, LLVMDIFlags Flags, uint32_t AlignInBits)
	Create a new descriptor for a local auto variable.
LLVMMetadataRef	LLVMDIBuilderCreateParameterVariable (LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name, size_t NameLen, unsigned ArgNo, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty, LLVMBool AlwaysPreserve, LLVMDIFlags Flags)
	Create a new descriptor for a function parameter variable.
LLVMMetadataRef	LLVMDIBuilderGetOrCreateSubrange (LLVMDIBuilderRef Builder, int64_t Lo, int64_t Count)
	Create a descriptor for a value range.
LLVMMetadataRef	LLVMDIBuilderGetOrCreateArray (LLVMDIBuilderRef Builder, LLVMMetadataRef *Data, size_t Length)
	Create an array of DI Nodes.
LLVMMetadataRef	LLVMGetSubprogram (LLVMValueRef Func)
	Get the metadata of the subprogram attached to a function.
void	LLVMSetSubprogram (LLVMValueRef Func, LLVMMetadataRef SP)
	Set the subprogram attached to a function.
unsigned	LLVMDISubprogramGetLine (LLVMMetadataRef Subprogram)
	Get the line associated with a given subprogram.
void	LLVMDISubprogramReplaceType (LLVMMetadataRef Subprogram, LLVMMetadataRef SubroutineType)
	Replace the subprogram subroutine type.
LLVMMetadataRef	LLVMInstructionGetDebugLoc (LLVMValueRef Inst)
	Get the debug location for the given instruction.
void	LLVMInstructionSetDebugLoc (LLVMValueRef Inst, LLVMMetadataRef Loc)
	Set the debug location for the given instruction.
LLVMMetadataRef	LLVMDIBuilderCreateLabel (LLVMDIBuilderRef Builder, LLVMMetadataRef Context, const char *Name, size_t NameLen, LLVMMetadataRef File, unsigned LineNo, LLVMBool AlwaysPreserve)
	Create a new descriptor for a label.
LLVMDbgRecordRef	LLVMDIBuilderInsertLabelBefore (LLVMDIBuilderRef Builder, LLVMMetadataRef LabelInfo, LLVMMetadataRef Location, LLVMValueRef InsertBefore)
	Insert a new llvm.dbg.label intrinsic call.
LLVMDbgRecordRef	LLVMDIBuilderInsertLabelAtEnd (LLVMDIBuilderRef Builder, LLVMMetadataRef LabelInfo, LLVMMetadataRef Location, LLVMBasicBlockRef InsertAtEnd)
	Insert a new llvm.dbg.label intrinsic call.
LLVMMetadataKind	LLVMGetMetadataKind (LLVMMetadataRef Metadata)
	Obtain the enumerated type of a Metadata instance.
static std::optional< AssignmentInfo >	getAssignmentInfoImpl (const DataLayout &DL, const Value *StoreDest, TypeSize SizeInBits)
	Collect constant properies (base, size, offset) of StoreDest.
static void	emitDbgAssign (AssignmentInfo Info, Value *Val, Value *Dest, Instruction &StoreLikeInst, const VarRecord &VarRec, DIBuilder &DIB)
	Returns nullptr if the assignment shouldn't be attributed to this variable.
static void	setAssignmentTrackingModuleFlag (Module &M)
static bool	getAssignmentTrackingModuleFlag (const Module &M)

Variables
static const char *	AssignmentTrackingModuleFlag

Macro Definition Documentation

DEBUG_TYPE

#define DEBUG_TYPE   "assignment-tracking"

Definition at line 2080 of file DebugInfo.cpp.

HANDLE_DW_LANG

#define HANDLE_DW_LANG	(		ID,
			NAME,
			LOWER_BOUND,
			VERSION,
			VENDOR )

Value:

  case LLVMDWARFSourceLanguage##NAME:                                          \
    return ID;

HANDLE_METADATA_LEAF

#define HANDLE_METADATA_LEAF

(

CLASS

)

Value:

  case Metadata::CLASS##Kind: \
    return (LLVMMetadataKind)LLVM##CLASS##MetadataKind;

Function Documentation

emitDbgAssign()

void emitDbgAssign ( AssignmentInfo Info, Value * Val, Value * Dest, Instruction & StoreLikeInst, const VarRecord & VarRec, DIBuilder & DIB )

static

Returns nullptr if the assignment shouldn't be attributed to this variable.

Definition at line 2034 of file DebugInfo.cpp.

References assert(), llvm::DIExpression::createFragmentExpression(), llvm::DbgVariableRecord::createLinkedDVRAssign(), llvm::at::VarRecord::DL, llvm::errs(), llvm::MDNode::get(), llvm::Value::getContext(), llvm::Instruction::getMetadata(), llvm::DIVariable::getSizeInBits(), Info, LLVM_DEBUG, Size, and llvm::at::VarRecord::Var.

Referenced by llvm::at::trackAssignments().

findDbgIntrinsics()

template<bool DbgAssignAndValuesOnly>

void findDbgIntrinsics ( Value * V, SmallVectorImpl< DbgVariableRecord * > & DbgVariableRecords )

static

Append users of MetadataAsValue(MD).

Definition at line 85 of file DebugInfo.cpp.

References llvm::cast(), llvm::dyn_cast(), llvm::DIArgList::getAllDbgVariableRecordUsers(), llvm::LocalAsMetadata::getIfExists(), llvm::SmallPtrSetImpl< PtrType >::insert(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by llvm::findDbgUsers(), and llvm::findDbgValues().

getAssignmentInfoImpl()

std::optional< AssignmentInfo > getAssignmentInfoImpl ( const DataLayout & DL, const Value * StoreDest, TypeSize SizeInBits )

static

Collect constant properies (base, size, offset) of StoreDest.

Return std::nullopt if any properties are not constants or the offset from the base pointer is negative.

Definition at line 1989 of file DebugInfo.cpp.

References llvm::sampleprof::Base, DL, llvm::dyn_cast(), llvm::APInt::getLimitedValue(), llvm::Value::getType(), llvm::APInt::isNegative(), llvm::details::FixedOrScalableQuantity< LeafTy, ValueTy >::isScalable(), llvm::Value::stripAndAccumulateConstantOffsets(), and UINT64_MAX.

Referenced by llvm::at::getAssignmentInfo(), llvm::at::getAssignmentInfo(), and llvm::at::getAssignmentInfo().

getAssignmentTrackingModuleFlag()

bool getAssignmentTrackingModuleFlag ( const Module & M )

static

Definition at line 2256 of file DebugInfo.cpp.

References AssignmentTrackingModuleFlag, and llvm::cast().

Referenced by llvm::isAssignmentTrackingEnabled().

isAllDILocation()

bool isAllDILocation ( SmallPtrSetImpl< Metadata * > & Visited, SmallPtrSetImpl< Metadata * > & AllDILocation, const SmallPtrSetImpl< Metadata * > & DIReachable, Metadata * MD )

static

Definition at line 434 of file DebugInfo.cpp.

References llvm::SmallPtrSetImpl< PtrType >::count(), llvm::dyn_cast_or_null(), llvm::SmallPtrSetImpl< PtrType >::insert(), llvm::isa(), isAllDILocation(), and N.

Referenced by isAllDILocation().

isDILocationReachable()

bool isDILocationReachable ( SmallPtrSetImpl< Metadata * > & Visited, SmallPtrSetImpl< Metadata * > & Reachable, Metadata * MD )

static

Return true if a node is a DILocation or if a DILocation is indirectly referenced by one of the node's children.

Definition at line 413 of file DebugInfo.cpp.

References llvm::dyn_cast_or_null(), llvm::SmallPtrSetImpl< PtrType >::insert(), llvm::isa(), isDILocationReachable(), and N.

Referenced by isDILocationReachable().

map_from_llvmDIFlags()

DINode::DIFlags map_from_llvmDIFlags ( LLVMDIFlags Flags )

static

Definition at line 992 of file DebugInfo.cpp.

Referenced by LLVMDIBuilderCreateAutoVariable(), LLVMDIBuilderCreateBasicType(), LLVMDIBuilderCreateBitFieldMemberType(), LLVMDIBuilderCreateClassType(), LLVMDIBuilderCreateFunction(), LLVMDIBuilderCreateInheritance(), LLVMDIBuilderCreateMemberPointerType(), LLVMDIBuilderCreateMemberType(), LLVMDIBuilderCreateObjCIVar(), LLVMDIBuilderCreateParameterVariable(), LLVMDIBuilderCreateReplaceableCompositeType(), LLVMDIBuilderCreateStaticMemberType(), LLVMDIBuilderCreateStructType(), LLVMDIBuilderCreateSubrangeType(), LLVMDIBuilderCreateSubroutineType(), and LLVMDIBuilderCreateUnionType().

map_from_llvmDWARFsourcelanguage()

unsigned map_from_llvmDWARFsourcelanguage ( LLVMDWARFSourceLanguage lang )

static

Definition at line 977 of file DebugInfo.cpp.

References llvm_unreachable.

Referenced by LLVMDIBuilderCreateCompileUnit().

map_to_llvmDIFlags()

LLVMDIFlags map_to_llvmDIFlags ( DINode::DIFlags Flags )

static

Definition at line 996 of file DebugInfo.cpp.

Referenced by LLVMDITypeGetFlags().

pack_into_DISPFlags()

DISubprogram::DISPFlags pack_into_DISPFlags ( bool IsLocalToUnit, bool IsDefinition, bool IsOptimized )

static

Definition at line 1001 of file DebugInfo.cpp.

References llvm::DISubprogram::toSPFlags().

Referenced by LLVMDIBuilderCreateFunction().

setAssignmentTrackingModuleFlag()

void setAssignmentTrackingModuleFlag ( Module & M )

static

Definition at line 2250 of file DebugInfo.cpp.

References AssignmentTrackingModuleFlag, llvm::ConstantAsMetadata::get(), llvm::Type::getInt1Ty(), and llvm::Module::Max.

Referenced by llvm::AssignmentTrackingPass::run(), and llvm::AssignmentTrackingPass::run().

stripDebugLocFromLoopID()

MDNode * stripDebugLocFromLoopID ( MDNode * N )

static

Definition at line 497 of file DebugInfo.cpp.

References llvm::all_of(), assert(), llvm::SmallPtrSetImplBase::clear(), llvm::count_if(), llvm::drop_begin(), llvm::SmallPtrSetImpl< PtrType >::insert(), N, stripLoopMDLoc(), and updateLoopMetadataDebugLocationsImpl().

Referenced by llvm::stripDebugInfo().

stripLoopMDLoc()

Metadata * stripLoopMDLoc ( const SmallPtrSetImpl< Metadata * > & AllDILocation, const SmallPtrSetImpl< Metadata * > & DIReachable, Metadata * MD )

static

Definition at line 460 of file DebugInfo.cpp.

References A(), assert(), llvm::SmallPtrSetImpl< PtrType >::count(), llvm::dyn_cast_or_null(), llvm::MDNode::get(), llvm::MDNode::getDistinct(), llvm::isa(), N, llvm::MDNode::replaceOperandWith(), and stripLoopMDLoc().

Referenced by stripDebugLocFromLoopID(), and stripLoopMDLoc().

unwrapDI()

template<typename DIT>

DIT * unwrapDI

(

LLVMMetadataRef

Ref

)

Definition at line 988 of file DebugInfo.cpp.

References llvm::Ref, and llvm::unwrap().

Referenced by LLVMDIBuilderCreateArrayType(), LLVMDIBuilderCreateArtificialType(), LLVMDIBuilderCreateBitFieldMemberType(), LLVMDIBuilderCreateClassType(), LLVMDIBuilderCreateCompileUnit(), LLVMDIBuilderCreateDynamicArrayType(), LLVMDIBuilderCreateEnumerationType(), LLVMDIBuilderCreateForwardDecl(), LLVMDIBuilderCreateFunction(), LLVMDIBuilderCreateGlobalVariableExpression(), LLVMDIBuilderCreateImportedDeclaration(), LLVMDIBuilderCreateImportedModuleFromAlias(), LLVMDIBuilderCreateImportedModuleFromModule(), LLVMDIBuilderCreateImportedModuleFromNamespace(), LLVMDIBuilderCreateInheritance(), LLVMDIBuilderCreateLabel(), LLVMDIBuilderCreateLexicalBlock(), LLVMDIBuilderCreateLexicalBlockFile(), LLVMDIBuilderCreateMacro(), LLVMDIBuilderCreateMemberPointerType(), LLVMDIBuilderCreateMemberType(), LLVMDIBuilderCreateModule(), LLVMDIBuilderCreateNameSpace(), LLVMDIBuilderCreateObjCIVar(), LLVMDIBuilderCreateObjCProperty(), LLVMDIBuilderCreateObjectPointerType(), LLVMDIBuilderCreatePointerType(), LLVMDIBuilderCreateQualifiedType(), LLVMDIBuilderCreateReferenceType(), LLVMDIBuilderCreateReplaceableCompositeType(), LLVMDIBuilderCreateSetType(), LLVMDIBuilderCreateStaticMemberType(), LLVMDIBuilderCreateStructType(), LLVMDIBuilderCreateSubrangeType(), LLVMDIBuilderCreateTempGlobalVariableFwdDecl(), LLVMDIBuilderCreateTempMacroFile(), LLVMDIBuilderCreateTypedef(), LLVMDIBuilderCreateUnionType(), LLVMDIBuilderCreateVectorType(), LLVMDIBuilderFinalizeSubprogram(), LLVMDIBuilderInsertLabelAtEnd(), LLVMDIBuilderInsertLabelBefore(), LLVMDIFileGetDirectory(), LLVMDIFileGetFilename(), LLVMDIFileGetSource(), LLVMDIGlobalVariableExpressionGetExpression(), LLVMDIGlobalVariableExpressionGetVariable(), LLVMDILocationGetColumn(), LLVMDILocationGetInlinedAt(), LLVMDILocationGetLine(), LLVMDILocationGetScope(), LLVMDIScopeGetFile(), LLVMDisposeTemporaryMDNode(), LLVMDISubprogramGetLine(), LLVMDISubprogramReplaceType(), LLVMDITypeGetAlignInBits(), LLVMDITypeGetFlags(), LLVMDITypeGetLine(), LLVMDITypeGetName(), LLVMDITypeGetOffsetInBits(), LLVMDITypeGetSizeInBits(), LLVMDIVariableGetFile(), LLVMDIVariableGetLine(), LLVMDIVariableGetScope(), LLVMGetDINodeTag(), LLVMMetadataReplaceAllUsesWith(), and unwrapExprVar().

unwrapExprVar()

PointerUnion< DIExpression *, DIVariable * > unwrapExprVar

(

LLVMMetadataRef

MD

)

MD may be nullptr, a DIExpression or DIVariable.

Definition at line 1292 of file DebugInfo.cpp.

References assert(), llvm::cast(), llvm::dyn_cast(), E(), llvm::isa(), and unwrapDI().

Referenced by LLVMDIBuilderCreateDynamicArrayType().

updateLoopMetadataDebugLocationsImpl()

MDNode * updateLoopMetadataDebugLocationsImpl ( MDNode * OrigLoopID, function_ref< Metadata *(Metadata *)> Updater )

static

Definition at line 378 of file DebugInfo.cpp.

References assert(), llvm::MDOperand::get(), llvm::MDNode::getContext(), llvm::MDNode::getDistinct(), llvm::MDNode::getNumOperands(), llvm::MDNode::getOperand(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::MDNode::replaceOperandWith().

Referenced by stripDebugLocFromLoopID(), and llvm::updateLoopMetadataDebugLocations().

Variable Documentation

AssignmentTrackingModuleFlag

const char* AssignmentTrackingModuleFlag

static

Initial value:

=
    "debug-info-assignment-tracking"

Definition at line 2247 of file DebugInfo.cpp.

Referenced by getAssignmentTrackingModuleFlag(), and setAssignmentTrackingModuleFlag().