instruction_spec.cpp

Go to the documentation of this file.

#include "barretenberg/vm2/tracegen/lib/instruction_spec.hpp"
 
#include <array>
#include <cstdint>
#include <unordered_map>
 
#include "barretenberg/vm2/common/aztec_constants.hpp"
#include "barretenberg/vm2/common/opcodes.hpp"
 
namespace bb::avm2::tracegen {
 
const std::unordered_map<ExecutionOpCode, SubtraceInfo> SUBTRACE_INFO_MAP = {
    // Map each ExecutionOpcode to a SubtraceInfo
    { ExecutionOpCode::ADD,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_ADD } },
    { ExecutionOpCode::SUB,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_SUB } },
    { ExecutionOpCode::MUL,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_MUL } },
    { ExecutionOpCode::DIV,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_DIV } },
    { ExecutionOpCode::FDIV,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_FDIV } },
    { ExecutionOpCode::EQ, { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_EQ } },
    { ExecutionOpCode::LT, { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_LT } },
    { ExecutionOpCode::LTE,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_LTE } },
    { ExecutionOpCode::NOT,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_NOT } },
    { ExecutionOpCode::SHL,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_SHL } },
    { ExecutionOpCode::SHR,
      { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_SHR } },
    { ExecutionOpCode::CAST,
      { .subtrace_selector = SubtraceSel::CAST, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_TRUNCATE } },
    // Bitwise - note the bitwise subtrace operation id need to match the op id values in the bitwise precomputed table
    { ExecutionOpCode::AND,
      { .subtrace_selector = SubtraceSel::BITWISE, .subtrace_operation_id = AVM_BITWISE_AND_OP_ID } },
    { ExecutionOpCode::OR,
      { .subtrace_selector = SubtraceSel::BITWISE, .subtrace_operation_id = AVM_BITWISE_OR_OP_ID } },
    { ExecutionOpCode::XOR,
      { .subtrace_selector = SubtraceSel::BITWISE, .subtrace_operation_id = AVM_BITWISE_XOR_OP_ID } },
    // Toradixbe
    { ExecutionOpCode::TORADIXBE, { .subtrace_selector = SubtraceSel::TORADIXBE, .subtrace_operation_id = 0 } },
    // ECC
    { ExecutionOpCode::ECADD, { .subtrace_selector = SubtraceSel::ECC, .subtrace_operation_id = 0 } },
    // Data Copy
    { ExecutionOpCode::CALLDATACOPY, { .subtrace_selector = SubtraceSel::CALLDATACOPY, .subtrace_operation_id = 0 } },
    { ExecutionOpCode::RETURNDATACOPY,
      { .subtrace_selector = SubtraceSel::RETURNDATACOPY, .subtrace_operation_id = 0 } },
    // Poseidon2Perm
    { ExecutionOpCode::POSEIDON2PERM, { .subtrace_selector = SubtraceSel::POSEIDON2PERM, .subtrace_operation_id = 0 } },
    // Execution
    { ExecutionOpCode::GETENVVAR,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_GETENVVAR } },
    { ExecutionOpCode::SET,
      { .subtrace_selector = SubtraceSel::SET, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_TRUNCATE } },
    { ExecutionOpCode::MOV,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_MOV } },
    { ExecutionOpCode::JUMP,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_JUMP } },
    { ExecutionOpCode::JUMPI,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_JUMPI } },
    { ExecutionOpCode::CALL,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_CALL } },
    { ExecutionOpCode::STATICCALL,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_STATICCALL } },
    { ExecutionOpCode::INTERNALCALL,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_INTERNALCALL } },
    { ExecutionOpCode::INTERNALRETURN,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_INTERNALRETURN } },
    { ExecutionOpCode::RETURN,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_RETURN } },
    { ExecutionOpCode::REVERT,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_REVERT } },
    { ExecutionOpCode::SUCCESSCOPY,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SUCCESSCOPY } },
    { ExecutionOpCode::RETURNDATASIZE,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_RETURNDATASIZE } },
    { ExecutionOpCode::DEBUGLOG,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_DEBUGLOG } },
    // Hashes
    { ExecutionOpCode::KECCAKF1600, { .subtrace_selector = SubtraceSel::KECCAKF1600, .subtrace_operation_id = 0 } },
    { ExecutionOpCode::POSEIDON2PERM, { .subtrace_selector = SubtraceSel::POSEIDON2PERM, .subtrace_operation_id = 0 } },
    { ExecutionOpCode::SHA256COMPRESSION,
      { .subtrace_selector = SubtraceSel::SHA256COMPRESSION, .subtrace_operation_id = 0 } },
    // Tree operations
    { ExecutionOpCode::SLOAD,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SLOAD } },
    { ExecutionOpCode::SSTORE,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SSTORE } },
    { ExecutionOpCode::NOTEHASHEXISTS,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_NOTEHASH_EXISTS } },
    { ExecutionOpCode::NULLIFIEREXISTS,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_NULLIFIER_EXISTS } },
    { ExecutionOpCode::EMITNULLIFIER,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_EMIT_NULLIFIER } },
    // Misc
    { ExecutionOpCode::GETCONTRACTINSTANCE,
      { .subtrace_selector = SubtraceSel::GETCONTRACTINSTANCE, .subtrace_operation_id = 0 } },
    { ExecutionOpCode::EMITNOTEHASH,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_EMIT_NOTEHASH } },
    { ExecutionOpCode::L1TOL2MSGEXISTS,
      { .subtrace_selector = SubtraceSel::EXECUTION,
        .subtrace_operation_id = AVM_EXEC_OP_ID_L1_TO_L2_MESSAGE_EXISTS } },
    // EC
    { ExecutionOpCode::ECADD, { .subtrace_selector = SubtraceSel::ECC, .subtrace_operation_id = 0 } },
    // Side effects
    { ExecutionOpCode::EMITUNENCRYPTEDLOG,
      { .subtrace_selector = SubtraceSel::EMITUNENCRYPTEDLOG, .subtrace_operation_id = 0 } },
    { ExecutionOpCode::SENDL2TOL1MSG,
      { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SENDL2TOL1MSG } },
};
 
