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
// use std::sync::Arc;
// use std::sync::atomic::AtomicBool;
use crate::core::{ClNullEventPtr, Mem, MemMap as MemMapCore, OclPrm};
use crate::error::{Error as OclError, Result as OclResult};
use crate::r#async::MemMap;
use crate::{Event, EventList, Queue};
use futures::{Async, Future, Poll};
/// A future which resolves to a `MemMap` as soon as its creating command
/// completes.
///
/// [UNSTABLE]: This type's methods may be renamed or otherwise changed at any time.
#[must_use = "futures do nothing unless polled"]
#[derive(Debug)]
pub struct FutureMemMap<T: OclPrm> {
core: Option<MemMapCore<T>>,
len: usize,
map_event: Event,
unmap_wait_events: Option<EventList>,
unmap_event: Option<Event>,
buffer: Option<Mem>,
queue: Option<Queue>,
callback_is_set: bool,
// buffer_is_mapped: Option<Arc<AtomicBool>>,
}
impl<T: OclPrm> FutureMemMap<T> {
/// Returns a new `FutureMemMap`.
pub unsafe fn new(
core: MemMapCore<T>,
len: usize,
map_event: Event,
buffer: Mem,
queue: Queue,
/*buffer_is_mapped: Arc<AtomicBool>*/
) -> FutureMemMap<T> {
FutureMemMap {
core: Some(core),
len,
map_event,
unmap_wait_events: None,
unmap_event: None,
buffer: Some(buffer),
queue: Some(queue),
callback_is_set: false,
// buffer_is_mapped: Some(buffer_is_mapped),
}
}
/// Set an event wait list for the unmap command.
///
/// Setting a wait list here will disallow any wait list from being set
/// later if/when calling unmap manually.
///
/// [UNSTABLE]: This method may be renamed or otherwise changed.
pub fn set_unmap_wait_events<El>(&mut self, wait_events: El)
where
El: Into<EventList>,
{
self.unmap_wait_events = Some(wait_events.into())
}
/// Set an event wait list for the unmap command.
///
/// See `::set_unmap_wait_events`.
pub fn ewait_unmap<L: Into<EventList>>(mut self, wait_events: L) -> FutureMemMap<T> {
self.set_unmap_wait_events(wait_events);
self
}
/// Create an event which will be triggered (set complete) after this
/// future resolves into a `MemMap` **and** after that `MemMap` is dropped
/// or manually unmapped.
///
/// The returned event can be added to the wait list of subsequent OpenCL
/// commands with the expectation that when all preceeding futures are
/// complete, the event will automatically be 'triggered' by having its
/// status set to complete, causing those commands to execute. This can be
/// used to inject host side code in amongst OpenCL commands without
/// thread blocking or extra delays of any kind.
///
/// [UNSTABLE]: This method may be renamed or otherwise changed.
pub fn create_unmap_event(&mut self) -> OclResult<&mut Event> {
if let Some(ref queue) = self.queue {
let uev = Event::user(&queue.context())?;
self.unmap_event = Some(uev);
Ok(self.unmap_event.as_mut().unwrap())
} else {
Err("FutureMemMap::create_unmap_event: No queue found!".into())
}
}
/// Specifies an event which will be triggered (set complete) after this
/// future resolves into a `MemMap` **and** after that `MemMap` is dropped
/// or manually unmapped.
///
/// See `::create_unmap_event`.
pub fn enew_unmap<En>(mut self, mut enew: En) -> FutureMemMap<T>
where
En: ClNullEventPtr,
{
{
let unmap_event = self.create_unmap_event().expect("FutureMemMap::enew_unmap");
unsafe {
enew.clone_from(unmap_event);
}
}
self
}
/// Specifies the queue to be used for the unmap command.
pub fn set_unmap_queue(&mut self, queue: Queue) {
self.queue = Some(queue)
}
/// Specifies the queue to be used for the unmap command.
pub fn with_unmap_queue(mut self, queue: Queue) -> FutureMemMap<T> {
self.set_unmap_queue(queue);
self
}
/// Returns the unmap event if it has been created.
///
/// [UNSTABLE]: This method may be renamed or otherwise changed.
#[inline]
pub fn unmap_event(&self) -> Option<&Event> {
self.unmap_event.as_ref()
}
/// Blocks the current thread until the OpenCL command is complete and an
/// appropriate lock can be obtained on the underlying data.
pub fn wait(self) -> OclResult<MemMap<T>> {
<Self as Future>::wait(self)
}
/// Resolves this `FutureMemMap` into a `MemMap`.
fn to_mapped_mem(&mut self) -> OclResult<MemMap<T>> {
match (self.core.take(), self.buffer.take(), self.queue.take()) {
(Some(core), Some(buffer), Some(queue)) => {
// TODO: Add `buffer_is_mapped` to list of joined stuff.
unsafe {
Ok(MemMap::new(
core,
self.len,
self.unmap_wait_events.take(),
self.unmap_event.take(),
buffer,
queue,
/*self.buffer_is_mapped.take().unwrap()*/
))
}
}
_ => Err("FutureMemMap::create_unmap_event: No queue and/or buffer found!".into()),
}
}
}
#[cfg(not(feature = "async_block"))]
impl<T> Future for FutureMemMap<T>
where
T: OclPrm + 'static,
{
type Item = MemMap<T>;
type Error = OclError;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
// println!("Polling FutureMemMap...");
match self.map_event.is_complete() {
Ok(true) => self.to_mapped_mem().map(|mm| Async::Ready(mm)),
Ok(false) => {
if !self.callback_is_set {
self.map_event.set_unpark_callback()?;
self.callback_is_set = true;
}
Ok(Async::NotReady)
}
Err(err) => Err(err.into()),
}
}
}
/// Blocking implementation.
#[cfg(feature = "async_block")]
impl<T: OclPrm> Future for FutureMemMap<T> {
type Item = MemMap<T>;
type Error = OclError;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
// println!("Polling FutureMemMap...");
let _ = self.callback_is_set;
self.map_event.wait_for()?;
self.to_mapped_mem().map(|mm| Async::Ready(mm))
}
}
unsafe impl<T: OclPrm> Send for FutureMemMap<T> {}
unsafe impl<T: OclPrm> Sync for FutureMemMap<T> {}