Runtime worker threads (#7089)

* std variant * principal work * format and naming * format and naming continued * working nested fork * add comment * naming and tabs * line width * fix wording * address review * refactor dynamic dispatch * update wasmtime * some care * move ext * more refactor * doc effort * simplify * doc effort * tests and docs * address review * naming * explain some args * add example * unwinding for native and tests * rename stray * fix refs * fix tests * fix warnings * stray naming * fixes and comments * Update primitives/io/src/tasks.rs Co-authored-by: cheme <emericchevalier.pro@gmail.com> * make examples "compile" * dyn_dispatch -> spawn_call * fix impl * address review * Update primitives/io/src/lib.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update primitives/io/src/tasks.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update primitives/io/src/async_externalities.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update primitives/io/src/tasks.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update frame/example-parallel/src/lib.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * fix compilation * Update client/executor/common/src/wasm_runtime.rs Co-authored-by: Sergei Shulepov <sergei@parity.io> * address review * Update client/executor/wasmtime/src/instance_wrapper.rs Co-authored-by: Sergei Shulepov <sergei@parity.io> * Update client/executor/src/native_executor.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update primitives/io/src/tasks.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/executor/src/native_executor.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update primitives/io/src/tasks.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update client/executor/wasmtime/src/instance_wrapper.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * address some issues * address more issues * wasm_only interface * define sp_tasks * avoid anyhow * fix example Co-authored-by: cheme <emericchevalier.pro@gmail.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Sergei Shulepov <sergei@parity.io> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2026-04-27 02:17:58 +00:00 · 2020-10-20 05:41:51 -07:00
parent 203acda659
commit a062bc2f1d
26 changed files with 1498 additions and 112 deletions
@@ -0,0 +1,215 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
+
+// This program 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.
+
+// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
+
+//! Async externalities.
+
+use std::any::{TypeId, Any};
+use sp_core::{
+	storage::{ChildInfo, TrackedStorageKey},
+	traits::{Externalities, SpawnNamed, TaskExecutorExt, RuntimeSpawnExt, RuntimeSpawn},
+};
+use sp_externalities::{Extensions, ExternalitiesExt as _};
+
+/// Simple state-less externalities for use in async context.
+///
+/// Will panic if anything is accessing the storage.
+#[derive(Debug)]
+pub struct AsyncExternalities {
+	extensions: Extensions,
+}
+
+/// New Async externalities.
+pub fn new_async_externalities(scheduler: Box<dyn SpawnNamed>) -> Result<AsyncExternalities, &'static str> {
+	let mut res = AsyncExternalities { extensions: Default::default() };
+	let mut ext = &mut res as &mut dyn Externalities;
+	ext.register_extension::<TaskExecutorExt>(TaskExecutorExt(scheduler.clone()))
+		.map_err(|_| "Failed to register task executor extension.")?;
+
+	Ok(res)
+}
+
+impl AsyncExternalities {
+	/// Extend async externalities with the ability to spawn wasm instances.
+	pub fn with_runtime_spawn(
+		mut self,
+		runtime_ext: Box<dyn RuntimeSpawn>,
+	) -> Result<Self, &'static str> {
+		let mut ext = &mut self as &mut dyn Externalities;
+		ext.register_extension::<RuntimeSpawnExt>(RuntimeSpawnExt(runtime_ext))
+			.map_err(|_| "Failed to register task executor extension.")?;
+
+		Ok(self)
+	}
+}
+
+type StorageKey = Vec<u8>;
+
+type StorageValue = Vec<u8>;
+
+impl Externalities for AsyncExternalities {
+	fn set_offchain_storage(&mut self, _key: &[u8], _value: Option<&[u8]>) {
+		panic!("`set_offchain_storage`: should not be used in async externalities!")
+	}
+
+	fn storage(&self, _key: &[u8]) -> Option<StorageValue> {
+		panic!("`storage`: should not be used in async externalities!")
+	}
+
+	fn storage_hash(&self, _key: &[u8]) -> Option<Vec<u8>> {
+		panic!("`storage_hash`: should not be used in async externalities!")
+	}
+
+	fn child_storage(
+		&self,
+		_child_info: &ChildInfo,
+		_key: &[u8],
+	) -> Option<StorageValue> {
+		panic!("`child_storage`: should not be used in async externalities!")
+	}
+
+	fn child_storage_hash(
+		&self,
+		_child_info: &ChildInfo,
+		_key: &[u8],
+	) -> Option<Vec<u8>> {
+		panic!("`child_storage_hash`: should not be used in async externalities!")
+	}
+
+	fn next_storage_key(&self, _key: &[u8]) -> Option<StorageKey> {
+		panic!("`next_storage_key`: should not be used in async externalities!")
+	}
+
+	fn next_child_storage_key(
+		&self,
+		_child_info: &ChildInfo,
+		_key: &[u8],
+	) -> Option<StorageKey> {
+		panic!("`next_child_storage_key`: should not be used in async externalities!")
+	}
+
+	fn place_storage(&mut self, _key: StorageKey, _maybe_value: Option<StorageValue>) {
+		panic!("`place_storage`: should not be used in async externalities!")
+	}
+
+	fn place_child_storage(
+		&mut self,
+		_child_info: &ChildInfo,
+		_key: StorageKey,
+		_value: Option<StorageValue>,
+	) {
+		panic!("`place_child_storage`: should not be used in async externalities!")
+	}
+
+	fn kill_child_storage(
+		&mut self,
+		_child_info: &ChildInfo,
+	) {
+		panic!("`kill_child_storage`: should not be used in async externalities!")
+	}
+
+	fn clear_prefix(&mut self, _prefix: &[u8]) {
+		panic!("`clear_prefix`: should not be used in async externalities!")
+	}
+
+	fn clear_child_prefix(
+		&mut self,
+		_child_info: &ChildInfo,
+		_prefix: &[u8],
+	) {
+		panic!("`clear_child_prefix`: should not be used in async externalities!")
+	}
+
+	fn storage_append(
+		&mut self,
+		_key: Vec<u8>,
+		_value: Vec<u8>,
+	) {
+		panic!("`storage_append`: should not be used in async externalities!")
+	}
+
+	fn chain_id(&self) -> u64 { 42 }
+
+	fn storage_root(&mut self) -> Vec<u8> {
+		panic!("`storage_root`: should not be used in async externalities!")
+	}
+
+	fn child_storage_root(
+		&mut self,
+		_child_info: &ChildInfo,
+	) -> Vec<u8> {
+		panic!("`child_storage_root`: should not be used in async externalities!")
+	}
+
+	fn storage_changes_root(&mut self, _parent: &[u8]) -> Result<Option<Vec<u8>>, ()> {
+		panic!("`storage_changes_root`: should not be used in async externalities!")
+	}
+
+	fn storage_start_transaction(&mut self) {
+		unimplemented!("Transactions are not supported by AsyncExternalities");
+	}
+
+	fn storage_rollback_transaction(&mut self) -> Result<(), ()> {
+		unimplemented!("Transactions are not supported by AsyncExternalities");
+	}
+
+	fn storage_commit_transaction(&mut self) -> Result<(), ()> {
+		unimplemented!("Transactions are not supported by AsyncExternalities");
+	}
+
+	fn wipe(&mut self) {}
+
+	fn commit(&mut self) {}
+
+	fn read_write_count(&self) -> (u32, u32, u32, u32) {
+		unimplemented!("read_write_count is not supported in AsyncExternalities")
+	}
+
+	fn reset_read_write_count(&mut self) {
+		unimplemented!("reset_read_write_count is not supported in AsyncExternalities")
+	}
+
+	fn get_whitelist(&self) -> Vec<TrackedStorageKey> {
+		unimplemented!("get_whitelist is not supported in AsyncExternalities")
+	}
+
+	fn set_whitelist(&mut self, _: Vec<TrackedStorageKey>) {
+		unimplemented!("set_whitelist is not supported in AsyncExternalities")
+	}
+}
+
+impl sp_externalities::ExtensionStore for AsyncExternalities {
+	fn extension_by_type_id(&mut self, type_id: TypeId) -> Option<&mut dyn Any> {
+		self.extensions.get_mut(type_id)
+	}
+
+	fn register_extension_with_type_id(
+		&mut self,
+		type_id: TypeId,
+		extension: Box<dyn sp_externalities::Extension>,
+	) -> Result<(), sp_externalities::Error> {
+		self.extensions.register_with_type_id(type_id, extension)
+	}
+
+	fn deregister_extension_by_type_id(&mut self, type_id: TypeId) -> Result<(), sp_externalities::Error> {
+		if self.extensions.deregister(type_id) {
+			Ok(())
+		} else {
+			Err(sp_externalities::Error::ExtensionIsNotRegistered(type_id))
+		}
+	}
+}