LCOV - code coverage report
Current view: top level - flamenco/vm/syscall - fd_vm_syscall_hash.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 0 84 0.0 %
Date: 2026-02-05 06:00:08 Functions: 0 3 0.0 %

          Line data    Source code
       1             : #include "fd_vm_syscall.h"
       2             : 
       3             : #include "../../../ballet/keccak256/fd_keccak256.h"
       4             : 
       5             : /* Syscalls for sha256, keccak256, blake3. */
       6             : 
       7             : /* Agave has a single generic hash syscall:
       8             :    https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1895-L1959
       9             :    With trait impl for sha256, keccak256 and blake3:
      10             :    https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L130-L225
      11             : 
      12             :    Notes:
      13             :    1. Max slices, base cost and byte cost are the same for all 3 hash functions:
      14             :       - https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L189-L197
      15             :       - https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L216-L224
      16             :    2. Poseidon doesn't follow this generic hash implementation (so we left it in fd_vm_syscall_crypto.c):
      17             :       - https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1678
      18             : 
      19             :    Implementation notes.
      20             :    Because of the notes above, we implemented fd_vm_syscall_sol_sha256() following the generic hash
      21             :    syscall step by step.
      22             :    The other implementations are just a copy & paste, replacing the hash function.
      23             :    Resisted the temptation to do a macro, because it would complicate future changes, for example if
      24             :    we were to modify CU costs. */
      25             : 
      26             : int
      27             : fd_vm_syscall_sol_sha256( /**/            void *  _vm,
      28             :                           /**/            ulong   vals_addr,
      29             :                           /**/            ulong   vals_len,
      30             :                           /**/            ulong   result_addr,
      31             :                           FD_PARAM_UNUSED ulong   r4,
      32             :                           FD_PARAM_UNUSED ulong   r5,
      33           0 :                           /**/            ulong * _ret ) {
      34             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1897 */
      35           0 :   fd_vm_t * vm = (fd_vm_t *)_vm;
      36             : 
      37             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1911-L1920 */
      38           0 :   if( FD_UNLIKELY( FD_VM_SHA256_MAX_SLICES < vals_len ) ) {
      39             :     /* Max msg_sz = 61 - 8 + 6 + 20 + 20 = 99 < 127 => we can use printf */
      40           0 :     fd_log_collector_printf_dangerous_max_127( vm->instr_ctx,
      41           0 :       "%s Hashing %lu sequences in one syscall is over the limit %lu",
      42           0 :       "Sha256", vals_len, FD_VM_SHA256_MAX_SLICES );
      43           0 :     FD_VM_ERR_FOR_LOG_SYSCALL( vm, FD_VM_SYSCALL_ERR_TOO_MANY_SLICES );
      44           0 :     return FD_VM_SYSCALL_ERR_TOO_MANY_SLICES; /* SyscallError::TooManySlices */
      45           0 :   }
      46             : 
      47             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1922 */
      48           0 :   FD_VM_CU_UPDATE( vm, FD_VM_SHA256_BASE_COST );
      49           0 :   uchar * hash_result = FD_VM_HADDR_QUERY_U8_SLICE( vm, result_addr, 32UL );
      50             : 
      51             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1930 */
      52           0 :   fd_sha256_t sha[1];
      53           0 :   fd_sha256_init( sha );
      54             : 
      55           0 :   if( vals_len > 0 ) {
      56             :     /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1932-L1937 */
      57           0 :     fd_vm_vec_t const * input_vec_haddr = (fd_vm_vec_t const *)FD_VM_MEM_HADDR_LD( vm, vals_addr, FD_VM_VEC_ALIGN, vals_len*sizeof(fd_vm_vec_t) );
      58           0 :     for( ulong i=0UL; i<vals_len; i++ ) {
      59             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1939-L1944 */
      60           0 :       ulong val_len = input_vec_haddr[i].len;
      61           0 :       void const * bytes = FD_VM_MEM_SLICE_HADDR_LD( vm, input_vec_haddr[i].addr, FD_VM_ALIGN_RUST_U8, val_len );
      62             : 
      63             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1945-L1951 */
      64           0 :       ulong cost = fd_ulong_max( FD_VM_MEM_OP_BASE_COST,
      65           0 :                                  fd_ulong_sat_mul( FD_VM_SHA256_BYTE_COST, (val_len / 2) ) );
      66             : 
      67             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1952 */
      68           0 :       FD_VM_CU_UPDATE( vm, cost );
      69             : 
      70             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1953 */
      71           0 :       fd_sha256_append( sha, bytes, val_len );
      72           0 :     }
      73           0 :   }
      74             : 
      75             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1956-L1957 */
      76           0 :   fd_sha256_fini( sha, hash_result );
      77           0 :   *_ret = 0UL;
      78           0 :   return FD_VM_SUCCESS;
      79           0 : }
      80             : 
      81             : int
      82             : fd_vm_syscall_sol_blake3( /**/            void *  _vm,
      83             :                           /**/            ulong   vals_addr,
      84             :                           /**/            ulong   vals_len,
      85             :                           /**/            ulong   result_addr,
      86             :                           FD_PARAM_UNUSED ulong   r4,
      87             :                           FD_PARAM_UNUSED ulong   r5,
      88           0 :                           /**/            ulong * _ret ) {
      89             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1897 */
      90           0 :   fd_vm_t * vm = (fd_vm_t *)_vm;
      91             : 
      92             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1911-L1920 */
      93           0 :   if( FD_UNLIKELY( FD_VM_SHA256_MAX_SLICES < vals_len ) ) {
      94             :     /* Max msg_sz = 61 - 8 + 6 + 20 + 20 = 99 < 127 => we can use printf */
      95           0 :     fd_log_collector_printf_dangerous_max_127( vm->instr_ctx,
      96           0 :       "%s Hashing %lu sequences in one syscall is over the limit %lu",
      97           0 :       "Blake3", vals_len, FD_VM_SHA256_MAX_SLICES );
      98           0 :     FD_VM_ERR_FOR_LOG_SYSCALL( vm, FD_VM_SYSCALL_ERR_TOO_MANY_SLICES );
      99           0 :     return FD_VM_SYSCALL_ERR_TOO_MANY_SLICES; /* SyscallError::TooManySlices */
     100           0 :   }
     101             : 
     102             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1922 */
     103           0 :   FD_VM_CU_UPDATE( vm, FD_VM_SHA256_BASE_COST );
     104           0 :   uchar * hash_result = FD_VM_HADDR_QUERY_U8_SLICE( vm, result_addr, 32UL );
     105             : 
     106             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1930 */
     107           0 :   fd_blake3_t sha[1];
     108           0 :   fd_blake3_init( sha );
     109             : 
     110           0 :   if( vals_len > 0 ) {
     111             :     /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1932-L1937 */
     112           0 :     fd_vm_vec_t const * input_vec_haddr = (fd_vm_vec_t const *)FD_VM_MEM_HADDR_LD( vm, vals_addr, FD_VM_VEC_ALIGN, vals_len*sizeof(fd_vm_vec_t) );
     113           0 :     for( ulong i=0UL; i<vals_len; i++ ) {
     114             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1939-L1944 */
     115           0 :       ulong val_len = input_vec_haddr[i].len;
     116           0 :       void const * bytes = FD_VM_MEM_SLICE_HADDR_LD( vm, input_vec_haddr[i].addr, FD_VM_ALIGN_RUST_U8, val_len );
     117             : 
     118             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1945-L1951 */
     119           0 :       ulong cost = fd_ulong_max( FD_VM_MEM_OP_BASE_COST,
     120           0 :                                  fd_ulong_sat_mul( FD_VM_SHA256_BYTE_COST, (val_len / 2) ) );
     121             : 
     122             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1952 */
     123           0 :       FD_VM_CU_UPDATE( vm, cost );
     124             : 
     125             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1953 */
     126           0 :       fd_blake3_append( sha, bytes, val_len );
     127           0 :     }
     128           0 :   }
     129             : 
     130             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1956-L1957 */
     131           0 :   fd_blake3_fini( sha, hash_result );
     132           0 :   *_ret = 0UL;
     133           0 :   return FD_VM_SUCCESS;
     134           0 : }
     135             : 
     136             : int
     137             : fd_vm_syscall_sol_keccak256( /**/            void *  _vm,
     138             :                              /**/            ulong   vals_addr,
     139             :                              /**/            ulong   vals_len,
     140             :                              /**/            ulong   result_addr,
     141             :                              FD_PARAM_UNUSED ulong   r4,
     142             :                              FD_PARAM_UNUSED ulong   r5,
     143           0 :                              /**/            ulong * _ret ) {
     144             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1897 */
     145           0 :   fd_vm_t * vm = (fd_vm_t *)_vm;
     146             : 
     147             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1911-L1920 */
     148           0 :   if( FD_UNLIKELY( FD_VM_SHA256_MAX_SLICES < vals_len ) ) {
     149             :     /* Max msg_sz = 61 - 8 + 9 + 20 + 20 = 102 < 127 => we can use printf */
     150           0 :     fd_log_collector_printf_dangerous_max_127( vm->instr_ctx,
     151           0 :       "%s Hashing %lu sequences in one syscall is over the limit %lu",
     152           0 :       "Keccak256", vals_len, FD_VM_SHA256_MAX_SLICES );
     153           0 :     FD_VM_ERR_FOR_LOG_SYSCALL( vm, FD_VM_SYSCALL_ERR_TOO_MANY_SLICES );
     154           0 :     return FD_VM_SYSCALL_ERR_TOO_MANY_SLICES; /* SyscallError::TooManySlices */
     155           0 :   }
     156             : 
     157             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1922 */
     158           0 :   FD_VM_CU_UPDATE( vm, FD_VM_SHA256_BASE_COST );
     159           0 :   uchar * hash_result = FD_VM_HADDR_QUERY_U8_SLICE( vm, result_addr, 32UL );
     160             : 
     161             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1930 */
     162           0 :   fd_keccak256_t sha[1];
     163           0 :   fd_keccak256_init( sha );
     164             : 
     165           0 :   if( vals_len > 0 ) {
     166             :     /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1932-L1937 */
     167           0 :     fd_vm_vec_t const * input_vec_haddr = (fd_vm_vec_t const *)FD_VM_MEM_HADDR_LD( vm, vals_addr, FD_VM_VEC_ALIGN, vals_len*sizeof(fd_vm_vec_t) );
     168           0 :     for( ulong i=0UL; i<vals_len; i++ ) {
     169             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1939-L1944 */
     170           0 :       ulong val_len = input_vec_haddr[i].len;
     171           0 :       void const * bytes = FD_VM_MEM_SLICE_HADDR_LD( vm, input_vec_haddr[i].addr, FD_VM_ALIGN_RUST_U8, val_len );
     172             : 
     173             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1945-L1951 */
     174           0 :       ulong cost = fd_ulong_max( FD_VM_MEM_OP_BASE_COST,
     175           0 :                                   fd_ulong_sat_mul( FD_VM_SHA256_BYTE_COST, (val_len / 2) ) );
     176             : 
     177             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1952 */
     178           0 :       FD_VM_CU_UPDATE( vm, cost );
     179             : 
     180             :       /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1953 */
     181           0 :       fd_keccak256_append( sha, bytes, val_len );
     182           0 :     }
     183           0 :   }
     184             : 
     185             :   /* https://github.com/anza-xyz/agave/blob/v1.18.12/programs/bpf_loader/src/syscalls/mod.rs#L1956-L1957 */
     186           0 :   fd_keccak256_fini( sha, hash_result );
     187           0 :   *_ret = 0UL;
     188           0 :   return FD_VM_SUCCESS;
     189           0 : }

Generated by: LCOV version 1.14