Transformation.hpp

Go to the documentation of this file.

/*
 * Copyright 2025 Nico Reißmann <nico.reissmann@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_RVSDG_TRANSFORMATION_HPP
#define JLM_RVSDG_TRANSFORMATION_HPP
 
#include <jlm/rvsdg/DotWriter.hpp>
#include <jlm/util/Statistics.hpp>
 
namespace jlm::rvsdg
{
 
class RvsdgModule;
 
class Transformation
{
public:
  virtual ~Transformation() noexcept;
 
  explicit Transformation(std::string_view Name)
      : Name_(Name)
  {}
 
  [[nodiscard]] const std::string_view &
  GetName() const noexcept
  {
    return Name_;
  }
 
  virtual void
  Run(RvsdgModule & module, util::StatisticsCollector & statisticsCollector) = 0;
 
  void
  Run(RvsdgModule & module)
  {
    util::StatisticsCollector statisticsCollector;
    Run(module, statisticsCollector);
  }
 
private:
  std::string_view Name_;
};
 
class TransformationSequence final : public Transformation
{
  class Statistics;
 
public:
  ~TransformationSequence() noexcept override;
 
  explicit TransformationSequence(
      std::vector<std::shared_ptr<Transformation>> transformations,
      DotWriter & dotWriter,
      const bool dumpRvsdgDotGraphs)
      : Transformation("TransformationSequence"),
        DotWriter_(dotWriter),
        DumpRvsdgDotGraphs_(dumpRvsdgDotGraphs),
        Transformations_(std::move(transformations))
  {}
 
  void
  Run(RvsdgModule & rvsdgModule, util::StatisticsCollector & statisticsCollector) override;
 
  static void
  CreateAndRun(
      RvsdgModule & rvsdgModule,
      util::StatisticsCollector & statisticsCollector,
      std::vector<std::shared_ptr<Transformation>> transformations,
      DotWriter & dotWriter,
      const bool dumpRvsdgDotGraphs)
  {
    TransformationSequence sequentialApplication(
        std::move(transformations),
        dotWriter,
        dumpRvsdgDotGraphs);
    sequentialApplication.Run(rvsdgModule, statisticsCollector);
  }
 
private:
  void
  DumpDotGraphs(
      RvsdgModule & rvsdgModule,
      const util::FilePath & filePath,
      const std::string & passName,
      size_t numPass) const;
 
  DotWriter & DotWriter_;
  bool DumpRvsdgDotGraphs_;
  std::vector<std::shared_ptr<Transformation>> Transformations_;
};
 
}
 
#endif // JLM_RVSDG_TRANSFORMATION_HPP