1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
//! Creates shared memory ring buffers to be used between untrusted processes.
//!
//! The information to be transferred between processes through other means (pipes or D-Bus) is:
//! * capacity
//! * memfd file descriptor
//! * empty signal file descriptor
//! * full signal file descriptor
use super::Error;
use crate::mem::mfd::{HugetlbSize, MemfdOptions};
use crate::ringbuf::Status;
use std::fs::File;
use std::io::{Read, Write};
use std::os::unix::io::FromRawFd;
use std::slice::from_raw_parts;
use std::slice::from_raw_parts_mut;
struct Inner {
mmap: memmap2::MmapRaw,
memfd: memfd::Memfd,
empty_signal: File,
full_signal: File,
}
fn page_size() -> usize { unsafe { libc::sysconf(libc::_SC_PAGESIZE) as usize } }
fn round_to_page_size<T>(capacity: usize) -> usize {
let bytes = crate::ringbuf::channel_bufsize::<T>(capacity);
let ps = page_size();
let m = bytes % ps;
if m == 0 {
bytes
} else {
bytes + ps - m
}
}
fn eventfd() -> Result<File, std::io::Error> {
let x = unsafe { libc::eventfd(0, libc::EFD_CLOEXEC) };
if x == -1 {
Err(std::io::Error::last_os_error())
} else {
Ok(unsafe { File::from_raw_fd(x) })
}
}
impl Inner {
fn new<T>(capacity: usize, tlbsize: Option<HugetlbSize>) -> Result<Self, Error> {
let bytes = round_to_page_size::<T>(capacity);
let mut opts = MemfdOptions::default().allow_sealing(true).close_on_exec(true);
if tlbsize.is_some() {
opts = opts.hugetlb(tlbsize);
}
let memfd = opts.create(std::any::type_name::<T>())?;
if tlbsize.is_none() {
// hugetlb does not need/allow to set_len
memfd.as_file().set_len(bytes as u64)?;
}
let empty_signal = eventfd()?;
let full_signal = eventfd()?;
let mmap = crate::mem::raw_memfd(&memfd, bytes)?;
Ok(Self { mmap, memfd, empty_signal, full_signal })
}
fn mlock(&mut self) -> Result<(), Error> { Ok(self.mmap.lock()?) }
fn open<T>(capacity: usize, file: File, empty_signal: File, full_signal: File) -> Result<Self, Error> {
let bytes = round_to_page_size::<T>(capacity);
let memfd = memfd::Memfd::try_from_file(file).map_err(|_| std::io::Error::last_os_error())?;
let mmap = crate::mem::raw_memfd(&memfd, bytes)?;
if mmap.len() < bytes {
Err(crate::ringbuf::Error::BufTooSmall)?
};
Ok(Self { mmap, memfd, empty_signal, full_signal })
}
}
pub struct Sender<T>(Inner, crate::ringbuf::Sender<T>);
impl<T: Copy + zerocopy::AsBytes> Sender<T> {
/// Sets up a new ringbuffer and returns the sender half.
pub fn new(capacity: usize) -> Result<Self, Error> {
let inner = Inner::new::<T>(capacity, None)?;
let ringbuf = unsafe { crate::ringbuf::Sender::attach(inner.mmap.as_mut_ptr(), inner.mmap.len())? };
Ok(Self(inner, ringbuf))
}
/// Create a new ringbuffer with hugetlb support and returns the sender half.
/// Supports linux version 4.16+ only
pub fn with_hugetlb(capacity: usize, tlbsize: HugetlbSize) -> Result<Self, Error> {
let inner = Inner::new::<T>(capacity, Some(tlbsize))?;
let ringbuf = unsafe { crate::ringbuf::Sender::attach(inner.mmap.as_mut_ptr(), inner.mmap.len())? };
Ok(Self(inner, ringbuf))
}
/// mlock the backing memory to avoid it being put into swap
pub fn mlock(&mut self) -> Result<(), Error> { self.0.mlock() }
/// Attaches to a ringbuffer set up by the receiving side.
pub fn open(capacity: usize, memfd: File, empty_signal: File, full_signal: File) -> Result<Self, Error> {
let inner = Inner::open::<T>(capacity, memfd, empty_signal, full_signal)?;
let ringbuf = unsafe { crate::ringbuf::Sender::attach(inner.mmap.as_mut_ptr(), inner.mmap.len())? };
Ok(Self(inner, ringbuf))
}
/// Low-level access to the ringbuffer.
///
/// Note that writing directly using these methods will not trigger a signal for the receiving side
/// to wake up.
pub fn sender_mut(&mut self) -> &mut crate::ringbuf::Sender<T> { &mut self.1 }
/// The file descriptor for the shared memory area
pub fn memfd(&self) -> &memfd::Memfd { &self.0.memfd }
/// The file descriptor written to when the receiving side should wake up
pub fn empty_signal(&self) -> &File { &self.0.empty_signal }
/// The file descriptor to register notification for in your favorite non-blocking framework (tokio, async-std etc).
///
/// It is written to by the receiving side when the buffer is no longer full.
pub fn full_signal(&self) -> &File { &self.0.full_signal }
/// Sends one or more items through the ringbuffer.
///
/// Because this is a ringbuffer between untrusted processes we can never create references to
/// the data, so we have to resort to raw pointers.
/// The closure receives a (ptr, count) pair which can be written to using e g `std::ptr::write`,
/// and returns the number of items written to that memory area.
/// If the buffer is full, the closure is not called. If there is more data that could be written
/// (e g in another part of the ringbuffer), that is indicated in the returned `Status` struct.
pub fn send_raw<F: FnOnce(*mut T, usize) -> usize>(&mut self, f: F) -> Result<Status, Error> {
let status = self.sender_mut().send(f)?;
if status.signal {
self.empty_signal().write(&1u64.to_ne_bytes())?;
}
Ok(status)
}
/// Sends one or more items through the ringbuffer.
///
/// The closure receives a slice to which it can write data and returns the number of items
/// written.
/// If the buffer is full, the closure is not called. If there is more data that could be written
/// (e g in another part of the ringbuffer), that is indicated in the returned `Status` struct.
///
/// # Safety
///
/// Caller must ensure that no one can read or write the data area, except for
/// at most one Sender (this one) and at most one Receiver, both set up correctly.
pub unsafe fn send_trusted<F: FnOnce(&mut [T]) -> usize>(&mut self, f: F) -> Result<Status, Error> {
self.send_raw(|p, count| f(from_raw_parts_mut(p, count)))
}
/// For blocking scenarios, blocks until the channel is writable.
pub fn block_until_writable(&mut self) -> Result<Status, Error> {
loop {
let s = self.sender_mut().write_count()?;
if s > 0 {
return Ok(Status { remaining: s, signal: false });
};
let mut b = [0u8; 8];
self.full_signal().read(&mut b)?;
}
}
}
pub struct Receiver<T>(Inner, crate::ringbuf::Receiver<T>);
impl<T: Copy + zerocopy::FromBytes> Receiver<T> {
/// Sets up a new ringbuffer and returns the receiver half.
pub fn new(capacity: usize) -> Result<Self, Error> {
let inner = Inner::new::<T>(capacity, None)?;
let ringbuf = unsafe { crate::ringbuf::Receiver::attach(inner.mmap.as_mut_ptr(), inner.mmap.len())? };
Ok(Self(inner, ringbuf))
}
/// Create a new ringbuffer with hugetlb support and returns the receiver half.
/// Supports linux version 4.16+ only
pub fn with_hugetlb(capacity: usize, tlbsize: HugetlbSize) -> Result<Self, Error> {
let inner = Inner::new::<T>(capacity, Some(tlbsize))?;
let ringbuf = unsafe { crate::ringbuf::Receiver::attach(inner.mmap.as_mut_ptr(), inner.mmap.len())? };
Ok(Self(inner, ringbuf))
}
/// Attaches to a ringbuffer set up by the sending side.
pub fn open(capacity: usize, memfd: File, empty_signal: File, full_signal: File) -> Result<Self, Error> {
let inner = Inner::open::<T>(capacity, memfd, empty_signal, full_signal)?;
let ringbuf = unsafe { crate::ringbuf::Receiver::attach(inner.mmap.as_mut_ptr(), inner.mmap.len())? };
Ok(Self(inner, ringbuf))
}
/// mlock the backing memory to avoid it being put into swap
pub fn mlock(&mut self) -> Result<(), Error> { self.0.mlock() }
/// Low-level access to the ringbuffer.
///
/// Note that reading directly using these methods will not trigger a signal for the sending side
/// to wake up.
pub fn receiver_mut(&mut self) -> &mut crate::ringbuf::Receiver<T> { &mut self.1 }
/// The file descriptor for the shared memory area
pub fn memfd(&self) -> &memfd::Memfd { &self.0.memfd }
/// The file descriptor to register notification for in your favorite non-blocking framework (tokio, async-std etc).
///
/// It is written to by the sending side when the buffer is no longer empty.
pub fn empty_signal(&self) -> &File { &self.0.empty_signal }
/// The file descriptor written to when the sending side should wake up
pub fn full_signal(&self) -> &File { &self.0.full_signal }
/// Receives data from the ringbuffer.
///
/// Because this is a ringbuffer between untrusted processes we can never create references to
/// the data, so we have to resort to raw pointers.
/// The closure receives a (ptr, count) pair which can be read from using e g `std::ptr::read`,
/// and returns the number of items that can be dropped from the ringbuffer.
/// If the buffer is empty, the closure is not called. If there is more data that could be read
/// (e g in another part of the ringbuffer), that is indicated in the returned `Status` struct.
pub fn receive_raw<F: FnOnce(*const T, usize) -> usize>(&mut self, f: F) -> Result<Status, Error> {
let status = self.receiver_mut().recv(f)?;
if status.signal {
self.full_signal().write(&1u64.to_ne_bytes())?;
}
Ok(status)
}
/// Receives data from the ringbuffer.
///
/// The closure receives a slice of data and returns the number of items that can be dropped
/// from the ringbuffer.
/// If the buffer is empty, the closure is not called. If there is more data that could be read
/// (e g in another part of the ringbuffer), that is indicated in the returned `Status` struct.
///
/// # Safety
///
/// Caller must ensure that no one can read or write the data area, except for
/// at most one Receiver (this one) and at most one Sender, both set up correctly.
pub unsafe fn receive_trusted<F: FnOnce(&[T]) -> usize>(&mut self, f: F) -> Result<Status, Error> {
self.receive_raw(|p, count| f(from_raw_parts(p, count)))
}
/// For blocking scenarios, blocks until the channel is readable.
pub fn block_until_readable(&mut self) -> Result<Status, Error> {
loop {
let s = self.receiver_mut().read_count()?;
if s > 0 {
return Ok(Status { remaining: s, signal: false });
};
let mut b = [0u8; 8];
self.empty_signal().read(&mut b)?;
}
}
}
#[test]
fn simple() {
let mut s: Sender<i32> = Sender::new(1000).unwrap();
assert!(s.sender_mut().write_count().unwrap() >= 1000);
let memfd = s.memfd().as_file().try_clone().unwrap();
let e = s.empty_signal().try_clone().unwrap();
let f = s.full_signal().try_clone().unwrap();
let mut r: Receiver<i32> = Receiver::open(1000, memfd, e, f).unwrap();
assert_eq!(r.receiver_mut().read_count().unwrap(), 0);
}