AgnosticModRefSummarizer.hpp

Go to the documentation of this file.

/*
 * Copyright 2022 Nico Reißmann <nico.reissmann@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_LLVM_OPT_ALIAS_ANALYSES_AGNOSTICMODREFSUMMARIZER_HPP
#define JLM_LLVM_OPT_ALIAS_ANALYSES_AGNOSTICMODREFSUMMARIZER_HPP
 
#include <jlm/llvm/opt/alias-analyses/ModRefSummarizer.hpp>
#include <jlm/util/Statistics.hpp>
#include <jlm/util/time.hpp>
 
namespace jlm::llvm::aa
{
 
class AgnosticModRefSet;
class AgnosticModRefSummary;
 
class AgnosticModRefSummarizer final : public ModRefSummarizer
{
public:
  class Statistics;
 
  ~AgnosticModRefSummarizer() override;
 
  AgnosticModRefSummarizer();
 
  AgnosticModRefSummarizer(const AgnosticModRefSummarizer &) = delete;
 
  AgnosticModRefSummarizer &
  operator=(const AgnosticModRefSummarizer &) = delete;
 
  std::unique_ptr<ModRefSummary>
  SummarizeModRefs(
      const rvsdg::RvsdgModule & rvsdgModule,
      const PointsToGraph & pointsToGraph,
      util::StatisticsCollector & statisticsCollector) override;
 
  static std::unique_ptr<ModRefSummary>
  Create(
      const rvsdg::RvsdgModule & rvsdgModule,
      const PointsToGraph & pointsToGraph,
      util::StatisticsCollector & statisticsCollector);
 
  static std::unique_ptr<ModRefSummary>
  Create(const rvsdg::RvsdgModule & rvsdgModule, const PointsToGraph & pointsToGraph);
 
private:
  [[nodiscard]] static AgnosticModRefSet
  GetAllMemoryNodes(const PointsToGraph & pointsToGraph);
 
  void
  AddPointerTargetsToModRefSet(
      const rvsdg::Output & output,
      ModRefEffect modRefEffect,
      AgnosticModRefSet & modRefSet) const;
 
  void
  AnnotateRegion(const rvsdg::Region & region);
 
  void
  AnnotateSimpleNode(const rvsdg::SimpleNode & node);
 
  // The ModRefSummary being created by this class
  std::unique_ptr<AgnosticModRefSummary> ModRefSummary_;
};
 
class AgnosticModRefSummarizer::Statistics final : public util::Statistics
{
  static constexpr auto memoryStateDistributionLabel_ = "MemoryStateDistribution";
 
public:
  Statistics(
      const util::FilePath & sourceFile,
      const util::StatisticsCollector & statisticsCollector,
      const PointsToGraph & pointsToGraph)
      : util::Statistics(Id::AgnosticModRefSummarizer, sourceFile),
        StatisticsCollector_(statisticsCollector)
  {
    if (!StatisticsCollector_.IsDemanded(*this))
      return;
 
    AddMeasurement(Label::NumPointsToGraphMemoryNodes, pointsToGraph.numMemoryNodes());
  }
 
  [[nodiscard]] size_t
  NumPointsToGraphMemoryNodes() const noexcept
  {
    return GetMeasurementValue<uint64_t>(Label::NumPointsToGraphMemoryNodes);
  }
 
  [[nodiscard]] size_t
  GetTime() const noexcept
  {
    return GetTimer(Label::Timer).ns();
  }
 
  void
  StartCollecting() noexcept
  {
    if (!StatisticsCollector_.IsDemanded(*this))
      return;
 
    AddTimer(Label::Timer).start();
  }
 
  void
  StopCollecting() noexcept
  {
    if (!StatisticsCollector_.IsDemanded(*this))
      return;
 
    GetTimer(Label::Timer).stop();
  }
 
  void
  addMemoryStateDistribution(const std::vector<MemoryStateSummary> & memoryStateDistribution)
  {
    AddMeasurement(memoryStateDistributionLabel_, toString(memoryStateDistribution));
  }
 
  static std::unique_ptr<Statistics>
  Create(
      const util::FilePath & sourceFile,
      const util::StatisticsCollector & statisticsCollector,
      const PointsToGraph & pointsToGraph)
  {
    return std::make_unique<Statistics>(sourceFile, statisticsCollector, pointsToGraph);
  }
 
private:
  const util::StatisticsCollector & StatisticsCollector_;
};
 
}
 
#endif // JLM_LLVM_OPT_ALIAS_ANALYSES_AGNOSTICMODREFSUMMARIZER_HPP