[llvm] 835c1b5 - [RemoveDIs] Auto-upgrade debug intrinsics to DbgRecords (default false) (#85650)
via llvm-commits
llvm-commits at lists.llvm.org
Tue Mar 19 06:28:46 PDT 2024
Author: Orlando Cazalet-Hyams
Date: 2024-03-19T13:28:43Z
New Revision: 835c1b56a82542d91c337e24140bd2b08a7bf715
URL: https://github.com/llvm/llvm-project/commit/835c1b56a82542d91c337e24140bd2b08a7bf715
DIFF: https://github.com/llvm/llvm-project/commit/835c1b56a82542d91c337e24140bd2b08a7bf715.diff
LOG: [RemoveDIs] Auto-upgrade debug intrinsics to DbgRecords (default false) (#85650)
If --load-bitcode-into-experimental-debuginfo-iterators is true then debug
intrinsics are auto-upgraded to DbgRecords (the new debug info format).
The upgrade is trivial because the two representations are semantically
identical. llvm.dbg.value with 4 operands and llvm.dbg.addr intrinsics are
upgraded in the same way as usual, but converted directly into DbgRecords
instead of debug intrinsics.
Added:
Modified:
llvm/lib/Bitcode/Reader/MetadataLoader.cpp
llvm/lib/IR/AutoUpgrade.cpp
llvm/test/Bitcode/DIExpression-aggresult.ll
llvm/test/Bitcode/dbg-record-roundtrip.ll
llvm/test/Bitcode/upgrade-dbg-addr.ll
Removed:
################################################################################
diff --git a/llvm/lib/Bitcode/Reader/MetadataLoader.cpp b/llvm/lib/Bitcode/Reader/MetadataLoader.cpp
index 3807320e7f17bb..fb005ee826ec20 100644
--- a/llvm/lib/Bitcode/Reader/MetadataLoader.cpp
+++ b/llvm/lib/Bitcode/Reader/MetadataLoader.cpp
@@ -609,17 +609,25 @@ class MetadataLoader::MetadataLoaderImpl {
if (!NeedDeclareExpressionUpgrade)
return;
+ auto UpdateDeclareIfNeeded = [&](auto *Declare) {
+ auto *DIExpr = Declare->getExpression();
+ if (!DIExpr || !DIExpr->startsWithDeref() ||
+ !isa_and_nonnull<Argument>(Declare->getAddress()))
+ return;
+ SmallVector<uint64_t, 8> Ops;
+ Ops.append(std::next(DIExpr->elements_begin()), DIExpr->elements_end());
+ Declare->setExpression(DIExpression::get(Context, Ops));
+ };
+
for (auto &BB : F)
- for (auto &I : BB)
+ for (auto &I : BB) {
+ for (DPValue &DPV : filterDbgVars(I.getDbgRecordRange())) {
+ if (DPV.isDbgDeclare())
+ UpdateDeclareIfNeeded(&DPV);
+ }
if (auto *DDI = dyn_cast<DbgDeclareInst>(&I))
- if (auto *DIExpr = DDI->getExpression())
- if (DIExpr->startsWithDeref() &&
- isa_and_nonnull<Argument>(DDI->getAddress())) {
- SmallVector<uint64_t, 8> Ops;
- Ops.append(std::next(DIExpr->elements_begin()),
- DIExpr->elements_end());
- DDI->setExpression(DIExpression::get(Context, Ops));
- }
+ UpdateDeclareIfNeeded(DDI);
+ }
}
/// Upgrade the expression from previous versions.
diff --git a/llvm/lib/IR/AutoUpgrade.cpp b/llvm/lib/IR/AutoUpgrade.cpp
index dbea4529456c58..c28a291c449c89 100644
--- a/llvm/lib/IR/AutoUpgrade.cpp
+++ b/llvm/lib/IR/AutoUpgrade.cpp
@@ -1056,6 +1056,18 @@ static bool upgradeIntrinsicFunction1(Function *F, Function *&NewFn) {
}
case 'd':
if (Name.consume_front("dbg.")) {
+ // Mark debug intrinsics for upgrade to new debug format.
+ if (F->getParent()->IsNewDbgInfoFormat) {
+ if (Name == "addr" || Name == "value" || Name == "assign" ||
+ Name == "declare" || Name == "label") {
+ // There's no function to replace these with.
+ NewFn = nullptr;
+ // But we do want these to get upgraded.
+ return true;
+ }
+ }
+ // Update llvm.dbg.addr intrinsics even in "new debug mode"; they'll get
+ // converted to DPValues later.
if (Name == "addr" || (Name == "value" && F->arg_size() == 4)) {
rename(F);
NewFn = Intrinsic::getDeclaration(F->getParent(), Intrinsic::dbg_value);
@@ -2332,6 +2344,59 @@ static Value *upgradeAMDGCNIntrinsicCall(StringRef Name, CallBase *CI,
llvm_unreachable("Unknown function for AMDGPU intrinsic upgrade.");
}
+/// Helper to unwrap intrinsic call MetadataAsValue operands.
+template <typename MDType>
+static MDType *unwrapMAVOp(CallBase *CI, unsigned Op) {
+ if (MetadataAsValue *MAV = dyn_cast<MetadataAsValue>(CI->getArgOperand(Op)))
+ return dyn_cast<MDType>(MAV->getMetadata());
+ return nullptr;
+}
+
+/// Convert debug intrinsic calls to non-instruction debug records.
+/// \p Name - Final part of the intrinsic name, e.g. 'value' in llvm.dbg.value.
+/// \p CI - The debug intrinsic call.
+static void upgradeDbgIntrinsicToDbgRecord(StringRef Name, CallBase *CI) {
+ DbgRecord *DR = nullptr;
+ if (Name == "label") {
+ DR = new DPLabel(unwrapMAVOp<DILabel>(CI, 0), CI->getDebugLoc());
+ } else if (Name == "assign") {
+ DR = new DPValue(
+ unwrapMAVOp<Metadata>(CI, 0), unwrapMAVOp<DILocalVariable>(CI, 1),
+ unwrapMAVOp<DIExpression>(CI, 2), unwrapMAVOp<DIAssignID>(CI, 3),
+ unwrapMAVOp<Metadata>(CI, 4), unwrapMAVOp<DIExpression>(CI, 5),
+ CI->getDebugLoc());
+ } else if (Name == "declare") {
+ DR = new DPValue(unwrapMAVOp<Metadata>(CI, 0),
+ unwrapMAVOp<DILocalVariable>(CI, 1),
+ unwrapMAVOp<DIExpression>(CI, 2), CI->getDebugLoc(),
+ DPValue::LocationType::Declare);
+ } else if (Name == "addr") {
+ // Upgrade dbg.addr to dbg.value with DW_OP_deref.
+ DIExpression *Expr = unwrapMAVOp<DIExpression>(CI, 2);
+ Expr = DIExpression::append(Expr, dwarf::DW_OP_deref);
+ DR = new DPValue(unwrapMAVOp<Metadata>(CI, 0),
+ unwrapMAVOp<DILocalVariable>(CI, 1), Expr,
+ CI->getDebugLoc());
+ } else if (Name == "value") {
+ // An old version of dbg.value had an extra offset argument.
+ unsigned VarOp = 1;
+ unsigned ExprOp = 2;
+ if (CI->arg_size() == 4) {
+ auto *Offset = dyn_cast_or_null<Constant>(CI->getArgOperand(1));
+ // Nonzero offset dbg.values get dropped without a replacement.
+ if (!Offset || !Offset->isZeroValue())
+ return;
+ VarOp = 2;
+ ExprOp = 3;
+ }
+ DR = new DPValue(unwrapMAVOp<Metadata>(CI, 0),
+ unwrapMAVOp<DILocalVariable>(CI, VarOp),
+ unwrapMAVOp<DIExpression>(CI, ExprOp), CI->getDebugLoc());
+ }
+ assert(DR && "Unhandled intrinsic kind in upgrade to DbgRecord");
+ CI->getParent()->insertDbgRecordBefore(DR, CI->getIterator());
+}
+
/// Upgrade a call to an old intrinsic. All argument and return casting must be
/// provided to seamlessly integrate with existing context.
void llvm::UpgradeIntrinsicCall(CallBase *CI, Function *NewFn) {
@@ -2357,6 +2422,7 @@ void llvm::UpgradeIntrinsicCall(CallBase *CI, Function *NewFn) {
bool IsNVVM = Name.consume_front("nvvm.");
bool IsARM = Name.consume_front("arm.");
bool IsAMDGCN = Name.consume_front("amdgcn.");
+ bool IsDbg = Name.consume_front("dbg.");
if (IsX86 && Name.starts_with("sse4a.movnt.")) {
SmallVector<Metadata *, 1> Elts;
@@ -2461,7 +2527,7 @@ void llvm::UpgradeIntrinsicCall(CallBase *CI, Function *NewFn) {
return;
}
- Value *Rep;
+ Value *Rep = nullptr;
// Upgrade packed integer vector compare intrinsics to compare instructions.
if (IsX86 && (Name.starts_with("sse2.pcmp") ||
Name.starts_with("avx2.pcmp"))) {
@@ -4196,6 +4262,8 @@ void llvm::UpgradeIntrinsicCall(CallBase *CI, Function *NewFn) {
Rep = upgradeARMIntrinsicCall(Name, CI, F, Builder);
} else if (IsAMDGCN) {
Rep = upgradeAMDGCNIntrinsicCall(Name, CI, F, Builder);
+ } else if (IsDbg && CI->getModule()->IsNewDbgInfoFormat) {
+ upgradeDbgIntrinsicToDbgRecord(Name, CI);
} else {
llvm_unreachable("Unknown function for CallBase upgrade.");
}
diff --git a/llvm/test/Bitcode/DIExpression-aggresult.ll b/llvm/test/Bitcode/DIExpression-aggresult.ll
index 0b89454aa2f942..017218277d02bf 100644
--- a/llvm/test/Bitcode/DIExpression-aggresult.ll
+++ b/llvm/test/Bitcode/DIExpression-aggresult.ll
@@ -1,4 +1,5 @@
; RUN: llvm-dis -o - %s.bc | FileCheck %s
+; RUN: llvm-dis -o - %s.bc --load-bitcode-into-experimental-debuginfo-iterators=true | FileCheck %s
%class.A = type { i32, i32, i32, i32 }
define void @_Z3fooi(%class.A* sret(%class.A) %agg.result) #0 !dbg !3 {
diff --git a/llvm/test/Bitcode/dbg-record-roundtrip.ll b/llvm/test/Bitcode/dbg-record-roundtrip.ll
index 251c3d9f4bb7e0..bd347cac720677 100644
--- a/llvm/test/Bitcode/dbg-record-roundtrip.ll
+++ b/llvm/test/Bitcode/dbg-record-roundtrip.ll
@@ -10,6 +10,11 @@
; RUN: | llvm-dis --load-bitcode-into-experimental-debuginfo-iterators=true --write-experimental-debuginfo=true \
; RUN: | FileCheck %s --check-prefixes=RECORDS
+;; Load intrinsics directly into the new format (auto-upgrade).
+; RUN: llvm-as --write-experimental-debuginfo-iterators-to-bitcode=false %s -o - \
+; RUN: | llvm-dis --load-bitcode-into-experimental-debuginfo-iterators=true --write-experimental-debuginfo=true \
+; RUN: | FileCheck %s --check-prefixes=RECORDS
+
;; Check that verify-uselistorder passes regardless of input format.
; RUN: llvm-as %s --write-experimental-debuginfo-iterators-to-bitcode=true -o - | verify-uselistorder
; RUN: verify-uselistorder %s
diff --git a/llvm/test/Bitcode/upgrade-dbg-addr.ll b/llvm/test/Bitcode/upgrade-dbg-addr.ll
index 40fd7db18948b5..06a411c2c83486 100644
--- a/llvm/test/Bitcode/upgrade-dbg-addr.ll
+++ b/llvm/test/Bitcode/upgrade-dbg-addr.ll
@@ -1,6 +1,7 @@
; Test upgrade of dbg.addr intrinsics into dbg.value with DW_OP_deref appended
;
; RUN: llvm-dis < %s.bc | FileCheck %s
+; RUN: llvm-dis < %s.bc --load-bitcode-into-experimental-debuginfo-iterators --write-experimental-debuginfo=false | FileCheck %s
; RUN: verify-uselistorder < %s.bc
define i32 @example(i32 %num) {
More information about the llvm-commits
mailing list