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.

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

Collator hardware benchmark #1315

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ sc-network-sync = { git = "https://github.com/paritytech/polkadot-sdk", branch =
sc-offchain = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
sc-rpc = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
sc-service = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
sc-sysinfo = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
sc-telemetry = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
sc-tracing = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
sc-transaction-pool = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" }
Expand Down
6 changes: 3 additions & 3 deletions bin/collator/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ sc-network-sync = { workspace = true }
sc-offchain = { workspace = true }
sc-rpc = { workspace = true }
sc-service = { workspace = true }
sc-sysinfo = { workspace = true }
sc-telemetry = { workspace = true }
sc-tracing = { workspace = true }
sc-transaction-pool = { workspace = true }
Expand Down Expand Up @@ -132,7 +133,7 @@ polkadot-service = { workspace = true }

# benchmark dependencies
frame-benchmarking = { workspace = true, features = ["std"] }
frame-benchmarking-cli = { workspace = true, optional = true }
frame-benchmarking-cli = { workspace = true }
polkadot-runtime-common = { workspace = true, features = ["std"], optional = true }

# try-runtime
Expand All @@ -157,7 +158,6 @@ substrate-build-script-utils = { workspace = true }
[features]
default = ["sc-cli", "polkadot-cli", "sc-service", "sc-service/rocksdb"]
runtime-benchmarks = [
"frame-benchmarking-cli",
"local-runtime/runtime-benchmarks",
"shibuya-runtime/runtime-benchmarks",
"shiden-runtime/runtime-benchmarks",
Expand All @@ -168,7 +168,7 @@ runtime-benchmarks = [
"polkadot-runtime-common",
"astar-primitives/runtime-benchmarks",
"frame-benchmarking/runtime-benchmarks",
"frame-benchmarking-cli?/runtime-benchmarks",
"frame-benchmarking-cli/runtime-benchmarks",
"frame-system/runtime-benchmarks",
"pallet-ethereum/runtime-benchmarks",
"pallet-evm/runtime-benchmarks",
Expand Down
10 changes: 10 additions & 0 deletions bin/collator/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,16 @@ pub struct Cli {
/// Proposer's soft deadline in percents of block size
#[clap(long, default_value = "50")]
pub proposer_soft_deadline_percent: u8,

/// Disable automatic hardware benchmarks.
///
/// By default these benchmarks are automatically ran at startup and measure
/// the CPU speed, the memory bandwidth and the disk speed.
///
/// The results are then printed out in the logs, and also sent as part of
/// telemetry, if telemetry is enabled.
#[arg(long)]
pub no_hardware_benchmarks: bool,
Dinonard marked this conversation as resolved.
Show resolved Hide resolved
}

/// Possible subcommands of the main binary.
Expand Down
10 changes: 9 additions & 1 deletion bin/collator/src/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -835,12 +835,20 @@ pub fn run() -> Result<()> {
}
);

let hwbench = (!cli.no_hardware_benchmarks)
.then_some(config.database.path().map(|database_path| {
let _ = std::fs::create_dir_all(database_path);
sc_sysinfo::gather_hwbench(Some(database_path))
}))
.flatten();

let additional_config = AdditionalConfig {
#[cfg(feature = "evm-tracing")]
evm_tracing_config: evm_tracing_config,
enable_evm_rpc: cli.enable_evm_rpc,
proposer_block_size_limit: cli.proposer_block_size_limit,
proposer_soft_deadline_percent: cli.proposer_soft_deadline_percent
proposer_soft_deadline_percent: cli.proposer_soft_deadline_percent,
hwbench,
};

if config.chain_spec.is_astar() {
Expand Down
53 changes: 52 additions & 1 deletion bin/collator/src/parachain/service.rs
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ async fn build_relay_chain_interface(
telemetry_worker_handle: Option<TelemetryWorkerHandle>,
task_manager: &mut TaskManager,
collator_options: CollatorOptions,
hwbench: Option<sc_sysinfo::HwBench>,
ermalkaleci marked this conversation as resolved.
Show resolved Hide resolved
) -> RelayChainResult<(
Arc<(dyn RelayChainInterface + 'static)>,
Option<CollatorPair>,
Expand All @@ -293,7 +294,7 @@ async fn build_relay_chain_interface(
parachain_config,
telemetry_worker_handle,
task_manager,
None,
hwbench,
)
}
}
Expand Down Expand Up @@ -394,6 +395,7 @@ where
telemetry_worker_handle,
&mut task_manager,
collator_options.clone(),
additional_config.hwbench.clone(),
)
.await
.map_err(|e| sc_service::Error::Application(Box::new(e) as Box<_>))?;
Expand Down Expand Up @@ -531,6 +533,22 @@ where
telemetry: telemetry.as_mut(),
})?;

if let Some(hwbench) = additional_config.hwbench.clone() {
sc_sysinfo::print_hwbench(&hwbench);
if is_authority {
warn_if_slow_hardware(&hwbench);
}

if let Some(ref mut telemetry) = telemetry {
let telemetry_handle = telemetry.handle();
task_manager.spawn_handle().spawn(
"telemetry_hwbench",
None,
sc_sysinfo::initialize_hwbench_telemetry(telemetry_handle, hwbench),
);
}
}

let announce_block = {
let sync_service = sync_service.clone();
Arc::new(move |hash, data| sync_service.announce_block(hash, data))
Expand Down Expand Up @@ -596,6 +614,9 @@ pub struct AdditionalConfig {

/// Soft deadline limit used by `Proposer`
pub proposer_soft_deadline_percent: u8,

/// Hardware benchmarks score
ermalkaleci marked this conversation as resolved.
Show resolved Hide resolved
pub hwbench: Option<sc_sysinfo::HwBench>,
}

/// Start a node with the given parachain `Configuration` and relay chain `Configuration`.
Expand Down Expand Up @@ -697,6 +718,7 @@ where
telemetry_worker_handle,
&mut task_manager,
collator_options.clone(),
additional_config.hwbench.clone(),
)
.await
.map_err(|e| sc_service::Error::Application(Box::new(e) as Box<_>))?;
Expand Down Expand Up @@ -866,6 +888,22 @@ where
telemetry: telemetry.as_mut(),
})?;

if let Some(hwbench) = additional_config.hwbench.clone() {
sc_sysinfo::print_hwbench(&hwbench);
if is_authority {
warn_if_slow_hardware(&hwbench);
}

if let Some(ref mut telemetry) = telemetry {
let telemetry_handle = telemetry.handle();
task_manager.spawn_handle().spawn(
"telemetry_hwbench",
None,
sc_sysinfo::initialize_hwbench_telemetry(telemetry_handle, hwbench),
);
}
}

let announce_block = {
let sync_service = sync_service.clone();
Arc::new(move |hash, data| sync_service.announce_block(hash, data))
Expand Down Expand Up @@ -1374,3 +1412,16 @@ pub async fn start_shibuya_node(
)
.await
}

/// Checks that the hardware meets the requirements and print a warning otherwise.
fn warn_if_slow_hardware(hwbench: &sc_sysinfo::HwBench) {
// Polkadot para-chains should generally use these requirements to ensure that the relay-chain
// will not take longer than expected to import its blocks.
if let Err(err) = frame_benchmarking_cli::SUBSTRATE_REFERENCE_HARDWARE.check_hardware(hwbench) {
log::warn!(
"⚠️ The hardware does not meet the minimal requirements {} for role 'Authority' find out more at:\n\
https://wiki.polkadot.network/docs/maintain-guides-how-to-validate-polkadot#reference-hardware",
err
);
}
}
Loading