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 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
use super::{Context, Global};
use crate::{
event::{
consumer::{Consumer, Noop, NoopEvent, PhantomEvent},
EventStatus,
},
prelude::{Error, Event, RawCommandQueue, RawEvent, Result},
thinfn::ThinFn,
};
use blaze_proc::docfg;
use opencl_sys::CL_SUCCESS;
use std::{
marker::PhantomData,
panic::{catch_unwind, resume_unwind, AssertUnwindSafe},
sync::{
atomic::{AtomicI32, AtomicUsize, Ordering},
Arc,
},
};
#[derive(Clone)]
enum ScopeWaker {
Thread(std::thread::Thread),
#[cfg(feature = "futures")]
Flag(Arc<::futures::task::AtomicWaker>),
}
impl ScopeWaker {
#[inline(always)]
pub fn wake(&self) {
match self {
Self::Thread(x) => x.unpark(),
#[cfg(feature = "futures")]
Self::Flag(x) => x.wake(),
}
}
}
struct ScopeData {
items: AtomicUsize,
err: AtomicI32,
}
/// A scope to enqueue events in.\
/// See [`scope`] and [`local_scope`]
pub struct Scope<'scope, 'env: 'scope, C: 'env + Context = Global> {
ctx: &'env C,
data: Arc<ScopeData>,
thread: ScopeWaker,
scope: PhantomData<&'scope mut &'scope ()>,
env: PhantomData<&'env mut &'env ()>,
}
impl<'scope, 'env: 'scope, C: 'env + Context> Scope<'scope, 'env, C> {
/// Creates a new [`Event`] scope targeted to `async` use
#[docfg(feature = "futures")]
#[inline(always)]
pub unsafe fn new_async(ctx: &'env C) -> Self {
Self::with_waker(ctx, Arc::new(futures::task::AtomicWaker::new()))
}
/// Creates a new `async` [`Event`] scope with the specified waker
#[docfg(feature = "futures")]
#[inline(always)]
fn with_waker(ctx: &'env C, waker: Arc<futures::task::AtomicWaker>) -> Self {
Self {
ctx,
data: Arc::new(ScopeData {
items: AtomicUsize::new(0),
err: AtomicI32::new(CL_SUCCESS),
}),
thread: ScopeWaker::Flag(waker),
scope: PhantomData,
env: PhantomData,
}
}
/// Enqueues a new event within the scope.
pub fn enqueue<E: FnOnce(&'env RawCommandQueue) -> Result<RawEvent>, F: 'scope + Consumer>(
&'scope self,
supplier: E,
consumer: F,
) -> Result<Event<F>> {
let queue = self.ctx.next_queue();
let inner = supplier(&queue)?;
let evt = Event::new(inner, consumer);
if self.data.items.fetch_add(1, Ordering::AcqRel) == usize::MAX {
panic!("too many items in scope")
}
if queue.size.fetch_add(1, Ordering::AcqRel) == usize::MAX {
panic!("Queue size overflow");
}
let queue_size = queue.size.clone();
let scope_data = self.data.clone();
let scope_thread = self.thread.clone();
let res = evt.on_complete_silent(move |_, res| {
let _ = queue_size.fetch_sub(1, Ordering::AcqRel);
if let Err(e) = res {
let _ = scope_data.err.compare_exchange(
CL_SUCCESS,
e.ty.as_i32(),
Ordering::AcqRel,
Ordering::Acquire,
);
}
Self::reduce_items(&scope_data, &scope_thread)
});
if let Err(e) = res {
queue.size.fetch_sub(1, Ordering::AcqRel);
return Err(e);
}
return Ok(evt);
}
/// Enqueues a new [`NoopEvent`] within the scope.
#[inline(always)]
pub fn enqueue_noop<E: FnOnce(&'env RawCommandQueue) -> Result<RawEvent>>(
&'scope self,
supplier: E,
) -> Result<NoopEvent> {
self.enqueue(supplier, Noop)
}
/// Enqueues a new [`NoopEvent`] within the scope.
#[inline(always)]
pub fn enqueue_phantom<T: 'scope, E: FnOnce(&'env RawCommandQueue) -> Result<RawEvent>>(
&'scope self,
supplier: E,
) -> Result<PhantomEvent<T>> {
self.enqueue(supplier, PhantomData)
}
/// Adds a callback function that will be executed when the event reaches the specified status.
pub(crate) fn on_status<
T: 'scope + Send,
F: 'scope + Send + FnOnce(RawEvent, Result<EventStatus>) -> T,
Cn: Consumer,
>(
&'scope self,
evt: &'env Event<Cn>,
status: EventStatus,
f: F,
) -> Result<crate::event::ScopedCallbackHandle<'scope, T>> {
let (send, recv) = std::sync::mpsc::sync_channel::<_>(1);
#[cfg(any(feature = "cl1_1", feature = "futures"))]
let cb_data = std::sync::Arc::new(crate::event::CallbackHandleData {
#[cfg(feature = "cl1_1")]
flag: once_cell::sync::OnceCell::new(),
#[cfg(feature = "futures")]
waker: futures::task::AtomicWaker::new(),
});
if self.data.items.fetch_add(1, Ordering::AcqRel) == usize::MAX {
panic!("too many items in scope")
}
let my_data = self.data.clone();
let my_thread = self.thread.clone();
#[cfg(any(feature = "cl1_1", feature = "futures"))]
let my_cb_data = cb_data.clone();
let f = move |evt, status: Result<EventStatus>| {
let f = std::panic::AssertUnwindSafe(|| f(evt, status.clone()));
match send.send(std::panic::catch_unwind(f)) {
Ok(_) => {
#[cfg(feature = "cl1_1")]
if let Some(flag) = my_cb_data.flag.get_or_init(|| None) {
flag.try_mark(status.err().map(|x| x.ty)).unwrap();
}
#[cfg(feature = "futures")]
my_cb_data.waker.wake();
}
Err(_) => {}
}
Self::reduce_items(&my_data, &my_thread)
};
let r#fn = ThinFn::<dyn 'scope + Send + FnOnce(RawEvent, Result<EventStatus>)>::new_once(f);
let user_data = ThinFn::into_raw(r#fn);
unsafe {
if let Err(e) =
evt.on_status_raw(status, crate::event::event_listener, user_data.cast())
{
let _ =
ThinFn::<dyn 'scope + Send + FnOnce(RawEvent, Result<EventStatus>)>::from_raw(
user_data,
); // drop user data
Self::reduce_items(&self.data, &self.thread);
return Err(e);
}
tri!(opencl_sys::clRetainEvent(evt.id()));
}
return Ok(crate::event::ScopedCallbackHandle {
recv,
#[cfg(any(feature = "cl1_1", feature = "futures"))]
data: cb_data,
phtm: PhantomData,
});
}
#[inline]
fn reduce_items(scope_data: &ScopeData, scope_thread: &ScopeWaker) {
if scope_data.items.fetch_sub(1, Ordering::AcqRel) == 1 {
scope_thread.wake();
}
}
}
/// Creates a new scope with the global context to enqueue events in.
/// All events that haven't completed by the end of the function will be automatically awaitad before the function returns.
#[inline(always)]
pub fn scope<'env, T, F: for<'scope> FnOnce(&'scope Scope<'scope, 'env>) -> Result<T>>(
f: F,
) -> Result<T> {
local_scope(Global::get(), f)
}
/// Creates a new scope with the specified context to enqueue events in.
/// All events that haven't completed by the end of the function will be automatically joined before the function returns.
pub fn local_scope<
'env,
T,
C: 'env + Context,
F: for<'scope> FnOnce(&'scope Scope<'scope, 'env, C>) -> Result<T>,
>(
ctx: &'env C,
f: F,
) -> Result<T> {
let data = ScopeData {
items: AtomicUsize::new(0),
err: AtomicI32::new(CL_SUCCESS),
};
let scope = Scope {
ctx,
data: Arc::new(data),
thread: ScopeWaker::Thread(std::thread::current()),
scope: PhantomData,
env: PhantomData,
};
// Run `f`, but catch panics so we can make sure to wait for all the threads to join.
let result = catch_unwind(AssertUnwindSafe(|| f(&scope)));
// Wait until all the events are finished.
while scope.data.items.load(Ordering::Acquire) != 0 {
std::thread::park();
}
// Throw any panic from `f`, or the return value of `f`.
return match result {
Err(e) => resume_unwind(e),
Ok(x) => {
let e = scope.data.err.load(Ordering::Acquire);
if e != CL_SUCCESS {
return Err(Error::from(e));
}
x
}
};
}
cfg_if::cfg_if! {
if #[cfg(feature = "futures")] {
use futures::Future;
use std::task::Poll;
enum AsyncScopeFuture<T, Fut> {
Future (futures::future::CatchUnwind<AssertUnwindSafe<Fut>>),
Panic (Box<dyn std::any::Any + Send>),
Value (Result<T>),
Ended
}
#[doc(hidden)]
pub struct InnerAsyncScope<'scope, 'env: 'scope, T, Fut: 'scope + Future<Output = Result<T>>, C: 'env + Context> {
scope: &'scope Scope<'scope, 'env, C>,
fut: AsyncScopeFuture<T, Fut>,
_pin: std::marker::PhantomPinned
}
impl<'scope, 'env: 'scope, T, Fut: 'scope + Future<Output = Result<T>>, C: 'env + Context> InnerAsyncScope<'scope, 'env, T, Fut, C> {
pub unsafe fn new<F: FnOnce(&'scope Scope<'scope, 'env, C>) -> Fut> (scope: &'scope Scope<'scope, 'env, C>, f: F) -> Self {
let fut = match catch_unwind(AssertUnwindSafe(|| f(scope))) {
Ok(f) => AsyncScopeFuture::Future(futures::FutureExt::catch_unwind(AssertUnwindSafe(f))),
Err(e) => AsyncScopeFuture::Panic(e)
};
return Self { scope, fut, _pin: std::marker::PhantomPinned };
}
#[inline(always)]
fn get_waker (&self) -> &futures::task::AtomicWaker {
match self.scope.thread {
ScopeWaker::Flag(ref x) => x,
_ => unsafe { std::hint::unreachable_unchecked() }
}
}
}
impl<'scope, 'env, T, Fut: 'scope + Future<Output = Result<T>>, C: 'env + Context> Future for InnerAsyncScope<'scope, 'env, T, Fut, C> {
type Output = Result<T>;
fn poll(self: std::pin::Pin<&mut Self>, cx: &mut std::task::Context<'_>) -> std::task::Poll<Self::Output> {
let this = unsafe {
self.get_unchecked_mut()
};
// Wait future
if let AsyncScopeFuture::Future(ref mut fut) = this.fut {
// Safety: Self is `!Unpin` and has already been pinned, so it cannot move
match unsafe { std::pin::Pin::new_unchecked(fut).poll(cx) } {
Poll::Ready(Ok(x)) => this.fut = AsyncScopeFuture::Value(x),
Poll::Ready(Err(e)) => this.fut = AsyncScopeFuture::Panic(e),
Poll::Pending => return Poll::Pending
}
}
// Sleep
this.get_waker().register(cx.waker());
if this.scope.data.items.load(Ordering::Acquire) != 0 {
return std::task::Poll::Pending;
}
// Complete
match core::mem::replace(&mut this.fut, AsyncScopeFuture::Ended) {
AsyncScopeFuture::Panic(e) => resume_unwind(e),
AsyncScopeFuture::Value(x) => {
let e = this.scope.data.err.load(Ordering::Relaxed);
if e == CL_SUCCESS {
return std::task::Poll::Ready(x)
}
return std::task::Poll::Ready(Err(Error::from(e)));
},
AsyncScopeFuture::Ended => panic!("Scope already finished"),
#[cfg(debug_assertions)]
AsyncScopeFuture::Future(_) => unreachable!(),
#[cfg(not(debug_assertions))]
AsyncScopeFuture::Future(_) => unsafe { std::hint::unreachable_unchecked() }
}
}
}
impl<'scope, 'env, T, Fut: Future<Output = Result<T>>, C: 'env + Context> Drop for InnerAsyncScope<'scope, 'env, T, Fut, C> {
#[inline]
fn drop(&mut self) {
// Await already-started events, without starting new ones.
let thread = unsafe {
std::mem::transmute::<_, *const ()>(std::thread::current())
};
let waker = std::task::RawWaker::new(thread, &TABLE);
let waker = unsafe { std::task::Waker::from_raw(waker) };
loop {
self.get_waker().register(&waker);
if self.scope.data.items.load(Ordering::Acquire) == 0 { break }
std::thread::park();
}
}
}
/// Creates a new scope for spawining scoped events.
///
/// The [`scope_async`](crate::scope_async) macro allows for the creation of `async` scopes, returning a [`Future`](std::future::Future)
/// that completes when all the events spawned inside the scope have completed.
///
/// ```rust
/// use blaze_rs::{buffer, scope_async, prelude::*};
/// use futures::future::*;
///
/// #[global_context]
/// static CONTEXT : SimpleContext = SimpleContext::default();
///
/// # async fn foo () -> Result<()> {
/// let buffer = buffer![1, 2, 3, 4, 5]?;
///
/// let (left, right) = scope_async!(|s| async {
/// let left = buffer.read(s, ..2, None)?.join_async()?;
/// let right = buffer.read(s, ..2, None)?.join_async()?;
/// return tokio::try_join!(left, right);
/// }).await?;
///
/// assert_eq!(left, vec![1, 2]);
/// assert_eq!(right, vec![3, 4, 5]);
/// # Ok(())
/// # }
/// ```
///
/// This macro can be called with the same form as [`scope`] or [`local_scope`].
///
/// ```rust
/// use blaze_rs::{scope_async, prelude::*};
///
/// #[global_context]
/// static CONTEXT : SimpleContext = SimpleContext::default();
///
/// # async fn foo () -> Result<()> {
/// let ctx = SimpleContext::default()?;
/// let buffer = Buffer::new_in(ctx, &[1, 2, 3, 4, 5], MemAccess::default(), false)?;
///
/// let (left, right) = scope_async!(buffer.context(), |s| async {
/// let left = buffer.read(s, ..2, None)?.join_async()?;
/// let right = buffer.read(s, ..2, None)?.join_async()?;
/// return tokio::try_join!(left, right);
/// }).await?;
///
/// assert_eq!(left, vec![1, 2]);
/// assert_eq!(right, vec![3, 4, 5]);
/// # Ok(())
/// # }
/// ```
///
/// Unlike it's [blocking](local_scope) counterpart, [`scope_async`](crate::scope_async) does **not** ensure that all events inside the future
/// will be ran. Rather, if the future is dropped before completion, it's destructor will block the current thread until every **already-started** event has completed,
/// and discarting the remaining uninitialized events.
///
/// ```rust
/// use blaze_rs::{prelude::*, buffer, scope_async};
/// use futures::{task::*, future::*};
///
/// #[global_context]
/// static CONTEXT : SimpleContext = SimpleContext::default();
///
/// # async fn foo () -> Result<()> {
/// let buffer = buffer![1, 2, 3, 4, 5]?;
///
/// let mut scope = Box::pin(scope_async!(|s| async {
/// let left = buffer.read(s, ..2, None)?.inspect(|_| println!("Left done!")).join_async()?.await;
/// let right = buffer.read(s, ..2, None)?.inspect(|_| println!("Right done!")).join_async()?.await;
/// return Ok((left, right));
/// }));
///
/// let mut ctx = std::task::Context::from_waker(noop_waker_ref());
/// let _ = scope.poll_unpin(&mut ctx)?;
/// drop(scope); // prints "Left done!", doesn't print "Right done!"
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! scope_async {
($f:expr) => {
$crate::scope_async!($crate::context::Global::get(), $f)
};
($ctx:expr, $f:expr) => {
async {
let scope = unsafe { $crate::context::Scope::new_async($ctx) };
unsafe {
$crate::context::InnerAsyncScope::new(&scope, $f).await
}
}
};
}
static TABLE : std::task::RawWakerVTable = std::task::RawWakerVTable::new(clone_waker, wake, wake_by_ref, drop_waker);
unsafe fn clone_waker (ptr: *const ()) -> std::task::RawWaker {
let thread = std::mem::ManuallyDrop::new(std::mem::transmute::<_, std::thread::Thread>(ptr));
let ptr = std::mem::transmute(std::thread::Thread::clone(&thread));
return std::task::RawWaker::new(ptr, &TABLE);
}
unsafe fn wake (ptr: *const ()) {
let thread = std::mem::transmute::<_, std::thread::Thread>(ptr);
thread.unpark();
}
unsafe fn wake_by_ref (ptr: *const ()) {
let thread = std::mem::ManuallyDrop::new(std::mem::transmute::<_, std::thread::Thread>(ptr));
thread.unpark();
}
unsafe fn drop_waker (ptr: *const ()) {
let _ = std::mem::transmute::<_, std::thread::Thread>(ptr);
}
}
}