Replace optimization interface with Transformation interface (#760)

This PR replaces the optimization interface with the Transformation interface. Specifically, this PR does the following: 1. Removes the optimization interface in the llvm sublibrary 2. Adds the Transformation interface to the rvsdg sublibrary. 3. Replaces all usages of the optimization interface with the Transformation interface Ultimately, this lifts the concept of an RVSDG transformation to the rvsdg library, enabling other sublibraries, such as the HLS library, to tap into it in the future and set up a coherent transformation pipeline. Moreover, this will enable to lift common transformations, such as dead node elimination, to the RVSDG library level. Ultimately, this will help to remove code duplication that is currently present in the code base, i.e., DNE clones in the LLVM and HLS sublibraries.
phate · Jan 18, 2025 · 7c3c119 · 7c3c119
1 parent 86f1970
commit 7c3c119
Show file tree

Hide file tree

Showing 63 changed files with 394 additions and 406 deletions.
diff --git a/jlm/hls/backend/rvsdg2rhls/rvsdg2rhls.cpp b/jlm/hls/backend/rvsdg2rhls/rvsdg2rhls.cpp
@@ -62,12 +62,12 @@ split_opt(llvm::RvsdgModule & rm)
   jlm::llvm::tginversion tgi;
   jlm::llvm::NodeReduction red;
   jlm::util::StatisticsCollector statisticsCollector;
-  tgi.run(rm, statisticsCollector);
-  dne.run(rm, statisticsCollector);
-  cne.run(rm, statisticsCollector);
-  ivr.run(rm, statisticsCollector);
-  red.run(rm, statisticsCollector);
-  dne.run(rm, statisticsCollector);
+  tgi.Run(rm, statisticsCollector);
+  dne.Run(rm, statisticsCollector);
+  cne.Run(rm, statisticsCollector);
+  ivr.Run(rm, statisticsCollector);
+  red.Run(rm, statisticsCollector);
+  dne.Run(rm, statisticsCollector);
 }
 
 void
@@ -79,13 +79,13 @@ pre_opt(jlm::llvm::RvsdgModule & rm)
   jlm::llvm::InvariantValueRedirection ivr;
   jlm::llvm::tginversion tgi;
   jlm::util::StatisticsCollector statisticsCollector;
-  tgi.run(rm, statisticsCollector);
-  dne.run(rm, statisticsCollector);
-  cne.run(rm, statisticsCollector);
-  ivr.run(rm, statisticsCollector);
-  dne.run(rm, statisticsCollector);
-  cne.run(rm, statisticsCollector);
-  dne.run(rm, statisticsCollector);
+  tgi.Run(rm, statisticsCollector);
+  dne.Run(rm, statisticsCollector);
+  cne.Run(rm, statisticsCollector);
+  ivr.Run(rm, statisticsCollector);
+  dne.Run(rm, statisticsCollector);
+  cne.Run(rm, statisticsCollector);
+  dne.Run(rm, statisticsCollector);
 }
 
 void
@@ -421,7 +421,7 @@ rvsdg2rhls(llvm::RvsdgModule & rhls, util::StatisticsCollector & collector)
   merge_gamma(rhls);
 
   llvm::DeadNodeElimination llvmDne;
-  llvmDne.run(rhls, collector);
+  llvmDne.Run(rhls, collector);
 
   mem_sep_argument(rhls);
   remove_unused_state(rhls);
@@ -430,7 +430,7 @@ rvsdg2rhls(llvm::RvsdgModule & rhls, util::StatisticsCollector & collector)
   ConvertGammaNodes(rhls);
   ConvertThetaNodes(rhls);
   hls::cne hlsCne;
-  hlsCne.run(rhls, collector);
+  hlsCne.Run(rhls, collector);
   // rhls optimization
   dne(rhls);
   alloca_conv(rhls);

diff --git a/jlm/hls/opt/cne.cpp b/jlm/hls/opt/cne.cpp
@@ -615,12 +615,12 @@ divert(rvsdg::Region * region, cnectx & ctx)
 }
 
 static void
