CallSummary.hpp

Go to the documentation of this file.

/*
 * Copyright 2018 Nico Reißmann <nico.reissmann@gmail.com>
 * Copyright 2025 Helge Bahmann <hcb@chaoticmind.net>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_LLVM_CALL_SUMMARY_HPP
#define JLM_LLVM_CALL_SUMMARY_HPP
 
#include <jlm/llvm/ir/operators/lambda.hpp>
#include <jlm/llvm/ir/RvsdgModule.hpp>
#include <jlm/util/iterator_range.hpp>
 
namespace jlm::llvm
{
 
class CallSummary final
{
  using DirectCallsConstRange =
      util::IteratorRange<std::vector<rvsdg::SimpleNode *>::const_iterator>;
  using OtherUsersConstRange = util::IteratorRange<std::vector<rvsdg::Input *>::const_iterator>;
 
public:
  CallSummary(
      rvsdg::GraphExport * rvsdgExport,
      std::vector<rvsdg::SimpleNode *> directCalls,
      std::vector<rvsdg::Input *> otherUsers)
      : RvsdgExport_(rvsdgExport),
        DirectCalls_(std::move(directCalls)),
        OtherUsers_(std::move(otherUsers))
  {}
 
  [[nodiscard]] bool
  IsDead() const noexcept
  {
    return RvsdgExport_ == nullptr && DirectCalls_.empty() && OtherUsers_.empty();
  }
 
  [[nodiscard]] bool
  IsExported() const noexcept
  {
    return RvsdgExport_ != nullptr;
  }
 
  [[nodiscard]] bool
  IsOnlyExported() const noexcept
  {
    return RvsdgExport_ != nullptr && DirectCalls_.empty() && OtherUsers_.empty();
  }
 
  [[nodiscard]] bool
  HasOnlyDirectCalls() const noexcept
  {
    return RvsdgExport_ == nullptr && OtherUsers_.empty() && !DirectCalls_.empty();
  }
 
  [[nodiscard]] bool
  HasNoOtherUsages() const noexcept
  {
    return OtherUsers_.empty();
  }
 
  [[nodiscard]] bool
  HasOnlyOtherUsages() const noexcept
  {
    return RvsdgExport_ == nullptr && DirectCalls_.empty() && !OtherUsers_.empty();
  }
 
  [[nodiscard]] size_t
  NumDirectCalls() const noexcept
  {
    return DirectCalls_.size();
  }
 
  [[nodiscard]] size_t
  NumOtherUsers() const noexcept
  {
    return OtherUsers_.size();
  }
 
  [[nodiscard]] rvsdg::GraphExport *
  GetRvsdgExport() const noexcept
  {
    return RvsdgExport_;
  }
 
  [[nodiscard]] DirectCallsConstRange
  DirectCalls() const noexcept
  {
    return { DirectCalls_.begin(), DirectCalls_.end() };
  }
 
  [[nodiscard]] OtherUsersConstRange
  OtherUsers() const noexcept
  {
    return { OtherUsers_.begin(), OtherUsers_.end() };
  }
 
  static std::unique_ptr<CallSummary>
  Create(
      rvsdg::GraphExport * rvsdgExport,
      std::vector<rvsdg::SimpleNode *> directCalls,
      std::vector<rvsdg::Input *> otherUsers)
  {
    return std::make_unique<CallSummary>(
        rvsdgExport,
        std::move(directCalls),
        std::move(otherUsers));
  }
 
private:
  rvsdg::GraphExport * RvsdgExport_;
  std::vector<rvsdg::SimpleNode *> DirectCalls_;
  std::vector<rvsdg::Input *> OtherUsers_;
};
 
CallSummary
ComputeCallSummary(const rvsdg::LambdaNode & lambdaNode);
 
}
 
#endif