flamenco: cleanup unused / dirty fd_executor functions

Author: mjain-jump

src/flamenco/runtime/fd_executor.c

@@ -163,43 +163,6 @@ fd_executor_lookup_native_program( fd_txn_account_t const * prog_acc,
   return 0;
 }
 
-static int
-fd_executor_is_system_nonce_account( fd_txn_account_t * account, fd_spad_t * exec_spad ) {
-  if( !memcmp( fd_txn_account_get_owner( account ), fd_solana_system_program_id.uc, sizeof(fd_pubkey_t) ) ) {
-    if( !fd_txn_account_get_data_len( account ) ) {
-      return 0;
-    } else {
-      if( fd_txn_account_get_data_len( account )!=FD_SYSTEM_PROGRAM_NONCE_DLEN ) {
-        return -1;
-      }
-
-      int err;
-      fd_nonce_state_versions_t * versions = fd_bincode_decode_spad(
-          nonce_state_versions, exec_spad,
-          fd_txn_account_get_data( account ),
-          fd_txn_account_get_data_len( account ),
-          &err );
-      if( FD_UNLIKELY( err ) ) {
-        return -1;
-      }
-
-      fd_nonce_state_t * state = NULL;
-      if( fd_nonce_state_versions_is_current( versions ) ) {
-        state = &versions->inner.current;
-      } else {
-        state = &versions->inner.legacy;
-      }
-
-      if( fd_nonce_state_is_initialized( state ) ) {
-        return 1;
-      }
-
-    }
-  }
-
-  return -1;
-}
-
 /* https://github.com/anza-xyz/agave/blob/v2.2.13/svm-rent-collector/src/svm_rent_collector.rs#L117-L136 */
 static uchar
 fd_executor_rent_transition_allowed( fd_rent_state_t const * pre_rent_state,
@@ -283,15 +246,15 @@ fd_validate_fee_payer( fd_txn_account_t * account,
   }
 
   /* https://github.com/anza-xyz/agave/blob/v2.2.13/svm/src/account_loader.rs#L305-L308 */
-  int is_nonce = fd_executor_is_system_nonce_account( account, exec_spad );
-  if( FD_UNLIKELY( is_nonce<0 ) ) {
+  int system_account_kind = fd_get_system_account_kind( account, exec_spad );
+  if( FD_UNLIKELY( system_account_kind==FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN ) ) {
     return FD_RUNTIME_TXN_ERR_INVALID_ACCOUNT_FOR_FEE;
   }
 
   /* https://github.com/anza-xyz/agave/blob/v2.2.13/svm/src/account_loader.rs#L309-L318 */
   ulong min_balance = 0UL;
-  if( is_nonce ) {
-    min_balance = fd_rent_exempt_minimum_balance( rent, 80 );
+  if( system_account_kind==FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_NONCE ) {
+    min_balance = fd_rent_exempt_minimum_balance( rent, FD_SYSTEM_PROGRAM_NONCE_DLEN );
   }
 
   /* https://github.com/anza-xyz/agave/blob/v2.2.13/svm/src/account_loader.rs#L320-L327 */
@@ -673,10 +636,9 @@ fd_increase_calculated_data_size( fd_exec_txn_ctx_t * txn_ctx,
 /* This function is represented as a closure in Agave.
    https://github.com/anza-xyz/agave/blob/v2.3.1/svm/src/account_loader.rs#L578-L640 */
 static int
-fd_collect_loaded_account( fd_exec_txn_ctx_t * txn_ctx,
-                           ushort              idx,
-                           ulong               loaded_acc_size ) {
-  fd_txn_account_t const * account = &txn_ctx->accounts[idx];
+fd_collect_loaded_account( fd_exec_txn_ctx_t *      txn_ctx,
+                           fd_txn_account_t const * account,
+                           ulong                    loaded_acc_size ) {
 
   /* https://github.com/anza-xyz/agave/blob/v2.3.1/svm/src/account_loader.rs#L586-L590 */
   int err = fd_increase_calculated_data_size( txn_ctx, loaded_acc_size );
@@ -697,7 +659,7 @@ fd_collect_loaded_account( fd_exec_txn_ctx_t * txn_ctx,
 
   /* Try to read the program state
      https://github.com/anza-xyz/agave/blob/v2.3.1/svm/src/account_loader.rs#L612-L634 */
-  fd_bpf_upgradeable_loader_state_t * loader_state = read_bpf_upgradeable_loader_state_for_program( txn_ctx, idx, NULL );
+  fd_bpf_upgradeable_loader_state_t * loader_state = fd_bpf_loader_program_get_state( account, txn_ctx->spad, NULL );
   if( FD_UNLIKELY( !loader_state ) ) {
     return FD_RUNTIME_EXECUTE_SUCCESS;
   }
@@ -785,7 +747,7 @@ fd_executor_load_transaction_accounts_simd_186( fd_exec_txn_ctx_t * txn_ctx ) {
          is enabled. */
       ulong loaded_acc_size = fd_ulong_sat_add( FD_TRANSACTION_ACCOUNT_BASE_SIZE,
                                                 fd_txn_account_get_data_len( acct ) );
-      int err = fd_collect_loaded_account( txn_ctx, i, loaded_acc_size );
+      int err = fd_collect_loaded_account( txn_ctx, acct, loaded_acc_size );
       if( FD_UNLIKELY( err!=FD_RUNTIME_EXECUTE_SUCCESS ) ) {
         return err;
       }
@@ -795,7 +757,7 @@ fd_executor_load_transaction_accounts_simd_186( fd_exec_txn_ctx_t * txn_ctx ) {
     /* Load and collect any remaining accounts
        https://github.com/anza-xyz/agave/blob/v2.3.1/svm/src/account_loader.rs#L652-L659 */
     ulong loaded_acc_size = load_transaction_account( txn_ctx, acct, is_writable, epoch, unknown_acc );
-    int err = fd_collect_loaded_account( txn_ctx, i, loaded_acc_size );
+    int err = fd_collect_loaded_account( txn_ctx, acct, loaded_acc_size );
     if( FD_UNLIKELY( err!=FD_RUNTIME_EXECUTE_SUCCESS ) ) {
       return err;
     }
@@ -1487,12 +1449,12 @@ fd_executor_setup_txn_account( fd_exec_txn_ctx_t * txn_ctx,
   return txn_account;
 }
 
-void
-fd_executor_setup_executable_account( fd_exec_txn_ctx_t * txn_ctx,
-                                      ushort              acc_idx,
-                                      ushort *            executable_idx ) {
+static void
+fd_executor_setup_executable_account( fd_exec_txn_ctx_t *      txn_ctx,
+                                      fd_txn_account_t const * account,
+                                      ushort *                 executable_idx ) {
   int err = 0;
-  fd_bpf_upgradeable_loader_state_t * program_loader_state = read_bpf_upgradeable_loader_state_for_program( txn_ctx, acc_idx, &err );
+  fd_bpf_upgradeable_loader_state_t * program_loader_state = fd_bpf_loader_program_get_state( account, txn_ctx->spad, &err );
   if( FD_UNLIKELY( !program_loader_state ) ) {
     return;
   }
@@ -1525,7 +1487,7 @@ fd_executor_setup_accounts_for_txn( fd_exec_txn_ctx_t * txn_ctx ) {
 
     if( FD_UNLIKELY( txn_account &&
                      memcmp( fd_txn_account_get_owner( txn_account ), fd_solana_bpf_loader_upgradeable_program_id.key, sizeof(fd_pubkey_t) ) == 0 ) ) {
-      fd_executor_setup_executable_account( txn_ctx, i, &j );
+      fd_executor_setup_executable_account( txn_ctx, txn_account, &j );
     }
   }
 

src/flamenco/runtime/fd_executor_err.h

@@ -10,10 +10,6 @@
 
 /* Instruction error codes */
 
-/* TODO make sure these are serialized consistently with solana_program::InstructionError */
-/* TODO FD_EXECUTOR_INSTR_SUCCESS is used like Ok(()) in Rust. But this is both overloaded and a
-        misnomer, because the instruction hasn't necessarily been executed successfully yet */
-
 #define FD_EXECUTOR_INSTR_ERR_FATAL                              ( INT_MIN ) /* Unrecoverable error */
 #define FD_EXECUTOR_INSTR_SUCCESS                                (   0 ) /* Instruction executed successfully */
 #define FD_EXECUTOR_INSTR_ERR_GENERIC_ERR                        (  -1 ) /* The program instruction returned an error */
@@ -71,27 +67,4 @@
 #define FD_EXECUTOR_INSTR_ERR_MAX_INSN_TRACE_LENS_EXCEEDED       ( -53 ) /* Max instruction trace length exceeded */
 #define FD_EXECUTOR_INSTR_ERR_BUILTINS_MUST_CONSUME_CUS          ( -54 ) /* Builtin programs must consume compute units */
 
-#define FD_EXECUTOR_SYSTEM_ERR_ACCOUNT_ALREADY_IN_USE            ( -1 ) /* an account with the same address already exists */
-#define FD_EXECUTOR_SYSTEM_ERR_RESULTS_WITH_NEGATIVE_LAMPORTS    ( -2 ) /* account does not have enough SOL to perform the operation */
-#define FD_EXECUTOR_SYSTEM_ERR_INVALID_PROGRAM_ID                ( -3 ) /* cannot assign account to this program id */
-#define FD_EXECUTOR_SYSTEM_ERR_INVALID_ACCOUNT_DATA_LENGTH       ( -4 ) /* cannot allocate account data of this length */
-#define FD_EXECUTOR_SYSTEM_ERR_MAX_SEED_LENGTH_EXCEEDED          ( -5 ) /* length of requested seed is too long */
-#define FD_EXECUTOR_SYSTEM_ERR_ADDRESS_WITH_SEED_MISMATCH        ( -6 ) /* provided address does not match addressed derived from seed */
-#define FD_EXECUTOR_SYSTEM_ERR_NONCE_NO_RECENT_BLOCKHASHES       ( -7 ) /* advancing stored nonce requires a populated RecentBlockhashes sysvar */
-#define FD_EXECUTOR_SYSTEM_ERR_NONCE_BLOCKHASH_NOT_EXPIRED       ( -8 ) /* stored nonce is still in recent_blockhashes */
-#define FD_EXECUTOR_SYSTEM_ERR_NONCE_UNEXPECTED_BLOCKHASH_VALUE  ( -9 ) /* specified nonce does not match stored nonce */
-
-/* PrecompileError
-   https://github.com/anza-xyz/agave/blob/v1.18.12/sdk/src/precompiles.rs#L16
-   Agave distinguishes between 5 errors and the returned one depends on
-   the order they decided to write their code.
-   These are all fatal errors, so the specific errors don't matter for
-   consensus.
-   To simplify our fuzzers, we return the same error code for all errors. */
-#define FD_EXECUTOR_PRECOMPILE_ERR_PUBLIC_KEY                    ( 0 )
-#define FD_EXECUTOR_PRECOMPILE_ERR_RECOVERY_ID                   ( 1 )
-#define FD_EXECUTOR_PRECOMPILE_ERR_SIGNATURE                     ( 2 )
-#define FD_EXECUTOR_PRECOMPILE_ERR_DATA_OFFSET                   ( 3 )
-#define FD_EXECUTOR_PRECOMPILE_ERR_INSTR_DATA_SIZE               ( 4 )
-
 #endif /* HEADER_fd_src_flamenco_runtime_fd_executor_err_h */

src/flamenco/runtime/program/fd_bpf_loader_program.c

@@ -92,38 +92,6 @@ program_error_to_instr_error( ulong  err,
   }
 }
 
-/* TODO: This can be combined with the other bpf loader state decode function */
-fd_bpf_upgradeable_loader_state_t *
-read_bpf_upgradeable_loader_state_for_program( fd_exec_txn_ctx_t * txn_ctx,
-                                               ushort              program_id,
-                                               int *               opt_err ) {
-  fd_txn_account_t * rec = NULL;
-  int err = fd_exec_txn_ctx_get_account_at_index( txn_ctx,
-                                                  program_id,
-                                                  &rec,
-                                                  fd_txn_account_check_exists );
-  if( FD_UNLIKELY( err ) ) {
-    if( opt_err ) {
-      *opt_err = err;
-    }
-    return NULL;
-  }
-
-  fd_bpf_upgradeable_loader_state_t * res = fd_bincode_decode_spad(
-      bpf_upgradeable_loader_state,
-      txn_ctx->spad,
-      fd_txn_account_get_data( rec ),
-      fd_txn_account_get_data_len( rec ),
-      &err );
-  if( FD_UNLIKELY( err ) ) {
-    if( opt_err ) {
-      *opt_err = FD_EXECUTOR_INSTR_ERR_INVALID_ACC_DATA;
-    }
-    return NULL;
-  }
-  return res;
-}
-
 /* https://github.com/anza-xyz/agave/blob/9b22f28104ec5fd606e4bb39442a7600b38bb671/programs/bpf_loader/src/lib.rs#L216-L229 */
 static ulong
 calculate_heap_cost( ulong heap_size, ulong heap_cost ) {
@@ -325,18 +293,20 @@ write_program_data( fd_exec_instr_ctx_t *   instr_ctx,
 fd_bpf_upgradeable_loader_state_t *
 fd_bpf_loader_program_get_state( fd_txn_account_t const * acct,
                                  fd_spad_t *              spad,
-                                 int *                    err ) {
+                                 int *                    opt_err ) {
+  int err;
   fd_bpf_upgradeable_loader_state_t * res = fd_bincode_decode_spad(
       bpf_upgradeable_loader_state,
       spad,
       fd_txn_account_get_data( acct ),
       fd_txn_account_get_data_len( acct ),
-      err );
-  if( FD_UNLIKELY( *err ) ) {
-    *err = FD_EXECUTOR_INSTR_ERR_INVALID_ACC_DATA;
-    return NULL;
+      &err );
+
+  if( opt_err ) {
+    *opt_err = FD_UNLIKELY( err ) ? FD_EXECUTOR_INSTR_ERR_INVALID_ACC_DATA : FD_EXECUTOR_INSTR_SUCCESS;
   }
-  return res;
+
+  return FD_UNLIKELY( err ) ? NULL : res;
 }
 
 /* Mirrors solana_sdk::transaction_context::BorrowedAccount::set_state()

src/flamenco/runtime/program/fd_bpf_loader_program.h

@@ -59,9 +59,9 @@ FD_PROTOTYPES_BEGIN
    https://github.com/anza-xyz/agave/blob/v2.1.14/sdk/src/transaction_context.rs#L965-L969 */
 
 fd_bpf_upgradeable_loader_state_t *
-fd_bpf_loader_program_get_state( fd_txn_account_t const * acc,
+fd_bpf_loader_program_get_state( fd_txn_account_t const * acct,
                                  fd_spad_t *              spad,
-                                 int *                    err );
+                                 int *                    opt_err );
 
 void
 fd_bpf_get_sbpf_versions( uint *                sbpf_min_version,
@@ -84,14 +84,6 @@ fd_bpf_execute( fd_exec_instr_ctx_t *            instr_ctx,
 int
 fd_bpf_loader_program_execute( fd_exec_instr_ctx_t * instr_ctx );
 
-/* read_bpf_upgradeable_loader_state_for_program allocates and returns the
-   bpf loader state for a given program id account within the scope of a txn. */
-
-fd_bpf_upgradeable_loader_state_t *
-read_bpf_upgradeable_loader_state_for_program( fd_exec_txn_ctx_t *                 txn_ctx,
-                                               ushort                              program_id,
-                                               int *                               opt_err );
-
 /* Public APIs */
 
 /* This function is called from `fd_runtime.c` and only performs the ELF and VM validation checks necessary

src/flamenco/runtime/program/fd_precompiles.h

@@ -4,6 +4,19 @@
 #include "../fd_runtime.h"
 #include "../context/fd_exec_instr_ctx.h"
 
+/* PrecompileError
+   https://github.com/anza-xyz/agave/blob/v1.18.12/sdk/src/precompiles.rs#L16
+   Agave distinguishes between 5 errors and the returned one depends on
+   the order they decided to write their code.
+   These are all fatal errors, so the specific errors don't matter for
+   consensus.
+   To simplify our fuzzers, we return the same error code for all errors. */
+#define FD_EXECUTOR_PRECOMPILE_ERR_PUBLIC_KEY                    ( 0 )
+#define FD_EXECUTOR_PRECOMPILE_ERR_RECOVERY_ID                   ( 1 )
+#define FD_EXECUTOR_PRECOMPILE_ERR_SIGNATURE                     ( 2 )
+#define FD_EXECUTOR_PRECOMPILE_ERR_DATA_OFFSET                   ( 3 )
+#define FD_EXECUTOR_PRECOMPILE_ERR_INSTR_DATA_SIZE               ( 4 )
+
 FD_PROTOTYPES_BEGIN
 
 /* fd_precompile_ed25519_verify is the instruction processing entrypoint

src/flamenco/runtime/program/fd_system_program.c

@@ -719,3 +719,50 @@ fd_system_program_execute( fd_exec_instr_ctx_t * ctx ) {
 
   return result;
 }
+
+/**********************************************************************/
+/* Public API                                                         */
+/**********************************************************************/
+
+int
+fd_get_system_account_kind( fd_txn_account_t * account,
+                            fd_spad_t *        exec_spad ) {
+  /* https://github.com/anza-xyz/solana-sdk/blob/nonce-account%40v2.2.1/nonce-account/src/lib.rs#L56 */
+  if( FD_UNLIKELY( memcmp( fd_txn_account_get_owner( account ), fd_solana_system_program_id.uc, sizeof(fd_pubkey_t) ) ) ) {
+    return FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN;
+  }
+
+  /* https://github.com/anza-xyz/solana-sdk/blob/nonce-account%40v2.2.1/nonce-account/src/lib.rs#L57-L58 */
+  if( FD_LIKELY( !fd_txn_account_get_data_len( account ) ) ) {
+    return FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_SYSTEM;
+  }
+
+  /* https://github.com/anza-xyz/solana-sdk/blob/nonce-account%40v2.2.1/nonce-account/src/lib.rs#L59 */
+  if( FD_UNLIKELY( fd_txn_account_get_data_len( account )!=FD_SYSTEM_PROGRAM_NONCE_DLEN ) ) {
+    return FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN;
+  }
+
+  /* https://github.com/anza-xyz/solana-sdk/blob/nonce-account%40v2.2.1/nonce-account/src/lib.rs#L60-L64 */
+  int err;
+  fd_nonce_state_versions_t * versions = fd_bincode_decode_spad(
+      nonce_state_versions, exec_spad,
+      fd_txn_account_get_data( account ),
+      fd_txn_account_get_data_len( account ),
+      &err );
+  if( FD_UNLIKELY( err ) ) {
+    return FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN;
+  }
+
+  fd_nonce_state_t * state = NULL;
+  if( fd_nonce_state_versions_is_current( versions ) ) {
+    state = &versions->inner.current;
+  } else {
+    state = &versions->inner.legacy;
+  }
+
+  if( FD_LIKELY( fd_nonce_state_is_initialized( state ) ) ) {
+    return FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_NONCE;
+  }
+
+  return FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN;
+}

src/flamenco/runtime/program/fd_system_program.h

@@ -18,6 +18,11 @@
 
 #define FD_SYSTEM_PROGRAM_NONCE_DLEN (80UL)
 
+/* https://github.com/anza-xyz/solana-sdk/blob/nonce-account%40v2.2.1/nonce-account/src/lib.rs#L49-L53 */
+#define FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN (-1)
+#define FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_SYSTEM  (0)
+#define FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_NONCE   (1)
+
 FD_PROTOTYPES_BEGIN
 
 /* fd_system_program_execute is the entrypoint for the system program */
@@ -42,14 +47,27 @@ int fd_system_program_exec_upgrade_nonce_account   ( fd_exec_instr_ctx_t * ctx
 
 /* User APIs */
 
-/* fd_check_transaction_age returns 0 if the transactions age is
-   valid, returns non-zero otherwise. This is determined by the age of
-   the blockhash provided in the transaction message or by the
-   validity of the nonce provided in the transaction. */
+/* fd_check_transaction_age returns 0 if the transactions age is valid,
+   returns non-zero otherwise. This is determined by the age of the
+   blockhash provided in the transaction message or by the validity of
+   the nonce provided in the transaction. */
 
 int
 fd_check_transaction_age( fd_exec_txn_ctx_t * txn_ctx );
 
+/* `fd_get_system_account_kind()` determines whether an account is
+   a normal system program account or a nonce account. Returns:
+   - FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_SYSTEM if the account is a
+     normal system program account
+   - FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_NONCE if the account is a
+     nonce account
+   - FD_SYSTEM_PROGRAM_NONCE_ACCOUNT_KIND_UNKNOWN otherwise
+   https://github.com/anza-xyz/solana-sdk/blob/nonce-account%40v2.2.1/nonce-account/src/lib.rs#L55-L71 */
+
+int
+fd_get_system_account_kind( fd_txn_account_t * account,
+                            fd_spad_t *        exec_spad );
+
 FD_PROTOTYPES_END
 
 #endif /* HEADER_fd_src_flamenco_runtime_program_fd_system_program_h */

src/flamenco/runtime/tests/harness/fd_instr_harness.c

@@ -196,11 +196,10 @@ fd_runtime_fuzz_instr_ctx_create( fd_runtime_fuzz_runner_t *           runner,
       continue;
     }
 
-    if( FD_UNLIKELY( 0 == memcmp(meta->info.owner, fd_solana_bpf_loader_upgradeable_program_id.key, sizeof(fd_pubkey_t)) ) ) {
-      int err = 0;
-      fd_bpf_upgradeable_loader_state_t * program_loader_state = read_bpf_upgradeable_loader_state_for_program( txn_ctx,
-                                                                                                                (ushort)i,
-                                                                                                                &err );
+    if( FD_UNLIKELY( !memcmp(meta->info.owner, fd_solana_bpf_loader_upgradeable_program_id.key, sizeof(fd_pubkey_t)) ) ) {
+      fd_bpf_upgradeable_loader_state_t * program_loader_state = fd_bpf_loader_program_get_state( acc,
+                                                                                                  txn_ctx->spad,
+                                                                                                  NULL );
 
       if( FD_UNLIKELY( !program_loader_state ) ) {
         continue;