Merge pull request #99 from elast0ny/develop

Apply pending PRs

Author: elast0ny

.github/workflows/rust.yml

@@ -2,7 +2,7 @@ name: build
 
 on:
   push:
-    branches: [master]
+    branches: [master, develop]
   pull_request:
 
 jobs:

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "shared_memory"
 description = "A user friendly crate that allows you to share memory between processes"
-version = "0.12.4"
+version = "0.12.5"
 authors = ["ElasT0ny <[email protected]>"]
 license = "MIT OR Apache-2.0"
 edition = "2018"
@@ -31,13 +31,13 @@ rand = "0.8"
 log = { version = "0.4", optional = true }
 
 [target.'cfg(unix)'.dependencies]
-nix = "0.23"
+nix = { version = "0.26", default-features = false, features = ["fs", "mman"] }
 libc = "0.2"
 
 [target.'cfg(windows)'.dependencies]
 win-sys = "0.3"
 
 [dev-dependencies]
 raw_sync = "0.1"
-clap = {version = "3", features = ["derive"]}
+clap = {version = "4", features = ["derive"]}
 env_logger = "0"

changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 0.12.5
+- Update dependencies
+- Use minimal features for `nix` on unix systems
+
 # 0.12.4
 - Allow Windows users to open shared memory that isnt managed by this crate
 - Added tests

examples/basic.rs

@@ -48,10 +48,7 @@ fn increment_value(shmem_flink: &str, thread_num: usize, max: u8) {
         Ok(m) => m,
         Err(ShmemError::LinkExists) => ShmemConf::new().flink(shmem_flink).open().unwrap(),
         Err(e) => {
-            eprintln!(
-                "Unable to create or open shmem flink {} : {}",
-                shmem_flink, e
-            );
+            eprintln!("Unable to create or open shmem flink {shmem_flink} : {e}");
             return;
         }
     };

examples/event.rs

@@ -15,7 +15,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         //Create an event in the shared memory
         println!("Creating event in shared memory");
         let (evt, used_bytes) = unsafe { Event::new(shmem.as_ptr(), true)? };
-        println!("\tUsed {} bytes", used_bytes);
+        println!("\tUsed {used_bytes} bytes");
 
         println!("Launch another instance of this example to signal the event !");
         evt.wait(Timeout::Infinite)?;
@@ -24,7 +24,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         // Open existing event
         println!("Openning event from shared memory");
         let (evt, used_bytes) = unsafe { Event::from_existing(shmem.as_ptr())? };
-        println!("\tEvent uses {} bytes", used_bytes);
+        println!("\tEvent uses {used_bytes} bytes");
 
         println!("Signaling event !");
         evt.set(EventState::Signaled)?;

examples/mutex.rs

@@ -48,10 +48,7 @@ fn increment_value(shmem_flink: &str, thread_num: usize) {
         Ok(m) => m,
         Err(ShmemError::LinkExists) => ShmemConf::new().flink(shmem_flink).open().unwrap(),
         Err(e) => {
-            eprintln!(
-                "Unable to create or open shmem flink {} : {}",
-                shmem_flink, e
-            );
+            eprintln!("Unable to create or open shmem flink {shmem_flink} : {e}");
             return;
         }
     };
@@ -99,7 +96,7 @@ fn increment_value(shmem_flink: &str, thread_num: usize) {
             // Cast mutex data to &mut u8
             let val: &mut u8 = unsafe { &mut **guard };
             if *val > 5 {
-                println!("[thread#{}] done !", thread_num);
+                println!("[thread#{thread_num}] done !");
                 return;
             }
 

src/error.rs

@@ -21,16 +21,16 @@ impl std::fmt::Display for ShmemError {
             ShmemError::MapSizeZero => f.write_str("You cannot create a shared memory mapping of 0 size"),
             ShmemError::NoLinkOrOsId => f.write_str("Tried to open mapping without flink path or os_id"),
             ShmemError::FlinkInvalidOsId => f.write_str("Tried to open mapping from both flink and os_id but the flink did not point to the same os_id"),
-            ShmemError::LinkCreateFailed(err) => write!(f, "Creating the link file failed, {}", err),
-            ShmemError::LinkWriteFailed(err) => write!(f, "Writing the link file failed, {}", err),
+            ShmemError::LinkCreateFailed(err) => write!(f, "Creating the link file failed, {err}"),
+            ShmemError::LinkWriteFailed(err) => write!(f, "Writing the link file failed, {err}"),
             ShmemError::LinkExists => f.write_str("Shared memory link already exists"),
-            ShmemError::LinkOpenFailed(err) => write!(f, "Opening the link file failed, {}", err),
-            ShmemError::LinkReadFailed(err) => write!(f, "Reading the link file failed, {}", err),
+            ShmemError::LinkOpenFailed(err) => write!(f, "Opening the link file failed, {err}"),
+            ShmemError::LinkReadFailed(err) => write!(f, "Reading the link file failed, {err}"),
             ShmemError::LinkDoesNotExist => f.write_str("Requested link file does not exist"),
             ShmemError::MappingIdExists => f.write_str("Shared memory OS specific ID already exists"),
-            ShmemError::MapCreateFailed(err) => write!(f, "Creating the shared memory failed, os error {}", err),
-            ShmemError::MapOpenFailed(err) => write!(f, "Opening the shared memory failed, os error {}", err),
-            ShmemError::UnknownOsError(err) => write!(f, "An unexpected OS error occurred, os error {}", err),
+            ShmemError::MapCreateFailed(err) => write!(f, "Creating the shared memory failed, os error {err}"),
+            ShmemError::MapOpenFailed(err) => write!(f, "Opening the shared memory failed, os error {err}"),
+            ShmemError::UnknownOsError(err) => write!(f, "An unexpected OS error occurred, os error {err}"),
         }
     }
 }

