mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2025-10-31 08:16:47 +00:00
1cacd28c3b
Remove the `DIArray` and `DITypeArray` typedefs, preferring the underlying types (`DebugNodeArray` and `MDTypeRefArray`, respectively). git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@235413 91177308-0d34-0410-b5e6-96231b3b80d8
862 lines
36 KiB
C++
862 lines
36 KiB
C++
//===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the DIBuilder.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/IR/DIBuilder.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
#include "llvm/IR/Constants.h"
|
|
#include "llvm/IR/DebugInfo.h"
|
|
#include "llvm/IR/IntrinsicInst.h"
|
|
#include "llvm/IR/Module.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "llvm/Support/Dwarf.h"
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::dwarf;
|
|
|
|
namespace {
|
|
class HeaderBuilder {
|
|
/// \brief Whether there are any fields yet.
|
|
///
|
|
/// Note that this is not equivalent to \c Chars.empty(), since \a concat()
|
|
/// may have been called already with an empty string.
|
|
bool IsEmpty;
|
|
SmallVector<char, 256> Chars;
|
|
|
|
public:
|
|
HeaderBuilder() : IsEmpty(true) {}
|
|
HeaderBuilder(const HeaderBuilder &X) : IsEmpty(X.IsEmpty), Chars(X.Chars) {}
|
|
HeaderBuilder(HeaderBuilder &&X)
|
|
: IsEmpty(X.IsEmpty), Chars(std::move(X.Chars)) {}
|
|
|
|
template <class Twineable> HeaderBuilder &concat(Twineable &&X) {
|
|
if (IsEmpty)
|
|
IsEmpty = false;
|
|
else
|
|
Chars.push_back(0);
|
|
Twine(X).toVector(Chars);
|
|
return *this;
|
|
}
|
|
|
|
MDString *get(LLVMContext &Context) const {
|
|
return MDString::get(Context, StringRef(Chars.begin(), Chars.size()));
|
|
}
|
|
|
|
static HeaderBuilder get(unsigned Tag) {
|
|
return HeaderBuilder().concat("0x" + Twine::utohexstr(Tag));
|
|
}
|
|
};
|
|
}
|
|
|
|
DIBuilder::DIBuilder(Module &m, bool AllowUnresolvedNodes)
|
|
: M(m), VMContext(M.getContext()), TempEnumTypes(nullptr),
|
|
TempRetainTypes(nullptr), TempSubprograms(nullptr), TempGVs(nullptr),
|
|
DeclareFn(nullptr), ValueFn(nullptr),
|
|
AllowUnresolvedNodes(AllowUnresolvedNodes) {}
|
|
|
|
void DIBuilder::trackIfUnresolved(MDNode *N) {
|
|
if (!N)
|
|
return;
|
|
if (N->isResolved())
|
|
return;
|
|
|
|
assert(AllowUnresolvedNodes && "Cannot handle unresolved nodes");
|
|
UnresolvedNodes.emplace_back(N);
|
|
}
|
|
|
|
void DIBuilder::finalize() {
|
|
TempEnumTypes->replaceAllUsesWith(MDTuple::get(VMContext, AllEnumTypes));
|
|
|
|
SmallVector<Metadata *, 16> RetainValues;
|
|
// Declarations and definitions of the same type may be retained. Some
|
|
// clients RAUW these pairs, leaving duplicates in the retained types
|
|
// list. Use a set to remove the duplicates while we transform the
|
|
// TrackingVHs back into Values.
|
|
SmallPtrSet<Metadata *, 16> RetainSet;
|
|
for (unsigned I = 0, E = AllRetainTypes.size(); I < E; I++)
|
|
if (RetainSet.insert(AllRetainTypes[I]).second)
|
|
RetainValues.push_back(AllRetainTypes[I]);
|
|
TempRetainTypes->replaceAllUsesWith(MDTuple::get(VMContext, RetainValues));
|
|
|
|
MDSubprogramArray SPs = MDTuple::get(VMContext, AllSubprograms);
|
|
TempSubprograms->replaceAllUsesWith(SPs.get());
|
|
for (auto *SP : SPs) {
|
|
if (MDTuple *Temp = SP->getVariables().get()) {
|
|
const auto &PV = PreservedVariables.lookup(SP);
|
|
SmallVector<Metadata *, 4> Variables(PV.begin(), PV.end());
|
|
DebugNodeArray AV = getOrCreateArray(Variables);
|
|
TempMDTuple(Temp)->replaceAllUsesWith(AV.get());
|
|
}
|
|
}
|
|
|
|
TempGVs->replaceAllUsesWith(MDTuple::get(VMContext, AllGVs));
|
|
|
|
TempImportedModules->replaceAllUsesWith(MDTuple::get(
|
|
VMContext, SmallVector<Metadata *, 16>(AllImportedModules.begin(),
|
|
AllImportedModules.end())));
|
|
|
|
// Now that all temp nodes have been replaced or deleted, resolve remaining
|
|
// cycles.
|
|
for (const auto &N : UnresolvedNodes)
|
|
if (N && !N->isResolved())
|
|
N->resolveCycles();
|
|
UnresolvedNodes.clear();
|
|
|
|
// Can't handle unresolved nodes anymore.
|
|
AllowUnresolvedNodes = false;
|
|
}
|
|
|
|
/// If N is compile unit return NULL otherwise return N.
|
|
static MDScope *getNonCompileUnitScope(MDScope *N) {
|
|
if (!N || isa<MDCompileUnit>(N))
|
|
return nullptr;
|
|
return cast<MDScope>(N);
|
|
}
|
|
|
|
MDCompileUnit *DIBuilder::createCompileUnit(
|
|
unsigned Lang, StringRef Filename, StringRef Directory, StringRef Producer,
|
|
bool isOptimized, StringRef Flags, unsigned RunTimeVer, StringRef SplitName,
|
|
DebugEmissionKind Kind, bool EmitDebugInfo) {
|
|
|
|
assert(((Lang <= dwarf::DW_LANG_Fortran08 && Lang >= dwarf::DW_LANG_C89) ||
|
|
(Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
|
|
"Invalid Language tag");
|
|
assert(!Filename.empty() &&
|
|
"Unable to create compile unit without filename");
|
|
|
|
// TODO: Once we make MDCompileUnit distinct, stop using temporaries here
|
|
// (just start with operands assigned to nullptr).
|
|
TempEnumTypes = MDTuple::getTemporary(VMContext, None);
|
|
TempRetainTypes = MDTuple::getTemporary(VMContext, None);
|
|
TempSubprograms = MDTuple::getTemporary(VMContext, None);
|
|
TempGVs = MDTuple::getTemporary(VMContext, None);
|
|
TempImportedModules = MDTuple::getTemporary(VMContext, None);
|
|
|
|
// TODO: Switch to getDistinct(). We never want to merge compile units based
|
|
// on contents.
|
|
MDCompileUnit *CUNode = MDCompileUnit::get(
|
|
VMContext, Lang, MDFile::get(VMContext, Filename, Directory), Producer,
|
|
isOptimized, Flags, RunTimeVer, SplitName, Kind, TempEnumTypes.get(),
|
|
TempRetainTypes.get(), TempSubprograms.get(), TempGVs.get(),
|
|
TempImportedModules.get());
|
|
|
|
// Create a named metadata so that it is easier to find cu in a module.
|
|
// Note that we only generate this when the caller wants to actually
|
|
// emit debug information. When we are only interested in tracking
|
|
// source line locations throughout the backend, we prevent codegen from
|
|
// emitting debug info in the final output by not generating llvm.dbg.cu.
|
|
if (EmitDebugInfo) {
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
|
|
NMD->addOperand(CUNode);
|
|
}
|
|
|
|
trackIfUnresolved(CUNode);
|
|
return CUNode;
|
|
}
|
|
|
|
static MDImportedEntity*
|
|
createImportedModule(LLVMContext &C, dwarf::Tag Tag, MDScope* Context,
|
|
Metadata *NS, unsigned Line, StringRef Name,
|
|
SmallVectorImpl<TrackingMDNodeRef> &AllImportedModules) {
|
|
auto *M =
|
|
MDImportedEntity::get(C, Tag, Context, DebugNodeRef(NS), Line, Name);
|
|
AllImportedModules.emplace_back(M);
|
|
return M;
|
|
}
|
|
|
|
MDImportedEntity* DIBuilder::createImportedModule(MDScope* Context,
|
|
MDNamespace* NS,
|
|
unsigned Line) {
|
|
return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
|
|
Context, NS, Line, StringRef(), AllImportedModules);
|
|
}
|
|
|
|
MDImportedEntity* DIBuilder::createImportedModule(MDScope* Context,
|
|
MDImportedEntity* NS,
|
|
unsigned Line) {
|
|
return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
|
|
Context, NS, Line, StringRef(), AllImportedModules);
|
|
}
|
|
|
|
MDImportedEntity *DIBuilder::createImportedDeclaration(MDScope *Context,
|
|
DebugNode *Decl,
|
|
unsigned Line,
|
|
StringRef Name) {
|
|
// Make sure to use the unique identifier based metadata reference for
|
|
// types that have one.
|
|
return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_declaration,
|
|
Context, DebugNodeRef::get(Decl), Line, Name,
|
|
AllImportedModules);
|
|
}
|
|
|
|
MDFile* DIBuilder::createFile(StringRef Filename, StringRef Directory) {
|
|
return MDFile::get(VMContext, Filename, Directory);
|
|
}
|
|
|
|
MDEnumerator *DIBuilder::createEnumerator(StringRef Name, int64_t Val) {
|
|
assert(!Name.empty() && "Unable to create enumerator without name");
|
|
return MDEnumerator::get(VMContext, Val, Name);
|
|
}
|
|
|
|
MDBasicType *DIBuilder::createUnspecifiedType(StringRef Name) {
|
|
assert(!Name.empty() && "Unable to create type without name");
|
|
return MDBasicType::get(VMContext, dwarf::DW_TAG_unspecified_type, Name);
|
|
}
|
|
|
|
MDBasicType *DIBuilder::createNullPtrType() {
|
|
return createUnspecifiedType("decltype(nullptr)");
|
|
}
|
|
|
|
MDBasicType *DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
unsigned Encoding) {
|
|
assert(!Name.empty() && "Unable to create type without name");
|
|
return MDBasicType::get(VMContext, dwarf::DW_TAG_base_type, Name, SizeInBits,
|
|
AlignInBits, Encoding);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createQualifiedType(unsigned Tag, MDType *FromTy) {
|
|
return MDDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr,
|
|
MDTypeRef::get(FromTy), 0, 0, 0, 0);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createPointerType(MDType *PointeeTy,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
StringRef Name) {
|
|
// FIXME: Why is there a name here?
|
|
return MDDerivedType::get(VMContext, dwarf::DW_TAG_pointer_type, Name,
|
|
nullptr, 0, nullptr, MDTypeRef::get(PointeeTy),
|
|
SizeInBits, AlignInBits, 0, 0);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createMemberPointerType(MDType *PointeeTy,
|
|
MDType *Base,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits) {
|
|
return MDDerivedType::get(VMContext, dwarf::DW_TAG_ptr_to_member_type, "",
|
|
nullptr, 0, nullptr, MDTypeRef::get(PointeeTy),
|
|
SizeInBits, AlignInBits, 0, 0, MDTypeRef::get(Base));
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createReferenceType(unsigned Tag, MDType *RTy) {
|
|
assert(RTy && "Unable to create reference type");
|
|
return MDDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr,
|
|
MDTypeRef::get(RTy), 0, 0, 0, 0);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createTypedef(MDType *Ty, StringRef Name,
|
|
MDFile *File, unsigned LineNo,
|
|
MDScope *Context) {
|
|
return MDDerivedType::get(VMContext, dwarf::DW_TAG_typedef, Name, File,
|
|
LineNo,
|
|
MDScopeRef::get(getNonCompileUnitScope(Context)),
|
|
MDTypeRef::get(Ty), 0, 0, 0, 0);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createFriend(MDType *Ty, MDType *FriendTy) {
|
|
assert(Ty && "Invalid type!");
|
|
assert(FriendTy && "Invalid friend type!");
|
|
return MDDerivedType::get(VMContext, dwarf::DW_TAG_friend, "", nullptr, 0,
|
|
MDTypeRef::get(Ty), MDTypeRef::get(FriendTy), 0, 0,
|
|
0, 0);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createInheritance(MDType *Ty, MDType *BaseTy,
|
|
uint64_t BaseOffset,
|
|
unsigned Flags) {
|
|
assert(Ty && "Unable to create inheritance");
|
|
return MDDerivedType::get(VMContext, dwarf::DW_TAG_inheritance, "", nullptr,
|
|
0, MDTypeRef::get(Ty), MDTypeRef::get(BaseTy), 0, 0,
|
|
BaseOffset, Flags);
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createMemberType(MDScope *Scope, StringRef Name,
|
|
MDFile *File, unsigned LineNumber,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
uint64_t OffsetInBits,
|
|
unsigned Flags, MDType *Ty) {
|
|
return MDDerivedType::get(
|
|
VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(Scope)), MDTypeRef::get(Ty),
|
|
SizeInBits, AlignInBits, OffsetInBits, Flags);
|
|
}
|
|
|
|
static ConstantAsMetadata *getConstantOrNull(Constant *C) {
|
|
if (C)
|
|
return ConstantAsMetadata::get(C);
|
|
return nullptr;
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createStaticMemberType(MDScope *Scope, StringRef Name,
|
|
MDFile *File,
|
|
unsigned LineNumber,
|
|
MDType *Ty, unsigned Flags,
|
|
llvm::Constant *Val) {
|
|
Flags |= DebugNode::FlagStaticMember;
|
|
return MDDerivedType::get(
|
|
VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(Scope)), MDTypeRef::get(Ty), 0, 0,
|
|
0, Flags, getConstantOrNull(Val));
|
|
}
|
|
|
|
MDDerivedType *DIBuilder::createObjCIVar(StringRef Name, MDFile *File,
|
|
unsigned LineNumber,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
uint64_t OffsetInBits, unsigned Flags,
|
|
MDType *Ty, MDNode *PropertyNode) {
|
|
return MDDerivedType::get(
|
|
VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(File)), MDTypeRef::get(Ty),
|
|
SizeInBits, AlignInBits, OffsetInBits, Flags, PropertyNode);
|
|
}
|
|
|
|
MDObjCProperty *
|
|
DIBuilder::createObjCProperty(StringRef Name, MDFile *File, unsigned LineNumber,
|
|
StringRef GetterName, StringRef SetterName,
|
|
unsigned PropertyAttributes, MDType *Ty) {
|
|
return MDObjCProperty::get(VMContext, Name, File, LineNumber, GetterName,
|
|
SetterName, PropertyAttributes, Ty);
|
|
}
|
|
|
|
MDTemplateTypeParameter *
|
|
DIBuilder::createTemplateTypeParameter(MDScope *Context, StringRef Name,
|
|
MDType *Ty) {
|
|
assert((!Context || isa<MDCompileUnit>(Context)) && "Expected compile unit");
|
|
return MDTemplateTypeParameter::get(VMContext, Name, MDTypeRef::get(Ty));
|
|
}
|
|
|
|
static MDTemplateValueParameter *
|
|
createTemplateValueParameterHelper(LLVMContext &VMContext, unsigned Tag,
|
|
MDScope *Context, StringRef Name, MDType *Ty,
|
|
Metadata *MD) {
|
|
assert((!Context || isa<MDCompileUnit>(Context)) && "Expected compile unit");
|
|
return MDTemplateValueParameter::get(VMContext, Tag, Name, MDTypeRef::get(Ty),
|
|
MD);
|
|
}
|
|
|
|
MDTemplateValueParameter *
|
|
DIBuilder::createTemplateValueParameter(MDScope *Context, StringRef Name,
|
|
MDType *Ty, Constant *Val) {
|
|
return createTemplateValueParameterHelper(
|
|
VMContext, dwarf::DW_TAG_template_value_parameter, Context, Name, Ty,
|
|
getConstantOrNull(Val));
|
|
}
|
|
|
|
MDTemplateValueParameter *
|
|
DIBuilder::createTemplateTemplateParameter(MDScope *Context, StringRef Name,
|
|
MDType *Ty, StringRef Val) {
|
|
return createTemplateValueParameterHelper(
|
|
VMContext, dwarf::DW_TAG_GNU_template_template_param, Context, Name, Ty,
|
|
MDString::get(VMContext, Val));
|
|
}
|
|
|
|
MDTemplateValueParameter *
|
|
DIBuilder::createTemplateParameterPack(MDScope *Context, StringRef Name,
|
|
MDType *Ty, DebugNodeArray Val) {
|
|
return createTemplateValueParameterHelper(
|
|
VMContext, dwarf::DW_TAG_GNU_template_parameter_pack, Context, Name, Ty,
|
|
Val.get());
|
|
}
|
|
|
|
MDCompositeType *DIBuilder::createClassType(
|
|
MDScope *Context, StringRef Name, MDFile *File, unsigned LineNumber,
|
|
uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
|
|
unsigned Flags, MDType *DerivedFrom, DebugNodeArray Elements,
|
|
MDType *VTableHolder, MDNode *TemplateParams, StringRef UniqueIdentifier) {
|
|
assert((!Context || isa<MDScope>(Context)) &&
|
|
"createClassType should be called with a valid Context");
|
|
|
|
auto *R = MDCompositeType::get(
|
|
VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(Context)),
|
|
MDTypeRef::get(DerivedFrom), SizeInBits, AlignInBits, OffsetInBits, Flags,
|
|
Elements, 0, MDTypeRef::get(VTableHolder),
|
|
cast_or_null<MDTuple>(TemplateParams), UniqueIdentifier);
|
|
if (!UniqueIdentifier.empty())
|
|
retainType(R);
|
|
trackIfUnresolved(R);
|
|
return R;
|
|
}
|
|
|
|
MDCompositeType *DIBuilder::createStructType(
|
|
MDScope *Context, StringRef Name, MDFile *File, unsigned LineNumber,
|
|
uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
|
|
MDType *DerivedFrom, DebugNodeArray Elements, unsigned RunTimeLang,
|
|
MDType *VTableHolder, StringRef UniqueIdentifier) {
|
|
auto *R = MDCompositeType::get(
|
|
VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(Context)),
|
|
MDTypeRef::get(DerivedFrom), SizeInBits, AlignInBits, 0, Flags, Elements,
|
|
RunTimeLang, MDTypeRef::get(VTableHolder), nullptr, UniqueIdentifier);
|
|
if (!UniqueIdentifier.empty())
|
|
retainType(R);
|
|
trackIfUnresolved(R);
|
|
return R;
|
|
}
|
|
|
|
MDCompositeType *DIBuilder::createUnionType(
|
|
MDScope *Scope, StringRef Name, MDFile *File, unsigned LineNumber,
|
|
uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
|
|
DebugNodeArray Elements, unsigned RunTimeLang, StringRef UniqueIdentifier) {
|
|
auto *R = MDCompositeType::get(
|
|
VMContext, dwarf::DW_TAG_union_type, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits,
|
|
AlignInBits, 0, Flags, Elements, RunTimeLang, nullptr, nullptr,
|
|
UniqueIdentifier);
|
|
if (!UniqueIdentifier.empty())
|
|
retainType(R);
|
|
trackIfUnresolved(R);
|
|
return R;
|
|
}
|
|
|
|
MDSubroutineType *DIBuilder::createSubroutineType(MDFile *File,
|
|
MDTypeRefArray ParameterTypes,
|
|
unsigned Flags) {
|
|
return MDSubroutineType::get(VMContext, Flags, ParameterTypes);
|
|
}
|
|
|
|
MDCompositeType *DIBuilder::createEnumerationType(
|
|
MDScope *Scope, StringRef Name, MDFile *File, unsigned LineNumber,
|
|
uint64_t SizeInBits, uint64_t AlignInBits, DebugNodeArray Elements,
|
|
MDType *UnderlyingType, StringRef UniqueIdentifier) {
|
|
auto *CTy = MDCompositeType::get(
|
|
VMContext, dwarf::DW_TAG_enumeration_type, Name, File, LineNumber,
|
|
MDScopeRef::get(getNonCompileUnitScope(Scope)),
|
|
MDTypeRef::get(UnderlyingType), SizeInBits, AlignInBits, 0, 0, Elements,
|
|
0, nullptr, nullptr, UniqueIdentifier);
|
|
AllEnumTypes.push_back(CTy);
|
|
if (!UniqueIdentifier.empty())
|
|
retainType(CTy);
|
|
trackIfUnresolved(CTy);
|
|
return CTy;
|
|
}
|
|
|
|
MDCompositeType *DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
|
|
MDType *Ty,
|
|
DebugNodeArray Subscripts) {
|
|
auto *R = MDCompositeType::get(VMContext, dwarf::DW_TAG_array_type, "",
|
|
nullptr, 0, nullptr, MDTypeRef::get(Ty), Size,
|
|
AlignInBits, 0, 0, Subscripts, 0, nullptr);
|
|
trackIfUnresolved(R);
|
|
return R;
|
|
}
|
|
|
|
MDCompositeType *DIBuilder::createVectorType(uint64_t Size,
|
|
uint64_t AlignInBits, MDType *Ty,
|
|
DebugNodeArray Subscripts) {
|
|
auto *R =
|
|
MDCompositeType::get(VMContext, dwarf::DW_TAG_array_type, "", nullptr, 0,
|
|
nullptr, MDTypeRef::get(Ty), Size, AlignInBits, 0,
|
|
DebugNode::FlagVector, Subscripts, 0, nullptr);
|
|
trackIfUnresolved(R);
|
|
return R;
|
|
}
|
|
|
|
static MDType *createTypeWithFlags(LLVMContext &Context, MDType *Ty,
|
|
unsigned FlagsToSet) {
|
|
auto NewTy = Ty->clone();
|
|
NewTy->setFlags(NewTy->getFlags() | FlagsToSet);
|
|
return MDNode::replaceWithUniqued(std::move(NewTy));
|
|
}
|
|
|
|
MDType *DIBuilder::createArtificialType(MDType *Ty) {
|
|
// FIXME: Restrict this to the nodes where it's valid.
|
|
if (Ty->isArtificial())
|
|
return Ty;
|
|
return createTypeWithFlags(VMContext, Ty, DebugNode::FlagArtificial);
|
|
}
|
|
|
|
MDType *DIBuilder::createObjectPointerType(MDType *Ty) {
|
|
// FIXME: Restrict this to the nodes where it's valid.
|
|
if (Ty->isObjectPointer())
|
|
return Ty;
|
|
unsigned Flags = DebugNode::FlagObjectPointer | DebugNode::FlagArtificial;
|
|
return createTypeWithFlags(VMContext, Ty, Flags);
|
|
}
|
|
|
|
void DIBuilder::retainType(MDType *T) {
|
|
assert(T && "Expected non-null type");
|
|
AllRetainTypes.emplace_back(T);
|
|
}
|
|
|
|
MDBasicType *DIBuilder::createUnspecifiedParameter() { return nullptr; }
|
|
|
|
MDCompositeType*
|
|
DIBuilder::createForwardDecl(unsigned Tag, StringRef Name, MDScope * Scope,
|
|
MDFile* F, unsigned Line, unsigned RuntimeLang,
|
|
uint64_t SizeInBits, uint64_t AlignInBits,
|
|
StringRef UniqueIdentifier) {
|
|
// FIXME: Define in terms of createReplaceableForwardDecl() by calling
|
|
// replaceWithUniqued().
|
|
auto *RetTy = MDCompositeType::get(
|
|
VMContext, Tag, Name, F, Line,
|
|
MDScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits,
|
|
AlignInBits, 0, DebugNode::FlagFwdDecl, nullptr, RuntimeLang, nullptr,
|
|
nullptr, UniqueIdentifier);
|
|
if (!UniqueIdentifier.empty())
|
|
retainType(RetTy);
|
|
trackIfUnresolved(RetTy);
|
|
return RetTy;
|
|
}
|
|
|
|
MDCompositeType* DIBuilder::createReplaceableCompositeType(
|
|
unsigned Tag, StringRef Name, MDScope * Scope, MDFile* F, unsigned Line,
|
|
unsigned RuntimeLang, uint64_t SizeInBits, uint64_t AlignInBits,
|
|
unsigned Flags, StringRef UniqueIdentifier) {
|
|
auto *RetTy = MDCompositeType::getTemporary(
|
|
VMContext, Tag, Name, F, Line,
|
|
MDScopeRef::get(getNonCompileUnitScope(Scope)), nullptr,
|
|
SizeInBits, AlignInBits, 0, Flags, nullptr, RuntimeLang,
|
|
nullptr, nullptr, UniqueIdentifier).release();
|
|
if (!UniqueIdentifier.empty())
|
|
retainType(RetTy);
|
|
trackIfUnresolved(RetTy);
|
|
return RetTy;
|
|
}
|
|
|
|
DebugNodeArray DIBuilder::getOrCreateArray(ArrayRef<Metadata *> Elements) {
|
|
return MDTuple::get(VMContext, Elements);
|
|
}
|
|
|
|
MDTypeRefArray DIBuilder::getOrCreateTypeArray(ArrayRef<Metadata *> Elements) {
|
|
SmallVector<llvm::Metadata *, 16> Elts;
|
|
for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
|
|
if (Elements[i] && isa<MDNode>(Elements[i]))
|
|
Elts.push_back(MDTypeRef::get(cast<MDType>(Elements[i])));
|
|
else
|
|
Elts.push_back(Elements[i]);
|
|
}
|
|
return MDTypeRefArray(MDNode::get(VMContext, Elts));
|
|
}
|
|
|
|
MDSubrange *DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
|
|
return MDSubrange::get(VMContext, Count, Lo);
|
|
}
|
|
|
|
static void checkGlobalVariableScope(MDScope * Context) {
|
|
#ifndef NDEBUG
|
|
if (auto *CT =
|
|
dyn_cast_or_null<MDCompositeType>(getNonCompileUnitScope(Context)))
|
|
assert(CT->getIdentifier().empty() &&
|
|
"Context of a global variable should not be a type with identifier");
|
|
#endif
|
|
}
|
|
|
|
MDGlobalVariable *DIBuilder::createGlobalVariable(
|
|
MDScope *Context, StringRef Name, StringRef LinkageName, MDFile *F,
|
|
unsigned LineNumber, MDType *Ty, bool isLocalToUnit, Constant *Val,
|
|
MDNode *Decl) {
|
|
checkGlobalVariableScope(Context);
|
|
|
|
auto *N = MDGlobalVariable::get(VMContext, cast_or_null<MDScope>(Context),
|
|
Name, LinkageName, F, LineNumber,
|
|
MDTypeRef::get(Ty), isLocalToUnit, true, Val,
|
|
cast_or_null<MDDerivedType>(Decl));
|
|
AllGVs.push_back(N);
|
|
return N;
|
|
}
|
|
|
|
MDGlobalVariable *DIBuilder::createTempGlobalVariableFwdDecl(
|
|
MDScope *Context, StringRef Name, StringRef LinkageName, MDFile *F,
|
|
unsigned LineNumber, MDType *Ty, bool isLocalToUnit, Constant *Val,
|
|
MDNode *Decl) {
|
|
checkGlobalVariableScope(Context);
|
|
|
|
return MDGlobalVariable::getTemporary(
|
|
VMContext, cast_or_null<MDScope>(Context), Name, LinkageName, F,
|
|
LineNumber, MDTypeRef::get(Ty), isLocalToUnit, false, Val,
|
|
cast_or_null<MDDerivedType>(Decl))
|
|
.release();
|
|
}
|
|
|
|
MDLocalVariable *DIBuilder::createLocalVariable(
|
|
unsigned Tag, MDScope *Scope, StringRef Name, MDFile *File, unsigned LineNo,
|
|
MDType *Ty, bool AlwaysPreserve, unsigned Flags, unsigned ArgNo) {
|
|
// FIXME: Why getNonCompileUnitScope()?
|
|
// FIXME: Why is "!Context" okay here?
|
|
// FIXME: WHy doesn't this check for a subprogram or lexical block (AFAICT
|
|
// the only valid scopes)?
|
|
MDScope* Context = getNonCompileUnitScope(Scope);
|
|
|
|
auto *Node = MDLocalVariable::get(
|
|
VMContext, Tag, cast_or_null<MDLocalScope>(Context), Name, File, LineNo,
|
|
MDTypeRef::get(Ty), ArgNo, Flags);
|
|
if (AlwaysPreserve) {
|
|
// The optimizer may remove local variable. If there is an interest
|
|
// to preserve variable info in such situation then stash it in a
|
|
// named mdnode.
|
|
MDSubprogram *Fn = getDISubprogram(Scope);
|
|
assert(Fn && "Missing subprogram for local variable");
|
|
PreservedVariables[Fn].emplace_back(Node);
|
|
}
|
|
return Node;
|
|
}
|
|
|
|
MDExpression* DIBuilder::createExpression(ArrayRef<uint64_t> Addr) {
|
|
return MDExpression::get(VMContext, Addr);
|
|
}
|
|
|
|
MDExpression* DIBuilder::createExpression(ArrayRef<int64_t> Signed) {
|
|
// TODO: Remove the callers of this signed version and delete.
|
|
SmallVector<uint64_t, 8> Addr(Signed.begin(), Signed.end());
|
|
return createExpression(Addr);
|
|
}
|
|
|
|
MDExpression* DIBuilder::createBitPieceExpression(unsigned OffsetInBytes,
|
|
unsigned SizeInBytes) {
|
|
uint64_t Addr[] = {dwarf::DW_OP_bit_piece, OffsetInBytes, SizeInBytes};
|
|
return MDExpression::get(VMContext, Addr);
|
|
}
|
|
|
|
MDSubprogram *DIBuilder::createFunction(MDScopeRef Context, StringRef Name,
|
|
StringRef LinkageName, MDFile *File,
|
|
unsigned LineNo, MDSubroutineType *Ty,
|
|
bool isLocalToUnit, bool isDefinition,
|
|
unsigned ScopeLine, unsigned Flags,
|
|
bool isOptimized, Function *Fn,
|
|
MDNode *TParams, MDNode *Decl) {
|
|
// dragonegg does not generate identifier for types, so using an empty map
|
|
// to resolve the context should be fine.
|
|
DITypeIdentifierMap EmptyMap;
|
|
return createFunction(Context.resolve(EmptyMap), Name, LinkageName, File,
|
|
LineNo, Ty, isLocalToUnit, isDefinition, ScopeLine,
|
|
Flags, isOptimized, Fn, TParams, Decl);
|
|
}
|
|
|
|
MDSubprogram* DIBuilder::createFunction(MDScope * Context, StringRef Name,
|
|
StringRef LinkageName, MDFile* File,
|
|
unsigned LineNo, MDSubroutineType* Ty,
|
|
bool isLocalToUnit, bool isDefinition,
|
|
unsigned ScopeLine, unsigned Flags,
|
|
bool isOptimized, Function *Fn,
|
|
MDNode *TParams, MDNode *Decl) {
|
|
assert(Ty->getTag() == dwarf::DW_TAG_subroutine_type &&
|
|
"function types should be subroutines");
|
|
auto *Node = MDSubprogram::get(
|
|
VMContext, MDScopeRef::get(getNonCompileUnitScope(Context)), Name,
|
|
LinkageName, File, LineNo, Ty,
|
|
isLocalToUnit, isDefinition, ScopeLine, nullptr, 0, 0, Flags, isOptimized,
|
|
Fn, cast_or_null<MDTuple>(TParams), cast_or_null<MDSubprogram>(Decl),
|
|
MDTuple::getTemporary(VMContext, None).release());
|
|
|
|
if (isDefinition)
|
|
AllSubprograms.push_back(Node);
|
|
trackIfUnresolved(Node);
|
|
return Node;
|
|
}
|
|
|
|
MDSubprogram*
|
|
DIBuilder::createTempFunctionFwdDecl(MDScope * Context, StringRef Name,
|
|
StringRef LinkageName, MDFile* File,
|
|
unsigned LineNo, MDSubroutineType* Ty,
|
|
bool isLocalToUnit, bool isDefinition,
|
|
unsigned ScopeLine, unsigned Flags,
|
|
bool isOptimized, Function *Fn,
|
|
MDNode *TParams, MDNode *Decl) {
|
|
return MDSubprogram::getTemporary(
|
|
VMContext, MDScopeRef::get(getNonCompileUnitScope(Context)), Name,
|
|
LinkageName, File, LineNo, Ty,
|
|
isLocalToUnit, isDefinition, ScopeLine, nullptr, 0, 0, Flags,
|
|
isOptimized, Fn, cast_or_null<MDTuple>(TParams),
|
|
cast_or_null<MDSubprogram>(Decl), nullptr).release();
|
|
}
|
|
|
|
MDSubprogram *
|
|
DIBuilder::createMethod(MDScope *Context, StringRef Name, StringRef LinkageName,
|
|
MDFile *F, unsigned LineNo, MDSubroutineType *Ty,
|
|
bool isLocalToUnit, bool isDefinition, unsigned VK,
|
|
unsigned VIndex, MDType *VTableHolder, unsigned Flags,
|
|
bool isOptimized, Function *Fn, MDNode *TParam) {
|
|
assert(Ty->getTag() == dwarf::DW_TAG_subroutine_type &&
|
|
"function types should be subroutines");
|
|
assert(getNonCompileUnitScope(Context) &&
|
|
"Methods should have both a Context and a context that isn't "
|
|
"the compile unit.");
|
|
// FIXME: Do we want to use different scope/lines?
|
|
auto *SP = MDSubprogram::get(
|
|
VMContext, MDScopeRef::get(cast<MDScope>(Context)), Name, LinkageName, F,
|
|
LineNo, Ty, isLocalToUnit, isDefinition, LineNo,
|
|
MDTypeRef::get(VTableHolder), VK, VIndex, Flags, isOptimized, Fn,
|
|
cast_or_null<MDTuple>(TParam), nullptr, nullptr);
|
|
|
|
if (isDefinition)
|
|
AllSubprograms.push_back(SP);
|
|
trackIfUnresolved(SP);
|
|
return SP;
|
|
}
|
|
|
|
MDNamespace* DIBuilder::createNameSpace(MDScope * Scope, StringRef Name,
|
|
MDFile* File, unsigned LineNo) {
|
|
return MDNamespace::get(VMContext, getNonCompileUnitScope(Scope), File, Name,
|
|
LineNo);
|
|
}
|
|
|
|
MDLexicalBlockFile* DIBuilder::createLexicalBlockFile(MDScope * Scope,
|
|
MDFile* File,
|
|
unsigned Discriminator) {
|
|
return MDLexicalBlockFile::get(VMContext, Scope, File, Discriminator);
|
|
}
|
|
|
|
MDLexicalBlock* DIBuilder::createLexicalBlock(MDScope * Scope, MDFile* File,
|
|
unsigned Line, unsigned Col) {
|
|
// Make these distinct, to avoid merging two lexical blocks on the same
|
|
// file/line/column.
|
|
return MDLexicalBlock::getDistinct(VMContext, getNonCompileUnitScope(Scope),
|
|
File, Line, Col);
|
|
}
|
|
|
|
static Value *getDbgIntrinsicValueImpl(LLVMContext &VMContext, Value *V) {
|
|
assert(V && "no value passed to dbg intrinsic");
|
|
return MetadataAsValue::get(VMContext, ValueAsMetadata::get(V));
|
|
}
|
|
|
|
static Instruction *withDebugLoc(Instruction *I, const MDLocation *DL) {
|
|
I->setDebugLoc(const_cast<MDLocation *>(DL));
|
|
return I;
|
|
}
|
|
|
|
Instruction *DIBuilder::insertDeclare(Value *Storage, MDLocalVariable* VarInfo,
|
|
MDExpression* Expr, const MDLocation *DL,
|
|
Instruction *InsertBefore) {
|
|
assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.declare");
|
|
assert(DL && "Expected debug loc");
|
|
assert(DL->getScope()->getSubprogram() ==
|
|
VarInfo->getScope()->getSubprogram() &&
|
|
"Expected matching subprograms");
|
|
if (!DeclareFn)
|
|
DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
|
|
|
|
trackIfUnresolved(VarInfo);
|
|
trackIfUnresolved(Expr);
|
|
Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage),
|
|
MetadataAsValue::get(VMContext, VarInfo),
|
|
MetadataAsValue::get(VMContext, Expr)};
|
|
return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertBefore), DL);
|
|
}
|
|
|
|
Instruction *DIBuilder::insertDeclare(Value *Storage, MDLocalVariable* VarInfo,
|
|
MDExpression* Expr, const MDLocation *DL,
|
|
BasicBlock *InsertAtEnd) {
|
|
assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.declare");
|
|
assert(DL && "Expected debug loc");
|
|
assert(DL->getScope()->getSubprogram() ==
|
|
VarInfo->getScope()->getSubprogram() &&
|
|
"Expected matching subprograms");
|
|
if (!DeclareFn)
|
|
DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
|
|
|
|
trackIfUnresolved(VarInfo);
|
|
trackIfUnresolved(Expr);
|
|
Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage),
|
|
MetadataAsValue::get(VMContext, VarInfo),
|
|
MetadataAsValue::get(VMContext, Expr)};
|
|
|
|
// If this block already has a terminator then insert this intrinsic
|
|
// before the terminator.
|
|
if (TerminatorInst *T = InsertAtEnd->getTerminator())
|
|
return withDebugLoc(CallInst::Create(DeclareFn, Args, "", T), DL);
|
|
return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertAtEnd), DL);
|
|
}
|
|
|
|
Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
|
|
MDLocalVariable* VarInfo,
|
|
MDExpression* Expr,
|
|
const MDLocation *DL,
|
|
Instruction *InsertBefore) {
|
|
assert(V && "no value passed to dbg.value");
|
|
assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.value");
|
|
assert(DL && "Expected debug loc");
|
|
assert(DL->getScope()->getSubprogram() ==
|
|
VarInfo->getScope()->getSubprogram() &&
|
|
"Expected matching subprograms");
|
|
if (!ValueFn)
|
|
ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
|
|
|
|
trackIfUnresolved(VarInfo);
|
|
trackIfUnresolved(Expr);
|
|
Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), Offset),
|
|
MetadataAsValue::get(VMContext, VarInfo),
|
|
MetadataAsValue::get(VMContext, Expr)};
|
|
return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertBefore), DL);
|
|
}
|
|
|
|
Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
|
|
MDLocalVariable* VarInfo,
|
|
MDExpression* Expr,
|
|
const MDLocation *DL,
|
|
BasicBlock *InsertAtEnd) {
|
|
assert(V && "no value passed to dbg.value");
|
|
assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.value");
|
|
assert(DL && "Expected debug loc");
|
|
assert(DL->getScope()->getSubprogram() ==
|
|
VarInfo->getScope()->getSubprogram() &&
|
|
"Expected matching subprograms");
|
|
if (!ValueFn)
|
|
ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
|
|
|
|
trackIfUnresolved(VarInfo);
|
|
trackIfUnresolved(Expr);
|
|
Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), Offset),
|
|
MetadataAsValue::get(VMContext, VarInfo),
|
|
MetadataAsValue::get(VMContext, Expr)};
|
|
|
|
return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertAtEnd), DL);
|
|
}
|
|
|
|
void DIBuilder::replaceVTableHolder(MDCompositeType* &T, MDCompositeType* VTableHolder) {
|
|
{
|
|
TypedTrackingMDRef<MDCompositeType> N(T);
|
|
N->replaceVTableHolder(MDTypeRef::get(VTableHolder));
|
|
T = N.get();
|
|
}
|
|
|
|
// If this didn't create a self-reference, just return.
|
|
if (T != VTableHolder)
|
|
return;
|
|
|
|
// Look for unresolved operands. T will drop RAUW support, orphaning any
|
|
// cycles underneath it.
|
|
if (T->isResolved())
|
|
for (const MDOperand &O : T->operands())
|
|
if (auto *N = dyn_cast_or_null<MDNode>(O))
|
|
trackIfUnresolved(N);
|
|
}
|
|
|
|
void DIBuilder::replaceArrays(MDCompositeType *&T, DebugNodeArray Elements,
|
|
DebugNodeArray TParams) {
|
|
{
|
|
TypedTrackingMDRef<MDCompositeType> N(T);
|
|
if (Elements)
|
|
N->replaceElements(Elements);
|
|
if (TParams)
|
|
N->replaceTemplateParams(MDTemplateParameterArray(TParams));
|
|
T = N.get();
|
|
}
|
|
|
|
// If T isn't resolved, there's no problem.
|
|
if (!T->isResolved())
|
|
return;
|
|
|
|
// If "T" is resolved, it may be due to a self-reference cycle. Track the
|
|
// arrays explicitly if they're unresolved, or else the cycles will be
|
|
// orphaned.
|
|
if (Elements)
|
|
trackIfUnresolved(Elements.get());
|
|
if (TParams)
|
|
trackIfUnresolved(TParams.get());
|
|
}
|