Barretenberg
The ZK-SNARK library at the core of Aztec
Loading...
Searching...
No Matches
instruction_spec.cpp
Go to the documentation of this file.
1#include "barretenberg/vm2/tracegen/lib/instruction_spec.hpp"
2
3#include <array>
4#include <cstdint>
5#include <unordered_map>
6
7#include "barretenberg/aztec/aztec_constants.hpp"
8#include "barretenberg/vm2/common/opcodes.hpp"
9
10namespace bb::avm2::tracegen {
11
12// Map each ExecutionOpcode to a SubtraceInfo - ordered to match ExecutionOpCode enum
13const std::unordered_map<ExecutionOpCode, SubtraceInfo>& get_subtrace_info_map()
14{
15 static const std::unordered_map<ExecutionOpCode, SubtraceInfo> SUBTRACE_INFO_MAP = {
16 { ExecutionOpCode::ADD,
17 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_ADD } },
18 { ExecutionOpCode::SUB,
19 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_SUB } },
20 { ExecutionOpCode::MUL,
21 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_MUL } },
22 { ExecutionOpCode::DIV,
23 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_DIV } },
24 { ExecutionOpCode::FDIV,
25 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_FDIV } },
26 { ExecutionOpCode::EQ,
27 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_EQ } },
28 { ExecutionOpCode::LT,
29 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_LT } },
30 { ExecutionOpCode::LTE,
31 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_LTE } },
32 { ExecutionOpCode::AND,
33 { .subtrace_selector = SubtraceSel::BITWISE, .subtrace_operation_id = AVM_BITWISE_AND_OP_ID } },
34 { ExecutionOpCode::OR,
35 { .subtrace_selector = SubtraceSel::BITWISE, .subtrace_operation_id = AVM_BITWISE_OR_OP_ID } },
36 { ExecutionOpCode::XOR,
37 { .subtrace_selector = SubtraceSel::BITWISE, .subtrace_operation_id = AVM_BITWISE_XOR_OP_ID } },
38 { ExecutionOpCode::NOT,
39 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_NOT } },
40 { ExecutionOpCode::SHL,
41 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_SHL } },
42 { ExecutionOpCode::SHR,
43 { .subtrace_selector = SubtraceSel::ALU, .subtrace_operation_id = AVM_EXEC_OP_ID_ALU_SHR } },
44 { ExecutionOpCode::CAST, { .subtrace_selector = SubtraceSel::CAST, .subtrace_operation_id = 0 } },
45 { ExecutionOpCode::GETENVVAR,
46 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_GETENVVAR } },
47 { ExecutionOpCode::CALLDATACOPY,
48 { .subtrace_selector = SubtraceSel::CALLDATACOPY, .subtrace_operation_id = 0 } },
49 { ExecutionOpCode::SUCCESSCOPY,
50 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SUCCESSCOPY } },
51 { ExecutionOpCode::RETURNDATASIZE,
52 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_RETURNDATASIZE } },
53 { ExecutionOpCode::RETURNDATACOPY,
54 { .subtrace_selector = SubtraceSel::RETURNDATACOPY, .subtrace_operation_id = 0 } },
55 { ExecutionOpCode::JUMP,
56 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_JUMP } },
57 { ExecutionOpCode::JUMPI,
58 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_JUMPI } },
59 { ExecutionOpCode::INTERNALCALL,
60 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_INTERNALCALL } },
61 { ExecutionOpCode::INTERNALRETURN,
62 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_INTERNALRETURN } },
63 { ExecutionOpCode::SET, { .subtrace_selector = SubtraceSel::SET, .subtrace_operation_id = 0 } },
64 { ExecutionOpCode::MOV,
65 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_MOV } },
66 { ExecutionOpCode::SLOAD,
67 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SLOAD } },
68 { ExecutionOpCode::SSTORE,
69 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SSTORE } },
70 { ExecutionOpCode::NOTEHASHEXISTS,
71 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_NOTEHASH_EXISTS } },
72 { ExecutionOpCode::EMITNOTEHASH,
73 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_EMIT_NOTEHASH } },
74 { ExecutionOpCode::NULLIFIEREXISTS,
75 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_NULLIFIER_EXISTS } },
76 { ExecutionOpCode::EMITNULLIFIER,
77 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_EMIT_NULLIFIER } },
78 { ExecutionOpCode::L1TOL2MSGEXISTS,
79 { .subtrace_selector = SubtraceSel::EXECUTION,
80 .subtrace_operation_id = AVM_EXEC_OP_ID_L1_TO_L2_MESSAGE_EXISTS } },
81 { ExecutionOpCode::GETCONTRACTINSTANCE,
82 { .subtrace_selector = SubtraceSel::GETCONTRACTINSTANCE, .subtrace_operation_id = 0 } },
83 { ExecutionOpCode::EMITPUBLICLOG,
84 { .subtrace_selector = SubtraceSel::EMITPUBLICLOG, .subtrace_operation_id = 0 } },
85 { ExecutionOpCode::SENDL2TOL1MSG,
86 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_SENDL2TOL1MSG } },
87 { ExecutionOpCode::CALL,
88 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_CALL } },
89 { ExecutionOpCode::STATICCALL,
90 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_STATICCALL } },
91 { ExecutionOpCode::RETURN,
92 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_RETURN } },
93 { ExecutionOpCode::REVERT,
94 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_REVERT } },
95 { ExecutionOpCode::DEBUGLOG,
96 { .subtrace_selector = SubtraceSel::EXECUTION, .subtrace_operation_id = AVM_EXEC_OP_ID_DEBUGLOG } },
97 { ExecutionOpCode::POSEIDON2PERM,
98 { .subtrace_selector = SubtraceSel::POSEIDON2PERM, .subtrace_operation_id = 0 } },
99 { ExecutionOpCode::SHA256COMPRESSION,
100 { .subtrace_selector = SubtraceSel::SHA256COMPRESSION, .subtrace_operation_id = 0 } },
101 { ExecutionOpCode::KECCAKF1600, { .subtrace_selector = SubtraceSel::KECCAKF1600, .subtrace_operation_id = 0 } },
102 { ExecutionOpCode::ECADD, { .subtrace_selector = SubtraceSel::ECC, .subtrace_operation_id = 0 } },
103 { ExecutionOpCode::TORADIXBE, { .subtrace_selector = SubtraceSel::TORADIXBE, .subtrace_operation_id = 0 } },
104 };
105 return SUBTRACE_INFO_MAP;
106}
107
108FF get_subtrace_id(SubtraceSel subtrace_sel)
109{
110 switch (subtrace_sel) {
111 case SubtraceSel::EXECUTION:
112 return AVM_SUBTRACE_ID_EXECUTION;
113 case SubtraceSel::ALU:
114 return AVM_SUBTRACE_ID_ALU;
115 case SubtraceSel::BITWISE:
116 return AVM_SUBTRACE_ID_BITWISE;
117 case SubtraceSel::CAST:
118 return AVM_SUBTRACE_ID_CAST;
119 case SubtraceSel::CALLDATACOPY:
120 return AVM_SUBTRACE_ID_CALLDATA_COPY;
121 case SubtraceSel::RETURNDATACOPY:
122 return AVM_SUBTRACE_ID_RETURNDATA_COPY;
123 case SubtraceSel::SET:
124 return AVM_SUBTRACE_ID_SET;
125 case SubtraceSel::GETCONTRACTINSTANCE:
126 return AVM_SUBTRACE_ID_GETCONTRACTINSTANCE;
127 case SubtraceSel::EMITPUBLICLOG:
128 return AVM_SUBTRACE_ID_EMITPUBLICLOG;
129 case SubtraceSel::POSEIDON2PERM:
130 return AVM_SUBTRACE_ID_POSEIDON2_PERM;
131 case SubtraceSel::SHA256COMPRESSION:
132 return AVM_SUBTRACE_ID_SHA256_COMPRESSION;
133 case SubtraceSel::KECCAKF1600:
134 return AVM_SUBTRACE_ID_KECCAKF1600;
135 case SubtraceSel::ECC:
136 return AVM_SUBTRACE_ID_ECC;
137 case SubtraceSel::TORADIXBE:
138 return AVM_SUBTRACE_ID_TO_RADIX;
139 }
140
141 // clangd will complain if we miss a case.
142 // This is just to please gcc.
143 __builtin_unreachable();
144}
145
146Column get_subtrace_selector(SubtraceSel subtrace_sel)
147{
148 using C = Column;
149
150 switch (subtrace_sel) {
151 case SubtraceSel::EXECUTION:
152 return C::execution_sel_exec_dispatch_execution;
153 case SubtraceSel::ALU:
154 return C::execution_sel_exec_dispatch_alu;
155 case SubtraceSel::BITWISE:
156 return C::execution_sel_exec_dispatch_bitwise;
157 case SubtraceSel::CAST:
158 return C::execution_sel_exec_dispatch_cast;
159 case SubtraceSel::CALLDATACOPY:
160 return C::execution_sel_exec_dispatch_calldata_copy;
161 case SubtraceSel::RETURNDATACOPY:
162 return C::execution_sel_exec_dispatch_returndata_copy;
163 case SubtraceSel::SET:
164 return C::execution_sel_exec_dispatch_set;
165 case SubtraceSel::GETCONTRACTINSTANCE:
166 return C::execution_sel_exec_dispatch_get_contract_instance;
167 case SubtraceSel::EMITPUBLICLOG:
168 return C::execution_sel_exec_dispatch_emit_public_log;
169 case SubtraceSel::POSEIDON2PERM:
170 return C::execution_sel_exec_dispatch_poseidon2_perm;
171 case SubtraceSel::SHA256COMPRESSION:
172 return C::execution_sel_exec_dispatch_sha256_compression;
173 case SubtraceSel::KECCAKF1600:
174 return C::execution_sel_exec_dispatch_keccakf1600;
175 case SubtraceSel::ECC:
176 return C::execution_sel_exec_dispatch_ecc_add;
177 case SubtraceSel::TORADIXBE:
178 return C::execution_sel_exec_dispatch_to_radix;
179 }
180
181 // clangd will complain if we miss a case.
182 // This is just to please gcc.
183 __builtin_unreachable();
184}
185
186Column get_dyn_gas_selector(uint32_t dyn_gas_id)
187{
188 using C = Column;
189
190 switch (dyn_gas_id) {
191 case AVM_DYN_GAS_ID_CALLDATACOPY:
192 return C::execution_sel_gas_calldata_copy;
193 case AVM_DYN_GAS_ID_RETURNDATACOPY:
194 return C::execution_sel_gas_returndata_copy;
195 case AVM_DYN_GAS_ID_TORADIX:
196 return C::execution_sel_gas_to_radix;
197 case AVM_DYN_GAS_ID_EMITPUBLICLOG:
198 return C::execution_sel_gas_emit_public_log;
199 case AVM_DYN_GAS_ID_SSTORE:
200 return C::execution_sel_gas_sstore;
201 default:
202 BB_ASSERT(false, "Invalid dynamic gas id");
203 }
204
205 // This is just to please gcc.
206 __builtin_unreachable();
207}
208
209} // namespace bb::avm2::tracegen
BB_ASSERT
#define BB_ASSERT(expression,...)
Definition assert.hpp:70
bb::avm2::tracegen::get_dyn_gas_selector
Column get_dyn_gas_selector(uint32_t dyn_gas_id)
Get the column selector for a given dynamic gas ID.
Definition instruction_spec.cpp:186
bb::avm2::tracegen::get_subtrace_info_map
const std::unordered_map< ExecutionOpCode, SubtraceInfo > & get_subtrace_info_map()
Definition instruction_spec.cpp:13
bb::avm2::tracegen::get_subtrace_selector
Column get_subtrace_selector(SubtraceSel subtrace_sel)
Get the column selector for a given subtrace selector.
Definition instruction_spec.cpp:146
bb::avm2::tracegen::get_subtrace_id
FF get_subtrace_id(SubtraceSel subtrace_sel)
Get the subtrace ID for a given subtrace enum.
Definition instruction_spec.cpp:108
bb::avm2::FF
AvmFlavorSettings::FF FF
Definition field.hpp:10
std::get
constexpr decltype(auto) get(::tuplet::tuple< T... > &&t) noexcept
Definition tuple.hpp:13
instruction_spec.hpp