Merge pull request #62 from elftausend/custom-cache-type

Cargo.toml

@@ -51,7 +51,7 @@ min-cl = { git = "https://github.com/elftausend/min-cl", optional = true }
 # min-cl = { version = "0.3.0", optional=true }
 
 [features]
-default = ["cpu", "opencl", "blas", "static-api", "stack", "macro", "untyped", "autograd", "autograd", "cached", "lazy", "fork", "graph", "serde"]
+default = ["cpu", "opencl", "blas", "static-api", "stack", "macro", "untyped", "autograd", "autograd", "cached", "lazy", "fork", "graph", "serde", "cuda"]
 # default = ["cpu"]
 # default = ["no-std"]
 # default = ["opencl"]

src/buffer/num.rs

@@ -183,7 +183,7 @@ impl<'a, T: Unit> Buffer<'a, T, ()> {
     {
         &self.data.num
     }
- 
+
     /// Used if the `Buffer` contains only a single value.
     /// By derefencing this `Buffer`, you obtain this value as well (which is probably preferred).
     ///

src/cache/owned_cache.rs

@@ -1,170 +1,22 @@
-use core::{any::Any, hash::BuildHasherDefault};
-use std::{collections::HashMap, sync::Arc};
+mod fast_cache;
+pub use fast_cache::*;
 
-use crate::{
-    flag::AllocFlag, Alloc, Cursor, Device, NoHasher, PtrType, ShallowCopy, Shape, UniqueId, Unit,
-};
+mod length_cache;
+pub use length_cache::*;
 
-#[derive(Clone)]
-pub struct Cache {
-    pub nodes: HashMap<UniqueId, Arc<dyn Any>, BuildHasherDefault<NoHasher>>,
-}
-
-impl Default for Cache {
-    #[inline]
-    fn default() -> Self {
-        Self::new()
-    }
-}
-
-impl Cache {
-    #[inline]
-    pub fn new() -> Self {
-        Self {
-            nodes: Default::default(),
-        }
-    }
+use crate::{Alloc, ShallowCopy, Shape, UniqueId, Unit};
 
-    /// # Safety
-    /// Lifetime of data must be at least as long as the lifetime of the cache (usually the device).
-    #[track_caller]
-    #[inline]
-    pub unsafe fn get<T, S, D>(
+pub trait Cache {
+    unsafe fn get<T, S, D>(
         &mut self,
         device: &D,
+        id: UniqueId,
         len: usize,
-        new_buf_callback: impl FnMut(usize, &D::Base<T, S>),
+        new_buf_callback: impl FnMut(UniqueId, &D::Base<T, S>),
     ) -> D::Base<T, S>
     where
         T: Unit,
-        D: Alloc<T> + Cursor + 'static,
-        D::Base<T, S>: ShallowCopy + 'static,
-        S: Shape,
-    {
-        let maybe_allocated = self.nodes.get(&(device.cursor() as UniqueId));
-        match maybe_allocated {
-            Some(data) => {
-                unsafe { device.bump_cursor() };
-                let data = unsafe {
-                    data.downcast_ref::<D::Base<T, S>>()
-                        .expect("Invalid request for data type!")
-                        .shallow()
-                };
-
-                // TODO: not necessary, could add length to hashmap
-                assert_eq!(data.size(), len, "Data size mismatch! Did you use e.g. if conditions in a (cursor) loop retrieving buffers with a different size?");
-                data
-            }
-            None => self.add_node(device, len, new_buf_callback),
-        }
-    }
-
-    #[track_caller]
-    fn add_node<T, S, D>(
-        &mut self,
-        device: &D,
-        len: usize,
-        mut callback: impl FnMut(usize, &D::Base<T, S>),
-    ) -> <D as Device>::Base<T, S>
-    where
-        T: Unit,
-        D: Alloc<T> + Cursor,
+        D: Alloc<T> + 'static,
         D::Base<T, S>: ShallowCopy + 'static,
-        S: Shape,
-    {
-        let data = device.alloc::<S>(len, AllocFlag::None).unwrap();
-        let shallow_data = unsafe { data.shallow() };
-
-        callback(device.cursor(), &shallow_data);
-        self.nodes
-            .insert(device.cursor() as UniqueId, Arc::new(data));
-        unsafe { device.bump_cursor() };
-
-        shallow_data
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    #[cfg(feature = "cpu")]
-    use super::Cache;
-    #[cfg(feature = "cpu")]
-    use crate::{Base, Cached, CPU};
-
-    #[cfg(feature = "cpu")]
-    #[test]
-    fn test_cache_add_node() {
-        let mut cache = Cache::default();
-        let device = CPU::<Cached<Base>>::new();
-
-        assert_eq!(cache.nodes.len(), 0);
-
-        let out = cache.add_node::<f32, (), _>(&device, 10, |_a, _b| ());
-
-        assert_eq!(cache.nodes.len(), 1);
-        assert_eq!(out.len, 10);
-
-        let out1 = unsafe { cache.get::<f32, (), _>(&device, 10, |_a, _b| ()) };
-        assert_ne!(out.ptr, out1.ptr);
-    }
-
-    #[cfg(feature = "cpu")]
-    #[test]
-    #[cfg_attr(miri, ignore)]
-    fn test_cache_get_reuse_based_on_location() {
-        use crate::Cursor;
-
-        let mut cache = Cache::default();
-        let device = CPU::<Base>::new();
-
-        let mut prev = None;
-        for _ in device.range(0..1000) {
-            let out3 = unsafe { cache.get::<f32, (), _>(&device, 10, |_a, _b| ()) };
-            if prev.is_none() {
-                prev = Some(out3.ptr);
-            }
-            assert_eq!(prev.unwrap(), out3.ptr);
-            assert_eq!(cache.nodes.len(), 1);
-            prev = Some(out3.ptr);
-        }
-        assert_eq!(cache.nodes.len(), 1);
-    }
-
-    #[cfg(feature = "cpu")]
-    #[test]
-    #[should_panic]
-    fn test_cache_with_diffrent_length_return() {
-        use crate::{Buffer, Cursor, Retriever, Base};
-
-        let dev = CPU::<Cached<Base>>::new();
-
-        for i in dev.range(10) {
-            if i == 4 {
-                // has assert inside, therefore, this line leads to a crash due tue mismatiching lengths
-                let buf: Buffer<u8, _> = dev.retrieve(5, ()).unwrap();
-                assert_eq!(buf.len, 5);
-            } else {
-                let _x: Buffer<u8, _> = dev.retrieve(3, ()).unwrap();
-            }
-        }
-    }
-
-    #[cfg(feature = "cpu")]
-    #[test]
-    fn test_cache_with_cursor_range_overlap() {
-        use crate::{Buffer, Cursor, Retriever, Base};
-
-        let dev = CPU::<Cached<Base>>::new();
-
-        for _i in dev.range(10) {
-            let _x: Buffer<u8, _> = dev.retrieve(3, ()).unwrap();
-        }
-
-        assert_eq!(dev.cursor(), 1);
-
-        for _i in dev.range(1..7) {
-            let _x: Buffer<u8, _> = dev.retrieve(4, ()).unwrap();
-        }
-        assert_eq!(dev.cursor(), 2);
-    }
+        S: Shape;
 }

src/cache/owned_cache/fast_cache.rs

@@ -0,0 +1,186 @@
+use core::{any::Any, hash::BuildHasherDefault};
+use std::{collections::HashMap, sync::Arc};
+
+use crate::{
+    flag::AllocFlag, Alloc, Cache, Device, NoHasher, PtrType, ShallowCopy, Shape, UniqueId, Unit,
+};
+
+#[derive(Clone)]
+pub struct FastCache {
+    pub nodes: HashMap<UniqueId, Arc<dyn Any>, BuildHasherDefault<NoHasher>>,
+}
+
+impl Default for FastCache {
+    #[inline]
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl Cache for FastCache {
+    #[inline]
+    unsafe fn get<T, S, D>(
+        &mut self,
+        device: &D,
+        id: UniqueId,
+        len: usize,
+        new_buf_callback: impl FnMut(UniqueId, &D::Base<T, S>),
+    ) -> D::Base<T, S>
+    where
+        T: Unit,
+        D: Alloc<T> + 'static,
+        D::Base<T, S>: ShallowCopy + 'static,
+        S: Shape,
+    {
+        self.get(device, id, len, new_buf_callback)
+    }
+}
+
+impl FastCache {
+    #[inline]
+    pub fn new() -> Self {
+        Self {
+            nodes: Default::default(),
+        }
+    }
+
+    /// # Safety
+    /// Lifetime of data must be at least as long as the lifetime of the cache (usually the device).
+    #[inline]
+    pub unsafe fn get<T, S, D>(
+        &mut self,
+        device: &D,
+        id: UniqueId,
+        len: usize,
+        new_buf_callback: impl FnMut(UniqueId, &D::Base<T, S>),
+    ) -> D::Base<T, S>
+    where
+        T: Unit,
+        D: Alloc<T> + 'static,
+        D::Base<T, S>: ShallowCopy + 'static,
+        S: Shape,
+    {
+        let maybe_allocated = self.nodes.get(&id);
+        match maybe_allocated {
+            Some(data) => {
+                let data = unsafe {
+                    data.downcast_ref::<D::Base<T, S>>()
+                        .expect("Invalid request for data type!")
+                        .shallow()
+                };
+
+                // TODO: not necessary, could add length to hashmap
+                assert_eq!(data.size(), len, "Data size mismatch! Did you use e.g. if conditions in a (cursor) loop retrieving buffers with a different size?");
+                data
+            }
+            None => unsafe { self.add_node(device, id, len, new_buf_callback) },
+        }
+    }
+
+    unsafe fn add_node<T, S, D>(
+        &mut self,
+        device: &D,
+        id: UniqueId,
+        len: usize,
+        mut callback: impl FnMut(UniqueId, &D::Base<T, S>),
+    ) -> <D as Device>::Base<T, S>
+    where
+        T: Unit,
+        D: Alloc<T>,
+        D::Base<T, S>: ShallowCopy + 'static,
+        S: Shape,
+    {
+        let data = device.alloc::<S>(len, AllocFlag::None).unwrap();
+        let shallow_data = unsafe { data.shallow() };
+
+        callback(id, &shallow_data);
+        self.nodes.insert(id, Arc::new(data));
+
+        shallow_data
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    #[cfg(feature = "cpu")]
+    use super::FastCache;
+    #[cfg(feature = "cpu")]
+    use crate::{Base, Cached, CPU};
+
+    #[cfg(feature = "cpu")]
+    #[test]
+    fn test_cache_add_node() {
+        let mut cache = FastCache::default();
+        let device = CPU::<Cached<Base>>::new();
+
+        assert_eq!(cache.nodes.len(), 0);
+
+        let out = unsafe { cache.add_node::<f32, (), _>(&device, 0, 10, |_a, _b| ()) };
+
+        assert_eq!(cache.nodes.len(), 1);
+        assert_eq!(out.len, 10);
+
+        let out1 = unsafe { cache.get::<f32, (), _>(&device, 1, 10, |_a, _b| ()) };
+        assert_ne!(out.ptr, out1.ptr);
+    }
+
+    #[cfg(feature = "cpu")]
+    #[test]
+    #[cfg_attr(miri, ignore)]
+    fn test_cache_get_reuse_based_on_location() {
+        use crate::Cursor;
+
+        let mut cache = FastCache::default();
+        let device = CPU::<Base>::new();
+
+        let mut prev = None;
+        for _ in device.range(0..1000) {
+            let out3 = unsafe { cache.get::<f32, (), _>(&device, 0, 10, |_a, _b| ()) };
+            if prev.is_none() {
+                prev = Some(out3.ptr);
+            }
+            assert_eq!(prev.unwrap(), out3.ptr);
+            assert_eq!(cache.nodes.len(), 1);
+            prev = Some(out3.ptr);
+        }
+        assert_eq!(cache.nodes.len(), 1);
+    }
+
+    #[cfg(feature = "cpu")]
+    #[test]
+    #[should_panic]
+    fn test_cache_with_diffrent_length_return() {
+        use crate::{Base, Buffer, Cursor, Retriever};
+
+        let dev = CPU::<Cached<Base>>::new();
+
+        for i in dev.range(10) {
+            if i == 4 {
+                // has assert inside, therefore, this line leads to a crash due tue mismatiching lengths
+                let buf: Buffer<u8, _> = dev.retrieve(5, ()).unwrap();
+                assert_eq!(buf.len, 5);
+            } else {
+                let _x: Buffer<u8, _> = dev.retrieve(3, ()).unwrap();
+            }
+        }
+    }
+
+    #[cfg(feature = "cpu")]
+    #[test]
+    fn test_cache_with_cursor_range_overlap() {
+        use crate::{Base, Buffer, Cursor, Retriever};
+
+        let dev = CPU::<Cached<Base>>::new();
+
+        for _i in dev.range(10) {
+            let _x: Buffer<u8, _> = dev.retrieve(3, ()).unwrap();
+        }
+
+        assert_eq!(dev.cursor(), 1);
+
+        for _i in dev.range(1..7) {
+            let _x: Buffer<u8, _> = dev.retrieve(4, ()).unwrap();
+        }
+        assert_eq!(dev.cursor(), 2);
+    }
+}