New PVF validation host (#2710)

* Implement PVF validation host * WIP: Diener * Increase the alloted compilation time * Add more comments * Minor clean up * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Fix pruning artifact removal * Fix formatting and newlines * Fix the thread pool * Update node/core/pvf/src/executor_intf.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Remove redundant test declaration * Don't convert the path into an intermediate string * Try to workaround the test failure * Use the puppet_worker trick again * Fix a blip * Move `ensure_wasmtime_version` under the tests mod * Add a macro for puppet_workers * fix build for not real-overseer * Rename the puppet worker for adder collator * play it safe with the name of adder puppet worker * Typo: triggered * Add more comments * Do not kill exec worker on every error * Plumb Duration for timeouts * typo: critical * Add proofs * Clean unused imports * Revert "WIP: Diener" This reverts commit b9f54e513366c7a6dfdd117ac19fbdc46b900b4d. * Sync version of wasmtime * Update cargo.lock * Update Substrate * Merge fixes still * Update wasmtime version in test * bastifmt Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Squash spaces * Trailing new line for testing.rs * Remove controversial code * comment about biasing * Fix suggestion * Add comments * make it more clear why unwrap_err * tmpfile retry * proper proofs for claim_idle * Remove mutex from ValidationHost * Add some more logging * Extract exec timeout into a constant * Add some clarifying logging * Use blake2_256 * Clean up the merge Specifically the leftovers after removing real-overseer * Update parachain/test-parachains/adder/collator/Cargo.toml Co-authored-by: Andronik Ordian <write@reusable.software> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Andronik Ordian <write@reusable.software>
2026-07-23 22:25:42 +00:00 · 2021-04-09 01:09:56 +03:00
parent 896ec8dbc3
commit 59b4d6511f
43 changed files with 5108 additions and 1991 deletions
@@ -0,0 +1,131 @@
+// Copyright 2021 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+use super::TestHost;
+use polkadot_parachain::{
+	primitives::{
+		RelayChainBlockNumber, BlockData as GenericBlockData, HeadData as GenericHeadData,
+		ValidationParams,
+	},
+};
+use parity_scale_codec::{Decode, Encode};
+use adder::{HeadData, BlockData, hash_state};
+
+#[async_std::test]
+async fn execute_good_on_parent() {
+	let parent_head = HeadData {
+		number: 0,
+		parent_hash: [0; 32],
+		post_state: hash_state(0),
+	};
+
+	let block_data = BlockData { state: 0, add: 512 };
+
+	let host = TestHost::new();
+
+	let ret = host
+		.validate_candidate(
+			adder::wasm_binary_unwrap(),
+			ValidationParams {
+				parent_head: GenericHeadData(parent_head.encode()),
+				block_data: GenericBlockData(block_data.encode()),
+				relay_parent_number: 1,
+				relay_parent_storage_root: Default::default(),
+			},
+		)
+		.await
+		.unwrap();
+
+	let new_head = HeadData::decode(&mut &ret.head_data.0[..]).unwrap();
+
+	assert_eq!(new_head.number, 1);
+	assert_eq!(new_head.parent_hash, parent_head.hash());
+	assert_eq!(new_head.post_state, hash_state(512));
+}
+
+#[async_std::test]
+async fn execute_good_chain_on_parent() {
+	let mut number = 0;
+	let mut parent_hash = [0; 32];
+	let mut last_state = 0;
+
+	let host = TestHost::new();
+
+	for add in 0..10 {
+		let parent_head = HeadData {
+			number,
+			parent_hash,
+			post_state: hash_state(last_state),
+		};
+
+		let block_data = BlockData {
+			state: last_state,
+			add,
+		};
+
+		let ret = host
+			.validate_candidate(
+				adder::wasm_binary_unwrap(),
+				ValidationParams {
+					parent_head: GenericHeadData(parent_head.encode()),
+					block_data: GenericBlockData(block_data.encode()),
+					relay_parent_number: number as RelayChainBlockNumber + 1,
+					relay_parent_storage_root: Default::default(),
+				},
+			)
+			.await
+			.unwrap();
+
+		let new_head = HeadData::decode(&mut &ret.head_data.0[..]).unwrap();
+
+		assert_eq!(new_head.number, number + 1);
+		assert_eq!(new_head.parent_hash, parent_head.hash());
+		assert_eq!(new_head.post_state, hash_state(last_state + add));
+
+		number += 1;
+		parent_hash = new_head.hash();
+		last_state += add;
+	}
+}
+
+#[async_std::test]
+async fn execute_bad_on_parent() {
+	let parent_head = HeadData {
+		number: 0,
+		parent_hash: [0; 32],
+		post_state: hash_state(0),
+	};
+
+	let block_data = BlockData {
+		state: 256, // start state is wrong.
+		add: 256,
+	};
+
+	let host = TestHost::new();
+
+	let _ret = host
+		.validate_candidate(
+			adder::wasm_binary_unwrap(),
+			ValidationParams {
+				parent_head: GenericHeadData(parent_head.encode()),
+				block_data: GenericBlockData(block_data.encode()),
+				relay_parent_number: 1,
+				relay_parent_storage_root: Default::default(),
+			},
+		)
+		.await
+		.unwrap_err();
+}
@@ -0,0 +1,152 @@
+// Copyright 2021 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+use polkadot_node_core_pvf::{Pvf, ValidationHost, start, Config, InvalidCandidate, ValidationError};
+use polkadot_parachain::{
+	primitives::{BlockData, ValidationParams, ValidationResult},
+};
+use parity_scale_codec::Encode as _;
+use async_std::sync::Mutex;
+
+mod adder;
+mod worker_common;
+
+const PUPPET_EXE: &str = env!("CARGO_BIN_EXE_puppet_worker");
+
+struct TestHost {
+	_cache_dir: tempfile::TempDir,
+	host: Mutex<ValidationHost>,
+}
+
+impl TestHost {
+	fn new() -> Self {
+		Self::new_with_config(|_| ())
+	}
+
+	fn new_with_config<F>(f: F) -> Self
+	where
+		F: FnOnce(&mut Config),
+	{
+		let cache_dir = tempfile::tempdir().unwrap();
+		let program_path = std::path::PathBuf::from(PUPPET_EXE);
+		let mut config = Config::new(cache_dir.path().to_owned(), program_path);
+		f(&mut config);
+		let (host, task) = start(config);
+		let _ = async_std::task::spawn(task);
+		Self {
+			_cache_dir: cache_dir,
+			host: Mutex::new(host),
+		}
+	}
+
+	async fn validate_candidate(
+		&self,
+		code: &[u8],
+		params: ValidationParams,
+	) -> Result<ValidationResult, ValidationError> {
+		let (result_tx, result_rx) = futures::channel::oneshot::channel();
+		self.host
+			.lock()
+			.await
+			.execute_pvf(
+				Pvf::from_code(code.to_vec()),
+				params.encode(),
+				polkadot_node_core_pvf::Priority::Normal,
+				result_tx,
+			)
+			.await
+			.unwrap();
+		result_rx.await.unwrap()
+	}
+}
+
+#[async_std::test]
+async fn terminates_on_timeout() {
+	let host = TestHost::new();
+
+	let result = host
+		.validate_candidate(
+			halt::wasm_binary_unwrap(),
+			ValidationParams {
+				block_data: BlockData(Vec::new()),
+				parent_head: Default::default(),
+				relay_parent_number: 1,
+				relay_parent_storage_root: Default::default(),
+			},
+		)
+		.await;
+
+	match result {
+		Err(ValidationError::InvalidCandidate(InvalidCandidate::HardTimeout)) => {}
+		r => panic!("{:?}", r),
+	}
+}
+
+#[async_std::test]
+async fn parallel_execution() {
+	let host = TestHost::new();
+	let execute_pvf_future_1 = host.validate_candidate(
+		halt::wasm_binary_unwrap(),
+		ValidationParams {
+			block_data: BlockData(Vec::new()),
+			parent_head: Default::default(),
+			relay_parent_number: 1,
+			relay_parent_storage_root: Default::default(),
+		},
+	);
+	let execute_pvf_future_2 = host.validate_candidate(
+		halt::wasm_binary_unwrap(),
+		ValidationParams {
+			block_data: BlockData(Vec::new()),
+			parent_head: Default::default(),
+			relay_parent_number: 1,
+			relay_parent_storage_root: Default::default(),
+		},
+	);
+
+	let start = std::time::Instant::now();
+	let (_, _) = futures::join!(execute_pvf_future_1, execute_pvf_future_2);
+
+	// total time should be < 2 x EXECUTION_TIMEOUT_SEC
+	const EXECUTION_TIMEOUT_SEC: u64 = 3;
+	assert!(
+		std::time::Instant::now().duration_since(start)
+			< std::time::Duration::from_secs(EXECUTION_TIMEOUT_SEC * 2)
+	);
+}
+
+#[async_std::test]
+async fn execute_queue_doesnt_stall_if_workers_died() {
+	let host = TestHost::new_with_config(|cfg| {
+		assert_eq!(cfg.execute_workers_max_num, 5);
+	});
+
+	// Here we spawn 8 validation jobs for the `halt` PVF and share those between 5 workers. The
+	// first five jobs should timeout and the workers killed. For the next 3 jobs a new batch of
+	// workers should be spun up.
+	futures::future::join_all((0u8..=8).map(|_| {
+		host.validate_candidate(
+			halt::wasm_binary_unwrap(),
+			ValidationParams {
+				block_data: BlockData(Vec::new()),
+				parent_head: Default::default(),
+				relay_parent_number: 1,
+				relay_parent_storage_root: Default::default(),
+			},
+		)
+	}))
+	.await;
+}
@@ -0,0 +1,43 @@
+// Copyright 2021 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Polkadot is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::PUPPET_EXE;
+use polkadot_node_core_pvf::testing::worker_common::{spawn_with_program_path, SpawnErr};
+use std::time::Duration;
+
+#[async_std::test]
+async fn spawn_timeout() {
+	let result = spawn_with_program_path(
+		"integration-test",
+		PUPPET_EXE,
+		&["sleep"],
+		Duration::from_secs(2),
+	)
+	.await;
+	assert!(matches!(result, Err(SpawnErr::AcceptTimeout)));
+}
+
+#[async_std::test]
+async fn should_connect() {
+	let _ = spawn_with_program_path(
+		"integration-test",
+		PUPPET_EXE,
+		&["prepare-worker"],
+		Duration::from_secs(2),
+	)
+	.await
+	.unwrap();
+}