Class DebugInfoReader

lib/Bytecode/Reader/BytecodeReader.cpp:784–1115

This class manages reading debug info attributes from bytecode format.

/// This class manages reading debug info attributes from bytecode format.
class DebugInfoReader {
public:
  DebugInfoReader(MLIRContext &context, EncodingReader &masterReader)
      : context(context), masterReader(masterReader) {}

  class Iterator {
  public:
    Iterator(DebugInfoReader &reader, uint64_t opIndex)
        : reader(reader), opIndex(opIndex) {}

    /// Return the next debug info attribute for the current operation.
    template <typename T>
    T next() {
      // Check if the index is reserved for special debug info attributes.
      if (opIndex == static_cast<uint64_t>(Bytecode::DebugReserved::UnknownLoc))
        return dyn_cast<T>(UnknownLoc::get(&reader.context));

      // Adjust the index to account for reserved indices.
      auto actualOpIndex =
          opIndex - static_cast<uint64_t>(Bytecode::DebugReserved::SIZE);

      // Calculate the offset for the current operation index.
      if (actualOpIndex >= reader.diIndexOffsets.size())
        return T();
      auto offset = reader.diIndexOffsets[actualOpIndex];

      // Validate size to prevent excessive memory allocation.
      if (reader.diIndices.size() > (std::numeric_limits<uint32_t>::max() - 1))
        return T();
      if (offset > (std::numeric_limits<uint32_t>::max() - 1))
        return T();
      if (offset + opIndexOffset >= reader.diIndices.size())
        return T();
      offset += opIndexOffset++;

      // Return the next debug info attribute for the current operation.
      return reader.getDebugInfo<T>(reader.diIndices[offset]);
    }

  private:
    DebugInfoReader &reader;
    uint64_t opIndex;
    uint64_t opIndexOffset = 0;
  };

  Iterator getIterator(uint64_t opIndex) { return Iterator(*this, opIndex); }

  /// This method initializes the debug info reader after construction.
  void initialize(ArrayRef<uint64_t> indices, ArrayRef<uint32_t> indexOffsets,
                  ArrayRef<uint8_t> data, ArrayRef<uint32_t> offsets) {
    diIndices = indices;
    diIndexOffsets = indexOffsets;
    diData = data;
    diOffsets = offsets;
    diCache.resize(offsets.size());
  }

private: