#ipc #memory #shmem #memfd

shmem-ipc

Untrusted IPC with maximum performance and minimum latency on Linux

3 releases (breaking)

0.3.0 Nov 22, 2022
0.2.0 Feb 16, 2021
0.1.0 Feb 8, 2021

#389 in Memory management

Apache-2.0/MIT

34KB
511 lines

crates.io API documentation license

Untrusted IPC with maximum performance and minimum latency. On Rust, on Linux.

When is this Rust crate useful?

  • Performance or latency is crucial, and
  • you run Linux.

A typical use case could be audio/video streaming.

Don't need maximum performance and minimum latency, and want a higher level protocol with serialization and lots of bells and whistles built-in? Try D-Bus.

Also, a unix socket is easier to set up and is not that much slower (see benchmark below).

As for Linux, this crate uses memfd sealing to ensure safety between untrusted processes, and ringbuffer signaling is done using eventfd for best performance. These two features are Linux only.

Getting started

You probably want to start in the sharedring module, which sets up a ringbuffer between untrusted processes (it's a wait-free/lock-free, bounded, SPSC queue). Another useful function is mem::write_once for a scenario where you write data once and make it available for reading afterwards. The mem and ringbuf modules contain building blocks that might be useful in other use cases.

The downside of using memfd based shared memory is that you need to set it up by transferring file descriptors, using some other way of communication. Using D-Bus would be the standard way of doing that - it's also possible using unix sockets.

There is also a client/server example in the examples directory that can help you get started. Enjoy!

Benchmark

Sharedring vs unix sockets vs D-Bus Notice the log scale: for a 64K packet, sharedring is a three times faster than unix sockets, and 60 times faster than D-Bus. (D-Bus is a higher level protocol, so that comparison is to some degree comparing apples and oranges.)

License

The code is Apache 2.0 / MIT dual licensed. Any code submitted in Pull Requests, discussions or issues is assumed to have this license, unless explicitly stated otherwise.

Dependencies

~2.5MB
~51K SLoC