[CodeGen][NPM] Port LiveDebugValues to NPM #131563

optimisan · 2025-03-17T05:15:43Z

No description provided.

optimisan · 2025-03-17T05:16:02Z

[CodeGen][NPM] Port LiveDebugValues to NPM #131563 👈 (View in Graphite)
[LiveDebugValues][NFC] Remove TargetPassConfig from LDVImpl #131562
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

llvmbot · 2025-03-17T05:16:42Z

@llvm/pr-subscribers-backend-arm

@llvm/pr-subscribers-debuginfo

Author: Akshat Oke (optimisan)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/131563.diff

6 Files Affected:

(modified) llvm/include/llvm/InitializePasses.h (+1-1)
(modified) llvm/include/llvm/Passes/CodeGenPassBuilder.h (+2-1)
(modified) llvm/include/llvm/Passes/MachinePassRegistry.def (+12-1)
(modified) llvm/lib/CodeGen/CodeGen.cpp (+1-1)
(modified) llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp (+41-15)
(modified) llvm/lib/Passes/PassBuilder.cpp (+1)

diff --git a/llvm/include/llvm/InitializePasses.h b/llvm/include/llvm/InitializePasses.h
index 36be3d552f556..06fd686a4a43d 100644
--- a/llvm/include/llvm/InitializePasses.h
+++ b/llvm/include/llvm/InitializePasses.h
@@ -153,7 +153,7 @@ void initializeLegacyLICMPassPass(PassRegistry &);
 void initializeLegalizerPass(PassRegistry &);
 void initializeGISelCSEAnalysisWrapperPassPass(PassRegistry &);
 void initializeGISelKnownBitsAnalysisPass(PassRegistry &);
-void initializeLiveDebugValuesPass(PassRegistry &);
+void initializeLiveDebugValuesLegacyPass(PassRegistry &);
 void initializeLiveDebugVariablesWrapperLegacyPass(PassRegistry &);
 void initializeLiveIntervalsWrapperPassPass(PassRegistry &);
 void initializeLiveRangeShrinkPass(PassRegistry &);
diff --git a/llvm/include/llvm/Passes/CodeGenPassBuilder.h b/llvm/include/llvm/Passes/CodeGenPassBuilder.h
index 90a0cdf803560..c580f5a3eb3e9 100644
--- a/llvm/include/llvm/Passes/CodeGenPassBuilder.h
+++ b/llvm/include/llvm/Passes/CodeGenPassBuilder.h
@@ -43,6 +43,7 @@
 #include "llvm/CodeGen/InterleavedAccess.h"
 #include "llvm/CodeGen/InterleavedLoadCombine.h"
 #include "llvm/CodeGen/JMCInstrumenter.h"
+#include "llvm/CodeGen/LiveDebugValuesPass.h"
 #include "llvm/CodeGen/LiveIntervals.h"
 #include "llvm/CodeGen/LocalStackSlotAllocation.h"
 #include "llvm/CodeGen/LowerEmuTLS.h"
