Started buffer: `(tx, rx)` memory buffer.

Added future support for paged ring-buffers (mod page) (TODO: not started impl yet.)

Fortune for mapped-file's current commit: Small blessing − 小吉

src/ext.rs

@@ -0,0 +1,87 @@
+//! Extensions
+use super::*;
+use std::{
+    ops,
+    borrow::{
+	Borrow, BorrowMut
+    },
+};
+
+/// Defer an expression call
+macro_rules! defer {
+    (move => $expr:expr) => {
+	$crate::ext::Deferred(move || {
+	    $expr
+	})
+    };
+    (ref => $expr:expr) => {
+        $crate::ext::Deferred(|| {
+	    $expr
+	})
+    };
+    (move $value:expr => $expr:expr)  => {
+	$crate::ext::DeferredDrop($value, move |a| {
+	    $expr(a)
+	})
+    };
+    (ref $value:expr => $expr:expr)  => {
+	$crate::ext::DeferredDrop($value, |a| {
+	    $expr(a)
+	})
+    };
+}
+pub(crate) use defer;
+
+/// Defer calling `F` until the destructor is ran
+pub struct Deferred<F: ?Sized +  FnOnce() -> ()>(F);
+
+/// Defer dropping this value until the container is dropped. The function `F` will be called on the value at drop time.
+pub struct DeferredDrop<T, F: ?Sized + FnOnce(T) -> ()>(T,F);
+
+impl<F: ?Sized+ FnOnce() -> ()> ops::Drop for Deferred<F>
+{
+    #[inline] 
+    fn drop(&mut self) {
+	self.0();
+    }
+}
+
+impl<T, F: ?Sized+ FnOnce(T) -> ()> ops::Drop for DeferredDrop<T, F>
+{
+    #[inline] 
+    fn drop(&mut self) {
+	self.1(self.0);
+    }
+}
+
+impl<T, F: ?Sized + FnOnce(T) -> ()> ops::DerefMut for DeferredDrop<T,F>
+{
+    #[inline] 
+    fn deref_mut(&mut self) -> &mut Self::Target {
+	&mut self.0
+    }
+}
+impl<T, F: ?Sized + FnOnce(T) -> ()> ops::Deref for DeferredDrop<T,F>
+{
+    type Target = T;
+    #[inline] 
+    fn deref(&self) -> &Self::Target {
+	&self.0
+    }
+}
+
+impl<T, F: ?Sized + FnOnce(T) -> ()> Borrow<T> for DeferredDrop<T,F>
+{
+    #[inline(always)] 
+    fn borrow(&self) -> &T {
+	&self.0
+    }
+}
+
+impl<T, F: ?Sized + FnOnce(T) -> ()> BorrowMut<T> for DeferredDrop<T,F>
+{
+    #[inline(always)] 
+    fn borrow_mut(&mut self) -> &mut T {
+	&mut self.0
+    }
+}

src/lib.rs

