blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Renames --boot-from-local-state to --use-snapshot-archives-at-startup (#32217)

This commit is contained in:
Brooks 2023-06-23 18:34:18 -04:00 committed by GitHub
parent 383063eeb2
commit 64ecfaf769
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 119 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.lock generated
View File

@ -5998,6 +5998,8 @@ dependencies = [
"spl-token",
"spl-token-2022",
"static_assertions",
"strum",
"strum_macros",
"tempfile",
"test-case",
"thiserror",

70
ledger-tool/src/main.rs
View File

@ -41,6 +41,7 @@ use {
},
blockstore_processor::ProcessOptions,
shred::Shred,
use_snapshot_archives_at_startup::{self, UseSnapshotArchivesAtStartup},
},
solana_measure::{measure, measure::Measure},
solana_runtime::{
@ -1169,21 +1170,15 @@ fn main() {
.multiple(true)
.takes_value(true)
.help("Log when transactions are processed that reference the given key(s).");
let boot_from_local_state = Arg::with_name("boot_from_local_state")
.long("boot-from-local-state")
.takes_value(false)
.hidden(hidden_unless_forced())
.help("Boot from state already on disk")
.long_help(
"Boot from state already on disk, instead of \
extracting it from a snapshot archive. \
This requires primary access, so another instance of \
solana-ledger-tool or solana-validator cannot \
simultaneously use the same ledger/accounts. \
Note, this will use the latest state available, \
which may be newer than the latest snapshot archive.",
)
.conflicts_with("no_snapshot");
let use_snapshot_archives_at_startup =
Arg::with_name(use_snapshot_archives_at_startup::cli::NAME)
.long(use_snapshot_archives_at_startup::cli::LONG_ARG)
.hidden(hidden_unless_forced())
.takes_value(true)
.possible_values(use_snapshot_archives_at_startup::cli::POSSIBLE_VALUES)
.default_value(use_snapshot_archives_at_startup::cli::default_value())
.help(use_snapshot_archives_at_startup::cli::HELP)
.long_help(use_snapshot_archives_at_startup::cli::LONG_HELP);
let default_max_full_snapshot_archives_to_retain =
&DEFAULT_MAX_FULL_SNAPSHOT_ARCHIVES_TO_RETAIN.to_string();
@ -1543,7 +1538,7 @@ fn main() {
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&debug_key_arg)
.arg(&geyser_plugin_args)
.arg(&boot_from_local_state)
.arg(&use_snapshot_archives_at_startup)
.arg(
Arg::with_name("skip_poh_verify")
.long("skip-poh-verify")
@ -1599,7 +1594,7 @@ fn main() {
.arg(&halt_at_slot_arg)
.arg(&hard_forks_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&boot_from_local_state)
.arg(&use_snapshot_archives_at_startup)
.arg(
Arg::with_name("include_all_votes")
.long("include-all-votes")
@ -1639,7 +1634,7 @@ fn main() {
.arg(&maximum_full_snapshot_archives_to_retain)
.arg(&maximum_incremental_snapshot_archives_to_retain)
.arg(&geyser_plugin_args)
.arg(&boot_from_local_state)
.arg(&use_snapshot_archives_at_startup)
.arg(
Arg::with_name("snapshot_slot")
.index(1)
@ -1828,7 +1823,7 @@ fn main() {
.arg(&hard_forks_arg)
.arg(&geyser_plugin_args)
.arg(&accounts_data_encoding_arg)
.arg(&boot_from_local_state)
.arg(&use_snapshot_archives_at_startup)
.arg(
Arg::with_name("include_sysvars")
.long("include-sysvars")
@ -1861,7 +1856,7 @@ fn main() {
.arg(&hard_forks_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&geyser_plugin_args)
.arg(&boot_from_local_state)
.arg(&use_snapshot_archives_at_startup)
.arg(
Arg::with_name("warp_epoch")
.required(false)
@ -2518,6 +2513,11 @@ fn main() {
);
}
let boot_from_local_state = value_t_or_exit!(
arg_matches,
use_snapshot_archives_at_startup::cli::NAME,
UseSnapshotArchivesAtStartup
) == UseSnapshotArchivesAtStartup::Never;
let process_options = ProcessOptions {
new_hard_forks: hardforks_of(arg_matches, "hard_forks"),
run_verification: !(arg_matches.is_present("skip_poh_verify")
@ -2540,7 +2540,7 @@ fn main() {
.is_present("accounts_db_test_hash_calculation"),
accounts_db_skip_shrink: arg_matches.is_present("accounts_db_skip_shrink"),
runtime_config: RuntimeConfig::default(),
boot_from_local_state: arg_matches.is_present("boot_from_local_state"),
boot_from_local_state,
..ProcessOptions::default()
};
let print_accounts_stats = arg_matches.is_present("print_accounts_stats");
@ -2583,12 +2583,17 @@ fn main() {
),
};
let boot_from_local_state = value_t_or_exit!(
arg_matches,
use_snapshot_archives_at_startup::cli::NAME,
UseSnapshotArchivesAtStartup
) == UseSnapshotArchivesAtStartup::Never;
let process_options = ProcessOptions {
new_hard_forks: hardforks_of(arg_matches, "hard_forks"),
halt_at_slot: value_t!(arg_matches, "halt_at_slot", Slot).ok(),
run_verification: false,
accounts_db_config: Some(get_accounts_db_config(&ledger_path, arg_matches)),
boot_from_local_state: arg_matches.is_present("boot_from_local_state"),
boot_from_local_state,
..ProcessOptions::default()
};
@ -2710,12 +2715,17 @@ fn main() {
NonZeroUsize
);
let genesis_config = open_genesis_config_by(&ledger_path, arg_matches);
let boot_from_local_state = value_t_or_exit!(
arg_matches,
use_snapshot_archives_at_startup::cli::NAME,
UseSnapshotArchivesAtStartup
) == UseSnapshotArchivesAtStartup::Never;
let mut process_options = ProcessOptions {
new_hard_forks,
run_verification: false,
accounts_db_config: Some(get_accounts_db_config(&ledger_path, arg_matches)),
accounts_db_skip_shrink: arg_matches.is_present("accounts_db_skip_shrink"),
boot_from_local_state: arg_matches.is_present("boot_from_local_state"),
boot_from_local_state,
..ProcessOptions::default()
};
let blockstore = Arc::new(open_blockstore(
@ -3123,12 +3133,17 @@ fn main() {
}
("accounts", Some(arg_matches)) => {
let halt_at_slot = value_t!(arg_matches, "halt_at_slot", Slot).ok();
let boot_from_local_state = value_t_or_exit!(
arg_matches,
use_snapshot_archives_at_startup::cli::NAME,
UseSnapshotArchivesAtStartup
) == UseSnapshotArchivesAtStartup::Never;
let process_options = ProcessOptions {
new_hard_forks: hardforks_of(arg_matches, "hard_forks"),
halt_at_slot,
run_verification: false,
accounts_db_config: Some(get_accounts_db_config(&ledger_path, arg_matches)),
boot_from_local_state: arg_matches.is_present("boot_from_local_state"),
boot_from_local_state,
..ProcessOptions::default()
};
let genesis_config = open_genesis_config_by(&ledger_path, arg_matches);
@ -3214,12 +3229,17 @@ fn main() {
}
("capitalization", Some(arg_matches)) => {
let halt_at_slot = value_t!(arg_matches, "halt_at_slot", Slot).ok();
let boot_from_local_state = value_t_or_exit!(
arg_matches,
use_snapshot_archives_at_startup::cli::NAME,
UseSnapshotArchivesAtStartup
) == UseSnapshotArchivesAtStartup::Never;
let process_options = ProcessOptions {
new_hard_forks: hardforks_of(arg_matches, "hard_forks"),
halt_at_slot,
run_verification: false,
accounts_db_config: Some(get_accounts_db_config(&ledger_path, arg_matches)),
boot_from_local_state: arg_matches.is_present("boot_from_local_state"),
boot_from_local_state,
..ProcessOptions::default()
};
let genesis_config = open_genesis_config_by(&ledger_path, arg_matches);

2
ledger/Cargo.toml
View File

@ -56,6 +56,8 @@ solana-vote-program = { workspace = true }
spl-token = { workspace = true, features = ["no-entrypoint"] }
spl-token-2022 = { workspace = true, features = ["no-entrypoint"] }
static_assertions = { workspace = true }
strum = { workspace = true, features = ["derive"] }
strum_macros = { workspace = true }
tempfile = { workspace = true }
thiserror = { workspace = true }
tokio = { workspace = true, features = ["full"] }

15
ledger/src/bank_forks_utils.rs
View File

@ -231,9 +231,8 @@ fn bank_forks_from_snapshot(
full_snapshot_archive_info.slot(),
);
// If a newer snapshot archive was downloaded, it is possible that the snapshot
// slot is higher than the local bank we just loaded. It is unlikely the user
// intended to still boot from local state in this scenario.
// If a newer snapshot archive was downloaded, it is possible that its slot is
// higher than the local bank we just loaded. Did the user intend for this?
let latest_snapshot_archive_slot = std::cmp::max(
full_snapshot_archive_info.slot(),
incremental_snapshot_archive_info
@ -242,14 +241,14 @@ fn bank_forks_from_snapshot(
.unwrap_or(0),
);
if bank.slot() < latest_snapshot_archive_slot {
error!(
"Attempting to boot from local state at a slot {} that is *older* than the latest \
snapshot archive slot {}, which is not supported. Either remove the snapshot archive \
or remove the --boot-from-local-state CLI flag.",
warn!(
"Starting up from local state at slot {}, which is *older* \
than the latest snapshot archive at slot {}. If this is not \
desired, change the --use-snapshot-archives-at-startup \
CLI option to \"always\" and restart.",
bank.slot(),
latest_snapshot_archive_slot,
);
process::exit(1);
}
(

1
ledger/src/lib.rs
View File

@ -28,6 +28,7 @@ pub mod sigverify_shreds;
pub mod slot_stats;
mod staking_utils;
pub mod token_balances;
pub mod use_snapshot_archives_at_startup;
#[macro_use]
extern crate solana_metrics;

41
ledger/src/use_snapshot_archives_at_startup.rs Normal file
View File

@ -0,0 +1,41 @@
use strum::{Display, EnumString, EnumVariantNames, IntoStaticStr, VariantNames};
/// When should snapshot archives be used at startup?
#[derive(
Debug, Default, Clone, Copy, PartialEq, Eq, Display, EnumString, EnumVariantNames, IntoStaticStr,
)]
#[strum(serialize_all = "kebab-case")]
pub enum UseSnapshotArchivesAtStartup {
/// If snapshot archives are used, they will be extracted and overwrite any existing state
/// already on disk. This will incur the associated runtime costs for extracting.
#[default]
Always,
/// If snapshot archive are not used, then the local snapshot state already on disk is
/// used instead. If there is no local state on disk, startup will fail.
Never,
}
pub mod cli {
use super::*;
pub const NAME: &str = "use_snapshot_archives_at_startup";
pub const LONG_ARG: &str = "use-snapshot-archives-at-startup";
pub const HELP: &str = "When should snapshot archives be used at startup?";
pub const LONG_HELP: &str = "At startup, when should snapshot archives be extracted \
versus using what is already on disk? \
\nSpecifying \"always\" will always startup by extracting snapshot archives \
and disregard any snapshot-related state already on disk. \
Note that starting up from snapshot archives will incur the runtime costs \
associated with extracting the archives and rebuilding the local state. \
\nSpecifying \"never\" will never startup from snapshot archives \
and will only use snapshot-related state already on disk. \
If there is no state already on disk, startup will fail. \
Note, this will use the latest state available, \
which may be newer than the latest snapshot archive.";
pub const POSSIBLE_VALUES: &[&str] = UseSnapshotArchivesAtStartup::VARIANTS;
pub fn default_value() -> &'static str {
UseSnapshotArchivesAtStartup::default().into()
}
}

2
programs/sbf/Cargo.lock generated
View File

@ -5006,6 +5006,8 @@ dependencies = [
"spl-token",
"spl-token-2022",
"static_assertions",
"strum",
"strum_macros",
"tempfile",
"thiserror",
"tokio",

18
validator/src/cli.rs
View File

@ -19,6 +19,7 @@ use {
validator::{BlockProductionMethod, BlockVerificationMethod},
},
solana_faucet::faucet::{self, FAUCET_PORT},
solana_ledger::use_snapshot_archives_at_startup,
solana_net_utils::{MINIMUM_VALIDATOR_PORT_RANGE_WIDTH, VALIDATOR_PORT_RANGE},
solana_rpc::{rpc::MAX_REQUEST_BODY_SIZE, rpc_pubsub_service::PubSubConfig},
solana_rpc_client_api::request::MAX_MULTIPLE_ACCOUNTS,
@ -292,17 +293,14 @@ pub fn app<'a>(version: &'a str, default_args: &'a DefaultArgs) -> App<'a, 'a> {
.help("Use DIR as snapshot location [default: --ledger value]"),
)
.arg(
Arg::with_name("boot_from_local_state")
.long("boot-from-local-state")
.takes_value(false)
Arg::with_name(use_snapshot_archives_at_startup::cli::NAME)
.long(use_snapshot_archives_at_startup::cli::LONG_ARG)
.hidden(hidden_unless_forced())
.help("Boot from state already on disk")
.long_help(
"Boot from state already on disk, instead of \
extracting it from a snapshot archive. \
Note, this will use the latest state available, \
which may be newer than the latest snapshot archive.",
)
.takes_value(true)
.possible_values(use_snapshot_archives_at_startup::cli::POSSIBLE_VALUES)
.default_value(use_snapshot_archives_at_startup::cli::default_value())
.help(use_snapshot_archives_at_startup::cli::HELP)
.long_help(use_snapshot_archives_at_startup::cli::LONG_HELP)
)
.arg(
Arg::with_name("incremental_snapshot_archive_path")

14
validator/src/main.rs
View File

@ -20,8 +20,12 @@ use {
},
},
solana_gossip::{cluster_info::Node, legacy_contact_info::LegacyContactInfo as ContactInfo},
solana_ledger::blockstore_options::{
BlockstoreCompressionType, BlockstoreRecoveryMode, LedgerColumnOptions, ShredStorageType,
solana_ledger::{
blockstore_options::{
BlockstoreCompressionType, BlockstoreRecoveryMode, LedgerColumnOptions,
ShredStorageType,
},
use_snapshot_archives_at_startup::{self, UseSnapshotArchivesAtStartup},
},
solana_perf::recycler::enable_recycler_warming,
solana_poh::poh_service,
@ -1374,7 +1378,11 @@ pub fn main() {
},
staked_nodes_overrides: staked_nodes_overrides.clone(),
replay_slots_concurrently: matches.is_present("replay_slots_concurrently"),
boot_from_local_state: matches.is_present("boot_from_local_state"),
boot_from_local_state: value_t_or_exit!(
matches,
use_snapshot_archives_at_startup::cli::NAME,
UseSnapshotArchivesAtStartup
) == UseSnapshotArchivesAtStartup::Never,
..ValidatorConfig::default()
};