[llvm] [RemoveDIs][DebugInfo][NFC] Add Instruction and convenience functions to DPValue (PR #77896)
Stephen Tozer via llvm-commits
llvm-commits at lists.llvm.org
Fri Jan 12 13:24:43 PST 2024
https://github.com/SLTozer updated https://github.com/llvm/llvm-project/pull/77896
>From ddc5bc56b6e77abf193c51c5ca4a0bbe9cfd60a1 Mon Sep 17 00:00:00 2001
From: Stephen Tozer <Stephen.Tozer at Sony.com>
Date: Tue, 2 Jan 2024 18:29:04 +0000
Subject: [PATCH 1/3] Update DPValue interface with some helpful functions
---
.../include/llvm/IR/DebugProgramInstruction.h | 46 +++++++++++
llvm/lib/IR/DebugProgramInstruction.cpp | 76 +++++++++++++++++++
2 files changed, 122 insertions(+)
diff --git a/llvm/include/llvm/IR/DebugProgramInstruction.h b/llvm/include/llvm/IR/DebugProgramInstruction.h
index 8230070343e0c1..0001b1a7ca0f06 100644
--- a/llvm/include/llvm/IR/DebugProgramInstruction.h
+++ b/llvm/include/llvm/IR/DebugProgramInstruction.h
@@ -91,6 +91,9 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
void removeFromParent();
void eraseFromParent();
+ DPValue *getNextNode() { return &*(++getIterator()); }
+ DPValue *getPrevNode() { return &*(--getIterator()); }
+
using self_iterator = simple_ilist<DPValue>::iterator;
using const_self_iterator = simple_ilist<DPValue>::const_iterator;
@@ -118,6 +121,16 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
DPValue(Metadata *Location, DILocalVariable *DV, DIExpression *Expr,
const DILocation *DI, LocationType Type = LocationType::Value);
+ static DPValue *createDPValue(Value *Location, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ Instruction *InsertBefore = nullptr);
+ static DPValue *createDPValue(Value *Location, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ DPValue *InsertBefore);
+ static DPValue *createDPDeclare(Value *Address, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ Instruction *InsertBefore = nullptr);
+
/// Iterator for ValueAsMetadata that internally uses direct pointer iteration
/// over either a ValueAsMetadata* or a ValueAsMetadata**, dereferencing to the
/// ValueAsMetadata .
@@ -166,6 +179,9 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
}
};
+ bool isDbgDeclare() { return Type == LocationType::Declare; }
+ bool isDbgValue() { return Type == LocationType::Value; }
+
/// Get the locations corresponding to the variable referenced by the debug
/// info intrinsic. Depending on the intrinsic, this could be the
/// variable's value or its address.
@@ -209,6 +225,10 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
Metadata *getRawLocation() const { return DebugValue; }
+ Value *getValue(unsigned OpIdx = 0) const {
+ return getVariableLocationOp(OpIdx);
+ }
+
/// Use of this should generally be avoided; instead,
/// replaceVariableLocationOp and addVariableLocationOps should be used where
/// possible to avoid creating invalid state.
@@ -224,6 +244,19 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
/// is described.
std::optional<uint64_t> getFragmentSizeInBits() const;
+ bool isEquivalentTo(const DPValue &Other) {
+ return std::tie(Type, DebugValue, Variable, Expression, DbgLoc) ==
+ std::tie(Other.Type, Other.DebugValue, Other.Variable,
+ Other.Expression, Other.DbgLoc);
+ }
+ // Matches the definition of the Instruction version, equivalent to above but
+ // without checking DbgLoc.
+ bool isIdenticalToWhenDefined(const DPValue &Other) {
+ return std::tie(Type, DebugValue, Variable, Expression) ==
+ std::tie(Other.Type, Other.DebugValue, Other.Variable,
+ Other.Expression);
+ }
+
DPValue *clone() const;
/// Convert this DPValue back into a dbg.value intrinsic.
/// \p InsertBefore Optional position to insert this intrinsic.
@@ -251,6 +284,13 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
LLVMContext &getContext();
const LLVMContext &getContext() const;
+ /// Insert this DPValue prior to \p InsertBefore. Must not be called if this
+ /// is already contained in a DPMarker.
+ void insertBefore(DPValue *InsertBefore);
+ void insertAfter(DPValue *InsertAfter);
+ void moveBefore(DPValue *MoveBefore);
+ void moveAfter(DPValue *MoveAfter);
+
void print(raw_ostream &O, bool IsForDebug = false) const;
void print(raw_ostream &ROS, ModuleSlotTracker &MST, bool IsForDebug) const;
};
@@ -309,6 +349,8 @@ class DPMarker {
/// Produce a range over all the DPValues in this Marker.
iterator_range<simple_ilist<DPValue>::iterator> getDbgValueRange();
+ iterator_range<simple_ilist<DPValue>::const_iterator>
+ getDbgValueRange() const;
/// Transfer any DPValues from \p Src into this DPMarker. If \p InsertAtHead
/// is true, place them before existing DPValues, otherwise afterwards.
void absorbDebugValues(DPMarker &Src, bool InsertAtHead);
@@ -320,6 +362,10 @@ class DPMarker {
/// Insert a DPValue into this DPMarker, at the end of the list. If
/// \p InsertAtHead is true, at the start.
void insertDPValue(DPValue *New, bool InsertAtHead);
+ /// Insert a DPValue prior to a DPValue contained within this marker.
+ void insertDPValue(DPValue *New, DPValue *InsertBefore);
+ /// Insert a DPValue after a DPValue contained within this marker.
+ void insertDPValueAfter(DPValue *New, DPValue *InsertAfter);
/// Clone all DPMarkers from \p From into this marker. There are numerous
/// options to customise the source/destination, due to gnarliness, see class
/// comment.
diff --git a/llvm/lib/IR/DebugProgramInstruction.cpp b/llvm/lib/IR/DebugProgramInstruction.cpp
index 7b709a2de0335f..8a16dd1acd9d6c 100644
--- a/llvm/lib/IR/DebugProgramInstruction.cpp
+++ b/llvm/lib/IR/DebugProgramInstruction.cpp
@@ -41,6 +41,36 @@ DPValue::DPValue(Metadata *Location, DILocalVariable *DV, DIExpression *Expr,
void DPValue::deleteInstr() { delete this; }
+DPValue *DPValue::createDPValue(Value *Location, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ Instruction *InsertBefore) {
+ auto *NewDPValue = new DPValue(ValueAsMetadata::get(Location), DV, Expr, DI,
+ LocationType::Value);
+ if (InsertBefore)
+ InsertBefore->getParent()->insertDPValueBefore(NewDPValue,
+ InsertBefore->getIterator());
+ return NewDPValue;
+}
+DPValue *DPValue::createDPValue(Value *Location, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ DPValue *InsertBefore) {
+ auto *NewDPValue = new DPValue(ValueAsMetadata::get(Location), DV, Expr, DI,
+ LocationType::Value);
+ if (InsertBefore)
+ NewDPValue->insertBefore(InsertBefore);
+ return NewDPValue;
+}
+DPValue *DPValue::createDPDeclare(Value *Address, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ Instruction *InsertBefore) {
+ auto *NewDPDeclare = new DPValue(ValueAsMetadata::get(Address), DV, Expr, DI,
+ LocationType::Declare);
+ if (InsertBefore)
+ InsertBefore->getParent()->insertDPValueBefore(NewDPDeclare,
+ InsertBefore->getIterator());
+ return NewDPDeclare;
+}
+
iterator_range<DPValue::location_op_iterator> DPValue::location_ops() const {
auto *MD = getRawLocation();
// If a Value has been deleted, the "location" for this DPValue will be
@@ -249,6 +279,35 @@ const LLVMContext &DPValue::getContext() const {
return getBlock()->getContext();
}
+void DPValue::insertBefore(DPValue *InsertBefore) {
+ assert(!getMarker() &&
+ "Cannot insert a DPValue that is already has a DPMarker!");
+ assert(InsertBefore->getMarker() &&
+ "Cannot insert a DPValue before a DPValue that does not have a "
+ "DPMarker!");
+ InsertBefore->getMarker()->insertDPValue(this, InsertBefore);
+}
+void DPValue::insertAfter(DPValue *InsertAfter) {
+ assert(!getMarker() &&
+ "Cannot insert a DPValue that is already has a DPMarker!");
+ assert(InsertAfter->getMarker() &&
+ "Cannot insert a DPValue after a DPValue that does not have a "
+ "DPMarker!");
+ InsertAfter->getMarker()->insertDPValueAfter(this, InsertAfter);
+}
+void DPValue::moveBefore(DPValue *MoveBefore) {
+ assert(getMarker() &&
+ "Canot move a DPValue that does not currently have a DPMarker!");
+ removeFromParent();
+ insertBefore(MoveBefore);
+}
+void DPValue::moveAfter(DPValue *MoveAfter) {
+ assert(getMarker() &&
+ "Canot move a DPValue that does not currently have a DPMarker!");
+ removeFromParent();
+ insertAfter(MoveAfter);
+}
+
///////////////////////////////////////////////////////////////////////////////
// An empty, global, DPMarker for the purpose of describing empty ranges of
@@ -313,9 +372,14 @@ void DPMarker::eraseFromParent() {
iterator_range<DPValue::self_iterator> DPMarker::getDbgValueRange() {
return make_range(StoredDPValues.begin(), StoredDPValues.end());
}
+iterator_range<DPValue::const_self_iterator>
+DPMarker::getDbgValueRange() const {
+ return make_range(StoredDPValues.begin(), StoredDPValues.end());
+}
void DPValue::removeFromParent() {
getMarker()->StoredDPValues.erase(getIterator());
+ Marker = nullptr;
}
void DPValue::eraseFromParent() {
@@ -328,6 +392,18 @@ void DPMarker::insertDPValue(DPValue *New, bool InsertAtHead) {
StoredDPValues.insert(It, *New);
New->setMarker(this);
}
+void DPMarker::insertDPValue(DPValue *New, DPValue *InsertBefore) {
+ assert(InsertBefore->getMarker() == this &&
+ "DPValue 'InsertBefore' must be contained in this DPMarker!");
+ StoredDPValues.insert(InsertBefore->getIterator(), *New);
+ New->setMarker(this);
+}
+void DPMarker::insertDPValueAfter(DPValue *New, DPValue *InsertAfter) {
+ assert(InsertAfter->getMarker() == this &&
+ "DPValue 'InsertAfter' must be contained in this DPMarker!");
+ StoredDPValues.insert(++(InsertAfter->getIterator()), *New);
+ New->setMarker(this);
+}
void DPMarker::absorbDebugValues(DPMarker &Src, bool InsertAtHead) {
auto It = InsertAtHead ? StoredDPValues.begin() : StoredDPValues.end();
>From c4f4909daca42a7fc643694290db7445db87d0ba Mon Sep 17 00:00:00 2001
From: Stephen Tozer <Stephen.Tozer at Sony.com>
Date: Fri, 12 Jan 2024 16:59:04 +0000
Subject: [PATCH 2/3] Update createDPV, impl missing overloads, address
comments
---
.../include/llvm/IR/DebugProgramInstruction.h | 15 ++++---
llvm/lib/IR/DebugProgramInstruction.cpp | 42 +++++++++----------
2 files changed, 29 insertions(+), 28 deletions(-)
diff --git a/llvm/include/llvm/IR/DebugProgramInstruction.h b/llvm/include/llvm/IR/DebugProgramInstruction.h
index 0001b1a7ca0f06..66a9e36ae617b7 100644
--- a/llvm/include/llvm/IR/DebugProgramInstruction.h
+++ b/llvm/include/llvm/IR/DebugProgramInstruction.h
@@ -51,6 +51,8 @@
#include "llvm/ADT/ilist.h"
#include "llvm/ADT/iterator.h"
#include "llvm/IR/DebugLoc.h"
+#include "llvm/IR/Instruction.h"
+#include "llvm/IR/SymbolTableListTraits.h"
namespace llvm {
@@ -122,14 +124,15 @@ class DPValue : public ilist_node<DPValue>, private DebugValueUser {
const DILocation *DI, LocationType Type = LocationType::Value);
static DPValue *createDPValue(Value *Location, DILocalVariable *DV,
- DIExpression *Expr, const DILocation *DI,
- Instruction *InsertBefore = nullptr);
+ DIExpression *Expr, const DILocation *DI);
static DPValue *createDPValue(Value *Location, DILocalVariable *DV,
DIExpression *Expr, const DILocation *DI,
- DPValue *InsertBefore);
- static DPValue *createDPDeclare(Value *Address, DILocalVariable *DV,
- DIExpression *Expr, const DILocation *DI,
- Instruction *InsertBefore = nullptr);
+ DPValue &InsertBefore);
+ static DPValue *createDPVDeclare(Value *Address, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI);
+ static DPValue *createDPVDeclare(Value *Address, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ DPValue &InsertBefore);
/// Iterator for ValueAsMetadata that internally uses direct pointer iteration
/// over either a ValueAsMetadata* or a ValueAsMetadata**, dereferencing to the
diff --git a/llvm/lib/IR/DebugProgramInstruction.cpp b/llvm/lib/IR/DebugProgramInstruction.cpp
index 8a16dd1acd9d6c..11ac118de389de 100644
--- a/llvm/lib/IR/DebugProgramInstruction.cpp
+++ b/llvm/lib/IR/DebugProgramInstruction.cpp
@@ -42,33 +42,31 @@ DPValue::DPValue(Metadata *Location, DILocalVariable *DV, DIExpression *Expr,
void DPValue::deleteInstr() { delete this; }
DPValue *DPValue::createDPValue(Value *Location, DILocalVariable *DV,
- DIExpression *Expr, const DILocation *DI,
- Instruction *InsertBefore) {
- auto *NewDPValue = new DPValue(ValueAsMetadata::get(Location), DV, Expr, DI,
- LocationType::Value);
- if (InsertBefore)
- InsertBefore->getParent()->insertDPValueBefore(NewDPValue,
- InsertBefore->getIterator());
- return NewDPValue;
+ DIExpression *Expr, const DILocation *DI) {
+ return new DPValue(ValueAsMetadata::get(Location), DV, Expr, DI,
+ LocationType::Value);
}
+
DPValue *DPValue::createDPValue(Value *Location, DILocalVariable *DV,
DIExpression *Expr, const DILocation *DI,
- DPValue *InsertBefore) {
- auto *NewDPValue = new DPValue(ValueAsMetadata::get(Location), DV, Expr, DI,
- LocationType::Value);
- if (InsertBefore)
- NewDPValue->insertBefore(InsertBefore);
+ DPValue &InsertBefore) {
+ auto *NewDPValue = createDPValue(Location, DV, Expr, DI);
+ NewDPValue->insertBefore(&InsertBefore);
return NewDPValue;
}
-DPValue *DPValue::createDPDeclare(Value *Address, DILocalVariable *DV,
- DIExpression *Expr, const DILocation *DI,
- Instruction *InsertBefore) {
- auto *NewDPDeclare = new DPValue(ValueAsMetadata::get(Address), DV, Expr, DI,
- LocationType::Declare);
- if (InsertBefore)
- InsertBefore->getParent()->insertDPValueBefore(NewDPDeclare,
- InsertBefore->getIterator());
- return NewDPDeclare;
+
+DPValue *DPValue::createDPVDeclare(Value *Address, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI) {
+ return new DPValue(ValueAsMetadata::get(Address), DV, Expr, DI,
+ LocationType::Declare);
+}
+
+DPValue *DPValue::createDPVDeclare(Value *Address, DILocalVariable *DV,
+ DIExpression *Expr, const DILocation *DI,
+ DPValue &InsertBefore) {
+ auto *NewDPVDeclare = createDPVDeclare(Address, DV, Expr, DI);
+ NewDPVDeclare->insertBefore(&InsertBefore);
+ return NewDPVDeclare;
}
iterator_range<DPValue::location_op_iterator> DPValue::location_ops() const {
>From 98b60b0f0dfa3b7127847f1f0e46d2370bc826c7 Mon Sep 17 00:00:00 2001
From: Stephen Tozer <Stephen.Tozer at Sony.com>
Date: Fri, 12 Jan 2024 21:22:17 +0000
Subject: [PATCH 3/3] Clang format
---
llvm/include/llvm/IR/DebugProgramInstruction.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/llvm/include/llvm/IR/DebugProgramInstruction.h b/llvm/include/llvm/IR/DebugProgramInstruction.h
index 66a9e36ae617b7..95642c2f2d04b8 100644
--- a/llvm/include/llvm/IR/DebugProgramInstruction.h
+++ b/llvm/include/llvm/IR/DebugProgramInstruction.h
@@ -47,8 +47,8 @@
#ifndef LLVM_IR_DEBUGPROGRAMINSTRUCTION_H
#define LLVM_IR_DEBUGPROGRAMINSTRUCTION_H
-#include "llvm/ADT/ilist_node.h"
#include "llvm/ADT/ilist.h"
+#include "llvm/ADT/ilist_node.h"
#include "llvm/ADT/iterator.h"
#include "llvm/IR/DebugLoc.h"
#include "llvm/IR/Instruction.h"
More information about the llvm-commits
mailing list