1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
use futures::task::AtomicWaker;
use std::marker::PhantomData;
use std::ops::DerefMut;
use std::sync::atomic::AtomicBool;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use std::sync::Mutex;
use std::task::Context;
use std::task::Poll;
type UnsendTask = Box<dyn FnOnce(&mut v8::HandleScope) + 'static>;
type SendTask = Box<dyn FnOnce(&mut v8::HandleScope) + Send + 'static>;
static_assertions::assert_not_impl_any!(V8TaskSpawnerFactory: Send);
static_assertions::assert_not_impl_any!(V8TaskSpawner: Send);
static_assertions::assert_impl_all!(V8CrossThreadTaskSpawner: Send);
/// The [`V8TaskSpawnerFactory`] must be created on the same thread as the thread that runs tasks.
///
/// This factory is not [`Send`] because it may contain `!Send` tasks submitted by a
/// [`V8CrossThreadTaskSpawner`]. It is only safe to send this object to another thread if you plan on
/// submitting [`Send`] tasks to it, which is what [`V8CrossThreadTaskSpawner`] does.
#[derive(Default)]
pub(crate) struct V8TaskSpawnerFactory {
// TODO(mmastrac): ideally we wouldn't box if we could use arena allocation and a max submission size
// TODO(mmastrac): we may want to split the Send and !Send tasks
/// The set of tasks, non-empty if `has_tasks` is set.
tasks: Mutex<Vec<SendTask>>,
/// A flag we can poll without any locks.
has_tasks: AtomicBool,
/// The polled waker, woken on task submission.
waker: AtomicWaker,
/// Mark as `!Send`. See note above.
_unsend_marker: PhantomData<*const ()>,
}
impl V8TaskSpawnerFactory {
pub fn new_same_thread_spawner(self: Arc<Self>) -> V8TaskSpawner {
V8TaskSpawner {
tasks: self,
_unsend_marker: PhantomData,
}
}
pub fn new_cross_thread_spawner(self: Arc<Self>) -> V8CrossThreadTaskSpawner {
V8CrossThreadTaskSpawner { tasks: self }
}
/// `false` guarantees that there are no queued tasks, while `true` means that it is likely (but not guaranteed)
/// that tasks exist.
///
/// Calls should prefer using the waker, but this is left while we rework the event loop.
pub fn has_pending_tasks(&self) -> bool {
// Ensure that all reads after this point happen-after we load from the atomic
self.has_tasks.load(Ordering::Acquire)
}
/// Poll this set of tasks, returning a non-empty set of tasks if there have
/// been any queued, or registering the waker if not.
pub fn poll_inner(&self, cx: &mut Context) -> Poll<Vec<UnsendTask>> {
// Check the flag first -- if it's false we definitely have no tasks. AcqRel semantics ensure
// that this read happens-before the vector read below, and that any writes happen-after the success
// case.
if self
.has_tasks
.compare_exchange(true, false, Ordering::AcqRel, Ordering::Acquire)
.is_err()
{
self.waker.register(cx.waker());
return Poll::Pending;
}
let mut lock = self.tasks.lock().unwrap();
let tasks = std::mem::take(lock.deref_mut());
if tasks.is_empty() {
// Unlikely race lost -- the task submission to the queue and flag are not atomic, so it's
// possible we ended up with an extra poll here. This only shows up under Miri, but as it is
// possible we do need to handle it.
self.waker.register(cx.waker());
return Poll::Pending;
}
// SAFETY: we are removing the Send trait as we return the tasks here to prevent
// these tasks from accidentally leaking to another thread.
let tasks = unsafe { std::mem::transmute(tasks) };
Poll::Ready(tasks)
}
fn spawn(&self, task: SendTask) {
self.tasks.lock().unwrap().push(task);
// TODO(mmastrac): can we skip the mutex here?
// Release ordering means that the writes in the above lock happen-before the atomic store
self.has_tasks.store(true, Ordering::Release);
self.waker.wake();
}
}
/// Allows for submission of v8 tasks on the same thread.
#[derive(Clone)]
pub struct V8TaskSpawner {
// TODO(mmastrac): can we split the waker into a send and !send one?
tasks: Arc<V8TaskSpawnerFactory>,
_unsend_marker: PhantomData<*const ()>,
}
impl V8TaskSpawner {
/// Spawn a task that runs within the [`crate::JsRuntime`] event loop from the same thread
/// that the runtime is running on. This function is re-entrant-safe and may be called from
/// ops, from outside of a [`v8::HandleScope`] in a plain `async`` task, or even from within
/// another, previously-spawned task.
///
/// The task is handed off to be run the next time the event loop is polled, and there are
/// no guarantees as to when this may happen.
///
/// # Safety
///
/// The task shares the same [`v8::HandleScope`] as the core event loop, which means that it
/// must maintain the scope in a valid state to avoid corrupting or destroying the runtime.
///
/// For example, if the code called by this task can raise an exception, the task must ensure
/// that it calls that code within a new [`v8::TryCatch`] to avoid the exception leaking to the
/// event loop's [`v8::HandleScope`].
pub fn spawn<F>(&self, f: F)
where
F: FnOnce(&mut v8::HandleScope) + 'static,
{
let task: Box<dyn FnOnce(&mut v8::HandleScope<'_>)> = Box::new(f);
// SAFETY: we are transmuting Send into a !Send handle but we guarantee this object will never
// leave the current thread because `V8TaskSpawner` is !Send.
let task: Box<dyn FnOnce(&mut v8::HandleScope<'_>) + Send> =
unsafe { std::mem::transmute(task) };
self.tasks.spawn(task)
}
}
/// Allows for submission of v8 tasks on any thread.
#[derive(Clone)]
pub struct V8CrossThreadTaskSpawner {
tasks: Arc<V8TaskSpawnerFactory>,
}
// SAFETY: the underlying V8TaskSpawnerFactory is not Send, but we always submit Send tasks
// to it from this spawner.
unsafe impl Send for V8CrossThreadTaskSpawner {}
impl V8CrossThreadTaskSpawner {
/// Spawn a task that runs within the [`crate::JsRuntime`] event loop, potentially (but not
/// required to be) from a different thread than the runtime is running on.
///
/// The task is handed off to be run the next time the event loop is polled, and there are
/// no guarantees as to when this may happen.
///
/// # Safety
///
/// The task shares the same [`v8::HandleScope`] as the core event loop, which means that it
/// must maintain the scope in a valid state to avoid corrupting or destroying the runtime.
///
/// For example, if the code called by this task can raise an exception, the task must ensure
/// that it calls that code within a new [`v8::TryCatch`] to avoid the exception leaking to the
/// event loop's [`v8::HandleScope`].
pub fn spawn<F>(&self, f: F)
where
F: FnOnce(&mut v8::HandleScope) + Send + 'static,
{
self.tasks.spawn(Box::new(f))
}
/// Spawn a task that runs within the [`crate::JsRuntime`] event loop from a different thread
/// than the runtime is running on.
///
/// This function will deadlock if called from the same thread as the [`crate::JsRuntime`], and
/// there are no checks for this case.
///
/// As this function blocks until the task has run to completion (or panics/deadlocks), it is
/// safe to borrow data from the local environment and use it within the closure.
///
/// The task is handed off to be run the next time the event loop is polled, and there are
/// no guarantees as to when this may happen, however the function will not return until the
/// task has been fully run to completion.
///
/// # Safety
///
/// The task shares the same [`v8::HandleScope`] as the core event loop, which means that it
/// must maintain the scope in a valid state to avoid corrupting or destroying the runtime.
///
/// For example, if the code called by this task can raise an exception, the task must ensure
/// that it calls that code within a new [`v8::TryCatch`] to avoid the exception leaking to the
/// event loop's [`v8::HandleScope`].
pub fn spawn_blocking<'a, F, T>(&self, f: F) -> T
where
F: FnOnce(&mut v8::HandleScope) -> T + Send + 'a,
T: Send + 'a,
{
let (tx, rx) = std::sync::mpsc::sync_channel(0);
let task: Box<dyn FnOnce(&mut v8::HandleScope<'_>) + Send> =
Box::new(|scope| {
let r = f(scope);
_ = tx.send(r);
});
// SAFETY: We can safely transmute to the 'static lifetime because we guarantee this method will either
// complete fully by the time it returns, deadlock or panic.
let task: SendTask = unsafe { std::mem::transmute(task) };
self.tasks.spawn(task);
rx.recv().unwrap()
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::future::poll_fn;
use tokio::task::LocalSet;
// https://github.com/tokio-rs/tokio/issues/6155
#[test]
#[cfg(not(all(miri, target_os = "linux")))]
fn test_spawner_serial() {
let runtime = tokio::runtime::Builder::new_multi_thread()
.worker_threads(1)
.build()
.unwrap();
runtime.block_on(async {
let factory = Arc::<V8TaskSpawnerFactory>::default();
let cross_thread_spawner = factory.clone().new_cross_thread_spawner();
let local_set = LocalSet::new();
const COUNT: usize = 1000;
let task = runtime.spawn(async move {
for _ in 0..COUNT {
cross_thread_spawner.spawn(|_| {});
}
});
local_set.spawn_local(async move {
let mut count = 0;
loop {
count += poll_fn(|cx| factory.poll_inner(cx)).await.len();
if count >= COUNT {
break;
}
}
});
local_set.await;
_ = task.await;
});
}
// https://github.com/tokio-rs/tokio/issues/6155
#[test]
#[cfg(not(all(miri, target_os = "linux")))]
fn test_spawner_parallel() {
let runtime = tokio::runtime::Builder::new_multi_thread()
.worker_threads(1)
.build()
.unwrap();
runtime.block_on(async {
let factory = Arc::<V8TaskSpawnerFactory>::default();
let cross_thread_spawner = factory.clone().new_cross_thread_spawner();
let local_set = LocalSet::new();
const COUNT: usize = 100;
let mut tasks = vec![];
for _ in 0..COUNT {
let cross_thread_spawner = cross_thread_spawner.clone();
tasks.push(runtime.spawn(async move {
cross_thread_spawner.spawn(|_| {});
}));
}
local_set.spawn_local(async move {
let mut count = 0;
loop {
count += poll_fn(|cx| factory.poll_inner(cx)).await.len();
if count >= COUNT {
break;
}
}
});
local_set.await;
for task in tasks.drain(..) {
_ = task.await;
}
});
}
}