      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

    // use std::sync::Arc;
    // use std::sync::atomic::AtomicBool;
    use std::ops::{Deref, DerefMut};
    use core::{self, OclPrm, ClWaitListPtr, ClNullEventPtr, MemMap as MemMapCore, Mem as MemCore, AsMem};
    use standard::{ClWaitListPtrEnum, ClNullEventPtrEnum, Event, EventList, Queue};
    use error::{Result as OclResult};

    /// An unmap command builder.
    ///
    /// [UNSTABLE]
    #[must_use = "commands do nothing unless enqueued"]
    #[derive(Debug)]
    pub struct MemUnmapCmd<'c, T> where T: 'c + OclPrm {
        queue: Option<&'c Queue>,
        mem_map: &'c mut MemMap<T>,
        ewait: Option<ClWaitListPtrEnum<'c>>,
        enew: Option<ClNullEventPtrEnum<'c>>,
    }

    impl<'c, T> MemUnmapCmd<'c, T> where T: OclPrm {
        /// Returns a new unmap command builder.
        fn new(mem_map: &'c mut MemMap<T>) -> MemUnmapCmd<'c, T>
        {
            MemUnmapCmd {
                queue: None,
                mem_map: mem_map,
                ewait: None,
                enew: None,
            }
        }

        /// Specifies a queue to use for this call only.
        pub fn queue<'q, Q>(mut self, queue: &'q Q) -> MemUnmapCmd<'c, T>
                where 'q: 'c, Q: 'q + AsRef<Queue> {
            self.queue = Some(queue.as_ref());
            self
        }

        /// Specifies an event or list of events to wait on before the command
        /// will run.
        ///
        /// When events generated using the `::enew` method of **other**,
        /// previously enqueued commands are passed here (either individually or
        /// as part of an [`EventList`]), this command will not execute until
        /// those commands have completed.
        ///
        /// Using events can compliment the use of queues to order commands by
        /// creating temporal dependencies between them (where commands in one
        /// queue must wait for the completion of commands in another). Events can
        /// also supplant queues altogether when, for example, using out-of-order
        /// queues.
        ///
        /// # Example
        ///
        /// ```rust,ignore
        /// // Create an event list:
        /// let mut event_list = EventList::new();
        /// // Enqueue a kernel on `queue_1`, creating an event representing the kernel
        /// // command in our list:
        /// kernel.cmd().queue(&queue_1).enew(&mut event_list).enq()?;
        /// // Map a buffer using `queue_2`, ensuring the read does not begin until
        /// // after the kernel command has completed:
        /// buffer.map().queue(&queue_2).ewait(&event_list).enq_async()?;
        /// ```
        ///
        /// [`EventList`]: struct.EventList.html
        pub fn ewait<Ewl>(mut self, ewait: Ewl) -> MemUnmapCmd<'c, T>
                where Ewl: Into<ClWaitListPtrEnum<'c>> {
            self.ewait = Some(ewait.into());
            self
        }

        /// Specifies the destination to store a new, optionally created event
        /// associated with this command.
        ///
        /// The destination can be a mutable reference to an empty event (created
        /// using [`Event::empty`]) or a mutable reference to an event list.
        ///
        /// After this command is enqueued, the event in the destination can be
        /// passed to the `::ewait` method of another command. Doing so will cause
        /// the other command to wait until this command has completed before
        /// executing.
        ///
        /// Using events can compliment the use of queues to order commands by
        /// creating temporal dependencies between them (where commands in one
        /// queue must wait for the completion of commands in another). Events can
        /// also supplant queues altogether when, for example, using out-of-order
        /// queues.
        ///
        /// # Example
        ///
        /// ```rust,ignore
        /// // Create an event list:
        /// let mut event = Event::empty();
        /// // Enqueue a kernel on `queue_1`, creating an event representing the kernel
        /// // command in our list:
        /// kernel.cmd().queue(&queue_1).enew(&mut event).enq()?;
        /// // Map a buffer using `queue_2`, ensuring the read does not begin until
        /// // after the kernel command has completed:
        /// buffer.map().queue(&queue_2).ewait(&event).enq_async()?;
        /// ```
        ///
        /// [`Event::empty`]: struct.Event.html#method.empty
        pub fn enew<En>(mut self, enew: En) -> MemUnmapCmd<'c, T>
                where En: Into<ClNullEventPtrEnum<'c>> {
            self.enew = Some(enew.into());
            self
        }

        /// Enqueues this command.
        ///
        pub fn enq(self) -> OclResult<()> {
            self.mem_map.enqueue_unmap(self.queue, self.ewait, self.enew)
        }
    }

    /// A view of memory mapped by `clEnqueueMap{...}`.
    ///
    ///
    /// [UNSTABLE]: Still in a state of flux: ~90% stable
    ///
    //
    // [NOTE]: Do not derive/impl `Clone`. Will not be thread safe without a mutex.
    //
    #[derive(Debug)]
    pub struct MemMap<T> where T: OclPrm {
        core: MemMapCore<T>,
        len: usize,
        buffer: MemCore,
        queue: Queue,
        unmap_wait_events: Option<EventList>,
        unmap_event: Option<Event>,
        is_unmapped: bool,
        // buffer_is_mapped: Arc<AtomicBool>
    }

    impl<T> MemMap<T>  where T: OclPrm {
        pub unsafe fn new(core: MemMapCore<T>, len: usize, unmap_wait_events: Option<EventList>,
                unmap_event: Option<Event>, buffer: MemCore, queue: Queue,
                /*buffer_is_mapped: Arc<AtomicBool>*/) -> MemMap<T> {
            MemMap {
                core: core,
                len: len,
                buffer: buffer,
                queue: queue,
                unmap_wait_events: unmap_wait_events,
                unmap_event: unmap_event,
                is_unmapped: false,
                // buffer_is_mapped,
            }
        }

        /// Returns an unmap command builder.
        ///
        /// Call `::enq` on it to enqueue the unmap command.
        pub fn unmap<'c>(&'c mut self) -> MemUnmapCmd<'c, T> {
            MemUnmapCmd::new(self)
        }

        /// Enqueues an unmap command for this memory object immediately.
        ///
        /// Prefer `::unmap` for a more stable interface as this function may
        /// change at any time.
        pub fn enqueue_unmap<Ewl, En>(&mut self, queue: Option<&Queue>, ewait_opt: Option<Ewl>,
                mut enew_opt: Option<En>) -> OclResult<()>
                where En: ClNullEventPtr, Ewl: ClWaitListPtr
        {
            if !self.is_unmapped {
                assert!(!(ewait_opt.is_some() && self.unmap_wait_events.is_some()),
                    "MemMap::enqueue_unmap: Cannot set an event wait list for the unmap command \
                    when the 'unmap_wait_events' has already been set.");

                let mut origin_event_opt = if self.unmap_event.is_some() || enew_opt.is_some() {
                    Some(Event::empty())
                } else {
                    None
                };

                core::enqueue_unmap_mem_object(queue.unwrap_or(&self.queue), &self.buffer,
                    &self.core, ewait_opt.and(self.unmap_wait_events.as_ref()), origin_event_opt.as_mut())?;

                self.is_unmapped = true;

                if let Some(origin_event) = origin_event_opt {
                    if let Some(ref mut enew) = enew_opt {
                        unsafe { enew.clone_from(&origin_event) }
                    }

                    if let Some(unmap_user_event) = self.unmap_event.take() {
                        #[cfg(not(feature = "async_block"))]
                        unsafe { origin_event.register_event_relay(unmap_user_event)?; }

                        #[cfg(feature = "async_block")]
                        origin_event.wait_for()?;
                        #[cfg(feature = "async_block")]
                        unmap_user_event.set_complete()?;
                    }
                }

                Ok(())
            } else {
                Err("ocl_core::- ::unmap: Already unmapped.".into())
            }
        }

        /// Returns a reference to the unmap target event if it has been set.
        pub fn unmap_event(&self) -> Option<&Event> {
            self.unmap_event.as_ref()
        }

        /// Returns a reference to the unmap wait event list if it has been set.
        pub fn unmap_wait_events(&self) -> Option<&EventList> {
            self.unmap_wait_events.as_ref()
        }

        /// Returns true if an unmap command has already been enqueued, causing
        /// the memory referenced by this `MemMap` to become invalid.
        #[inline] pub fn is_unmapped(&self) -> bool { self.is_unmapped }

        /// Returns a pointer to the host mapped memory.
        #[inline] pub fn as_ptr(&self) -> *const T { self.core.as_ptr() }

        /// Returns a mutable pointer to the host mapped memory.
        #[inline] pub fn as_mut_ptr(&mut self) -> *mut T { self.core.as_mut_ptr() }

        /// Returns a reference to the internal core command queue.
        #[inline] pub fn queue(&self) -> &Queue { &self.queue }
    }

    impl<T> Deref for MemMap<T> where T: OclPrm {
        type Target = [T];

        fn deref(&self) -> &[T] {
            assert!(!self.is_unmapped, "Mapped memory has been unmapped and cannot be accessed.");
            unsafe { self.core.as_slice(self.len) }
        }
    }

    impl<T> DerefMut for MemMap<T> where T: OclPrm {
        fn deref_mut(&mut self) -> &mut [T] {
            assert!(!self.is_unmapped, "Mapped memory has been unmapped and cannot be accessed.");
            unsafe { self.core.as_slice_mut(self.len) }
        }
    }

    impl<T: OclPrm> Drop for MemMap<T> {
        fn drop(&mut self) {
            if !self.is_unmapped {
                self.enqueue_unmap::<&Event, &mut Event>(None, None, None).ok();
            }
        }
    }

    impl<T: OclPrm> AsMem<T> for MemMap<T> {
        fn as_mem(&self) -> &MemCore {
            self.core.as_mem()
        }
    }

    // impl<'a, T: OclPrm> AsMem for &'a mut MemMap<T> {
    //     fn as_mem(&self) -> &MemCore {
    //         self.core.as_mem()
    //     }
    // }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)