@@ -25,10 +25,16 @@ use std::{
 mod ffi;
 use ffi::c_try;
 
+
 pub mod hugetlb;
 #[cfg(feature="file")]
 pub mod file;
 
+pub mod ring; //TODO
+use ring::buffer;
+
+mod ext; use ext::*;
+
 use hugetlb::{
     HugePage,
     MapHugeFlag,
@@ -69,6 +75,12 @@ pub struct MappedFile<T>
     file: T,
     map: MappedSlice,
 }
+#[inline(never)]
+#[cold]
+fn _panic_invalid_address() -> !
+{
+    panic!("Invalid/unsupported address returned from mmap()")
+}
 
 impl<T: AsRawFd> MappedFile<T> {
     /// Map the file `file` to `len` bytes with memory protection as provided by `perm`, and mapping flags provided by `flags`.
@@ -83,12 +95,7 @@ impl<T: AsRawFd> MappedFile<T> {
     /// If `mmap()` succeeds, but returns an invalid address (e.g. 0)
     pub fn try_new(file: T, len: usize, perm: Perm, flags: impl flags::MapFlags) -> Result<Self, TryNewError<T>>
     {
-	#[inline(never)]
-	#[cold]
-        fn _panic_invalid_address() -> !
-        {
-            panic!("Invalid/unsupported address returned from mmap()")
-        }
+	
 	const NULL: *mut libc::c_void = ptr::null_mut();
         let fd = file.as_raw_fd();
         let slice = match unsafe {
@@ -111,6 +118,76 @@ impl<T: AsRawFd> MappedFile<T> {
             map: MappedSlice(slice)
         })
     }
+
+    /// Returns a dual mapping `(tx, rx)`, into the same file.
+    ///
+    /// # Note
+    /// `len` **must** be a multiple of the used page size (or hugepage size, if `flags` is set to use one) for this to work.
+    pub fn try_new_buffer<B: buffer::TwoBufferProvider<T>>(file: T, len: usize, rings: impl Into<Option<std::num::NonZeroUsize>>, allow_unsafe_writes: bool, flags: impl flags::MapFlags) -> Result<(MappedFile<B>, MappedFile<B>), TryNewError<T>>
+    {
+	const NULL: *mut libc::c_void = ptr::null_mut();
+	use std::{
+	    //rc::Rc,
+	    cell::RefCell,
+	};
+
+	let mut defer_set = {
+	    let mut defer_set: Vec<(*mut u8, usize)> = Vec::new();
+	    defer!(ref defer_set => |set: Vec<(*mut u8, usize)>| {
+		for (ptr, len) in set {
+		    unsafe {
+			libc::munmap(ptr as *mut _, len);
+		    }
+		}
+	    });
+	    defer_set
+	};
+	
+	macro_rules! try_map {
+	    ($($tt:tt)*) => {
+		match unsafe {
+		    mmap($($tt)*)
+		} {
+		    MAP_FAILED => return Err(TryNewError::wrap_last_error(file)),
+		    NULL => _panic_invalid_address(),
+		    ptr => unsafe {
+			defer_set.push((ptr as *mut u8, len));
+			
+			UniqueSlice {
+			    mem: NonNull::new_unchecked(ptr as *mut u8),
+			    end: match NonNull::new((ptr as *mut u8).add(len)) {
+				Some(n) => n,
+				_ => _panic_invalid_address(),
+			    }
+			}
+		    }
+		}
+	    };
+	}
+	let (prot_r, prot_w) = if allow_unsafe_writes {
+	    let p = Perm::ReadWrite.get_prot();
+	    (p, p)
+	} else {
+	    (Perm::Writeonly.get_prot(), Perm::Readonly.get_prot())
+	};
+	match rings.into() {
+	    None => {
+		// No rings, just create two mappings at same addr.
+		let flags = flags.get_mmap_flags();
+		let tm = try_map!(NULL, len, prot_w, flags, file.as_raw_fd(), 0); 
+		let wm = try_map!(tm.mem.as_ptr() as *mut _, len, prot_r, flags | libc::MAP_FIXED, file.as_raw_fd(), 0);
+		//TODO... How to create the first `A?rc` over `file`?
+	    },
+	    Some(pages) => {
+		// Create anon mapping
+		try_map!(NULL, len, libc::PROT_NONE, flags.get_mmap_flags() | libc::MAP_ANONYMOUS, file.as_raw_fd(), 0);
+	    }
+	    
+	}
+
+	// Must happen at the end, so that maps dont get defer free'd
+	defer_set.clear();
+    }
     
     /// Map the file `file` to `len` bytes with memory protection as provided by `perm`, and
     /// mapping flags provided by `flags`.
@@ -140,8 +217,8 @@ impl<T: AsRawFd> MappedFile<T> {
         match unsafe {
 	    msync(self.map.0.as_mut_ptr() as *mut _, self.map.0.len(), flush.get_ms())
 	} {
-            0 => Ok(()),
-            _ => Err(io::Error::last_os_error())
+	    0 => Ok(()),
+	    _ => Err(io::Error::last_os_error())
         }
     }
 
@@ -188,14 +265,14 @@ impl<T> MappedFile<T> {
     pub fn advise(&mut self, adv: Advice, needed: Option<bool>) -> io::Result<()>
     {
         use libc::{
-            madvise,
-            MADV_WILLNEED,
-            MADV_DONTNEED
+	    madvise,
+	    MADV_WILLNEED,
+	    MADV_DONTNEED
         };
         let (addr, len) = self.raw_parts();
         match unsafe { madvise(addr as *mut _, len, adv.get_madv() | needed.map(|n| n.then(|| MADV_WILLNEED).unwrap_or(MADV_DONTNEED)).unwrap_or(0)) } {
-            0 => Ok(()),
-            _ => Err(io::Error::last_os_error())
+	    0 => Ok(()),
+	    _ => Err(io::Error::last_os_error())
         }
     }
 
@@ -207,7 +284,7 @@ impl<T> MappedFile<T> {
     pub fn try_with_advice(mut self, adv: Advice, needed: Option<bool>) -> Result<Self, TryNewError<Self>>
     {
         match self.advise(adv, needed) {
-            Ok(_) => Ok(self),
+	    Ok(_) => Ok(self),
 	    Err(error) => Err(TryNewError {
 		error: Box::new(error),
 		value: self,
@@ -237,8 +314,8 @@ impl<T> MappedFile<T> {
     {
         let MappedFile{ file, map } = self;
         (MappedFile {
-            file: other,
-            map
+	    file: other,
+	    map
         }, file)
     }
 

src/ring.rs

@@ -0,0 +1,6 @@
+//! `mmap()` based (regular or huge) page-sized ring-buffers over arbitrary files
+use super::*;
+
+//TODO: Implement this w/ MAP_FIXED
+
+pub mod buffer;

src/ring/buffer.rs

@@ -0,0 +1,78 @@
+//! Traits and types used for mapping a R^W send-recv buffer `(tx, rx)`
+//!
+//! See `MappedFile::try_new_buffer()`
+use super::*;
+use std::{
+    borrow::Borrow,
+    ops,
+    sync,
+    rc,
+};
+
+pub trait TwoBufferProvider<T: ?Sized>
+{
+    type ControlWrapper: Borrow<T>;
+
+    fn as_wrapper(&self) -> &Self::ControlWrapper;
+
+    #[inline(always)] 
+    fn inner(&self) -> &T
+    {
+	self.as_wrapper().borrow()
+    }
+
+    fn from_boxed(value: Box<T>) -> Box<Self>;
+//TODO: How do we give enough info to caller to create this?	
+}
+
+/// For thread-sharable buffer holds
+#[derive(Debug, Clone)]
+pub struct Shared<T: ?Sized>(sync::Arc<T>);
+
+/// For non thread-sharable buffer holds
+#[derive(Debug, Clone)]
+pub struct Private<T: ?Sized>(rc::Rc<T>);
+
+impl<T: ?Sized> TwoBufferProvider<T> for Shared<T> {
+    type ControlWrapper = sync::Arc<T>;
+
+    #[inline(always)] 
+    fn as_wrapper(&self) -> &Self::ControlWrapper {
+	&self.0
+    }
+
+    #[inline] 
+    fn from_boxed(value: Box<T>) ->Box<Self> {
+	Box::new(Self(value.into()))
+    }
+}
+
+impl<T: ?Sized + AsRawFd> AsRawFd for Shared<T>
+{
+    #[inline(always)] 
+    fn as_raw_fd(&self) -> RawFd {
+	self.as_wrapper().as_raw_fd()
+    }
+}
+
+impl<T: ?Sized> TwoBufferProvider<T> for Private<T> {
+    type ControlWrapper = rc::Rc<T>;
+
+    #[inline(always)] 
+    fn as_wrapper(&self) -> &Self::ControlWrapper {
+	&self.0
+    }
+    
+    #[inline] 
+    fn from_boxed(value: Box<T>) ->Box<Self> {
+	Box::new(Self(value.into()))
+    }
+}
+
+impl<T: ?Sized + AsRawFd> AsRawFd for Private<T>
+{
+    #[inline(always)] 
+    fn as_raw_fd(&self) -> RawFd {
+	self.as_wrapper().as_raw_fd()
+    }
+}