addressing_event.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <optional>
#include <stdexcept>
#include <string>
#include <vector>
 
#include "barretenberg/vm2/common/memory_types.hpp"
#include "barretenberg/vm2/simulation/lib/serialization.hpp"
 
namespace bb::avm2::simulation {
 
enum class AddressingEventError {
    // The base address (mem[0]) is not a valid address.
    BASE_ADDRESS_INVALID,
    // The relative computation overflowed.
    RELATIVE_COMPUTATION_OOB,
    // The address obtained after applying indirection is not a valid address.
    INVALID_ADDRESS_AFTER_INDIRECTION,
};
 
inline std::string to_string(AddressingEventError e)
{
    switch (e) {
    case AddressingEventError::BASE_ADDRESS_INVALID:
        return "BASE_ADDRESS_INVALID";
    case AddressingEventError::RELATIVE_COMPUTATION_OOB:
        return "RELATIVE_COMPUTATION_OOB";
    case AddressingEventError::INVALID_ADDRESS_AFTER_INDIRECTION:
        return "INVALID_ADDRESS_AFTER_INDIRECTION";
    }
 
    // We should be catching all the cases above.
    __builtin_unreachable();
}
 
struct AddressingException : public std::runtime_error {
    explicit AddressingException()
        : std::runtime_error("Error resolving operands.")
    {}
};
 
struct OperandResolutionInfo {
    Operand after_relative;
    Operand resolved_operand;
    std::optional<AddressingEventError> error;
};
 
// See https://docs.google.com/document/d/1EgFj0OQYZCWufjzLgoAAiVL9jV0-fUAaCCIVlvRc8bY/ for circuit details.
// - The activation mask can be derived from spec.num_addresses.
struct AddressingEvent {
    Instruction instruction;
    MemoryValue base_address;
    std::vector<OperandResolutionInfo> resolution_info; // One per operand (including immediates).
};
 
} // namespace bb::avm2::simulation