@@ -999,7 +1000,7 @@ Error CodeGenPassBuilder<Derived, TargetMachineT>::addMachinePasses(
   addPass(FuncletLayoutPass());
 
   addPass(StackMapLivenessPass());
-  addPass(LiveDebugValuesPass());
+  addPass(LiveDebugValuesPass(getTM<TargetMachine>().Options.ShouldEmitDebugEntryValues()));
   addPass(MachineSanitizerBinaryMetadata());
 
   if (TM.Options.EnableMachineOutliner &&
diff --git a/llvm/include/llvm/Passes/MachinePassRegistry.def b/llvm/include/llvm/Passes/MachinePassRegistry.def
index ebfdaf82169d8..77d9c41864424 100644
--- a/llvm/include/llvm/Passes/MachinePassRegistry.def
+++ b/llvm/include/llvm/Passes/MachinePassRegistry.def
@@ -195,6 +195,18 @@ MACHINE_FUNCTION_PASS("verify<machine-trace-metrics>", MachineTraceMetricsVerifi
 #define MACHINE_FUNCTION_PASS_WITH_PARAMS(NAME, CLASS, CREATE_PASS, PARSER,    \
                                           PARAMS)
 #endif
+
+MACHINE_FUNCTION_PASS_WITH_PARAMS(
+    "live-debug-values", "LiveDebugValuesPass",
+    [](bool ShouldEmitDebugEntryValues) {
+      return LiveDebugValuesPass(ShouldEmitDebugEntryValues);
+    },
+    [](StringRef Params) {
+      return parseSinglePassOption(Params, "emit-debug-entry-values",
+                                   "LiveDebugValuesPass");
+    },
+    "emit-debug-entry-values")
+
 MACHINE_FUNCTION_PASS_WITH_PARAMS(
     "machine-sink", "MachineSinkingPass",
     [](bool EnableSinkAndFold) {
@@ -262,7 +274,6 @@ DUMMY_MACHINE_FUNCTION_PASS("instruction-select", InstructionSelectPass)
 DUMMY_MACHINE_FUNCTION_PASS("irtranslator", IRTranslatorPass)
 DUMMY_MACHINE_FUNCTION_PASS("kcfi", MachineKCFIPass)
 DUMMY_MACHINE_FUNCTION_PASS("legalizer", LegalizerPass)
-DUMMY_MACHINE_FUNCTION_PASS("livedebugvalues", LiveDebugValuesPass)
 DUMMY_MACHINE_FUNCTION_PASS("lrshrink", LiveRangeShrinkPass)
 DUMMY_MACHINE_FUNCTION_PASS("machine-combiner", MachineCombinerPass)
 DUMMY_MACHINE_FUNCTION_PASS("static-data-splitter", StaticDataSplitter)
diff --git a/llvm/lib/CodeGen/CodeGen.cpp b/llvm/lib/CodeGen/CodeGen.cpp
index b36d2f743d512..94ce0a072f91f 100644
--- a/llvm/lib/CodeGen/CodeGen.cpp
+++ b/llvm/lib/CodeGen/CodeGen.cpp
@@ -58,7 +58,7 @@ void llvm::initializeCodeGen(PassRegistry &Registry) {
   initializeInterleavedLoadCombinePass(Registry);
   initializeInterleavedAccessPass(Registry);
   initializeJMCInstrumenterPass(Registry);
-  initializeLiveDebugValuesPass(Registry);
+  initializeLiveDebugValuesLegacyPass(Registry);
   initializeLiveDebugVariablesWrapperLegacyPass(Registry);
   initializeLiveIntervalsWrapperPassPass(Registry);
   initializeLiveRangeShrinkPass(Registry);
diff --git a/llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp b/llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp
index 484143a03fca1..585eff9a8417a 100644
--- a/llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp
+++ b/llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp
@@ -8,6 +8,7 @@
 
 #include "LiveDebugValues.h"
 
+#include "llvm/CodeGen/LiveDebugValuesPass.h"
 #include "llvm/CodeGen/MachineDominators.h"
 #include "llvm/CodeGen/MachineFunction.h"
 #include "llvm/CodeGen/MachineFunctionPass.h"
@@ -63,12 +64,12 @@ namespace {
 /// Generic LiveDebugValues pass. Calls through to VarLocBasedLDV or
 /// InstrRefBasedLDV to perform location propagation, via the LDVImpl
 /// base class.
-class LiveDebugValues : public MachineFunctionPass {
+class LiveDebugValuesLegacy : public MachineFunctionPass {
 public:
   static char ID;
 
-  LiveDebugValues();
-  ~LiveDebugValues() = default;
+  LiveDebugValuesLegacy();
+  ~LiveDebugValuesLegacy() = default;
 
   /// Calculate the liveness information for the given machine function.
   bool runOnMachineFunction(MachineFunction &MF) override;
@@ -77,36 +78,63 @@ class LiveDebugValues : public MachineFunctionPass {
     AU.setPreservesCFG();
     MachineFunctionPass::getAnalysisUsage(AU);
   }
+};
 
+struct LiveDebugValues {
+  LiveDebugValues();
+  ~LiveDebugValues() = default;
+  bool run(MachineFunction &MF, bool ShouldEmitDebugEntryValues);
 private:
   std::unique_ptr<LDVImpl> InstrRefImpl;
   std::unique_ptr<LDVImpl> VarLocImpl;
-  TargetPassConfig *TPC = nullptr;
   MachineDominatorTree MDT;
 };
 } // namespace
 
-char LiveDebugValues::ID = 0;
+char LiveDebugValuesLegacy::ID = 0;
 
-char &llvm::LiveDebugValuesID = LiveDebugValues::ID;
+char &llvm::LiveDebugValuesID = LiveDebugValuesLegacy::ID;
 
-INITIALIZE_PASS(LiveDebugValues, DEBUG_TYPE, "Live DEBUG_VALUE analysis", false,
+INITIALIZE_PASS(LiveDebugValuesLegacy, DEBUG_TYPE, "Live DEBUG_VALUE analysis", false,
                 false)
 
 /// Default construct and initialize the pass.
-LiveDebugValues::LiveDebugValues() : MachineFunctionPass(ID) {
-  initializeLiveDebugValuesPass(*PassRegistry::getPassRegistry());
+LiveDebugValuesLegacy::LiveDebugValuesLegacy() : MachineFunctionPass(ID) {
+  initializeLiveDebugValuesLegacyPass(*PassRegistry::getPassRegistry());
+}
+
+LiveDebugValues::LiveDebugValues() {
   InstrRefImpl =
       std::unique_ptr<LDVImpl>(llvm::makeInstrRefBasedLiveDebugValues());
   VarLocImpl = std::unique_ptr<LDVImpl>(llvm::makeVarLocBasedLiveDebugValues());
 }
 
-bool LiveDebugValues::runOnMachineFunction(MachineFunction &MF) {
+PreservedAnalyses LiveDebugValuesPass::run(MachineFunction &MF,
+                                           MachineFunctionAnalysisManager &MFAM) {
+  if(!LiveDebugValues().run(MF, ShouldEmitDebugEntryValues))
+    return PreservedAnalyses::all();
+  auto PA = getMachineFunctionPassPreservedAnalyses();
+  PA.preserveSet<CFGAnalyses>();
+  return PA;
+}
+
+void LiveDebugValuesPass::printPipeline(raw_ostream &OS, function_ref<StringRef(StringRef)> MapClassName2PassName){
+  OS << MapClassName2PassName(name());
+  if (ShouldEmitDebugEntryValues)
+    OS << "<emit-debug-entry-values>";
+}
+
+bool LiveDebugValuesLegacy::runOnMachineFunction(MachineFunction &MF) {
+  auto *TPC = getAnalysisIfAvailable<TargetPassConfig>();
+  assert(TPC && "TargetPassConfig must be available");
+  return LiveDebugValues().run(MF, TPC->getTM<TargetMachine>().Options.ShouldEmitDebugEntryValues());
+}
+
+bool LiveDebugValues::run(MachineFunction &MF, bool ShouldEmitDebugEntryValues) {
   bool InstrRefBased = MF.useDebugInstrRef();
   // Allow the user to force selection of InstrRef LDV.
   InstrRefBased |= ForceInstrRefLDV;
 
-  TPC = getAnalysisIfAvailable<TargetPassConfig>();
   LDVImpl *TheImpl = &*VarLocImpl;
 
   MachineDominatorTree *DomTree = nullptr;
@@ -116,10 +144,8 @@ bool LiveDebugValues::runOnMachineFunction(MachineFunction &MF) {
     TheImpl = &*InstrRefImpl;
   }
 
-  return TheImpl->ExtendRanges(
-      MF, DomTree,
-      TPC->getTM<TargetMachine>().Options.ShouldEmitDebugEntryValues(),
-      InputBBLimit, InputDbgValueLimit);
+  return TheImpl->ExtendRanges(MF, DomTree, ShouldEmitDebugEntryValues,
+                               InputBBLimit, InputDbgValueLimit);
 }
 
 bool llvm::debuginfoShouldUseDebugInstrRef(const Triple &T) {
diff --git a/llvm/lib/Passes/PassBuilder.cpp b/llvm/lib/Passes/PassBuilder.cpp
index 2e62d6e6f4cc6..648d853b03016 100644
--- a/llvm/lib/Passes/PassBuilder.cpp
+++ b/llvm/lib/Passes/PassBuilder.cpp
@@ -102,6 +102,7 @@
 #include "llvm/CodeGen/InterleavedAccess.h"
 #include "llvm/CodeGen/InterleavedLoadCombine.h"
 #include "llvm/CodeGen/JMCInstrumenter.h"
+#include "llvm/CodeGen/LiveDebugValuesPass.h"
 #include "llvm/CodeGen/LiveDebugVariables.h"
 #include "llvm/CodeGen/LiveIntervals.h"
 #include "llvm/CodeGen/LiveRegMatrix.h"

github-actions · 2025-03-17T05:19:07Z

✅ With the latest revision this PR passed the C/C++ code formatter.

arsenm · 2025-03-17T05:23:50Z

llvm/lib/Passes/PassBuilder.cpp

@@ -102,6 +102,7 @@
 #include "llvm/CodeGen/InterleavedAccess.h"
 #include "llvm/CodeGen/InterleavedLoadCombine.h"
 #include "llvm/CodeGen/JMCInstrumenter.h"
+#include "llvm/CodeGen/LiveDebugValuesPass.h"


Dead include?

whoops forgot to add the new header file again. (updated now)

llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp

llvm/include/llvm/CodeGen/LiveDebugValuesPass.h

arsenm · 2025-03-17T11:00:38Z

llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp

+                         MachineFunctionAnalysisManager &MFAM) {
+  if (!LiveDebugValues().run(MF, ShouldEmitDebugEntryValues))
+    return PreservedAnalyses::all();
+  auto PA = getMachineFunctionPassPreservedAnalyses();


I would hope this preserves everything

But this just copies what the old PM does

As far as I'm aware this should preserve all information in analyses -- LDV will insert new DBG_VALUE instructions and should do absolutely nothing else.

OK, should fix both PMs in a follow up

I see, will do

jmorse

LGTM, although I'm not especially familiar with the transition to the new pass manager.

jmorse · 2025-03-17T13:35:01Z

llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp

+                         MachineFunctionAnalysisManager &MFAM) {
+  if (!LiveDebugValues().run(MF, ShouldEmitDebugEntryValues))
+    return PreservedAnalyses::all();
+  auto PA = getMachineFunctionPassPreservedAnalyses();


As far as I'm aware this should preserve all information in analyses -- LDV will insert new DBG_VALUE instructions and should do absolutely nothing else.

llvm-ci · 2025-03-24T06:08:18Z

LLVM Buildbot has detected a new failure on builder clang-cmake-x86_64-avx512-win running on avx512-intel64-win while building llvm at step 4 "cmake stage 1".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/81/builds/5578

Here is the relevant piece of the build log for the reference

Step 4 (cmake stage 1) failure: 'cmake -G ...' (failure)
'cmake' is not recognized as an internal or external command,
operable program or batch file.

optimisan mentioned this pull request Mar 17, 2025

[LiveDebugValues][NFC] Remove TargetPassConfig from LDVImpl #131562

Merged

optimisan marked this pull request as ready for review March 17, 2025 05:16

llvmbot added the debuginfo label Mar 17, 2025

optimisan added the llvm:codegen label Mar 17, 2025 — with Graphite App

optimisan requested review from arsenm, cdevadas and vikramRH March 17, 2025 05:18

arsenm reviewed Mar 17, 2025

View reviewed changes

optimisan force-pushed the users/optimisan/remove-tpc-from-ldvimpl branch from bb1d6f1 to cd06f54 Compare March 17, 2025 05:47

optimisan force-pushed the users/optimisan/port-live-debug-values branch from b4613ea to be6e70f Compare March 17, 2025 05:47

llvmbot added the backend:ARM label Mar 17, 2025

arsenm reviewed Mar 17, 2025

View reviewed changes

llvm/lib/CodeGen/LiveDebugValues/LiveDebugValues.cpp Outdated Show resolved Hide resolved

optimisan force-pushed the users/optimisan/port-live-debug-values branch from 5c87dc3 to 768f70a Compare March 17, 2025 10:39

arsenm reviewed Mar 17, 2025

View reviewed changes

arsenm requested a review from jmorse March 17, 2025 11:01

jmorse approved these changes Mar 17, 2025

View reviewed changes

Base automatically changed from users/optimisan/remove-tpc-from-ldvimpl to main March 18, 2025 05:34

optimisan force-pushed the users/optimisan/port-live-debug-values branch from 768f70a to 6404e9b Compare March 18, 2025 06:09

optimisan added 4 commits March 21, 2025 06:27

[CodeGen][NPM] Port LiveDebugValues to NPM

02fe333

format .h

c63484f

AS

d37f602

add required for TPC

7a01e19

optimisan force-pushed the users/optimisan/port-live-debug-values branch from ba355c0 to 7a01e19 Compare March 21, 2025 08:10

optimisan merged commit 174110b into main Mar 24, 2025
11 checks passed

optimisan deleted the users/optimisan/port-live-debug-values branch March 24, 2025 06:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[CodeGen][NPM] Port LiveDebugValues to NPM #131563

[CodeGen][NPM] Port LiveDebugValues to NPM #131563

Uh oh!

optimisan commented Mar 17, 2025

Uh oh!

optimisan commented Mar 17, 2025 •

edited

Loading

Uh oh!

llvmbot commented Mar 17, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 17, 2025 •

edited

Loading

Uh oh!

arsenm Mar 17, 2025

Uh oh!

optimisan Mar 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

arsenm Mar 17, 2025

Uh oh!

arsenm Mar 17, 2025

Uh oh!

jmorse Mar 17, 2025

Uh oh!

arsenm Mar 18, 2025

Uh oh!

optimisan Mar 18, 2025

Uh oh!

jmorse left a comment

Uh oh!

jmorse Mar 17, 2025

Uh oh!

Uh oh!

llvm-ci commented Mar 24, 2025

Uh oh!

Uh oh!

[CodeGen][NPM] Port LiveDebugValues to NPM #131563

[CodeGen][NPM] Port LiveDebugValues to NPM #131563

Uh oh!

Conversation

optimisan commented Mar 17, 2025

Uh oh!

optimisan commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

llvmbot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arsenm Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

optimisan Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

arsenm Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

arsenm Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

jmorse Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

arsenm Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

optimisan Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

jmorse left a comment

Choose a reason for hiding this comment

Uh oh!

jmorse Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

llvm-ci commented Mar 24, 2025

Uh oh!

Uh oh!

optimisan commented Mar 17, 2025 •

edited

Loading

llvmbot commented Mar 17, 2025 •

edited

Loading

github-actions bot commented Mar 17, 2025 •

edited

Loading

optimisan Mar 17, 2025 •

edited

Loading