Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ledger-tool: Deduplicate max-genesis-archive-unpacked-size argument #1774

Merged
merged 2 commits into from
Jun 18, 2024
Merged

ledger-tool: Deduplicate max-genesis-archive-unpacked-size argument #1774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7c1b38
ledger-tool: Deduplicate max-genesis-archive-unpacked-size argument
steviez Jun 18, 2024
2f9e1f7
Make function return single arg instead of slice
steviez Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions ledger-tool/src/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,22 @@ pub fn accounts_db_args<'a, 'b>() -> Box<[Arg<'a, 'b>]> {
.into_boxed_slice()
}

// For our current version of CLAP, the value passed to Arg::default_value()
// must be a &str. But, we can't convert an integer to a &str at compile time.
// So, declare this constant and enforce equality with the following unit test
// test_max_genesis_archive_unpacked_size_constant
const MAX_GENESIS_ARCHIVE_UNPACKED_SIZE_STR: &str = "10485760";

/// Returns the arguments that configure loading genesis
pub fn load_genesis_arg<'a, 'b>() -> Arg<'a, 'b> {
Arg::with_name("max_genesis_archive_unpacked_size")
.long("max-genesis-archive-unpacked-size")
.value_name("NUMBER")
.takes_value(true)
.default_value(MAX_GENESIS_ARCHIVE_UNPACKED_SIZE_STR)
.help("maximum total uncompressed size of unpacked genesis archive")
}