-cne(jlm::llvm::RvsdgModule & rm, util::StatisticsCollector & statisticsCollector)
+cne(rvsdg::RvsdgModule & rvsdgModule, util::StatisticsCollector & statisticsCollector)
 {
-  auto & graph = rm.Rvsdg();
+  auto & graph = rvsdgModule.Rvsdg();
 
   cnectx ctx;
-  auto statistics = cnestat::Create(rm.SourceFileName());
+  auto statistics = cnestat::Create(rvsdgModule.SourceFilePath().value());
 
   statistics->start_mark_stat(graph);
   mark(&graph.GetRootRegion(), ctx);
@@ -639,7 +639,7 @@ cne::~cne()
 {}
 
 void
-cne::run(llvm::RvsdgModule & module, util::StatisticsCollector & statisticsCollector)
+cne::Run(rvsdg::RvsdgModule & module, util::StatisticsCollector & statisticsCollector)
 {
   hls::cne(module, statisticsCollector);
 }

diff --git a/jlm/hls/opt/cne.hpp b/jlm/hls/opt/cne.hpp
@@ -6,12 +6,7 @@
 #ifndef JLM_HLS_OPT_CNE_HPP
 #define JLM_HLS_OPT_CNE_HPP
 
-#include <jlm/llvm/opt/optimization.hpp>
-
-namespace jlm::llvm
-{
-class RvsdgModule;
-}
+#include <jlm/rvsdg/Transformation.hpp>
 
 namespace jlm::hls
 {
@@ -25,13 +20,13 @@ namespace jlm::hls
  * This is mainly a copy of the CNE optimization in the LLVM backend with the addition of support
  * for the hls::loop_op.
  */
-class cne final : public llvm::optimization
+class cne final : public rvsdg::Transformation
 {
 public:
   virtual ~cne();
 
-  virtual void
-  run(llvm::RvsdgModule & module, jlm::util::StatisticsCollector & statisticsCollector) override;
+  void
+  Run(rvsdg::RvsdgModule & module, util::StatisticsCollector & statisticsCollector) override;
 };
 
 }

diff --git a/jlm/llvm/Makefile.sub b/jlm/llvm/Makefile.sub
@@ -59,8 +59,6 @@ libllvm_SOURCES = \
     jlm/llvm/opt/inlining.cpp \
     jlm/llvm/opt/InvariantValueRedirection.cpp \
     jlm/llvm/opt/inversion.cpp \
-    jlm/llvm/opt/optimization.cpp \
-    jlm/llvm/opt/OptimizationSequence.cpp \
     jlm/llvm/opt/pull.cpp \
     jlm/llvm/opt/push.cpp \
     jlm/llvm/opt/reduction.cpp \
@@ -91,11 +89,9 @@ libllvm_HEADERS = \
 	jlm/llvm/opt/alias-analyses/PointsToGraph.hpp \
 	jlm/llvm/opt/alias-analyses/AliasAnalysis.hpp \
 	jlm/llvm/opt/pull.hpp \
-	jlm/llvm/opt/optimization.hpp \
 	jlm/llvm/opt/reduction.hpp \
 	jlm/llvm/opt/InvariantValueRedirection.hpp \
 	jlm/llvm/opt/inversion.hpp \
-	jlm/llvm/opt/OptimizationSequence.hpp \
 	jlm/llvm/opt/RvsdgTreePrinter.hpp \
 	jlm/llvm/frontend/LlvmModuleConversion.hpp \
 	jlm/llvm/frontend/LlvmTypeConversion.hpp \

diff --git a/jlm/llvm/opt/DeadNodeElimination.cpp b/jlm/llvm/opt/DeadNodeElimination.cpp
@@ -156,12 +156,14 @@ DeadNodeElimination::run(rvsdg::Region & region)
 }
 
 void
-DeadNodeElimination::run(RvsdgModule & module, jlm::util::StatisticsCollector & statisticsCollector)
+DeadNodeElimination::Run(
+    rvsdg::RvsdgModule & module,
+    util::StatisticsCollector & statisticsCollector)
 {
   Context_ = Context::Create();
 
   auto & rvsdg = module.Rvsdg();
-  auto statistics = Statistics::Create(module.SourceFileName());
+  auto statistics = Statistics::Create(module.SourceFilePath().value());
   statistics->StartMarkStatistics(rvsdg);
   MarkRegion(rvsdg.GetRootRegion());
   statistics->StopMarkStatistics();

diff --git a/jlm/llvm/opt/DeadNodeElimination.hpp b/jlm/llvm/opt/DeadNodeElimination.hpp
@@ -6,14 +6,16 @@
 #ifndef JLM_LLVM_OPT_DEADNODEELIMINATION_HPP
 #define JLM_LLVM_OPT_DEADNODEELIMINATION_HPP
 
-#include <jlm/llvm/opt/optimization.hpp>
-#include <jlm/rvsdg/simple-node.hpp>
-#include <jlm/rvsdg/structural-node.hpp>
+#include <jlm/rvsdg/Transformation.hpp>
 
 namespace jlm::rvsdg
 {
 class GammaNode;
+class Graph;
+class output;
+class StructuralNode;
 class ThetaNode;
+class Region;
 }
 
 namespace jlm::llvm
@@ -34,8 +36,6 @@ namespace phi
 class node;
 }
 
