flamenco, runtime: implement replace_spl_token_with_p_token

Author: topointon-jump

src/flamenco/features/fd_features_generated.c

@@ -1807,6 +1807,12 @@ fd_feature_id_t const ids[] = {
     .name                      = "create_account_allow_prefund",
     .cleaned_up                = 0 },
 
+  { .index                     = offsetof(fd_features_t, replace_spl_token_with_p_token)>>3,
+    .id                        = {"\x0c\x44\xe0\x0e\x03\x6f\xc8\xa4\xc4\x7e\xdb\x02\xb0\x8d\xff\x3b\xc2\x2f\x04\x5a\x7d\x01\xa1\x00\x07\x1f\x85\x5f\x21\x09\x7a\x6a"},
+                                 /* ptokFjwyJtrwCa9Kgo9xoDS59V4QccBGEaRFnRPnSdP */
+    .name                      = "replace_spl_token_with_p_token",
+    .cleaned_up                = 0 },
+
   { .index = ULONG_MAX }
 };
 
@@ -2088,6 +2094,7 @@ typedef struct fd_feature_id_lookup_entry fd_feature_id_lookup_entry_t;
 #define MAP_PERFECT_262 0x8b0786cd93f63607UL, .val = &ids[262]
 #define MAP_PERFECT_263 0x4908ae0360664f6dUL, .val = &ids[263]
 #define MAP_PERFECT_264 0x632b9b7c9e9a3257UL, .val = &ids[264]
+#define MAP_PERFECT_265 0xa4c86f030ee0440cUL, .val = &ids[265]
 
 #include "../../util/tmpl/fd_map_perfect.c"
 
