RegionAwareModRefSummarizer.hpp

Go to the documentation of this file.

/*
 * Copyright 2022 Nico Reißmann <nico.reissmann@gmail.com>
 * Copyright 2025 Håvard Krogstie <krogstie.havard@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_LLVM_OPT_ALIAS_ANALYSES_REGIONAWAREMODREFSUMMARIZER_HPP
#define JLM_LLVM_OPT_ALIAS_ANALYSES_REGIONAWAREMODREFSUMMARIZER_HPP
 
#include <jlm/llvm/opt/alias-analyses/ModRefSummarizer.hpp>
#include <jlm/llvm/opt/alias-analyses/ModRefSummary.hpp>
#include <jlm/llvm/opt/alias-analyses/PointsToGraph.hpp>
 
#include <queue>
 
namespace jlm::llvm::aa
{
 
class RegionAwareModRefSummary;
using ModRefSetIndex = uint32_t;
 
class RegionAwareModRefSummarizer final : public ModRefSummarizer
{
public:
  class Statistics;
  struct Context;
 
  ~RegionAwareModRefSummarizer() noexcept override;
 
  RegionAwareModRefSummarizer();
 
  RegionAwareModRefSummarizer(const RegionAwareModRefSummarizer &) = delete;
 
  RegionAwareModRefSummarizer &
  operator=(const RegionAwareModRefSummarizer &) = 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:
  static util::HashSet<PointsToGraph::NodeIndex>
  CreateSimpleAllocaSet(const PointsToGraph & pointsToGraph);
 
  util::HashSet<PointsToGraph::NodeIndex>
  getReachableSimpleAllocas(std::queue<PointsToGraph::NodeIndex> & nodes);
 
  util::HashSet<PointsToGraph::NodeIndex>
  getSimpleAllocasReachableFromRegionArguments(const rvsdg::Region & region);
 
  util::HashSet<PointsToGraph::NodeIndex>
  getSimpleAllocasReachableFromCallArguments(const rvsdg::SimpleNode & call);
 
  void
  removeSimpleAllocasAroundSetjmp();
 
  void
  AddModRefSimpleConstraint(ModRefSetIndex from, ModRefSetIndex to);
 
  void
  addModRefSetSimpleAllocaAllowlist(
      ModRefSetIndex index,
      util::HashSet<PointsToGraph::NodeIndex> allowlist);
 
  void
  annotateInterproceduralRegion(const rvsdg::Region & region);
 
  void
  AnnotateFunction(const rvsdg::LambdaNode & lambda);
 
  void
  AnnotateRegion(
      const rvsdg::Region & region,
      ModRefSetIndex modRefSet,
      const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateStructuralNode(
      const rvsdg::StructuralNode & structuralNode,
      const rvsdg::LambdaNode & lambda);
 
  std::optional<ModRefSetIndex>
  AnnotateSimpleNode(const rvsdg::SimpleNode & simpleNode, const rvsdg::LambdaNode & lambda);
 
  void
  addPointerOriginTargets(
      ModRefSetIndex modRefSetIndex,
      const rvsdg::Output & origin,
      std::optional<size_t> minTargetSize,
      ModRefEffect modRefEffect);
 
  ModRefSetIndex
  AnnotateLoad(const rvsdg::SimpleNode & loadNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateStore(const rvsdg::SimpleNode & storeNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateAlloca(const rvsdg::SimpleNode & allocaNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateMalloc(const rvsdg::SimpleNode & mallocNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateFree(const rvsdg::SimpleNode & freeNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateMemcpy(const rvsdg::SimpleNode & memcpyNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateMemset(const rvsdg::SimpleNode & memsetNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateMemmove(const rvsdg::SimpleNode & memmoveNode, const rvsdg::LambdaNode & lambda);
 
  ModRefSetIndex
  AnnotateCall(const rvsdg::SimpleNode & callNode, const rvsdg::LambdaNode & lambda);
 
  void
  SolveModRefSetConstraintGraph();
 
  bool
  verifySimpleAllocaAllowlists() const;
 
  void
  determineReadOnlyMemory();
 
  void
  materializeSets();
 
  void
  materializeSetsInFunction(const rvsdg::LambdaNode & lambda);
 
  static std::string
  ToRegionTree(const rvsdg::Graph & rvsdg, const RegionAwareModRefSummary & modRefSummary);
 
  std::unique_ptr<RegionAwareModRefSummary> ModRefSummary_;
 
  std::unique_ptr<Context> Context_;
};
 
}
 
#endif // JLM_LLVM_OPT_ALIAS_ANALYSES_REGIONAWAREMODREFSUMMARIZER_HPP