Phi.hpp

Go to the documentation of this file.

/*
 * Copyright 2012 2013 2014 2015 Nico Reißmann <nico.reissmann@gmail.com>
 * Copyright 2012 2013 2014 2025 Helge Bahmann <hcb@chaoticmind.net>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_RVSDG_PHI_HPP
#define JLM_RVSDG_PHI_HPP
 
#include <jlm/rvsdg/graph.hpp>
#include <jlm/rvsdg/lambda.hpp>
#include <jlm/rvsdg/node.hpp>
#include <jlm/rvsdg/region.hpp>
#include <jlm/rvsdg/structural-node.hpp>
#include <jlm/util/common.hpp>
 
namespace jlm::rvsdg
{
 
class PhiOperation final : public rvsdg::StructuralOperation
{
public:
  ~PhiOperation() override;
 
  [[nodiscard]] std::string
  debug_string() const override;
 
  [[nodiscard]] std::unique_ptr<Operation>
  copy() const override;
};
 
class PhiBuilder;
 
class PhiNode final : public rvsdg::StructuralNode
{
  friend class PhiBuilder;
 
public:
  ~PhiNode() override;
 
private:
  explicit PhiNode(rvsdg::Region * parent)
      : StructuralNode(parent, 1)
  {}
 
  static PhiNode *
  create(rvsdg::Region * parent)
  {
    return new PhiNode(parent);
  }
 
public:
  struct ContextVar
  {
    rvsdg::Input * input;
 
    rvsdg::Output * inner;
  };
 
  struct FixVar
  {
    rvsdg::Output * recref;
 
    rvsdg::Input * result;
 
    rvsdg::Output * output;
  };
 
  [[nodiscard]] const PhiOperation &
  GetOperation() const noexcept override;
 
  ContextVar
  AddContextVar(jlm::rvsdg::Output & origin);
 
  void
  RemoveContextVars(std::vector<ContextVar> vars);
 
  [[nodiscard]] std::vector<ContextVar>
  GetContextVars() const noexcept;
 
  [[nodiscard]] ContextVar
  MapInputContextVar(const rvsdg::Input & input) const noexcept;
 
  [[nodiscard]] std::optional<ContextVar>
  MapArgumentContextVar(const rvsdg::Output & argument) const noexcept;
 
  void
  RemoveFixVars(std::vector<FixVar> vars);
 
  [[nodiscard]] std::vector<FixVar>
  GetFixVars() const noexcept;
 
  [[nodiscard]] std::optional<FixVar>
  MapArgumentFixVar(const rvsdg::Output & argument) const noexcept;
 
  [[nodiscard]] FixVar
  MapResultFixVar(const rvsdg::Input & result) const noexcept;
 
  [[nodiscard]] FixVar
  MapOutputFixVar(const rvsdg::Output & output) const noexcept;
 
  [[nodiscard]] std::variant<FixVar, ContextVar>
  MapArgument(const rvsdg::Output & argument) const noexcept;
 
  rvsdg::Region *
  subregion() const noexcept
  {
    return StructuralNode::subregion(0);
  }
 
  PhiNode *
  copy(rvsdg::Region * region, rvsdg::SubstitutionMap & smap) const override;
 
  static std::vector<rvsdg::LambdaNode *>
  ExtractLambdaNodes(const PhiNode & phiNode);
};
 
class PhiBuilder final
{
public:
  constexpr PhiBuilder() noexcept
      : node_(nullptr)
  {}
 
  rvsdg::Region *
  subregion() const noexcept
  {
    return node_ ? node_->subregion() : nullptr;
  }
 
  void
  begin(rvsdg::Region * parent)
  {
    if (node_)
      return;
 
    node_ = PhiNode::create(parent);
  }
 
  PhiNode::ContextVar
  AddContextVar(jlm::rvsdg::Output & origin);
 
  PhiNode::FixVar
  AddFixVar(std::shared_ptr<const jlm::rvsdg::Type> type);
 
  PhiNode *
  end();
 
private:
  PhiNode * node_;
};
 
}
 
#endif