Trace.hpp

Go to the documentation of this file.

/*
 * Copyright 2025 Håvard Krogstie <krogstie.havard@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_LLVM_IR_TRACE_HPP
#define JLM_LLVM_IR_TRACE_HPP
 
#include <jlm/llvm/ir/operators/GetElementPtr.hpp>
#include <jlm/rvsdg/node.hpp>
#include <jlm/rvsdg/Trace.hpp>
 
#include <optional>
 
namespace jlm::llvm
{
 
class OutputTracer : public rvsdg::OutputTracer
{
public:
  explicit OutputTracer();
 
  [[nodiscard]] bool
  isTracingThroughLoadedStates() const noexcept
  {
    return traceThroughLoadedStates_;
  }
 
  [[nodiscard]] bool
  isTracingThroughHoistBarriers() const noexcept
  {
    return traceThroughHoistBarriers_;
  }
 
  void
  setTraceThroughLoadedStates(const bool traceThroughLoadedStates)
  {
    traceThroughLoadedStates_ = traceThroughLoadedStates;
  }
 
  void
  setTracingThroughHoistBarriers(const bool traceThroughHoistBarriers)
  {
    traceThroughHoistBarriers_ = traceThroughHoistBarriers;
  }
 
protected:
  [[nodiscard]] TraceStepResult
  traceStep(rvsdg::Output & output, BackEdgeState backEdgeState, const rvsdg::Region * withinRegion)
      override;
 
private:
  bool traceThroughLoadedStates_ = false;
  bool traceThroughHoistBarriers_ = true;
};
 
rvsdg::Output &
traceOutput(
    rvsdg::Output & output,
    bool mayEnterSubregions,
    const rvsdg::Region * withinRegion = nullptr);
 
inline const rvsdg::Output &
traceOutput(
    const rvsdg::Output & output,
    bool mayEnterSubregions,
    const rvsdg::Region * withinRegion = nullptr)
{
  return llvm::traceOutput(const_cast<rvsdg::Output &>(output), mayEnterSubregions, withinRegion);
}
 
std::optional<int64_t>
tryGetConstantSignedInteger(const rvsdg::Output & output);
 
struct TracedPointerOrigin
{
  [[nodiscard]] std::optional<int64_t>
  getOffsetInBytes() const noexcept;
 
  const rvsdg::Output * BasePointer = nullptr;
  std::optional<std::vector<GetElementPtrOperation::Constant>> gepConstants{};
};
 
[[nodiscard]] TracedPointerOrigin
TracePointerOriginPrecise(const rvsdg::Output & p);
 
struct TraceCollection
{
  std::unordered_map<const rvsdg::Output *, std::optional<int64_t>> AllTracedOutputs{};
 
  std::unordered_map<const rvsdg::Output *, std::optional<int64_t>> TopOrigins{};
};
 
[[nodiscard]] bool
TraceAllPointerOrigins(
    TracedPointerOrigin p,
    TraceCollection & traceCollection,
    size_t maxTraceCollectionSize);
 
}
 
#endif // JLM_LLVM_IR_TRACE_HPP