src/unix.rs

@@ -1,3 +1,4 @@
+use std::num::NonZeroUsize;
 use std::os::unix::io::RawFd;
 use std::ptr::null_mut;
 
@@ -83,6 +84,9 @@ impl MapData {
 pub fn create_mapping(unique_id: &str, map_size: usize) -> Result<MapData, ShmemError> {
     //Create shared memory file descriptor
     debug!("Creating persistent mapping at {}", unique_id);
+
+    let nz_map_size = NonZeroUsize::new(map_size).ok_or(ShmemError::MapSizeZero)?;
+
     let shmem_fd = match shm_open(
         unique_id, //Unique name that usualy pops up in /dev/shm/
         OFlag::O_CREAT | OFlag::O_EXCL | OFlag::O_RDWR, //create exclusively (error if collision) and read/write to allow resize
@@ -122,8 +126,8 @@ pub fn create_mapping(unique_id: &str, map_size: usize) -> Result<MapData, Shmem
     debug!("Loading mapping into address space");
     new_map.map_ptr = match unsafe {
         mmap(
-            null_mut(),                                   //Desired addr
-            new_map.map_size,                             //size of mapping
+            None,                                         //Desired addr
+            nz_map_size,                                  //size of mapping
             ProtFlags::PROT_READ | ProtFlags::PROT_WRITE, //Permissions on pages
             MapFlags::MAP_SHARED,                         //What kind of mapping
             new_map.map_fd,                               //fd
@@ -187,12 +191,14 @@ pub fn open_mapping(
         Err(e) => return Err(ShmemError::MapOpenFailed(e as u32)),
     };
 
+    let nz_map_size = NonZeroUsize::new(new_map.map_size).ok_or(ShmemError::MapSizeZero)?;
+
     //Map memory into our address space
     debug!("Loading mapping into address space");
     new_map.map_ptr = match unsafe {
         mmap(
-            null_mut(),                                   //Desired addr
-            new_map.map_size,                             //size of mapping
+            None,                                         //Desired addr
+            nz_map_size,                                  //size of mapping
             ProtFlags::PROT_READ | ProtFlags::PROT_WRITE, //Permissions on pages
             MapFlags::MAP_SHARED,                         //What kind of mapping
             new_map.map_fd,                               //fd

tests/general.rs

@@ -69,7 +69,7 @@ fn open_flink() {
     let s1 = ShmemConf::new().flink(flink).size(4090).create().unwrap();
 
     // Open with file base link
-    let mut s2 = ShmemConf::new().flink(&flink).open().unwrap();
+    let mut s2 = ShmemConf::new().flink(flink).open().unwrap();
 
     assert!(!s2.is_owner());
     assert!(!s2.get_os_id().is_empty());
@@ -85,7 +85,7 @@ fn open_flink() {
     drop(s1);
 
     // Make sure it can be openned again
-    assert!(ShmemConf::new().flink(&flink).open().is_err());
+    assert!(ShmemConf::new().flink(flink).open().is_err());
 
     drop(s2);
 }
@@ -99,7 +99,7 @@ fn share_data() {
 
     // Open with the unique os id
     let os_id = s1.get_os_id().to_string();
-    let s2 = ShmemConf::new().os_id(&os_id).open().unwrap();
+    let s2 = ShmemConf::new().os_id(os_id).open().unwrap();
 
     let ptr1 = s1.as_ptr() as *mut u32;
     let ptr2 = s2.as_ptr() as *mut u32;

tests/posix_semantics.rs

@@ -77,7 +77,7 @@ fn posix_behavior() {
             // This thread keeps a shared memory instance alive until it's told to
             // drop it.
             let existing_os_id = rx_c.recv().unwrap();
-            let _shmem = ShmemConf::new().os_id(&existing_os_id).open().unwrap();
+            let _shmem = ShmemConf::new().os_id(existing_os_id).open().unwrap();
             // Indicate to thread A that the instance has been created.
             tx_a.send(String::new()).unwrap();
             // Shut down signal.