mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-08-26 07:29:55 +00:00
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121279 91177308-0d34-0410-b5e6-96231b3b80d8
1671 lines
54 KiB
C++
1671 lines
54 KiB
C++
//===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
|
|
//
|
|
// 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 helper classes used to build and interpret debug
|
|
// information in LLVM IR form.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Analysis/DebugInfo.h"
|
|
#include "llvm/Constants.h"
|
|
#include "llvm/DerivedTypes.h"
|
|
#include "llvm/Intrinsics.h"
|
|
#include "llvm/IntrinsicInst.h"
|
|
#include "llvm/Instructions.h"
|
|
#include "llvm/Module.h"
|
|
#include "llvm/Analysis/ValueTracking.h"
|
|
#include "llvm/ADT/SmallPtrSet.h"
|
|
#include "llvm/ADT/SmallString.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "llvm/Support/Dwarf.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
using namespace llvm;
|
|
using namespace llvm::dwarf;
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// DIDescriptor
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
|
|
}
|
|
|
|
DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
|
|
}
|
|
|
|
DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
|
|
}
|
|
|
|
DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
|
|
}
|
|
|
|
DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
|
|
}
|
|
|
|
StringRef
|
|
DIDescriptor::getStringField(unsigned Elt) const {
|
|
if (DbgNode == 0)
|
|
return StringRef();
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
|
if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
|
|
return MDS->getString();
|
|
|
|
return StringRef();
|
|
}
|
|
|
|
uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
|
|
if (DbgNode == 0)
|
|
return 0;
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
|
if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getOperand(Elt)))
|
|
return CI->getZExtValue();
|
|
|
|
return 0;
|
|
}
|
|
|
|
DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
|
|
if (DbgNode == 0)
|
|
return DIDescriptor();
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
|
return
|
|
DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
|
|
return DIDescriptor();
|
|
}
|
|
|
|
GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
|
|
if (DbgNode == 0)
|
|
return 0;
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
|
return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
|
|
return 0;
|
|
}
|
|
|
|
Constant *DIDescriptor::getConstantField(unsigned Elt) const {
|
|
if (DbgNode == 0)
|
|
return 0;
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
|
return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
|
|
return 0;
|
|
}
|
|
|
|
Function *DIDescriptor::getFunctionField(unsigned Elt) const {
|
|
if (DbgNode == 0)
|
|
return 0;
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
|
return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
|
|
return 0;
|
|
}
|
|
|
|
unsigned DIVariable::getNumAddrElements() const {
|
|
if (getVersion() <= llvm::LLVMDebugVersion8)
|
|
return DbgNode->getNumOperands()-6;
|
|
return DbgNode->getNumOperands()-7;
|
|
}
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Predicates
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// isBasicType - Return true if the specified tag is legal for
|
|
/// DIBasicType.
|
|
bool DIDescriptor::isBasicType() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_base_type;
|
|
}
|
|
|
|
/// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
|
|
bool DIDescriptor::isDerivedType() const {
|
|
if (!DbgNode) return false;
|
|
switch (getTag()) {
|
|
case dwarf::DW_TAG_typedef:
|
|
case dwarf::DW_TAG_pointer_type:
|
|
case dwarf::DW_TAG_reference_type:
|
|
case dwarf::DW_TAG_const_type:
|
|
case dwarf::DW_TAG_volatile_type:
|
|
case dwarf::DW_TAG_restrict_type:
|
|
case dwarf::DW_TAG_member:
|
|
case dwarf::DW_TAG_inheritance:
|
|
case dwarf::DW_TAG_friend:
|
|
return true;
|
|
default:
|
|
// CompositeTypes are currently modelled as DerivedTypes.
|
|
return isCompositeType();
|
|
}
|
|
}
|
|
|
|
/// isCompositeType - Return true if the specified tag is legal for
|
|
/// DICompositeType.
|
|
bool DIDescriptor::isCompositeType() const {
|
|
if (!DbgNode) return false;
|
|
switch (getTag()) {
|
|
case dwarf::DW_TAG_array_type:
|
|
case dwarf::DW_TAG_structure_type:
|
|
case dwarf::DW_TAG_union_type:
|
|
case dwarf::DW_TAG_enumeration_type:
|
|
case dwarf::DW_TAG_vector_type:
|
|
case dwarf::DW_TAG_subroutine_type:
|
|
case dwarf::DW_TAG_class_type:
|
|
return true;
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// isVariable - Return true if the specified tag is legal for DIVariable.
|
|
bool DIDescriptor::isVariable() const {
|
|
if (!DbgNode) return false;
|
|
switch (getTag()) {
|
|
case dwarf::DW_TAG_auto_variable:
|
|
case dwarf::DW_TAG_arg_variable:
|
|
case dwarf::DW_TAG_return_variable:
|
|
return true;
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// isType - Return true if the specified tag is legal for DIType.
|
|
bool DIDescriptor::isType() const {
|
|
return isBasicType() || isCompositeType() || isDerivedType();
|
|
}
|
|
|
|
/// isSubprogram - Return true if the specified tag is legal for
|
|
/// DISubprogram.
|
|
bool DIDescriptor::isSubprogram() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
|
|
}
|
|
|
|
/// isGlobalVariable - Return true if the specified tag is legal for
|
|
/// DIGlobalVariable.
|
|
bool DIDescriptor::isGlobalVariable() const {
|
|
return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
|
|
getTag() == dwarf::DW_TAG_constant);
|
|
}
|
|
|
|
/// isGlobal - Return true if the specified tag is legal for DIGlobal.
|
|
bool DIDescriptor::isGlobal() const {
|
|
return isGlobalVariable();
|
|
}
|
|
|
|
/// isUnspecifiedParmeter - Return true if the specified tab is
|
|
/// DW_TAG_unspecified_parameters.
|
|
bool DIDescriptor::isUnspecifiedParameter() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
|
|
}
|
|
|
|
/// isScope - Return true if the specified tag is one of the scope
|
|
/// related tag.
|
|
bool DIDescriptor::isScope() const {
|
|
if (!DbgNode) return false;
|
|
switch (getTag()) {
|
|
case dwarf::DW_TAG_compile_unit:
|
|
case dwarf::DW_TAG_lexical_block:
|
|
case dwarf::DW_TAG_subprogram:
|
|
case dwarf::DW_TAG_namespace:
|
|
return true;
|
|
default:
|
|
break;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
|
|
bool DIDescriptor::isCompileUnit() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
|
|
}
|
|
|
|
/// isFile - Return true if the specified tag is DW_TAG_file_type.
|
|
bool DIDescriptor::isFile() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_file_type;
|
|
}
|
|
|
|
/// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
|
|
bool DIDescriptor::isNameSpace() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_namespace;
|
|
}
|
|
|
|
/// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
|
|
bool DIDescriptor::isLexicalBlock() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_lexical_block;
|
|
}
|
|
|
|
/// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
|
|
bool DIDescriptor::isSubrange() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
|
|
}
|
|
|
|
/// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
|
|
bool DIDescriptor::isEnumerator() const {
|
|
return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Simple Descriptor Constructors and other Methods
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
DIType::DIType(const MDNode *N) : DIScope(N) {
|
|
if (!N) return;
|
|
if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
|
|
DbgNode = 0;
|
|
}
|
|
}
|
|
|
|
unsigned DIArray::getNumElements() const {
|
|
if (!DbgNode)
|
|
return 0;
|
|
return DbgNode->getNumOperands();
|
|
}
|
|
|
|
/// replaceAllUsesWith - Replace all uses of debug info referenced by
|
|
/// this descriptor.
|
|
void DIType::replaceAllUsesWith(DIDescriptor &D) {
|
|
if (!DbgNode)
|
|
return;
|
|
|
|
// Since we use a TrackingVH for the node, its easy for clients to manufacture
|
|
// legitimate situations where they want to replaceAllUsesWith() on something
|
|
// which, due to uniquing, has merged with the source. We shield clients from
|
|
// this detail by allowing a value to be replaced with replaceAllUsesWith()
|
|
// itself.
|
|
if (DbgNode != D) {
|
|
MDNode *Node = const_cast<MDNode*>(DbgNode);
|
|
const MDNode *DN = D;
|
|
const Value *V = cast_or_null<Value>(DN);
|
|
Node->replaceAllUsesWith(const_cast<Value*>(V));
|
|
MDNode::deleteTemporary(Node);
|
|
}
|
|
}
|
|
|
|
/// replaceAllUsesWith - Replace all uses of debug info referenced by
|
|
/// this descriptor.
|
|
void DIType::replaceAllUsesWith(MDNode *D) {
|
|
if (!DbgNode)
|
|
return;
|
|
|
|
// Since we use a TrackingVH for the node, its easy for clients to manufacture
|
|
// legitimate situations where they want to replaceAllUsesWith() on something
|
|
// which, due to uniquing, has merged with the source. We shield clients from
|
|
// this detail by allowing a value to be replaced with replaceAllUsesWith()
|
|
// itself.
|
|
if (DbgNode != D) {
|
|
MDNode *Node = const_cast<MDNode*>(DbgNode);
|
|
const MDNode *DN = D;
|
|
const Value *V = cast_or_null<Value>(DN);
|
|
Node->replaceAllUsesWith(const_cast<Value*>(V));
|
|
MDNode::deleteTemporary(Node);
|
|
}
|
|
}
|
|
|
|
/// Verify - Verify that a compile unit is well formed.
|
|
bool DICompileUnit::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
StringRef N = getFilename();
|
|
if (N.empty())
|
|
return false;
|
|
// It is possible that directory and produce string is empty.
|
|
return true;
|
|
}
|
|
|
|
/// Verify - Verify that a type descriptor is well formed.
|
|
bool DIType::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
if (!getContext().Verify())
|
|
return false;
|
|
unsigned Tag = getTag();
|
|
if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
|
|
Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
|
|
Tag != dwarf::DW_TAG_reference_type && Tag != dwarf::DW_TAG_restrict_type
|
|
&& Tag != dwarf::DW_TAG_vector_type && Tag != dwarf::DW_TAG_array_type
|
|
&& Tag != dwarf::DW_TAG_enumeration_type
|
|
&& getFilename().empty())
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
/// Verify - Verify that a basic type descriptor is well formed.
|
|
bool DIBasicType::Verify() const {
|
|
return isBasicType();
|
|
}
|
|
|
|
/// Verify - Verify that a derived type descriptor is well formed.
|
|
bool DIDerivedType::Verify() const {
|
|
return isDerivedType();
|
|
}
|
|
|
|
/// Verify - Verify that a composite type descriptor is well formed.
|
|
bool DICompositeType::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
if (!getContext().Verify())
|
|
return false;
|
|
|
|
DICompileUnit CU = getCompileUnit();
|
|
if (!CU.Verify())
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
/// Verify - Verify that a subprogram descriptor is well formed.
|
|
bool DISubprogram::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
|
|
if (!getContext().Verify())
|
|
return false;
|
|
|
|
DICompileUnit CU = getCompileUnit();
|
|
if (!CU.Verify())
|
|
return false;
|
|
|
|
DICompositeType Ty = getType();
|
|
if (!Ty.Verify())
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
/// Verify - Verify that a global variable descriptor is well formed.
|
|
bool DIGlobalVariable::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
|
|
if (getDisplayName().empty())
|
|
return false;
|
|
|
|
if (!getContext().Verify())
|
|
return false;
|
|
|
|
DICompileUnit CU = getCompileUnit();
|
|
if (!CU.Verify())
|
|
return false;
|
|
|
|
DIType Ty = getType();
|
|
if (!Ty.Verify())
|
|
return false;
|
|
|
|
if (!getGlobal() && !getConstant())
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
/// Verify - Verify that a variable descriptor is well formed.
|
|
bool DIVariable::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
|
|
if (!getContext().Verify())
|
|
return false;
|
|
|
|
if (!getCompileUnit().Verify())
|
|
return false;
|
|
|
|
DIType Ty = getType();
|
|
if (!Ty.Verify())
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
/// Verify - Verify that a location descriptor is well formed.
|
|
bool DILocation::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
|
|
return DbgNode->getNumOperands() == 4;
|
|
}
|
|
|
|
/// Verify - Verify that a namespace descriptor is well formed.
|
|
bool DINameSpace::Verify() const {
|
|
if (!DbgNode)
|
|
return false;
|
|
if (getName().empty())
|
|
return false;
|
|
if (!getCompileUnit().Verify())
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
/// getOriginalTypeSize - If this type is derived from a base type then
|
|
/// return base type size.
|
|
uint64_t DIDerivedType::getOriginalTypeSize() const {
|
|
unsigned Tag = getTag();
|
|
if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
|
|
Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
|
|
Tag == dwarf::DW_TAG_restrict_type) {
|
|
DIType BaseType = getTypeDerivedFrom();
|
|
// If this type is not derived from any type then take conservative
|
|
// approach.
|
|
if (!BaseType.isValid())
|
|
return getSizeInBits();
|
|
if (BaseType.isDerivedType())
|
|
return DIDerivedType(BaseType).getOriginalTypeSize();
|
|
else
|
|
return BaseType.getSizeInBits();
|
|
}
|
|
|
|
return getSizeInBits();
|
|
}
|
|
|
|
/// isInlinedFnArgument - Return true if this variable provides debugging
|
|
/// information for an inlined function arguments.
|
|
bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
|
|
assert(CurFn && "Invalid function");
|
|
if (!getContext().isSubprogram())
|
|
return false;
|
|
// This variable is not inlined function argument if its scope
|
|
// does not describe current function.
|
|
return !(DISubprogram(getContext()).describes(CurFn));
|
|
}
|
|
|
|
/// describes - Return true if this subprogram provides debugging
|
|
/// information for the function F.
|
|
bool DISubprogram::describes(const Function *F) {
|
|
assert(F && "Invalid function");
|
|
if (F == getFunction())
|
|
return true;
|
|
StringRef Name = getLinkageName();
|
|
if (Name.empty())
|
|
Name = getName();
|
|
if (F->getName() == Name)
|
|
return true;
|
|
return false;
|
|
}
|
|
|
|
unsigned DISubprogram::isOptimized() const {
|
|
assert (DbgNode && "Invalid subprogram descriptor!");
|
|
if (DbgNode->getNumOperands() == 16)
|
|
return getUnsignedField(15);
|
|
return 0;
|
|
}
|
|
|
|
StringRef DIScope::getFilename() const {
|
|
if (!DbgNode)
|
|
return StringRef();
|
|
if (isLexicalBlock())
|
|
return DILexicalBlock(DbgNode).getFilename();
|
|
if (isSubprogram())
|
|
return DISubprogram(DbgNode).getFilename();
|
|
if (isCompileUnit())
|
|
return DICompileUnit(DbgNode).getFilename();
|
|
if (isNameSpace())
|
|
return DINameSpace(DbgNode).getFilename();
|
|
if (isType())
|
|
return DIType(DbgNode).getFilename();
|
|
if (isFile())
|
|
return DIFile(DbgNode).getFilename();
|
|
assert(0 && "Invalid DIScope!");
|
|
return StringRef();
|
|
}
|
|
|
|
StringRef DIScope::getDirectory() const {
|
|
if (!DbgNode)
|
|
return StringRef();
|
|
if (isLexicalBlock())
|
|
return DILexicalBlock(DbgNode).getDirectory();
|
|
if (isSubprogram())
|
|
return DISubprogram(DbgNode).getDirectory();
|
|
if (isCompileUnit())
|
|
return DICompileUnit(DbgNode).getDirectory();
|
|
if (isNameSpace())
|
|
return DINameSpace(DbgNode).getDirectory();
|
|
if (isType())
|
|
return DIType(DbgNode).getDirectory();
|
|
if (isFile())
|
|
return DIFile(DbgNode).getDirectory();
|
|
assert(0 && "Invalid DIScope!");
|
|
return StringRef();
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// DIDescriptor: dump routines for all descriptors.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
/// print - Print descriptor.
|
|
void DIDescriptor::print(raw_ostream &OS) const {
|
|
OS << "[" << dwarf::TagString(getTag()) << "] ";
|
|
OS.write_hex((intptr_t) &*DbgNode) << ']';
|
|
}
|
|
|
|
/// print - Print compile unit.
|
|
void DICompileUnit::print(raw_ostream &OS) const {
|
|
if (getLanguage())
|
|
OS << " [" << dwarf::LanguageString(getLanguage()) << "] ";
|
|
|
|
OS << " [" << getDirectory() << "/" << getFilename() << "]";
|
|
}
|
|
|
|
/// print - Print type.
|
|
void DIType::print(raw_ostream &OS) const {
|
|
if (!DbgNode) return;
|
|
|
|
StringRef Res = getName();
|
|
if (!Res.empty())
|
|
OS << " [" << Res << "] ";
|
|
|
|
unsigned Tag = getTag();
|
|
OS << " [" << dwarf::TagString(Tag) << "] ";
|
|
|
|
// TODO : Print context
|
|
getCompileUnit().print(OS);
|
|
OS << " ["
|
|
<< "line " << getLineNumber() << ", "
|
|
<< getSizeInBits() << " bits, "
|
|
<< getAlignInBits() << " bit alignment, "
|
|
<< getOffsetInBits() << " bit offset"
|
|
<< "] ";
|
|
|
|
if (isPrivate())
|
|
OS << " [private] ";
|
|
else if (isProtected())
|
|
OS << " [protected] ";
|
|
|
|
if (isForwardDecl())
|
|
OS << " [fwd] ";
|
|
|
|
if (isBasicType())
|
|
DIBasicType(DbgNode).print(OS);
|
|
else if (isDerivedType())
|
|
DIDerivedType(DbgNode).print(OS);
|
|
else if (isCompositeType())
|
|
DICompositeType(DbgNode).print(OS);
|
|
else {
|
|
OS << "Invalid DIType\n";
|
|
return;
|
|
}
|
|
|
|
OS << "\n";
|
|
}
|
|
|
|
/// print - Print basic type.
|
|
void DIBasicType::print(raw_ostream &OS) const {
|
|
OS << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
|
|
}
|
|
|
|
/// print - Print derived type.
|
|
void DIDerivedType::print(raw_ostream &OS) const {
|
|
OS << "\n\t Derived From: "; getTypeDerivedFrom().print(OS);
|
|
}
|
|
|
|
/// print - Print composite type.
|
|
void DICompositeType::print(raw_ostream &OS) const {
|
|
DIArray A = getTypeArray();
|
|
OS << " [" << A.getNumElements() << " elements]";
|
|
}
|
|
|
|
/// print - Print subprogram.
|
|
void DISubprogram::print(raw_ostream &OS) const {
|
|
StringRef Res = getName();
|
|
if (!Res.empty())
|
|
OS << " [" << Res << "] ";
|
|
|
|
unsigned Tag = getTag();
|
|
OS << " [" << dwarf::TagString(Tag) << "] ";
|
|
|
|
// TODO : Print context
|
|
getCompileUnit().print(OS);
|
|
OS << " [" << getLineNumber() << "] ";
|
|
|
|
if (isLocalToUnit())
|
|
OS << " [local] ";
|
|
|
|
if (isDefinition())
|
|
OS << " [def] ";
|
|
|
|
OS << "\n";
|
|
}
|
|
|
|
/// print - Print global variable.
|
|
void DIGlobalVariable::print(raw_ostream &OS) const {
|
|
OS << " [";
|
|
StringRef Res = getName();
|
|
if (!Res.empty())
|
|
OS << " [" << Res << "] ";
|
|
|
|
unsigned Tag = getTag();
|
|
OS << " [" << dwarf::TagString(Tag) << "] ";
|
|
|
|
// TODO : Print context
|
|
getCompileUnit().print(OS);
|
|
OS << " [" << getLineNumber() << "] ";
|
|
|
|
if (isLocalToUnit())
|
|
OS << " [local] ";
|
|
|
|
if (isDefinition())
|
|
OS << " [def] ";
|
|
|
|
if (isGlobalVariable())
|
|
DIGlobalVariable(DbgNode).print(OS);
|
|
OS << "]\n";
|
|
}
|
|
|
|
/// print - Print variable.
|
|
void DIVariable::print(raw_ostream &OS) const {
|
|
StringRef Res = getName();
|
|
if (!Res.empty())
|
|
OS << " [" << Res << "] ";
|
|
|
|
getCompileUnit().print(OS);
|
|
OS << " [" << getLineNumber() << "] ";
|
|
getType().print(OS);
|
|
OS << "\n";
|
|
|
|
// FIXME: Dump complex addresses
|
|
}
|
|
|
|
/// dump - Print descriptor to dbgs() with a newline.
|
|
void DIDescriptor::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print compile unit to dbgs() with a newline.
|
|
void DICompileUnit::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print type to dbgs() with a newline.
|
|
void DIType::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print basic type to dbgs() with a newline.
|
|
void DIBasicType::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print derived type to dbgs() with a newline.
|
|
void DIDerivedType::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print composite type to dbgs() with a newline.
|
|
void DICompositeType::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print subprogram to dbgs() with a newline.
|
|
void DISubprogram::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print global variable.
|
|
void DIGlobalVariable::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
/// dump - Print variable.
|
|
void DIVariable::dump() const {
|
|
print(dbgs()); dbgs() << '\n';
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// DIFactory: Basic Helpers
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
DIFactory::DIFactory(Module &m)
|
|
: M(m), VMContext(M.getContext()), DeclareFn(0), ValueFn(0) {}
|
|
|
|
Constant *DIFactory::GetTagConstant(unsigned TAG) {
|
|
assert((TAG & LLVMDebugVersionMask) == 0 &&
|
|
"Tag too large for debug encoding!");
|
|
return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// DIFactory: Primary Constructors
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// GetOrCreateArray - Create an descriptor for an array of descriptors.
|
|
/// This implicitly uniques the arrays created.
|
|
DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
|
|
if (NumTys == 0) {
|
|
Value *Null = llvm::Constant::getNullValue(Type::getInt32Ty(VMContext));
|
|
return DIArray(MDNode::get(VMContext, &Null, 1));
|
|
}
|
|
|
|
SmallVector<Value *, 16> Elts(Tys, Tys+NumTys);
|
|
return DIArray(MDNode::get(VMContext, Elts.data(), Elts.size()));
|
|
}
|
|
|
|
/// GetOrCreateSubrange - Create a descriptor for a value range. This
|
|
/// implicitly uniques the values returned.
|
|
DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_subrange_type),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
|
|
};
|
|
|
|
return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
|
|
}
|
|
|
|
/// CreateUnspecifiedParameter - Create unspeicified type descriptor
|
|
/// for the subroutine type.
|
|
DIDescriptor DIFactory::CreateUnspecifiedParameter() {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_unspecified_parameters)
|
|
};
|
|
return DIDescriptor(MDNode::get(VMContext, &Elts[0], 1));
|
|
}
|
|
|
|
/// CreateCompileUnit - Create a new descriptor for the specified compile
|
|
/// unit. Note that this does not unique compile units within the module.
|
|
DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
|
|
StringRef Filename,
|
|
StringRef Directory,
|
|
StringRef Producer,
|
|
bool isMain,
|
|
bool isOptimized,
|
|
StringRef Flags,
|
|
unsigned RunTimeVer) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_compile_unit),
|
|
llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
|
|
MDString::get(VMContext, Filename),
|
|
MDString::get(VMContext, Directory),
|
|
MDString::get(VMContext, Producer),
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
|
|
MDString::get(VMContext, Flags),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
|
|
};
|
|
|
|
return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
|
|
}
|
|
|
|
/// CreateFile - Create a new descriptor for the specified file.
|
|
DIFile DIFactory::CreateFile(StringRef Filename,
|
|
StringRef Directory,
|
|
DICompileUnit CU) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_file_type),
|
|
MDString::get(VMContext, Filename),
|
|
MDString::get(VMContext, Directory),
|
|
CU
|
|
};
|
|
|
|
return DIFile(MDNode::get(VMContext, &Elts[0], 4));
|
|
}
|
|
|
|
/// CreateEnumerator - Create a single enumerator value.
|
|
DIEnumerator DIFactory::CreateEnumerator(StringRef Name, uint64_t Val){
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_enumerator),
|
|
MDString::get(VMContext, Name),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), Val)
|
|
};
|
|
return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
|
|
}
|
|
|
|
|
|
/// CreateBasicType - Create a basic type like int, float, etc.
|
|
DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNumber,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
uint64_t OffsetInBits, unsigned Flags,
|
|
unsigned Encoding) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_base_type),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
|
|
};
|
|
return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
|
|
}
|
|
|
|
|
|
/// CreateBasicType - Create a basic type like int, float, etc.
|
|
DIBasicType DIFactory::CreateBasicTypeEx(DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNumber,
|
|
Constant *SizeInBits,
|
|
Constant *AlignInBits,
|
|
Constant *OffsetInBits, unsigned Flags,
|
|
unsigned Encoding) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_base_type),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
|
|
SizeInBits,
|
|
AlignInBits,
|
|
OffsetInBits,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
|
|
};
|
|
return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
|
|
}
|
|
|
|
/// CreateArtificialType - Create a new DIType with "artificial" flag set.
|
|
DIType DIFactory::CreateArtificialType(DIType Ty) {
|
|
if (Ty.isArtificial())
|
|
return Ty;
|
|
|
|
SmallVector<Value *, 9> Elts;
|
|
MDNode *N = Ty;
|
|
assert (N && "Unexpected input DIType!");
|
|
for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
|
|
if (Value *V = N->getOperand(i))
|
|
Elts.push_back(V);
|
|
else
|
|
Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
|
|
}
|
|
|
|
unsigned CurFlags = Ty.getFlags();
|
|
CurFlags = CurFlags | DIType::FlagArtificial;
|
|
|
|
// Flags are stored at this slot.
|
|
Elts[8] = ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
|
|
|
|
return DIType(MDNode::get(VMContext, Elts.data(), Elts.size()));
|
|
}
|
|
|
|
/// CreateDerivedType - Create a derived type like const qualified type,
|
|
/// pointer, typedef, etc.
|
|
DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
|
|
DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNumber,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
uint64_t OffsetInBits,
|
|
unsigned Flags,
|
|
DIType DerivedFrom) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(Tag),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
DerivedFrom,
|
|
};
|
|
return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
|
|
}
|
|
|
|
|
|
/// CreateDerivedType - Create a derived type like const qualified type,
|
|
/// pointer, typedef, etc.
|
|
DIDerivedType DIFactory::CreateDerivedTypeEx(unsigned Tag,
|
|
DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNumber,
|
|
Constant *SizeInBits,
|
|
Constant *AlignInBits,
|
|
Constant *OffsetInBits,
|
|
unsigned Flags,
|
|
DIType DerivedFrom) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(Tag),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
|
|
SizeInBits,
|
|
AlignInBits,
|
|
OffsetInBits,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
DerivedFrom,
|
|
};
|
|
return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
|
|
}
|
|
|
|
|
|
/// CreateCompositeType - Create a composite type like array, struct, etc.
|
|
DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
|
|
DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNumber,
|
|
uint64_t SizeInBits,
|
|
uint64_t AlignInBits,
|
|
uint64_t OffsetInBits,
|
|
unsigned Flags,
|
|
DIType DerivedFrom,
|
|
DIArray Elements,
|
|
unsigned RuntimeLang,
|
|
MDNode *ContainingType) {
|
|
|
|
Value *Elts[] = {
|
|
GetTagConstant(Tag),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
|
|
ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
DerivedFrom,
|
|
Elements,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang),
|
|
ContainingType
|
|
};
|
|
|
|
MDNode *Node = MDNode::get(VMContext, &Elts[0], 13);
|
|
// Create a named metadata so that we do not lose this enum info.
|
|
if (Tag == dwarf::DW_TAG_enumeration_type) {
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.enum");
|
|
NMD->addOperand(Node);
|
|
}
|
|
return DICompositeType(Node);
|
|
}
|
|
|
|
/// CreateTemporaryType - Create a temporary forward-declared type.
|
|
DIType DIFactory::CreateTemporaryType() {
|
|
// Give the temporary MDNode a tag. It doesn't matter what tag we
|
|
// use here as long as DIType accepts it.
|
|
Value *Elts[] = {
|
|
GetTagConstant(DW_TAG_base_type)
|
|
};
|
|
MDNode *Node = MDNode::getTemporary(VMContext, Elts, array_lengthof(Elts));
|
|
return DIType(Node);
|
|
}
|
|
|
|
/// CreateTemporaryType - Create a temporary forward-declared type.
|
|
DIType DIFactory::CreateTemporaryType(DIFile F) {
|
|
// Give the temporary MDNode a tag. It doesn't matter what tag we
|
|
// use here as long as DIType accepts it.
|
|
Value *Elts[] = {
|
|
GetTagConstant(DW_TAG_base_type),
|
|
F.getCompileUnit(),
|
|
NULL,
|
|
F
|
|
};
|
|
MDNode *Node = MDNode::getTemporary(VMContext, Elts, array_lengthof(Elts));
|
|
return DIType(Node);
|
|
}
|
|
|
|
/// CreateCompositeType - Create a composite type like array, struct, etc.
|
|
DICompositeType DIFactory::CreateCompositeTypeEx(unsigned Tag,
|
|
DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNumber,
|
|
Constant *SizeInBits,
|
|
Constant *AlignInBits,
|
|
Constant *OffsetInBits,
|
|
unsigned Flags,
|
|
DIType DerivedFrom,
|
|
DIArray Elements,
|
|
unsigned RuntimeLang,
|
|
MDNode *ContainingType) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(Tag),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
|
|
SizeInBits,
|
|
AlignInBits,
|
|
OffsetInBits,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
DerivedFrom,
|
|
Elements,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang),
|
|
ContainingType
|
|
};
|
|
MDNode *Node = MDNode::get(VMContext, &Elts[0], 13);
|
|
// Create a named metadata so that we do not lose this enum info.
|
|
if (Tag == dwarf::DW_TAG_enumeration_type) {
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.enum");
|
|
NMD->addOperand(Node);
|
|
}
|
|
return DICompositeType(Node);
|
|
}
|
|
|
|
|
|
/// CreateSubprogram - Create a new descriptor for the specified subprogram.
|
|
/// See comments in DISubprogram for descriptions of these fields. This
|
|
/// method does not unique the generated descriptors.
|
|
DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
|
|
StringRef Name,
|
|
StringRef DisplayName,
|
|
StringRef LinkageName,
|
|
DIFile F,
|
|
unsigned LineNo, DIType Ty,
|
|
bool isLocalToUnit,
|
|
bool isDefinition,
|
|
unsigned VK, unsigned VIndex,
|
|
DIType ContainingType,
|
|
unsigned Flags,
|
|
bool isOptimized,
|
|
Function *Fn) {
|
|
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_subprogram),
|
|
llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
MDString::get(VMContext, DisplayName),
|
|
MDString::get(VMContext, LinkageName),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
|
|
Ty,
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
|
|
ContainingType,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
|
|
Fn
|
|
};
|
|
MDNode *Node = MDNode::get(VMContext, &Elts[0], 17);
|
|
|
|
// Create a named metadata so that we do not lose this mdnode.
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
|
|
NMD->addOperand(Node);
|
|
return DISubprogram(Node);
|
|
}
|
|
|
|
/// CreateSubprogramDefinition - Create new subprogram descriptor for the
|
|
/// given declaration.
|
|
DISubprogram DIFactory::CreateSubprogramDefinition(DISubprogram &SPDeclaration){
|
|
if (SPDeclaration.isDefinition())
|
|
return DISubprogram(SPDeclaration);
|
|
|
|
MDNode *DeclNode = SPDeclaration;
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_subprogram),
|
|
llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
|
|
DeclNode->getOperand(2), // Context
|
|
DeclNode->getOperand(3), // Name
|
|
DeclNode->getOperand(4), // DisplayName
|
|
DeclNode->getOperand(5), // LinkageName
|
|
DeclNode->getOperand(6), // CompileUnit
|
|
DeclNode->getOperand(7), // LineNo
|
|
DeclNode->getOperand(8), // Type
|
|
DeclNode->getOperand(9), // isLocalToUnit
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), true),
|
|
DeclNode->getOperand(11), // Virtuality
|
|
DeclNode->getOperand(12), // VIndex
|
|
DeclNode->getOperand(13), // Containting Type
|
|
DeclNode->getOperand(14), // Flags
|
|
DeclNode->getOperand(15), // isOptimized
|
|
SPDeclaration.getFunction()
|
|
};
|
|
MDNode *Node =MDNode::get(VMContext, &Elts[0], 16);
|
|
|
|
// Create a named metadata so that we do not lose this mdnode.
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
|
|
NMD->addOperand(Node);
|
|
return DISubprogram(Node);
|
|
}
|
|
|
|
/// CreateGlobalVariable - Create a new descriptor for the specified global.
|
|
DIGlobalVariable
|
|
DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
|
|
StringRef DisplayName,
|
|
StringRef LinkageName,
|
|
DIFile F,
|
|
unsigned LineNo, DIType Ty,bool isLocalToUnit,
|
|
bool isDefinition, llvm::GlobalVariable *Val) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_variable),
|
|
llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
MDString::get(VMContext, DisplayName),
|
|
MDString::get(VMContext, LinkageName),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
|
|
Ty,
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
|
|
Val
|
|
};
|
|
|
|
Value *const *Vs = &Elts[0];
|
|
MDNode *Node = MDNode::get(VMContext,Vs, 12);
|
|
|
|
// Create a named metadata so that we do not lose this mdnode.
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
|
|
NMD->addOperand(Node);
|
|
|
|
return DIGlobalVariable(Node);
|
|
}
|
|
|
|
/// CreateGlobalVariable - Create a new descriptor for the specified constant.
|
|
DIGlobalVariable
|
|
DIFactory::CreateGlobalVariable(DIDescriptor Context, StringRef Name,
|
|
StringRef DisplayName,
|
|
StringRef LinkageName,
|
|
DIFile F,
|
|
unsigned LineNo, DIType Ty,bool isLocalToUnit,
|
|
bool isDefinition, llvm::Constant *Val) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_variable),
|
|
llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
MDString::get(VMContext, DisplayName),
|
|
MDString::get(VMContext, LinkageName),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
|
|
Ty,
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
|
|
ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
|
|
Val
|
|
};
|
|
|
|
Value *const *Vs = &Elts[0];
|
|
MDNode *Node = MDNode::get(VMContext,Vs, 12);
|
|
|
|
// Create a named metadata so that we do not lose this mdnode.
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
|
|
NMD->addOperand(Node);
|
|
|
|
return DIGlobalVariable(Node);
|
|
}
|
|
|
|
/// fixupObjcLikeName - Replace contains special characters used
|
|
/// in a typical Objective-C names with '.' in a given string.
|
|
static void fixupObjcLikeName(std::string &Str) {
|
|
for (size_t i = 0, e = Str.size(); i < e; ++i) {
|
|
char C = Str[i];
|
|
if (C == '[' || C == ']' || C == ' ' || C == ':' || C == '+' ||
|
|
C == '(' || C == ')')
|
|
Str[i] = '.';
|
|
}
|
|
}
|
|
|
|
/// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
|
|
/// to hold function specific information.
|
|
NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, StringRef FuncName) {
|
|
SmallString<32> Out;
|
|
if (FuncName.find('[') == StringRef::npos)
|
|
return M.getOrInsertNamedMetadata(Twine("llvm.dbg.lv.", FuncName)
|
|
.toStringRef(Out));
|
|
std::string Name = FuncName;
|
|
fixupObjcLikeName(Name);
|
|
return M.getOrInsertNamedMetadata(Twine("llvm.dbg.lv.", Name)
|
|
.toStringRef(Out));
|
|
}
|
|
|
|
/// getFnSpecificMDNode - Return a NameMDNode, if available, that is
|
|
/// suitable to hold function specific information.
|
|
NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, StringRef FuncName) {
|
|
if (FuncName.find('[') == StringRef::npos)
|
|
return M.getNamedMetadata(Twine("llvm.dbg.lv.", FuncName));
|
|
std::string Name = FuncName;
|
|
fixupObjcLikeName(Name);
|
|
return M.getNamedMetadata(Twine("llvm.dbg.lv.", Name));
|
|
}
|
|
|
|
/// CreateVariable - Create a new descriptor for the specified variable.
|
|
DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
|
|
StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNo,
|
|
DIType Ty, bool AlwaysPreserve,
|
|
unsigned Flags) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(Tag),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
|
|
Ty,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Flags)
|
|
};
|
|
MDNode *Node = MDNode::get(VMContext, &Elts[0], 7);
|
|
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.
|
|
DISubprogram Fn(getDISubprogram(Context));
|
|
StringRef FName = "fn";
|
|
if (Fn.getFunction())
|
|
FName = Fn.getFunction()->getName();
|
|
char One = '\1';
|
|
if (FName.startswith(StringRef(&One, 1)))
|
|
FName = FName.substr(1);
|
|
|
|
|
|
NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, FName);
|
|
FnLocals->addOperand(Node);
|
|
}
|
|
return DIVariable(Node);
|
|
}
|
|
|
|
|
|
/// CreateComplexVariable - Create a new descriptor for the specified variable
|
|
/// which has a complex address expression for its address.
|
|
DIVariable DIFactory::CreateComplexVariable(unsigned Tag, DIDescriptor Context,
|
|
StringRef Name, DIFile F,
|
|
unsigned LineNo,
|
|
DIType Ty, Value *const *Addr,
|
|
unsigned NumAddr) {
|
|
SmallVector<Value *, 15> Elts;
|
|
Elts.push_back(GetTagConstant(Tag));
|
|
Elts.push_back(Context);
|
|
Elts.push_back(MDString::get(VMContext, Name));
|
|
Elts.push_back(F);
|
|
Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
|
|
Elts.push_back(Ty);
|
|
Elts.append(Addr, Addr+NumAddr);
|
|
|
|
return DIVariable(MDNode::get(VMContext, Elts.data(), Elts.size()));
|
|
}
|
|
|
|
|
|
/// CreateBlock - This creates a descriptor for a lexical block with the
|
|
/// specified parent VMContext.
|
|
DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context,
|
|
DIFile F, unsigned LineNo,
|
|
unsigned Col) {
|
|
// Defeat MDNode uniqing for lexical blocks.
|
|
static unsigned int unique_id = 0;
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_lexical_block),
|
|
Context,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), Col),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
|
|
};
|
|
return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 6));
|
|
}
|
|
|
|
/// CreateNameSpace - This creates new descriptor for a namespace
|
|
/// with the specified parent context.
|
|
DINameSpace DIFactory::CreateNameSpace(DIDescriptor Context, StringRef Name,
|
|
DIFile F,
|
|
unsigned LineNo) {
|
|
Value *Elts[] = {
|
|
GetTagConstant(dwarf::DW_TAG_namespace),
|
|
Context,
|
|
MDString::get(VMContext, Name),
|
|
F,
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
|
|
};
|
|
return DINameSpace(MDNode::get(VMContext, &Elts[0], 5));
|
|
}
|
|
|
|
/// CreateLocation - Creates a debug info location.
|
|
DILocation DIFactory::CreateLocation(unsigned LineNo, unsigned ColumnNo,
|
|
DIScope S, DILocation OrigLoc) {
|
|
Value *Elts[] = {
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
|
|
ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo),
|
|
S,
|
|
OrigLoc,
|
|
};
|
|
return DILocation(MDNode::get(VMContext, &Elts[0], 4));
|
|
}
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// DIFactory: Routines for inserting code into a function
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
|
|
Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
|
|
Instruction *InsertBefore) {
|
|
assert(Storage && "no storage passed to dbg.declare");
|
|
assert(D.Verify() && "empty DIVariable passed to dbg.declare");
|
|
if (!DeclareFn)
|
|
DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
|
|
|
|
Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
|
|
D };
|
|
return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
|
|
}
|
|
|
|
/// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
|
|
Instruction *DIFactory::InsertDeclare(Value *Storage, DIVariable D,
|
|
BasicBlock *InsertAtEnd) {
|
|
assert(Storage && "no storage passed to dbg.declare");
|
|
assert(D.Verify() && "invalid DIVariable passed to dbg.declare");
|
|
if (!DeclareFn)
|
|
DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
|
|
|
|
Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1),
|
|
D };
|
|
|
|
// If this block already has a terminator then insert this intrinsic
|
|
// before the terminator.
|
|
if (TerminatorInst *T = InsertAtEnd->getTerminator())
|
|
return CallInst::Create(DeclareFn, Args, Args+2, "", T);
|
|
else
|
|
return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);}
|
|
|
|
/// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
|
|
Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
|
|
DIVariable D,
|
|
Instruction *InsertBefore) {
|
|
assert(V && "no value passed to dbg.value");
|
|
assert(D.Verify() && "invalid DIVariable passed to dbg.value");
|
|
if (!ValueFn)
|
|
ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
|
|
|
|
Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
|
|
ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
|
|
D };
|
|
return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
|
|
}
|
|
|
|
/// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
|
|
Instruction *DIFactory::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
|
|
DIVariable D,
|
|
BasicBlock *InsertAtEnd) {
|
|
assert(V && "no value passed to dbg.value");
|
|
assert(D.Verify() && "invalid DIVariable passed to dbg.value");
|
|
if (!ValueFn)
|
|
ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
|
|
|
|
Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
|
|
ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
|
|
D };
|
|
return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
|
|
}
|
|
|
|
// RecordType - Record DIType in a module such that it is not lost even if
|
|
// it is not referenced through debug info anchors.
|
|
void DIFactory::RecordType(DIType T) {
|
|
NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.ty");
|
|
NMD->addOperand(T);
|
|
}
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// DebugInfoFinder implementations.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// processModule - Process entire module and collect debug info.
|
|
void DebugInfoFinder::processModule(Module &M) {
|
|
for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
|
|
for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
|
|
for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
|
|
++BI) {
|
|
if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
|
|
processDeclare(DDI);
|
|
|
|
DebugLoc Loc = BI->getDebugLoc();
|
|
if (Loc.isUnknown())
|
|
continue;
|
|
|
|
LLVMContext &Ctx = BI->getContext();
|
|
DIDescriptor Scope(Loc.getScope(Ctx));
|
|
|
|
if (Scope.isCompileUnit())
|
|
addCompileUnit(DICompileUnit(Scope));
|
|
else if (Scope.isSubprogram())
|
|
processSubprogram(DISubprogram(Scope));
|
|
else if (Scope.isLexicalBlock())
|
|
processLexicalBlock(DILexicalBlock(Scope));
|
|
|
|
if (MDNode *IA = Loc.getInlinedAt(Ctx))
|
|
processLocation(DILocation(IA));
|
|
}
|
|
|
|
if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv")) {
|
|
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
|
|
DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
|
|
if (addGlobalVariable(DIG)) {
|
|
addCompileUnit(DIG.getCompileUnit());
|
|
processType(DIG.getType());
|
|
}
|
|
}
|
|
}
|
|
|
|
if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.sp"))
|
|
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
|
|
processSubprogram(DISubprogram(NMD->getOperand(i)));
|
|
}
|
|
|
|
/// processLocation - Process DILocation.
|
|
void DebugInfoFinder::processLocation(DILocation Loc) {
|
|
if (!Loc.Verify()) return;
|
|
DIDescriptor S(Loc.getScope());
|
|
if (S.isCompileUnit())
|
|
addCompileUnit(DICompileUnit(S));
|
|
else if (S.isSubprogram())
|
|
processSubprogram(DISubprogram(S));
|
|
else if (S.isLexicalBlock())
|
|
processLexicalBlock(DILexicalBlock(S));
|
|
processLocation(Loc.getOrigLocation());
|
|
}
|
|
|
|
/// processType - Process DIType.
|
|
void DebugInfoFinder::processType(DIType DT) {
|
|
if (!addType(DT))
|
|
return;
|
|
|
|
addCompileUnit(DT.getCompileUnit());
|
|
if (DT.isCompositeType()) {
|
|
DICompositeType DCT(DT);
|
|
processType(DCT.getTypeDerivedFrom());
|
|
DIArray DA = DCT.getTypeArray();
|
|
for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
|
|
DIDescriptor D = DA.getElement(i);
|
|
if (D.isType())
|
|
processType(DIType(D));
|
|
else if (D.isSubprogram())
|
|
processSubprogram(DISubprogram(D));
|
|
}
|
|
} else if (DT.isDerivedType()) {
|
|
DIDerivedType DDT(DT);
|
|
processType(DDT.getTypeDerivedFrom());
|
|
}
|
|
}
|
|
|
|
/// processLexicalBlock
|
|
void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
|
|
DIScope Context = LB.getContext();
|
|
if (Context.isLexicalBlock())
|
|
return processLexicalBlock(DILexicalBlock(Context));
|
|
else
|
|
return processSubprogram(DISubprogram(Context));
|
|
}
|
|
|
|
/// processSubprogram - Process DISubprogram.
|
|
void DebugInfoFinder::processSubprogram(DISubprogram SP) {
|
|
if (!addSubprogram(SP))
|
|
return;
|
|
addCompileUnit(SP.getCompileUnit());
|
|
processType(SP.getType());
|
|
}
|
|
|
|
/// processDeclare - Process DbgDeclareInst.
|
|
void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
|
|
MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
|
|
if (!N) return;
|
|
|
|
DIDescriptor DV(N);
|
|
if (!DV.isVariable())
|
|
return;
|
|
|
|
if (!NodesSeen.insert(DV))
|
|
return;
|
|
|
|
addCompileUnit(DIVariable(N).getCompileUnit());
|
|
processType(DIVariable(N).getType());
|
|
}
|
|
|
|
/// addType - Add type into Tys.
|
|
bool DebugInfoFinder::addType(DIType DT) {
|
|
if (!DT.isValid())
|
|
return false;
|
|
|
|
if (!NodesSeen.insert(DT))
|
|
return false;
|
|
|
|
TYs.push_back(DT);
|
|
return true;
|
|
}
|
|
|
|
/// addCompileUnit - Add compile unit into CUs.
|
|
bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
|
|
if (!CU.Verify())
|
|
return false;
|
|
|
|
if (!NodesSeen.insert(CU))
|
|
return false;
|
|
|
|
CUs.push_back(CU);
|
|
return true;
|
|
}
|
|
|
|
/// addGlobalVariable - Add global variable into GVs.
|
|
bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
|
|
if (!DIDescriptor(DIG).isGlobalVariable())
|
|
return false;
|
|
|
|
if (!NodesSeen.insert(DIG))
|
|
return false;
|
|
|
|
GVs.push_back(DIG);
|
|
return true;
|
|
}
|
|
|
|
// addSubprogram - Add subprgoram into SPs.
|
|
bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
|
|
if (!DIDescriptor(SP).isSubprogram())
|
|
return false;
|
|
|
|
if (!NodesSeen.insert(SP))
|
|
return false;
|
|
|
|
SPs.push_back(SP);
|
|
return true;
|
|
}
|
|
|
|
/// Find the debug info descriptor corresponding to this global variable.
|
|
static Value *findDbgGlobalDeclare(GlobalVariable *V) {
|
|
const Module *M = V->getParent();
|
|
NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
|
|
if (!NMD)
|
|
return 0;
|
|
|
|
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
|
|
DIDescriptor DIG(cast<MDNode>(NMD->getOperand(i)));
|
|
if (!DIG.isGlobalVariable())
|
|
continue;
|
|
if (DIGlobalVariable(DIG).getGlobal() == V)
|
|
return DIG;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
|
|
/// It looks through pointer casts too.
|
|
static const DbgDeclareInst *findDbgDeclare(const Value *V) {
|
|
V = V->stripPointerCasts();
|
|
|
|
if (!isa<Instruction>(V) && !isa<Argument>(V))
|
|
return 0;
|
|
|
|
const Function *F = NULL;
|
|
if (const Instruction *I = dyn_cast<Instruction>(V))
|
|
F = I->getParent()->getParent();
|
|
else if (const Argument *A = dyn_cast<Argument>(V))
|
|
F = A->getParent();
|
|
|
|
for (Function::const_iterator FI = F->begin(), FE = F->end(); FI != FE; ++FI)
|
|
for (BasicBlock::const_iterator BI = (*FI).begin(), BE = (*FI).end();
|
|
BI != BE; ++BI)
|
|
if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
|
|
if (DDI->getAddress() == V)
|
|
return DDI;
|
|
|
|
return 0;
|
|
}
|
|
|
|
bool llvm::getLocationInfo(const Value *V, std::string &DisplayName,
|
|
std::string &Type, unsigned &LineNo,
|
|
std::string &File, std::string &Dir) {
|
|
DICompileUnit Unit;
|
|
DIType TypeD;
|
|
|
|
if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
|
|
Value *DIGV = findDbgGlobalDeclare(GV);
|
|
if (!DIGV) return false;
|
|
DIGlobalVariable Var(cast<MDNode>(DIGV));
|
|
|
|
StringRef D = Var.getDisplayName();
|
|
if (!D.empty())
|
|
DisplayName = D;
|
|
LineNo = Var.getLineNumber();
|
|
Unit = Var.getCompileUnit();
|
|
TypeD = Var.getType();
|
|
} else {
|
|
const DbgDeclareInst *DDI = findDbgDeclare(V);
|
|
if (!DDI) return false;
|
|
DIVariable Var(cast<MDNode>(DDI->getVariable()));
|
|
|
|
StringRef D = Var.getName();
|
|
if (!D.empty())
|
|
DisplayName = D;
|
|
LineNo = Var.getLineNumber();
|
|
Unit = Var.getCompileUnit();
|
|
TypeD = Var.getType();
|
|
}
|
|
|
|
StringRef T = TypeD.getName();
|
|
if (!T.empty())
|
|
Type = T;
|
|
StringRef F = Unit.getFilename();
|
|
if (!F.empty())
|
|
File = F;
|
|
StringRef D = Unit.getDirectory();
|
|
if (!D.empty())
|
|
Dir = D;
|
|
return true;
|
|
}
|
|
|
|
/// getDISubprogram - Find subprogram that is enclosing this scope.
|
|
DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
|
|
DIDescriptor D(Scope);
|
|
if (D.isSubprogram())
|
|
return DISubprogram(Scope);
|
|
|
|
if (D.isLexicalBlock())
|
|
return getDISubprogram(DILexicalBlock(Scope).getContext());
|
|
|
|
return DISubprogram();
|
|
}
|
|
|
|
/// getDICompositeType - Find underlying composite type.
|
|
DICompositeType llvm::getDICompositeType(DIType T) {
|
|
if (T.isCompositeType())
|
|
return DICompositeType(T);
|
|
|
|
if (T.isDerivedType())
|
|
return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
|
|
|
|
return DICompositeType();
|
|
}
|