test_interaction_builder.hpp

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <cstdint>
#include <string>
 
#include "barretenberg/common/log.hpp"
#include "barretenberg/vm2/common/map.hpp"
#include "barretenberg/vm2/common/set.hpp"
#include "barretenberg/vm2/tracegen/lib/lookup_builder.hpp"
#include "barretenberg/vm2/tracegen/lib/permutation_builder.hpp"
#include "barretenberg/vm2/tracegen/trace_container.hpp"
 
namespace bb::avm2::tracegen {
 
// Adds checks to a lookup builder. The BaseBuilder needs to be an IndexedLookupTraceBuilder.
template <typename BaseBuilder> class AddChecksToBuilder : public BaseBuilder {
    static_assert(std::is_base_of_v<IndexedLookupTraceBuilder<typename BaseBuilder::LookupSettings>, BaseBuilder>,
                  "BaseBuilder must be an IndexedLookupTraceBuilder");
 
  public:
    // Inherit the base constructors (incl. the outer_dst_selector one) so a strict-mode interaction can be
    // registered with an explicit outer selector.
    using BaseBuilder::BaseBuilder;
 
    using TupleType = typename BaseBuilder::TupleType;
    ~AddChecksToBuilder() override = default;
 
    void init(TraceContainer& trace) override
    {
        BaseBuilder::init(trace);
        this->trace = &trace;
    }
 
    uint32_t find_in_dst(const TupleType& src_values) const override
    {
        uint32_t dst_row = BaseBuilder::find_in_dst(src_values);
 
        auto dst_values = trace->get_multiple(BaseBuilder::LookupSettings::DST_COLUMNS, dst_row);
        if (src_values != dst_values) {
            throw std::runtime_error("Failed computing counts for " + std::string(BaseBuilder::LookupSettings::NAME) +
                                     ". Could not find tuple in destination. " + "SRC tuple: " +
                                     column_values_to_string(src_values, BaseBuilder::LookupSettings::SRC_COLUMNS));
        }
 
        return dst_row;
    }
 
  private:
    TraceContainer* trace = nullptr;
};
 
// Builds a permutation and performs additional checks.
// Only use in tests and debugging. This is slow and memory intensive.
template <typename PermutationSettings>
class CheckingPermutationBuilder : public PermutationBuilder<PermutationSettings> {
  public:
    // Owning value array; see get_multiple_as_array in interaction_builder.hpp for why we can't key on RefTuple.
    using ArrayTuple = std::array<FF, PermutationSettings::COLUMNS_PER_SET>;
 
    void process(TraceContainer& trace) override
    {
        PermutationBuilder<PermutationSettings>::process(trace);
 
        // Collect the source and destination tuples.
        source_tuples.clear();
        trace.visit_column(PermutationSettings::SRC_SELECTOR, [&](uint32_t row, const FF&) {
            source_tuples[get_multiple_as_array(trace, PermutationSettings::SRC_COLUMNS, row)].insert(row);
        });
        destination_tuples.clear();
        trace.visit_column(PermutationSettings::DST_SELECTOR, [&](uint32_t row, const FF&) {
            destination_tuples[get_multiple_as_array(trace, PermutationSettings::DST_COLUMNS, row)].insert(row);
        });
 
        auto build_error_message =
            [&](const ArrayTuple& tuple, const auto& columns, const auto& src_rows, const auto& dst_rows) {
                std::string error = "Failure to build permutation " + std::string(PermutationSettings::NAME) + ".\n";
                error += format("Tuple ",
                                column_values_to_string(tuple, columns),
                                " has multiplicity ",
                                src_rows.size(),
                                " in the source, but ",
                                dst_rows.size(),
                                " in the destination.\n");
                error += format("Source rows: ");
                for (auto row : src_rows) {
                    error += format(row, " ");
                }
                error += format("\n");
                error += format("Destination rows: ");
                for (auto row : dst_rows) {
                    error += format(row, " ");
                }
                return error;
            };
 
        // Check that every source tuple is found in the destination with the same multiplicity.
        for (const auto& [src_tuple, src_rows] : source_tuples) {
            auto dst_rows = destination_tuples.contains(src_tuple) ? destination_tuples.at(src_tuple)
                                                                   : unordered_flat_set<uint32_t>();
            if (src_rows.size() != dst_rows.size()) {
                throw std::runtime_error(
                    build_error_message(src_tuple, PermutationSettings::SRC_COLUMNS, src_rows, dst_rows));
            }
        }
        // Check that every destination tuple is found in the source with the same multiplicity.
        for (const auto& [dst_tuple, dst_rows] : destination_tuples) {
            auto src_rows =
                source_tuples.contains(dst_tuple) ? source_tuples.at(dst_tuple) : unordered_flat_set<uint32_t>();
            if (src_rows.size() != dst_rows.size()) {
                throw std::runtime_error(
                    build_error_message(dst_tuple, PermutationSettings::DST_COLUMNS, src_rows, dst_rows));
            }
        }
    }
 
  private:
    unordered_flat_map<ArrayTuple, unordered_flat_set<uint32_t>> source_tuples;
    unordered_flat_map<ArrayTuple, unordered_flat_set<uint32_t>> destination_tuples;
};
 
} // namespace bb::avm2::tracegen