Polish shm (#2023)

* make `with_size` method for POSIX backend builder infallable
* add `as_mut_unchecked` method to all SHM buffer types
* add alignment construction methods `for_type` and `for_val`
* add alignment setting for default SHM Provider builder

* code format for new rust

Author: yellowhatter

commons/zenoh-codec/tests/codec.rs

@@ -41,7 +41,7 @@ fn zbuf_test() {
 
     let codec = Zenoh080::new();
     codec.write(&mut writer, &zbuf).unwrap();
-    println!("Buffer: {:?}", buffer);
+    println!("Buffer: {buffer:?}");
 
     let mut reader = buffer.reader();
     let ret: ZBuf = codec.read(&mut reader).unwrap();
@@ -178,7 +178,7 @@ fn codec_zint_len() {
         let mut writer = buff.writer();
         let n: u64 = 1 << (7 * i);
         codec.write(&mut writer, n).unwrap();
-        println!("ZInt len: {} {:02x?}", n, buff);
+        println!("ZInt len: {n} {buff:02x?}");
         assert_eq!(codec.w_len(n), buff.len());
     }
 

commons/zenoh-config/src/include.rs

@@ -136,10 +136,7 @@ where
 
             values.remove(k);
             if let Some(include_values) = v.as_object_mut() {
-                let title = format!(
-                    "{}.{} -> {}::{}",
-                    title, include_property_name, include_path, k
-                );
+                let title = format!("{title}.{include_property_name} -> {include_path}::{k}");
                 recursive_include(
                     title.as_str(),
                     include_values,
@@ -157,7 +154,7 @@ where
     // process remaining object values
     for (k, v) in values.iter_mut() {
         if let Some(object) = v.as_object_mut() {
-            let title = format!("{}.{}", title, k);
+            let title = format!("{title}.{k}");
             recursive_include(
                 title.as_str(),
                 object,

commons/zenoh-config/src/lib.rs

@@ -242,7 +242,7 @@ pub enum InterceptorLink {
 
 impl std::fmt::Display for InterceptorLink {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(f, "Transport({:?})", self)
+        write!(f, "Transport({self:?})")
     }
 }
 
@@ -1162,7 +1162,7 @@ impl PluginsConfig {
             let required = match value.get("__required__") {
                 None => false,
                 Some(Value::Bool(b)) => *b,
-                _ => panic!("Plugin '{}' has an invalid '__required__' configuration property (must be a boolean)", id)
+                _ => panic!("Plugin '{id}' has an invalid '__required__' configuration property (must be a boolean)")
             };
             let name = match value.get("__plugin__") {
                 Some(Value::String(p)) => p,
@@ -1172,8 +1172,8 @@ impl PluginsConfig {
             if let Some(paths) = value.get("__path__") {
                 let paths = match paths {
                     Value::String(s) => vec![s.clone()],
-                    Value::Array(a) => a.iter().map(|s| if let Value::String(s) = s { s.clone() } else { panic!("Plugin '{}' has an invalid '__path__' configuration property (must be either string or array of strings)", id) }).collect(),
-                    _ => panic!("Plugin '{}' has an invalid '__path__' configuration property (must be either string or array of strings)", id)
+                    Value::Array(a) => a.iter().map(|s| if let Value::String(s) = s { s.clone() } else { panic!("Plugin '{id}' has an invalid '__path__' configuration property (must be either string or array of strings)") }).collect(),
+                    _ => panic!("Plugin '{id}' has an invalid '__path__' configuration property (must be either string or array of strings)")
                 };
                 PluginLoad { id: id.clone(), name: name.clone(), paths: Some(paths), required }
             } else {
@@ -1286,7 +1286,7 @@ impl std::fmt::Debug for PluginsConfig {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         let mut values: Value = self.values.clone();
         sift_privates(&mut values);
-        write!(f, "{:?}", values)
+        write!(f, "{values:?}")
     }
 }
 

commons/zenoh-protocol/src/core/endpoint.rs

@@ -78,7 +78,7 @@ impl fmt::Display for Protocol<'_> {
 
 impl fmt::Debug for Protocol<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -113,7 +113,7 @@ impl fmt::Display for ProtocolMut<'_> {
 
 impl fmt::Debug for ProtocolMut<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -142,7 +142,7 @@ impl fmt::Display for Address<'_> {
 
 impl fmt::Debug for Address<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -183,7 +183,7 @@ impl fmt::Display for AddressMut<'_> {
 
 impl fmt::Debug for AddressMut<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -231,7 +231,7 @@ impl fmt::Display for Metadata<'_> {
 
 impl fmt::Debug for Metadata<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -316,7 +316,7 @@ impl fmt::Display for MetadataMut<'_> {
 
 impl fmt::Debug for MetadataMut<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -361,7 +361,7 @@ impl fmt::Display for Config<'_> {
 
 impl fmt::Debug for Config<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -446,7 +446,7 @@ impl fmt::Display for ConfigMut<'_> {
 
 impl fmt::Debug for ConfigMut<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 
@@ -577,7 +577,7 @@ impl fmt::Display for EndPoint {
 
 impl fmt::Debug for EndPoint {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 

commons/zenoh-protocol/src/core/locator.rs

@@ -118,7 +118,7 @@ impl fmt::Display for Locator {
 
 impl fmt::Debug for Locator {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 

commons/zenoh-protocol/src/core/parameters.rs

@@ -466,7 +466,7 @@ impl fmt::Display for Parameters<'_> {
 
 impl fmt::Debug for Parameters<'_> {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "{}", self)
+        write!(f, "{self}")
     }
 }
 

commons/zenoh-runtime/src/lib.rs

@@ -76,7 +76,7 @@ impl RuntimeParam {
                     .get(&zrt)
                     .unwrap()
                     .fetch_add(1, Ordering::SeqCst);
-                format!("{}-{}", zrt, id)
+                format!("{zrt}-{id}")
             })
             .build()?;
         Ok(rt)

commons/zenoh-shm/src/api/buffer/traits.rs

@@ -31,6 +31,19 @@ pub enum BufferRelayoutError {
 pub trait ShmBuf: Deref<Target = [u8]> + AsRef<[u8]> {
     #[zenoh_macros::unstable_doc]
     fn is_valid(&self) -> bool;
+
+    #[zenoh_macros::unstable_doc]
+    /// Get unchecked mutable access to buffer's memory. This is unsafe yet very powerful API for
+    /// building concurrent access logic around SHM buffer contents. For safe version please
+    /// see `ShmBufMut` trait
+    ///
+    /// # Safety
+    ///
+    /// Safe if multiple conditions are met:
+    /// - user code guarantees no data race across all applications that share the buffer
+    /// - the buffer is not being concurrently sent to the outside of SHM domain
+    /// - the buffer is valid
+    unsafe fn as_mut_unchecked(&mut self) -> &mut [u8];
 }
 
 #[zenoh_macros::unstable_doc]

commons/zenoh-shm/src/api/buffer/zshm.rs

@@ -36,6 +36,10 @@ impl ShmBuf for ZShm {
     fn is_valid(&self) -> bool {
         self.0.is_valid()
     }
+
+    unsafe fn as_mut_unchecked(&mut self) -> &mut [u8] {
+        self.0.as_mut_slice_inner()
+    }
 }
 
 impl OwnedShmBuf for ZShm {
@@ -137,6 +141,10 @@ impl ShmBuf for zshm {
     fn is_valid(&self) -> bool {
         self.0.is_valid()
     }
+
+    unsafe fn as_mut_unchecked(&mut self) -> &mut [u8] {
+        self.0.as_mut_slice_inner()
+    }
 }
 
 impl Deref for zshm {

commons/zenoh-shm/src/api/buffer/zshmmut.rs

@@ -36,6 +36,10 @@ impl ShmBuf for ZShmMut {
     fn is_valid(&self) -> bool {
         self.0.is_valid()
     }
+
+    unsafe fn as_mut_unchecked(&mut self) -> &mut [u8] {
+        self.0.as_mut_slice_inner()
+    }
 }
 
 impl ShmBufMut for ZShmMut {}
@@ -153,6 +157,10 @@ impl ShmBuf for zshmmut {
     fn is_valid(&self) -> bool {
         self.0.is_valid()
     }
+
+    unsafe fn as_mut_unchecked(&mut self) -> &mut [u8] {
+        self.0.as_mut_slice_inner()
+    }
 }
 
 impl ShmBufMut for zshmmut {}