-class RvsdgModule;
-
 /** \brief Dead Node Elimination Optimization
  *
  * Dead Node Elimination removes all nodes that do not contribute to the result of a computation. A
@@ -51,7 +51,7 @@ class RvsdgModule;
  *
  * Please see TestDeadNodeElimination.cpp for Dead Node Elimination examples.
  */
-class DeadNodeElimination final : public optimization
+class DeadNodeElimination final : public rvsdg::Transformation
 {
   class Context;
   class Statistics;
@@ -75,7 +75,7 @@ class DeadNodeElimination final : public optimization
   run(rvsdg::Region & region);
 
   void
-  run(RvsdgModule & module, jlm::util::StatisticsCollector & statisticsCollector) override;
+  Run(rvsdg::RvsdgModule & module, util::StatisticsCollector & statisticsCollector) override;
 
 private:
   void

diff --git a/jlm/llvm/opt/InvariantValueRedirection.cpp b/jlm/llvm/opt/InvariantValueRedirection.cpp
@@ -47,14 +47,14 @@ class InvariantValueRedirection::Statistics final : public util::Statistics
 InvariantValueRedirection::~InvariantValueRedirection() = default;
 
 void
-InvariantValueRedirection::run(
-    RvsdgModule & rvsdgModule,
+InvariantValueRedirection::Run(
+    rvsdg::RvsdgModule & module,
     util::StatisticsCollector & statisticsCollector)
 {
-  auto statistics = Statistics::Create(rvsdgModule.SourceFileName());
+  auto statistics = Statistics::Create(module.SourceFilePath().value());
 
   statistics->Start();
-  RedirectInRootRegion(rvsdgModule.Rvsdg());
+  RedirectInRootRegion(module.Rvsdg());
   statistics->Stop();
 
   statisticsCollector.CollectDemandedStatistics(std::move(statistics));

diff --git a/jlm/llvm/opt/InvariantValueRedirection.hpp b/jlm/llvm/opt/InvariantValueRedirection.hpp
@@ -6,7 +6,7 @@
 #ifndef JLM_LLVM_OPT_INVARIANTVALUEREDIRECTION_HPP
 #define JLM_LLVM_OPT_INVARIANTVALUEREDIRECTION_HPP
 
-#include <jlm/llvm/opt/optimization.hpp>
+#include <jlm/rvsdg/Transformation.hpp>
 
 namespace jlm::rvsdg
 {
@@ -21,7 +21,6 @@ namespace jlm::llvm
 {
 
 class CallNode;
-class RvsdgModule;
 
 /** \brief Invariant Value Redirection Optimization
  *
@@ -50,15 +49,15 @@ class RvsdgModule;
  * for call nodes works only on non-recursive direct calls as IVR needs to inspect the lambda body
  * in order to determine whether a value is simply routed through the lambda.
  */
-class InvariantValueRedirection final : public optimization
+class InvariantValueRedirection final : public rvsdg::Transformation
 {
   class Statistics;
 
 public:
   ~InvariantValueRedirection() override;
 
   void
-  run(RvsdgModule & rvsdgModule, util::StatisticsCollector & statisticsCollector) override;
+  Run(rvsdg::RvsdgModule & module, util::StatisticsCollector & statisticsCollector) override;
 
 private:
   static void

diff --git a/jlm/llvm/opt/OptimizationSequence.cpp b/jlm/llvm/opt/OptimizationSequence.cpp
diff --git a/jlm/llvm/opt/OptimizationSequence.hpp b/jlm/llvm/opt/OptimizationSequence.hpp
diff --git a/jlm/llvm/opt/RvsdgTreePrinter.cpp b/jlm/llvm/opt/RvsdgTreePrinter.cpp
@@ -45,9 +45,11 @@ class RvsdgTreePrinter::Statistics final : public util::Statistics
 RvsdgTreePrinter::~RvsdgTreePrinter() noexcept = default;
 
 void
-RvsdgTreePrinter::run(RvsdgModule & rvsdgModule, util::StatisticsCollector & statisticsCollector)
+RvsdgTreePrinter::Run(
+    rvsdg::RvsdgModule & rvsdgModule,
+    util::StatisticsCollector & statisticsCollector)
 {
-  auto statistics = Statistics::Create(rvsdgModule.SourceFileName());
+  auto statistics = Statistics::Create(rvsdgModule.SourceFilePath().value());
   statistics->Start();
 
   auto annotationMap = ComputeAnnotationMap(rvsdgModule.Rvsdg());