LCOV - code coverage report
Current view: top level - app/shared_dev/commands/configure - genesis.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 0 216 0.0 %
Date: 2025-10-17 04:46:03 Functions: 0 6 0.0 %

          Line data    Source code
       1             : #define _GNU_SOURCE
       2             : #define FD_SCRATCH_USE_HANDHOLDING 1
       3             : #include "../../../shared/commands/configure/configure.h"
       4             : 
       5             : #include "../../../platform/fd_file_util.h"
       6             : #include "../../../../ballet/poh/fd_poh.h"
       7             : #include "../../../../disco/keyguard/fd_keyload.h"
       8             : #include "../../../../discof/genesis/genesis_hash.h"
       9             : #include "../../../../flamenco/features/fd_features.h"
      10             : #include "../../../../flamenco/genesis/fd_genesis_create.h"
      11             : #include "../../../../flamenco/types/fd_types_custom.h"
      12             : #include "../../../../flamenco/runtime/sysvar/fd_sysvar_clock.h"
      13             : 
      14             : #include <stdio.h>
      15             : #include <unistd.h>
      16             : #include <dirent.h>
      17             : #include <sys/stat.h>
      18             : #include <sys/wait.h>
      19             : 
      20             : #define NAME "genesis"
      21             : 
      22             : /* default_enable_features is a table of features enabled by default */
      23             : 
      24             : static void
      25           0 : default_enable_features( fd_features_t * features ) {
      26           0 :   features->index_erasure_conflict_duplicate_proofs = 0UL;
      27           0 :   features->curve25519_restrict_msm_length = 0UL;
      28           0 :   features->commission_updates_only_allowed_in_first_half_of_epoch = 0UL;
      29           0 :   features->validate_fee_collector_account = 0UL;
      30           0 :   features->incremental_snapshot_only_incremental_hash_calculation = 0UL;
      31           0 :   features->timely_vote_credits = 0UL;
      32           0 :   features->apply_cost_tracker_during_replay = 0UL;
      33           0 :   features->reject_callx_r10 = 1UL;
      34           0 :   features->update_hashes_per_tick = 0UL;
      35           0 :   features->pico_inflation = 0UL;
      36           0 :   features->remaining_compute_units_syscall_enabled = 0UL;
      37           0 :   features->simplify_writable_program_account_check = 0UL;
      38           0 :   features->enable_bpf_loader_set_authority_checked_ix = 0UL;
      39           0 :   features->consume_blockstore_duplicate_proofs = 0UL;
      40           0 :   features->disable_deploy_of_alloc_free_syscall = 0UL;
      41           0 :   features->disable_bpf_loader_instructions = 0UL;
      42           0 :   features->full_inflation_enable = 0UL;
      43           0 :   features->vote_state_add_vote_latency = 0UL;
      44           0 :   features->curve25519_syscall_enabled = 0UL;
      45           0 :   features->error_on_syscall_bpf_function_hash_collisions = 0UL;
      46           0 :   features->update_hashes_per_tick3 = 0UL;
      47           0 :   features->update_hashes_per_tick4 = 0UL;
      48           0 :   features->enable_bpf_loader_extend_program_ix = 0UL;
      49           0 :   features->enable_loader_v4 = 0UL;
      50           0 :   features->increase_tx_account_lock_limit = 0UL;
      51           0 :   features->stake_raise_minimum_delegation_to_1_sol = 0UL;
      52           0 :   features->enable_alt_bn128_syscall = 0UL;
      53           0 :   features->revise_turbine_epoch_stakes = 0UL;
      54           0 :   features->clean_up_delegation_errors = 0UL;
      55           0 :   features->update_hashes_per_tick5 = 0UL;
      56           0 :   features->full_inflation_vote = 0UL;
      57           0 :   features->skip_rent_rewrites = 0UL;
      58           0 :   features->switch_to_new_elf_parser = 0UL;
      59           0 :   features->require_rent_exempt_split_destination = 0UL;
      60           0 :   features->enable_turbine_fanout_experiments = 0UL;
      61           0 :   features->devnet_and_testnet = 0UL;
      62           0 :   features->enable_big_mod_exp_syscall = 0UL;
      63           0 :   features->enable_alt_bn128_compression_syscall = 0UL;
      64           0 :   features->update_hashes_per_tick2 = 0UL;
      65           0 :   features->account_data_direct_mapping = 0UL;
      66           0 :   features->stricter_abi_and_runtime_constraints = 0UL;
      67           0 :   features->bpf_account_data_direct_mapping = 0UL;
      68           0 :   features->relax_authority_signer_check_for_lookup_table_creation = 0UL;
      69           0 :   features->update_hashes_per_tick6 = 0UL;
      70           0 :   features->enable_poseidon_syscall = 0UL;
      71           0 :   features->better_error_codes_for_tx_lamport_check = 0UL;
      72           0 :   features->stake_minimum_delegation_for_rewards = 0UL;
      73           0 :   features->loosen_cpi_size_restriction = 0UL;
      74           0 :   features->drop_legacy_shreds = 0UL;
      75           0 :   features->deprecate_rewards_sysvar = 0UL;
      76           0 :   features->warp_timestamp_again = 0UL;
      77           0 :   features->reduce_stake_warmup_cooldown = 0UL;
      78           0 :   features->disable_turbine_fanout_experiments = 0UL;
      79           0 :   features->blake3_syscall_enabled = 0UL;
      80           0 :   features->last_restart_slot_sysvar = 0UL;
      81           0 :   features->disable_fees_sysvar = 0UL;
      82           0 : }
      83             : 
      84             : /* estimate_hashes_per_tick approximates the PoH hashrate of the current
      85             :    tile.  Spins PoH hashing for estimate_dur_ns nanoseconds.  Returns
      86             :    the hashes per tick achieved, where tick_mhz is the target tick rate
      87             :    in ticks per microsecond (MHz).  Assumes that the estimate duration
      88             :    is larger than the tick duration. */
      89             : 
      90             : static ulong
      91             : estimate_hashes_per_tick( ulong tick_mhz,
      92           0 :                           ulong estimate_dur_ns ) {
      93           0 :   ulong const batch    = 1UL<<20;
      94           0 :   long const  deadline = fd_log_wallclock() + (long)estimate_dur_ns;
      95             : 
      96           0 :   uchar poh_hash[ 32 ] = {0};
      97           0 :   ulong          hash_cnt = 0UL;
      98           0 :   do {
      99           0 :     fd_poh_append( poh_hash, batch );
     100           0 :     hash_cnt += batch;
     101           0 :   } while( fd_log_wallclock() < deadline );
     102             : 
     103           0 :   double hash_cnt_dbl = (double)hash_cnt;
     104           0 :   double tick_cnt_dbl = (double)estimate_dur_ns / ( (double)tick_mhz * 1000.0 );
     105           0 :   if( tick_cnt_dbl < 1.0 ) return 0UL;
     106             : 
     107             :   /* Apply 50% factor to the maximum machine hash rate. */
     108           0 :   double hashes_per_tick = hash_cnt_dbl / tick_cnt_dbl / 2.0;
     109           0 :   return (ulong)hashes_per_tick;
     110           0 : }
     111             : 
     112             : 
     113             : /* Create a new genesis.bin file contents into the provided blob buffer
     114             :    and return the size of the buffer.  Will abort on error if the
     115             :    provided buffer is not large enough. */
     116             : 
     117             : static ulong
     118             : create_genesis( config_t const * config,
     119             :                 uchar *          blob,
     120           0 :                 ulong            blob_max ) {
     121             : 
     122           0 :   fd_genesis_options_t options[1];
     123             : 
     124             :   /* Read in keys */
     125             : 
     126           0 :   uchar const * identity_pubkey_ = fd_keyload_load( config->paths.identity_key, 1 );
     127           0 :   if( FD_UNLIKELY( !identity_pubkey_ ) ) FD_LOG_ERR(( "Failed to load identity key" ));
     128           0 :   memcpy( options->identity_pubkey.key, identity_pubkey_, 32 );
     129           0 :   fd_keyload_unload( identity_pubkey_, 1 );
     130             : 
     131           0 :   char file_path[ PATH_MAX ];
     132           0 :   FD_TEST( fd_cstr_printf_check( file_path, PATH_MAX, NULL, "%s/faucet.json", config->paths.base ) );
     133           0 :   uchar const * faucet_pubkey_ = fd_keyload_load( file_path, 1 );
     134           0 :   if( FD_UNLIKELY( !faucet_pubkey_ ) ) FD_LOG_ERR(( "Failed to load faucet key" ));
     135           0 :   memcpy( options->faucet_pubkey.key, faucet_pubkey_, 32 );
     136           0 :   fd_keyload_unload( faucet_pubkey_, 1 );
     137             : 
     138           0 :   FD_TEST( fd_cstr_printf_check( file_path, PATH_MAX, NULL, "%s/stake-account.json", config->paths.base ) );
     139           0 :   uchar const * stake_pubkey_ = fd_keyload_load( file_path, 1 );
     140           0 :   if( FD_UNLIKELY( !stake_pubkey_ ) ) FD_LOG_ERR(( "Failed to load stake account key" ));
     141           0 :   memcpy( options->stake_pubkey.key, stake_pubkey_, 32 );
     142           0 :   fd_keyload_unload( stake_pubkey_, 1 );
     143             : 
     144           0 :   if( !strcmp( config->paths.vote_account, "" ) ) {
     145           0 :     FD_TEST( fd_cstr_printf_check( file_path, PATH_MAX, NULL, "%s/vote-account.json", config->paths.base ) );
     146           0 :   } else {
     147           0 :     fd_cstr_fini( fd_cstr_append_cstr_safe( fd_cstr_init( file_path ), config->paths.vote_account, PATH_MAX-1UL ) );
     148           0 :   }
     149             : 
     150           0 :   uchar const * vote_pubkey_ = fd_keyload_load( file_path, 1 );
     151           0 :   if( FD_UNLIKELY( !vote_pubkey_ ) ) FD_LOG_ERR(( "Failed to load vote account key" ));
     152           0 :   memcpy( options->vote_pubkey.key, vote_pubkey_, 32 );
     153           0 :   fd_keyload_unload( vote_pubkey_, 1 );
     154             : 
     155           0 :   options->creation_time      = (ulong)fd_log_wallclock() / (ulong)1e9;
     156           0 :   options->faucet_balance     = 500000000000000000UL;
     157           0 :   options->vote_account_stake = config->development.genesis.vote_account_stake_lamports;
     158             : 
     159             :   /* Set up PoH config */
     160             : 
     161           0 :   if( 0UL==config->development.genesis.hashes_per_tick ) {
     162             : 
     163             :     /* set hashes_per_tick to whatever machine is capable of */
     164           0 :     ulong hashes_per_tick =
     165           0 :       estimate_hashes_per_tick( config->development.genesis.target_tick_duration_micros,
     166           0 :                                 (ulong)3e9 /* 3 seconds */ );
     167             : 
     168           0 :     if( hashes_per_tick == 0UL ) {
     169           0 :       FD_LOG_WARNING(( "PoH rate estimation failed.  Defaulting to %lu",
     170           0 :                         FD_SYSVAR_CLOCK_DEFAULT_HASHES_PER_TICK ));
     171           0 :       hashes_per_tick = FD_SYSVAR_CLOCK_DEFAULT_HASHES_PER_TICK;
     172           0 :     }
     173             : 
     174           0 :     options->hashes_per_tick = hashes_per_tick;
     175             : 
     176           0 :   } else if( 1UL==config->development.genesis.hashes_per_tick ) {
     177             : 
     178             :     /* set hashes_per_tick field to 0, which means sleep mode */
     179           0 :     options->hashes_per_tick = 0UL;
     180             : 
     181           0 :   } else {
     182             : 
     183             :     /* set hashes_per_tick to the specified value */
     184           0 :     options->hashes_per_tick = config->development.genesis.hashes_per_tick;
     185             : 
     186           0 :   }
     187             : 
     188           0 :   options->ticks_per_slot               = config->development.genesis.ticks_per_slot;
     189           0 :   options->target_tick_duration_micros  = config->development.genesis.target_tick_duration_micros;
     190             : 
     191           0 :   options->fund_initial_accounts        = config->development.genesis.fund_initial_accounts;
     192           0 :   options->fund_initial_amount_lamports = config->development.genesis.fund_initial_amount_lamports;
     193             : 
     194           0 :   options->warmup_epochs                = config->development.genesis.warmup_epochs;
     195             : 
     196           0 :   fd_features_t features[1];
     197           0 :   fd_features_disable_all( features );
     198           0 :   fd_cluster_version_t cluster_version = {
     199           0 :     .major = FD_DEFAULT_AGAVE_CLUSTER_VERSION_MAJOR,
     200           0 :     .minor = FD_DEFAULT_AGAVE_CLUSTER_VERSION_MINOR,
     201           0 :     .patch = FD_DEFAULT_AGAVE_CLUSTER_VERSION_PATCH
     202           0 :   };
     203           0 :   fd_features_enable_cleaned_up( features, &cluster_version );
     204           0 :   default_enable_features( features );
     205             : 
     206           0 :   options->features = features;
     207             : 
     208             :   /* Serialize blob */
     209             : 
     210           0 :   static uchar scratch_smem[ 16<<20UL ];  /* fits at least 32k accounts */
     211           0 :          ulong scratch_fmem[ 4 ];
     212           0 :   fd_scratch_attach( scratch_smem, scratch_fmem,
     213           0 :                      sizeof(scratch_smem), sizeof(scratch_fmem)/sizeof(ulong) );
     214             : 
     215           0 :   ulong blob_sz = fd_genesis_create( blob, blob_max, options );
     216           0 :   if( FD_UNLIKELY( !blob_sz ) ) FD_LOG_ERR(( "Failed to create genesis blob" ));
     217             : 
     218           0 :   fd_scratch_detach( NULL );
     219             : 
     220           0 :   return blob_sz;
     221           0 : }
     222             : 
     223             : static void
     224           0 : init( config_t const * config ) {
     225           0 :   int bootstrap = !config->gossip.entrypoints_cnt;
     226           0 :   if( FD_LIKELY( !bootstrap ) ) return;
     227             : 
     228           0 :   char _genesis_path[ PATH_MAX ];
     229           0 :   char const * genesis_path;
     230           0 :   if( FD_LIKELY( config->is_firedancer ) ) genesis_path = config->paths.genesis;
     231           0 :   else {
     232           0 :     genesis_path = _genesis_path;
     233           0 :     FD_TEST( fd_cstr_printf_check( _genesis_path, PATH_MAX, NULL, "%s/genesis.bin", config->paths.ledger ) );
     234           0 :   }
     235             : 
     236           0 :   if( FD_UNLIKELY( -1==fd_file_util_mkdir_all( genesis_path, config->uid, config->gid, 0 ) ) )
     237           0 :     FD_LOG_ERR(( "could not create ledger directory `%s` (%i-%s)", config->paths.ledger, errno, fd_io_strerror( errno ) ));
     238             : 
     239           0 :   static uchar blob[ 16<<20UL ];
     240           0 :   ulong blob_sz = create_genesis( config, blob, sizeof(blob) );
     241             : 
     242             :   /* Switch to target user in the configuration when creating the
     243             :      genesis.bin file so it is permissioned correctly. */
     244             : 
     245           0 :   gid_t gid = getgid();
     246           0 :   uid_t uid = getuid();
     247           0 :   if( FD_LIKELY( gid == 0 && setegid( config->gid ) ) )
     248           0 :     FD_LOG_ERR(( "setegid() failed (%i-%s)", errno, fd_io_strerror( errno ) ));
     249           0 :   if( FD_LIKELY( uid == 0 && seteuid( config->uid ) ) )
     250           0 :     FD_LOG_ERR(( "seteuid() failed (%i-%s)", errno, fd_io_strerror( errno ) ));
     251             : 
     252           0 :   mode_t previous = umask( S_IRWXO | S_IRWXG );
     253             : 
     254           0 :   do {
     255           0 :     FILE * genesis_file = fopen( genesis_path, "w" );
     256           0 :     FD_TEST( genesis_file );
     257           0 :     FD_TEST( 1L == fwrite( blob, blob_sz, 1L, genesis_file ) );
     258           0 :     FD_TEST( !fclose( genesis_file ) );
     259           0 :   } while(0);
     260             : 
     261           0 :   umask( previous );
     262             : 
     263           0 :   if( FD_UNLIKELY( seteuid( uid ) ) ) FD_LOG_ERR(( "seteuid() failed (%i-%s)", errno, fd_io_strerror( errno ) ));
     264           0 :   if( FD_UNLIKELY( setegid( gid ) ) ) FD_LOG_ERR(( "setegid() failed (%i-%s)", errno, fd_io_strerror( errno ) ));
     265             : 
     266           0 :   uchar genesis_hash[ 32 ];
     267           0 :   char  genesis_hash_cstr[ FD_BASE58_ENCODED_32_SZ ];
     268             : 
     269           0 :   ushort shred_version;
     270           0 :   int result = compute_shred_version( genesis_path, &shred_version, genesis_hash );
     271           0 :   if( FD_UNLIKELY( -1==result ) ) FD_LOG_ERR(( "could not compute shred version from genesis file `%s` (%i-%s)", genesis_path, errno, fd_io_strerror( errno ) ));
     272             : 
     273           0 :   FD_LOG_INFO(( "Created %s:  genesis_hash=%s sz=%lu",
     274           0 :                 genesis_path,
     275           0 :                 fd_base58_encode_32( genesis_hash, NULL, genesis_hash_cstr ),
     276           0 :                 blob_sz ));
     277           0 :   FD_LOG_INFO(( "Shred version: %hu", shred_version ));
     278           0 : }
     279             : 
     280             : static int
     281             : fini( config_t const * config,
     282           0 :       int              pre_init ) {
     283           0 :   (void)pre_init;
     284             : 
     285           0 :   char _genesis_path[ PATH_MAX ];
     286           0 :   char const * genesis_path;
     287           0 :   if( FD_LIKELY( config->is_firedancer ) ) genesis_path = config->paths.genesis;
     288           0 :   else {
     289           0 :     genesis_path = _genesis_path;
     290           0 :     FD_TEST( fd_cstr_printf_check( _genesis_path, PATH_MAX, NULL, "%s/genesis.bin", config->paths.ledger ) );
     291           0 :   }
     292             : 
     293           0 :   if( FD_UNLIKELY( unlink( genesis_path ) && errno!=ENOENT ) )
     294           0 :     FD_LOG_ERR(( "could not remove genesis.bin file `%s` (%i-%s)", genesis_path, errno, fd_io_strerror( errno ) ));
     295           0 :   return 0;
     296           0 : }
     297             : 
     298             : static configure_result_t
     299           0 : check( config_t const * config ) {
     300           0 :   int bootstrap = !config->gossip.entrypoints_cnt;
     301             : 
     302           0 :   char _genesis_path[ PATH_MAX ];
     303           0 :   char const * genesis_path;
     304           0 :   if( FD_LIKELY( config->is_firedancer ) ) genesis_path = config->paths.genesis;
     305           0 :   else {
     306           0 :     genesis_path = _genesis_path;
     307           0 :     FD_TEST( fd_cstr_printf_check( _genesis_path, PATH_MAX, NULL, "%s/genesis.bin", config->paths.ledger ) );
     308           0 :   }
     309             : 
     310           0 :   struct stat st;
     311           0 :   int err = stat( genesis_path, &st );
     312           0 :   if( FD_UNLIKELY( -1==err && errno!=ENOENT ) ) FD_LOG_ERR(( "could not stat genesis.bin file at `%s` (%i-%s)", genesis_path, errno, fd_io_strerror( errno ) ));
     313             : 
     314           0 :   if( FD_UNLIKELY( bootstrap ) ) {
     315           0 :     if( FD_UNLIKELY( -1==err && errno==ENOENT ) ) NOT_CONFIGURED( "`%s` does not exist", genesis_path );
     316           0 :   } else {
     317           0 :     if( FD_UNLIKELY( -1==err && errno==ENOENT ) ) CONFIGURE_OK();
     318           0 :   }
     319             : 
     320           0 :   CHECK( check_dir( config->paths.ledger, config->uid, config->gid, S_IFDIR | S_IRUSR | S_IWUSR | S_IXUSR ) );
     321           0 :   CHECK( check_file( genesis_path, config->uid, config->gid, S_IFREG | S_IRUSR | S_IWUSR ) );
     322             : 
     323           0 :   PARTIALLY_CONFIGURED( "`%s` already exists", genesis_path );
     324           0 : }
     325             : 
     326             : configure_stage_t fd_cfg_stage_genesis = {
     327             :   .name  = NAME,
     328             :   .init  = init,
     329             :   .fini  = fini,
     330             :   .check = check,
     331             :   .always_recreate = 1,
     332             : };
     333             : 
     334             : #undef NAME

Generated by: LCOV version 1.14