IOBarrier.hpp

Go to the documentation of this file.

/*
 * Copyright 2025 Nico Reißmann <nico.reissmann@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_LLVM_IR_OPERATORS_IOBARRIER_HPP
#define JLM_LLVM_IR_OPERATORS_IOBARRIER_HPP
 
#include <jlm/llvm/ir/types.hpp>
#include <jlm/rvsdg/operation.hpp>
#include <jlm/rvsdg/simple-node.hpp>
 
namespace jlm::llvm
{
 
class IOBarrierOperation final : public rvsdg::SimpleOperation
{
public:
  ~IOBarrierOperation() noexcept override;
 
  explicit IOBarrierOperation(const std::shared_ptr<const rvsdg::Type> & type)
      : SimpleOperation({ type, IOStateType::Create() }, { type })
  {}
 
  [[nodiscard]] const std::shared_ptr<const rvsdg::Type> &
  Type() const noexcept
  {
    return result(0);
  }
 
  bool
  operator==(const Operation & other) const noexcept override;
 
  std::string
  debug_string() const override;
 
  std::unique_ptr<Operation>
  copy() const override;
 
  [[nodiscard]] static rvsdg::Input &
  BarredInput(const rvsdg::Node & node) noexcept
  {
    JLM_ASSERT(rvsdg::is<IOBarrierOperation>(&node));
    const auto input = node.input(0);
    return *input;
  }
 
  [[nodiscard]] static rvsdg::Input &
  getIOStateInput(const rvsdg::Node & node) noexcept
  {
    JLM_ASSERT(rvsdg::is<IOBarrierOperation>(&node));
    const auto input = node.input(1);
    JLM_ASSERT(rvsdg::is<IOStateType>(input->Type()));
    return *input;
  }
 
  static rvsdg::SimpleNode &
  createNode(rvsdg::Output & value, rvsdg::Output & ioState)
  {
    return rvsdg::CreateOpNode<IOBarrierOperation>({ &value, &ioState }, value.Type());
  }
};
 
class MemoryHoistBarrierOperation final : public rvsdg::SimpleOperation
{
public:
  ~MemoryHoistBarrierOperation() noexcept override;
 
  explicit MemoryHoistBarrierOperation(const std::size_t dereferenceableSize)
      : SimpleOperation(
            { PointerType::Create(), IOStateType::Create() },
            { PointerType::Create() }),
        dereferenceableSize_(dereferenceableSize)
  {}
 
  bool
  operator==(const Operation & other) const noexcept override;
 
  std::string
  debug_string() const override;
 
  std::unique_ptr<Operation>
  copy() const override;
 
  [[nodiscard]] std::size_t
  getDereferenceableSize() const noexcept
  {
    return dereferenceableSize_;
  }
 
  [[nodiscard]] static rvsdg::Input &
  getAddressInput(const rvsdg::Node & node) noexcept
  {
    JLM_ASSERT(rvsdg::is<MemoryHoistBarrierOperation>(&node));
    const auto input = node.input(0);
    JLM_ASSERT(rvsdg::is<PointerType>(input->Type()));
    return *input;
  }
 
  [[nodiscard]] static rvsdg::Output &
  getAddressOutput(const rvsdg::Node & node) noexcept
  {
    JLM_ASSERT(rvsdg::is<MemoryHoistBarrierOperation>(&node));
    const auto output = node.output(0);
    JLM_ASSERT(rvsdg::is<PointerType>(output->Type()));
    return *output;
  }
 
  [[nodiscard]] static rvsdg::Input &
  getIOStateInput(const rvsdg::Node & node) noexcept
  {
    JLM_ASSERT(rvsdg::is<MemoryHoistBarrierOperation>(&node));
    const auto input = node.input(1);
    JLM_ASSERT(rvsdg::is<IOStateType>(input->Type()));
    return *input;
  }
 
  static rvsdg::SimpleNode &
  createNode(
      rvsdg::Output & address,
      rvsdg::Output & ioState,
      const std::size_t dereferenceableSize)
  {
    return rvsdg::CreateOpNode<MemoryHoistBarrierOperation>(
        { &address, &ioState },
        dereferenceableSize);
  }
 
  static std::optional<std::vector<rvsdg::Output *>>
  normalizeNestedMemoryHoistBarriers(
      const MemoryHoistBarrierOperation & lowerMhbOp,
      const std::vector<rvsdg::Output *> & operands);
 
private:
  std::size_t dereferenceableSize_;
};
 
}
 
#endif // JLM_LLVM_IR_OPERATORS_IOBARRIER_HPP