Add io-uring-bufring (#46)

* Misc updates for runtime use

* Add io-uring-bufring

Author: pinkforest

Cargo.lock

@@ -1,4 +1,4 @@
 [workspace]
-members = ["io-uring-bearer", "io-uring-epoll", "io-uring-opcode", "io-uring-fd", "io-uring-owner", "ops/*"]
+members = ["io-uring-bearer", "io-uring-epoll", "io-uring-opcode", "io-uring-fd", "io-uring-owner", "io-uring-bufring", "ops/*"]
 exclude = ["examples/*"]
 resolver = "2"

Cargo.toml

@@ -111,4 +111,4 @@ impl From<OpError> for UringBearerError {
     }
 }
 
-impl std::error::Error for UringBearerError {}
+impl core::error::Error for UringBearerError {}

io-uring-bearer/src/error.rs

@@ -250,15 +250,17 @@ impl<C: core::fmt::Debug + Clone + OpCompletion> UringBearer<C> {
     }
     // TODO: Rework - this should be generic and FdKind'ed
     #[inline]
-    fn _fixed_fd_validate(&self, try_fixed_fd: u32) -> bool {
+    fn _fixed_fd_validate(&self, _try_fixed_fd: u32) -> bool {
         // TODO: provide external entity (yaoi) better API to set things registered
         return true;
-        if try_fixed_fd > self.fd_register.capacity() - 1 {
+        /*
+        if _try_fixed_fd > self.fd_register.capacity() - 1 {
             return false;
         }
-        match self.fd_register.get(try_fixed_fd) {
+        match self.fd_register.get(_try_fixed_fd) {
             Some((_, _itm)) => true,
             _ => false,
-        }
+    }
+        */
     }
 }

io-uring-bearer/src/uring.rs

@@ -0,0 +1,31 @@
+[package]
+name = "io-uring-bufring"
+version = "0.1.0"
+edition = "2021"
+description = "io_uring bufring"
+homepage = "https://github.com/yaws-rs/io_uring-utils"
+keywords = ["io", "uring", "epoll", "async"]
+license = "Apache-2.0/MIT"
+readme = "README.md"
+repository = "https://github.com/yaws-rs/io_uring-utils"
+categories = ["science"]
+
+[dependencies]
+io-uring = { version = "0.7", default-features = false }
+io-uring-bearer = { path = "../io-uring-bearer", version = "0.2.0-pre3", default-features = false, optional = true }
+io-uring-opcode = { path = "../io-uring-opcode", version = "0.2.0-pre3", default-features = false, optional = true }
+anonymous-mmap = { path = "../../ylibc/anonymous_mmap", version = "0.1.0", default-features = false }
+libc = { version = "0.2", features = ["extra_traits"] }
+
+[dev-dependencies]
+capacity = "0.1"
+io-uring-opcode = { path = "../io-uring-opcode", version = "0.2.0-pre3", features = ["accept_multi", "connect", "socket"] }
+io-uring-opcode-sets = { path = "../io-uring-opcode-sets", version = "0.0.1-whatever0", features = ["accept_multi", "connect", "socket"] }
+ysockaddr = { version = "0.2.0" }
+
+[features]
+default = []
+bearer = ["dep:io-uring-bearer", "dep:io-uring-opcode"]
+
+[package.metadata.docs.rs]
+features = [""]

io-uring-bufring/Cargo.toml

@@ -0,0 +1,3 @@
+# io-uring-bufring
+
+bufring abstraction that can be used with io-uring-bearer or io-uring directly.

io-uring-bufring/README.md

@@ -0,0 +1,36 @@
+//! io_uring RingBuf Errors
+
+use core::fmt;
+use core::fmt::Display;
+
+use anonymous_mmap::AnonymousMmapError;
+
+/// Errors from the UringRingBuf
+#[derive(Debug)]
+pub enum RingBufError {
+    /// Given / assumed page size must be divisible with the given buffer size
+    PageSizeUndivisible,
+    /// Error during Mmap from AnonymousMmap
+    Mmap(AnonymousMmapError),
+    /// io-uring-bearer Related Unregister error
+    #[cfg(feature = "bearer")]
+    Unregister(crate::RingBufRegistered, std::io::Error),
+    /// io-uring-bearer Related Register error
+    #[cfg(feature = "bearer")]
+    Register(crate::RingBufUnregistered, std::io::Error),
+}
+
+impl Display for RingBufError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::PageSizeUndivisible => write!(f, "Given / assumed page size must be divisible with the given buffer size"),
+            Self::Mmap(am) => write!(f, "mmap error: {}", am),
+            #[cfg(feature = "bearer")]
+            Self::Register(_, iou) => write!(f, "IoUring Register: {}", iou),
+            #[cfg(feature = "bearer")]
+            Self::Unregister(_, iou) => write!(f, "IoUring Unregister: {}", iou),            
+        }
+    }
+}
+
+impl core::error::Error for RingBufError {}

io-uring-bufring/src/error.rs

@@ -0,0 +1,28 @@
+#![warn(
+    clippy::unwrap_used,
+    missing_docs,
+    rust_2018_idioms,
+    unused_lifetimes,
+    unused_qualifications
+)]
+#![doc = include_str!("../README.md")]
+
+//***********************************************
+// Re-Exports
+//***********************************************
+pub use io_uring;
+
+//-----------------------------------------------
+// All Errors
+//-----------------------------------------------
+mod error;
+#[doc(inline)]
+pub use error::RingBufError;
+
+//-----------------------------------------------
+// RingBuf type
+//-----------------------------------------------
+
+mod ring_buf;
+#[doc(inline)]
+pub use ring_buf::*;