Line data Source code
1 : #ifndef HEADER_fd_src_flamenco_vm_fd_vm_base_h
2 : #define HEADER_fd_src_flamenco_vm_fd_vm_base_h
3 :
4 : /* FIXME: Headers included from other modules need cleanup. As it
5 : stands, flamenco_base brings in types/custom, types/meta,
6 : types/bincode, ballet/base58, ballet/sha256, ballet/sha512,
7 : ballet/ed25519, ballet/txnthis also brings in util, flamenco_base,
8 : ballet/base58, util and the optional util/net/ipv4 ballet/sha256,
9 : most of which is probably not necessary to use this module in a
10 : somewhat haphazard fashion (include no-no things that are only
11 : available in hosted environments like stdio and stdlib) */
12 :
13 : #include "../fd_flamenco_base.h"
14 : #include "../../ballet/sbpf/fd_sbpf_loader.h" /* FIXME: functionality needed from here probably should be moved here */
15 : #include "../features/fd_features.h"
16 :
17 : /* Defines the different VM access types */
18 177 : #define FD_VM_ACCESS_TYPE_LD (1)
19 162 : #define FD_VM_ACCESS_TYPE_ST (2)
20 :
21 : /* FD_VM_SUCCESS is zero and returned to indicate that an operation
22 : completed successfully. FD_VM_ERR_* are negative integers and
23 : returned to indicate an operation that failed and why. */
24 :
25 : /* "Standard" Firedancer error codes (FIXME: harmonize and consolidate) */
26 :
27 56467394 : #define FD_VM_SUCCESS ( 0) /* success */
28 1891752 : #define FD_VM_ERR_INVAL (-1) /* invalid request */
29 3 : #define FD_VM_ERR_UNSUP (-3) /* unsupported request */
30 6 : #define FD_VM_ERR_FULL (-5) /* storage full */
31 3 : #define FD_VM_ERR_EMPTY (-6) /* nothing to do */
32 3 : #define FD_VM_ERR_IO (-7) /* input-output error */
33 :
34 : /* VM exec error codes: These are only produced by the VM itself. */
35 :
36 60 : #define FD_VM_ERR_SIGFPE (-18) /* divide by zero */
37 :
38 : /* sBPF validation error codes. These are only produced by
39 : fd_vm_validate. FIXME: Consider having fd_vm_validate return
40 : standard error codes and then provide detail like this through an
41 : info arg. FIXME: Are these exact matches to Solana? If so, provide
42 : link, if not, document and refine name / consolidate further. */
43 :
44 1185 : #define FD_VM_ERR_INVALID_OPCODE (-25) /* detected an invalid opcode */
45 471 : #define FD_VM_ERR_INVALID_SRC_REG (-26) /* detected an invalid source register */
46 675 : #define FD_VM_ERR_INVALID_DST_REG (-27) /* detected an invalid destination register */
47 150 : #define FD_VM_ERR_JMP_OUT_OF_BOUNDS (-29) /* detected an out of bounds jump */
48 3 : #define FD_VM_ERR_JMP_TO_ADDL_IMM (-30) /* detected a jump to an addl imm */
49 21 : #define FD_VM_ERR_INVALID_END_IMM (-31) /* detected an invalid immediate for an endianness conversion instruction */
50 3 : #define FD_VM_ERR_INCOMPLETE_LDQ (-32) /* detected an incomplete ldq at program end */
51 3 : #define FD_VM_ERR_LDQ_NO_ADDL_IMM (-33) /* detected a ldq without an addl imm following it */
52 21 : #define FD_VM_ERR_INVALID_REG (-35) /* detected an invalid register */
53 0 : #define FD_VM_ERR_BAD_TEXT (-36) /* detected a bad text section (overflow, outside rodata boundary, etc.,)*/
54 198 : #define FD_VM_SH_OVERFLOW (-37) /* detected a shift overflow, equivalent to VeriferError::ShiftWithOverflow */
55 0 : #define FD_VM_TEXT_SZ_UNALIGNED (-38) /* detected a text section that is not a multiple of 8 */
56 : #define FD_VM_INVALID_FUNCTION (-39) /* detected an invalid function */
57 : #define FD_VM_INVALID_SYSCALL (-40) /* detected an invalid syscall */
58 :
59 : /* Syscall Errors
60 : https://github.com/anza-xyz/agave/blob/v2.0.7/programs/bpf_loader/src/syscalls/mod.rs#L81 */
61 :
62 0 : #define FD_VM_SYSCALL_ERR_INVALID_STRING (-1)
63 0 : #define FD_VM_SYSCALL_ERR_ABORT (-2)
64 0 : #define FD_VM_SYSCALL_ERR_PANIC (-3)
65 0 : #define FD_VM_SYSCALL_ERR_INVOKE_CONTEXT_BORROW_FAILED (-4)
66 0 : #define FD_VM_SYSCALL_ERR_MALFORMED_SIGNER_SEED (-5)
67 12 : #define FD_VM_SYSCALL_ERR_BAD_SEEDS (-6)
68 6 : #define FD_VM_SYSCALL_ERR_PROGRAM_NOT_SUPPORTED (-7)
69 0 : #define FD_VM_SYSCALL_ERR_UNALIGNED_POINTER (-8)
70 6 : #define FD_VM_SYSCALL_ERR_TOO_MANY_SIGNERS (-9)
71 0 : #define FD_VM_SYSCALL_ERR_INSTRUCTION_TOO_LARGE (-10)
72 0 : #define FD_VM_SYSCALL_ERR_TOO_MANY_ACCOUNTS (-11)
73 36 : #define FD_VM_SYSCALL_ERR_COPY_OVERLAPPING (-12)
74 0 : #define FD_VM_SYSCALL_ERR_RETURN_DATA_TOO_LARGE (-13)
75 12 : #define FD_VM_SYSCALL_ERR_TOO_MANY_SLICES (-14)
76 3 : #define FD_VM_SYSCALL_ERR_INVALID_LENGTH (-15)
77 0 : #define FD_VM_SYSCALL_ERR_MAX_INSTRUCTION_DATA_LEN_EXCEEDED (-16)
78 6 : #define FD_VM_SYSCALL_ERR_MAX_INSTRUCTION_ACCOUNTS_EXCEEDED (-17)
79 6 : #define FD_VM_SYSCALL_ERR_MAX_INSTRUCTION_ACCOUNT_INFOS_EXCEEDED (-18)
80 3 : #define FD_VM_SYSCALL_ERR_INVALID_ATTRIBUTE (-19)
81 258 : #define FD_VM_SYSCALL_ERR_INVALID_POINTER (-20)
82 0 : #define FD_VM_SYSCALL_ERR_ARITHMETIC_OVERFLOW (-21)
83 :
84 : /* These syscall errors are unique to Firedancer and do not have an Agave equivalent. */
85 0 : #define FD_VM_SYSCALL_ERR_INSTR_ERR (-22)
86 0 : #define FD_VM_SYSCALL_ERR_INVALID_PDA (-23) /* the computed pda was not a valid ed25519 point */
87 6 : #define FD_VM_SYSCALL_ERR_COMPUTE_BUDGET_EXCEEDED (-24) /* compute unit limit exceeded in syscall */
88 138 : #define FD_VM_SYSCALL_ERR_SEGFAULT (-25) /* illegal memory address (e.g. read/write to an address not backed by any memory) in syscall */
89 0 : #define FD_VM_SYSCALL_ERR_OUTSIDE_RUNTIME (-26) /* syscall called with vm not running in solana runtime */
90 :
91 : /* Poseidon returns custom errors for some reason */
92 0 : #define FD_VM_SYSCALL_ERR_POSEIDON_INVALID_PARAMS (1)
93 0 : #define FD_VM_SYSCALL_ERR_POSEIDON_INVALID_ENDIANNESS (2)
94 :
95 : /* EbpfError
96 : https://github.com/anza-xyz/sbpf/blob/main/src/error.rs#L20-L78 */
97 :
98 0 : #define FD_VM_ERR_EBPF_ELF_ERROR (-1)
99 0 : #define FD_VM_ERR_EBPF_FUNCTION_ALREADY_REGISTERED (-2)
100 3 : #define FD_VM_ERR_EBPF_CALL_DEPTH_EXCEEDED (-3)
101 0 : #define FD_VM_ERR_EBPF_EXIT_ROOT_CALL_FRAME (-4)
102 138 : #define FD_VM_ERR_EBPF_DIVIDE_BY_ZERO (-5)
103 36 : #define FD_VM_ERR_EBPF_DIVIDE_OVERFLOW (-6)
104 87 : #define FD_VM_ERR_EBPF_EXECUTION_OVERRUN (-7)
105 42 : #define FD_VM_ERR_EBPF_CALL_OUTSIDE_TEXT_SEGMENT (-8)
106 831 : #define FD_VM_ERR_EBPF_EXCEEDED_MAX_INSTRUCTIONS (-9)
107 0 : #define FD_VM_ERR_EBPF_JIT_NOT_COMPILED (-10)
108 0 : #define FD_VM_ERR_EBPF_INVALID_MEMORY_REGION (-11)
109 315 : #define FD_VM_ERR_EBPF_ACCESS_VIOLATION (-12)
110 0 : #define FD_VM_ERR_EBPF_STACK_ACCESS_VIOLATION (-13)
111 18 : #define FD_VM_ERR_EBPF_INVALID_INSTRUCTION (-14)
112 1203 : #define FD_VM_ERR_EBPF_UNSUPPORTED_INSTRUCTION (-15)
113 0 : #define FD_VM_ERR_EBPF_EXHAUSTED_TEXT_SEGMENT (-16)
114 0 : #define FD_VM_ERR_EBPF_LIBC_INVOCATION_FAILED (-17)
115 0 : #define FD_VM_ERR_EBPF_VERIFIER_ERROR (-18)
116 6 : #define FD_VM_ERR_EBPF_SYSCALL_ERROR (-19)
117 :
118 :
119 : FD_PROTOTYPES_BEGIN
120 :
121 : /* fd_vm_strerror converts an FD_VM_SUCCESS / FD_VM_ERR_* code into
122 : a human readable cstr. The lifetime of the returned pointer is
123 : infinite. The returned pointer is always to a non-NULL cstr. */
124 :
125 : FD_FN_CONST char const * fd_vm_strerror( int err );
126 :
127 : FD_PROTOTYPES_END
128 :
129 : /* fd_vm_limits API ***************************************************/
130 :
131 : /* FIXME: pretty good case these actually belong in ballet/sbpf */
132 : /* FIXME: DOCUMENT THESE / LINK TO SOLANA CODE / ETC */
133 :
134 : /* VM register constants */
135 :
136 330 : #define FD_VM_REG_CNT (11UL)
137 17262 : #define FD_VM_REG_MAX (16UL) /* Actual number of SBPF instruction src/dst register indices */
138 :
139 : #define FD_VM_SHADOW_REG_CNT (4UL)
140 :
141 : /* VM stack constants */
142 :
143 51114 : #define FD_VM_STACK_FRAME_MAX (64UL)
144 53025 : #define FD_VM_STACK_FRAME_SZ FD_VM_STACK_FRAME_SIZE
145 : #define FD_VM_STACK_GUARD_SZ (0x1000UL)
146 39783 : #define FD_VM_STACK_MAX (FD_VM_STACK_FRAME_MAX*(FD_VM_STACK_FRAME_SZ))
147 :
148 : /* VM heap constants */
149 :
150 768 : #define FD_VM_HEAP_DEFAULT ( 32UL*1024UL) /* FIXME: SHOULD THIS MATCH FD_VM_HEAP_SIZE LIMIT BELOW? */
151 0 : #define FD_VM_HEAP_MAX (256UL*1024UL)
152 :
153 : /* VM log constants */
154 :
155 27 : #define FD_VM_LOG_MAX (10000UL)
156 : #define FD_VM_LOG_TAIL (128UL) /* Large enough to cover the worst case syscall log tail clobbering in string parsing */
157 :
158 : /* VM memory map constants
159 :
160 : The sBPF virtual address space is divided into 4 GiB regions:
161 :
162 : SBPF V0-V2:
163 : region 0 0x000000000 (unmapped)
164 : region 1 0x100000000 program (full ELF: rodata + text)
165 : region 2 0x200000000 stack
166 : region 3 0x300000000 heap
167 : region 4 0x400000000 input
168 :
169 : SBPF V3:
170 : region 0 0x000000000 rodata segment (read-only)
171 : region 1 0x100000000 (unmapped, bytecode execute-only)
172 : region 2 0x200000000 stack
173 : region 3 0x300000000 heap
174 : region 4 0x400000000 input
175 :
176 : https://github.com/anza-xyz/sbpf/blob/v0.14.4/src/ebpf.rs#L42-L51 */
177 :
178 : #define FD_VM_LO_REGION (0UL)
179 53163 : #define FD_VM_PROG_REGION (1UL)
180 53163 : #define FD_VM_STACK_REGION (2UL)
181 53163 : #define FD_VM_HEAP_REGION (3UL)
182 132675 : #define FD_VM_INPUT_REGION (4UL)
183 79512 : #define FD_VM_HIGH_REGION (5UL)
184 :
185 54 : #define FD_VM_MEM_MAP_RODATA_REGION_START (0x000000000UL) /* SBPF V3+ only */
186 54 : #define FD_VM_MEM_MAP_PROGRAM_REGION_START (0x100000000UL)
187 17577 : #define FD_VM_MEM_MAP_STACK_REGION_START (0x200000000UL)
188 20121 : #define FD_VM_MEM_MAP_HEAP_REGION_START (0x300000000UL)
189 81639 : #define FD_VM_MEM_MAP_INPUT_REGION_START (0x400000000UL)
190 : #define FD_VM_MEM_MAP_REGION_SZ (0x0FFFFFFFFUL)
191 : #define FD_VM_MEM_MAP_REGION_MASK (~FD_VM_MEM_MAP_REGION_SZ)
192 79512 : #define FD_VM_MEM_MAP_REGION_VIRT_ADDR_BITS (32)
193 :
194 : /* VM compute budget. Note: these names should match exactly the names
195 : used in existing Solana validator. See:
196 : https://github.com/anza-xyz/agave/blob/v1.18.5/program-runtime/src/compute_budget.rs#L19
197 : https://github.com/anza-xyz/agave/blob/v1.18.5/program-runtime/src/compute_budget.rs#L133 */
198 : /* FIXME: DOUBLE CHECK THESE */
199 :
200 : /* FD_VM_COMPUTE_UNIT_LIMIT is the number of compute units that a
201 : transaction or individual instruction is allowed to consume. Compute
202 : units are consumed by program execution, resources they use, etc ... */
203 :
204 504 : #define FD_VM_COMPUTE_UNIT_LIMIT ( 1400000UL)
205 :
206 : /* FD_VM_LOG_64_UNITS is the number of compute units consumed by a
207 : log_64 call */
208 :
209 : #define FD_VM_LOG_64_UNITS ( 100UL)
210 :
211 : /* FD_VM_CREATE_PROGRAM_ADDRESS_UNITS is the number of compute units
212 : consumed by a create_program_address call and a try_find_program_address_call */
213 :
214 : #define FD_VM_CREATE_PROGRAM_ADDRESS_UNITS ( 1500UL)
215 :
216 : /* FD_VM_INVOKE_UNITS is the number of compute units consumed by an
217 : invoke call (not including the cost incurred by the called program)
218 : https://github.com/anza-xyz/agave/blob/v3.1.2/program-runtime/src/execution_budget.rs#L22-L23 */
219 3255 : #define FD_VM_INVOKE_UNITS ( 946UL)
220 :
221 : /* SIMD-0339 uses a fixed size (80 bytes) to bill each account info:
222 : - 32 bytes for account address
223 : - 32 bytes for owner address
224 : - 8 bytes for lamports
225 : - 8 bytes for data length
226 : https://github.com/anza-xyz/agave/blob/v3.1.2/program-runtime/src/cpi.rs#L63-L68
227 : */
228 3081 : #define FD_VM_ACCOUNT_INFO_BYTE_SIZE ( 80UL)
229 :
230 : /* FD_VM_MAX_INVOKE_STACK_HEIGHT is the maximum program instruction
231 : invocation stack height. Invocation stack height starts at 1 for
232 : transaction instructions and the stack height is incremented each
233 : time a program invokes an instruction and decremented when a program
234 : returns */
235 :
236 : #define FD_VM_MAX_INVOKE_STACK_HEIGHT ( 5UL)
237 :
238 : /* FD_VM_MAX_INSTRUCTION_TRACE_LENGTH is the maximum cross-program
239 : invocation and instructions per transaction */
240 :
241 : #define FD_VM_MAX_INSTRUCTION_TRACE_LENGTH ( 64UL)
242 :
243 : /* FD_VM_SHA256_BASE_COST is the base number of compute units consumed
244 : to call SHA256 */
245 :
246 0 : #define FD_VM_SHA256_BASE_COST ( 85UL)
247 :
248 : /* FD_VM_SHA256_BYTE_COST is the incremental number of units consumed by
249 : SHA256 (based on bytes) */
250 :
251 48 : #define FD_VM_SHA256_BYTE_COST ( 1UL)
252 :
253 : /* FD_VM_SHA256_MAX_SLICES is the maximum number of slices hashed per
254 : syscall */
255 :
256 24 : #define FD_VM_SHA256_MAX_SLICES ( 20000UL)
257 :
258 : /* FD_VM_MAX_CALL_DEPTH is the maximum SBF to BPF call depth */
259 :
260 99 : #define FD_VM_MAX_CALL_DEPTH ( 64UL)
261 :
262 : /* FD_VM_STACK_FRAME_SIZE is the size of a stack frame in bytes, must
263 : match the size specified in the LLVM SBF backend */
264 :
265 53025 : #define FD_VM_STACK_FRAME_SIZE ( 4096UL)
266 :
267 : /* FD_VM_LOG_PUBKEY_UNITS is the number of compute units consumed by
268 : logging a `Pubkey` */
269 :
270 : #define FD_VM_LOG_PUBKEY_UNITS ( 100UL)
271 :
272 : /* FD_VM_MAX_CPI_INSTRUCTION_SIZE is the maximum cross-program
273 : invocation instruction size */
274 :
275 : #define FD_VM_MAX_CPI_INSTRUCTION_SIZE ( 1280UL) /* IPv6 Min MTU size */
276 :
277 : /* FD_VM_CPI_MAX_INSTRUCTION_ACCOUNTS is the maximum number of accounts
278 : that can be referenced by a single CPI instruction.
279 :
280 : Agave's bound for this is the same as their bound for the bound
281 : enforced by the bpf loader serializer.
282 : https://github.com/anza-xyz/agave/blob/v3.1.1/transaction-context/src/lib.rs#L32
283 :
284 : TODO: when SIMD-406 is activated, we can use FD_INSTR_ACCT_MAX instead. */
285 :
286 : #define FD_VM_CPI_MAX_INSTRUCTION_ACCOUNTS (FD_BPF_INSTR_ACCT_MAX)
287 :
288 : /* FD_VM_CPI_BYTES_PER_UNIT is the number of account data bytes per
289 : compute unit charged during a cross-program invocation */
290 :
291 6486 : #define FD_VM_CPI_BYTES_PER_UNIT ( 250UL) /* ~50MB at 200,000 units */
292 :
293 : /* FD_VM_SYSVAR_BASE_COST is the base number of compute units consumed
294 : to get a sysvar */
295 :
296 : #define FD_VM_SYSVAR_BASE_COST ( 100UL)
297 :
298 : /* FD_VM_SECP256K1_RECOVER_COST is the number of compute units consumed
299 : to call secp256k1_recover */
300 :
301 : #define FD_VM_SECP256K1_RECOVER_COST ( 25000UL)
302 :
303 : /* FD_VM_SYSCALL_BASE_COST is the number of compute units consumed to do
304 : a syscall without any work */
305 :
306 0 : #define FD_VM_SYSCALL_BASE_COST ( 100UL)
307 :
308 : /* FD_VM_CURVE_EDWARDS_VALIDATE_POINT_COST is the number of compute
309 : units consumed to validate a curve25519 edwards point */
310 :
311 : #define FD_VM_CURVE_EDWARDS_VALIDATE_POINT_COST ( 159UL)
312 :
313 : /* FD_VM_CURVE_EDWARDS_ADD_COST is the number of compute units
314 : consumed to add two curve25519 edwards points */
315 :
316 0 : #define FD_VM_CURVE_EDWARDS_ADD_COST ( 473UL)
317 :
318 : /* FD_VM_CURVE_EDWARDS_SUBTRACT_COST is the number of compute units
319 : consumed to subtract two curve25519 edwards points */
320 :
321 0 : #define FD_VM_CURVE_EDWARDS_SUBTRACT_COST ( 475UL)
322 :
323 : /* FD_VM_CURVE_EDWARDS_MULTIPLY_COST is the number of compute units
324 : consumed to multiply a curve25519 edwards point */
325 :
326 0 : #define FD_VM_CURVE_EDWARDS_MULTIPLY_COST ( 2177UL)
327 :
328 : /* FD_VM_CURVE_EDWARDS_MSM_BASE_COST is the number of compute units
329 : consumed for a multiscalar multiplication (msm) of edwards points.
330 : The total cost is calculated as
331 : `msm_base_cost + (length - 1) * msm_incremental_cost` */
332 :
333 6 : #define FD_VM_CURVE_EDWARDS_MSM_BASE_COST ( 2273UL)
334 :
335 : /* FD_VM_CURVE_EDWARDS_MSM_INCREMENTAL_COST is the number of
336 : compute units consumed for a multiscalar multiplication (msm) of
337 : edwards points. The total cost is calculated as
338 : `msm_base_cost + (length - 1) * msm_incremental_cost` */
339 :
340 6 : #define FD_VM_CURVE_EDWARDS_MSM_INCREMENTAL_COST ( 758UL)
341 :
342 : /* FD_VM_CURVE_RISTRETTO_VALIDATE_POINT_COST is the number of
343 : compute units consumed to validate a curve25519 ristretto point */
344 :
345 : #define FD_VM_CURVE_RISTRETTO_VALIDATE_POINT_COST ( 169UL)
346 :
347 : /* FD_VM_CURVE_RISTRETTO_ADD_COST is the number of compute units
348 : consumed to add two curve25519 ristretto points */
349 :
350 6 : #define FD_VM_CURVE_RISTRETTO_ADD_COST ( 521UL)
351 :
352 : /* FD_VM_CURVE_RISTRETTO_SUBTRACT_COST is the number of compute
353 : units consumed to subtract two curve25519 ristretto points */
354 :
355 3 : #define FD_VM_CURVE_RISTRETTO_SUBTRACT_COST ( 519UL)
356 :
357 : /* FD_VM_CURVE_RISTRETTO_MULTIPLY_COST is the number of compute
358 : units consumed to multiply a curve25519 ristretto point */
359 :
360 3 : #define FD_VM_CURVE_RISTRETTO_MULTIPLY_COST ( 2208UL)
361 :
362 : /* FD_VM_CURVE_RISTRETTO_MSM_BASE_COST is the number of compute
363 : units consumed for a multiscalar multiplication (msm) of ristretto
364 : points. The total cost is calculated as
365 : `msm_base_cost + (length - 1) * msm_incremental_cost` */
366 :
367 3 : #define FD_VM_CURVE_RISTRETTO_MSM_BASE_COST ( 2303UL)
368 :
369 : /* FD_VM_CURVE_RISTRETTO_MSM_INCREMENTAL_COST is the number of
370 : compute units consumed for a multiscalar multiplication (msm) of
371 : ristretto points. The total cost is calculated as
372 : `msm_base_cost + (length - 1) * msm_incremental_cost` */
373 :
374 3 : #define FD_VM_CURVE_RISTRETTO_MSM_INCREMENTAL_COST ( 788UL)
375 :
376 : /* FD_VM_CURVE_BLS12_381_G1_ADD_COST is the number of compute
377 : units consumed for addition in BLS12-381 G1. */
378 :
379 3 : #define FD_VM_CURVE_BLS12_381_G1_ADD_COST ( 128UL)
380 :
381 : /* FD_VM_CURVE_BLS12_381_G2_ADD_COST is the number of compute
382 : units consumed for addition in BLS12-381 G2. */
383 :
384 0 : #define FD_VM_CURVE_BLS12_381_G2_ADD_COST ( 203UL)
385 :
386 : /* FD_VM_CURVE_BLS12_381_G1_SUB_COST is the number of compute
387 : units consumed for subtraction in BLS12-381 G1. */
388 :
389 0 : #define FD_VM_CURVE_BLS12_381_G1_SUB_COST ( 129UL)
390 :
391 : /* FD_VM_CURVE_BLS12_381_G2_SUB_COST is the number of compute
392 : units consumed for subtraction in BLS12-381 G2. */
393 :
394 0 : #define FD_VM_CURVE_BLS12_381_G2_SUB_COST ( 204UL)
395 :
396 : /* FD_VM_CURVE_BLS12_381_G1_MUL_COST is the number of compute
397 : units consumed for multiplication in BLS12-381 G1. */
398 :
399 0 : #define FD_VM_CURVE_BLS12_381_G1_MUL_COST ( 4627UL)
400 :
401 : /* FD_VM_CURVE_BLS12_381_G2_MUL_COST is the number of compute
402 : units consumed for multiplication in BLS12-381 G2. */
403 :
404 0 : #define FD_VM_CURVE_BLS12_381_G2_MUL_COST ( 8255UL)
405 :
406 : /* FD_VM_CURVE_BLS12_381_G1_DECOMPRESS_COST is the number of compute
407 : units consumed for point decompression in BLS12-381 G1. */
408 : #define FD_VM_CURVE_BLS12_381_G1_DECOMPRESS_COST ( 2100UL)
409 :
410 : /* FD_VM_CURVE_BLS12_381_G2_DECOMPRESS_COST is the number of compute
411 : units consumed for point decompression in BLS12-381 G2. */
412 :
413 : #define FD_VM_CURVE_BLS12_381_G2_DECOMPRESS_COST ( 3050UL)
414 :
415 : /* FD_VM_CURVE_BLS12_381_G1_VALIDATE_COST is the number of compute
416 : units consumed for point validation in BLS12-381 G1. */
417 :
418 : #define FD_VM_CURVE_BLS12_381_G1_VALIDATE_COST ( 1565UL)
419 :
420 : /* FD_VM_CURVE_BLS12_381_G2_VALIDATE_COST is the number of compute
421 : units consumed for point validation in BLS12-381 G2. */
422 :
423 : #define FD_VM_CURVE_BLS12_381_G2_VALIDATE_COST ( 1968UL)
424 :
425 : /* FD_VM_CURVE_BLS12_381_PAIRING_*_COST are the number of compute
426 : units consumed for calculating a pairing map in BLS12-381.
427 : The total cost is calculated as
428 : `pairing_base_cost + (length-1) * pairing_incr_cost` */
429 :
430 6 : #define FD_VM_CURVE_BLS12_381_PAIRING_BASE_COST ( 25445UL)
431 6 : #define FD_VM_CURVE_BLS12_381_PAIRING_INCR_COST ( 13023UL)
432 :
433 : /* FD_VM_HEAP_SIZE is the program heap region size, default:
434 : solana_sdk::entrypoint::HEAP_LENGTH */
435 :
436 : #define FD_VM_HEAP_SIZE ( 32768UL)
437 :
438 : /* FD_VM_HEAP_COST is the number of compute units per additional 32k
439 : heap above the default (~.5 us per 32k at 15 units/us rounded up) */
440 :
441 2751 : #define FD_VM_HEAP_COST ( 8UL) /* DEFAULT_HEAP_COST */
442 :
443 : /* FD_VM_MEM_OP_BASE_COST is the memory operation syscall base cost */
444 :
445 48 : #define FD_VM_MEM_OP_BASE_COST ( 10UL)
446 :
447 : /* FD_VM_ALT_BN128_ADDITION_COST is the number of compute units consumed
448 : to call alt_bn128_addition */
449 :
450 0 : #define FD_VM_ALT_BN128_G1_ADDITION_COST ( 334UL)
451 0 : #define FD_VM_ALT_BN128_G2_ADDITION_COST ( 535UL)
452 :
453 : /* FD_VM_ALT_BN128_MULTIPLICATION_COST is the number of compute units
454 : consumed to call alt_bn128_multiplication */
455 :
456 0 : #define FD_VM_ALT_BN128_G1_MULTIPLICATION_COST ( 3840UL)
457 0 : #define FD_VM_ALT_BN128_G2_MULTIPLICATION_COST ( 15670UL)
458 :
459 : /* FD_VM_ALT_BN128_PAIRING_ONE_PAIR_COST_FIRST
460 : FD_VM_ALT_BN128_PAIRING_ONE_PAIR_COST_OTHER give the total cost as
461 : alt_bn128_pairing_one_pair_cost_first + alt_bn128_pairing_one_pair_cost_other * (num_elems - 1) */
462 :
463 0 : #define FD_VM_ALT_BN128_PAIRING_ONE_PAIR_COST_FIRST ( 36364UL)
464 0 : #define FD_VM_ALT_BN128_PAIRING_ONE_PAIR_COST_OTHER ( 12121UL)
465 :
466 : /* FD_VM_BIG_MODULAR_EXPONENTIATION_COST is the big integer modular
467 : exponentiation cost */
468 :
469 : #define FD_VM_BIG_MODULAR_EXPONENTIATION_COST ( 33UL)
470 :
471 : /* FD_VM_POSEIDON_COST_COEFFICIENT_A is the coefficient `a` of the
472 : quadratic function which determines the number of compute units
473 : consumed to call poseidon syscall for a given number of inputs */
474 :
475 0 : #define FD_VM_POSEIDON_COST_COEFFICIENT_A ( 61UL)
476 :
477 : /* FD_VM_POSEIDON_COST_COEFFICIENT_C is the coefficient `c` of the
478 : quadratic function which determines the number of compute units
479 : consumed to call poseidon syscall for a given number of inputs */
480 :
481 0 : #define FD_VM_POSEIDON_COST_COEFFICIENT_C ( 542UL)
482 :
483 : /* FD_VM_GET_REMAINING_COMPUTE_UNITS_COST is the number of compute units
484 : consumed for reading the remaining compute units */
485 :
486 : #define FD_VM_GET_REMAINING_COMPUTE_UNITS_COST ( 100UL)
487 :
488 : /* FD_VM_ALT_BN128_G1_COMPRESS is the number of compute units consumed
489 : to call alt_bn128_g1_compress */
490 :
491 0 : #define FD_VM_ALT_BN128_G1_COMPRESS ( 30UL)
492 :
493 : /* FD_VM_ALT_BN128_G1_DECOMPRESS is the number of compute units consumed
494 : to call alt_bn128_g1_decompress */
495 :
496 0 : #define FD_VM_ALT_BN128_G1_DECOMPRESS ( 398UL)
497 :
498 : /* FD_VM_ALT_BN128_G2_COMPRESS is the number of compute units consumed
499 : to call alt_bn128_g2_compress */
500 :
501 0 : #define FD_VM_ALT_BN128_G2_COMPRESS ( 86UL)
502 :
503 : /* FD_VM_ALT_BN128_G2_DECOMPRESS is the number of compute units consumed
504 : to call alt_bn128_g2_decompress */
505 :
506 0 : #define FD_VM_ALT_BN128_G2_DECOMPRESS ( 13610UL)
507 :
508 : /* FD_VM_LOADED_ACCOUNTS_DATA_SIZE_LIMIT is the maximum accounts data
509 : size, in bytes, that a transaction is allowed to load */
510 :
511 303 : #define FD_VM_LOADED_ACCOUNTS_DATA_SIZE_LIMIT (64UL*1024UL*1024UL) /* 64MiB */
512 :
513 : /* fd_vm_disasm API ***************************************************/
514 :
515 : /* FIXME: pretty good case this actually belongs in ballet/sbpf */
516 : /* FIXME: fd_sbpf_instr_t is nominally a ulong but implemented using
517 : bit-fields. Compilers tend to generate notoriously poor asm for bit
518 : fields ... check ASM here. */
519 :
520 : FD_PROTOTYPES_BEGIN
521 :
522 : /* fd_vm_disasm_{instr,program} appends to the *_out_len (in strlen
523 : sense) cstr in the out_max byte buffer out a pretty printed cstr of
524 : the {instruction,program}. If syscalls is non-NULL, syscalls will be
525 : annotated with the names from the provided syscall mapping.
526 :
527 : On input, *_out_len should be strlen(out) and in [0,out_max). For
528 : instr, pc is the program counter corresponding to text[0] (as such
529 : text_cnt should be positive) and text_cnt is the number of words
530 : available at text to support safely printing multiword instructions.
531 :
532 : Given a valid out on input, on output, *_out_len will be strlen(out)
533 : and in [0,out_max), even if there was an error.
534 :
535 : Returns:
536 :
537 : FD_VM_SUCCESS - out buffer and *_out_len updated.
538 :
539 : FD_VM_ERR_INVAL - Invalid input. For instr, out buffer and *_out_len
540 : are unchanged. For program, out buffer and *_out_len will have been
541 : updated up to the point where the error occurred.
542 :
543 : FD_VM_ERR_UNSUP - For program, too many functions and/or labels for
544 : the current implementation. out buffer and *_out_len unchanged.
545 :
546 : FD_VM_ERR_FULL - Not enough room in out to hold the result so output
547 : was truncated. out buffer and *_out_len updated.
548 :
549 : FD_VM_ERR_IO - An error occurred formatting the string to append. For
550 : instr, out_buffer and *_out_len unchanged. For program, out buffer
551 : and *_out_len will have been updated up to the point where the error
552 : occurred. In both cases, trailing bytes of out might have been
553 : clobbered. */
554 :
555 : int
556 : fd_vm_disasm_instr( ulong const * text, /* Indexed [0,text_cnt) */
557 : ulong text_cnt,
558 : ulong pc,
559 : fd_sbpf_syscalls_t const * syscalls,
560 : char * out, /* Indexed [0,out_max) */
561 : ulong out_max,
562 : ulong * _out_len );
563 :
564 : int
565 : fd_vm_disasm_program( ulong const * text, /* Indexed [0,text_cnt) */
566 : ulong text_cnt,
567 : fd_sbpf_syscalls_t const * syscalls,
568 : char * out, /* Indexed [0,out_max) */
569 : ulong out_max,
570 : ulong * _out_len );
571 :
572 : FD_PROTOTYPES_END
573 :
574 : /* fd_vm_trace API ****************************************************/
575 :
576 : /* FIXME: pretty good case this actually belongs in ballet/sbpf */
577 :
578 : /* A FD_VM_TRACE_EVENT_TYPE_* indicates how a fd_vm_trace_event_t should
579 : be interpreted. */
580 :
581 30 : #define FD_VM_TRACE_EVENT_TYPE_EXE (0)
582 24 : #define FD_VM_TRACE_EVENT_TYPE_READ (1)
583 24 : #define FD_VM_TRACE_EVENT_TYPE_WRITE (2)
584 :
585 : struct fd_vm_trace_event_exe {
586 : /* This point is aligned 8 */
587 : ulong info; /* Event info bit field */
588 : ulong pc; /* pc */
589 : ulong ic; /* ic */
590 : ulong cu; /* cu */
591 : ulong ic_correction; /* ic_correction */
592 : ulong frame_cnt; /* frame_cnt */
593 : ulong reg[ FD_VM_REG_CNT ]; /* registers */
594 : ulong text[ 2 ]; /* If the event has valid clear, this is actually text[1] */
595 : /* This point is aligned 8 */
596 : };
597 :
598 : typedef struct fd_vm_trace_event_exe fd_vm_trace_event_exe_t;
599 :
600 : struct fd_vm_trace_event_mem {
601 : /* This point is aligned 8 */
602 : ulong info; /* Event info bit field */
603 : ulong vaddr; /* VM address range associated with event */
604 : ulong sz;
605 : /* This point is aligned 8
606 : If event has valid set:
607 : min(sz,event_data_max) bytes user data bytes
608 : padding to aligned 8 */
609 : };
610 :
611 : typedef struct fd_vm_trace_event_mem fd_vm_trace_event_mem_t;
612 :
613 3 : #define FD_VM_TRACE_MAGIC (0xfdc377ace3a61c00UL) /* FD VM TRACE MAGIC version 0 */
614 :
615 : struct fd_vm_trace {
616 : /* This point is aligned 8 */
617 : ulong magic; /* ==FD_VM_TRACE_MAGIC */
618 : ulong event_max; /* Number bytes of event storage */
619 : ulong event_data_max; /* Max bytes to capture per data event */
620 : ulong event_sz; /* Used bytes of event storage */
621 : /* This point is aligned 8
622 : event_max bytes storage
623 : padding to aligned 8 */
624 : };
625 :
626 : typedef struct fd_vm_trace fd_vm_trace_t;
627 :
628 : FD_PROTOTYPES_BEGIN
629 :
630 : /* trace object structors */
631 : /* FIXME: DOCUMENT (USUAL CONVENTIONS) */
632 :
633 : FD_FN_CONST ulong
634 : fd_vm_trace_align( void );
635 :
636 : FD_FN_CONST ulong
637 : fd_vm_trace_footprint( ulong event_max, /* Maximum amount of event storage (<=1 EiB) */
638 : ulong event_data_max ); /* Maximum number of bytes that can be captured in an event (<=1 EiB) */
639 :
640 : void *
641 : fd_vm_trace_new( void * shmem,
642 : ulong event_max,
643 : ulong event_data_max );
644 :
645 : fd_vm_trace_t *
646 : fd_vm_trace_join( void * _trace );
647 :
648 : void *
649 : fd_vm_trace_leave( fd_vm_trace_t * trace );
650 :
651 : void *
652 : fd_vm_trace_delete( void * _trace );
653 :
654 : /* Given a current local join, fd_vm_trace_event returns the location in
655 : the caller's address space where trace events are stored and
656 : fd_vm_trace_event_sz returns number of bytes of trace events stored
657 : at that location. event_max is the number of bytes of event storage
658 : (value used to construct the trace) and event_data_max is the maximum
659 : number of data bytes that can be captured per event (value used to
660 : construct the trace). event will be aligned 8 and event_sz will be a
661 : multiple of 8 in [0,event_max]. The lifetime of the returned pointer
662 : is the lifetime of the current join. The first 8 bytes of an event
663 : are an info field used by trace inspection tools how to interpret the
664 : event. */
665 :
666 6 : FD_FN_CONST static inline void const * fd_vm_trace_event ( fd_vm_trace_t const * trace ) { return (void *)(trace+1); }
667 6 : FD_FN_CONST static inline ulong fd_vm_trace_event_sz ( fd_vm_trace_t const * trace ) { return trace->event_sz; }
668 3 : FD_FN_CONST static inline ulong fd_vm_trace_event_max ( fd_vm_trace_t const * trace ) { return trace->event_max; }
669 6 : FD_FN_CONST static inline ulong fd_vm_trace_event_data_max( fd_vm_trace_t const * trace ) { return trace->event_data_max; }
670 :
671 : /* fd_vm_trace_event_info returns the event info corresponding to the
672 : given (type,valid) tuple. Assumes type is a FD_VM_TRACE_EVENT_TYPE_*
673 : and that valid is in [0,1]. fd_vm_trace_event_info_{type,valid}
674 : extract from the given info {type,valid}. Assumes info is valid. */
675 :
676 45 : FD_FN_CONST static inline ulong fd_vm_trace_event_info( int type, int valid ) { return (ulong)((valid<<2) | type); }
677 :
678 45 : FD_FN_CONST static inline int fd_vm_trace_event_info_type ( ulong info ) { return (int)(info & 3UL); } /* EVENT_TYPE_* */
679 45 : FD_FN_CONST static inline int fd_vm_trace_event_info_valid( ulong info ) { return (int)(info >> 2); } /* In [0,1] */
680 :
681 : /* fd_vm_trace_reset frees all events in the trace. Returns
682 : FD_VM_SUCCESS (0) on success or FD_VM_ERR code (negative) on failure.
683 : Reasons for failure include NULL trace. */
684 :
685 : static inline int
686 0 : fd_vm_trace_reset( fd_vm_trace_t * trace ) {
687 0 : if( FD_UNLIKELY( !trace ) ) return FD_VM_ERR_INVAL;
688 0 : trace->event_sz = 0UL;
689 0 : return FD_VM_SUCCESS;
690 0 : }
691 :
692 : /* fd_vm_trace_event_exe records the current pc, ic, cu and
693 : register file of the VM and the instruction about to execute. Text
694 : points to the first word of the instruction about to execute and
695 : text_cnt points to the number of words available at that point.
696 : Returns FD_VM_SUCCESS (0) on success and a FD_VM_ERR code (negative)
697 : on failure. Reasons for failure include INVAL (trace NULL, reg NULL,
698 : text NULL, and/or text_cnt 0) and FULL (insufficient trace event
699 : storage available). */
700 :
701 : int
702 : fd_vm_trace_event_exe( fd_vm_trace_t * trace,
703 : ulong pc,
704 : ulong ic,
705 : ulong cu,
706 : ulong reg[ FD_VM_REG_CNT ],
707 : ulong const * text, /* Indexed [0,text_cnt) */
708 : ulong text_cnt,
709 : ulong ic_correction,
710 : ulong frame_cnt );
711 :
712 : /* fd_vm_trace_event_mem records an attempt to access the VM address
713 : range [vaddr,vaddr+sz). If write==0, it was a read attempt,
714 : otherwise, it was a write attempt. Data points to the location of
715 : the memory range in host memory or NULL if the range is invalid. If
716 : data is not NULL and sz is non-zero, this will record
717 : min(sz,event_data_max) of data for the event and mark the event has
718 : having valid data. Returns FD_VM_SUCCESS (0) on success and a
719 : FD_VM_ERR code (negative) on failure. Reasons for failure include
720 : INVAL (trace NULL) and FULL (insufficient trace event storage
721 : available to store the event). */
722 :
723 : int
724 : fd_vm_trace_event_mem( fd_vm_trace_t * trace,
725 : int write,
726 : ulong vaddr,
727 : ulong sz,
728 : void * data );
729 :
730 : /* fd_vm_trace_printf pretty prints the current trace to stdout. If
731 : syscalls is non-NULL, the trace will annotate syscalls in its
732 : disassembly according the syscall mapping. Returns FD_VM_SUCCESS (0)
733 : on success and a FD_VM_ERR code (negative) on failure. Reasons for
734 : failure include INVAL (NULL trace) and IO (corruption detected while
735 : parsing the trace events). FIXME: REVAMP THIS API FOR MORE GENERAL
736 : USE CASES. */
737 :
738 : int
739 : fd_vm_trace_printf( fd_vm_trace_t const * trace,
740 : fd_sbpf_syscalls_t const * syscalls );
741 :
742 : /* fd_vm_syscall API **************************************************/
743 :
744 : /* FIXME: fd_sbpf_syscalls_t and fd_sbpf_syscall_func_t probably should
745 : be moved from ballet/sbpf to here. */
746 :
747 : /* Note: the syscall map is kept separate from the fd_vm_t itself to
748 : support, for example, multiple fd_vm_t executing transactions
749 : concurrently for a slot. They could use the same syscalls for setup,
750 : memory and cache efficiency. */
751 :
752 : /* fd_vm_syscall_register inserts the syscall with the given cstr name
753 : into the given syscalls. The VM syscall implementation to use is
754 : given by func (NULL is fine though a VM itself may not accept such as
755 : valid). The caller promises there is room in the syscall map.
756 : Returns FD_VM_SUCCESS (0) on success or a FD_VM_ERR code (negative)
757 : on failure. Reasons for failure include INVAL (NULL syscalls, NULL
758 : name, name or the hash of name already in the map). On success,
759 : syscalls retains a read-only interest in name (e.g. use an infinite
760 : lifetime cstr here). (This function is exposed to allow VM users to
761 : add custom syscalls but most use cases probably should just call
762 : fd_vm_syscall_register_slot below.)
763 :
764 : IMPORTANT SAFETY TIP! See notes in syscall/fd_vm_syscall.h on what a
765 : syscall should expect to see and what to return. */
766 :
767 : int
768 : fd_vm_syscall_register( fd_sbpf_syscalls_t * syscalls,
769 : char const * name,
770 : fd_sbpf_syscall_func_t func );
771 :
772 : /* fd_vm_syscall_register_slot unmaps all syscalls in the current map
773 : (also ending any interest in the corresponding name cstr) and
774 : registers all syscalls appropriate for the slot. Returns
775 : FD_VM_SUCCESS (0) on success and FD_VM_ERR code (negative) on
776 : failure. Reasons for failure include INVAL (NULL syscalls) and FULL
777 : (tried to register too many system calls ... compile time map size
778 : needs to be adjusted).
779 :
780 : is_deploy should be 1 if the set of syscalls registered should be that
781 : used to verify programs before they are deployed, and 0 if it
782 : should be the set used to execute programs. */
783 :
784 : int
785 : fd_vm_syscall_register_slot( fd_sbpf_syscalls_t * syscalls,
786 : ulong slot,
787 : fd_features_t const * features,
788 : uchar is_deploy );
789 :
790 : /* fd_vm_syscall_register_all is a shorthand for registering all
791 : syscalls (see register slot). */
792 :
793 : static inline int
794 3 : fd_vm_syscall_register_all( fd_sbpf_syscalls_t * syscalls, uchar is_deploy ) {
795 : return fd_vm_syscall_register_slot( syscalls, 0UL, NULL, is_deploy );
796 3 : }
797 :
798 : FD_PROTOTYPES_END
799 :
800 : #endif /* HEADER_fd_src_flamenco_vm_fd_vm_base_h */
|
