#memfd #shared-memory #ipc #shm-anon #shm

shmemfdrs

Creates anonymous shared memory file descriptors for IPC on Unix platforms, using memfd/SHM_ANON/shm_open

2 releases

Uses old Rust 2015

0.1.1 Jun 9, 2018
0.1.0 Dec 9, 2017

#186 in Unix APIs

21 downloads per month
Used in tiny-nix-ipc

MIT/Apache

8KB
50 lines

crates.io

shmemfdrs

This tiny little crate provides a function that creates anonymous shared memory file descriptors for IPC, using the best available platform-specific method:

  • on Linux, if the memfd Cargo feature is enabled for this crate: memfd (requires kernel >= 3.17)
  • on FreeBSD: shm_open(SHM_ANON)
  • otherwise: shm_open with a name, instantly unlinked

memfd and SHM_ANON are actually anonymous from the start, i.e. they don't need access the filesystem at all, so they work well with process sandboxes like Capsicum. (memfd actually uses the provided name, but only for debugging purposes.)

This crate was extracted from ipc-channel.

Usage

There's just one function exported from this crate:

fn create_shmem<T: AsRef<CStr>>(name: T, length: usize) -> c_int

Should be easy to figure out :)

The name should start with / and shouldn't be very long (255 characters max).

Contributing

Please feel free to submit pull requests!

By participating in this project you agree to follow the Contributor Code of Conduct.

The list of contributors is available on GitHub.

License

Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.

Dependencies

~86KB

[