2013-11-08 08:13:15 +00:00
|
|
|
//===--- 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.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2014-03-06 00:46:21 +00:00
|
|
|
#include "llvm/IR/DebugInfo.h"
|
2014-03-04 10:07:28 +00:00
|
|
|
#include "LLVMContextImpl.h"
|
2013-11-08 08:13:15 +00:00
|
|
|
#include "llvm/ADT/STLExtras.h"
|
|
|
|
#include "llvm/ADT/SmallPtrSet.h"
|
|
|
|
#include "llvm/ADT/SmallString.h"
|
2015-02-21 00:43:09 +00:00
|
|
|
#include "llvm/ADT/StringSwitch.h"
|
2013-11-08 08:13:15 +00:00
|
|
|
#include "llvm/Analysis/ValueTracking.h"
|
|
|
|
#include "llvm/IR/Constants.h"
|
2014-08-01 22:11:58 +00:00
|
|
|
#include "llvm/IR/DIBuilder.h"
|
2013-11-08 08:13:15 +00:00
|
|
|
#include "llvm/IR/DerivedTypes.h"
|
|
|
|
#include "llvm/IR/Instructions.h"
|
|
|
|
#include "llvm/IR/IntrinsicInst.h"
|
|
|
|
#include "llvm/IR/Intrinsics.h"
|
2015-03-30 21:36:43 +00:00
|
|
|
#include "llvm/IR/GVMaterializer.h"
|
2013-11-08 08:13:15 +00:00
|
|
|
#include "llvm/IR/Module.h"
|
2014-03-04 11:17:44 +00:00
|
|
|
#include "llvm/IR/ValueHandle.h"
|
2013-11-08 08:13:15 +00:00
|
|
|
#include "llvm/Support/Debug.h"
|
|
|
|
#include "llvm/Support/Dwarf.h"
|
|
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
using namespace llvm;
|
|
|
|
using namespace llvm::dwarf;
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// DIDescriptor
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2015-02-21 00:43:09 +00:00
|
|
|
unsigned DIDescriptor::getFlag(StringRef Flag) {
|
|
|
|
return StringSwitch<unsigned>(Flag)
|
|
|
|
#define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
|
|
|
|
#include "llvm/IR/DebugInfoFlags.def"
|
|
|
|
.Default(0);
|
|
|
|
}
|
|
|
|
|
|
|
|
const char *DIDescriptor::getFlagString(unsigned Flag) {
|
|
|
|
switch (Flag) {
|
|
|
|
default:
|
|
|
|
return "";
|
|
|
|
#define HANDLE_DI_FLAG(ID, NAME) \
|
|
|
|
case Flag##NAME: \
|
|
|
|
return "DIFlag" #NAME;
|
|
|
|
#include "llvm/IR/DebugInfoFlags.def"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-02-21 00:45:26 +00:00
|
|
|
unsigned DIDescriptor::splitFlags(unsigned Flags,
|
|
|
|
SmallVectorImpl<unsigned> &SplitFlags) {
|
|
|
|
// Accessibility flags need to be specially handled, since they're packed
|
|
|
|
// together.
|
|
|
|
if (unsigned A = Flags & FlagAccessibility) {
|
|
|
|
if (A == FlagPrivate)
|
|
|
|
SplitFlags.push_back(FlagPrivate);
|
|
|
|
else if (A == FlagProtected)
|
|
|
|
SplitFlags.push_back(FlagProtected);
|
|
|
|
else
|
|
|
|
SplitFlags.push_back(FlagPublic);
|
|
|
|
Flags &= ~A;
|
|
|
|
}
|
|
|
|
|
|
|
|
#define HANDLE_DI_FLAG(ID, NAME) \
|
|
|
|
if (unsigned Bit = Flags & ID) { \
|
|
|
|
SplitFlags.push_back(Bit); \
|
|
|
|
Flags &= ~Bit; \
|
|
|
|
}
|
|
|
|
#include "llvm/IR/DebugInfoFlags.def"
|
|
|
|
|
|
|
|
return Flags;
|
|
|
|
}
|
|
|
|
|
2013-11-08 08:13:15 +00:00
|
|
|
bool DIDescriptor::Verify() const {
|
|
|
|
return DbgNode &&
|
|
|
|
(DIDerivedType(DbgNode).Verify() ||
|
|
|
|
DICompositeType(DbgNode).Verify() || DIBasicType(DbgNode).Verify() ||
|
|
|
|
DIVariable(DbgNode).Verify() || DISubprogram(DbgNode).Verify() ||
|
|
|
|
DIGlobalVariable(DbgNode).Verify() || DIFile(DbgNode).Verify() ||
|
|
|
|
DICompileUnit(DbgNode).Verify() || DINameSpace(DbgNode).Verify() ||
|
|
|
|
DILexicalBlock(DbgNode).Verify() ||
|
|
|
|
DILexicalBlockFile(DbgNode).Verify() ||
|
|
|
|
DISubrange(DbgNode).Verify() || DIEnumerator(DbgNode).Verify() ||
|
|
|
|
DIObjCProperty(DbgNode).Verify() ||
|
|
|
|
DITemplateTypeParameter(DbgNode).Verify() ||
|
|
|
|
DITemplateValueParameter(DbgNode).Verify() ||
|
2015-03-16 21:03:55 +00:00
|
|
|
DIImportedEntity(DbgNode).Verify());
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
static Metadata *getField(const MDNode *DbgNode, unsigned Elt) {
|
2014-04-09 06:08:46 +00:00
|
|
|
if (!DbgNode || Elt >= DbgNode->getNumOperands())
|
|
|
|
return nullptr;
|
2013-11-08 08:13:15 +00:00
|
|
|
return DbgNode->getOperand(Elt);
|
|
|
|
}
|
|
|
|
|
|
|
|
static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
|
|
|
|
return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
|
|
|
|
}
|
|
|
|
|
|
|
|
static StringRef getStringField(const MDNode *DbgNode, unsigned Elt) {
|
|
|
|
if (MDString *MDS = dyn_cast_or_null<MDString>(getField(DbgNode, Elt)))
|
|
|
|
return MDS->getString();
|
|
|
|
return StringRef();
|
|
|
|
}
|
|
|
|
|
|
|
|
StringRef DIDescriptor::getStringField(unsigned Elt) const {
|
|
|
|
return ::getStringField(DbgNode, Elt);
|
|
|
|
}
|
|
|
|
|
|
|
|
uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
if (auto *C = getConstantField(Elt))
|
|
|
|
if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
|
2013-11-08 08:13:15 +00:00
|
|
|
return CI->getZExtValue();
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
int64_t DIDescriptor::getInt64Field(unsigned Elt) const {
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
if (auto *C = getConstantField(Elt))
|
|
|
|
if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
|
|
|
|
return CI->getZExtValue();
|
2013-11-08 08:13:15 +00:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
|
|
|
|
MDNode *Field = getNodeField(DbgNode, Elt);
|
|
|
|
return DIDescriptor(Field);
|
|
|
|
}
|
|
|
|
|
|
|
|
GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
return dyn_cast_or_null<GlobalVariable>(getConstantField(Elt));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
Constant *DIDescriptor::getConstantField(unsigned Elt) const {
|
2014-04-09 06:08:46 +00:00
|
|
|
if (!DbgNode)
|
|
|
|
return nullptr;
|
2013-11-08 08:13:15 +00:00
|
|
|
|
|
|
|
if (Elt < DbgNode->getNumOperands())
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
if (auto *C =
|
|
|
|
dyn_cast_or_null<ConstantAsMetadata>(DbgNode->getOperand(Elt)))
|
|
|
|
return C->getValue();
|
2014-04-09 06:08:46 +00:00
|
|
|
return nullptr;
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
Function *DIDescriptor::getFunctionField(unsigned Elt) const {
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
return dyn_cast_or_null<Function>(getConstantField(Elt));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2014-10-15 17:01:28 +00:00
|
|
|
/// \brief Return the size reported by the variable's type.
|
2014-08-01 22:11:58 +00:00
|
|
|
unsigned DIVariable::getSizeInBits(const DITypeIdentifierMap &Map) {
|
|
|
|
DIType Ty = getType().resolve(Map);
|
|
|
|
// Follow derived types until we reach a type that
|
|
|
|
// reports back a size.
|
|
|
|
while (Ty.isDerivedType() && !Ty.getSizeInBits()) {
|
|
|
|
DIDerivedType DT(&*Ty);
|
|
|
|
Ty = DT.getTypeDerivedFrom().resolve(Map);
|
|
|
|
}
|
|
|
|
assert(Ty.getSizeInBits() && "type with size 0");
|
|
|
|
return Ty.getSizeInBits();
|
|
|
|
}
|
|
|
|
|
2015-02-09 23:57:15 +00:00
|
|
|
bool DIExpression::isBitPiece() const {
|
2015-01-21 00:59:20 +00:00
|
|
|
unsigned N = getNumElements();
|
2015-02-09 23:57:15 +00:00
|
|
|
return N >=3 && getElement(N-3) == dwarf::DW_OP_bit_piece;
|
Move the complex address expression out of DIVariable and into an extra
argument of the llvm.dbg.declare/llvm.dbg.value intrinsics.
Previously, DIVariable was a variable-length field that has an optional
reference to a Metadata array consisting of a variable number of
complex address expressions. In the case of OpPiece expressions this is
wasting a lot of storage in IR, because when an aggregate type is, e.g.,
SROA'd into all of its n individual members, the IR will contain n copies
of the DIVariable, all alike, only differing in the complex address
reference at the end.
By making the complex address into an extra argument of the
dbg.value/dbg.declare intrinsics, all of the pieces can reference the
same variable and the complex address expressions can be uniqued across
the CU, too.
Down the road, this will allow us to move other flags, such as
"indirection" out of the DIVariable, too.
The new intrinsics look like this:
declare void @llvm.dbg.declare(metadata %storage, metadata %var, metadata %expr)
declare void @llvm.dbg.value(metadata %storage, i64 %offset, metadata %var, metadata %expr)
This patch adds a new LLVM-local tag to DIExpressions, so we can detect
and pretty-print DIExpression metadata nodes.
What this patch doesn't do:
This patch does not touch the "Indirect" field in DIVariable; but moving
that into the expression would be a natural next step.
http://reviews.llvm.org/D4919
rdar://problem/17994491
Thanks to dblaikie and dexonsmith for reviewing this patch!
Note: I accidentally committed a bogus older version of this patch previously.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@218787 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-01 18:55:02 +00:00
|
|
|
}
|
|
|
|
|
2015-02-09 23:57:15 +00:00
|
|
|
uint64_t DIExpression::getBitPieceOffset() const {
|
|
|
|
assert(isBitPiece() && "not a piece");
|
2015-01-21 00:59:20 +00:00
|
|
|
return getElement(getNumElements()-2);
|
Move the complex address expression out of DIVariable and into an extra
argument of the llvm.dbg.declare/llvm.dbg.value intrinsics.
Previously, DIVariable was a variable-length field that has an optional
reference to a Metadata array consisting of a variable number of
complex address expressions. In the case of OpPiece expressions this is
wasting a lot of storage in IR, because when an aggregate type is, e.g.,
SROA'd into all of its n individual members, the IR will contain n copies
of the DIVariable, all alike, only differing in the complex address
reference at the end.
By making the complex address into an extra argument of the
dbg.value/dbg.declare intrinsics, all of the pieces can reference the
same variable and the complex address expressions can be uniqued across
the CU, too.
Down the road, this will allow us to move other flags, such as
"indirection" out of the DIVariable, too.
The new intrinsics look like this:
declare void @llvm.dbg.declare(metadata %storage, metadata %var, metadata %expr)
declare void @llvm.dbg.value(metadata %storage, i64 %offset, metadata %var, metadata %expr)
This patch adds a new LLVM-local tag to DIExpressions, so we can detect
and pretty-print DIExpression metadata nodes.
What this patch doesn't do:
This patch does not touch the "Indirect" field in DIVariable; but moving
that into the expression would be a natural next step.
http://reviews.llvm.org/D4919
rdar://problem/17994491
Thanks to dblaikie and dexonsmith for reviewing this patch!
Note: I accidentally committed a bogus older version of this patch previously.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@218787 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-01 18:55:02 +00:00
|
|
|
}
|
2014-08-01 22:11:58 +00:00
|
|
|
|
2015-02-09 23:57:15 +00:00
|
|
|
uint64_t DIExpression::getBitPieceSize() const {
|
|
|
|
assert(isBitPiece() && "not a piece");
|
2015-01-21 00:59:20 +00:00
|
|
|
return getElement(getNumElements()-1);
|
Move the complex address expression out of DIVariable and into an extra
argument of the llvm.dbg.declare/llvm.dbg.value intrinsics.
Previously, DIVariable was a variable-length field that has an optional
reference to a Metadata array consisting of a variable number of
complex address expressions. In the case of OpPiece expressions this is
wasting a lot of storage in IR, because when an aggregate type is, e.g.,
SROA'd into all of its n individual members, the IR will contain n copies
of the DIVariable, all alike, only differing in the complex address
reference at the end.
By making the complex address into an extra argument of the
dbg.value/dbg.declare intrinsics, all of the pieces can reference the
same variable and the complex address expressions can be uniqued across
the CU, too.
Down the road, this will allow us to move other flags, such as
"indirection" out of the DIVariable, too.
The new intrinsics look like this:
declare void @llvm.dbg.declare(metadata %storage, metadata %var, metadata %expr)
declare void @llvm.dbg.value(metadata %storage, i64 %offset, metadata %var, metadata %expr)
This patch adds a new LLVM-local tag to DIExpressions, so we can detect
and pretty-print DIExpression metadata nodes.
What this patch doesn't do:
This patch does not touch the "Indirect" field in DIVariable; but moving
that into the expression would be a natural next step.
http://reviews.llvm.org/D4919
rdar://problem/17994491
Thanks to dblaikie and dexonsmith for reviewing this patch!
Note: I accidentally committed a bogus older version of this patch previously.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@218787 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-01 18:55:02 +00:00
|
|
|
}
|
2014-08-01 22:11:58 +00:00
|
|
|
|
2015-03-04 17:39:33 +00:00
|
|
|
DIExpression::iterator DIExpression::Operand::getNext() const {
|
2015-01-23 23:40:47 +00:00
|
|
|
iterator it(I);
|
2015-03-04 17:39:33 +00:00
|
|
|
return ++it;
|
2015-01-23 23:40:47 +00:00
|
|
|
}
|
|
|
|
|
2013-11-08 08:13:15 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Simple Descriptor Constructors and other Methods
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2015-02-28 23:48:02 +00:00
|
|
|
void DIDescriptor::replaceAllUsesWith(LLVMContext &, DIDescriptor D) {
|
2013-11-08 08:13:15 +00:00
|
|
|
assert(DbgNode && "Trying to replace an unverified type!");
|
2015-02-28 23:48:02 +00:00
|
|
|
assert(DbgNode->isTemporary() && "Expected temporary node");
|
|
|
|
TempMDNode Temp(get());
|
2013-11-08 08:13:15 +00:00
|
|
|
|
|
|
|
// 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.
|
2015-02-28 23:48:02 +00:00
|
|
|
if (Temp.get() == D.get()) {
|
|
|
|
DbgNode = MDNode::replaceWithUniqued(std::move(Temp));
|
|
|
|
return;
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
2014-05-06 03:41:57 +00:00
|
|
|
|
2015-02-28 23:48:02 +00:00
|
|
|
Temp->replaceAllUsesWith(D.get());
|
|
|
|
DbgNode = D.get();
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2014-09-15 07:50:36 +00:00
|
|
|
void DIDescriptor::replaceAllUsesWith(MDNode *D) {
|
2013-11-08 08:13:15 +00:00
|
|
|
assert(DbgNode && "Trying to replace an unverified type!");
|
2014-05-06 03:41:57 +00:00
|
|
|
assert(DbgNode != D && "This replacement should always happen");
|
IR: Remove MDNodeFwdDecl
Remove `MDNodeFwdDecl` (as promised in r226481). Aside from API
changes, there's no real functionality change here.
`MDNode::getTemporary()` now forwards to `MDTuple::getTemporary()`,
which returns a tuple with `isTemporary()` equal to true.
The main point is that we can now add temporaries of other `MDNode`
subclasses, needed for PR22235 (I introduced `MDNodeFwdDecl` in the
first place because I didn't recognize this need, and thought they were
only needed to handle forward references).
A few things left out of (or highlighted by) this commit:
- I've had to remove the (few) uses of `std::unique_ptr<>` to deal
with temporaries, since the destructor is no longer public.
`getTemporary()` should probably return the equivalent of
`std::unique_ptr<T, MDNode::deleteTemporary>`.
- `MDLocation::getTemporary()` doesn't exist yet (worse, it actually
does exist, but does the wrong thing: `MDNode::getTemporary()` is
inherited and returns an `MDTuple`).
- `MDNode` now only has one subclass, `UniquableMDNode`, and the
distinction between them is actually somewhat confusing.
I'll fix those up next.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@226501 91177308-0d34-0410-b5e6-96231b3b80d8
2015-01-19 20:36:39 +00:00
|
|
|
assert(DbgNode->isTemporary() && "Expected temporary node");
|
2015-02-28 23:48:02 +00:00
|
|
|
TempMDNode Node(get());
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
Node->replaceAllUsesWith(D);
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2015-03-31 00:47:15 +00:00
|
|
|
bool DICompileUnit::Verify() const { return isCompileUnit(); }
|
2015-03-03 17:24:31 +00:00
|
|
|
bool DIObjCProperty::Verify() const { return isObjCProperty(); }
|
2013-11-08 08:13:15 +00:00
|
|
|
|
2015-03-31 01:47:55 +00:00
|
|
|
#ifndef NDEBUG
|
2014-10-15 17:01:28 +00:00
|
|
|
/// \brief Check if a value can be a reference to a type.
|
2014-11-14 23:55:03 +00:00
|
|
|
static bool isTypeRef(const Metadata *MD) {
|
|
|
|
if (!MD)
|
|
|
|
return true;
|
|
|
|
if (auto *S = dyn_cast<MDString>(MD))
|
|
|
|
return !S->getString().empty();
|
2015-03-03 17:24:31 +00:00
|
|
|
return isa<MDType>(MD);
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2014-10-15 17:01:28 +00:00
|
|
|
/// \brief Check if a value can be a ScopeRef.
|
2014-11-14 23:55:03 +00:00
|
|
|
static bool isScopeRef(const Metadata *MD) {
|
|
|
|
if (!MD)
|
|
|
|
return true;
|
|
|
|
if (auto *S = dyn_cast<MDString>(MD))
|
|
|
|
return !S->getString().empty();
|
2015-03-03 17:24:31 +00:00
|
|
|
return isa<MDScope>(MD);
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2015-02-18 19:39:36 +00:00
|
|
|
/// \brief Check if a value can be a DescriptorRef.
|
|
|
|
static bool isDescriptorRef(const Metadata *MD) {
|
|
|
|
if (!MD)
|
|
|
|
return true;
|
|
|
|
if (auto *S = dyn_cast<MDString>(MD))
|
|
|
|
return !S->getString().empty();
|
|
|
|
return isa<MDNode>(MD);
|
|
|
|
}
|
2015-02-18 19:56:50 +00:00
|
|
|
#endif
|
2015-02-18 19:39:36 +00:00
|
|
|
|
2015-03-31 01:28:58 +00:00
|
|
|
bool DIType::Verify() const { return isType(); }
|
2015-03-31 00:47:15 +00:00
|
|
|
bool DIBasicType::Verify() const { return isBasicType(); }
|
|
|
|
bool DIDerivedType::Verify() const { return isDerivedType(); }
|
2015-03-31 01:28:58 +00:00
|
|
|
bool DICompositeType::Verify() const { return isCompositeType(); }
|
2013-11-08 08:13:15 +00:00
|
|
|
|
|
|
|
bool DISubprogram::Verify() const {
|
2015-03-23 21:54:07 +00:00
|
|
|
auto *N = dyn_cast_or_null<MDSubprogram>(DbgNode);
|
2015-03-03 17:24:31 +00:00
|
|
|
if (!N)
|
2013-11-08 08:13:15 +00:00
|
|
|
return false;
|
|
|
|
|
DebugInfo: Ensure that all debug location scope chains from instructions within a function, lead to the function itself.
Let me tell you a tale...
Originally committed in r211723 after discovering a nasty case of weird
scoping due to inlining, this was reverted in r211724 after it fired in
ASan/compiler-rt.
(minor diversion where I accidentally committed/reverted again in
r211871/r211873)
After further testing and fixing bugs in ArgumentPromotion (r211872) and
Inlining (r212065) it was recommitted in r212085. Reverted in r212089
after the sanitizer buildbots still showed problems.
Fixed another bug in ArgumentPromotion (r212128) found by this
assertion.
Recommitted in r212205, reverted in r212226 after it crashed some more
on sanitizer buildbots.
Fix clang some more in r212761.
Recommitted in r212776, reverted in r212793. ASan failures.
Recommitted in r213391, reverted in r213432, trying to reproduce flakey
ASan build failure.
Fixed bugs in r213805 (ArgPromo + DebugInfo), r213952
(LiveDebugVariables strips dbg_value intrinsics in functions not
described by debug info).
Recommitted in r214761, reverted in r214999, flakey failure on Windows
buildbot.
Fixed DeadArgElimination + DebugInfo bug in r219210.
Recommitted in r219215, reverted in r219512, failure on ObjC++ atomic
properties in the test-suite on Darwin.
Fixed ObjC++ atomic properties issue in Clang in r219690.
[This commit is provided 'as is' with no hope that this is the last time
I commit this change either expressed or implied]
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@219702 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-14 18:22:52 +00:00
|
|
|
// If a DISubprogram has an llvm::Function*, then scope chains from all
|
|
|
|
// instructions within the function should lead to this DISubprogram.
|
|
|
|
if (auto *F = getFunction()) {
|
|
|
|
for (auto &BB : *F) {
|
|
|
|
for (auto &I : BB) {
|
2015-03-30 19:40:05 +00:00
|
|
|
MDLocation *DL = I.getDebugLoc();
|
2015-03-30 17:06:38 +00:00
|
|
|
if (!DL)
|
DebugInfo: Ensure that all debug location scope chains from instructions within a function, lead to the function itself.
Let me tell you a tale...
Originally committed in r211723 after discovering a nasty case of weird
scoping due to inlining, this was reverted in r211724 after it fired in
ASan/compiler-rt.
(minor diversion where I accidentally committed/reverted again in
r211871/r211873)
After further testing and fixing bugs in ArgumentPromotion (r211872) and
Inlining (r212065) it was recommitted in r212085. Reverted in r212089
after the sanitizer buildbots still showed problems.
Fixed another bug in ArgumentPromotion (r212128) found by this
assertion.
Recommitted in r212205, reverted in r212226 after it crashed some more
on sanitizer buildbots.
Fix clang some more in r212761.
Recommitted in r212776, reverted in r212793. ASan failures.
Recommitted in r213391, reverted in r213432, trying to reproduce flakey
ASan build failure.
Fixed bugs in r213805 (ArgPromo + DebugInfo), r213952
(LiveDebugVariables strips dbg_value intrinsics in functions not
described by debug info).
Recommitted in r214761, reverted in r214999, flakey failure on Windows
buildbot.
Fixed DeadArgElimination + DebugInfo bug in r219210.
Recommitted in r219215, reverted in r219512, failure on ObjC++ atomic
properties in the test-suite on Darwin.
Fixed ObjC++ atomic properties issue in Clang in r219690.
[This commit is provided 'as is' with no hope that this is the last time
I commit this change either expressed or implied]
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@219702 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-14 18:22:52 +00:00
|
|
|
continue;
|
|
|
|
|
|
|
|
// walk the inlined-at scopes
|
2015-03-30 17:41:24 +00:00
|
|
|
MDScope *Scope = DL->getInlinedAtScope();
|
2015-01-20 22:37:25 +00:00
|
|
|
if (!Scope)
|
|
|
|
return false;
|
2015-03-30 17:06:38 +00:00
|
|
|
while (!isa<MDSubprogram>(Scope)) {
|
|
|
|
Scope = cast<MDLexicalBlockBase>(Scope)->getScope();
|
2015-01-21 18:32:56 +00:00
|
|
|
if (!Scope)
|
|
|
|
return false;
|
DebugInfo: Ensure that all debug location scope chains from instructions within a function, lead to the function itself.
Let me tell you a tale...
Originally committed in r211723 after discovering a nasty case of weird
scoping due to inlining, this was reverted in r211724 after it fired in
ASan/compiler-rt.
(minor diversion where I accidentally committed/reverted again in
r211871/r211873)
After further testing and fixing bugs in ArgumentPromotion (r211872) and
Inlining (r212065) it was recommitted in r212085. Reverted in r212089
after the sanitizer buildbots still showed problems.
Fixed another bug in ArgumentPromotion (r212128) found by this
assertion.
Recommitted in r212205, reverted in r212226 after it crashed some more
on sanitizer buildbots.
Fix clang some more in r212761.
Recommitted in r212776, reverted in r212793. ASan failures.
Recommitted in r213391, reverted in r213432, trying to reproduce flakey
ASan build failure.
Fixed bugs in r213805 (ArgPromo + DebugInfo), r213952
(LiveDebugVariables strips dbg_value intrinsics in functions not
described by debug info).
Recommitted in r214761, reverted in r214999, flakey failure on Windows
buildbot.
Fixed DeadArgElimination + DebugInfo bug in r219210.
Recommitted in r219215, reverted in r219512, failure on ObjC++ atomic
properties in the test-suite on Darwin.
Fixed ObjC++ atomic properties issue in Clang in r219690.
[This commit is provided 'as is' with no hope that this is the last time
I commit this change either expressed or implied]
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@219702 91177308-0d34-0410-b5e6-96231b3b80d8
2014-10-14 18:22:52 +00:00
|
|
|
}
|
|
|
|
if (!DISubprogram(Scope).describes(F))
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-03-03 17:24:31 +00:00
|
|
|
|
|
|
|
return true;
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2015-03-31 01:28:22 +00:00
|
|
|
bool DIGlobalVariable::Verify() const { return isGlobalVariable(); }
|
|
|
|
bool DIVariable::Verify() const { return isVariable(); }
|
2013-11-08 08:13:15 +00:00
|
|
|
|
2015-03-23 21:54:07 +00:00
|
|
|
bool DILocation::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDLocation>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DINameSpace::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDNamespace>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DIFile::Verify() const { return dyn_cast_or_null<MDFile>(DbgNode); }
|
|
|
|
bool DIEnumerator::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDEnumerator>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DISubrange::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDSubrange>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DILexicalBlock::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDLexicalBlock>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DILexicalBlockFile::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDLexicalBlockFile>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DITemplateTypeParameter::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDTemplateTypeParameter>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DITemplateValueParameter::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDTemplateValueParameter>(DbgNode);
|
|
|
|
}
|
|
|
|
bool DIImportedEntity::Verify() const {
|
|
|
|
return dyn_cast_or_null<MDImportedEntity>(DbgNode);
|
|
|
|
}
|
2013-11-08 08:13:15 +00:00
|
|
|
|
2014-07-28 19:33:20 +00:00
|
|
|
void DICompositeType::setArraysHelper(MDNode *Elements, MDNode *TParams) {
|
2015-03-23 21:54:07 +00:00
|
|
|
TypedTrackingMDRef<MDCompositeTypeBase> N(get());
|
2015-03-03 17:24:31 +00:00
|
|
|
if (Elements)
|
|
|
|
N->replaceElements(cast<MDTuple>(Elements));
|
2013-11-08 08:13:15 +00:00
|
|
|
if (TParams)
|
2015-03-03 17:24:31 +00:00
|
|
|
N->replaceTemplateParams(cast<MDTuple>(TParams));
|
2013-11-08 08:13:15 +00:00
|
|
|
DbgNode = N;
|
|
|
|
}
|
|
|
|
|
|
|
|
DIScopeRef DIScope::getRef() const {
|
|
|
|
if (!isCompositeType())
|
|
|
|
return DIScopeRef(*this);
|
|
|
|
DICompositeType DTy(DbgNode);
|
|
|
|
if (!DTy.getIdentifier())
|
|
|
|
return DIScopeRef(*this);
|
|
|
|
return DIScopeRef(DTy.getIdentifier());
|
|
|
|
}
|
|
|
|
|
|
|
|
void DICompositeType::setContainingType(DICompositeType ContainingType) {
|
2015-03-23 21:54:07 +00:00
|
|
|
TypedTrackingMDRef<MDCompositeTypeBase> N(get());
|
2015-03-03 17:24:31 +00:00
|
|
|
N->replaceVTableHolder(ContainingType.getRef());
|
2013-11-08 08:13:15 +00:00
|
|
|
DbgNode = N;
|
|
|
|
}
|
|
|
|
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
|
2015-03-03 17:24:31 +00:00
|
|
|
Function *DISubprogram::getFunction() const {
|
2015-03-23 21:54:07 +00:00
|
|
|
if (auto *N = get())
|
2015-03-03 17:24:31 +00:00
|
|
|
if (auto *C = dyn_cast_or_null<ConstantAsMetadata>(N->getFunction()))
|
|
|
|
return dyn_cast<Function>(C->getValue());
|
|
|
|
return nullptr;
|
|
|
|
}
|
|
|
|
|
2013-11-08 08:13:15 +00:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2015-03-03 17:24:31 +00:00
|
|
|
GlobalVariable *DIGlobalVariable::getGlobal() const {
|
|
|
|
return dyn_cast_or_null<GlobalVariable>(getConstant());
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
DIScopeRef DIScope::getContext() const {
|
|
|
|
|
|
|
|
if (isType())
|
|
|
|
return DIType(DbgNode).getContext();
|
|
|
|
|
|
|
|
if (isSubprogram())
|
|
|
|
return DIScopeRef(DISubprogram(DbgNode).getContext());
|
|
|
|
|
|
|
|
if (isLexicalBlock())
|
|
|
|
return DIScopeRef(DILexicalBlock(DbgNode).getContext());
|
|
|
|
|
|
|
|
if (isLexicalBlockFile())
|
|
|
|
return DIScopeRef(DILexicalBlockFile(DbgNode).getContext());
|
|
|
|
|
|
|
|
if (isNameSpace())
|
|
|
|
return DIScopeRef(DINameSpace(DbgNode).getContext());
|
|
|
|
|
|
|
|
assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
|
2014-04-09 06:08:46 +00:00
|
|
|
return DIScopeRef(nullptr);
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
StringRef DIScope::getName() const {
|
|
|
|
if (isType())
|
|
|
|
return DIType(DbgNode).getName();
|
|
|
|
if (isSubprogram())
|
|
|
|
return DISubprogram(DbgNode).getName();
|
|
|
|
if (isNameSpace())
|
|
|
|
return DINameSpace(DbgNode).getName();
|
|
|
|
assert((isLexicalBlock() || isLexicalBlockFile() || isFile() ||
|
|
|
|
isCompileUnit()) &&
|
|
|
|
"Unhandled type of scope.");
|
|
|
|
return StringRef();
|
|
|
|
}
|
|
|
|
|
|
|
|
StringRef DIScope::getFilename() const {
|
2015-03-23 21:54:07 +00:00
|
|
|
if (auto *N = get())
|
2015-03-03 17:24:31 +00:00
|
|
|
return ::getStringField(dyn_cast_or_null<MDNode>(N->getFile()), 0);
|
|
|
|
return "";
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
StringRef DIScope::getDirectory() const {
|
2015-03-23 21:54:07 +00:00
|
|
|
if (auto *N = get())
|
2015-03-03 17:24:31 +00:00
|
|
|
return ::getStringField(dyn_cast_or_null<MDNode>(N->getFile()), 1);
|
|
|
|
return "";
|
2014-10-03 20:01:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void DICompileUnit::replaceSubprograms(DIArray Subprograms) {
|
|
|
|
assert(Verify() && "Expected compile unit");
|
2015-03-23 21:54:07 +00:00
|
|
|
get()->replaceSubprograms(cast_or_null<MDTuple>(Subprograms.get()));
|
2014-10-03 20:01:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void DICompileUnit::replaceGlobalVariables(DIArray GlobalVariables) {
|
|
|
|
assert(Verify() && "Expected compile unit");
|
2015-03-23 21:54:07 +00:00
|
|
|
get()->replaceGlobalVariables(cast_or_null<MDTuple>(GlobalVariables.get()));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2014-03-03 20:06:11 +00:00
|
|
|
DILocation DILocation::copyWithNewScope(LLVMContext &Ctx,
|
2014-08-21 22:45:21 +00:00
|
|
|
DILexicalBlockFile NewScope) {
|
2014-03-03 20:06:11 +00:00
|
|
|
assert(Verify());
|
2015-01-14 22:27:36 +00:00
|
|
|
assert(NewScope && "Expected valid scope");
|
|
|
|
|
|
|
|
const auto *Old = cast<MDLocation>(DbgNode);
|
|
|
|
return DILocation(MDLocation::get(Ctx, Old->getLine(), Old->getColumn(),
|
|
|
|
NewScope, Old->getInlinedAt()));
|
2014-03-03 20:06:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
unsigned DILocation::computeNewDiscriminator(LLVMContext &Ctx) {
|
|
|
|
std::pair<const char *, unsigned> Key(getFilename().data(), getLineNumber());
|
|
|
|
return ++Ctx.pImpl->DiscriminatorTable[Key];
|
|
|
|
}
|
|
|
|
|
2013-11-08 08:13:15 +00:00
|
|
|
DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
|
|
|
|
LLVMContext &VMContext) {
|
2014-10-03 20:01:09 +00:00
|
|
|
assert(DIVariable(DV).Verify() && "Expected a DIVariable");
|
2015-03-03 17:24:31 +00:00
|
|
|
return cast<MDLocalVariable>(DV)
|
|
|
|
->withInline(cast_or_null<MDLocation>(InlinedScope));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
|
2014-10-03 20:01:09 +00:00
|
|
|
assert(DIVariable(DV).Verify() && "Expected a DIVariable");
|
2015-03-03 17:24:31 +00:00
|
|
|
return cast<MDLocalVariable>(DV)->withoutInline();
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
|
2015-03-31 02:06:28 +00:00
|
|
|
if (auto *LocalScope = dyn_cast_or_null<MDLocalScope>(Scope))
|
|
|
|
return LocalScope->getSubprogram();
|
|
|
|
return nullptr;
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2014-10-23 23:46:28 +00:00
|
|
|
DISubprogram llvm::getDISubprogram(const Function *F) {
|
|
|
|
// We look for the first instr that has a debug annotation leading back to F.
|
|
|
|
for (auto &BB : *F) {
|
2014-11-01 07:57:14 +00:00
|
|
|
auto Inst = std::find_if(BB.begin(), BB.end(), [](const Instruction &Inst) {
|
2015-03-30 19:40:05 +00:00
|
|
|
return Inst.getDebugLoc();
|
2014-11-01 07:57:14 +00:00
|
|
|
});
|
|
|
|
if (Inst == BB.end())
|
|
|
|
continue;
|
|
|
|
DebugLoc DLoc = Inst->getDebugLoc();
|
2015-03-30 19:40:05 +00:00
|
|
|
const MDNode *Scope = DLoc.getInlinedAtScope();
|
2014-11-01 07:57:14 +00:00
|
|
|
DISubprogram Subprogram = getDISubprogram(Scope);
|
|
|
|
return Subprogram.describes(F) ? Subprogram : DISubprogram();
|
2014-10-23 23:46:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return DISubprogram();
|
|
|
|
}
|
|
|
|
|
2013-11-08 08:13:15 +00:00
|
|
|
DICompositeType llvm::getDICompositeType(DIType T) {
|
|
|
|
if (T.isCompositeType())
|
|
|
|
return DICompositeType(T);
|
|
|
|
|
|
|
|
if (T.isDerivedType()) {
|
|
|
|
// This function is currently used by dragonegg and dragonegg does
|
|
|
|
// not generate identifier for types, so using an empty map to resolve
|
|
|
|
// DerivedFrom should be fine.
|
|
|
|
DITypeIdentifierMap EmptyMap;
|
|
|
|
return getDICompositeType(
|
|
|
|
DIDerivedType(T).getTypeDerivedFrom().resolve(EmptyMap));
|
|
|
|
}
|
|
|
|
|
|
|
|
return DICompositeType();
|
|
|
|
}
|
|
|
|
|
|
|
|
DITypeIdentifierMap
|
|
|
|
llvm::generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes) {
|
|
|
|
DITypeIdentifierMap Map;
|
|
|
|
for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
|
2014-11-11 21:30:22 +00:00
|
|
|
DICompileUnit CU(CU_Nodes->getOperand(CUi));
|
2013-11-08 08:13:15 +00:00
|
|
|
DIArray Retain = CU.getRetainedTypes();
|
|
|
|
for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
|
|
|
|
if (!Retain.getElement(Ti).isCompositeType())
|
|
|
|
continue;
|
|
|
|
DICompositeType Ty(Retain.getElement(Ti));
|
|
|
|
if (MDString *TypeId = Ty.getIdentifier()) {
|
|
|
|
// Definition has priority over declaration.
|
|
|
|
// Try to insert (TypeId, Ty) to Map.
|
|
|
|
std::pair<DITypeIdentifierMap::iterator, bool> P =
|
|
|
|
Map.insert(std::make_pair(TypeId, Ty));
|
|
|
|
// If TypeId already exists in Map and this is a definition, replace
|
|
|
|
// whatever we had (declaration or definition) with the definition.
|
|
|
|
if (!P.second && !Ty.isForwardDecl())
|
|
|
|
P.first->second = Ty;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Map;
|
|
|
|
}
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// DebugInfoFinder implementations.
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
void DebugInfoFinder::reset() {
|
|
|
|
CUs.clear();
|
|
|
|
SPs.clear();
|
|
|
|
GVs.clear();
|
|
|
|
TYs.clear();
|
|
|
|
Scopes.clear();
|
|
|
|
NodesSeen.clear();
|
|
|
|
TypeIdentifierMap.clear();
|
2013-11-17 18:42:37 +00:00
|
|
|
TypeMapInitialized = false;
|
|
|
|
}
|
|
|
|
|
2013-11-17 19:35:03 +00:00
|
|
|
void DebugInfoFinder::InitializeTypeMap(const Module &M) {
|
2013-11-17 18:42:37 +00:00
|
|
|
if (!TypeMapInitialized)
|
|
|
|
if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
|
|
|
|
TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
|
|
|
|
TypeMapInitialized = true;
|
|
|
|
}
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void DebugInfoFinder::processModule(const Module &M) {
|
2013-11-17 19:35:03 +00:00
|
|
|
InitializeTypeMap(M);
|
2013-11-08 08:13:15 +00:00
|
|
|
if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
|
|
|
|
for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
|
2014-11-11 21:30:22 +00:00
|
|
|
DICompileUnit CU(CU_Nodes->getOperand(i));
|
2013-11-08 08:13:15 +00:00
|
|
|
addCompileUnit(CU);
|
|
|
|
DIArray GVs = CU.getGlobalVariables();
|
|
|
|
for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
|
|
|
|
DIGlobalVariable DIG(GVs.getElement(i));
|
|
|
|
if (addGlobalVariable(DIG)) {
|
2014-11-21 19:55:23 +00:00
|
|
|
processScope(DIG.getContext());
|
2014-03-18 02:34:58 +00:00
|
|
|
processType(DIG.getType().resolve(TypeIdentifierMap));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
DIArray SPs = CU.getSubprograms();
|
|
|
|
for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
|
|
|
|
processSubprogram(DISubprogram(SPs.getElement(i)));
|
|
|
|
DIArray EnumTypes = CU.getEnumTypes();
|
|
|
|
for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
|
|
|
|
processType(DIType(EnumTypes.getElement(i)));
|
|
|
|
DIArray RetainedTypes = CU.getRetainedTypes();
|
|
|
|
for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
|
|
|
|
processType(DIType(RetainedTypes.getElement(i)));
|
|
|
|
DIArray Imports = CU.getImportedEntities();
|
|
|
|
for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
|
|
|
|
DIImportedEntity Import = DIImportedEntity(Imports.getElement(i));
|
2015-03-20 19:13:53 +00:00
|
|
|
if (!Import)
|
|
|
|
continue;
|
2014-04-01 03:41:04 +00:00
|
|
|
DIDescriptor Entity = Import.getEntity().resolve(TypeIdentifierMap);
|
2013-11-08 08:13:15 +00:00
|
|
|
if (Entity.isType())
|
|
|
|
processType(DIType(Entity));
|
|
|
|
else if (Entity.isSubprogram())
|
|
|
|
processSubprogram(DISubprogram(Entity));
|
|
|
|
else if (Entity.isNameSpace())
|
|
|
|
processScope(DINameSpace(Entity).getContext());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-11-17 18:42:37 +00:00
|
|
|
void DebugInfoFinder::processLocation(const Module &M, DILocation Loc) {
|
2013-11-08 08:13:15 +00:00
|
|
|
if (!Loc)
|
|
|
|
return;
|
2013-11-17 19:35:03 +00:00
|
|
|
InitializeTypeMap(M);
|
2013-11-08 08:13:15 +00:00
|
|
|
processScope(Loc.getScope());
|
2013-11-17 18:42:37 +00:00
|
|
|
processLocation(M, Loc.getOrigLocation());
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void DebugInfoFinder::processType(DIType DT) {
|
|
|
|
if (!addType(DT))
|
|
|
|
return;
|
|
|
|
processScope(DT.getContext().resolve(TypeIdentifierMap));
|
|
|
|
if (DT.isCompositeType()) {
|
|
|
|
DICompositeType DCT(DT);
|
|
|
|
processType(DCT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
|
2014-07-28 22:24:06 +00:00
|
|
|
if (DT.isSubroutineType()) {
|
|
|
|
DITypeArray DTA = DISubroutineType(DT).getTypeArray();
|
|
|
|
for (unsigned i = 0, e = DTA.getNumElements(); i != e; ++i)
|
|
|
|
processType(DTA.getElement(i).resolve(TypeIdentifierMap));
|
|
|
|
return;
|
|
|
|
}
|
2014-07-28 19:14:13 +00:00
|
|
|
DIArray DA = DCT.getElements();
|
2013-11-08 08:13:15 +00:00
|
|
|
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().resolve(TypeIdentifierMap));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void DebugInfoFinder::processScope(DIScope Scope) {
|
|
|
|
if (Scope.isType()) {
|
|
|
|
DIType Ty(Scope);
|
|
|
|
processType(Ty);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if (Scope.isCompileUnit()) {
|
|
|
|
addCompileUnit(DICompileUnit(Scope));
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if (Scope.isSubprogram()) {
|
|
|
|
processSubprogram(DISubprogram(Scope));
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if (!addScope(Scope))
|
|
|
|
return;
|
|
|
|
if (Scope.isLexicalBlock()) {
|
|
|
|
DILexicalBlock LB(Scope);
|
|
|
|
processScope(LB.getContext());
|
|
|
|
} else if (Scope.isLexicalBlockFile()) {
|
|
|
|
DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
|
|
|
|
processScope(LBF.getScope());
|
|
|
|
} else if (Scope.isNameSpace()) {
|
|
|
|
DINameSpace NS(Scope);
|
|
|
|
processScope(NS.getContext());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void DebugInfoFinder::processSubprogram(DISubprogram SP) {
|
|
|
|
if (!addSubprogram(SP))
|
|
|
|
return;
|
|
|
|
processScope(SP.getContext().resolve(TypeIdentifierMap));
|
|
|
|
processType(SP.getType());
|
|
|
|
DIArray TParams = SP.getTemplateParams();
|
|
|
|
for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
|
|
|
|
DIDescriptor Element = TParams.getElement(I);
|
|
|
|
if (Element.isTemplateTypeParameter()) {
|
|
|
|
DITemplateTypeParameter TType(Element);
|
|
|
|
processType(TType.getType().resolve(TypeIdentifierMap));
|
|
|
|
} else if (Element.isTemplateValueParameter()) {
|
|
|
|
DITemplateValueParameter TVal(Element);
|
|
|
|
processType(TVal.getType().resolve(TypeIdentifierMap));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-11-17 18:42:37 +00:00
|
|
|
void DebugInfoFinder::processDeclare(const Module &M,
|
|
|
|
const DbgDeclareInst *DDI) {
|
2013-11-08 08:13:15 +00:00
|
|
|
MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
|
|
|
|
if (!N)
|
|
|
|
return;
|
2013-11-17 19:35:03 +00:00
|
|
|
InitializeTypeMap(M);
|
2013-11-08 08:13:15 +00:00
|
|
|
|
|
|
|
DIDescriptor DV(N);
|
|
|
|
if (!DV.isVariable())
|
|
|
|
return;
|
|
|
|
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(DV).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return;
|
|
|
|
processScope(DIVariable(N).getContext());
|
2014-03-18 02:34:58 +00:00
|
|
|
processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
2013-11-17 18:42:37 +00:00
|
|
|
void DebugInfoFinder::processValue(const Module &M, const DbgValueInst *DVI) {
|
2013-11-08 08:13:15 +00:00
|
|
|
MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
|
|
|
|
if (!N)
|
|
|
|
return;
|
2013-11-17 19:35:03 +00:00
|
|
|
InitializeTypeMap(M);
|
2013-11-08 08:13:15 +00:00
|
|
|
|
|
|
|
DIDescriptor DV(N);
|
|
|
|
if (!DV.isVariable())
|
|
|
|
return;
|
|
|
|
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(DV).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return;
|
|
|
|
processScope(DIVariable(N).getContext());
|
2014-03-18 02:34:58 +00:00
|
|
|
processType(DIVariable(N).getType().resolve(TypeIdentifierMap));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool DebugInfoFinder::addType(DIType DT) {
|
|
|
|
if (!DT)
|
|
|
|
return false;
|
|
|
|
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(DT).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return false;
|
|
|
|
|
|
|
|
TYs.push_back(DT);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
|
|
|
|
if (!CU)
|
|
|
|
return false;
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(CU).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return false;
|
|
|
|
|
|
|
|
CUs.push_back(CU);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
|
|
|
|
if (!DIG)
|
|
|
|
return false;
|
|
|
|
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(DIG).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return false;
|
|
|
|
|
|
|
|
GVs.push_back(DIG);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
|
|
|
|
if (!SP)
|
|
|
|
return false;
|
|
|
|
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(SP).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return false;
|
|
|
|
|
|
|
|
SPs.push_back(SP);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool DebugInfoFinder::addScope(DIScope Scope) {
|
|
|
|
if (!Scope)
|
|
|
|
return false;
|
|
|
|
// FIXME: Ocaml binding generates a scope with no content, we treat it
|
|
|
|
// as null for now.
|
|
|
|
if (Scope->getNumOperands() == 0)
|
|
|
|
return false;
|
2014-11-19 07:49:26 +00:00
|
|
|
if (!NodesSeen.insert(Scope).second)
|
2013-11-08 08:13:15 +00:00
|
|
|
return false;
|
|
|
|
Scopes.push_back(Scope);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// DIDescriptor: dump routines for all descriptors.
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
void DIDescriptor::dump() const {
|
|
|
|
print(dbgs());
|
|
|
|
dbgs() << '\n';
|
|
|
|
}
|
|
|
|
|
|
|
|
void DIDescriptor::print(raw_ostream &OS) const {
|
2015-03-03 17:24:31 +00:00
|
|
|
if (!get())
|
2013-11-08 08:13:15 +00:00
|
|
|
return;
|
2015-03-03 17:24:31 +00:00
|
|
|
get()->print(OS);
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
|
|
|
|
const LLVMContext &Ctx) {
|
2015-03-30 19:40:05 +00:00
|
|
|
if (!DL)
|
2015-03-30 18:45:11 +00:00
|
|
|
return;
|
|
|
|
|
2015-03-30 19:40:05 +00:00
|
|
|
DIScope Scope(DL.getScope());
|
2015-03-30 18:45:11 +00:00
|
|
|
assert(Scope.isScope() && "Scope of a DebugLoc should be a DIScope.");
|
|
|
|
// Omit the directory, because it's likely to be long and uninteresting.
|
|
|
|
CommentOS << Scope.getFilename();
|
|
|
|
CommentOS << ':' << DL.getLine();
|
|
|
|
if (DL.getCol() != 0)
|
|
|
|
CommentOS << ':' << DL.getCol();
|
|
|
|
|
2015-03-30 19:40:05 +00:00
|
|
|
DebugLoc InlinedAtDL = DL.getInlinedAt();
|
|
|
|
if (!InlinedAtDL)
|
2015-03-30 18:45:11 +00:00
|
|
|
return;
|
|
|
|
|
|
|
|
CommentOS << " @[ ";
|
|
|
|
printDebugLoc(InlinedAtDL, CommentOS, Ctx);
|
|
|
|
CommentOS << " ]";
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void DIVariable::printExtendedName(raw_ostream &OS) const {
|
|
|
|
const LLVMContext &Ctx = DbgNode->getContext();
|
|
|
|
StringRef Res = getName();
|
|
|
|
if (!Res.empty())
|
|
|
|
OS << Res << "," << getLineNumber();
|
2015-03-30 19:40:05 +00:00
|
|
|
if (auto *InlinedAt = get()->getInlinedAt()) {
|
|
|
|
if (DebugLoc InlinedAtDL = InlinedAt) {
|
2013-11-08 08:13:15 +00:00
|
|
|
OS << " @[";
|
|
|
|
printDebugLoc(InlinedAtDL, OS, Ctx);
|
|
|
|
OS << "]";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-02-18 19:39:36 +00:00
|
|
|
template <> DIRef<DIDescriptor>::DIRef(const Metadata *V) : Val(V) {
|
|
|
|
assert(isDescriptorRef(V) &&
|
|
|
|
"DIDescriptorRef should be a MDString or MDNode");
|
|
|
|
}
|
2014-11-14 23:55:03 +00:00
|
|
|
template <> DIRef<DIScope>::DIRef(const Metadata *V) : Val(V) {
|
2013-11-08 08:13:15 +00:00
|
|
|
assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
|
|
|
|
}
|
2014-11-14 23:55:03 +00:00
|
|
|
template <> DIRef<DIType>::DIRef(const Metadata *V) : Val(V) {
|
2013-11-08 08:13:15 +00:00
|
|
|
assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
|
|
|
|
}
|
|
|
|
|
2015-02-18 19:39:36 +00:00
|
|
|
template <>
|
|
|
|
DIDescriptorRef DIDescriptor::getFieldAs<DIDescriptorRef>(unsigned Elt) const {
|
|
|
|
return DIDescriptorRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
|
|
|
|
}
|
2013-11-08 08:13:15 +00:00
|
|
|
template <>
|
|
|
|
DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
|
2014-11-14 23:55:03 +00:00
|
|
|
return DIScopeRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
|
|
|
template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
|
2014-11-14 23:55:03 +00:00
|
|
|
return DITypeRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
|
2013-11-08 08:13:15 +00:00
|
|
|
}
|
2013-11-22 22:06:31 +00:00
|
|
|
|
2015-03-30 21:36:43 +00:00
|
|
|
bool llvm::stripDebugInfo(Function &F) {
|
|
|
|
bool Changed = false;
|
|
|
|
for (BasicBlock &BB : F) {
|
|
|
|
for (Instruction &I : BB) {
|
|
|
|
if (I.getDebugLoc()) {
|
|
|
|
Changed = true;
|
|
|
|
I.setDebugLoc(DebugLoc());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Changed;
|
|
|
|
}
|
|
|
|
|
2013-11-22 22:06:31 +00:00
|
|
|
bool llvm::StripDebugInfo(Module &M) {
|
|
|
|
bool Changed = false;
|
|
|
|
|
|
|
|
// Remove all of the calls to the debugger intrinsics, and remove them from
|
|
|
|
// the module.
|
|
|
|
if (Function *Declare = M.getFunction("llvm.dbg.declare")) {
|
|
|
|
while (!Declare->use_empty()) {
|
2014-03-09 03:16:01 +00:00
|
|
|
CallInst *CI = cast<CallInst>(Declare->user_back());
|
2013-11-22 22:06:31 +00:00
|
|
|
CI->eraseFromParent();
|
|
|
|
}
|
|
|
|
Declare->eraseFromParent();
|
|
|
|
Changed = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (Function *DbgVal = M.getFunction("llvm.dbg.value")) {
|
|
|
|
while (!DbgVal->use_empty()) {
|
2014-03-09 03:16:01 +00:00
|
|
|
CallInst *CI = cast<CallInst>(DbgVal->user_back());
|
2013-11-22 22:06:31 +00:00
|
|
|
CI->eraseFromParent();
|
|
|
|
}
|
|
|
|
DbgVal->eraseFromParent();
|
|
|
|
Changed = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
|
|
|
|
NME = M.named_metadata_end(); NMI != NME;) {
|
|
|
|
NamedMDNode *NMD = NMI;
|
|
|
|
++NMI;
|
|
|
|
if (NMD->getName().startswith("llvm.dbg.")) {
|
|
|
|
NMD->eraseFromParent();
|
|
|
|
Changed = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-03-30 21:36:43 +00:00
|
|
|
for (Function &F : M)
|
|
|
|
Changed |= stripDebugInfo(F);
|
|
|
|
|
|
|
|
if ( GVMaterializer *Materializer = M.getMaterializer())
|
|
|
|
Materializer->setStripDebugInfo();
|
2013-11-22 22:06:31 +00:00
|
|
|
|
|
|
|
return Changed;
|
|
|
|
}
|
2013-12-02 21:29:56 +00:00
|
|
|
|
2013-12-03 00:12:14 +00:00
|
|
|
unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
|
2015-02-16 06:04:53 +00:00
|
|
|
if (auto *Val = mdconst::dyn_extract_or_null<ConstantInt>(
|
IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532. Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.
I have a follow-up patch prepared for `clang`. If this breaks other
sub-projects, I apologize in advance :(. Help me compile it on Darwin
I'll try to fix it. FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.
This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.
Here's a quick guide for updating your code:
- `Metadata` is the root of a class hierarchy with three main classes:
`MDNode`, `MDString`, and `ValueAsMetadata`. It is distinct from
the `Value` class hierarchy. It is typeless -- i.e., instances do
*not* have a `Type`.
- `MDNode`'s operands are all `Metadata *` (instead of `Value *`).
- `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.
If you're referring solely to resolved `MDNode`s -- post graph
construction -- just use `MDNode*`.
- `MDNode` (and the rest of `Metadata`) have only limited support for
`replaceAllUsesWith()`.
As long as an `MDNode` is pointing at a forward declaration -- the
result of `MDNode::getTemporary()` -- it maintains a side map of its
uses and can RAUW itself. Once the forward declarations are fully
resolved RAUW support is dropped on the ground. This means that
uniquing collisions on changing operands cause nodes to become
"distinct". (This already happened fairly commonly, whenever an
operand went to null.)
If you're constructing complex (non self-reference) `MDNode` cycles,
you need to call `MDNode::resolveCycles()` on each node (or on a
top-level node that somehow references all of the nodes). Also,
don't do that. Metadata cycles (and the RAUW machinery needed to
construct them) are expensive.
- An `MDNode` can only refer to a `Constant` through a bridge called
`ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).
As a side effect, accessing an operand of an `MDNode` that is known
to be, e.g., `ConstantInt`, takes three steps: first, cast from
`Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
third, cast down to `ConstantInt`.
The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
metadata schema owners transition away from using `Constant`s when
the type isn't important (and they don't care about referring to
`GlobalValue`s).
In the meantime, I've added transitional API to the `mdconst`
namespace that matches semantics with the old code, in order to
avoid adding the error-prone three-step equivalent to every call
site. If your old code was:
MDNode *N = foo();
bar(isa <ConstantInt>(N->getOperand(0)));
baz(cast <ConstantInt>(N->getOperand(1)));
bak(cast_or_null <ConstantInt>(N->getOperand(2)));
bat(dyn_cast <ConstantInt>(N->getOperand(3)));
bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));
you can trivially match its semantics with:
MDNode *N = foo();
bar(mdconst::hasa <ConstantInt>(N->getOperand(0)));
baz(mdconst::extract <ConstantInt>(N->getOperand(1)));
bak(mdconst::extract_or_null <ConstantInt>(N->getOperand(2)));
bat(mdconst::dyn_extract <ConstantInt>(N->getOperand(3)));
bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));
and when you transition your metadata schema to `MDInt`:
MDNode *N = foo();
bar(isa <MDInt>(N->getOperand(0)));
baz(cast <MDInt>(N->getOperand(1)));
bak(cast_or_null <MDInt>(N->getOperand(2)));
bat(dyn_cast <MDInt>(N->getOperand(3)));
bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));
- A `CallInst` -- specifically, intrinsic instructions -- can refer to
metadata through a bridge called `MetadataAsValue`. This is a
subclass of `Value` where `getType()->isMetadataTy()`.
`MetadataAsValue` is the *only* class that can legally refer to a
`LocalAsMetadata`, which is a bridged form of non-`Constant` values
like `Argument` and `Instruction`. It can also refer to any other
`Metadata` subclass.
(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
|
|
|
M.getModuleFlag("Debug Info Version")))
|
|
|
|
return Val->getZExtValue();
|
|
|
|
return 0;
|
2013-12-02 21:29:56 +00:00
|
|
|
}
|
2014-07-01 20:05:26 +00:00
|
|
|
|
2014-07-02 18:30:05 +00:00
|
|
|
llvm::DenseMap<const llvm::Function *, llvm::DISubprogram>
|
|
|
|
llvm::makeSubprogramMap(const Module &M) {
|
|
|
|
DenseMap<const Function *, DISubprogram> R;
|
2014-07-01 20:05:26 +00:00
|
|
|
|
|
|
|
NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu");
|
|
|
|
if (!CU_Nodes)
|
|
|
|
return R;
|
|
|
|
|
2014-11-11 21:30:22 +00:00
|
|
|
for (MDNode *N : CU_Nodes->operands()) {
|
|
|
|
DICompileUnit CUNode(N);
|
2014-07-01 20:05:26 +00:00
|
|
|
DIArray SPs = CUNode.getSubprograms();
|
|
|
|
for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
|
|
|
|
DISubprogram SP(SPs.getElement(i));
|
|
|
|
if (Function *F = SP.getFunction())
|
|
|
|
R.insert(std::make_pair(F, SP));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return R;
|
|
|
|
}
|