@@ -2363,4 +2370,5 @@ FD_STATIC_ASSERT( offsetof( fd_features_t, limit_instruction_accounts
 FD_STATIC_ASSERT( offsetof( fd_features_t, validator_admission_ticket                              )>>3==262UL, layout );
 FD_STATIC_ASSERT( offsetof( fd_features_t, discard_unexpected_data_complete_shreds                 )>>3==263UL, layout );
 FD_STATIC_ASSERT( offsetof( fd_features_t, create_account_allow_prefund                            )>>3==264UL, layout );
+FD_STATIC_ASSERT( offsetof( fd_features_t, replace_spl_token_with_p_token                          )>>3==265UL, layout );
 FD_STATIC_ASSERT( sizeof( fd_features_t )>>3==FD_FEATURE_ID_CNT, layout );

src/flamenco/features/fd_features_generated.h

@@ -8,10 +8,10 @@
 #endif
 
 /* FEATURE_ID_CNT is the number of features in ids */
-#define FD_FEATURE_ID_CNT (265UL)
+#define FD_FEATURE_ID_CNT (266UL)
 
 /* Feature set ID calculated from all feature names */
-#define FD_FEATURE_SET_ID (2642541842U)
+#define FD_FEATURE_SET_ID (1894134510U)
 
 union fd_features {
   ulong f[ FD_FEATURE_ID_CNT ];
@@ -281,5 +281,6 @@ union fd_features {
     /* 0x8b0786cd93f63607 */ ulong validator_admission_ticket;
     /* 0x4908ae0360664f6d */ ulong discard_unexpected_data_complete_shreds;
     /* 0x632b9b7c9e9a3257 */ ulong create_account_allow_prefund;
+    /* 0xa4c86f030ee0440c */ ulong replace_spl_token_with_p_token;
   };
 };

src/flamenco/features/feature_map.json

@@ -263,5 +263,6 @@
   {"name":"limit_instruction_accounts","pubkey":"DqbnFPASg7tHmZ6qfpdrt2M6MWoSeiicWPXxPhxqFCQ"},
   {"name":"validator_admission_ticket","pubkey":"VATtb1DepUwdPh5bFVasdtkbeDNsftZSRzr2aKpKWJA"},
   {"name":"discard_unexpected_data_complete_shreds","pubkey":"8MhfKhoZEoiySpVe248bDkisyEcBA7JQLyUS94xoTSqN"},
-  {"name":"create_account_allow_prefund","pubkey":"6sPDzwyARRExKH52LECxcGoqziH8G7SZofwuxi8Ja331"}
+  {"name":"create_account_allow_prefund","pubkey":"6sPDzwyARRExKH52LECxcGoqziH8G7SZofwuxi8Ja331"},
+  {"name":"replace_spl_token_with_p_token","pubkey":"ptokFjwyJtrwCa9Kgo9xoDS59V4QccBGEaRFnRPnSdP"}
 ]

src/flamenco/runtime/fd_core_bpf_migration.c

@@ -8,6 +8,8 @@
 #include "fd_hashes.h"
 #include "../accdb/fd_accdb_sync.h"
 #include "../../ballet/sha256/fd_sha256.h"
+#include "../../ballet/sbpf/fd_sbpf_loader.h"
+#include "../progcache/fd_prog_load.h"
 #include <assert.h>
 
 static fd_pubkey_t
@@ -257,6 +259,80 @@ target_core_bpf_new_checked( target_core_bpf_t *       target_core_bpf,
   return target_core_bpf;
 }
 
+/* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L25-L82
+
+   Agave uses a separate TargetBpfV2 struct, but it has the
+   same layout as target_builtin_t so we reuse that. */
+static target_builtin_t *
+target_bpf_v2_new_checked( target_builtin_t *        target_bpf_v2,
+                           fd_pubkey_t const *       program_address,
+                           int                       allow_prefunded,
+                           fd_accdb_user_t *         accdb,
+                           fd_funk_txn_xid_t const * xid,
+                           fd_runtime_stack_t *      runtime_stack ) {
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L30-L33 */
+  fd_tmp_account_t * program_account = &runtime_stack->bpf_migration.program_account;
+  if( FD_UNLIKELY( !tmp_account_read( program_account, accdb, xid, program_address ) ) ) {
+    /* CoreBpfMigrationError::AccountNotFound(*program_address) */
+    return NULL;
+  }
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L35-L38 */
+  if( FD_UNLIKELY( 0!=memcmp( program_account->meta.owner, &fd_solana_bpf_loader_program_id, FD_PUBKEY_FOOTPRINT ) ) ) {
+    /* CoreBpfMigrationError::IncorrectOwner(*program_address) */
+    return NULL;
+  }
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L40-L45 */
+  if( FD_UNLIKELY( !program_account->meta.executable ) ) {
+    /* CoreBpfMigrationError::ProgramAccountNotExecutable(*program_address) */
+    return NULL;
+  }
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L47 */
+  fd_pubkey_t program_data_address = get_program_data_address( program_address );
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L49-L74 */
+  ulong program_data_account_lamports = 0UL;
+  do {
+    fd_accdb_ro_t ro[1];
+    int progdata_exists = !!fd_accdb_open_ro( accdb, ro, xid, &program_data_address );
+
+    /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L49-L74 */
+    if( FD_LIKELY( allow_prefunded ) ) {
+      /* The program data account should not exist, but a system
+         account with funded lamports is acceptable.
+
+         https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L50-L61 */
+      if( FD_UNLIKELY( progdata_exists ) ) {
+        if( FD_UNLIKELY( 0!=memcmp( fd_accdb_ref_owner( ro ), &fd_solana_system_program_id, FD_PUBKEY_FOOTPRINT ) ) ) {
+          /* CoreBpfMigrationError::ProgramHasDataAccount(*program_address) */
+          fd_accdb_close_ro( accdb, ro );
+          return NULL;
+        } else {
+          program_data_account_lamports = fd_accdb_ref_lamports( ro );
+          fd_accdb_close_ro( accdb, ro );
+        }
+      }
+    } else {
+      /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/target_bpf_v2.rs#L62-L74 */
+      if( FD_UNLIKELY( progdata_exists ) ) {
+        /* CoreBpfMigrationError::ProgramHasDataAccount(*program_address) */
+        fd_accdb_close_ro( accdb, ro );
+        return NULL;
+      }
+    }
+  } while(0);
+
+  *target_bpf_v2 = (target_builtin_t) {
+    .program_account               = program_account,
+    .program_data_address          = program_data_address,
+    .program_data_account_lamports = program_data_account_lamports
+  };
+  return target_bpf_v2;
+}
+
 /* https://github.com/anza-xyz/agave/blob/v3.1.7/runtime/src/bank/builtins/core_bpf_migration/source_buffer.rs#L51-L75 */
 
 static fd_tmp_account_t *
@@ -624,3 +700,115 @@ fd_upgrade_core_bpf_program( fd_bank_t *                            bank,
 
   fd_memset( &runtime_stack->bpf_migration, 0, sizeof(runtime_stack->bpf_migration) );
 }
+
+/* Mimics upgrade_loader_v2_program_with_loader_v3_program().
+   https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L402-L474 */
+void
+fd_upgrade_loader_v2_program_with_loader_v3_program( fd_bank_t *               bank,
+                                                     fd_accdb_user_t *         accdb,
+                                                     fd_funk_txn_xid_t const * xid,
+                                                     fd_runtime_stack_t *      runtime_stack,
+                                                     fd_pubkey_t const *       loader_v2_program_address,
+                                                     fd_pubkey_t const *       source_buffer_address,
+                                                     int                       allow_prefunded,
+                                                     fd_capture_ctx_t *        capture_ctx ) {
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L411-L412 */
+  target_builtin_t target[1];
+  if( FD_UNLIKELY( !target_bpf_v2_new_checked(
+      target,
+      loader_v2_program_address,
+      allow_prefunded,
+      accdb,
+      xid,
+      runtime_stack ) ) )
+    return;
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L413 */
+  fd_tmp_account_t * source = &runtime_stack->bpf_migration.source;
+  if( FD_UNLIKELY( !source_buffer_new_checked( source, accdb, xid, source_buffer_address, NULL ) ) )
+    return;
+
+  fd_rent_t const * rent = fd_bank_rent_query( bank );
+  ulong const       slot = fd_bank_slot_get  ( bank );
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L416-L417 */
+  fd_tmp_account_t * new_target_program = &runtime_stack->bpf_migration.new_target_program;
+  if( FD_UNLIKELY( !new_target_program_account( new_target_program, target, rent ) ) )
+    return;
+  new_target_program->addr = *loader_v2_program_address;
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L419-L421 */
+  fd_tmp_account_t * new_target_program_data = &runtime_stack->bpf_migration.new_target_program_data;
+  if( FD_UNLIKELY( !new_target_program_data_account( new_target_program_data, source, NULL, rent, slot ) ) ) {
+    return;
+  }
+  new_target_program_data->addr = target->program_data_address;
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L427-L435 */
+  ulong old_data_sz;
+  if( FD_UNLIKELY( fd_ulong_checked_add( target->program_account->data_sz, source->data_sz, &old_data_sz ) ) ) return;
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L432-L435 */
+  ulong new_data_sz;
+  if( FD_UNLIKELY( fd_ulong_checked_add( new_target_program->data_sz, new_target_program_data->data_sz, &new_data_sz ) ) ) return;
+
+  assert( new_target_program_data->data_sz>=PROGRAMDATA_METADATA_SIZE );
+
+  /* Validate the ELF. Agave calls directly_invoke_loader_v3_deploy,
+     which validates the ELF and aborts the migration if the ELF is
+     invalid.
+
+     We don't invalidate the program cache here, because upgrades are
+     done at the epoch boundary, so the cache entry is invalidated
+     automatically.
+
+     https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L437-L443 */
+  do {
+    uchar const * elf    = (uchar const *)new_target_program_data->data + PROGRAMDATA_METADATA_SIZE;
+    ulong         elf_sz = new_target_program_data->data_sz - PROGRAMDATA_METADATA_SIZE;
+
+    fd_prog_versions_t versions = fd_prog_versions( fd_bank_features_query( bank ), slot );
+    fd_sbpf_loader_config_t loader_config = {
+      .sbpf_min_version = versions.min_sbpf_version,
+      .sbpf_max_version = versions.max_sbpf_version,
+    };
+    fd_sbpf_elf_info_t elf_info[1];
+    if( FD_UNLIKELY( fd_sbpf_elf_peek( elf_info, elf, elf_sz, &loader_config )!=FD_SBPF_ELF_SUCCESS ) ) {
+      return;
+    }
+  } while(0);
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L451-L459 */
+  ulong lamports_to_burn;
+  if( FD_UNLIKELY( fd_ulong_checked_add( target->program_account->meta.lamports, source->meta.lamports, &lamports_to_burn ) ) ) return;
+  if( FD_UNLIKELY( fd_ulong_checked_add( lamports_to_burn, target->program_data_account_lamports, &lamports_to_burn ) ) )       return;
+
+  ulong lamports_to_fund;
+  if( FD_UNLIKELY( fd_ulong_checked_add( new_target_program->meta.lamports, new_target_program_data->meta.lamports, &lamports_to_fund ) ) ) return;
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L460 */
+  if( FD_UNLIKELY( fd_update_capitalization( bank, lamports_to_burn, lamports_to_fund ) ) ) {
+    FD_LOG_CRIT(( "invariant violation: capitalization overflow while upgrading Loader v2 program to Loader v3" ));
+  }
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L462-L468 */
+  tmp_account_store( new_target_program,      accdb, xid, bank, capture_ctx );
+  tmp_account_store( new_target_program_data, accdb, xid, bank, capture_ctx );
+
+  fd_tmp_account_t * empty = &runtime_stack->bpf_migration.empty;
+  tmp_account_new( empty, 0UL );
+  empty->addr = source->addr;
+  tmp_account_store( empty, accdb, xid, bank, capture_ctx );
+
+  /* TODO: Agave updates "delta_off_chain", using these two fields,
+     which is not consensus-critical so we don't update this in our
+     migration code.
+
+     However, if we ever enable Firedancer-produced snapshots we will
+     need to track this correctly. */
+  (void)old_data_sz;
+  (void)new_data_sz;
+
+  fd_memset( &runtime_stack->bpf_migration, 0, sizeof(runtime_stack->bpf_migration) );
+}

src/flamenco/runtime/fd_runtime.c

@@ -514,6 +514,19 @@ fd_compute_and_apply_new_feature_activations( fd_bank_t *               bank,
   if( FD_UNLIKELY( FD_FEATURE_JUST_ACTIVATED_BANK( bank, vote_state_v4 ) ) ) {
     fd_upgrade_core_bpf_program( bank, accdb, xid, runtime_stack, &fd_solana_stake_program_id, &fd_solana_stake_program_vote_state_v4_buffer_address, capture_ctx );
   }
+
+  /* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank.rs#L5703-L5716 */
+  if( FD_UNLIKELY( FD_FEATURE_JUST_ACTIVATED_BANK( bank, replace_spl_token_with_p_token ) ) ) {
+    fd_upgrade_loader_v2_program_with_loader_v3_program(
+      bank,
+      accdb,
+      xid,
+      runtime_stack,
+      &fd_solana_spl_token_id,
+      &fd_solana_ptoken_program_buffer_address,
+      FD_FEATURE_ACTIVE_BANK( bank, relax_programdata_account_check_migration ),
+      capture_ctx );
+  }
 }
 
 /* Starting a new epoch.

src/flamenco/runtime/fd_system_ids.c

@@ -44,6 +44,7 @@ const fd_pubkey_t fd_solana_feature_program_buffer_address                = { .u
 const fd_pubkey_t fd_solana_stake_program_buffer_address                  = { .uc = { STAKE_PROG_BUFFER_ID } };
 const fd_pubkey_t fd_solana_stake_program_vote_state_v4_buffer_address    = { .uc = { STAKE_PROG_VOTE_STATE_V4_BUFFER_ID } };
 const fd_pubkey_t fd_solana_slashing_program_buffer_address               = { .uc = { SLASHING_PROG_BUFFER_ID } };
+const fd_pubkey_t fd_solana_ptoken_program_buffer_address                 = { .uc = { PTOKEN_PROG_BUFFER_ID } };
 
 const fd_pubkey_t fd_solana_migration_authority                           = { .uc = { MIGRATION_AUTHORITY_ID } };
 

src/flamenco/runtime/fd_system_ids.h

@@ -53,6 +53,7 @@ extern const fd_pubkey_t fd_solana_feature_program_buffer_address;
 extern const fd_pubkey_t fd_solana_stake_program_buffer_address;
 extern const fd_pubkey_t fd_solana_stake_program_vote_state_v4_buffer_address;
 extern const fd_pubkey_t fd_solana_slashing_program_buffer_address;
+extern const fd_pubkey_t fd_solana_ptoken_program_buffer_address;
 
 /* BPF migration authority
    https://github.com/anza-xyz/agave/blob/v2.2.6/programs/bpf_loader/src/lib.rs#L399-L401 */

src/flamenco/runtime/fd_system_ids_pp.h

@@ -85,5 +85,7 @@
                                            0x0dU,0x79U,0xd4U,0x08U,0xa8U,0x96U,0xe6U,0x1aU,0xe2U,0x65U,0xf9U,0x8fU,0x23U,0xd4U,0x52U,0x64U
 #define SLASHING_PROG_BUFFER_ID            0x06U,0x68U,0x2eU,0x32U,0xc0U,0x4cU,0xe7U,0x71U,0xa4U,0x71U,0xc5U,0x09U,0xd0U,0xf0U,0xc6U,0xa8U, \
                                            0x30U,0x2bU,0x19U,0x20U,0x7bU,0xc3U,0x8aU,0x70U,0x77U,0x0aU,0xddU,0xc6U,0x16U,0x48U,0xb6U,0x3fU
+#define PTOKEN_PROG_BUFFER_ID              0x0cU,0x44U,0xe0U,0x0aU,0xa3U,0xddU,0x2cU,0xf3U,0xb5U,0x43U,0x4dU,0x54U,0x3fU,0x9eU,0xA7U,0xafU, \
+                                           0x85U,0x76U,0x97U,0x50U,0xefU,0xc7U,0x5fU,0x16U,0xadU,0xe0U,0xadU,0x88U,0x59U,0xdfU,0xdcU,0x14U
 #define MIGRATION_AUTHORITY_ID             0x24U,0x47U,0x35U,0xd0U,0x66U,0xd1U,0x46U,0x66U,0x76U,0x6dU,0xb4U,0x43U,0xd0U,0xf2U,0xcaU,0xe8U, \
                                            0x0aU,0xcbU,0xb0U,0x23U,0x6fU,0x8cU,0x76U,0x21U,0xebU,0xeeU,0x3eU,0x0bU,0xa3U,0xceU,0x8dU,0xa3U

src/flamenco/runtime/program/fd_builtin_programs.h

@@ -111,6 +111,17 @@ fd_upgrade_core_bpf_program( fd_bank_t *                            bank,
                              fd_pubkey_t const *                    source_buffer_address,
                              fd_capture_ctx_t *                     capture_ctx );
 
+/* https://github.com/anza-xyz/agave/blob/v4.0.0-beta.2/runtime/src/bank/builtins/core_bpf_migration/mod.rs#L402-L408 */
+void
+fd_upgrade_loader_v2_program_with_loader_v3_program( fd_bank_t *               bank,
+                                                     fd_accdb_user_t *         accdb,
+                                                     fd_funk_txn_xid_t const * xid,
+                                                     fd_runtime_stack_t *      runtime_stack,
+                                                     fd_pubkey_t const *       loader_v2_program_address,
+                                                     fd_pubkey_t const *       source_buffer_address,
+                                                     int                       allow_prefunded,
+                                                     fd_capture_ctx_t *        capture_ctx );
+
 FD_PROTOTYPES_END
 
 #endif /* HEADER_fd_src_flamenco_runtime_program_fd_builtin_programs_h */