cli: introduce host-perf-check command

cli/src/cli.rs

@@ -54,6 +54,10 @@ pub enum Subcommand {
 	#[structopt(name = "benchmark", about = "Benchmark runtime pallets.")]
 	Benchmark(frame_benchmarking_cli::BenchmarkCmd),
 
+	/// Compiles a sample wasm code in order to measure the machine capabilities
+	/// of running PVF host.
+	HostPerfCheck,
+
 	/// Try some command against runtime state.
 	#[cfg(feature = "try-runtime")]
 	TryRuntime(try_runtime_cli::TryRuntimeCmd),

cli/src/command.rs

@@ -17,9 +17,24 @@
 use crate::cli::{Cli, Subcommand};
 use futures::future::TryFutureExt;
 use log::info;
+use polkadot_node_core_pvf::{sc_executor_common, sp_maybe_compressed_blob};
 use sc_cli::{Role, RuntimeVersion, SubstrateCli};
 use service::{self, IdentifyVariant};
 use sp_core::crypto::Ss58AddressFormatRegistry;
+use std::{fs::OpenOptions, path::Path, time::Duration};
+
+#[allow(missing_docs)]
+#[derive(thiserror::Error, Debug)]
+pub enum PerfCheckError {
+	#[error("This subcommand is only available in release mode")]
+	DebugBuildNotSupported,
+
+	#[error("Failed to decompress wasm code")]
+	CodeDecompressionFailed,
+
+	#[error(transparent)]
+	Wasm(#[from] sc_executor_common::error::WasmError),
+}
 
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
@@ -32,6 +47,9 @@ pub enum Error {
 	#[error(transparent)]
 	SubstrateService(#[from] sc_service::Error),
 
+	#[error(transparent)]
+	PerfCheck(#[from] PerfCheckError),
+
 	#[error("Other: {0}")]
 	Other(String),
 }
@@ -215,6 +233,57 @@ fn ensure_dev(spec: &Box<dyn service::ChainSpec>) -> std::result::Result<(), Str
 	}
 }
 
+/// Runs a performance check via compiling sample wasm code with a timeout.
+/// Should only be run in release build since the check would take too much time otherwise.
+/// Returns `Ok` if the check has been passed previously.
+#[allow(dead_code)]
+fn host_perf_check() -> Result<()> {
+	const PERF_CHECK_TIME_LIMIT: Duration = Duration::from_secs(20);
+	const CODE_SIZE_LIMIT: usize = 1024usize.pow(3);
+	const WASM_CODE: &[u8] = include_bytes!(
+		"../../target/release/wbuild/kusama-runtime/kusama_runtime.compact.compressed.wasm"
+	);
+	const CHECK_PASSED_FILE_NAME: &str = ".perf_check_passed";
+
+	// We will try to save a dummy file to the same path as the polkadot binary
+	// to make it independent from the current directory.
+	let check_passed_path = std::env::current_exe()
+		.map(|mut path| {
+			path.pop();
+			path
+		})
+		.unwrap_or_default()
+		.join(CHECK_PASSED_FILE_NAME);
+
+	// To avoid running the check on every launch we create a dummy dot-file on success.
+	if Path::new(&check_passed_path).exists() {
+		info!("Performance check skipped: already passed");
+		return Ok(())
+	}
+
+	info!("Running the performance check...");
+	let start = std::time::Instant::now();
+
+	// Recreate the pipeline from the pvf prepare worker.
+	let code = sp_maybe_compressed_blob::decompress(WASM_CODE, CODE_SIZE_LIMIT)
+		.or(Err(PerfCheckError::CodeDecompressionFailed))?;
+	let blob = polkadot_node_core_pvf::prevalidate(code.as_ref()).map_err(PerfCheckError::from)?;
+	let _ = polkadot_node_core_pvf::prepare(blob).map_err(PerfCheckError::from)?;
+
+	let elapsed = start.elapsed();
+	if elapsed <= PERF_CHECK_TIME_LIMIT {
+		info!("Performance check passed, elapsed: {:?}", start.elapsed());
+		// `touch` a dummy file.
+		let _ = OpenOptions::new().create(true).write(true).open(Path::new(&check_passed_path));
+		Ok(())
+	} else {
+		Err(Error::Other(format!(
+			"Performance check not passed: exceeded the {:?} time limit, elapsed: {:?}",
+			PERF_CHECK_TIME_LIMIT, elapsed
+		)))
+	}
+}
+
 /// Launch a node, accepting arguments just like a regular node,
 /// accepts an alternative overseer generator, to adjust behavior
 /// for integration tests as needed.
@@ -415,6 +484,20 @@ pub fn run() -> Result<()> {
 			#[cfg(not(feature = "polkadot-native"))]
 			panic!("No runtime feature (polkadot, kusama, westend, rococo) is enabled")
 		},
+		Some(Subcommand::HostPerfCheck) => {
+			let mut builder = sc_cli::LoggerBuilder::new("");
+			builder.with_colors(true);
+			let _ = builder.init();
+
+			#[cfg(not(debug_assertions))]
+			{
+				host_perf_check()
+			}
+			#[cfg(debug_assertions)]
+			{
+				Err(PerfCheckError::DebugBuildNotSupported.into())
+			}
+		},
 		Some(Subcommand::Key(cmd)) => Ok(cmd.run(&cli)?),
 		#[cfg(feature = "try-runtime")]
 		Some(Subcommand::TryRuntime(cmd)) => {

node/core/pvf/src/lib.rs

@@ -102,4 +102,9 @@ pub use metrics::Metrics;
 pub use execute::worker_entrypoint as execute_worker_entrypoint;
 pub use prepare::worker_entrypoint as prepare_worker_entrypoint;
 
+pub use executor_intf::{prepare, prevalidate};
+
+pub use sc_executor_common;
+pub use sp_maybe_compressed_blob;
+
 const LOG_TARGET: &str = "parachain::pvf";