[llvm] Add option to print entire function instead of just the loops for loo… (PR #123229)

[Akshay Deodhar via llvm-commits]

https://github.com/akshayrdeodhar updated https://github.com/llvm/llvm-project/pull/123229

>From 35361b7d6d3057cf3c9574f0b78559203b9fad65 Mon Sep 17 00:00:00 2001
From: Akshay Deodhar <adeodhar at nvidia.com>
Date: Wed, 18 Dec 2024 06:47:21 +0000
Subject: [PATCH 1/2] Add option to print entire function instead of just the
 loops for loop passes

---
 llvm/include/llvm/IR/PrintPasses.h |  3 +++
 llvm/lib/Analysis/LoopInfo.cpp     | 12 ++++++++++++
 llvm/lib/IR/PrintPasses.cpp        |  8 ++++++++
 3 files changed, 23 insertions(+)

diff --git a/llvm/include/llvm/IR/PrintPasses.h b/llvm/include/llvm/IR/PrintPasses.h
index 95b97e76c867cb..0aa1b379c35cf2 100644
--- a/llvm/include/llvm/IR/PrintPasses.h
+++ b/llvm/include/llvm/IR/PrintPasses.h
@@ -51,6 +51,9 @@ std::vector<std::string> printAfterPasses();
 // Returns true if we should always print the entire module.
 bool forcePrintModuleIR();
 
+// Returns true if we should print the entire function for loop passes.
+bool forcePrintFuncIR();
+
 // Return true if -filter-passes is empty or contains the pass name.
 bool isPassInPrintList(StringRef PassName);
 bool isFilterPassesEmpty();
diff --git a/llvm/lib/Analysis/LoopInfo.cpp b/llvm/lib/Analysis/LoopInfo.cpp
index 6bb5f001e9bd1d..7bd5e1e0cfac8f 100644
--- a/llvm/lib/Analysis/LoopInfo.cpp
+++ b/llvm/lib/Analysis/LoopInfo.cpp
@@ -999,6 +999,18 @@ void llvm::printLoop(Loop &L, raw_ostream &OS, const std::string &Banner) {
     return;
   }
 
+  if (forcePrintFuncIR()) {
+    // handling -print-loop-func-scope.
+    // -print-module-scope overrides this.
+    OS << Banner << " (loop: ";
+    L.getHeader()->printAsOperand(OS, false);
+    OS << ")\n";
+
+    // printing whole function.
+    OS << *L.getHeader()->getParent();
+    return;
+  }
+
   OS << Banner;
 
   auto *PreHeader = L.getLoopPreheader();
diff --git a/llvm/lib/IR/PrintPasses.cpp b/llvm/lib/IR/PrintPasses.cpp
index e2ef20bb81ba7d..466d16ccf32fca 100644
--- a/llvm/lib/IR/PrintPasses.cpp
+++ b/llvm/lib/IR/PrintPasses.cpp
@@ -88,6 +88,12 @@ static cl::opt<bool>
                               "always print a module IR"),
                      cl::init(false), cl::Hidden);
 
+static cl::opt<bool>
+    LoopPrintFuncScope("print-loop-func-scope",
+                       cl::desc("When printing IR for print-[before|after]{-all} "
+                                "for a loop pass, always print function IR"),
+                       cl::init(false), cl::Hidden);
+
 // See the description for -print-changed for an explanation of the use
 // of this option.
 static cl::list<std::string> FilterPasses(
@@ -141,6 +147,8 @@ std::vector<std::string> llvm::printAfterPasses() {
 
 bool llvm::forcePrintModuleIR() { return PrintModuleScope; }
 
+bool llvm::forcePrintFuncIR() { return LoopPrintFuncScope; }
+
 bool llvm::isPassInPrintList(StringRef PassName) {
   static std::unordered_set<std::string> Set(FilterPasses.begin(),
                                              FilterPasses.end());

>From 334ca62a7c79b431e750e8ce38f3fe979171879d Mon Sep 17 00:00:00 2001
From: Akshay Deodhar <adeodhar at nvidia.com>
Date: Thu, 16 Jan 2025 19:47:24 +0000
Subject: [PATCH 2/2] clang-format

---
 llvm/lib/IR/PrintPasses.cpp | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/llvm/lib/IR/PrintPasses.cpp b/llvm/lib/IR/PrintPasses.cpp
index 466d16ccf32fca..610411a3cf978a 100644
--- a/llvm/lib/IR/PrintPasses.cpp
+++ b/llvm/lib/IR/PrintPasses.cpp
@@ -88,11 +88,11 @@ static cl::opt<bool>
                               "always print a module IR"),
                      cl::init(false), cl::Hidden);
 
-static cl::opt<bool>
-    LoopPrintFuncScope("print-loop-func-scope",
-                       cl::desc("When printing IR for print-[before|after]{-all} "
-                                "for a loop pass, always print function IR"),
-                       cl::init(false), cl::Hidden);
+static cl::opt<bool> LoopPrintFuncScope(
+    "print-loop-func-scope",
+    cl::desc("When printing IR for print-[before|after]{-all} "
+             "for a loop pass, always print function IR"),
+    cl::init(false), cl::Hidden);
 
 // See the description for -print-changed for an explanation of the use
 // of this option.