/// Returns the arguments that configure snapshot loading
pub fn snapshot_args<'a, 'b>() -> Box<[Arg<'a, 'b>]> {
vec![
Expand Down Expand Up @@ -278,3 +294,18 @@ pub fn hardforks_of(matches: &ArgMatches<'_>, name: &str) -> Option<Vec<Slot>> {
None
}
}

#[cfg(test)]
mod tests {
use {super::*, solana_accounts_db::hardened_unpack::MAX_GENESIS_ARCHIVE_UNPACKED_SIZE};

#[test]
fn test_max_genesis_archive_unpacked_size_constant() {
assert_eq!(
MAX_GENESIS_ARCHIVE_UNPACKED_SIZE,
MAX_GENESIS_ARCHIVE_UNPACKED_SIZE_STR
.parse::<u64>()
.unwrap()
);
}
}
33 changes: 12 additions & 21 deletions ledger-tool/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ use {
log::*,
serde_derive::Serialize,
solana_account_decoder::UiAccountEncoding,
solana_accounts_db::{
accounts_db::CalcAccountsHashDataSource, accounts_index::ScanConfig,
hardened_unpack::MAX_GENESIS_ARCHIVE_UNPACKED_SIZE,
},
solana_accounts_db::{accounts_db::CalcAccountsHashDataSource, accounts_index::ScanConfig},
solana_clap_utils::{
hidden_unless_forced,
input_parsers::{cluster_type_of, pubkey_of, pubkeys_of},
Expand Down Expand Up @@ -561,6 +558,7 @@ fn main() {

solana_logger::setup_with_default_filter();

let load_genesis_config_arg = load_genesis_arg();
let accounts_db_config_args = accounts_db_args();
let snapshot_config_args = snapshot_args();

Expand Down Expand Up @@ -608,13 +606,6 @@ fn main() {
.long("allow-dead-slots")
.takes_value(false)
.help("Output dead slots as well");
let default_genesis_archive_unpacked_size = MAX_GENESIS_ARCHIVE_UNPACKED_SIZE.to_string();
let max_genesis_archive_unpacked_size_arg = Arg::with_name("max_genesis_archive_unpacked_size")
.long("max-genesis-archive-unpacked-size")
.value_name("NUMBER")
.takes_value(true)
.default_value(&default_genesis_archive_unpacked_size)
.help("maximum total uncompressed size of unpacked genesis archive");
let hashes_per_tick = Arg::with_name("hashes_per_tick")
.long("hashes-per-tick")
.value_name("NUM_HASHES|\"sleep\"")
Expand Down Expand Up @@ -771,7 +762,7 @@ fn main() {
.subcommand(
SubCommand::with_name("genesis")
.about("Prints the ledger's genesis config")
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&load_genesis_config_arg)
.arg(
Arg::with_name("accounts")
.long("accounts")
Expand All @@ -790,12 +781,12 @@ fn main() {
.subcommand(
SubCommand::with_name("genesis-hash")
.about("Prints the ledger's genesis hash")
.arg(&max_genesis_archive_unpacked_size_arg),
.arg(&load_genesis_config_arg)
)
.subcommand(
SubCommand::with_name("modify-genesis")
.about("Modifies genesis parameters")
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&load_genesis_config_arg)
.arg(&hashes_per_tick)
.arg(
Arg::with_name("cluster_type")
Expand All @@ -815,22 +806,23 @@ fn main() {
.subcommand(
SubCommand::with_name("shred-version")
.about("Prints the ledger's shred hash")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&hard_forks_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
)
.subcommand(
SubCommand::with_name("bank-hash")
.about("Prints the hash of the working bank after reading the ledger")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&halt_at_slot_arg)
)
.subcommand(
SubCommand::with_name("verify")
.about("Verify the ledger")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&halt_at_slot_arg)
Expand All @@ -841,7 +833,6 @@ fn main() {
.arg(&accounts_db_test_hash_calculation_arg)
.arg(&os_memory_stats_reporting_arg)
.arg(&allow_dead_slots_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&debug_key_arg)
.arg(&geyser_plugin_args)
.arg(&log_messages_bytes_limit_arg)
Expand Down Expand Up @@ -967,11 +958,11 @@ fn main() {
.subcommand(
SubCommand::with_name("graph")
.about("Create a Graphviz rendering of the ledger")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&halt_at_slot_arg)
.arg(&hard_forks_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(
Arg::with_name("include_all_votes")
.long("include-all-votes")
Expand Down Expand Up @@ -1000,10 +991,10 @@ fn main() {
.subcommand(
SubCommand::with_name("create-snapshot")
.about("Create a new ledger snapshot")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&hard_forks_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&snapshot_version_arg)
.arg(&geyser_plugin_args)
.arg(&log_messages_bytes_limit_arg)
Expand Down Expand Up @@ -1206,14 +1197,14 @@ fn main() {
.subcommand(
SubCommand::with_name("accounts")
.about("Print account stats and contents after processing the ledger")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&halt_at_slot_arg)
.arg(&hard_forks_arg)
.arg(&geyser_plugin_args)
.arg(&log_messages_bytes_limit_arg)
.arg(&accounts_data_encoding_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(
Arg::with_name("include_sysvars")
.long("include-sysvars")
Expand Down Expand Up @@ -1260,11 +1251,11 @@ fn main() {
.subcommand(
SubCommand::with_name("capitalization")
.about("Print capitalization (aka, total supply) while checksumming it")
.arg(&load_genesis_config_arg)
.args(&accounts_db_config_args)
.args(&snapshot_config_args)
.arg(&halt_at_slot_arg)
.arg(&hard_forks_arg)
.arg(&max_genesis_archive_unpacked_size_arg)
.arg(&geyser_plugin_args)
.arg(&log_messages_bytes_limit_arg)
.arg(
Expand Down
10 changes: 3 additions & 7 deletions ledger-tool/src/program.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,8 @@ impl ProgramSubCommand for App<'_, '_> {
)
.required(true)
.index(1);
let max_genesis_arg = Arg::with_name("max_genesis_archive_unpacked_size")
.long("max-genesis-archive-unpacked-size")
.value_name("NUMBER")
.takes_value(true)
.default_value("10485760")
.help("maximum total uncompressed size of unpacked genesis archive");

let load_genesis_config_arg = load_genesis_arg();
let snapshot_config_args = snapshot_args();

self.subcommand(
Expand Down Expand Up @@ -161,8 +157,8 @@ and the following fields are required
.takes_value(true)
.default_value("0"),
)
.arg(&load_genesis_config_arg)
.args(&snapshot_config_args)
.arg(&max_genesis_arg)
.arg(
Arg::with_name("memory")
.help("Heap memory for the program to run on")
Expand Down