RvsdgTreePrinter.hpp

Go to the documentation of this file.

/*
 * Copyright 2024 Nico Reißmann <nico.reissmann@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_LLVM_OPT_RVSDGTREEPRINTER_HPP
#define JLM_LLVM_OPT_RVSDGTREEPRINTER_HPP
 
#include <jlm/rvsdg/Transformation.hpp>
#include <jlm/util/AnnotationMap.hpp>
#include <jlm/util/HashSet.hpp>
 
namespace jlm::rvsdg
{
class Graph;
class Node;
class Input;
class Output;
}
 
namespace jlm::util
{
class StatisticsCollector;
}
 
namespace jlm::llvm
{
 
class RvsdgTreePrinter final : public rvsdg::Transformation
{
  class Statistics;
 
public:
  class Configuration final
  {
  public:
    enum class Annotation
    {
      FirstEnumValue,
 
      DebugIds,
 
      NumRvsdgNodes,
 
      NumAggregateAllocaNodes,
 
      NumAllocaNodes,
 
      NumLoadNodes,
 
      NumStoreNodes,
 
      NumMemoryStateInputsOutputs,
 
      LastEnumValue
    };
 
    explicit Configuration(util::HashSet<Annotation> requiredAnnotations)
        : RequiredAnnotations_(std::move(requiredAnnotations))
    {}
 
    [[nodiscard]] const util::HashSet<Annotation> &
    RequiredAnnotations() const noexcept
    {
      return RequiredAnnotations_;
    }
 
  private:
    util::HashSet<Annotation> RequiredAnnotations_ = {};
  };
 
  ~RvsdgTreePrinter() noexcept override;
 
  explicit RvsdgTreePrinter(Configuration configuration)
      : Transformation("RvsdgTreePrinter"),
        Configuration_(std::move(configuration))
  {}
 
  RvsdgTreePrinter(const RvsdgTreePrinter &) = delete;
 
  RvsdgTreePrinter(RvsdgTreePrinter &&) = delete;
 
  RvsdgTreePrinter &
  operator=(const RvsdgTreePrinter &) = delete;
 
  RvsdgTreePrinter &
  operator=(RvsdgTreePrinter &&) = delete;
 
  void
  Run(rvsdg::RvsdgModule & rvsdgModule, util::StatisticsCollector & statisticsCollector) override;
 
private:
  [[nodiscard]] util::AnnotationMap
  ComputeAnnotationMap(const rvsdg::Graph & rvsdg) const;
 
  static void
  AnnotateNumNodes(
      const rvsdg::Graph & rvsdg,
      const std::function<bool(const rvsdg::Node &)> & match,
      const std::string_view & label,
      util::AnnotationMap & annotationMap);
 
  static void
  AnnotateNumMemoryStateInputsOutputs(
      const rvsdg::Graph & rvsdg,
      util::AnnotationMap & annotationMap);
 
  static void
  AnnotateDebugIds(const rvsdg::Graph & rvsdg, util::AnnotationMap & annotationMap);
 
  [[nodiscard]] static bool
  IsMemoryStateInput(const rvsdg::Input * input) noexcept;
 
  [[nodiscard]] static bool
  IsMemoryStateOutput(const rvsdg::Output * output) noexcept;
 
  Configuration Configuration_;
};
 
}
 
#endif