summaryrefslogtreecommitdiff
path: root/core/task.rs
diff options
context:
space:
mode:
authorMatt Mastracci <matthew@mastracci.com>2023-05-14 15:40:01 -0600
committerGitHub <noreply@github.com>2023-05-14 15:40:01 -0600
commit9845361153f35f6a68a82eb3a13845fddbeab026 (patch)
tree307b58f09cac9e681255dac74f487f8da70d76d2 /core/task.rs
parentb99159bf14d15418a7dbb22e9ce78b15d52971cc (diff)
refactor(core): bake single-thread assumptions into spawn/spawn_blocking (#19056)
Partially supersedes #19016. This migrates `spawn` and `spawn_blocking` to `deno_core`, and removes the requirement for `spawn` tasks to be `Send` given our single-threaded executor. While we don't need to technically do anything w/`spawn_blocking`, this allows us to have a single `JoinHandle` type that works for both cases, and allows us to more easily experiment with alternative `spawn_blocking` implementations that do not require tokio (ie: rayon). Async ops (+~35%): Before: ``` time 1310 ms rate 763358 time 1267 ms rate 789265 time 1259 ms rate 794281 time 1266 ms rate 789889 ``` After: ``` time 956 ms rate 1046025 time 954 ms rate 1048218 time 924 ms rate 1082251 time 920 ms rate 1086956 ``` HTTP serve (+~4.4%): Before: ``` Running 10s test @ http://localhost:4500 2 threads and 10 connections Thread Stats Avg Stdev Max +/- Stdev Latency 68.78us 19.77us 1.43ms 86.84% Req/Sec 68.78k 5.00k 73.84k 91.58% 1381833 requests in 10.10s, 167.36MB read Requests/sec: 136823.29 Transfer/sec: 16.57MB ``` After: ``` Running 10s test @ http://localhost:4500 2 threads and 10 connections Thread Stats Avg Stdev Max +/- Stdev Latency 63.12us 17.43us 1.11ms 85.13% Req/Sec 71.82k 3.71k 77.02k 79.21% 1443195 requests in 10.10s, 174.79MB read Requests/sec: 142921.99 Transfer/sec: 17.31MB ``` Suggested-By: alice@ryhl.io Co-authored-by: Bartek IwaƄczuk <biwanczuk@gmail.com>
Diffstat (limited to 'core/task.rs')
-rw-r--r--core/task.rs131
1 files changed, 131 insertions, 0 deletions
diff --git a/core/task.rs b/core/task.rs
new file mode 100644
index 000000000..46a4c8c26
--- /dev/null
+++ b/core/task.rs
@@ -0,0 +1,131 @@
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+use core::pin::Pin;
+use core::task::Context;
+use core::task::Poll;
+use futures::Future;
+use std::marker::PhantomData;
+use tokio::runtime::Handle;
+use tokio::runtime::RuntimeFlavor;
+
+/// Equivalent to [`tokio::task::JoinHandle`].
+#[repr(transparent)]
+pub struct JoinHandle<R> {
+ handle: tokio::task::JoinHandle<MaskResultAsSend<R>>,
+ _r: PhantomData<R>,
+}
+
+impl<R> JoinHandle<R> {
+ /// Equivalent to [`tokio::task::JoinHandle::abort`].
+ pub fn abort(&self) {
+ self.handle.abort()
+ }
+}
+
+impl<R> Future for JoinHandle<R> {
+ type Output = Result<R, tokio::task::JoinError>;
+
+ fn poll(
+ self: Pin<&mut Self>,
+ cx: &mut std::task::Context<'_>,
+ ) -> std::task::Poll<Self::Output> {
+ // SAFETY: We are sure that handle is valid here
+ unsafe {
+ let me: &mut Self = Pin::into_inner_unchecked(self);
+ let handle = Pin::new_unchecked(&mut me.handle);
+ match handle.poll(cx) {
+ Poll::Pending => Poll::Pending,
+ Poll::Ready(Ok(r)) => Poll::Ready(Ok(r.into_inner())),
+ Poll::Ready(Err(e)) => Poll::Ready(Err(e)),
+ }
+ }
+ }
+}
+
+/// Equivalent to [`tokio::task::spawn`], but does not require the future to be [`Send`]. Must only be
+/// used on a [`RuntimeFlavor::CurrentThread`] executor, though this is only checked when running with
+/// debug assertions.
+pub fn spawn<F: Future<Output = R> + 'static, R: 'static>(
+ f: F,
+) -> JoinHandle<R> {
+ debug_assert!(
+ Handle::current().runtime_flavor() == RuntimeFlavor::CurrentThread
+ );
+ // SAFETY: we know this is a current-thread executor
+ let future = unsafe { MaskFutureAsSend::new(f) };
+ JoinHandle {
+ handle: tokio::task::spawn(future),
+ _r: Default::default(),
+ }
+}
+
+/// Equivalent to [`tokio::task::spawn_blocking`]. Currently a thin wrapper around the tokio API, but this
+/// may change in the future.
+pub fn spawn_blocking<
+ F: (FnOnce() -> R) + Send + 'static,
+ R: Send + 'static,
+>(
+ f: F,
+) -> JoinHandle<R> {
+ let handle = tokio::task::spawn_blocking(|| MaskResultAsSend { result: f() });
+ JoinHandle {
+ handle,
+ _r: Default::default(),
+ }
+}
+
+#[repr(transparent)]
+#[doc(hidden)]
+pub struct MaskResultAsSend<R> {
+ result: R,
+}
+
+/// SAFETY: We ensure that Send bounds are only faked when tokio is running on a current-thread executor
+unsafe impl<R> Send for MaskResultAsSend<R> {}
+
+impl<R> MaskResultAsSend<R> {
+ #[inline(always)]
+ pub fn into_inner(self) -> R {
+ self.result
+ }
+}
+
+pub struct MaskFutureAsSend<F> {
+ future: F,
+}
+
+impl<F> MaskFutureAsSend<F> {
+ /// Mark a non-`Send` future as `Send`. This is a trick to be able to use
+ /// `tokio::spawn()` (which requires `Send` futures) in a current thread
+ /// runtime.
+ ///
+ /// # Safety
+ ///
+ /// You must ensure that the future is actually used on the same
+ /// thread, ie. always use current thread runtime flavor from Tokio.
+ pub unsafe fn new(future: F) -> Self {
+ Self { future }
+ }
+}
+
+// SAFETY: we are cheating here - this struct is NOT really Send,
+// but we need to mark it Send so that we can use `spawn()` in Tokio.
+unsafe impl<F> Send for MaskFutureAsSend<F> {}
+
+impl<F: Future> Future for MaskFutureAsSend<F> {
+ type Output = MaskResultAsSend<F::Output>;
+
+ fn poll(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<MaskResultAsSend<F::Output>> {
+ // SAFETY: We are sure that future is valid here
+ unsafe {
+ let me: &mut MaskFutureAsSend<F> = Pin::into_inner_unchecked(self);
+ let future = Pin::new_unchecked(&mut me.future);
+ match future.poll(cx) {
+ Poll::Pending => Poll::Pending,
+ Poll::Ready(result) => Poll::Ready(MaskResultAsSend { result }),
+ }
+ }
+ }
+}