FF get_subtrace_id(SubtraceSel subtrace_sel)
{
    switch (subtrace_sel) {
    case SubtraceSel::ALU:
        return AVM_SUBTRACE_ID_ALU;
    case SubtraceSel::CAST:
        return AVM_SUBTRACE_ID_CAST;
    case SubtraceSel::SET:
        return AVM_SUBTRACE_ID_SET;
    case SubtraceSel::BITWISE:
        return AVM_SUBTRACE_ID_BITWISE;
    case SubtraceSel::TORADIXBE:
        return AVM_SUBTRACE_ID_TO_RADIX;
    case SubtraceSel::POSEIDON2PERM:
        return AVM_SUBTRACE_ID_POSEIDON_PERM;
    case SubtraceSel::ECC:
        return AVM_SUBTRACE_ID_ECC;
    case SubtraceSel::CALLDATACOPY:
        return AVM_SUBTRACE_ID_CALLDATA_COPY;
    case SubtraceSel::RETURNDATACOPY:
        return AVM_SUBTRACE_ID_RETURNDATA_COPY;
    case SubtraceSel::EXECUTION:
        return AVM_SUBTRACE_ID_EXECUTION;
    case SubtraceSel::KECCAKF1600:
        return AVM_SUBTRACE_ID_KECCAKF1600;
    case SubtraceSel::GETCONTRACTINSTANCE:
        return AVM_SUBTRACE_ID_GETCONTRACTINSTANCE;
    case SubtraceSel::EMITUNENCRYPTEDLOG:
        return AVM_SUBTRACE_ID_EMITUNENCRYPTEDLOG;
    case SubtraceSel::SHA256COMPRESSION:
        return AVM_SUBTRACE_ID_SHA256_COMPRESSION;
    }
 
    // clangd will complain if we miss a case.
    // This is just to please gcc.
    __builtin_unreachable();
}
 
Column get_subtrace_selector(SubtraceSel subtrace_sel)
{
    using C = Column;
 
    switch (subtrace_sel) {
    case SubtraceSel::ALU:
        return C::execution_sel_execute_alu;
    case SubtraceSel::CAST:
        return C::execution_sel_execute_cast;
    case SubtraceSel::SET:
        return C::execution_sel_execute_set;
    case SubtraceSel::BITWISE:
        return C::execution_sel_execute_bitwise;
    case SubtraceSel::TORADIXBE:
        return C::execution_sel_execute_to_radix;
    case SubtraceSel::POSEIDON2PERM:
        return C::execution_sel_execute_poseidon2_perm;
    case SubtraceSel::ECC:
        return C::execution_sel_execute_ecc_add;
    case SubtraceSel::CALLDATACOPY:
        return C::execution_sel_execute_calldata_copy;
    case SubtraceSel::RETURNDATACOPY:
        return C::execution_sel_execute_returndata_copy;
    case SubtraceSel::EXECUTION:
        return C::execution_sel_execute_execution;
    case SubtraceSel::KECCAKF1600:
        return C::execution_sel_execute_keccakf1600;
    case SubtraceSel::GETCONTRACTINSTANCE:
        return C::execution_sel_execute_get_contract_instance;
    case SubtraceSel::EMITUNENCRYPTEDLOG:
        return C::execution_sel_execute_emit_unencrypted_log;
    case SubtraceSel::SHA256COMPRESSION:
        return C::execution_sel_execute_sha256_compression;
    }
 
    // clangd will complain if we miss a case.
    // This is just to please gcc.
    __builtin_unreachable();
}
 
Column get_dyn_gas_selector(uint32_t dyn_gas_id)
{
    using C = Column;
 
    switch (dyn_gas_id) {
    case AVM_DYN_GAS_ID_CALLDATACOPY:
        return C::execution_sel_gas_calldata_copy;
    case AVM_DYN_GAS_ID_RETURNDATACOPY:
        return C::execution_sel_gas_returndata_copy;
    case AVM_DYN_GAS_ID_TORADIX:
        return C::execution_sel_gas_to_radix;
    case AVM_DYN_GAS_ID_BITWISE:
        return C::execution_sel_gas_bitwise;
    case AVM_DYN_GAS_ID_EMITUNENCRYPTEDLOG:
        return C::execution_sel_gas_emit_unencrypted_log;
    case AVM_DYN_GAS_ID_SSTORE:
        return C::execution_sel_gas_sstore;
    default:
        assert(false && "Invalid dynamic gas id");
    }
 
    // This is just to please gcc.
    __builtin_unreachable();
}
 
} // namespace bb::avm2::tracegen